Files
siftlode/frontend/src/components/OnboardingWizard.escape.dom.test.tsx
T
peter 545996f807 fix(ui): a toast host ranks by when its overlay opened, and an overlay keeps its Escape, its dialog and its navigation straight
Deep-review round 4, the overlays.

- Toast hosts were ranked by mount time, and PlayerModal swaps its host on every fullscreen change:
  leaving true fullscreen with the download dialog open put the player's host back on top, so toasts
  were drawn under that dialog's scrim and a click on one closed the dialog. Each overlay takes a
  rank once, when it opens (`useOverlayOrder`), and hands it to every host it renders.
- A dialog open while fullscreen is left keeps a stable portal container (moved, not re-created):
  React tore the portal down when `fsRoot` changed, resetting a half-filled form and dropping focus
  to <body>. Focus is put back after the move.
- The onboarding wizard is a layer, not a raw document listener: one Escape used to dismiss the
  error dialog over it AND end onboarding, skipping the write-scope step.
- `navigateTo` (a toast's "View", clicked inside the player's own host) goes over the overlays it
  unmounts, so the player's Back-to-close cleanup no longer pops the page it just opened — the same
  fix Shift+W already had. The access-requests toast action too.
- The live region arms itself a task after it takes over inherited toasts: React flushes effects in
  the same task as that render, so the "silent inheritance" arming was a no-op.
- The overlay-host guard matches class tokens in any order (PlexPlayer's root was never checked),
  globs `ui/` too (ui/Modal was not checked either), and requires the rank.
2026-09-11 23:43:23 +02:00

64 lines
2.3 KiB
TypeScript

// @vitest-environment jsdom
//
// Escape closes the topmost layer only — the wizard included (deep-review round 4). Its own Escape
// was a raw `document` listener with no layer check, and document listeners run before the window
// listener ui/Modal uses: a sync that failed inside the wizard opens the global error dialog, and one
// Esc dismissed the error AND ended onboarding, skipping the write-scope step.
import { describe, it, expect, vi, beforeEach, afterEach } from "vitest";
import { render, cleanup, screen, fireEvent } 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" } }),
Trans: ({ i18nKey }: { i18nKey: string }) => i18nKey,
};
});
vi.mock("../lib/onboarding", () => ({ beginGrant: vi.fn(), endOnboarding: vi.fn() }));
import OnboardingWizard from "./OnboardingWizard";
import Modal from "./ui/Modal";
import { api, type Me } from "../lib/api";
const me = { id: 1, email: "a@b", can_read: false, can_write: false } as unknown as Me;
beforeEach(() => {
vi.spyOn(api, "myStatus").mockResolvedValue({ channels_total: 0 } as never);
});
afterEach(() => {
cleanup();
vi.restoreAllMocks();
});
describe("the onboarding wizard's Escape", () => {
const mount = (onClose: () => void, dialog: boolean) =>
render(
<QueryClientProvider
client={new QueryClient({ defaultOptions: { queries: { retry: false } } })}
>
<OnboardingWizard me={me} onClose={onClose} />
{dialog && (
<Modal title="boom" onClose={() => {}}>
<p>the sync failed</p>
</Modal>
)}
</QueryClientProvider>,
);
it("closes the wizard when nothing is open above it", () => {
const onClose = vi.fn();
mount(onClose, false);
fireEvent.keyDown(document, { key: "Escape" });
expect(onClose).toHaveBeenCalledTimes(1);
});
it("leaves the wizard alone while a dialog is open over it", () => {
const onClose = vi.fn();
mount(onClose, true);
fireEvent.keyDown(screen.getByText("the sync failed"), { key: "Escape" });
expect(onClose).not.toHaveBeenCalled();
});
});