diff --git a/CHANGELOG.md b/CHANGELOG.md index 46de25ea8..f8713a2db 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,6 +12,8 @@ NOTE: As semantic versioning states all 0.y.z releases can contain breaking chan ### Fixed +- [#382](https://github.com/kobsio/kobs/pull/#382): [app] Remove ServiceWorker. + ### Changed ## [v0.9.0](https://github.com/kobsio/kobs/releases/tag/v0.9.0) (2022-07-05) diff --git a/plugins/app/package.json b/plugins/app/package.json index e5fcfde56..6fb7f0232 100644 --- a/plugins/app/package.json +++ b/plugins/app/package.json @@ -33,11 +33,6 @@ "react-query": "^3.39.0", "react-router-dom": "^6.3.0", "typescript": "^4.4.2", - "workbox-core": "^6.5.3", - "workbox-expiration": "^6.5.3", - "workbox-precaching": "^6.5.3", - "workbox-routing": "^6.5.3", - "workbox-strategies": "^6.5.3", "xterm": "^4.18.0", "xterm-addon-fit": "^0.5.0" }, diff --git a/plugins/app/src/App.tsx b/plugins/app/src/App.tsx index 3e60b9a31..7316198cb 100644 --- a/plugins/app/src/App.tsx +++ b/plugins/app/src/App.tsx @@ -9,7 +9,6 @@ import React, { Suspense, lazy } from 'react'; import { ErrorBoundary } from 'react-error-boundary'; import ReactDOM from 'react-dom/client'; -import * as serviceWorkerRegistration from './serviceWorkerRegistration'; import { AuthContextProvider } from './context/AuthContext'; import Header from './components/header/Header'; import { PluginsContextProvider } from './context/PluginsContext'; @@ -102,5 +101,3 @@ ReactDOM.createRoot(document.getElementById('root') as HTMLElement).render( , ); - -serviceWorkerRegistration.register(); diff --git a/plugins/app/src/service-worker.ts b/plugins/app/src/service-worker.ts deleted file mode 100644 index 790a83ee4..000000000 --- a/plugins/app/src/service-worker.ts +++ /dev/null @@ -1,80 +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 { createHandlerBoundToURL, precacheAndRoute } from 'workbox-precaching'; -import { ExpirationPlugin } from 'workbox-expiration'; -import { StaleWhileRevalidate } from 'workbox-strategies'; -import { clientsClaim } from 'workbox-core'; -import { registerRoute } from 'workbox-routing'; - -declare const self: ServiceWorkerGlobalScope; - -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 -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(process.env.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) => { - if (event.data && event.data.type === 'SKIP_WAITING') { - self.skipWaiting(); - } -}); - -// Any other custom service worker logic can go here. diff --git a/plugins/app/src/serviceWorkerRegistration.ts b/plugins/app/src/serviceWorkerRegistration.ts deleted file mode 100644 index fd26bd978..000000000 --- a/plugins/app/src/serviceWorkerRegistration.ts +++ /dev/null @@ -1,140 +0,0 @@ -// 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 - -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}$/), -); - -type Config = { - onSuccess?: (registration: ServiceWorkerRegistration) => void; - onUpdate?: (registration: ServiceWorkerRegistration) => void; -}; - -export function register(config?: Config): void { - if (process.env.NODE_ENV === 'production' && 'serviceWorker' in navigator) { - // The URL constructor is available in all browsers that support SW. - const publicUrl = new URL(process.env.PUBLIC_URL, window.location.href); - if (publicUrl.origin !== window.location.origin) { - // Our service worker won't work if PUBLIC_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 = `${process.env.PUBLIC_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. - navigator.serviceWorker.ready.then(() => { - console.log( - 'This web app is being served cache-first by a service ' + - 'worker. To learn more, visit https://cra.link/PWA', - ); - }); - } else { - // Is not localhost. Just register service worker - registerValidSW(swUrl, config); - } - }); - } -} - -function registerValidSW(swUrl: string, config?: Config): void { - navigator.serviceWorker - .register(swUrl) - .then((registration) => { - registration.onupdatefound = (): void => { - const installingWorker = registration.installing; - if (installingWorker == null) { - return; - } - installingWorker.onstatechange = (): void => { - 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 && 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 && config.onSuccess) { - config.onSuccess(registration); - } - } - } - }; - }; - }) - .catch((error) => { - console.error('Error during service worker registration:', error); - }); -} - -function checkValidServiceWorker(swUrl: string, config?: Config): void { - // Check if the service worker can be found. If it can't reload the page. - fetch(swUrl, { - // eslint-disable-next-line @typescript-eslint/naming-convention - 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.indexOf('javascript') === -1)) { - // No service worker found. Probably a different app. Reload the page. - navigator.serviceWorker.ready.then((registration) => { - 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(): void { - if ('serviceWorker' in navigator) { - navigator.serviceWorker.ready - .then((registration) => { - registration.unregister(); - }) - .catch((error) => { - console.error(error.message); - }); - } -} diff --git a/yarn.lock b/yarn.lock index 686d0b4a2..5465de877 100644 --- a/yarn.lock +++ b/yarn.lock @@ -14137,12 +14137,12 @@ workbox-cacheable-response@6.5.3: dependencies: workbox-core "6.5.3" -workbox-core@6.5.3, workbox-core@^6.5.3: +workbox-core@6.5.3: version "6.5.3" resolved "https://registry.yarnpkg.com/workbox-core/-/workbox-core-6.5.3.tgz#bca038a9ef0d7a634a6db2a60f45313ed22ac249" integrity sha512-Bb9ey5n/M9x+l3fBTlLpHt9ASTzgSGj6vxni7pY72ilB/Pb3XtN+cZ9yueboVhD5+9cNQrC9n/E1fSrqWsUz7Q== -workbox-expiration@6.5.3, workbox-expiration@^6.5.3: +workbox-expiration@6.5.3: version "6.5.3" resolved "https://registry.yarnpkg.com/workbox-expiration/-/workbox-expiration-6.5.3.tgz#efc0811f371a2ede1052b9de1c4f072b71d50503" integrity sha512-jzYopYR1zD04ZMdlbn/R2Ik6ixiXbi15c9iX5H8CTi6RPDz7uhvMLZPKEndZTpfgmUk8mdmT9Vx/AhbuCl5Sqw== @@ -14167,7 +14167,7 @@ workbox-navigation-preload@6.5.3: dependencies: workbox-core "6.5.3" -workbox-precaching@6.5.3, workbox-precaching@^6.5.3: +workbox-precaching@6.5.3: version "6.5.3" resolved "https://registry.yarnpkg.com/workbox-precaching/-/workbox-precaching-6.5.3.tgz#c870312b2ef901d790ab9e48da084e776c62af47" integrity sha512-sjNfgNLSsRX5zcc63H/ar/hCf+T19fRtTqvWh795gdpghWb5xsfEkecXEvZ8biEi1QD7X/ljtHphdaPvXDygMQ== @@ -14195,14 +14195,14 @@ workbox-recipes@6.5.3: workbox-routing "6.5.3" workbox-strategies "6.5.3" -workbox-routing@6.5.3, workbox-routing@^6.5.3: +workbox-routing@6.5.3: version "6.5.3" resolved "https://registry.yarnpkg.com/workbox-routing/-/workbox-routing-6.5.3.tgz#a0a699d8cc90b5692bd3df24679acbbda3913777" integrity sha512-DFjxcuRAJjjt4T34RbMm3MCn+xnd36UT/2RfPRfa8VWJGItGJIn7tG+GwVTdHmvE54i/QmVTJepyAGWtoLPTmg== dependencies: workbox-core "6.5.3" -workbox-strategies@6.5.3, workbox-strategies@^6.5.3: +workbox-strategies@6.5.3: version "6.5.3" resolved "https://registry.yarnpkg.com/workbox-strategies/-/workbox-strategies-6.5.3.tgz#4bea9a48fee16cf43766e0d8138296773c8a9783" integrity sha512-MgmGRrDVXs7rtSCcetZgkSZyMpRGw8HqL2aguszOc3nUmzGZsT238z/NN9ZouCxSzDu3PQ3ZSKmovAacaIhu1w==