connect-cachify-static/lib/cachify-static.js

static (simpler and faster) variant of connect-cachify middleware

import url from 'node:url';
import Debug from 'debug';
import onHeaders from 'on-headers';
import parseUrl from 'parseurl';
import hashStore from './hash-store.js';

const debug = Debug('connect:cachify-static');

const format = {
  path(path, hash) {
    return `/${hash}${path}`;
  },
  name(path, hash) {
    const index = path.lastIndexOf('/') + 1;
    return `${path.slice(0, index) + hash}-${path.slice(index)}`;
  }
};

export function init(root, opts = {}) {
  opts.match ??= /\.(js|css|svg|eot|woff2?|ttf|cur|png|gif|jpg|wasm|webp)$/;

  if (typeof opts.format === 'string') {
    opts.format = format[opts.format];
  }
  if (typeof opts.format !== 'function') {
    opts.format = format.path;
  }

  return hashStore(root, opts.match, opts.format);
}

export default function (root, opts = {}) {
  const storePromise = init(root, opts);
  let store;

  return Object.assign(cachifyStatic, {
    helpers,
    locals
  });

  async function cachifyStatic(req, res, next) {
    const parsedUrl = parseUrl(req);
    store ??= await storePromise;

    if (res.locals) {
      res.locals.cachify = store.cachify;
    }

    const path = store.getPath(parsedUrl.pathname);
    if (!path) {
      return next();
    }
    // this is where magic happens
    res.setHeader('Cache-Control', 'public, max-age=31536000, immutable');
    parsedUrl.pathname = path;
    req.url = url.format(parsedUrl);
    debug('Updated URL: %s', req.url);

    if (opts.control_headers) {
      // strip cache related headers
      onHeaders(res, () => {
        ['ETag', 'Last-Modified'].forEach(res.removeHeader, res);
      });
    }
    next();
  }

  async function locals(_req, res, next) {
    if (res.locals) {
      store ??= await storePromise;
      res.locals.cachify = store.cachify;
    }
    next();
  }

  async function helpers() {
    store ??= await storePromise;
    return {
      cachify: store.cachify,
      filter: store.filter
    };
  }
}