Remove the ServiceWorker and manifest.json

There is barely any performance benefit of SW-based caching and it
causes a lot of issues after updating a instance and when the cache is
stale, causing weird UI issues like chunk loading errors and other
unexpected behaviour.

I kept the unregistration in the code so existing serviceworkers will
properly uninstall after an update. We may be able to eventually drop
the code completely in a future version after most users have ran the
uninstallation.

manifest.json is removed because it serves no real purpose without a
serviceworker and to eliminate another HTTP request for the sake of
performance.

Fixes: #12344

Author: silverwind

Makefile

@@ -96,7 +96,7 @@ FOMANTIC_DEST_DIR := web_src/fomantic/build
 WEBPACK_SOURCES := $(shell find web_src/js web_src/less -type f) $(FOMANTIC_DEST)
 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))

custom/conf/app.example.ini

@@ -190,8 +190,6 @@ REACTIONS = +1, -1, laugh, hooray, confused, heart, rocket, eyes
 DEFAULT_SHOW_FULL_NAME = false
 ; 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 = true
 
 [ui.admin]
 ; Number of users that are displayed on one page

docs/content/doc/advanced/config-cheat-sheet.en-us.md

@@ -137,7 +137,6 @@ Values containing `#` or `;` must be quoted using `` ` `` or `"""`.
     For custom reactions, add a tightly cropped square image to public/emoji/img/reaction_name.png
 - `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`: **true**: Whether to enable a Service Worker to cache frontend assets.
 
 ### UI - Admin (`ui.admin`)
 

docs/content/doc/advanced/hacking-on-gitea.en-us.md

@@ -151,8 +151,6 @@ Before committing, make sure the linters pass:
 make lint-frontend
 ```
 
-Note: When working on frontend code, set `USE_SERVICE_WORKER` to `false` in `app.ini` to prevent undesirable caching of frontend assets.
-
 ### Building and adding SVGs
 
 SVG icons are built using the `make svg` target which compiles the icon sources defined in `build/generate-svg.js` into the output directory `public/img/svg`. Custom icons can be added in the `web_src/svg` directory.

modules/setting/setting.go

@@ -179,7 +179,6 @@ var (
 		Reactions             []string
 		ReactionsMap          map[string]bool
 		SearchRepoDescription bool
-		UseServiceWorker      bool
 
 		Notification struct {
 			MinTimeout            time.Duration
@@ -1012,7 +1011,6 @@ func NewContext() {
 	UI.ShowUserEmail = Cfg.Section("ui").Key("SHOW_USER_EMAIL").MustBool(true)
 	UI.DefaultShowFullName = Cfg.Section("ui").Key("DEFAULT_SHOW_FULL_NAME").MustBool(false)
 	UI.SearchRepoDescription = Cfg.Section("ui").Key("SEARCH_REPO_DESCRIPTION").MustBool(true)
-	UI.UseServiceWorker = Cfg.Section("ui").Key("USE_SERVICE_WORKER").MustBool(true)
 
 	HasRobotsTxt = com.IsFile(path.Join(CustomPath, "robots.txt"))
 

modules/templates/helper.go

@@ -169,9 +169,6 @@ func NewFuncMap() []template.FuncMap {
 		"MetaKeywords": func() string {
 			return setting.UI.Meta.Keywords
 		},
-		"UseServiceWorker": func() bool {
-			return setting.UI.UseServiceWorker
-		},
 		"FilenameIsImage": func(filename string) bool {
 			mimeType := mime.TypeByExtension(filepath.Ext(filename))
 			return strings.HasPrefix(mimeType, "image/")

package-lock.json

@@ -45,8 +45,6 @@
     "webpack": "4.44.0",
     "webpack-cli": "3.3.12",
     "webpack-fix-style-only-entries": "0.5.1",
-    "workbox-routing": "5.1.3",
-    "workbox-strategies": "5.1.3",
     "worker-loader": "2.0.0",
     "wrap-ansi": "7.0.0"
   },

package.json

@@ -30,7 +30,6 @@
 			AppVer: '{{AppVer}}',
 			AppSubUrl: '{{AppSubUrl}}',
 			StaticUrlPrefix: '{{StaticUrlPrefix}}',
-			UseServiceWorker: {{UseServiceWorker}},
 			csrf: '{{.CsrfToken}}',
 			HighlightJS: {{if .RequireHighlightJS}}true{{else}}false{{end}},
 			SimpleMDE: {{if .RequireSimpleMDE}}true{{else}}false{{end}},

templates/base/head.tmpl

@@ -1,53 +1,23 @@
-const {UseServiceWorker, AppSubUrl, AppVer} = window.config;
-const cachePrefix = 'static-cache-v'; // actual version is set in the service worker script
-
 async function unregister() {
+  if (!('serviceWorker' in navigator)) return;
   const registrations = await navigator.serviceWorker.getRegistrations();
   await Promise.all(registrations.map((registration) => {
     return registration.active && registration.unregister();
   }));
 }
 
 async function invalidateCache() {
+  if (!caches || !caches.keys) return;
   const cacheKeys = await caches.keys();
   await Promise.all(cacheKeys.map((key) => {
-    return key.startsWith(cachePrefix) && caches.delete(key);
+    return key.startsWith('static-cache-v') && caches.delete(key);
   }));
 }
 
-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) {
-    await invalidateCache();
-    localStorage.setItem('staticCacheKey', cacheKey);
-  }
-}
-
 export default async function initServiceWorker() {
-  if (!('serviceWorker' in navigator)) return;
-
-  if (UseServiceWorker) {
-    try {
-      // normally we'd serve the service worker as a static asset from StaticUrlPrefix but
-      // the spec strictly requires it to be same-origin so it has to be AppSubUrl to work
-      await Promise.all([
-        checkCacheValidity(),
-        navigator.serviceWorker.register(`${AppSubUrl}/serviceworker.js`),
-      ]);
-    } catch (err) {
-      console.error(err);
-      await Promise.all([
-        invalidateCache(),
-        unregister(),
-      ]);
-    }
-  } else {
-    await Promise.all([
-      invalidateCache(),
-      unregister(),
-    ]);
-  }
+  // we once had a service worker, if it's present, remove it and wipe its cache
+  await Promise.all([
+    invalidateCache(),
+    unregister(),
+  ]);
 }

web_src/js/features/serviceworker.js

@@ -50,9 +50,6 @@ module.exports = {
     swagger: [
       resolve(__dirname, 'web_src/js/standalone/swagger.js'),
     ],
-    serviceworker: [
-      resolve(__dirname, 'web_src/js/serviceworker.js'),
-    ],
     'eventsource.sharedworker': [
       resolve(__dirname, 'web_src/js/features/eventsource.sharedworker.js'),
     ],
@@ -61,11 +58,7 @@ module.exports = {
   devtool: false,
   output: {
     path: resolve(__dirname, 'public'),
-    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: 'js/[name].js',
   },
   optimization: {