diff --git a/web/public/service-worker.js b/web/public/service-worker.js new file mode 100644 index 00000000..7a43529a --- /dev/null +++ b/web/public/service-worker.js @@ -0,0 +1,19 @@ +// Self-destructible service worker stub to self-destruct old broken v1 SW + +self.addEventListener('install', function(e) { + self.skipWaiting(); +}) + +self.addEventListener('activate', function(e) { + self.registration.unregister() + .then(function () { + return self.clients.matchAll(); + }) + .then(function (clients) { + clients.forEach(client => { + if (client instanceof WindowClient) { + client.navigate(client.url) + } + }) + }); +}) diff --git a/web/src/service-worker.ts b/web/src/service-worker.ts deleted file mode 100644 index d048755c..00000000 --- a/web/src/service-worker.ts +++ /dev/null @@ -1,107 +0,0 @@ -/// -/* eslint-disable no-restricted-globals */ - -// This service worker can be customized! -// See https://developers.google.com/web/tools/workbox/modules -// for the list of available Workbox modules, or add any other -// code you'd like. -// You can also remove this file if you'd prefer not to use a -// service worker, and the Workbox build step will be skipped. - -import { clientsClaim } from 'workbox-core' -import { ExpirationPlugin } from 'workbox-expiration' -import { precacheAndRoute, createHandlerBoundToURL } from 'workbox-precaching' -import { registerRoute } from 'workbox-routing' -import { NetworkFirst, StaleWhileRevalidate } from 'workbox-strategies' -import { trimSuffix } from './utils/path' - -declare const self: ServiceWorkerGlobalScope - -const BASE_URL = trimSuffix(import.meta.env.BASE_URL, '/') - -clientsClaim() - -// Precache all of the assets generated by your build process. -// Their URLs are injected into the manifest variable below. -// This variable must be present somewhere in your service worker file, -// even if you decide not to use precaching. See https://cra.link/PWA -precacheAndRoute(self.__WB_MANIFEST) - -// 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 -// eslint-disable-next-line prefer-regex-literals -const fileExtensionRegexp = new RegExp('/[^/?]+\\.[^/]+$') -registerRoute( - // Return false to exempt requests from being fulfilled by index.html. - ({ request, url }: { request: Request; url: 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(BASE_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 }), - ], - }), -) - -// Cache WebAssembly and Go assets -// eslint-disable-next-line prefer-regex-literals -const goWasmAssetsRegExp = new RegExp('^/wasm/(.*)(.js|.wasm)$', 'i') -const DAY_IN_SECONDS = 24 * 60 * 60 -registerRoute( - ({ url }) => url.origin === self.location.origin && goWasmAssetsRegExp.test(url.pathname), - new StaleWhileRevalidate({ - cacheName: 'wasm', - plugins: [new ExpirationPlugin({ maxAgeSeconds: 5 * DAY_IN_SECONDS })], - }), -) - -const apiEndpointsForCaching = new Set(['/api/backends/info', '/api/version']) - -// Cache available Go versions from Go playground -registerRoute( - ({ url }) => url.origin === self.location.origin && apiEndpointsForCaching.has(url.pathname), - new NetworkFirst({ - cacheName: 'api', - networkTimeoutSeconds: 15, - }), -) - -// This allows the web app to trigger skipWaiting via -// registration.waiting.postMessage({type: 'SKIP_WAITING'}) -self.addEventListener('message', (event) => { - if (event.data && event.data.type === 'SKIP_WAITING') { - self.skipWaiting().catch(console.error) - } -}) - -// Any other custom service worker logic can go here. diff --git a/web/src/serviceWorkerRegistration.ts b/web/src/serviceWorkerRegistration.ts index f3989f4b..6d46f31b 100644 --- a/web/src/serviceWorkerRegistration.ts +++ b/web/src/serviceWorkerRegistration.ts @@ -1,167 +1,4 @@ /// -// This optional code is used to register a service worker. -// register() is not called by default. - -// This lets the app load faster on subsequent visits in production, and gives -// it offline capabilities. However, it also means that developers (and users) -// will only see deployed updates on subsequent visits to a page, after all the -// existing tabs open on the page have been closed, since previously cached -// resources are updated in the background. - -// To learn more about the benefits of this model and instructions on how to -// opt-in, read https://cra.link/PWA -import { trimSuffix } from './utils/path' - -const BASE_URL = trimSuffix(import.meta.env.BASE_URL, '/') - -const isLocalhost = Boolean( - window.location.hostname === 'localhost' || - // [::1] is the IPv6 localhost address. - window.location.hostname === '[::1]' || - // 127.0.0.0/8 are considered localhost for IPv4. - window.location.hostname.match(/^127(?:\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3}$/), -) - -interface Config { - onSuccess?: (registration: ServiceWorkerRegistration) => void - onUpdate?: (registration: ServiceWorkerRegistration) => void -} - -export function register(config?: Config) { - if (import.meta.env.NODE_ENV === 'production' && 'serviceWorker' in navigator) { - // The URL constructor is available in all browsers that support SW. - const publicUrl = new URL(BASE_URL, window.location.href) - if (publicUrl.origin !== window.location.origin) { - // Our service worker won't work if BASE_URL is on a different origin - // from what our page is served on. This might happen if a CDN is used to - // serve assets; see https://github.com/facebook/create-react-app/issues/2374 - return - } - - window.addEventListener('load', () => { - const swUrl = `${BASE_URL}/service-worker.js` - - if (isLocalhost) { - // This is running on localhost. Let's check if a service worker still exists or not. - checkValidServiceWorker(swUrl, config) - - // Add some additional logging to localhost, pointing developers to the - // service worker/PWA documentation. - // eslint-disable-next-line @typescript-eslint/no-floating-promises - navigator.serviceWorker.ready.then((reg) => { - console.log( - 'This web app is being served cache-first by a service ' + - 'worker. To learn more, visit https://cra.link/PWA', - ) - reg.update().catch((err) => { - console.error('Failed to update service worker: ', err) - }) - }) - } else { - // Is not localhost. Just register service worker - registerValidSW(swUrl, config) - } - }) - } -} - -/** - * Manually registers service worker - * - * @param config - */ -export function manualRegister(config?: Config) { - if (import.meta.env.DEV) { - return - } - if (!('serviceWorker' in navigator)) { - return - } - - const publicUrl = new URL(BASE_URL, window.location.href) - if (publicUrl.origin !== window.location.origin) { - return - } - - const swUrl = `${BASE_URL}/service-worker.js` - if (isLocalhost) { - checkValidServiceWorker(swUrl, config) - return - } - - registerValidSW(swUrl, config) -} - -function registerValidSW(swUrl: string, config?: Config) { - navigator.serviceWorker - .register(swUrl) - .then((registration) => { - registration.onupdatefound = () => { - const installingWorker = registration.installing - if (installingWorker == null) { - return - } - installingWorker.onstatechange = () => { - if (installingWorker.state === 'installed') { - if (navigator.serviceWorker.controller) { - // At this point, the updated precached content has been fetched, - // but the previous service worker will still serve the older - // content until all client tabs are closed. - console.log( - 'New content is available and will be used when all ' + - 'tabs for this page are closed. See https://cra.link/PWA.', - ) - - // Execute callback - if (config?.onUpdate) { - config.onUpdate(registration) - } - } else { - // At this point, everything has been precached. - // It's the perfect time to display a - // "Content is cached for offline use." message. - console.log('Content is cached for offline use.') - - // Execute callback - if (config?.onSuccess) { - config.onSuccess(registration) - } - } - } - } - } - }) - .catch((error) => { - console.error('Error during service worker registration:', error) - }) -} - -function checkValidServiceWorker(swUrl: string, config?: Config) { - // Check if the service worker can be found. If it can't reload the page. - fetch(swUrl, { - headers: { 'Service-Worker': 'script' }, - }) - .then((response) => { - // Ensure service worker exists, and that we really are getting a JS file. - const contentType = response.headers.get('content-type') - if (response.status === 404 || (contentType != null && !contentType.includes('javascript'))) { - // No service worker found. Probably a different app. Reload the page. - // eslint-disable-next-line @typescript-eslint/no-floating-promises - navigator.serviceWorker.ready.then((registration) => { - // eslint-disable-next-line @typescript-eslint/no-floating-promises - registration.unregister().then(() => { - window.location.reload() - }) - }) - } else { - // Service worker found. Proceed as normal. - registerValidSW(swUrl, config) - } - }) - .catch(() => { - console.log('No internet connection found. App is running in offline mode.') - }) -} export function unregister() { if ('serviceWorker' in navigator) {