@toapi/worker 1.2.1 → 1.2.3

package/dist/console-fallback.d.ts

@@ -0,0 +1,7 @@
+import type { Logger } from "@toapi/common";
+export declare const consoleFallback: (logger?: Logger) => {
+    error: (error: unknown) => import("@toapi/common").MaybePromise<void>;
+    warn: (message: string) => import("@toapi/common").MaybePromise<void>;
+    info: (message: string) => import("@toapi/common").MaybePromise<void>;
+};
+//# sourceMappingURL=console-fallback.d.ts.map

package/dist/console-fallback.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"console-fallback.d.ts","sourceRoot":"","sources":["../src/console-fallback.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAE5C,eAAO,MAAM,eAAe,GAAI,SAAS,MAAM;;;;CAK1B,CAAC"}

package/dist/console-fallback.js

@@ -0,0 +1,5 @@
+export const consoleFallback = (logger) => ({
+    error: logger?.error ?? ((error) => console.error("Toapi Worker:", error)),
+    warn: logger?.warn ?? ((message) => console.warn("Toapi Worker:", message)),
+    info: logger?.info ?? ((message) => console.info("Toapi Worker:", message)),
+});

package/dist/handle-toapi-request.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"handle-toapi-request.d.ts","sourceRoot":"","sources":["../src/handle-toapi-request.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAM5C,wBAAsB,kBAAkB,CACtC,GAAG,EAAE,OAAO,EACZ,OAAO,CAAC,EAAE;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,qBAsC9B;AAED;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,2BAAqB,CAAC"}
+{"version":3,"file":"handle-toapi-request.d.ts","sourceRoot":"","sources":["../src/handle-toapi-request.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAO5C,wBAAsB,kBAAkB,CACtC,GAAG,EAAE,OAAO,EACZ,OAAO,CAAC,EAAE;IAAE,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,qBA8B9B;AAED;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,2BAAqB,CAAC"}

package/dist/handle-toapi-request.js

@@ -2,9 +2,9 @@ import { isMutation } from "@toapi/common";
 import { getCachedEntry, getMetadata } from "./cache";
 import { mutateAndInvalidate } from "./mutate-and-invalidate";
 import { serveFromNetwork } from "./serve-from-network";
+import { consoleFallback } from "./console-fallback";
 export async function handleToapiRequest(req, options) {
-    const errorLog = options?.logger?.error ??
-        ((err) => console.error("Toapi Worker fetch failed", err));
+    const logger = consoleFallback(options?.logger);
     if (isMutation(req)) {
         return mutateAndInvalidate(req);
     }
@@ -15,26 +15,21 @@ export async function handleToapiRequest(req, options) {
             return serveFromNetwork(req);
         }
         const meta = await getMetadata(req.url);
-        if (meta?.expiresAt) {
-            if (meta.expiresAt > Date.now()) {
-                // cached response is still valid
-                return cachedResponse;
+        if (meta && (!meta.expiresAt || meta.expiresAt > Date.now())) {
+            return cachedResponse;
+        }
+        else {
+            // cached response is expired
+            try {
+                // try to serve from network
+                return await serveFromNetwork(req);
             }
-            else {
-                // cached response is expired
-                try {
-                    // try to serve from network
-                    return await serveFromNetwork(req);
-                }
-                catch (error) {
-                    // probably network not available, serve old response
-                    errorLog(error);
-                    return cachedResponse;
-                }
+            catch (error) {
+                // probably network not available, serve old response
+                logger.error(error);
+                return cachedResponse;
             }
         }
-        // no expiration header, serve cached response
-        return cachedResponse;
     }
 }
 /**

package/dist/revalidation-stream.d.ts

@@ -1,6 +1,9 @@
+import { type Logger } from "@toapi/common";
 interface Options {
     url: string;
+    timeout?: number;
+    logger?: Logger;
 }
-export declare function listenForInvalidations({ url }: Options): Promise<void>;
+export declare function listenForInvalidations({ url, timeout, logger: customLogger, }: Options): Promise<void>;
 export {};
 //# sourceMappingURL=revalidation-stream.d.ts.map

package/dist/revalidation-stream.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"revalidation-stream.d.ts","sourceRoot":"","sources":["../src/revalidation-stream.ts"],"names":[],"mappings":"AAQA,UAAU,OAAO;IACf,GAAG,EAAE,MAAM,CAAC;CACb;AAED,wBAAsB,sBAAsB,CAAC,EAAE,GAAG,EAAE,EAAE,OAAO,iBAoF5D"}
+{"version":3,"file":"revalidation-stream.d.ts","sourceRoot":"","sources":["../src/revalidation-stream.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,KAAK,MAAM,EACZ,MAAM,eAAe,CAAC;AAMvB,UAAU,OAAO;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,wBAAsB,sBAAsB,CAAC,EAC3C,GAAG,EACH,OAAc,EACd,MAAM,EAAE,YAAY,GACrB,EAAE,OAAO,iBAqFT"}

package/dist/revalidation-stream.js

@@ -1,7 +1,9 @@
 import { INVALIDATION_POST_EVENT, TAGS_CONTENT_TYPE, } from "@toapi/common";
 import { deleteCache, expireAll, invalidateTags } from "./cache";
-export async function listenForInvalidations({ url }) {
-    console.info("TApi: Listening for invalidations...");
+import { consoleFallback } from "./console-fallback";
+export async function listenForInvalidations({ url, timeout = 5000, logger: customLogger, }) {
+    const logger = consoleFallback(customLogger);
+    logger.info("Listening for invalidations...");
     let res = null;
     const MAX_ATTEMPTS = 1000;
     for (let retry = 0; retry < MAX_ATTEMPTS; retry++) {
@@ -10,32 +12,32 @@ export async function listenForInvalidations({ url }) {
             break;
         }
         catch (error) {
-            console.warn(`TApi: Failed attempt #${retry + 1} to open invalidation stream`, error);
+            logger.warn(`Failed attempt #${retry + 1} to open invalidation stream\n${String(error)}`);
         }
         await new Promise((resolve) => setTimeout(resolve, 500 * Math.pow(2, retry)));
     }
     if (!res) {
-        console.error(`TApi: Failed to open invalidation stream after ${MAX_ATTEMPTS} attempts, giving up.`);
+        logger.error(new Error(`Failed to open invalidation stream after ${MAX_ATTEMPTS} attempts, giving up.`));
         return;
     }
     const contentType = res.headers.get("Content-Type");
     if (!res.ok || contentType !== TAGS_CONTENT_TYPE || !res.body) {
-        console.error("TApi: Failed to open invalidation stream. Cleaning up and unregistering service worker.", res.status, res.statusText);
+        logger.error(new Error(`Failed to open invalidation stream: Received ${res.status} ${res.statusText} with content type ${contentType}. Cleaning up and unregistering service worker.`));
         await deleteCache();
         await self.registration.unregister();
         return;
     }
-    console.info("TApi: Invalidation Stream Connection Established");
+    logger.info("Invalidation Stream Connection Established");
     try {
         const tags = await expireAll();
         const clients = await self.clients.matchAll();
         for (const client of clients) {
             client.postMessage({ type: INVALIDATION_POST_EVENT, tags });
         }
-        console.info("TApi: Marked all cached entries as expired");
+        logger.info("Marked all cached entries as expired");
     }
     catch {
-        console.warn("TApi: Failed to expire existing cache entries");
+        logger.warn("Failed to expire existing cache entries");
     }
     try {
         let buffer = "";
@@ -50,7 +52,7 @@ export async function listenForInvalidations({ url }) {
                 if (!rawTags)
                     continue;
                 const tags = rawTags.split(" ");
-                console.info("TApi: Remote-Invalidating tags", tags);
+                logger.info(`Remote-Invalidating tags: ${tags}`);
                 await invalidateTags(tags);
                 for (const client of clients) {
                     client.postMessage({ type: INVALIDATION_POST_EVENT, tags });
@@ -59,12 +61,9 @@ export async function listenForInvalidations({ url }) {
         }
     }
     catch (error) {
-        if (error instanceof Error && error.name === "NetworkError") {
-            console.info("TApi: Network disconnected, retrying revalidation connection...");
-            setTimeout(() => {
-                listenForInvalidations({ url });
-            }, 5000);
-        }
-        console.error("TApi: Failed to read invalidation stream", error);
+        logger.warn(`Invalidation stream failure, retrying in ${Math.round(timeout / 1000)}s`);
+        setTimeout(() => {
+            listenForInvalidations({ url, timeout: Math.round(timeout * 1.5) });
+        }, timeout);
     }
 }

package/dist/setup.d.ts

@@ -17,24 +17,30 @@ export interface SetupToapiWorkerOptions {
     invalidationsUrl?: string;
     /**
      * Grace period in seconds past a cache entry's `expiresAt` before it is
-     * dropped on the next `activate`. See {@link CleanupOptions}.
+     * dropped by the cleanup pass that runs on every worker startup. See
+     * {@link CleanupOptions}.
      *
      * @default 60 * 60 * 24 * 7 // 7 days
      */
     maximumStaleAge?: number;
     /**
-     * Optional logger. Its `error` method is used for failed network refetches
-     * and for a fatal failure of the invalidation stream. Defaults to
-     * `console.error`.
+     * Optional logger. `error` reports failed network refetches and a fatal
+     * failure of the invalidation stream, `warn` reports invalidation-stream
+     * retries, and `info` reports stream progress. Each method that is omitted
+     * falls back to the matching `console` method.
      */
     logger?: Logger;
 }
 /**
  * Wire up the whole Toapi service worker in a single call. This registers the
- * `activate` and `fetch` listeners and opens the revalidation stream, and is
- * equivalent to calling {@link cleanup}, {@link handleToapiRequest}, and
+ * `fetch` listener, runs {@link cleanup}, and opens the revalidation stream,
+ * and is equivalent to calling {@link cleanup}, {@link handleToapiRequest}, and
  * {@link listenForInvalidations} by hand.
  *
+ * Cleanup runs at worker startup rather than from the `activate` event, which
+ * only fires when a new worker takes over — an installed worker that is never
+ * updated would otherwise never clean up.
+ *
  * ```ts
  * // service-worker.ts
  * import { setupToapiWorker } from "@toapi/worker";
@@ -49,5 +55,5 @@ export interface SetupToapiWorkerOptions {
  * `vite-plugin-pwa`'s precaching) — requests it doesn't handle fall through to
  * them.
  */
-export declare function setupToapiWorker({ basePath, invalidationsUrl, maximumStaleAge, logger, }?: SetupToapiWorkerOptions): void;
+export declare function setupToapiWorker({ basePath, invalidationsUrl, maximumStaleAge, logger: customLogger, }?: SetupToapiWorkerOptions): void;
 //# sourceMappingURL=setup.d.ts.map

package/dist/setup.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"setup.d.ts","sourceRoot":"","sources":["../src/setup.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAU5C,MAAM,WAAW,uBAAuB;IACtC;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;;OAKG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,gBAAgB,CAAC,EAC/B,QAAiB,EACjB,gBAAsD,EACtD,eAAkC,EAClC,MAAM,GACP,GAAE,uBAA4B,QAwB9B"}
+{"version":3,"file":"setup.d.ts","sourceRoot":"","sources":["../src/setup.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAW5C,MAAM,WAAW,uBAAuB;IACtC;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;;;OAMG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAgB,gBAAgB,CAAC,EAC/B,QAAiB,EACjB,gBAAsD,EACtD,eAAkC,EAClC,MAAM,EAAE,YAAY,GACrB,GAAE,uBAA4B,QAkB9B"}

package/dist/setup.js

@@ -2,13 +2,18 @@ import { INVALIDATIONS_ROUTE } from "@toapi/common";
 import { cleanup } from "./cleanup";
 import { handleToapiRequest } from "./handle-toapi-request";
 import { listenForInvalidations } from "./revalidation-stream";
+import { consoleFallback } from "./console-fallback";
 const ONE_WEEK_SECONDS = 60 * 60 * 24 * 7;
 /**
  * Wire up the whole Toapi service worker in a single call. This registers the
- * `activate` and `fetch` listeners and opens the revalidation stream, and is
- * equivalent to calling {@link cleanup}, {@link handleToapiRequest}, and
+ * `fetch` listener, runs {@link cleanup}, and opens the revalidation stream,
+ * and is equivalent to calling {@link cleanup}, {@link handleToapiRequest}, and
  * {@link listenForInvalidations} by hand.
  *
+ * Cleanup runs at worker startup rather than from the `activate` event, which
+ * only fires when a new worker takes over — an installed worker that is never
+ * updated would otherwise never clean up.
+ *
  * ```ts
  * // service-worker.ts
  * import { setupToapiWorker } from "@toapi/worker";
@@ -23,13 +28,9 @@ const ONE_WEEK_SECONDS = 60 * 60 * 24 * 7;
  * `vite-plugin-pwa`'s precaching) — requests it doesn't handle fall through to
  * them.
  */
-export function setupToapiWorker({ basePath = "/api", invalidationsUrl = `${basePath}${INVALIDATIONS_ROUTE}`, maximumStaleAge = ONE_WEEK_SECONDS, logger, } = {}) {
+export function setupToapiWorker({ basePath = "/api", invalidationsUrl = `${basePath}${INVALIDATIONS_ROUTE}`, maximumStaleAge = ONE_WEEK_SECONDS, logger: customLogger, } = {}) {
+    const logger = consoleFallback(customLogger);
     const controlPrefix = `${basePath}/__tapi`;
-    const errorLog = logger?.error ??
-        ((err) => console.error("Toapi Worker: invalidation stream failed", err));
-    self.addEventListener("activate", (event) => {
-        event.waitUntil(cleanup({ maximumStaleAge }));
-    });
     self.addEventListener("fetch", (event) => {
         const url = new URL(event.request.url);
         // only handle same-origin API requests, and never the control endpoints
@@ -40,5 +41,6 @@ export function setupToapiWorker({ basePath = "/api", invalidationsUrl = `${base
             event.respondWith(handleToapiRequest(event.request, { logger }));
         }
     });
-    listenForInvalidations({ url: invalidationsUrl }).catch(errorLog);
+    listenForInvalidations({ url: invalidationsUrl, logger }).catch(logger.error);
+    cleanup({ maximumStaleAge }).catch(logger.error);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@toapi/worker",
-  "version": "1.2.1",
+  "version": "1.2.3",
   "author": {
     "name": "Michel Smola",
     "email": "michel.smola@farbenmeer.de"
@@ -20,7 +20,7 @@
     }
   },
   "dependencies": {
-    "@toapi/common": "^1.2.1"
+    "@toapi/common": "^1.2.3"
   },
   "devDependencies": {
     "@types/node": "^25.0.3",