C

cache-digest-immutable

πŸ“‘ Service Worker to create Cache Digest header for Immutable Responses

Name Last Update
src Loading commit data...
test Loading commit data...
.babelrc Loading commit data...
.gitignore Loading commit data...
.gitlab-ci.yml Loading commit data...
.npmignore Loading commit data...
LICENSE.txt Loading commit data...
README.md Loading commit data...
package.json Loading commit data...

πŸ“‘ Cache Digest Immutable

Uses a service worker's fetch event and Cache API to set the cache-digest header. Webservers use this digest to check which files the client aleady has cached. This avoids server-pushing redundant data, providing atomic cache invalidation when used in combination with filename revving (aka cache busting).

As an explicit opt-in, to avoid overly aggressive caching, this implementation only includes, in the digest, responses that have the cache-control: immutable extension set.

Usage

if ('serviceWorker' in navigator) {
  addEventListener('load', function () {
    navigator.serviceWorker.register('cache-digest-immutable.js')
  }, {once: true})
}

Note: This waits until everything else on the page has loaded. This is fine since the service worker only receives fetch events on future page loads.

Server Support

Specifications

Significant Decisions

  • Written in ES2015+ which works fine as of Chrome 56 (Canary version at the time of starting this implementation).
  • Uses importScripts(...) for native module loading within Service Workers. Not meant to be compatible with alternatives like CommonJS, ES2015 Modules (export/import), etc.
  • Only caches if cache-control: immutable extension is set. This makes it opt-in for server configurations and avoids overly aggressive caching. Also minimises the cache digest size to only contain assets that will be cached long-term, as opposed to short-term ephemeral resources that require revalidation.
  • Respects all caching directives by fully parsing the date/expires/cache-control headers (incl max-age=N/no-store/no-cache/must-revalidate).
  • Manages cache by purging stale responses.
  • Rewritten the URL value hashing code to use the browser's asynchronous SubtleCrypto API's SHA256 implementation.
  • Rewritten the digest algo to closely follow the spec. Still uses the same (slightly tweaked) BitCoder implementation of Golomb coding.
  • Memoises the digest to avoid recalculating on every single request. Huge performance improvement by throttling only one calculation per second.
  • Rewrote Base64 encoding to use browser's native btoa function.

Related

  • Unbundle - Originally developed for, and extracted from, this package.
  • cache-digest.js - Passes the same test suite for guaranteed binary output compatibility.

Colophon

Made by Sebastiaan Deckers in Singapore πŸ‡ΈπŸ‡¬