Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add SW stub #368

Merged
merged 1 commit into from
Jul 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions web/public/service-worker.js
Original file line number Diff line number Diff line change
@@ -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)
}
})
});
})
107 changes: 0 additions & 107 deletions web/src/service-worker.ts

This file was deleted.

163 changes: 0 additions & 163 deletions web/src/serviceWorkerRegistration.ts
Original file line number Diff line number Diff line change
@@ -1,167 +1,4 @@
/// <reference types="node" />
// 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) {
Expand Down
Loading