Lucas WintherandClaude Opus 5
e6da85e7f9
Two defects behind "the new version is ready" not going away.
1. THE WORKER NEVER INSTALLED — in any environment, ever.
install did `cache.addAll([...PRECACHE, SHELL])`. PRECACHE is derived from
the build's own outputs, which already contain index.html, and SHELL is
index.html again. addAll() rejects the ENTIRE install on a duplicate
request:
InvalidStateError: Cache.addAll(): duplicate requests (.../index.html)
So install failed on every load, the worker went redundant, and nothing
ever activated. Registration itself succeeds and the failure is inside the
install event, so nothing surfaced it — which is why offline behaviour was
listed as "never verified" rather than "broken". All 11 precached URLs
return 200; the list was the only fault. Deduping now lives in
src/swPrecache.ts, at the point of use, so no future addition to either
list can reintroduce it.
Verified in a real browser for the first time: the worker installs,
activates, claims the page, and caches 11 entries. A rebuild is then
detected, the prompt appears, clicking Reload applies it, stale caches are
dropped and the prompt does not return.
2. THE DEV WORKER IGNORED THE LIFECYCLE — my own regression, from 53707b1.
That commit made the dev server serve an inert sw.js to silence a MIME
error. Inert included the lifecycle: no skipWaiting, no clients.claim, no
message handler. A worker like that can sit in `waiting` forever and can
never be applied, so the prompt returns on every load and the Reload button
cannot possibly clear it. This is the likeliest cause of the reported
symptom, since with defect 1 a production build could never have shown that
prompt at all. The dev worker still caches nothing — that would fight HMR —
but now honours install, activate and SKIP_WAITING.
3. applyUpdate RACED ITS OWN RELOAD — real, measured, but not reproducible on
demand, so it is hardening rather than a proven fix.
It posted SKIP_WAITING and called window.location.reload() on the next
line. Measured in Chrome: at that instant the new worker was still
`installed` and the controller had NOT changed — it changed 2 ms later. The
window is wider in practice because activate deletes every stale cache
before claiming clients. When the reload wins, the reloaded page still finds
registration.waiting and shows the prompt again. It now waits for
controllerchange, with a timeout backstop so a worker that ignores
SKIP_WAITING cannot leave the button dead. The sequencing is pure and
tested (src/ui/swUpdate.ts): listener attached before the message, reload
exactly once, unsubscribed after.
Tooling: scripts/screenshot.ts gains --profile (a fresh Chrome profile has no
registered worker, so nothing stateful across loads could be reproduced at all)
and --eval-after-file (observe a flow that ends in a navigation from the other
side of it).
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
53 lines
2.0 KiB
TypeScript
53 lines
2.0 KiB
TypeScript
/**
|
|
* Sequencing for "apply the waiting service worker, then reload".
|
|
*
|
|
* Pure, with every browser touchpoint injected, because the bug it fixes is
|
|
* entirely about ORDER and order is what a test can pin. The old code was:
|
|
*
|
|
* waiting.postMessage({ type: "SKIP_WAITING" });
|
|
* window.location.reload();
|
|
*
|
|
* Measured in Chrome: at the moment of that reload the new worker was still
|
|
* `installed` and the controller had not changed — it changed 2 ms later. So
|
|
* the reload raced activation. When the reload won, the fresh page load still
|
|
* found `registration.waiting` and showed "A new version is ready" again, and
|
|
* pressing Reload re-entered the same race. The prompt never went away.
|
|
*
|
|
* The window is wider than 2 ms in practice: the worker's `activate` handler
|
|
* deletes every stale cache before calling `clients.claim()`.
|
|
*/
|
|
export interface UpdateHandle {
|
|
/** Tells the waiting worker to activate now. */
|
|
postSkipWaiting(): void;
|
|
/** Subscribes to the page's controller changing. Returns an unsubscribe. */
|
|
onControllerChange(listener: () => void): () => void;
|
|
setTimer(fn: () => void, ms: number): () => void;
|
|
reload(): void;
|
|
}
|
|
|
|
/**
|
|
* `timeoutMs` is a backstop, not a delay: a worker that ignores SKIP_WAITING —
|
|
* the deliberately inert one the dev server serves, or a broken build — must
|
|
* not leave the Reload button doing nothing at all. It reloads anyway, because
|
|
* that is what the user asked for.
|
|
*/
|
|
export function requestUpdate(handle: UpdateHandle, timeoutMs = 3000): void {
|
|
let reloaded = false;
|
|
|
|
const finish = () => {
|
|
if (reloaded) return;
|
|
reloaded = true;
|
|
stopListening();
|
|
cancelTimer();
|
|
handle.reload();
|
|
};
|
|
|
|
// Subscribe BEFORE posting. Activation can complete in a couple of
|
|
// milliseconds, and a listener attached afterwards would miss it and fall
|
|
// through to the timeout every time.
|
|
const stopListening = handle.onControllerChange(finish);
|
|
const cancelTimer = handle.setTimer(finish, timeoutMs);
|
|
|
|
handle.postSkipWaiting();
|
|
}
|