Files
siftlode/frontend/src/components/PlexPlaylistReorder.dom.test.tsx
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

131 lines
5.7 KiB
TypeScript

// @vitest-environment jsdom
//
// One accepted write, one cache entry that matches it — the Plex half.
//
// `Playlists.tsx` (the YouTube list) got this rule first: the detail cache is what a rollback
// reads and what a re-entry inside the 30 s staleTime renders without refetching, so an accepted
// reorder that is not written there leaves the cache disagreeing with the server. The Plex list got
// the rollback half of that fix and not this half.
//
// Its own file: `@dnd-kit/core` is mocked module-wide so the test can fire `onDragEnd` directly —
// dnd-kit's pointer sensor does not activate under jsdom (no layout, no pointer capture).
import { it, expect, vi, beforeAll, afterEach } from "vitest";
import { render, cleanup, screen, act, waitFor } from "@testing-library/react";
import { QueryClient, QueryClientProvider } from "@tanstack/react-query";
vi.mock("react-i18next", async (importOriginal) => {
const actual = await importOriginal<typeof import("react-i18next")>();
return {
...actual,
useTranslation: () => ({ t: (key: string) => key, i18n: { language: "en" } }),
};
});
const { dragEnd } = vi.hoisted(() => ({ dragEnd: { fire: (_e: unknown) => {} } }));
vi.mock("@dnd-kit/core", async (importOriginal) => {
const actual = await importOriginal<typeof import("@dnd-kit/core")>();
return {
...actual,
DndContext: ({
children,
onDragEnd,
}: {
children: React.ReactNode;
onDragEnd: (e: unknown) => void;
}) => {
dragEnd.fire = onDragEnd;
return <>{children}</>;
},
};
});
import PlexPlaylistView from "./PlexPlaylistView";
import { api, type PlexCard } from "../lib/api";
import { qk } from "../lib/queryKeys";
beforeAll(() => {
class Stub {
observe() {}
unobserve() {}
disconnect() {}
takeRecords() {
return [];
}
}
globalThis.ResizeObserver ??= Stub as unknown as typeof ResizeObserver;
globalThis.IntersectionObserver ??= Stub as unknown as typeof IntersectionObserver;
});
afterEach(() => {
cleanup();
vi.restoreAllMocks();
});
const movie = (id: string) =>
({ id, type: "movie", title: `Movie ${id}`, year: 2020, thumb: "" }) as unknown as PlexCard;
it("writes the order the server accepted into the detail cache, without waiting for a refetch", async () => {
// The refetch that same handler schedules must not be what makes the cache right: the
// point of the write is that a re-entry inside the 30 s staleTime renders the accepted order
// immediately, with no request at all. So the refetch is HELD OPEN here — if this assertion
// needed it to land, deleting the write would still pass and that fix would be unguarded.
let calls = 0;
vi.spyOn(api, "plexPlaylist").mockImplementation(() =>
++calls === 1
? Promise.resolve({ id: 5, title: "Films", items: [movie("1"), movie("2"), movie("3")] })
: new Promise(() => {}),
);
const reorder = vi.spyOn(api, "plexReorderPlaylist").mockResolvedValue(undefined as never);
const qc = new QueryClient({ defaultOptions: { queries: { retry: false } } });
render(
<QueryClientProvider client={qc}>
<PlexPlaylistView playlistId={5} onBack={() => {}} onPlay={() => {}} />
</QueryClientProvider>,
);
await screen.findByText("Movie 1");
act(() => dragEnd.fire({ active: { id: "1" }, over: { id: "2" } }));
await waitFor(() => expect(reorder).toHaveBeenCalledWith(5, ["2", "1", "3"]));
// The list key was always invalidated; the DETAIL key — the one `putBack` reads and the one a
// re-entry renders from — kept the pre-reorder order, so leaving and coming back inside the
// staleTime showed the reorder undone, and the next drag persisted that.
await waitFor(() =>
expect(
qc.getQueryData<{ items: PlexCard[] }>(qk.plexPlaylist(5, "en"))?.items.map((i) => i.id),
).toEqual(["2", "1", "3"]),
);
});
it("refetches the detail too, so a membership change that landed meanwhile is not clobbered", async () => {
// `next` is the membership of the render that started the drag, and `reorder_playlist` only
// touches the rating_keys it is handed — it never ratifies that list. So writing `next` into the
// detail cache silently drops anything that landed in between (a row removed from another
// surface, an item added elsewhere), and with only the LIST key invalidated nothing corrected it:
// staleTime is 30 s and refetchOnWindowFocus is off, so the phantom row stayed on screen for as
// long as the view was mounted and the next drag persisted an order built from it. The YouTube
// sibling invalidates the detail key right after writing it; this half did not.
let calls = 0;
vi.spyOn(api, "plexPlaylist").mockImplementation(() =>
Promise.resolve(
++calls === 1
? { id: 5, title: "Films", items: [movie("1"), movie("2"), movie("3")] }
: { id: 5, title: "Films", items: [movie("2"), movie("1")] }, // "3" is gone server-side
),
);
const reorder = vi.spyOn(api, "plexReorderPlaylist").mockResolvedValue(undefined as never);
const qc = new QueryClient({ defaultOptions: { queries: { retry: false } } });
render(
<QueryClientProvider client={qc}>
<PlexPlaylistView playlistId={5} onBack={() => {}} onPlay={() => {}} />
</QueryClientProvider>,
);
await screen.findByText("Movie 3");
act(() => dragEnd.fire({ active: { id: "1" }, over: { id: "2" } }));
await waitFor(() => expect(reorder).toHaveBeenCalledWith(5, ["2", "1", "3"]));
// The refetch the accepted write schedules brings the real membership back.
await waitFor(() => expect(screen.queryByText("Movie 3")).toBeNull());
await waitFor(() =>
expect(
qc.getQueryData<{ items: PlexCard[] }>(qk.plexPlaylist(5, "en"))?.items.map((i) => i.id),
).toEqual(["2", "1"]),
);
});