Skip to content

Commit 6325f8c

Browse files
committed
fix(web): keep preview pages alive when tabs reorder
preview.list sorts tabs by last update, and re-rendering the hosted webviews in that order moved their elements. Electron destroys a webview's page when its element moves, which left a white tab that automation waited on until timeout.
1 parent 2679d27 commit 6325f8c

2 files changed

Lines changed: 102 additions & 16 deletions

File tree

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
import { scopeThreadRef } from "@t3tools/client-runtime/environment";
2+
import { type EnvironmentId, type PreviewSessionSnapshot, ThreadId } from "@t3tools/contracts";
3+
import { act } from "react";
4+
import { create, type ReactTestRenderer } from "react-test-renderer";
5+
import { afterEach, describe, expect, it, vi } from "vite-plus/test";
6+
7+
vi.mock("~/env", () => ({ isElectron: true }));
8+
9+
vi.mock("~/hooks/useTheme", () => ({
10+
useTheme: () => ({ resolvedTheme: "light" }),
11+
}));
12+
13+
vi.mock("./HostedBrowserWebview", () => ({
14+
HostedBrowserWebview: (props: { readonly tabId: string }) => (
15+
<div data-preview-server-tab={props.tabId} />
16+
),
17+
}));
18+
19+
import { reconcilePreviewServerSessions, resetPreviewStateForTests } from "~/previewStateStore";
20+
import { AppAtomRegistryProvider } from "~/rpc/atomRegistry";
21+
import { ElectronBrowserHost } from "./ElectronBrowserHost";
22+
23+
const ref = scopeThreadRef("env-1" as EnvironmentId, ThreadId.make("thread-1"));
24+
25+
const snapshot = (tabId: string, updatedAt: string): PreviewSessionSnapshot => ({
26+
threadId: "thread-1",
27+
tabId,
28+
navStatus: { _tag: "Success", url: `https://example.com/${tabId}`, title: tabId },
29+
canGoBack: false,
30+
canGoForward: false,
31+
updatedAt,
32+
});
33+
34+
let renderer: ReactTestRenderer | undefined;
35+
36+
afterEach(async () => {
37+
await act(() => renderer?.unmount());
38+
renderer = undefined;
39+
resetPreviewStateForTests();
40+
vi.unstubAllGlobals();
41+
});
42+
43+
const renderedTabIds = () =>
44+
renderer!.root
45+
.findAll((node) => node.type === "div" && node.props["data-preview-server-tab"] !== undefined)
46+
.map((node) => node.props["data-preview-server-tab"] as string);
47+
48+
describe("ElectronBrowserHost", () => {
49+
it("keeps webview order when the server reorders tabs by last update", async () => {
50+
vi.stubGlobal("IS_REACT_ACT_ENVIRONMENT", true);
51+
vi.stubGlobal("window", globalThis);
52+
reconcilePreviewServerSessions(ref, {
53+
sessions: [
54+
snapshot("tab_7", "2026-01-01T00:00:01.000Z"),
55+
snapshot("tab_8", "2026-01-01T00:00:02.000Z"),
56+
],
57+
serverEpoch: "server-a",
58+
revision: 1,
59+
});
60+
await act(() => {
61+
renderer = create(
62+
<AppAtomRegistryProvider>
63+
<ElectronBrowserHost />
64+
</AppAtomRegistryProvider>,
65+
);
66+
});
67+
const initialOrder = renderedTabIds();
68+
69+
await act(() => {
70+
reconcilePreviewServerSessions(ref, {
71+
sessions: [
72+
snapshot("tab_8", "2026-01-01T00:00:02.000Z"),
73+
snapshot("tab_7", "2026-01-01T00:00:03.000Z"),
74+
],
75+
serverEpoch: "server-a",
76+
revision: 2,
77+
});
78+
});
79+
80+
expect(initialOrder).toHaveLength(2);
81+
expect(renderedTabIds()).toEqual(initialOrder);
82+
});
83+
});

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

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -18,23 +18,26 @@ export function ElectronBrowserHost() {
1818
const previewByThreadKey = useActivePreviewSessions();
1919
const sessions = useMemo(
2020
() =>
21-
Object.entries(previewByThreadKey).flatMap(([threadKey, previewState]) => {
22-
const threadRef = parseScopedThreadKey(threadKey);
23-
return threadRef
24-
? Object.values(previewState.sessions).map((snapshot) => ({
25-
threadRef,
26-
snapshot,
27-
runtimeTabId: previewRuntimeTabId(
21+
Object.entries(previewByThreadKey)
22+
.flatMap(([threadKey, previewState]) => {
23+
const threadRef = parseScopedThreadKey(threadKey);
24+
return threadRef
25+
? Object.values(previewState.sessions).map((snapshot) => ({
2826
threadRef,
29-
previewState.serverEpoch,
30-
snapshot.tabId,
31-
),
32-
pictureInPicture:
33-
previewState.desktopByTabId[snapshot.tabId]?.pictureInPicture ?? false,
34-
zoomFactor: previewState.desktopByTabId[snapshot.tabId]?.zoomFactor ?? 1,
35-
}))
36-
: [];
37-
}),
27+
snapshot,
28+
runtimeTabId: previewRuntimeTabId(
29+
threadRef,
30+
previewState.serverEpoch,
31+
snapshot.tabId,
32+
),
33+
pictureInPicture:
34+
previewState.desktopByTabId[snapshot.tabId]?.pictureInPicture ?? false,
35+
zoomFactor: previewState.desktopByTabId[snapshot.tabId]?.zoomFactor ?? 1,
36+
}))
37+
: [];
38+
})
39+
// Electron destroys a webview's page when React moves its element, so the order is fixed.
40+
.toSorted((left, right) => left.runtimeTabId.localeCompare(right.runtimeTabId)),
3841
[previewByThreadKey],
3942
);
4043

0 commit comments

Comments
 (0)