Cache invalidation for import maps
# package-developmentm
Markus Johansson
08/09/2024, 1:47 PMI Have a question around shipping packages with import maps, how does one handle cache invalidation? My current approach has been to append the version to the entry point js file, but if I was to include serveral import maps in the
umbraco-package.jsonw
Warren Buckley
08/09/2024, 1:49 PMIs this for building/bundling/shipping something?
If so if its tedious job to do, could a Powershell script help you out to append the cache bust version querystring or something ?!
Warren Buckley
08/09/2024, 1:50 PMIf its for during your development cycle then - I would imagine its something similar but done with Node script land or some kind of Vite plugin you write yourself to add it in
m
Markus Johansson
08/09/2024, 2:17 PMI do have a powershell-script that will append the package version as a cache buster ?v1231 kind of style for the package entry point.
I just found that importmaps support a Cache Buster Token that will be replaced at runtime, this kind of solves the problem for me I think.
Copy code
{
"$schema": "../../../umbraco-package-schema.json",
....
"importmap": {
"imports": {
"@my-package/base-classes": "/App_Plugins/myPackage/dist/base-classes.js?v%CACHE_BUSTER%"
}
}
}w
Warren Buckley
08/09/2024, 2:20 PMIs that an Umbraco thing or a native browser thing ?
m
Markus Johansson
08/09/2024, 2:22 PMIt a Umbraco-thing, they do a simple string replace, they have some magic for the cache-busting stuff where they are requesting assets with a hash /umbraco/backoffice/{hashBasedOnUmbracoVersion}/{pathToAsset}
Then they have a AddRewrite that basically redirects to /umbraco/backoffice/{pathToAsset} and serve files from the RCL
Markus Johansson
08/09/2024, 2:23 PMI have not looked closely at how the hash is created but if it does not take all package versions into account it would not work for a package since it might not change when a package is updated.
Markus Johansson
08/09/2024, 2:26 PMNope. In debug mode it will regenerate the hash on each startup but in production mode it uses the umbraco version to generate the hash. So if we use it for a package this hash and a user upgrades the package it would not change the hash in production unless Umbraco it self is also upgraded.
Markus Johansson
08/09/2024, 2:26 PMIt feels like there should be something in the core for this so that each and every package developer dont't have to come up with their own solution.
w
Warren Buckley
08/09/2024, 2:28 PMTotally agree - but not yet at stage of importmaps with what I'm doing
Warren Buckley
08/09/2024, 2:28 PMAnything that we all need or could benefit from seems to be good shout to get into core
m
Markus Johansson
08/09/2024, 2:31 PMI created an issue about the hash, but to be fair - it's probably a bigger discussion to be had.
https://github.com/umbraco/Umbraco-CMS/issues/16893
w
Warren Buckley
08/09/2024, 2:32 PMWatching the issue to follow along....
m
Markus Johansson
08/09/2024, 2:33 PMTrue, I think that the fact that I would like to ship nu base classes for other developers to use makes the build process very complicated - for packages like "The Dashboard" it's really quite stright forward.
w
Warren Buckley
08/09/2024, 3:15 PMYeh for most packages its probably fine
Warren Buckley
08/09/2024, 3:15 PMIts just when you get into the territoary that you have your own extension types that can then in turn extend your extension really
m
Markus Johansson
08/09/2024, 4:30 PMI guess that it's not super common but it would still be nice.
Markus Johansson
08/09/2024, 4:34 PMI'll make sure to share any findings 😄
4 Views