stealjs / cache-bust Goto Github PK

View Code? Open in Web Editor NEW

6.0 12.0 0.0 29 KB

A cache busting extension for StealJS

Home Page: https://stealjs.com/docs/config.cacheVersion.html

License: MIT License

JavaScript 96.61% HTML 3.39%

cache-bust's Introduction

cache-bust

A StealJS and SystemJS cache busting extension.

Deprecated: this package is now built into steal. See the cacheVersion documentation for more details.

Install

You can install through NPM:

npm install steal-cache-bust --save

You'll then want to copy node_modules/steal-cache-bust/cache-bust.js to a location within your project folder. In the future this extension will be included in Steal by default.

Usage

With StealJS simply include cache-bust as a configDependency. Assuming you placed it in your root folder:

{
  "system": {
    "configDependencies": [
      "cache-bust"
    ]
  }
}

If you prefer leaving cache-bust in your node_modules folder you should use the full path to the cache-bust.js file:

{
  "system": {
    "configDependencies": [
      "node_modules/steal-cache-bust/cache-bust.js"
    ]
  }
}

Configuration

When not running in production the cacheVersion is ignored and a timestamp is added instead. As some files do not pass through steal no cache busting can be applied to those. When developing using Chrome as your browser you may want to tick the 'Disable cache (while DevTools is open)' checkbox under Settings | Preferences | Network to prevent caching altogether while you are developing.

You can configure cache busting by setting properties on the script tag. You'll probably at least want to set cacheVersion.

cacheVersion

This is the version string that will be appending as a query parameter inwhen running in production. For example if you do:

<script src="node_modules/steal/steal.js" cache-version="14"></script>

Then requests will be for:

http://example.com/foo/bar.js?version=14

This version should be changed for each production release to ensure that the latest code is retrieved from the server.

If you do not specify a cacheVersion value a timestamp will be added as the cache busting parameter. This is not ideal for a production environment as you will lose all the benefits of browser caching.

cacheKey

By default "version" is used as the query param for busting caches but you can use a different string by setting cacheKey.

License

MIT

cache-bust's People

Contributors

Stargazers

Watchers

cache-bust's Issues

update loader.env to use window-production

Newer versions of steal use window-production instead of production.

Version 10 of node.js has been released

Version 10 of Node.js (code name Dubnium) has been released! 🎊

To see what happens to your code in Node.js 10, Greenkeeper has created a branch with the following changes:

Added the new Node.js version to your .travis.yml

If you’re interested in upgrading this repo to Node.js 10, you can open a PR with these changes. Please note that this issue is just intended as a friendly reminder and the PR as a possible starting point for getting your code running on Node.js 10.

More information on this issue

Greenkeeper has checked the engines key in any package.json file, the .nvmrc file, and the .travis.yml file, if present.

engines was only updated if it defined a single version, not a range.
.nvmrc was updated to Node.js 10
.travis.yml was only changed if there was a root-level node_js that didn’t already include Node.js 10, such as node or lts/*. In this case, the new version was appended to the list. We didn’t touch job or matrix configurations because these tend to be quite specific and complex, and it’s difficult to infer what the intentions were.

For many simpler .travis.yml configurations, this PR should suffice as-is, but depending on what you’re doing it may require additional work or may not be applicable at all. We’re also aware that you may have good reasons to not update to Node.js 10, which is why this was sent as an issue and not a pull request. Feel free to delete it without comment, I’m a humble robot and won’t feel rejected 🤖

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

Your Greenkeeper Bot 🌴

Default cache version enhancement

When obtaining the cache version:

var cacheVersion = loader.cacheVersion || Math.random();

That Math.random() will not be guaranteed to be unique. However, new Date().getTime() would do the trick.

Not a big deal though as typically one should specify the version.

Come to think of it... the cache busting should be applied when not in production as well. In a previous project we added the date to the urls for development builds to always force a reload. Would this perhaps be an option? So use the above suggestion when either no cache version is set or when not in production.

wont work in production

as worte in http://forums.donejs.com/t/problems-getting-stealjs-cache-bust-to-work/514/4
steal-cache-bust can (today) not work in production.

in production steal-cache-bust is bundled into the index.js file and steal therefore cant be load the index.js file with the cache-bust extension because it dont know that cache-busting is enabled.

for any future files, steal will load these files with a version number

@matthewp
my thoughts:
either we integrate steal-cache-buster into core and enable it by setting the steal config
or
we add (in steal 1.0) the fetch hook into the steal.production.js that we copied into the dist folder and remove cache-buster from being bundled

API

System.cacheVersion

This is the key that is changed (usually by your server-side scripting language) when you need to bust the cache.

System.cacheKey

If for some reason you want to configure what is used as the querystring key when fetching.

Questions

Should this be production only?
This will bust the cache for all modules, is there a better way to only bust it for files that have changed?