@serwist/sw 9.0.0-preview.2 → 9.0.0-preview.21

package/src/plugins/rangeRequests/utils/parseRangeHeader.ts

@@ -0,0 +1,54 @@
+/*
+  Copyright 2018 Google LLC
+
+  Use of this source code is governed by an MIT-style
+  license that can be found in the LICENSE file or at
+  https://opensource.org/licenses/MIT.
+*/
+
+import { assert, SerwistError } from "@serwist/core/internal";
+
+/**
+ * @param rangeHeader A Range: header value.
+ * @returns An object with `start` and `end` properties, reflecting
+ * the parsed value of the Range: header. If either the `start` or `end` are
+ * omitted, then `null` will be returned.
+ * @private
+ */
+export const parseRangeHeader = (
+  rangeHeader: string,
+): {
+  start?: number;
+  end?: number;
+} => {
+  if (process.env.NODE_ENV !== "production") {
+    assert!.isType(rangeHeader, "string", {
+      moduleName: "@serwist/range-requests",
+      funcName: "parseRangeHeader",
+      paramName: "rangeHeader",
+    });
+  }
+
+  const normalizedRangeHeader = rangeHeader.trim().toLowerCase();
+  if (!normalizedRangeHeader.startsWith("bytes=")) {
+    throw new SerwistError("unit-must-be-bytes", { normalizedRangeHeader });
+  }
+
+  // Specifying multiple ranges separate by commas is valid syntax, but this
+  // library only attempts to handle a single, contiguous sequence of bytes.
+  // https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Range#Syntax
+  if (normalizedRangeHeader.includes(",")) {
+    throw new SerwistError("single-range-only", { normalizedRangeHeader });
+  }
+
+  const rangeParts = /(\d*)-(\d*)/.exec(normalizedRangeHeader);
+  // We need either at least one of the start or end values.
+  if (!rangeParts || !(rangeParts[1] || rangeParts[2])) {
+    throw new SerwistError("invalid-range-values", { normalizedRangeHeader });
+  }
+
+  return {
+    start: rangeParts[1] === "" ? undefined : Number(rangeParts[1]),
+    end: rangeParts[2] === "" ? undefined : Number(rangeParts[2]),
+  };
+};

package/src/precaching/PrecacheController.ts

@@ -0,0 +1,332 @@
+/*
+  Copyright 2019 Google LLC
+
+  Use of this source code is governed by an MIT-style
+  license that can be found in the LICENSE file or at
+  https://opensource.org/licenses/MIT.
+*/
+
+import type { RouteHandlerCallback, SerwistPlugin } from "@serwist/core";
+import { assert, SerwistError, logger, privateCacheNames, waitUntil } from "@serwist/core/internal";
+import { parallel } from "@serwist/utils";
+import type { Strategy } from "../strategies/Strategy.js";
+import { PrecacheStrategy } from "./PrecacheStrategy.js";
+import type { CleanupResult, InstallResult, PrecacheEntry } from "./types.js";
+import { PrecacheCacheKeyPlugin } from "./utils/PrecacheCacheKeyPlugin.js";
+import { PrecacheInstallReportPlugin } from "./utils/PrecacheInstallReportPlugin.js";
+import { createCacheKey } from "./utils/createCacheKey.js";
+import { printCleanupDetails } from "./utils/printCleanupDetails.js";
+import { printInstallDetails } from "./utils/printInstallDetails.js";
+
+// Give TypeScript the correct global.
+declare const self: ServiceWorkerGlobalScope;
+
+interface PrecacheControllerOptions {
+  /**
+   * The cache to use for precaching.
+   */
+  cacheName?: string;
+  /**
+   * Plugins to use when precaching as well as responding to fetch
+   * events for precached assets.
+   */
+  plugins?: SerwistPlugin[];
+  /**
+   * Whether to attempt to get the response from the network if there's
+   * a precache miss.
+   */
+  fallbackToNetwork?: boolean;
+  /**
+   * A number of how many precache requests should be made concurrently.
+   *
+   * @default 1
+   */
+  concurrentPrecaching?: number;
+}
+
+/**
+ * Performs efficient precaching of assets.
+ */
+export class PrecacheController {
+  private _installAndActiveListenersAdded?: boolean;
+  private _concurrentPrecaching: number;
+  private readonly _strategy: Strategy;
+  private readonly _urlsToCacheKeys: Map<string, string> = new Map();
+  private readonly _urlsToCacheModes: Map<string, "reload" | "default" | "no-store" | "no-cache" | "force-cache" | "only-if-cached"> = new Map();
+  private readonly _cacheKeysToIntegrities: Map<string, string> = new Map();
+
+  /**
+   * Create a new PrecacheController.
+   *
+   * @param options
+   */
+  constructor({ cacheName, plugins = [], fallbackToNetwork = true, concurrentPrecaching = 1 }: PrecacheControllerOptions = {}) {
+    this._concurrentPrecaching = concurrentPrecaching;
+    this._strategy = new PrecacheStrategy({
+      cacheName: privateCacheNames.getPrecacheName(cacheName),
+      plugins: [...plugins, new PrecacheCacheKeyPlugin({ precacheController: this })],
+      fallbackToNetwork,
+    });
+    // Bind the install and activate methods to the instance.
+    this.install = this.install.bind(this);
+    this.activate = this.activate.bind(this);
+  }
+
+  /**
+   * The strategy created by this controller and
+   * used to cache assets and respond to fetch events.
+   */
+  get strategy(): Strategy {
+    return this._strategy;
+  }
+
+  /**
+   * Adds items to the precache list, removing any duplicates and
+   * stores the files in the precache cache when the service
+   * worker installs.
+   *
+   * This method can be called multiple times.
+   *
+   * @param entries Array of entries to precache.
+   */
+  precache(entries: (PrecacheEntry | string)[]): void {
+    this.addToCacheList(entries);
+
+    if (!this._installAndActiveListenersAdded) {
+      self.addEventListener("install", this.install);
+      self.addEventListener("activate", this.activate);
+      this._installAndActiveListenersAdded = true;
+    }
+  }
+
+  /**
+   * This method will add items to the precache list, removing duplicates
+   * and ensuring the information is valid.
+   *
+   * @param entries Array of entries to precache.
+   */
+  addToCacheList(entries: (PrecacheEntry | string)[]): void {
+    if (process.env.NODE_ENV !== "production") {
+      assert!.isArray(entries, {
+        moduleName: "@serwist/precaching",
+        className: "PrecacheController",
+        funcName: "addToCacheList",
+        paramName: "entries",
+      });
+    }
+
+    const urlsToWarnAbout: string[] = [];
+    for (const entry of entries) {
+      // See https://github.com/GoogleChrome/workbox/issues/2259
+      if (typeof entry === "string") {
+        urlsToWarnAbout.push(entry);
+      } else if (entry && !entry.integrity && entry.revision === undefined) {
+        urlsToWarnAbout.push(entry.url);
+      }
+
+      const { cacheKey, url } = createCacheKey(entry);
+      const cacheMode = typeof entry !== "string" && entry.revision ? "reload" : "default";
+
+      if (this._urlsToCacheKeys.has(url) && this._urlsToCacheKeys.get(url) !== cacheKey) {
+        throw new SerwistError("add-to-cache-list-conflicting-entries", {
+          firstEntry: this._urlsToCacheKeys.get(url),
+          secondEntry: cacheKey,
+        });
+      }
+
+      if (typeof entry !== "string" && entry.integrity) {
+        if (this._cacheKeysToIntegrities.has(cacheKey) && this._cacheKeysToIntegrities.get(cacheKey) !== entry.integrity) {
+          throw new SerwistError("add-to-cache-list-conflicting-integrities", {
+            url,
+          });
+        }
+        this._cacheKeysToIntegrities.set(cacheKey, entry.integrity);
+      }
+
+      this._urlsToCacheKeys.set(url, cacheKey);
+      this._urlsToCacheModes.set(url, cacheMode);
+
+      if (urlsToWarnAbout.length > 0) {
+        const warningMessage = `Serwist is precaching URLs without revision info: ${urlsToWarnAbout.join(
+          ", ",
+        )}\nThis is generally NOT safe. Learn more at https://bit.ly/wb-precache`;
+        if (process.env.NODE_ENV === "production") {
+          // Use console directly to display this warning without bloating
+          // bundle sizes by pulling in all of the logger codebase in prod.
+          console.warn(warningMessage);
+        } else {
+          logger.warn(warningMessage);
+        }
+      }
+    }
+  }
+
+  /**
+   * Precaches new and updated assets. Call this method from the service worker
+   * install event.
+   *
+   * Note: this method calls `event.waitUntil()` for you, so you do not need
+   * to call it yourself in your event handlers.
+   *
+   * @param event
+   * @returns
+   */
+  install(event: ExtendableEvent): Promise<InstallResult> {
+    return waitUntil<InstallResult>(event, async () => {
+      const installReportPlugin = new PrecacheInstallReportPlugin();
+      this.strategy.plugins.push(installReportPlugin);
+
+      await parallel(this._concurrentPrecaching, Array.from(this._urlsToCacheKeys.entries()), async ([url, cacheKey]): Promise<void> => {
+        const integrity = this._cacheKeysToIntegrities.get(cacheKey);
+        const cacheMode = this._urlsToCacheModes.get(url);
+
+        const request = new Request(url, {
+          integrity,
+          cache: cacheMode,
+          credentials: "same-origin",
+        });
+
+        await Promise.all(
+          this.strategy.handleAll({
+            event,
+            request,
+            url: new URL(request.url),
+            params: { cacheKey },
+          }),
+        );
+      });
+
+      const { updatedURLs, notUpdatedURLs } = installReportPlugin;
+
+      if (process.env.NODE_ENV !== "production") {
+        printInstallDetails(updatedURLs, notUpdatedURLs);
+      }
+
+      return { updatedURLs, notUpdatedURLs };
+    });
+  }
+
+  /**
+   * Deletes assets that are no longer present in the current precache manifest.
+   * Call this method from the service worker activate event.
+   *
+   * Note: this method calls `event.waitUntil()` for you, so you do not need
+   * to call it yourself in your event handlers.
+   *
+   * @param event
+   * @returns
+   */
+  activate(event: ExtendableEvent): Promise<CleanupResult> {
+    return waitUntil<CleanupResult>(event, async () => {
+      const cache = await self.caches.open(this.strategy.cacheName);
+      const currentlyCachedRequests = await cache.keys();
+      const expectedCacheKeys = new Set(this._urlsToCacheKeys.values());
+
+      const deletedCacheRequests: string[] = [];
+
+      for (const request of currentlyCachedRequests) {
+        if (!expectedCacheKeys.has(request.url)) {
+          await cache.delete(request);
+          deletedCacheRequests.push(request.url);
+        }
+      }
+
+      if (process.env.NODE_ENV !== "production") {
+        printCleanupDetails(deletedCacheRequests);
+      }
+
+      return { deletedCacheRequests };
+    });
+  }
+
+  /**
+   * Returns a mapping of a precached URL to the corresponding cache key, taking
+   * into account the revision information for the URL.
+   *
+   * @returns A URL to cache key mapping.
+   */
+  getURLsToCacheKeys(): Map<string, string> {
+    return this._urlsToCacheKeys;
+  }
+
+  /**
+   * Returns a list of all the URLs that have been precached by the current
+   * service worker.
+   *
+   * @returns The precached URLs.
+   */
+  getCachedURLs(): string[] {
+    return [...this._urlsToCacheKeys.keys()];
+  }
+
+  /**
+   * Returns the cache key used for storing a given URL. If that URL is
+   * unversioned, like `/index.html', then the cache key will be the original
+   * URL with a search parameter appended to it.
+   *
+   * @param url A URL whose cache key you want to look up.
+   * @returns The versioned URL that corresponds to a cache key
+   * for the original URL, or undefined if that URL isn't precached.
+   */
+  getCacheKeyForURL(url: string): string | undefined {
+    const urlObject = new URL(url, location.href);
+    return this._urlsToCacheKeys.get(urlObject.href);
+  }
+
+  /**
+   * @param url A cache key whose SRI you want to look up.
+   * @returns The subresource integrity associated with the cache key,
+   * or undefined if it's not set.
+   */
+  getIntegrityForCacheKey(cacheKey: string): string | undefined {
+    return this._cacheKeysToIntegrities.get(cacheKey);
+  }
+
+  /**
+   * This acts as a drop-in replacement for
+   * [`cache.match()`](https://developer.mozilla.org/en-US/docs/Web/API/Cache/match)
+   * with the following differences:
+   *
+   * - It knows what the name of the precache is, and only checks in that cache.
+   * - It allows you to pass in an "original" URL without versioning parameters,
+   * and it will automatically look up the correct cache key for the currently
+   * active revision of that URL.
+   *
+   * E.g., `matchPrecache('index.html')` will find the correct precached
+   * response for the currently active service worker, even if the actual cache
+   * key is `'/index.html?__WB_REVISION__=1234abcd'`.
+   *
+   * @param request The key (without revisioning parameters)
+   * to look up in the precache.
+   * @returns
+   */
+  async matchPrecache(request: string | Request): Promise<Response | undefined> {
+    const url = request instanceof Request ? request.url : request;
+    const cacheKey = this.getCacheKeyForURL(url);
+    if (cacheKey) {
+      const cache = await self.caches.open(this.strategy.cacheName);
+      return cache.match(cacheKey);
+    }
+    return undefined;
+  }
+
+  /**
+   * Returns a function that looks up `url` in the precache (taking into
+   * account revision information), and returns the corresponding `Response`.
+   *
+   * @param url The precached URL which will be used to lookup the response.
+   * @return
+   */
+  createHandlerBoundToURL(url: string): RouteHandlerCallback {
+    const cacheKey = this.getCacheKeyForURL(url);
+    if (!cacheKey) {
+      throw new SerwistError("non-precached-url", { url });
+    }
+    return (options) => {
+      options.request = new Request(url);
+      options.params = { cacheKey, ...options.params };
+
+      return this.strategy.handle(options);
+    };
+  }
+}

package/src/precaching/PrecacheRoute.ts

@@ -0,0 +1,50 @@
+/*
+  Copyright 2020 Google LLC
+
+  Use of this source code is governed by an MIT-style
+  license that can be found in the LICENSE file or at
+  https://opensource.org/licenses/MIT.
+*/
+
+import type { RouteMatchCallback, RouteMatchCallbackOptions } from "@serwist/core";
+import { getFriendlyURL, logger } from "@serwist/core/internal";
+import { Route } from "../routing/Route.js";
+
+import type { PrecacheController } from "./PrecacheController.js";
+import type { PrecacheRouteOptions } from "./types.js";
+import { generateURLVariations } from "./utils/generateURLVariations.js";
+
+/**
+ * A subclass of `@serwist/routing.Route` that takes a
+ * `@serwist/precaching.PrecacheController`
+ * instance and uses it to match incoming requests and handle fetching
+ * responses from the precache.
+ */
+class PrecacheRoute extends Route {
+  /**
+   * @param precacheController A `PrecacheController`
+   * instance used to both match requests and respond to fetch events.
+   * @param options Options to control how requests are matched
+   * against the list of precached URLs.
+   */
+  constructor(precacheController: PrecacheController, options?: PrecacheRouteOptions) {
+    const match: RouteMatchCallback = ({ request }: RouteMatchCallbackOptions) => {
+      const urlsToCacheKeys = precacheController.getURLsToCacheKeys();
+      for (const possibleURL of generateURLVariations(request.url, options)) {
+        const cacheKey = urlsToCacheKeys.get(possibleURL);
+        if (cacheKey) {
+          const integrity = precacheController.getIntegrityForCacheKey(cacheKey);
+          return { cacheKey, integrity };
+        }
+      }
+      if (process.env.NODE_ENV !== "production") {
+        logger.debug(`Precaching did not find a match for ${getFriendlyURL(request.url)}`);
+      }
+      return;
+    };
+
+    super(match, precacheController.strategy);
+  }
+}
+
+export { PrecacheRoute };

package/src/precaching/PrecacheStrategy.ts

@@ -0,0 +1,238 @@
+/*
+  Copyright 2020 Google LLC
+
+  Use of this source code is governed by an MIT-style
+  license that can be found in the LICENSE file or at
+  https://opensource.org/licenses/MIT.
+*/
+
+import type { SerwistPlugin } from "@serwist/core";
+import { copyResponse } from "@serwist/core";
+import { SerwistError, getFriendlyURL, logger, privateCacheNames } from "@serwist/core/internal";
+import type { StrategyOptions } from "../strategies/Strategy.js";
+import { Strategy } from "../strategies/Strategy.js";
+import type { StrategyHandler } from "../strategies/StrategyHandler.js";
+
+interface PrecacheStrategyOptions extends StrategyOptions {
+  /**
+   * Whether to attempt to get the response from the network
+   * if there's a precache miss.
+   */
+  fallbackToNetwork?: boolean;
+}
+
+/**
+ * A `@serwist/strategies.Strategy` implementation
+ * specifically designed to work with
+ * `@serwist/precaching.PrecacheController`
+ * to both cache and fetch precached assets.
+ *
+ * Note: an instance of this class is created automatically when creating a
+ * `PrecacheController`; it's generally not necessary to create this yourself.
+ */
+export class PrecacheStrategy extends Strategy {
+  private readonly _fallbackToNetwork: boolean;
+
+  static readonly defaultPrecacheCacheabilityPlugin: SerwistPlugin = {
+    async cacheWillUpdate({ response }) {
+      if (!response || response.status >= 400) {
+        return null;
+      }
+
+      return response;
+    },
+  };
+
+  static readonly copyRedirectedCacheableResponsesPlugin: SerwistPlugin = {
+    async cacheWillUpdate({ response }) {
+      return response.redirected ? await copyResponse(response) : response;
+    },
+  };
+
+  /**
+   * @param options
+   */
+  constructor(options: PrecacheStrategyOptions = {}) {
+    options.cacheName = privateCacheNames.getPrecacheName(options.cacheName);
+    super(options);
+
+    this._fallbackToNetwork = options.fallbackToNetwork === false ? false : true;
+
+    // Redirected responses cannot be used to satisfy a navigation request, so
+    // any redirected response must be "copied" rather than cloned, so the new
+    // response doesn't contain the `redirected` flag. See:
+    // https://bugs.chromium.org/p/chromium/issues/detail?id=669363&desc=2#c1
+    this.plugins.push(PrecacheStrategy.copyRedirectedCacheableResponsesPlugin);
+  }
+
+  /**
+   * @private
+   * @param request A request to run this strategy for.
+   * @param handler The event that triggered the request.
+   * @returns
+   */
+  async _handle(request: Request, handler: StrategyHandler): Promise<Response> {
+    const response = await handler.cacheMatch(request);
+    if (response) {
+      return response;
+    }
+
+    // If this is an `install` event for an entry that isn't already cached,
+    // then populate the cache.
+    if (handler.event && handler.event.type === "install") {
+      return await this._handleInstall(request, handler);
+    }
+
+    // Getting here means something went wrong. An entry that should have been
+    // precached wasn't found in the cache.
+    return await this._handleFetch(request, handler);
+  }
+
+  async _handleFetch(request: Request, handler: StrategyHandler): Promise<Response> {
+    let response: Response | undefined = undefined;
+    const params = (handler.params || {}) as {
+      cacheKey?: string;
+      integrity?: string;
+    };
+
+    // Fallback to the network if we're configured to do so.
+    if (this._fallbackToNetwork) {
+      if (process.env.NODE_ENV !== "production") {
+        logger.warn(`The precached response for ${getFriendlyURL(request.url)} in ${this.cacheName} was not found. Falling back to the network.`);
+      }
+
+      const integrityInManifest = params.integrity;
+      const integrityInRequest = request.integrity;
+      const noIntegrityConflict = !integrityInRequest || integrityInRequest === integrityInManifest;
+
+      // Do not add integrity if the original request is no-cors
+      // See https://github.com/GoogleChrome/workbox/issues/3096
+      response = await handler.fetch(
+        new Request(request, {
+          integrity: request.mode !== "no-cors" ? integrityInRequest || integrityInManifest : undefined,
+        }),
+      );
+
+      // It's only "safe" to repair the cache if we're using SRI to guarantee
+      // that the response matches the precache manifest's expectations,
+      // and there's either a) no integrity property in the incoming request
+      // or b) there is an integrity, and it matches the precache manifest.
+      // See https://github.com/GoogleChrome/workbox/issues/2858
+      // Also if the original request users no-cors we don't use integrity.
+      // See https://github.com/GoogleChrome/workbox/issues/3096
+      if (integrityInManifest && noIntegrityConflict && request.mode !== "no-cors") {
+        this._useDefaultCacheabilityPluginIfNeeded();
+        const wasCached = await handler.cachePut(request, response.clone());
+        if (process.env.NODE_ENV !== "production") {
+          if (wasCached) {
+            logger.log(`A response for ${getFriendlyURL(request.url)} was used to "repair" the precache.`);
+          }
+        }
+      }
+    } else {
+      // This shouldn't normally happen, but there are edge cases:
+      // https://github.com/GoogleChrome/workbox/issues/1441
+      throw new SerwistError("missing-precache-entry", {
+        cacheName: this.cacheName,
+        url: request.url,
+      });
+    }
+
+    if (process.env.NODE_ENV !== "production") {
+      const cacheKey = params.cacheKey || (await handler.getCacheKey(request, "read"));
+
+      // Serwist is going to handle the route.
+      // print the routing details to the console.
+      logger.groupCollapsed(`Precaching is responding to: ${getFriendlyURL(request.url)}`);
+      logger.log(`Serving the precached url: ${getFriendlyURL(cacheKey instanceof Request ? cacheKey.url : cacheKey)}`);
+
+      logger.groupCollapsed("View request details here.");
+      logger.log(request);
+      logger.groupEnd();
+
+      logger.groupCollapsed("View response details here.");
+      logger.log(response);
+      logger.groupEnd();
+
+      logger.groupEnd();
+    }
+
+    return response;
+  }
+
+  async _handleInstall(request: Request, handler: StrategyHandler): Promise<Response> {
+    this._useDefaultCacheabilityPluginIfNeeded();
+
+    const response = await handler.fetch(request);
+
+    // Make sure we defer cachePut() until after we know the response
+    // should be cached; see https://github.com/GoogleChrome/workbox/issues/2737
+    const wasCached = await handler.cachePut(request, response.clone());
+    if (!wasCached) {
+      // Throwing here will lead to the `install` handler failing, which
+      // we want to do if *any* of the responses aren't safe to cache.
+      throw new SerwistError("bad-precaching-response", {
+        url: request.url,
+        status: response.status,
+      });
+    }
+
+    return response;
+  }
+
+  /**
+   * This method is complex, as there a number of things to account for:
+   *
+   * The `plugins` array can be set at construction, and/or it might be added to
+   * to at any time before the strategy is used.
+   *
+   * At the time the strategy is used (i.e. during an `install` event), there
+   * needs to be at least one plugin that implements `cacheWillUpdate` in the
+   * array, other than `copyRedirectedCacheableResponsesPlugin`.
+   *
+   * - If this method is called and there are no suitable `cacheWillUpdate`
+   * plugins, we need to add `defaultPrecacheCacheabilityPlugin`.
+   *
+   * - If this method is called and there is exactly one `cacheWillUpdate`, then
+   * we don't have to do anything (this might be a previously added
+   * `defaultPrecacheCacheabilityPlugin`, or it might be a custom plugin).
+   *
+   * - If this method is called and there is more than one `cacheWillUpdate`,
+   * then we need to check if one is `defaultPrecacheCacheabilityPlugin`. If so,
+   * we need to remove it. (This situation is unlikely, but it could happen if
+   * the strategy is used multiple times, the first without a `cacheWillUpdate`,
+   * and then later on after manually adding a custom `cacheWillUpdate`.)
+   *
+   * See https://github.com/GoogleChrome/workbox/issues/2737 for more context.
+   *
+   * @private
+   */
+  _useDefaultCacheabilityPluginIfNeeded(): void {
+    let defaultPluginIndex: number | null = null;
+    let cacheWillUpdatePluginCount = 0;
+
+    for (const [index, plugin] of this.plugins.entries()) {
+      // Ignore the copy redirected plugin when determining what to do.
+      if (plugin === PrecacheStrategy.copyRedirectedCacheableResponsesPlugin) {
+        continue;
+      }
+
+      // Save the default plugin's index, in case it needs to be removed.
+      if (plugin === PrecacheStrategy.defaultPrecacheCacheabilityPlugin) {
+        defaultPluginIndex = index;
+      }
+
+      if (plugin.cacheWillUpdate) {
+        cacheWillUpdatePluginCount++;
+      }
+    }
+
+    if (cacheWillUpdatePluginCount === 0) {
+      this.plugins.push(PrecacheStrategy.defaultPrecacheCacheabilityPlugin);
+    } else if (cacheWillUpdatePluginCount > 1 && defaultPluginIndex !== null) {
+      // Only remove the default plugin; multiple custom plugins are allowed.
+      this.plugins.splice(defaultPluginIndex, 1);
+    }
+    // Nothing needs to be done if cacheWillUpdatePluginCount is 1
+  }
+}

package/src/precaching/addPlugins.ts

@@ -0,0 +1,21 @@
+/*
+  Copyright 2019 Google LLC
+
+  Use of this source code is governed by an MIT-style
+  license that can be found in the LICENSE file or at
+  https://opensource.org/licenses/MIT.
+*/
+
+import type { SerwistPlugin } from "@serwist/core";
+
+import { getSingletonPrecacheController } from "./singletonPrecacheController.js";
+
+/**
+ * Adds plugins to the precaching strategy.
+ *
+ * @param plugins
+ */
+export const addPlugins = (plugins: SerwistPlugin[]): void => {
+  const precacheController = getSingletonPrecacheController();
+  precacheController.strategy.plugins.push(...plugins);
+};