web: fix service worker to allow Notesnook to behave as a PWA again (#2905)

* web: make service worker work again * web: only enable sourcemap during dev
2025-12-24 07:29:30 +01:00 · 2023-07-12 06:51:14 +05:00
parent df5cbacc8a
commit 5854a3eef5
37 changed files with 1343 additions and 355 deletions
--- a/apps/web/src/service-worker.ts
+++ b/apps/web/src/service-worker.ts
@@ -0,0 +1,106 @@
+/*
+This file is part of the Notesnook project (https://notesnook.com/)
+
+Copyright (C) 2023 Streetwriters (Private) Limited
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+*/
+/* eslint-disable no-var */
+/// <reference lib="webworker" />
+
+import { clientsClaim } from "workbox-core";
+import { ExpirationPlugin } from "workbox-expiration";
+import { precacheAndRoute, createHandlerBoundToURL } from "workbox-precaching";
+import { registerRoute } from "workbox-routing";
+import { StaleWhileRevalidate } from "workbox-strategies";
+
+declare var self: ServiceWorkerGlobalScope & typeof globalThis;
+
+clientsClaim();
+
+const precacheRoutes = self.__WB_MANIFEST;
+const filters = [/KaTeX/i, /hack/i, /code-lang-/i];
+precacheAndRoute(
+  precacheRoutes.filter((route) => {
+    return filters.every(
+      (filter) => !filter.test(typeof route === "string" ? route : route.url)
+    );
+  })
+);
+
+// Set up App Shell-style routing, so that all navigation requests
+// are fulfilled with your index.html shell. Learn more at
+// https://developers.google.com/web/fundamentals/architecture/app-shell
+const fileExtensionRegexp = new RegExp("/[^/?]+\\.[^/]+$");
+registerRoute(
+  // Return false to exempt requests from being fulfilled by index.html.
+  ({ request, url }) => {
+    // If this isn't a navigation, skip.
+    if (request.mode !== "navigate") {
+      return false;
+    } // If this is a URL that starts with /_, skip.
+
+    if (url.pathname.startsWith("/_")) {
+      return false;
+    } // If this looks like a URL for a resource, because it contains // a file extension, skip.
+
+    if (url.pathname.match(fileExtensionRegexp)) {
+      return false;
+    } // Return true to signal that we want to use the handler.
+
+    return true;
+  },
+  createHandlerBoundToURL(PUBLIC_URL + "/index.html")
+);
+
+// An example runtime caching route for requests that aren't handled by the
+// precache, in this case same-origin .png requests like those from in public/
+registerRoute(
+  // Add in any other file extensions or routing criteria as needed.
+  ({ url }) =>
+    url.origin === self.location.origin && url.pathname.endsWith(".png"), // Customize this strategy as needed, e.g., by changing to CacheFirst.
+  new StaleWhileRevalidate({
+    cacheName: "images",
+    plugins: [
+      // Ensure that once this runtime cache reaches a maximum size the
+      // least-recently used images are removed.
+      new ExpirationPlugin({ maxEntries: 50 })
+    ]
+  })
+);
+
+// This allows the web app to trigger skipWaiting via
+// registration.waiting.postMessage({type: 'SKIP_WAITING'})
+self.addEventListener("message", (event) => {
+  const { data } = event;
+  if (!data) return;
+
+  switch (data.type) {
+    case "SKIP_WAITING":
+      self.skipWaiting();
+      break;
+    case "GET_VERSION":
+      {
+        if (!event.source) return;
+        event.source.postMessage({
+          type: data.type,
+          version: APP_VERSION,
+          hash: GIT_HASH
+        });
+      }
+      break;
+    default:
+      break;
+  }
+});