Skip to content

Commit 81dea78

Browse files
test(web): disposable render helper and lint rule for browser tests (#22187)
Co-authored-by: Claude Opus 5.5 <[email protected]>
1 parent 758d773 commit 81dea78

149 files changed

Lines changed: 7080 additions & 7300 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎AGENTS.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,18 @@ An empty database is a bad test. Seed your worktree's `.t3` with a copy of real
100100
- **Do not run repo-wide checks.** No `vp check`, no `vp run -r test`, no `vp run -r typecheck` unless I ask. CI owns the full suite.
101101
- Backend behavior changes ship with focused tests for that behavior.
102102
- The server is event-sourced, and side effects run after the command commits. In tests, drain the effect worker (`OrchestrationEffectWorkerV2.drain`) or await the specific persisted event or `Deferred` that marks the milestone. Never wait on sleeps or polling. A test that needs a timeout to pass is wrong.
103+
- Web component tests are `*.browser.test.tsx` and render through `apps/web/test/render.tsx`. Acquire everything a test changes with `using`/`await using` so disposal undoes it even when the test fails; no `beforeEach`/`afterEach`, no module-level screens. Shared mock state that `vi.mock` factories read gets reset by a `setup()` call at the top of the test. `t3code/require-disposable-render` flags the old patterns.
104+
105+
```tsx
106+
it("saves on Enter", async () => {
107+
const onSave = vi.fn();
108+
using _now = vi.spyOn(Date, "now").mockReturnValue(0);
109+
await using screen = await render(<TitleEditor onSave={onSave} />, { router: "/threads/1" });
110+
await userEvent.type(screen.getByRole("textbox"), "Title{Enter}");
111+
expect(onSave).toHaveBeenCalledWith("Title");
112+
});
113+
```
114+
103115
- Upon request, user-visible frontend changes should get one integrated pass in a real client: `test-t3-app` for web, `test-t3-mobile` for mobile. The primary agent does this once after integrating. Subagents do not launch their own dev servers. Ask permission before doing computer use or spinning up browsers.
104116

105117
For authorized mobile verification, a missing or outdated native client is a build step, not a blocker. Run `node scripts/mobile-native-client.ts ensure <ios|android> <device-id>` on the simulator host before starting Metro. It checks the local Expo fingerprint and builds/installs when needed. See `test-t3-mobile` for the full workflow.

‎apps/web/src/browser/ElectronBrowserHost.browser.test.tsx‎

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ import {
77
type DesktopPreviewBridge,
88
type PreviewSessionSnapshot,
99
} from "@t3tools/contracts";
10-
import { act } from "react";
11-
import { createRoot, type Root } from "react-dom/client";
12-
import { afterEach, beforeEach, describe, expect, it, vi } from "vite-plus/test";
10+
import { describe, expect, it, vi } from "vite-plus/test";
11+
12+
import { act, fakeTimers, render } from "../../test/render";
1313

1414
const mocks = vi.hoisted(() => ({
1515
getClientSettings: vi.fn<() => Promise<ClientSettings | null>>(),
@@ -73,10 +73,7 @@ const snapshot = (tabId: string, updatedAt: string): PreviewSessionSnapshot => (
7373
updatedAt,
7474
});
7575

76-
let root: Root | undefined;
77-
let container: HTMLDivElement;
78-
79-
beforeEach(() => {
76+
function setup(): Disposable {
8077
__resetClientSettingsPersistenceForTests();
8178
mocks.getClientSettings.mockReset().mockResolvedValue(DEFAULT_CLIENT_SETTINGS);
8279
mocks.setClientSettings.mockReset().mockResolvedValue(undefined);
@@ -88,26 +85,37 @@ beforeEach(() => {
8885
webPreferences: "contextIsolation=yes",
8986
preloadUrl: null,
9087
});
91-
vi.stubGlobal("IS_REACT_ACT_ENVIRONMENT", true);
92-
container = document.createElement("div");
93-
document.body.append(container);
94-
});
95-
96-
afterEach(async () => {
97-
vi.useFakeTimers();
98-
await act(async () => root?.unmount());
99-
root = undefined;
100-
container.remove();
101-
await vi.advanceTimersByTimeAsync(0);
102-
vi.useRealTimers();
103-
resetPreviewStateForTests();
104-
__resetClientSettingsPersistenceForTests();
105-
vi.restoreAllMocks();
106-
vi.unstubAllGlobals();
107-
});
88+
return {
89+
[Symbol.dispose]() {
90+
resetPreviewStateForTests();
91+
__resetClientSettingsPersistenceForTests();
92+
},
93+
};
94+
}
95+
96+
async function renderHost() {
97+
await using stack = new AsyncDisposableStack();
98+
const screen = stack.use(
99+
await render(
100+
<AppAtomRegistryProvider>
101+
<ElectronBrowserHost />
102+
</AppAtomRegistryProvider>,
103+
),
104+
);
105+
// Unmounting releases each tab on a close timer; run it now so it never fires in a later test.
106+
stack.defer(async () => {
107+
using _timers = fakeTimers();
108+
await screen.unmount();
109+
await vi.advanceTimersByTimeAsync(0);
110+
});
111+
await act(() => ensureClientSettingsHydrated());
112+
const environment = stack.move();
113+
return { container: screen.container, [Symbol.asyncDispose]: () => environment.disposeAsync() };
114+
}
108115

109116
describe("ElectronBrowserHost", () => {
110117
it("never moves a tab's webview when the server reorders tabs by last update", async () => {
118+
using _state = setup();
111119
reconcilePreviewServerSessions(threadRef, {
112120
sessions: [
113121
snapshot("tab_7", "2026-01-01T00:00:01.000Z"),
@@ -116,17 +124,9 @@ describe("ElectronBrowserHost", () => {
116124
serverEpoch: "server-a",
117125
revision: 1,
118126
});
119-
root = createRoot(container);
120-
await act(async () => {
121-
root!.render(
122-
<AppAtomRegistryProvider>
123-
<ElectronBrowserHost />
124-
</AppAtomRegistryProvider>,
125-
);
126-
await ensureClientSettingsHydrated();
127-
});
127+
await using screen = await renderHost();
128128

129-
const host = container.querySelector("[data-electron-browser-host]")!;
129+
const host = screen.container.querySelector("[data-electron-browser-host]")!;
130130
const webviews = () => [...host.querySelectorAll("webview")];
131131
const before = webviews();
132132
expect(before.map((node) => node.getAttribute("data-preview-server-tab")).toSorted()).toEqual([

‎apps/web/src/browser/HostedBrowserWebview.browser.test.tsx‎

Lines changed: 80 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,14 @@ import {
77
type DesktopPreviewBridge,
88
type PreviewViewportSetting,
99
} from "@t3tools/contracts";
10-
import { act } from "react";
10+
import type { ReactNode } from "react";
1111

1212
import "~/index.css";
13-
import { createRoot, type Root } from "react-dom/client";
14-
import { afterEach, beforeEach, describe, expect, it, vi } from "vite-plus/test";
13+
import { describe, expect, it, vi } from "vite-plus/test";
1514
import type { previewBridge } from "~/components/preview/previewBridge";
1615

16+
import { act, fakeTimers, render, stubGlobal } from "../../test/render";
17+
1718
const mocks = vi.hoisted(() => ({
1819
getClientSettings: vi.fn<() => Promise<ClientSettings | null>>(),
1920
setClientSettings: vi.fn<(settings: ClientSettings) => Promise<void>>(),
@@ -58,9 +59,6 @@ import { useBrowserSurfaceStore } from "./browserSurfaceStore";
5859
import * as desktopTabLifetime from "./desktopTabLifetime";
5960
import { HostedBrowserWebview } from "./HostedBrowserWebview";
6061

61-
let root: Root | undefined;
62-
let container: HTMLDivElement;
63-
6462
function deferred<A>() {
6563
let resolve!: (value: A) => void;
6664
let reject!: (error: unknown) => void;
@@ -71,9 +69,16 @@ function deferred<A>() {
7169
return { promise, resolve, reject };
7270
}
7371

74-
beforeEach(() => {
72+
function resetStores() {
7573
__resetClientSettingsPersistenceForTests();
7674
useBrowserSurfaceStore.setState({ activityByTabId: {}, byTabId: {} });
75+
}
76+
77+
function setup() {
78+
using stack = new DisposableStack();
79+
resetStores();
80+
stack.defer(resetStores);
81+
vi.mocked(desktopTabLifetime.acquireDesktopTab).mockClear();
7782
mocks.getClientSettings.mockReset();
7883
mocks.setClientSettings.mockReset().mockResolvedValue(undefined);
7984
mocks.createTab.mockReset().mockResolvedValue(undefined);
@@ -84,27 +89,27 @@ beforeEach(() => {
8489
webPreferences: "contextIsolation=yes",
8590
preloadUrl: null,
8691
});
87-
vi.stubGlobal("IS_REACT_ACT_ENVIRONMENT", true);
88-
vi.spyOn(console, "error").mockImplementation(() => undefined);
89-
container = document.createElement("div");
90-
document.body.append(container);
91-
});
92+
stack.use(vi.spyOn(console, "error").mockImplementation(() => undefined));
93+
return stack.move();
94+
}
9295

93-
afterEach(async () => {
94-
vi.useFakeTimers();
95-
await act(async () => root?.unmount());
96-
root = undefined;
97-
container.remove();
98-
await vi.advanceTimersByTimeAsync(0);
99-
vi.useRealTimers();
100-
__resetClientSettingsPersistenceForTests();
101-
useBrowserSurfaceStore.setState({ activityByTabId: {}, byTabId: {} });
102-
vi.restoreAllMocks();
103-
vi.unstubAllGlobals();
104-
});
96+
// The webview releases its desktop tab on a timer after unmount; run it before the test ends
97+
// so it cannot land in the next one.
98+
async function renderHost(ui: ReactNode) {
99+
await using stack = new AsyncDisposableStack();
100+
const screen = stack.use(await render(ui));
101+
stack.defer(async () => {
102+
using _timers = fakeTimers();
103+
await screen.unmount();
104+
await vi.advanceTimersByTimeAsync(0);
105+
});
106+
const environment = stack.move();
107+
return Object.assign(screen, { [Symbol.asyncDispose]: () => environment.disposeAsync() });
108+
}
105109

106110
describe("HostedBrowserWebview settings hydration", () => {
107111
it("starts a retained background tab only after a settings read succeeds on retry", async () => {
112+
using _setup = setup();
108113
const firstRead = deferred<ClientSettings | null>();
109114
const retryRead = deferred<ClientSettings | null>();
110115
const tabCreation = deferred<void>();
@@ -116,7 +121,7 @@ describe("HostedBrowserWebview settings hydration", () => {
116121
// Chromium treats <webview> as an unknown element; give it the one Electron method the
117122
// host calls once the guest attaches.
118123
const createElement = document.createElement.bind(document);
119-
const createGuest = vi.spyOn(document, "createElement").mockImplementation(((
124+
using createGuest = vi.spyOn(document, "createElement").mockImplementation(((
120125
tagName: string,
121126
options?: ElementCreationOptions,
122127
) => {
@@ -126,28 +131,25 @@ describe("HostedBrowserWebview settings hydration", () => {
126131
: element;
127132
}) as typeof document.createElement);
128133
const guests = () => createGuest.mock.calls.filter(([tagName]) => tagName === "webview");
129-
const guest = () => container.querySelector("webview");
134+
const guest = () => screen.container.querySelector("webview");
130135
const threadRef = {
131136
environmentId: EnvironmentId.make("host-settings-retry"),
132137
threadId: ThreadId.make("thread-settings-retry"),
133138
};
134139
const runtimeTabId = "retained-background-tab";
135140
useBrowserSurfaceStore.getState().acquireActivity(runtimeTabId);
136141

137-
root = createRoot(container);
138-
await act(async () =>
139-
root!.render(
140-
<HostedBrowserWebview
141-
threadRef={threadRef}
142-
tabId="server-tab"
143-
runtimeTabId={runtimeTabId}
144-
initialUrl="https://example.com"
145-
viewport={FILL_PREVIEW_VIEWPORT}
146-
pictureInPicture={false}
147-
profileId="work"
148-
zoomFactor={1.25}
149-
/>,
150-
),
142+
await using screen = await renderHost(
143+
<HostedBrowserWebview
144+
threadRef={threadRef}
145+
tabId="server-tab"
146+
runtimeTabId={runtimeTabId}
147+
initialUrl="https://example.com"
148+
viewport={FILL_PREVIEW_VIEWPORT}
149+
pictureInPicture={false}
150+
profileId="work"
151+
zoomFactor={1.25}
152+
/>,
151153
);
152154

153155
expect(mocks.getClientSettings).toHaveBeenCalledOnce();
@@ -211,41 +213,48 @@ describe("HostedBrowserWebview viewport layout", () => {
211213
const owner = Symbol("panel");
212214
const panel = { x: 0, y: 0, width: 2000, height: 1600 };
213215

216+
const webview = (viewport: PreviewViewportSetting) => (
217+
<HostedBrowserWebview
218+
threadRef={{
219+
environmentId: EnvironmentId.make("zoom-layout"),
220+
threadId: ThreadId.make("zoom-layout"),
221+
}}
222+
tabId="zoom-layout"
223+
runtimeTabId={runtimeTabId}
224+
initialUrl="about:blank"
225+
viewport={viewport}
226+
pictureInPicture={false}
227+
profileId={undefined}
228+
zoomFactor={1.5}
229+
/>
230+
);
231+
214232
async function renderViewport(viewport: PreviewViewportSetting) {
215233
mocks.getClientSettings.mockResolvedValue({
216234
...DEFAULT_CLIENT_SETTINGS,
217235
browserDefaultZoomFactor: 1.5,
218236
});
219-
root ??= createRoot(container);
220-
await act(async () => {
221-
await ensureClientSettingsHydrated();
222-
root!.render(
223-
<HostedBrowserWebview
224-
threadRef={{
225-
environmentId: EnvironmentId.make("zoom-layout"),
226-
threadId: ThreadId.make("zoom-layout"),
227-
}}
228-
tabId="zoom-layout"
229-
runtimeTabId={runtimeTabId}
230-
initialUrl="about:blank"
231-
viewport={viewport}
232-
pictureInPicture={false}
233-
profileId={undefined}
234-
zoomFactor={1.5}
235-
/>,
236-
);
237-
});
238-
const guest = container.querySelector("webview");
237+
await act(() => ensureClientSettingsHydrated());
238+
await using stack = new AsyncDisposableStack();
239+
const screen = stack.use(await renderHost(webview(viewport)));
240+
const guest = screen.container.querySelector("webview");
239241
expect(guest).not.toBeNull();
240-
return guest!;
242+
const environment = stack.move();
243+
return Object.assign(screen, {
244+
guest: guest!,
245+
setViewport: (next: PreviewViewportSetting) => screen.rerender(webview(next)),
246+
[Symbol.asyncDispose]: () => environment.disposeAsync(),
247+
});
241248
}
242249

243250
it("keeps fixed viewports sized in guest pixels across host zoom and fitted surfaces", async () => {
251+
using _setup = setup();
244252
let windowZoom = 1.25;
245-
vi.stubGlobal("desktopBridge", { getWindowZoomFactor: () => windowZoom });
253+
using _bridge = stubGlobal("desktopBridge", { getWindowZoomFactor: () => windowZoom });
246254
useBrowserSurfaceStore.getState().claim(runtimeTabId, owner, false);
247255
useBrowserSurfaceStore.getState().present(runtimeTabId, owner, panel, true, 0, 30);
248-
const guest = await renderViewport({ _tag: "freeform", width: 800, height: 600 });
256+
await using screen = await renderViewport({ _tag: "freeform", width: 800, height: 600 });
257+
const { guest } = screen;
249258
expect(guest.getBoundingClientRect()).toMatchObject({ width: 960, height: 720 });
250259

251260
windowZoom = 0.75;
@@ -258,7 +267,7 @@ describe("HostedBrowserWebview viewport layout", () => {
258267

259268
windowZoom = 1.25;
260269
await act(() => window.dispatchEvent(new Event("resize")));
261-
await renderViewport({ _tag: "preset", presetId: "iphone-se", width: 375, height: 667 });
270+
await screen.setViewport({ _tag: "preset", presetId: "iphone-se", width: 375, height: 667 });
262271
expect(guest.getBoundingClientRect().width).toBe(450);
263272
expect(guest.getBoundingClientRect().height).toBeCloseTo(800.4, 1);
264273

@@ -278,7 +287,7 @@ describe("HostedBrowserWebview viewport layout", () => {
278287
useBrowserSurfaceStore.getState().claim(runtimeTabId, owner, false);
279288
useBrowserSurfaceStore.getState().present(runtimeTabId, owner, panel, true, 0, 30);
280289
});
281-
await renderViewport(FILL_PREVIEW_VIEWPORT);
290+
await screen.setViewport(FILL_PREVIEW_VIEWPORT);
282291
expect(guest.getBoundingClientRect()).toMatchObject({ width: 2000, height: 1600 });
283292
expect(mocks.createTab).toHaveBeenCalledExactlyOnceWith(runtimeTabId, {
284293
zoomFactor: 1.5,
@@ -287,11 +296,14 @@ describe("HostedBrowserWebview viewport layout", () => {
287296
});
288297

289298
it("preserves preview scaling with an older bridge or no desktop bridge", async () => {
290-
vi.stubGlobal("desktopBridge", {});
291-
const guest = await renderViewport({ _tag: "freeform", width: 800, height: 600 });
299+
using _setup = setup();
300+
using _bridge = stubGlobal("desktopBridge", {});
301+
await using screen = await renderViewport({ _tag: "freeform", width: 800, height: 600 });
302+
const { guest } = screen;
292303
expect(guest.getBoundingClientRect()).toMatchObject({ width: 1200, height: 900 });
293304

294-
vi.stubGlobal("desktopBridge", undefined);
305+
// `_bridge` puts the original back after the unmount, so the unmount still sees no bridge.
306+
Reflect.set(globalThis, "desktopBridge", undefined);
295307
await act(() => window.dispatchEvent(new Event("resize")));
296308
expect(guest.getBoundingClientRect()).toMatchObject({ width: 1200, height: 900 });
297309
});

0 commit comments

Comments
 (0)