Skip to content

The agent that grows with you

test(web): drive chunk-load recovery through a real vite:preloadError event

Teknium010611bc5e6b
diff --git a/web/src/lib/chunk-load-recovery.test.ts b/web/src/lib/chunk-load-recovery.test.ts
index 62851ca91aa..b00f90ef4ef 100644
--- a/web/src/lib/chunk-load-recovery.test.ts
+++ b/web/src/lib/chunk-load-recovery.test.ts
@@ -1,5 +1,5 @@
import { describe, expect, it, vi } from "vitest";
-import { reloadForChunkLoadError } from "./chunk-load-recovery";
+import { reloadForChunkLoadError, startChunkLoadRecovery } from "./chunk-load-recovery";
function memoryStorage() {
const data = new Map<string, string>();
@@ -35,3 +35,47 @@ describe("reloadForChunkLoadError", () => {
expect(reload).not.toHaveBeenCalled();
});
});
+
+describe("startChunkLoadRecovery", () => {
+ function preloadError(payload: unknown) {
+ return Object.assign(new Event("vite:preloadError"), { payload });
+ }
+
+ it("turns vite:preloadError into one reload, then suppresses the next one", () => {
+ const target = new EventTarget();
+ const reload = vi.fn();
+ startChunkLoadRecovery(target as unknown as Window, { storage: memoryStorage(), reload });
+ target.dispatchEvent(preloadError(staleChunk()));
+ expect(reload).toHaveBeenCalledTimes(1);
+ target.dispatchEvent(preloadError(staleChunk()));
+ expect(reload).toHaveBeenCalledTimes(1);
+ });
+
+ it.each([
+ ["chunk CSS", "Unable to preload CSS for /assets/ConfigPage-D09a41f-.css"],
+ ["Safari, no URL", "Importing a module script failed."],
+ ["Firefox", "error loading dynamically imported module: http://127.0.0.1:9119/assets/ConfigPage-D09a41f-.js"],
+ ])("reloads for a %s failure", (_name, message) => {
+ const target = new EventTarget();
+ const reload = vi.fn();
+ startChunkLoadRecovery(target as unknown as Window, { storage: memoryStorage(), reload });
+ target.dispatchEvent(preloadError(new Error(message)));
+ expect(reload).toHaveBeenCalledTimes(1);
+ });
+
+ it("never reloads when session storage throws", () => {
+ const target = new EventTarget();
+ const reload = vi.fn();
+ const throwing = {
+ getItem: () => {
+ throw new DOMException("denied", "SecurityError");
+ },
+ setItem: () => {
+ throw new DOMException("denied", "SecurityError");
+ },
+ };
+ startChunkLoadRecovery(target as unknown as Window, { storage: throwing, reload });
+ target.dispatchEvent(preloadError(staleChunk()));
+ expect(reload).not.toHaveBeenCalled();
+ });
+});
diff --git a/web/src/lib/chunk-load-recovery.ts b/web/src/lib/chunk-load-recovery.ts
index 03e30344fdc..76ad8aba6bc 100644
--- a/web/src/lib/chunk-load-recovery.ts
+++ b/web/src/lib/chunk-load-recovery.ts
@@ -54,8 +54,11 @@ export function reloadForChunkLoadError(
/** Vite dispatches `vite:preloadError` for every failed lazy import and chunk
* CSS preload, including imports nobody awaits. The event is not cancelled,
* so the import still rejects as before when no reload happens. */
-export function startChunkLoadRecovery(target: Pick<Window, "addEventListener"> = window): void {
+export function startChunkLoadRecovery(
+ target: Pick<Window, "addEventListener"> = window,
+ { storage, reload }: { storage?: ReloadStorage | null; reload?: () => void } = {},
+): void {
target.addEventListener("vite:preloadError", (event) => {
- reloadForChunkLoadError((event as Event & { payload?: unknown }).payload);
+ reloadForChunkLoadError((event as Event & { payload?: unknown }).payload, storage, reload);
});
}