feat: service worker cache static app resources, and all entry points (#18043)

* feat: service worker cache static app resources, and all entry points

* review comments

* review

* lint

* minor tweaks

* review comments

* optimize disabled cache

---------

Co-authored-by: Alex <alex.tran1502@gmail.com>
This commit is contained in:
Min Idzelis
2025-06-12 19:33:29 -04:00
committed by GitHub
parent 8923d5b0a3
commit ed5b260eeb
5 changed files with 180 additions and 75 deletions

View File

@@ -2,85 +2,25 @@
/// <reference no-default-lib="true"/>
/// <reference lib="esnext" />
/// <reference lib="webworker" />
import { version } from '$service-worker';
import { installBroadcastChannelListener } from './broadcast-channel';
import { addFilesToCache, deleteOldCaches } from './cache';
import { handleFetchEvent } from './fetch-event';
const useCache = true;
const sw = globalThis as unknown as ServiceWorkerGlobalScope;
const pendingLoads = new Map<string, AbortController>();
// Create a unique cache name for this deployment
const CACHE = `cache-${version}`;
sw.addEventListener('install', (event) => {
event.waitUntil(sw.skipWaiting());
});
sw.addEventListener('activate', (event) => {
const handleActivate = (event: ExtendableEvent) => {
event.waitUntil(sw.clients.claim());
// Remove previous cached data from disk
event.waitUntil(deleteOldCaches());
});
sw.addEventListener('fetch', (event) => {
if (event.request.method !== 'GET') {
return;
}
const url = new URL(event.request.url);
if (/^\/api\/assets\/[a-f0-9-]+\/(original|thumbnail)/.test(url.pathname)) {
event.respondWith(immichAsset(url));
}
});
async function deleteOldCaches() {
for (const key of await caches.keys()) {
if (key !== CACHE) {
await caches.delete(key);
}
}
}
async function immichAsset(url: URL) {
const cache = await caches.open(CACHE);
let response = useCache ? await cache.match(url) : undefined;
if (response) {
return response;
}
try {
const cancelToken = new AbortController();
const request = fetch(url, {
signal: cancelToken.signal,
});
pendingLoads.set(url.toString(), cancelToken);
response = await request;
if (!(response instanceof Response)) {
throw new TypeError('invalid response from fetch');
}
if (response.status === 200) {
cache.put(url, response.clone());
}
return response;
} catch {
return Response.error();
} finally {
pendingLoads.delete(url.toString());
}
}
const broadcast = new BroadcastChannel('immich');
// eslint-disable-next-line unicorn/prefer-add-event-listener
broadcast.onmessage = (event) => {
if (!event.data) {
return;
}
const urlstring = event.data.url;
const url = new URL(urlstring, event.origin);
if (event.data.type === 'cancel') {
const pending = pendingLoads.get(url.toString());
if (pending) {
pending.abort();
pendingLoads.delete(url.toString());
}
} else if (event.data.type === 'preload') {
immichAsset(url);
}
};
const handleInstall = (event: ExtendableEvent) => {
event.waitUntil(sw.skipWaiting());
// Create a new cache and add all files to it
event.waitUntil(addFilesToCache());
};
sw.addEventListener('install', handleInstall);
sw.addEventListener('activate', handleActivate);
sw.addEventListener('fetch', handleFetchEvent);
installBroadcastChannelListener();