Skip to content

Commit 04c15af

Browse files
test(web): migrate panel registry tests to the browser runner
Replace removed react-test-renderer imports with DOM roots and move the four React suites under browser discovery. Preserve lazy mount/disposal and annotation assertions, and use browser clicks for profile selection.
1 parent 31ca0af commit 04c15af

4 files changed

Lines changed: 57 additions & 30 deletions

File tree

apps/web/src/components/RightPanelTabs.browserProfile.test.tsx renamed to apps/web/src/components/RightPanelTabs.browserProfile.browser.test.tsx

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
// @vitest-environment jsdom
2-
31
import {
42
BUILT_IN_BROWSER_PROFILES,
53
DEFAULT_BROWSER_PROFILE_ID,
@@ -9,6 +7,9 @@ import { DEFAULT_RESOLVED_KEYBINDINGS } from "@t3tools/shared/keybindings";
97
import { act } from "react";
108
import { createRoot, type Root } from "react-dom/client";
119
import { afterEach, beforeEach, describe, expect, it, vi } from "vite-plus/test";
10+
import { userEvent } from "vite-plus/test/browser";
11+
12+
vi.mock("~/hooks/useTheme", () => ({ useTheme: () => ({ resolvedTheme: "light" }) }));
1213

1314
// The profile list normally comes from client settings; the built-ins are enough to choose from.
1415
vi.mock("~/browser/browserDefaults", async (importOriginal) => ({
@@ -34,8 +35,7 @@ beforeEach(() => {
3435
disconnect() {}
3536
},
3637
);
37-
// jsdom lacks the Web Animations API that the tab bar's scroll area waits on.
38-
Element.prototype.getAnimations ??= () => [];
38+
vi.spyOn(Element.prototype, "getAnimations").mockReturnValue([]);
3939
opened = [];
4040
container = document.createElement("div");
4141
document.body.append(container);
@@ -45,6 +45,7 @@ beforeEach(() => {
4545
afterEach(async () => {
4646
await act(async () => root.unmount());
4747
container.remove();
48+
vi.restoreAllMocks();
4849
vi.unstubAllGlobals();
4950
});
5051

@@ -120,11 +121,7 @@ function menuItem(label: string): HTMLElement {
120121

121122
async function click(element: Element) {
122123
await act(async () => {
123-
element.dispatchEvent(new MouseEvent("pointerdown", { bubbles: true }));
124-
element.dispatchEvent(new MouseEvent("mousedown", { bubbles: true }));
125-
element.dispatchEvent(new MouseEvent("pointerup", { bubbles: true }));
126-
element.dispatchEvent(new MouseEvent("mouseup", { bubbles: true }));
127-
element.dispatchEvent(new MouseEvent("click", { bubbles: true }));
124+
await userEvent.click(element);
128125
});
129126
}
130127

apps/web/src/panels/bundledPanels.test.tsx renamed to apps/web/src/panels/bundledPanels.browser.test.tsx

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { EnvironmentId, ThreadId, type ScopedThreadRef } from "@t3tools/contracts";
22
import { act, Suspense } from "react";
3-
import { create } from "react-test-renderer";
4-
import { describe, expect, it, vi } from "vite-plus/test";
3+
import { createRoot, type Root } from "react-dom/client";
4+
import { afterEach, beforeEach, describe, expect, it, vi } from "vite-plus/test";
55

66
const loaded = vi.hoisted(() => ({ diff: 0, preview: 0, previewRenders: [] as unknown[] }));
77
vi.mock("./diff/DiffSidePanel", () => {
@@ -34,17 +34,33 @@ const host: PanelHost = {
3434
};
3535

3636
describe("bundled side panels", () => {
37+
let root: Root;
38+
let container: HTMLDivElement;
39+
40+
beforeEach(() => {
41+
vi.stubGlobal("IS_REACT_ACT_ENVIRONMENT", true);
42+
container = document.createElement("div");
43+
document.body.append(container);
44+
root = createRoot(container);
45+
});
46+
47+
afterEach(async () => {
48+
await act(() => root.unmount());
49+
container.remove();
50+
vi.unstubAllGlobals();
51+
});
3752
it("loads only the selected panel body and lends it the host", async () => {
3853
expect(loaded).toMatchObject({ diff: 0, preview: 0 });
3954
await act(async () => {
40-
create(
55+
root.render(
4156
<PanelHostContext value={host}>
4257
<Suspense fallback={null}>
4358
<RegisteredSidePanel id="preview" tabId="tab-1" />
4459
</Suspense>
4560
</PanelHostContext>,
4661
);
4762
});
63+
await expect.poll(() => loaded.previewRenders.length).toBe(1);
4864
expect(loaded).toMatchObject({ diff: 0, preview: 1 });
4965
expect(loaded.previewRenders).toEqual([{ props: { tabId: "tab-1" }, host }]);
5066
});

apps/web/src/panels/panelRegistry.test.tsx renamed to apps/web/src/panels/panelRegistry.browser.test.tsx

Lines changed: 23 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { act, Suspense, useEffect } from "react";
2-
import { create, type ReactTestRenderer } from "react-test-renderer";
3-
import { describe, expect, it, vi } from "vite-plus/test";
2+
import { createRoot, type Root } from "react-dom/client";
3+
import { afterEach, beforeEach, describe, expect, it, vi } from "vite-plus/test";
44

55
import { createPanelRegistry } from "./panelRegistry";
66

@@ -13,6 +13,21 @@ const metadata = {
1313

1414
// These exercise lazy evaluation and actual mount/disposal, without inspecting markup.
1515
describe("panel registry", () => {
16+
let root: Root;
17+
let container: HTMLDivElement;
18+
19+
beforeEach(() => {
20+
vi.stubGlobal("IS_REACT_ACT_ENVIRONMENT", true);
21+
container = document.createElement("div");
22+
document.body.append(container);
23+
root = createRoot(container);
24+
});
25+
26+
afterEach(async () => {
27+
await act(() => root.unmount());
28+
container.remove();
29+
vi.unstubAllGlobals();
30+
});
1631
it("rejects duplicate ids without loading either panel", () => {
1732
const load = vi.fn();
1833
const definition = { ...metadata, id: "diff", title: "Diff", load } as const;
@@ -38,9 +53,8 @@ describe("panel registry", () => {
3853
const registry = createPanelRegistry([{ ...metadata, id: "diff", title: "Diff", load }]);
3954
expect(load).not.toHaveBeenCalled();
4055
const Component = registry.get("diff").Component;
41-
let renderer!: ReactTestRenderer;
4256
await act(async () => {
43-
renderer = create(
57+
root.render(
4458
<Suspense fallback={null}>
4559
<Component />
4660
</Suspense>,
@@ -57,7 +71,7 @@ describe("panel registry", () => {
5771
const Again = registry.get("diff").Component;
5872
expect(Again).toBe(Component);
5973
await act(async () => {
60-
renderer.update(
74+
root.render(
6175
<Suspense fallback={null}>
6276
<Again />
6377
</Suspense>,
@@ -66,9 +80,7 @@ describe("panel registry", () => {
6680
expect(load).toHaveBeenCalledTimes(1);
6781
expect(mounted).toHaveBeenCalledTimes(1);
6882
expect(disposed).not.toHaveBeenCalled();
69-
await act(async () => {
70-
renderer.unmount();
71-
});
83+
await act(() => root.render(null));
7284
expect(disposed).toHaveBeenCalledTimes(1);
7385
});
7486

@@ -110,16 +122,15 @@ describe("panel registry", () => {
110122
expect(loadNotes).not.toHaveBeenCalled();
111123
expect(loadCounter).not.toHaveBeenCalled();
112124

113-
let renderer!: ReactTestRenderer;
114125
await act(async () => {
115-
renderer = create(
126+
root.render(
116127
<Suspense fallback={null}>
117128
<NotesPanel text="a" />
118129
</Suspense>,
119130
);
120131
});
121132
await act(async () => {
122-
renderer.update(
133+
root.render(
123134
<Suspense fallback={null}>
124135
<NotesPanel text="a" />
125136
</Suspense>,
@@ -131,7 +142,7 @@ describe("panel registry", () => {
131142

132143
const CounterPanel = registry.get("counter").Component;
133144
await act(async () => {
134-
renderer.update(
145+
root.render(
135146
<Suspense fallback={null}>
136147
<CounterPanel count={2} />
137148
</Suspense>,

apps/web/src/panels/preview/PreviewSidePanel.test.tsx renamed to apps/web/src/panels/preview/PreviewSidePanel.browser.test.tsx

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import {
1010
type ScopedThreadRef,
1111
} from "@t3tools/contracts";
1212
import { act, useEffect, type ReactNode } from "react";
13-
import { create, type ReactTestRenderer } from "react-test-renderer";
13+
import { createRoot, type Root } from "react-dom/client";
1414
import { afterEach, beforeAll, beforeEach, describe, expect, it, vi } from "vite-plus/test";
1515

1616
// Drives the registered Preview through the real RegisteredSidePanel ->
@@ -193,13 +193,17 @@ const annotation: PreviewAnnotationPayload = {
193193
};
194194

195195
describe("registered Preview side panel", () => {
196-
let renderer: ReactTestRenderer | null = null;
196+
let root: Root;
197+
let container: HTMLDivElement;
197198

198199
// The registry loads the body lazily; warm the module so a render settles in one act.
199200
beforeAll(() => import("./PreviewSidePanel"));
200201

201202
beforeEach(() => {
202203
vi.stubGlobal("IS_REACT_ACT_ENVIRONMENT", true);
204+
container = document.createElement("div");
205+
document.body.append(container);
206+
root = createRoot(container);
203207
mocks.pickElement.mockReset();
204208
mocks.cancelPickElement.mockClear();
205209
mocks.addPreviewAnnotation.mockClear();
@@ -210,15 +214,14 @@ describe("registered Preview side panel", () => {
210214
});
211215

212216
afterEach(async () => {
213-
await act(async () => renderer?.unmount());
214-
renderer = null;
217+
await act(() => root.unmount());
218+
container.remove();
215219
vi.unstubAllGlobals();
216220
});
217221

218222
async function render(host: PanelHost) {
219223
await act(async () => {
220-
if (renderer) renderer.update(panel(host));
221-
else renderer = create(panel(host));
224+
root.render(panel(host));
222225
});
223226
}
224227

0 commit comments

Comments
 (0)