Skip to content

Commit 00d11b1

Browse files
juliusmarmingecodex
andcommitted
fix(preview): validate no-wait navigation targets
Co-authored-by: codex <[email protected]>
1 parent 17ec73f commit 00d11b1

3 files changed

Lines changed: 135 additions & 60 deletions

File tree

‎apps/web/src/components/preview/PreviewAutomationHosts.tsx‎

Lines changed: 5 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ import {
3939
import { resolveBrowserRecordingStopTarget } from "~/browser/browserRecordingScope";
4040
import { useBrowserSurfaceStore } from "~/browser/browserSurfaceStore";
4141
import { runBrowserViewportMutation } from "~/browser/browserViewportActions";
42-
import { isCurrentPreviewRuntimeTab, previewRuntimeTabId } from "~/browser/previewRuntimeTabId";
42+
import { previewRuntimeTabId } from "~/browser/previewRuntimeTabId";
4343
import { isElectron } from "~/env";
4444
import { useEnvironments } from "~/state/environments";
4545
import { previewEnvironment } from "~/state/preview";
@@ -48,7 +48,6 @@ import { useAtomCommand } from "~/state/use-atom-command";
4848

4949
import { previewBridge } from "./previewBridge";
5050
import {
51-
PreviewAutomationNavigationTimeoutError,
5251
PreviewAutomationOperationError,
5352
PreviewAutomationOverlayTimeoutError,
5453
PreviewAutomationRecordingNotActiveError,
@@ -60,6 +59,10 @@ import {
6059
previewAutomationOpenNeedsOverlay,
6160
shouldOpenPreviewMiniPlayer,
6261
} from "./previewAutomationOpenReadiness";
62+
import {
63+
assertPreviewRuntimeCurrent,
64+
waitForNavigationReadiness,
65+
} from "./previewNavigationReadiness";
6366
import { createPreviewAutomationRequestConsumerAtom } from "./previewAutomationRequestConsumer";
6467
import { createPreviewAutomationClientId } from "./previewAutomationClientId";
6568
import {
@@ -80,29 +83,6 @@ const waitForPreviewPresentation = async (runtimeTabId: string): Promise<void> =
8083
}
8184
};
8285

83-
const assertPreviewRuntimeCurrent = (
84-
threadRef: ScopedThreadRef,
85-
tabId: string,
86-
runtimeTabId: string,
87-
request: Pick<PreviewAutomationRequest, "operation" | "requestId">,
88-
) => {
89-
const state = readThreadPreviewState(threadRef);
90-
if (
91-
state.sessions[tabId] &&
92-
isCurrentPreviewRuntimeTab(threadRef, state.serverEpoch, tabId, runtimeTabId)
93-
) {
94-
return state;
95-
}
96-
throw new PreviewAutomationTargetUnavailableError({
97-
requestId: request.requestId,
98-
operation: request.operation,
99-
environmentId: threadRef.environmentId,
100-
threadId: threadRef.threadId,
101-
tabId,
102-
bridgeAvailable: Boolean(previewBridge),
103-
});
104-
};
105-
10686
const waitForDesktopOverlay = async (
10787
threadRef: ScopedThreadRef,
10888
requestId: string,
@@ -131,41 +111,6 @@ const waitForDesktopOverlay = async (
131111
});
132112
};
133113

134-
const waitForNavigationReadiness = async (
135-
threadRef: ScopedThreadRef,
136-
requestId: string,
137-
tabId: string,
138-
runtimeTabId: string,
139-
operation: PreviewAutomationRequest["operation"],
140-
readiness: PreviewAutomationNavigateInput["readiness"],
141-
timeoutMs: number,
142-
): Promise<void> => {
143-
const targetReadiness = readiness ?? "load";
144-
if (!previewBridge || targetReadiness === "none") return;
145-
const deadline = Date.now() + timeoutMs;
146-
while (Date.now() <= deadline) {
147-
assertPreviewRuntimeCurrent(threadRef, tabId, runtimeTabId, { operation, requestId });
148-
if (targetReadiness === "domContentLoaded") {
149-
const readyState = await previewBridge.automation.evaluate(runtimeTabId, {
150-
expression: "document.readyState",
151-
});
152-
if (readyState === "interactive" || readyState === "complete") return;
153-
} else {
154-
const status = await previewBridge.automation.status(runtimeTabId);
155-
if (status.available && !status.loading) return;
156-
}
157-
await new Promise<void>((resolve) => window.setTimeout(resolve, 50));
158-
}
159-
throw new PreviewAutomationNavigationTimeoutError({
160-
requestId,
161-
environmentId: threadRef.environmentId,
162-
threadId: threadRef.threadId,
163-
tabId,
164-
readiness: targetReadiness,
165-
timeoutMs,
166-
});
167-
};
168-
169114
interface ExecutablePreviewWebview extends Element {
170115
readonly executeJavaScript: (code: string, userGesture?: boolean) => Promise<unknown>;
171116
}
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
import { EnvironmentId, ThreadId } from "@t3tools/contracts";
2+
import { describe, expect, it, vi } from "vite-plus/test";
3+
4+
const mocks = vi.hoisted(() => ({
5+
readThreadPreviewState: vi.fn(),
6+
}));
7+
8+
vi.mock("~/previewStateStore", () => ({
9+
applyPreviewServerSnapshot: vi.fn(),
10+
readThreadPreviewState: mocks.readThreadPreviewState,
11+
reconcilePreviewServerSessions: vi.fn(),
12+
updatePreviewServerSnapshot: vi.fn(),
13+
}));
14+
15+
vi.mock("./previewBridge", () => ({
16+
previewBridge: {
17+
automation: {
18+
evaluate: vi.fn(),
19+
status: vi.fn(),
20+
},
21+
},
22+
}));
23+
24+
import { previewRuntimeTabId } from "~/browser/previewRuntimeTabId";
25+
26+
import { PreviewAutomationTargetUnavailableError } from "./previewAutomationErrors";
27+
import { waitForNavigationReadiness } from "./previewNavigationReadiness";
28+
29+
describe("waitForNavigationReadiness", () => {
30+
it("rejects a replaced runtime target even when readiness polling is disabled", async () => {
31+
const threadRef = {
32+
environmentId: EnvironmentId.make("environment-2"),
33+
threadId: ThreadId.make("thread-1"),
34+
};
35+
const tabId = "tab_1";
36+
const staleRuntimeTabId = previewRuntimeTabId(threadRef, "epoch-1", tabId);
37+
mocks.readThreadPreviewState.mockReturnValue({
38+
serverEpoch: "epoch-2",
39+
sessions: {
40+
[tabId]: { tabId },
41+
},
42+
});
43+
44+
await expect(
45+
waitForNavigationReadiness(
46+
threadRef,
47+
"request-1",
48+
tabId,
49+
staleRuntimeTabId,
50+
"navigate",
51+
"none",
52+
100,
53+
),
54+
).rejects.toBeInstanceOf(PreviewAutomationTargetUnavailableError);
55+
});
56+
});
Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
import {
2+
type PreviewAutomationNavigateInput,
3+
type PreviewAutomationRequest,
4+
type ScopedThreadRef,
5+
} from "@t3tools/contracts";
6+
7+
import { isCurrentPreviewRuntimeTab } from "~/browser/previewRuntimeTabId";
8+
import { readThreadPreviewState } from "~/previewStateStore";
9+
10+
import { previewBridge } from "./previewBridge";
11+
import {
12+
PreviewAutomationNavigationTimeoutError,
13+
PreviewAutomationTargetUnavailableError,
14+
} from "./previewAutomationErrors";
15+
16+
export function assertPreviewRuntimeCurrent(
17+
threadRef: ScopedThreadRef,
18+
tabId: string,
19+
runtimeTabId: string,
20+
request: Pick<PreviewAutomationRequest, "operation" | "requestId">,
21+
) {
22+
const state = readThreadPreviewState(threadRef);
23+
if (
24+
state.sessions[tabId] &&
25+
isCurrentPreviewRuntimeTab(threadRef, state.serverEpoch, tabId, runtimeTabId)
26+
) {
27+
return state;
28+
}
29+
throw new PreviewAutomationTargetUnavailableError({
30+
requestId: request.requestId,
31+
operation: request.operation,
32+
environmentId: threadRef.environmentId,
33+
threadId: threadRef.threadId,
34+
tabId,
35+
bridgeAvailable: Boolean(previewBridge),
36+
});
37+
}
38+
39+
export async function waitForNavigationReadiness(
40+
threadRef: ScopedThreadRef,
41+
requestId: string,
42+
tabId: string,
43+
runtimeTabId: string,
44+
operation: PreviewAutomationRequest["operation"],
45+
readiness: PreviewAutomationNavigateInput["readiness"],
46+
timeoutMs: number,
47+
): Promise<void> {
48+
const targetReadiness = readiness ?? "load";
49+
if (!previewBridge) return;
50+
assertPreviewRuntimeCurrent(threadRef, tabId, runtimeTabId, { operation, requestId });
51+
if (targetReadiness === "none") return;
52+
const deadline = Date.now() + timeoutMs;
53+
while (Date.now() <= deadline) {
54+
assertPreviewRuntimeCurrent(threadRef, tabId, runtimeTabId, { operation, requestId });
55+
if (targetReadiness === "domContentLoaded") {
56+
const readyState = await previewBridge.automation.evaluate(runtimeTabId, {
57+
expression: "document.readyState",
58+
});
59+
if (readyState === "interactive" || readyState === "complete") return;
60+
} else {
61+
const status = await previewBridge.automation.status(runtimeTabId);
62+
if (status.available && !status.loading) return;
63+
}
64+
await new Promise<void>((resolve) => window.setTimeout(resolve, 50));
65+
}
66+
throw new PreviewAutomationNavigationTimeoutError({
67+
requestId,
68+
environmentId: threadRef.environmentId,
69+
threadId: threadRef.threadId,
70+
tabId,
71+
readiness: targetReadiness,
72+
timeoutMs,
73+
});
74+
}

0 commit comments

Comments
 (0)