Files
siftlode/frontend/src/lib/useUrlMirror.dom.test.ts
T
peter 4aaaaa7860 chore(comments): drop epic, sprint and review-round ids from the code
The code cited its plan instead of saying why: `E28 review J4`, `(R6 S3b)`, `S1 justified…`,
`deep-review round 5`. That plan lives in the private ops repo, so for every reader of this one the
citation was noise, and a sentence whose subject was the plan step ("round 2 showed…") hid its
lesson behind an id. Each one is gone and the "why" kept: a bare citation is deleted, a sentence
carrying a lesson is reworded around it ("a later attempt showed…").

Measured (`scripts/audit_metrics.py`, product code): 652 lines in 270 files carried an epic code by
the definition the next commit holds (507 / 241 by the old, two-digit-only one) -> 0. Across all
code, tests, scripts and configs: ~1100 epic-code lines plus ~320 sprint/round ids.

Behaviour unchanged, checked mechanically: every changed .py file has the same AST once docstrings
are blanked; css/sh/toml/yml/json files are identical once comments are stripped; the only
non-comment changes in TS/JS are test titles, one description string in a contract table, and five
ESLint messages, whose text is all the gates snapshot diff holds. Not touched: Markdown (docs and
the changelog keep their history), Alembic migrations, TV episode notation (`S2 · E5`), DESIGN.md
ids (`C1`, `B4`, `S3h`), tracker ids (`SEC-16`, `DX-17`).

One stale claim fixed on the way: test_hls_reaper's docstring said the player checkpoints "every
10 s whether or not it is playing", which plex/stream.py calls wrong; it now says what the code does.
2026-10-05 00:19:39 +02:00

62 lines
2.6 KiB
TypeScript

// @vitest-environment jsdom
//
// useUrlMirror: mirror a set of nav params onto the CURRENT history entry (replaceState) whenever they
// change. Backfills coverage a review found missing — the effect keys on the SERIALIZED updates
// so an inline object literal (new identity every render) only fires when a param actually changes; a
// null value clears a key; and every other param on the URL is preserved.
import { describe, it, expect, beforeEach, afterEach, vi } from "vitest";
import { renderHook } from "@testing-library/react";
import { useUrlMirror } from "./useUrlMirror";
const setUrl = (search: string) => window.history.replaceState(null, "", search || "/");
let spy: ReturnType<typeof vi.spyOn>;
beforeEach(() => {
setUrl("/");
spy = vi.spyOn(window.history, "replaceState");
});
afterEach(() => spy.mockRestore());
describe("useUrlMirror", () => {
it("writes the param onto the current entry on mount", () => {
renderHook(() => useUrlMirror({ pl: "5" }));
expect(window.location.search).toBe("?pl=5");
expect(spy).toHaveBeenCalledTimes(1);
});
it("does not re-fire when the serialized updates are unchanged (stable dep)", () => {
const { rerender } = renderHook((p: Record<string, string | null>) => useUrlMirror(p), {
initialProps: { pl: "5" } as Record<string, string | null>,
});
expect(spy).toHaveBeenCalledTimes(1);
rerender({ pl: "5" }); // new object identity, same serialized value
expect(spy).toHaveBeenCalledTimes(1);
});
it("clears a key when its value turns null", () => {
const { rerender } = renderHook((p: Record<string, string | null>) => useUrlMirror(p), {
initialProps: { pl: "5" } as Record<string, string | null>,
});
expect(window.location.search).toBe("?pl=5");
rerender({ pl: null });
expect(window.location.search).toBe("");
expect(spy).toHaveBeenCalledTimes(2);
});
it("preserves other params already on the URL", () => {
setUrl("?page=playlists");
renderHook(() => useUrlMirror({ pl: "5" }));
expect(window.location.search).toBe("?page=playlists&pl=5");
});
it("leaves an unconsumed auth token in the fragment alone", () => {
// This hook's mount effect is what ran before <App> (and therefore before the auth card) had even
// loaded, so whatever it writes to the address bar is what the card later reads. It must not eat
// the #verify=/#reset= token that the emailed link carries.
window.history.replaceState(null, "", "/?page=playlists#verify=tok123");
renderHook(() => useUrlMirror({ pl: "5" }));
expect(window.location.hash).toBe("#verify=tok123");
expect(window.location.search).toBe("?page=playlists&pl=5");
});
});