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) <[email protected]>
101 lines
3.0 KiB
TypeScript
101 lines
3.0 KiB
TypeScript
import { test, expect, describe } from "bun:test";
|
|
import { requestUpdate, type UpdateHandle } from "./swUpdate.ts";
|
|
|
|
function fakeHandle() {
|
|
const events: string[] = [];
|
|
let controllerListener: (() => void) | null = null;
|
|
let timer: { fn: () => void; ms: number } | null = null;
|
|
let unsubscribed = false;
|
|
|
|
const handle: UpdateHandle = {
|
|
postSkipWaiting() {
|
|
events.push("postSkipWaiting");
|
|
},
|
|
onControllerChange(listener) {
|
|
events.push("listen");
|
|
controllerListener = listener;
|
|
return () => {
|
|
unsubscribed = true;
|
|
};
|
|
},
|
|
setTimer(fn, ms) {
|
|
timer = { fn, ms };
|
|
return () => {};
|
|
},
|
|
reload() {
|
|
events.push("reload");
|
|
},
|
|
};
|
|
|
|
return {
|
|
handle,
|
|
events,
|
|
get unsubscribed() {
|
|
return unsubscribed;
|
|
},
|
|
fireControllerChange: () => controllerListener?.(),
|
|
fireTimeout: () => timer?.fn(),
|
|
get timerMs() {
|
|
return timer?.ms;
|
|
},
|
|
};
|
|
}
|
|
|
|
describe("applying a waiting service worker", () => {
|
|
/**
|
|
* The bug: applyUpdate posted SKIP_WAITING and called reload() on the very
|
|
* next line. Measured in Chrome, the controller had NOT changed at that
|
|
* instant — it changed 2 ms later — so the reload raced activation. When the
|
|
* reload won, the fresh page still saw registration.waiting and showed
|
|
* "A new version is ready" again, and clicking Reload re-entered the same
|
|
* race. The prompt never went away.
|
|
*/
|
|
test("does not reload until the new worker actually takes control", () => {
|
|
const f = fakeHandle();
|
|
requestUpdate(f.handle);
|
|
expect(f.events).toEqual(["listen", "postSkipWaiting"]);
|
|
expect(f.events).not.toContain("reload");
|
|
});
|
|
|
|
test("listens before posting, or a fast activation is missed entirely", () => {
|
|
const f = fakeHandle();
|
|
requestUpdate(f.handle);
|
|
expect(f.events.indexOf("listen")).toBeLessThan(f.events.indexOf("postSkipWaiting"));
|
|
});
|
|
|
|
test("reloads once the controller changes", () => {
|
|
const f = fakeHandle();
|
|
requestUpdate(f.handle);
|
|
f.fireControllerChange();
|
|
expect(f.events).toEqual(["listen", "postSkipWaiting", "reload"]);
|
|
});
|
|
|
|
/**
|
|
* A worker that ignores SKIP_WAITING — the deliberately inert one the dev
|
|
* server serves, or a genuinely broken build — must not leave the Reload
|
|
* button dead. Reload anyway; the user asked for it.
|
|
*/
|
|
test("reloads anyway if the worker never takes control", () => {
|
|
const f = fakeHandle();
|
|
requestUpdate(f.handle, 1500);
|
|
expect(f.timerMs).toBe(1500);
|
|
f.fireTimeout();
|
|
expect(f.events).toEqual(["listen", "postSkipWaiting", "reload"]);
|
|
});
|
|
|
|
test("reloads exactly once when both the change and the timeout fire", () => {
|
|
const f = fakeHandle();
|
|
requestUpdate(f.handle);
|
|
f.fireControllerChange();
|
|
f.fireTimeout();
|
|
expect(f.events.filter((e) => e === "reload")).toHaveLength(1);
|
|
});
|
|
|
|
test("stops listening once it has reloaded", () => {
|
|
const f = fakeHandle();
|
|
requestUpdate(f.handle);
|
|
f.fireControllerChange();
|
|
expect(f.unsubscribed).toBe(true);
|
|
});
|
|
});
|