| 1 | import assert from "node:assert/strict"; |
| 2 | import test from "node:test"; |
| 3 | |
| 4 | import { PATIENCE_MS, REFRESH_PATIENCE_MS, installResilientFetch, isNetworkFailure, keepTrying, refreshesCurrent, retriable, retryDelay, watchBuildNavigation } from "./resilient-fetch.ts"; |
| 5 | import { reconnectDelay } from "./reconnect.ts"; |
| 6 | |
| 7 | const ORIGIN = "https://g1t.sh"; |
| 8 | const url = (path: string) => new URL(path, ORIGIN); |
| 9 | |
| 10 | test("only an active navigation carries its build; fetchers, refreshes and writes never force a document switch", async () => { |
| 11 | const calls: Headers[] = []; |
| 12 | const previous = Object.getOwnPropertyDescriptor(globalThis, "window"); |
| 13 | let late: Promise<Response> | undefined; |
| 14 | const browser = { location: new URL("https://g1t.sh/edit"), fetch: async (_input: unknown, init?: RequestInit) => { calls.push(new Headers(init?.headers)); return late ?? new Response(null); } }; |
| 15 | Object.defineProperty(globalThis, "window", { value: browser, configurable: true }); |
| 16 | let destination: { pathname: string; search: string } | undefined; |
| 17 | const stop = watchBuildNavigation(() => destination); |
| 18 | try { |
| 19 | installResilientFetch("old-build"); |
| 20 | await browser.fetch("/notifications.data"); |
| 21 | destination = { pathname: "/next", search: "?tab=one" }; |
| 22 | await browser.fetch("/next.data?tab=one&_routes=root"); |
| 23 | await browser.fetch("/unrelated.data"); |
| 24 | await browser.fetch("/next.data?tab=one", { method: "POST" }); |
| 25 | await browser.fetch("/edit.data"); |
| 26 | await browser.fetch("https://external.example/next.data?tab=one"); |
| 27 | assert.deepEqual(calls.map((headers) => headers.get("x-g1t-build")), [null, "old-build", null, null, null, null]); |
| 28 | for (const path of ["/next.data?tab=one", "/__manifest?paths=/next"]) { |
| 29 | let finish!: (response: Response) => void; |
| 30 | late = new Promise<Response>((resolve) => { finish = resolve; }); |
| 31 | const controller = new AbortController(); |
| 32 | const abandoned = browser.fetch(path, { signal: controller.signal }); |
| 33 | // A transport can finish after the second click canceled the first. |
| 34 | controller.abort(); |
| 35 | const rejected = assert.rejects(abandoned, { name: "AbortError" }); |
| 36 | finish(new Response(null, { status: 204, headers: { "X-Remix-Reload-Document": "true" } })); |
| 37 | await rejected; |
| 38 | late = undefined; |
| 39 | assert.equal((await browser.fetch("/newer.data")).status, 200); |
| 40 | } |
| 41 | } finally { |
| 42 | stop(); |
| 43 | if (previous) Object.defineProperty(globalThis, "window", previous); |
| 44 | else Reflect.deleteProperty(globalThis, "window"); |
| 45 | } |
| 46 | }); |
| 47 | |
| 48 | test("a request that got no answer, in each browser's words, is a network failure", () => { |
| 49 | assert.equal(isNetworkFailure(new TypeError("Failed to fetch")), true); |
| 50 | assert.equal(isNetworkFailure(new TypeError("NetworkError when attempting to fetch resource.")), true); |
| 51 | assert.equal(isNetworkFailure(new TypeError("Load failed")), true); |
| 52 | }); |
| 53 | |
| 54 | test("a stale build, an abort or a server's error is not", () => { |
| 55 | assert.equal(isNetworkFailure(new TypeError("Failed to fetch dynamically imported module: https://g1t.sh/assets/a.js")), false); |
| 56 | assert.equal(isNetworkFailure(new DOMException("The user aborted a request.", "AbortError")), false); |
| 57 | assert.equal(isNetworkFailure(new Error("Failed to fetch")), false); |
| 58 | assert.equal(isNetworkFailure({ status: 500 }), false); |
| 59 | }); |
| 60 | |
| 61 | test("only the router's own reads are sent again", () => { |
| 62 | assert.equal(retriable(url("/flagon-io/g1t/settings/repository.data?_routes=root"), "GET", ORIGIN), true); |
| 63 | assert.equal(retriable(url("/__manifest?p=/a"), "get", ORIGIN), true); |
| 64 | assert.equal(retriable(url("/flagon-io/g1t/settings/repository.data"), "POST", ORIGIN), false); |
| 65 | assert.equal(retriable(url("/-/notify"), "GET", ORIGIN), false); |
| 66 | assert.equal(retriable(new URL("https://otel.g1t.sh/x.data"), "GET", ORIGIN), false); |
| 67 | }); |
| 68 | |
| 69 | test("a read for the page already showing is a refresh; one for another page is a navigation", () => { |
| 70 | const here = { pathname: "/flagon-io/g1t/settings/repository", search: "" }; |
| 71 | assert.equal(refreshesCurrent(url("/flagon-io/g1t/settings/repository.data?_routes=root,routes/repo/layout"), here), true); |
| 72 | assert.equal(refreshesCurrent(url("/flagon-io/g1t/issues.data"), here), false); |
| 73 | assert.equal(refreshesCurrent(url("/_root.data"), { pathname: "/", search: "" }), true); |
| 74 | assert.equal(refreshesCurrent(url("/a.data?tab=open&_routes=x"), { pathname: "/a", search: "?tab=open" }), true); |
| 75 | assert.equal(refreshesCurrent(url("/a.data?tab=closed"), { pathname: "/a", search: "?tab=open" }), false); |
| 76 | }); |
| 77 | |
| 78 | test("retries come quickly at first, then settle", () => { |
| 79 | assert.deepEqual([1, 2, 3, 4, 5, 9].map(retryDelay), [250, 500, 1000, 2000, 4000, 5000]); |
| 80 | assert.deepEqual([1, 2, 3, 4, 8].map(reconnectDelay), [3000, 6000, 12000, 24000, 30000]); |
| 81 | }); |
| 82 | |
| 83 | test("a refresh waits out the browser being offline, however long", () => { |
| 84 | assert.equal(keepTrying({ refresh: true, elapsedMs: 60 * 60_000, onlineMs: 0, erroring: false }, 5000), true); |
| 85 | }); |
| 86 | |
| 87 | test("a network that is up and never answers is no blip: a refresh gives up, and so does a click", () => { |
| 88 | assert.equal(keepTrying({ refresh: true, elapsedMs: 0, onlineMs: REFRESH_PATIENCE_MS - 5000, erroring: false }, 5000), true); |
| 89 | assert.equal(keepTrying({ refresh: true, elapsedMs: 0, onlineMs: REFRESH_PATIENCE_MS - 4000, erroring: false }, 5000), false); |
| 90 | assert.equal(keepTrying({ refresh: false, elapsedMs: PATIENCE_MS - 4000, onlineMs: 0, erroring: false }, 5000), false); |
| 91 | }); |
| 92 | |
| 93 | test("while the error page tries on its own, a read is tried once", () => { |
| 94 | assert.equal(keepTrying({ refresh: true, elapsedMs: 0, onlineMs: 0, erroring: true }, 250), false); |
| 95 | }); |