Move serviceworker to workbox and fix SSE interference (#11538)

* Move serviceworker to workbox and fix SSE interference

Instead of statically hardcoding every frontend asset, this uses a
type-based approach to cache all js,css and manifest.json requests.

This also fixes the issue that the service worker was interfering with
EventSource because it was unconditionally handling all requests which
this new implementation doesn't.

Fixes: https://github.com/go-gitea/gitea/issues/11092
Fixes: https://github.com/go-gitea/gitea/issues/7372

* rethrow error instead of logging

* await .register

* Revert "rethrow error instead of logging"

This reverts commit 043162ba1f18b98a4bf9635959fd28d16e839fc5.

* improve comment

* remove JSRenderer

* add version-based cache invalidation

* refactor

* more refactor

* remove comment

* rename item to fit cache name

Co-authored-by: guillep2k <18600385+guillep2k@users.noreply.github.com>

web_src/js/features/serviceworker.js

@@ -0,0 +1,43 @@
+const {UseServiceWorker, AppSubUrl, AppVer} = window.config;
+const cacheName = 'static-cache-v2';
+
+async function unregister() {
+  for (const registration of await navigator.serviceWorker.getRegistrations()) {
+    const serviceWorker = registration.active;
+    if (!serviceWorker) continue;
+    registration.unregister();
+  }
+}
+
+async function invalidateCache() {
+  await caches.delete(cacheName);
+}
+
+async function checkCacheValidity() {
+  const cacheKey = AppVer;
+  const storedCacheKey = localStorage.getItem('staticCacheKey');
+
+  // invalidate cache if it belongs to a different gitea version
+  if (cacheKey && storedCacheKey !== cacheKey) {
+    invalidateCache();
+    localStorage.setItem('staticCacheKey', cacheKey);
+  }
+}
+
+export default async function initServiceWorker() {
+  if (!('serviceWorker' in navigator)) return;
+
+  if (UseServiceWorker) {
+    await checkCacheValidity();
+    try {
+      await navigator.serviceWorker.register(`${AppSubUrl}/serviceworker.js`);
+    } catch (err) {
+      console.error(err);
+      await invalidateCache();
+      await unregister();
+    }
+  } else {
+    await invalidateCache();
+    await unregister();
+  }
+}

web_src/js/index.js

@@ -14,6 +14,7 @@ import initGitGraph from './features/gitgraph.js';
 import initClipboard from './features/clipboard.js';
 import initUserHeatmap from './features/userheatmap.js';
 import initDateTimePicker from './features/datetimepicker.js';
+import initServiceWorker from './features/serviceworker.js';
 import attachTribute from './features/tribute.js';
 import createDropzone from './features/dropzone.js';
 import highlight from './features/highlight.js';
@@ -2475,6 +2476,7 @@ $(document).ready(async () => {
     initGitGraph(),
     initClipboard(),
     initUserHeatmap(),
+    initServiceWorker(),
   ]);
 });
 

web_src/js/serviceworker.js

@@ -0,0 +1,16 @@
+import {registerRoute} from 'workbox-routing';
+import {StaleWhileRevalidate} from 'workbox-strategies';
+
+const cacheName = 'static-cache-v2';
+
+const cachedDestinations = new Set([
+  'manifest',
+  'script',
+  'style',
+  'worker',
+]);
+
+registerRoute(
+  ({request}) => cachedDestinations.has(request.destination),
+  new StaleWhileRevalidate({cacheName}),
+);