Remove the service worker (#25010)

It's been disabled by default since 1.17 (https://github.com/go-gitea/gitea/pull/18914), and it never really delivered any benefit except being another cache layer that has its own unsolved invalidation issues. HTTP cache works, we don't need two cache layers at the browser for assets. ## ⚠️ BREAKING You can remove the config `[ui].USE_SERVICE_WORKER` from your `app.ini` now.
2024-12-24 17:00:39 +00:00 · 2023-05-31 04:07:04 +02:00 · 2023-05-31 04:07:04 +02:00 · 50bd7d0b24
commit 50bd7d0b24
parent 28a89e360f
15 changed files with 3 additions and 128 deletions
--- a/.dockerignore
+++ b/.dockerignore
@ -76,7 +76,6 @@ cpu.out
 /yarn-error.log
 /npm-debug.log*
 /public/js
-/public/serviceworker.js
 /public/css
 /public/fonts
 /public/img/webpack
--- a/.gitignore
+++ b/.gitignore
@ -77,7 +77,6 @@ cpu.out
 /yarn-error.log
 /npm-debug.log*
 /public/js
-/public/serviceworker.js
 /public/css
 /public/fonts
 /public/img/webpack
--- a/.ignore
+++ b/.ignore
@ -1,5 +1,6 @@
 *.min.css
 *.min.js
+/assets/*.json
 /modules/options/bindata.go
 /modules/public/bindata.go
 /modules/templates/bindata.go
--- a/2
+++ b/2
@ -114,7 +114,7 @@ FOMANTIC_WORK_DIR := web_src/fomantic
 WEBPACK_SOURCES := $(shell find web_src/js web_src/css -type f)
 WEBPACK_CONFIGS := webpack.config.js
 WEBPACK_DEST := public/js/index.js public/css/index.css
-WEBPACK_DEST_ENTRIES := public/js public/css public/fonts public/img/webpack public/serviceworker.js
+WEBPACK_DEST_ENTRIES := public/js public/css public/fonts public/img/webpack

 BINDATA_DEST := modules/public/bindata.go modules/options/bindata.go modules/templates/bindata.go
 BINDATA_HASH := $(addsuffix .hash,$(BINDATA_DEST))
--- a/custom/conf/app.example.ini
+++ b/custom/conf/app.example.ini
@ -1208,9 +1208,6 @@ LEVEL = Info
 ;; Whether to search within description at repository search on explore page.
 ;SEARCH_REPO_DESCRIPTION = true
 ;;
-;; Whether to enable a Service Worker to cache frontend assets
-;USE_SERVICE_WORKER = false
-;;
 ;; Whether to only show relevant repos on the explore page when no keyword is specified and default sorting is used.
 ;; A repo is considered irrelevant if it's a fork or if it has no metadata (no description, no icon, no topic).
 ;ONLY_SHOW_RELEVANT_REPOS = false
--- a/docs/content/doc/administration/config-cheat-sheet.en-us.md
+++ b/docs/content/doc/administration/config-cheat-sheet.en-us.md
@ -230,7 +230,6 @@ The following configuration set `Content-Type: application/vnd.android.package-a
    add it to this config.
 - `DEFAULT_SHOW_FULL_NAME`: **false**: Whether the full name of the users should be shown where possible. If the full name isn't set, the username will be used.
 - `SEARCH_REPO_DESCRIPTION`: **true**: Whether to search within description at repository search on explore page.
- `USE_SERVICE_WORKER`: **false**: Whether to enable a Service Worker to cache frontend assets.
 - `ONLY_SHOW_RELEVANT_REPOS`: **false** Whether to only show relevant repos on the explore page when no keyword is specified and default sorting is used.
    A repo is considered irrelevant if it's a fork or if it has no metadata (no description, no icon, no topic).

--- a/modules/setting/ui.go
+++ b/modules/setting/ui.go
@ -32,7 +32,6 @@ var UI = struct {
 	CustomEmojis          []string
 	CustomEmojisMap       map[string]string `ini:"-"`
 	SearchRepoDescription bool
-	UseServiceWorker      bool
 	OnlyShowRelevantRepos bool

 	Notification struct {
@ -136,7 +135,6 @@ func loadUIFrom(rootCfg ConfigProvider) {
 	UI.ShowUserEmail = sec.Key("SHOW_USER_EMAIL").MustBool(true)
 	UI.DefaultShowFullName = sec.Key("DEFAULT_SHOW_FULL_NAME").MustBool(false)
 	UI.SearchRepoDescription = sec.Key("SEARCH_REPO_DESCRIPTION").MustBool(true)
-	UI.UseServiceWorker = sec.Key("USE_SERVICE_WORKER").MustBool(false)

 	// OnlyShowRelevantRepos=false is important for many private/enterprise instances,
 	// because many private repositories do not have "description/topic", users just want to search by their names.
--- a/modules/templates/helper.go
+++ b/modules/templates/helper.go
@ -127,9 +127,6 @@ func NewFuncMap() template.FuncMap {
 		"MetaKeywords": func() string {
 			return setting.UI.Meta.Keywords
 		},
-		"UseServiceWorker": func() bool {
-			return setting.UI.UseServiceWorker
-		},
 		"EnableTimetracking": func() bool {
 			return setting.Service.EnableTimetracking
 		},
--- a/package-lock.json
+++ b/package-lock.json
@ -51,8 +51,6 @@
        "vue3-calendar-heatmap": "2.0.5",
        "webpack": "5.84.1",
        "webpack-cli": "5.1.1",
-        "workbox-routing": "6.6.0",
-        "workbox-strategies": "6.6.0",
        "wrap-ansi": "8.1.0"
      },
      "devDependencies": {
@ -11045,27 +11043,6 @@
        "node": ">=0.10.0"
      }
    },
-    "node_modules/workbox-core": {
-      "version": "6.6.0",
-      "resolved": "https://registry.npmjs.org/workbox-core/-/workbox-core-6.6.0.tgz",
-      "integrity": "sha512-GDtFRF7Yg3DD859PMbPAYPeJyg5gJYXuBQAC+wyrWuuXgpfoOrIQIvFRZnQ7+czTIQjIr1DhLEGFzZanAT/3bQ=="
-    },
-    "node_modules/workbox-routing": {
-      "version": "6.6.0",
-      "resolved": "https://registry.npmjs.org/workbox-routing/-/workbox-routing-6.6.0.tgz",
-      "integrity": "sha512-x8gdN7VDBiLC03izAZRfU+WKUXJnbqt6PG9Uh0XuPRzJPpZGLKce/FkOX95dWHRpOHWLEq8RXzjW0O+POSkKvw==",
-      "dependencies": {
-        "workbox-core": "6.6.0"
-      }
-    },
-    "node_modules/workbox-strategies": {
-      "version": "6.6.0",
-      "resolved": "https://registry.npmjs.org/workbox-strategies/-/workbox-strategies-6.6.0.tgz",
-      "integrity": "sha512-eC07XGuINAKUWDnZeIPdRdVja4JQtTuc35TZ8SwMb1ztjp7Ddq2CJ4yqLvWzFWGlYI7CG/YGqaETntTxBGdKgQ==",
-      "dependencies": {
-        "workbox-core": "6.6.0"
-      }
-    },
    "node_modules/wrap-ansi": {
      "version": "8.1.0",
      "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-8.1.0.tgz",
--- a/package.json
+++ b/package.json
@ -51,8 +51,6 @@
    "vue3-calendar-heatmap": "2.0.5",
    "webpack": "5.84.1",
    "webpack-cli": "5.1.1",
-    "workbox-routing": "6.6.0",
-    "workbox-strategies": "6.6.0",
    "wrap-ansi": "8.1.0"
  },
  "devDependencies": {
--- a/templates/base/head_script.tmpl
+++ b/templates/base/head_script.tmpl
@ -12,7 +12,6 @@ If you introduce mistakes in it, Gitea JavaScript code wouldn't run correctly.
 		assetUrlPrefix: '{{AssetUrlPrefix}}',
 		runModeIsProd: {{.RunModeIsProd}},
 		customEmojis: {{CustomEmojis}},
-		useServiceWorker: {{UseServiceWorker}},
 		csrfToken: '{{.CsrfToken}}',
 		pageData: {{.PageData}},
 		notificationSettings: {{NotificationSettings}}, {{/*a map provided by NewFuncMap in helper.go*/}}
--- a/web_src/js/features/serviceworker.js
+++ b/web_src/js/features/serviceworker.js
@ -1,57 +0,0 @@
-import {joinPaths, parseUrl} from '../utils.js';
-
-const {useServiceWorker, assetUrlPrefix, assetVersionEncoded} = window.config;
-const cachePrefix = 'static-cache-v'; // actual version is set in the service worker script
-const workerUrl = `${joinPaths(assetUrlPrefix, 'serviceworker.js')}?v=${assetVersionEncoded}`;
-
-async function unregisterAll() {
-  for (const registration of await navigator.serviceWorker.getRegistrations()) {
-    if (registration.active) await registration.unregister();
-  }
-}
-
-async function unregisterOtherWorkers() {
-  for (const registration of await navigator.serviceWorker.getRegistrations()) {
-    const scriptPath = parseUrl(registration.active?.scriptURL || '').pathname;
-    const workerPath = parseUrl(workerUrl).pathname;
-    if (scriptPath !== workerPath) await registration.unregister();
-  }
-}
-
-async function invalidateCache() {
-  for (const key of await caches.keys()) {
-    if (key.startsWith(cachePrefix)) caches.delete(key);
-  }
-}
-
-async function checkCacheValidity() {
-  const cacheKey = assetVersionEncoded;
-  const storedCacheKey = localStorage.getItem('staticCacheKey');
-
-  // invalidate cache if it belongs to a different gitea version
-  if (cacheKey && storedCacheKey !== cacheKey) {
-    await invalidateCache();
-    localStorage.setItem('staticCacheKey', cacheKey);
-  }
-}
-
-export async function initServiceWorker() {
-  if (!('serviceWorker' in navigator)) return;
-
-  if (useServiceWorker) {
-    // unregister all service workers where scriptURL does not match the current one
-    await unregisterOtherWorkers();
-    try {
-      // the spec strictly requires it to be same-origin so the AssetUrlPrefix should contain AppSubUrl
-      await checkCacheValidity();
-      await navigator.serviceWorker.register(workerUrl);
-    } catch (err) {
-      console.error(err);
-      await invalidateCache();
-      await unregisterAll();
-    }
-  } else {
-    await invalidateCache();
-    await unregisterAll();
-  }
-}
--- a/web_src/js/index.js
+++ b/web_src/js/index.js
@ -11,7 +11,6 @@ import {initHeatmap} from './features/heatmap.js';
 import {initImageDiff} from './features/imagediff.js';
 import {initRepoMigration} from './features/repo-migration.js';
 import {initRepoProject} from './features/repo-projects.js';
-import {initServiceWorker} from './features/serviceworker.js';
 import {initTableSort} from './features/tablesort.js';
 import {initAdminUserListSearchForm} from './features/admin/users.js';
 import {initAdminConfigs} from './features/admin/config.js';
@ -116,7 +115,6 @@ onDomReady(() => {
  initImageDiff();
  initMarkupAnchors();
  initMarkupContent();
-  initServiceWorker();
  initSshKeyFormParser();
  initStopwatch();
  initTableSort();
--- a/web_src/js/serviceworker.js
+++ b/web_src/js/serviceworker.js
@ -1,23 +0,0 @@
-import {registerRoute} from 'workbox-routing';
-import {StaleWhileRevalidate} from 'workbox-strategies';
-
-const cacheName = 'static-cache-v2';
-
-// disable workbox debug logging in development, remove when debugging the service worker
-self.__WB_DISABLE_DEV_LOGS = true;
-
-// see https://developer.mozilla.org/en-US/docs/Web/API/RequestDestination for possible values
-const cachedDestinations = new Set([
-  'font',
-  'manifest',
-  'paintworklet',
-  'script',
-  'sharedworker',
-  'style',
-  'worker',
-]);
-
-registerRoute(
-  ({request}) => cachedDestinations.has(request.destination),
-  new StaleWhileRevalidate({cacheName}),
-);
--- a/webpack.config.js
+++ b/webpack.config.js
@ -62,9 +62,6 @@ export default {
      fileURLToPath(new URL('web_src/js/standalone/swagger.js', import.meta.url)),
      fileURLToPath(new URL('web_src/css/standalone/swagger.css', import.meta.url)),
    ],
-    serviceworker: [
-      fileURLToPath(new URL('web_src/js/serviceworker.js', import.meta.url)),
-    ],
    'eventsource.sharedworker': [
      fileURLToPath(new URL('web_src/js/features/eventsource.sharedworker.js', import.meta.url)),
    ],
@ -73,11 +70,7 @@ export default {
  devtool: false,
  output: {
    path: fileURLToPath(new URL('public', import.meta.url)),
-    filename: ({chunk}) => {
-      // serviceworker can only manage assets below it's script's directory so
-      // we have to put it in / instead of /js/
-      return chunk.name === 'serviceworker' ? '[name].js' : 'js/[name].js';
-    },
+    filename: () => 'js/[name].js',
    chunkFilename: ({chunk}) => {
      const language = (/monaco.*languages?_.+?_(.+?)_/.exec(chunk.id) || [])[1];
      return `js/${language ? `monaco-language-${language.toLowerCase()}` : `[name]`}.[contenthash:8].js`;