From 24b3dc41dff1862405d6926aa618a60d06c737b1 Mon Sep 17 00:00:00 2001 From: morluto <76467478+morluto@users.noreply.github.com> Date: Fri, 24 Jul 2026 14:14:15 +0000 Subject: [PATCH] fix(browser): contain scenario pages and preserve inputs --- scripts/lib/browser-scenario-verifier.mjs | 44 ++++++++++- src/browser/PlaywrightScenarioBrowser.ts | 6 ++ src/browser/PlaywrightScenarioEvents.ts | 6 +- src/browser/PlaywrightScenarioSession.ts | 48 +++++++----- src/domain/browserScenario.ts | 6 ++ tests/browserScenario.test.ts | 12 +++ tests/playwrightScenarioEvents.test.ts | 92 +++++++++++++++++++++++ 7 files changed, 191 insertions(+), 23 deletions(-) create mode 100644 tests/playwrightScenarioEvents.test.ts diff --git a/scripts/lib/browser-scenario-verifier.mjs b/scripts/lib/browser-scenario-verifier.mjs index 77220c093..089657242 100644 --- a/scripts/lib/browser-scenario-verifier.mjs +++ b/scripts/lib/browser-scenario-verifier.mjs @@ -8,6 +8,37 @@ import { browserScenarioSchema } from "../../dist/domain/browserScenario.js"; const execute = promisify(execFile); +const duplicateOriginStorage = (origin) => ({ + local_storage: [ + { + origin, + entries: [ + { + name: "rea-first-seed", + value: { + source: "literal", + value: "first", + classification: "public", + }, + }, + ], + }, + { + origin, + entries: [ + { + name: "rea-second-seed", + value: { + source: "literal", + value: "second", + classification: "public", + }, + }, + ], + }, + ], +}); + /** Build the source-owned full-capture browser scenario. */ export function browserScenario(browser, origin) { return browserScenarioSchema.parse({ @@ -16,7 +47,7 @@ export function browserScenario(browser, origin) { start_url: { url: `${origin}/app`, query: [] }, allowed_origins: [origin], environment: { - viewport: { width: 1_280, height: 720 }, + viewport: { width: 1_280, height: 720, device_scale_factor: 1.25 }, locale: "en-US", timezone: "UTC", color_scheme: "light", @@ -46,7 +77,7 @@ export function browserScenario(browser, origin) { }, }, ], - storage: {}, + storage: duplicateOriginStorage(origin), request_replay: { mode: "disabled" }, secrets: [], redaction: { @@ -153,6 +184,15 @@ export function assertScenarioCapture(capture) { throw new Error( `Scenario launch did not capture every requested artifact: ${JSON.stringify(final?.artifacts ?? null)}`, ); + const storageNames = + final.artifacts.storage.state === "captured" + ? final.artifacts.storage.value.local_storage.map(({ name }) => name) + : []; + if ( + !storageNames.includes("rea-first-seed") || + !storageNames.includes("rea-second-seed") + ) + throw new Error("Scenario launch did not retain duplicate-origin seeds"); if ( capture.events.items.length === 0 || capture.completeness.equality_eligible !== true diff --git a/src/browser/PlaywrightScenarioBrowser.ts b/src/browser/PlaywrightScenarioBrowser.ts index 127e4e5f4..f3e74b121 100644 --- a/src/browser/PlaywrightScenarioBrowser.ts +++ b/src/browser/PlaywrightScenarioBrowser.ts @@ -98,6 +98,12 @@ const configureAttachedEnvironment = async ( }); const session = await context.newCDPSession(page); try { + await session.send("Emulation.setDeviceMetricsOverride", { + width: scenario.environment.viewport.width, + height: scenario.environment.viewport.height, + deviceScaleFactor: scenario.environment.viewport.device_scale_factor, + mobile: false, + }); await session.send("Emulation.setLocaleOverride", { locale: scenario.environment.locale, }); diff --git a/src/browser/PlaywrightScenarioEvents.ts b/src/browser/PlaywrightScenarioEvents.ts index 5da2c74a8..2b3fd604e 100644 --- a/src/browser/PlaywrightScenarioEvents.ts +++ b/src/browser/PlaywrightScenarioEvents.ts @@ -165,9 +165,11 @@ export class PlaywrightScenarioEvents { page.on("pageerror", (error) => this.push({ kind: "page-error", - message: this.secrets.redact(error.message), + message: this.secrets.redact(error.message).slice(0, 65_536), stack: - error.stack === undefined ? null : this.secrets.redact(error.stack), + error.stack === undefined + ? null + : this.secrets.redact(error.stack).slice(0, 262_144), }), ); if (this.enabled.has("network")) { diff --git a/src/browser/PlaywrightScenarioSession.ts b/src/browser/PlaywrightScenarioSession.ts index 26c6acf24..af84358ca 100644 --- a/src/browser/PlaywrightScenarioSession.ts +++ b/src/browser/PlaywrightScenarioSession.ts @@ -41,6 +41,18 @@ const originAllowed = ( } }; +const storageSeeds = ( + blocks: BrowserScenario["storage"]["local_storage"], + secrets: BrowserScenarioSecrets, +): Record => { + const seeds: Record = {}; + for (const { origin, entries } of blocks) + (seeds[origin] ??= []).push( + ...entries.map(({ name, value }) => [name, secrets.value(value)]), + ); + return seeds; +}; + const installStorageSeeds = async ( context: BrowserContext, page: Page, @@ -58,18 +70,8 @@ const installStorageSeeds = async ( })), ); const storage = { - local: Object.fromEntries( - scenario.storage.local_storage.map(({ origin, entries }) => [ - origin, - entries.map(({ name, value }) => [name, secrets.value(value)]), - ]), - ), - session: Object.fromEntries( - scenario.storage.session_storage.map(({ origin, entries }) => [ - origin, - entries.map(({ name, value }) => [name, secrets.value(value)]), - ]), - ), + local: storageSeeds(scenario.storage.local_storage, secrets), + session: storageSeeds(scenario.storage.session_storage, secrets), }; const payload = JSON.stringify(storage).replaceAll("<", "\\u003c"); await page.addInitScript(`(() => { @@ -84,12 +86,11 @@ const installStorageSeeds = async ( const installHttpPolicy = async (input: { readonly context: BrowserContext; - readonly page: Page; readonly scenario: BrowserScenario; readonly secrets: BrowserScenarioSecrets; readonly ownedPages: Set; }): Promise => { - const { context, page, scenario, secrets, ownedPages } = input; + const { context, scenario, secrets, ownedPages } = input; const routes = scenario.request_replay.mode === "exact" ? new Map( @@ -131,7 +132,6 @@ const installHttpPolicy = async (input: { } await route.continue(); }); - page.on("popup", (popup) => ownedPages.add(popup)); }; type ReplayResponse = Extract< @@ -163,11 +163,11 @@ const fulfillReplayRoute = async ( }; const installWebSocketPolicy = async ( - page: Page, + owner: BrowserContext | Page, scenario: BrowserScenario, ): Promise => { const allowed = new Set(scenario.allowed_origins); - await page.routeWebSocket("**/*", async (route: WebSocketRoute) => { + await owner.routeWebSocket("**/*", async (route: WebSocketRoute) => { const url = new URL(route.url()); const httpOrigin = `${url.protocol === "wss:" ? "https:" : "http:"}//${url.host}`; if ( @@ -191,8 +191,18 @@ const initializePage = async ( context.setDefaultTimeout(scenario.limits.action_timeout_ms); context.setDefaultNavigationTimeout(scenario.limits.navigation_timeout_ms); const ownedPages = new Set([page]); - await installHttpPolicy({ context, page, scenario, secrets, ownedPages }); - await installWebSocketPolicy(page, scenario); + await installHttpPolicy({ context, scenario, secrets, ownedPages }); + await installWebSocketPolicy( + scenario.browser.mode === "launch" ? context : page, + scenario, + ); + page.on("popup", (popup) => { + ownedPages.add(popup); + if (scenario.browser.mode === "connect") + void installWebSocketPolicy(popup, scenario).catch(async () => { + await popup.close().catch(() => undefined); + }); + }); await installStorageSeeds(context, page, scenario, secrets); return ownedPages; }; diff --git a/src/domain/browserScenario.ts b/src/domain/browserScenario.ts index 0ade2a880..9d5c06d45 100644 --- a/src/domain/browserScenario.ts +++ b/src/domain/browserScenario.ts @@ -194,6 +194,12 @@ const validateRequestReplay = ( ); return; } + assertUnique( + route.response.headers.map(({ name }) => name.toLowerCase()), + ["request_replay", "routes", routeIndex, "response", "headers"], + "Replay response header names", + context, + ); route.response.headers.forEach((header, headerIndex) => { if (FORBIDDEN_REPLAY_HEADERS.has(header.name)) addIssue( diff --git a/tests/browserScenario.test.ts b/tests/browserScenario.test.ts index dc6ca3a8d..d24276917 100644 --- a/tests/browserScenario.test.ts +++ b/tests/browserScenario.test.ts @@ -246,6 +246,18 @@ describe("browserScenarioSchema", () => { } }); + it("rejects duplicate replay response headers case-insensitively", () => { + const scenario = baseScenario(); + const response = scenario.request_replay.routes[0]!.response; + if (response.kind !== "response") + throw new Error("Expected replay response fixture"); + response.headers.push({ + name: "Content-Type", + value: literal("text/plain"), + }); + expect(browserScenarioSchema.safeParse(scenario).success).toBe(false); + }); + it("rejects raw secret-shaped action values", () => { const scenario = baseScenario(); scenario.actions[0] = { diff --git a/tests/playwrightScenarioEvents.test.ts b/tests/playwrightScenarioEvents.test.ts new file mode 100644 index 000000000..58b31bb1e --- /dev/null +++ b/tests/playwrightScenarioEvents.test.ts @@ -0,0 +1,92 @@ +import { describe, expect, it } from "vitest"; +import type { Page } from "playwright-core"; + +import { BrowserScenarioSecrets } from "../src/browser/BrowserScenarioSecrets.js"; +import { BrowserScenarioCaptureBudget } from "../src/browser/PlaywrightScenarioArtifacts.js"; +import { PlaywrightScenarioEvents } from "../src/browser/PlaywrightScenarioEvents.js"; +import { browserScenarioSchema } from "../src/domain/browserScenario.js"; + +describe("PlaywrightScenarioEvents", () => { + it("bounds oversized page errors before validating captured events", () => { + const listeners = new Map void>(); + const page = { + on: (name: string, listener: (value: Error) => void) => { + listeners.set(name, listener); + }, + } as unknown as Page; + const scenario = browserScenarioSchema.parse({ + schema_version: 1, + browser: { + mode: "launch", + executable_path: "/opt/chromium", + headless: true, + user_data: "temporary-owned", + cleanup: "close-and-delete-profile", + }, + start_url: { url: "https://app.example.test/" }, + allowed_origins: ["https://app.example.test"], + environment: { + viewport: { width: 1_280, height: 720 }, + locale: "en-US", + timezone: "UTC", + color_scheme: "light", + reduced_motion: "reduce", + service_workers: "block", + }, + actions: [ + { + step_id: "wait", + action: "wait_for_timeout", + duration_ms: 1, + }, + ], + storage: {}, + request_replay: { mode: "disabled" }, + secrets: [], + redaction: { + secret_values: "replace-with-secret-reference", + query_parameter_names: [], + }, + capture: { + after_each_step: [], + at_end: [], + events: ["page-errors"], + }, + limits: { + max_duration_ms: 10_000, + action_timeout_ms: 1_000, + navigation_timeout_ms: 1_000, + max_events: 10, + max_frames: 10, + max_workers: 10, + max_popups: 10, + max_websockets: 10, + max_dom_nodes: 100, + max_accessibility_nodes: 100, + max_screenshots: 1, + max_screenshot_bytes: 1_024, + max_storage_entries: 10, + max_total_metadata_bytes: 1_000_000, + }, + approved: true, + }); + const secrets = BrowserScenarioSecrets.resolve(scenario, {}); + if (secrets === undefined) throw new Error("Expected resolved secrets"); + const events = new PlaywrightScenarioEvents({ + page, + enabled: new Set(["page-errors"]), + limits: scenario.limits, + secrets, + budget: new BrowserScenarioCaptureBudget(1, 1_000_000), + }); + const error = new Error("m".repeat(70_000)); + error.stack = "s".repeat(300_000); + + expect(() => listeners.get("pageerror")?.(error)).not.toThrow(); + expect(events.result().items[0]).toMatchObject({ + kind: "page-error", + message: "m".repeat(65_536), + stack: "s".repeat(262_144), + }); + }); +});