Skip to content

Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.

fix(trace): replay sub-resources from archive in trace snapshot CLI (#40632)

Simon Knottcb03945f4f0e
diff --git a/packages/playwright-core/src/tools/trace/traceSnapshot.ts b/packages/playwright-core/src/tools/trace/traceSnapshot.ts
index ccac7fb5a2..0280ef75b2 100644
--- a/packages/playwright-core/src/tools/trace/traceSnapshot.ts
+++ b/packages/playwright-core/src/tools/trace/traceSnapshot.ts
@@ -99,10 +99,37 @@ async function serveTraceSnapshot(storage: SnapshotStorage, loader: TraceLoader,
return true;
});
+ httpServer.routePath('/__pwsnapshot/sw.js', (_request: any, response: any) => {
+ response.statusCode = 200;
+ response.setHeader('Content-Type', 'application/javascript');
+ response.setHeader('Service-Worker-Allowed', '/');
+ response.end(`(${snapshotServiceWorker.toString()})();`);
+ return true;
+ });
+
+ httpServer.routePath('/__pwsnapshot/resource', (request: any, response: any) => {
+ const url = new URL('http://localhost' + request.url!);
+ const frame = new URL(url.searchParams.get('frame')!);
+ const snapshotUrl = 'http://localhost' + frame.pathname + frame.search;
+ const requestUrl = url.searchParams.get('url')!;
+ const method = url.searchParams.get('method')!;
+ snapshotServer.serveResource([requestUrl], method, snapshotUrl).then(async resp => {
+ response.statusCode = resp.status;
+ resp.headers.forEach((value: string, key: string) => response.appendHeader(key, value));
+ response.end(Buffer.from(await resp.arrayBuffer()));
+ }).catch(() => {
+ response.statusCode = 500;
+ response.end();
+ });
+ return true;
+ });
+
+ const startTime = Date.now();
+ const snapshotUrl = `/snapshot/${pageId}?name=${encodeURIComponent(snapshotKey)}`;
httpServer.routePrefix('/', (_request: any, response: any) => {
- response.statusCode = 302;
- response.setHeader('Location', `/snapshot/${pageId}?name=${encodeURIComponent(snapshotKey)}`);
- response.end();
+ response.statusCode = 200;
+ response.setHeader('Content-Type', 'text/html; charset=utf-8');
+ response.end(`<!DOCTYPE html><html><body><script>(${bootstrapSnapshotPage.toString()})(${JSON.stringify(`/__pwsnapshot/sw.js?v=${startTime}`)}, ${JSON.stringify(snapshotUrl)});</script></body></html>`);
return true;
});
@@ -110,11 +137,56 @@ async function serveTraceSnapshot(storage: SnapshotStorage, loader: TraceLoader,
return { url: httpServer.urlPrefix('human-readable'), stop: () => httpServer.stop() };
}
+function snapshotServiceWorker() {
+ type Client = { url: string };
+ type FetchEvent = {
+ request: Request;
+ clientId: string | null;
+ respondWith(response: Promise<Response>): void;
+ };
+ type ServiceWorkerGlobalScope = {
+ location: { origin: string };
+ addEventListener(event: 'install' | 'activate', listener: (event: any) => void): void;
+ addEventListener(event: 'fetch', listener: (event: FetchEvent) => void): void;
+ clients: { claim(): Promise<void>; get(id: string): Promise<Client | undefined> };
+ skipWaiting(): Promise<void>;
+ };
+ const sw = self as unknown as ServiceWorkerGlobalScope;
+
+ sw.addEventListener('install', () => sw.skipWaiting());
+ sw.addEventListener('activate', event => event.waitUntil(sw.clients.claim()));
+ sw.addEventListener('fetch', event => {
+ const requestUrl = new URL(event.request.url);
+ if (requestUrl.origin === sw.location.origin)
+ return;
+ event.respondWith((async () => {
+ const client = event.clientId ? await sw.clients.get(event.clientId) : null;
+ if (!client)
+ return new Response('No client', { status: 500 });
+ const params = new URLSearchParams({
+ frame: client.url,
+ url: event.request.url,
+ method: event.request.method,
+ });
+ return fetch('/__pwsnapshot/resource?' + params.toString());
+ })());
+ });
+}
+
+async function bootstrapSnapshotPage(swUrl: string, snapshotUrl: string) {
+ await navigator.serviceWorker.register(swUrl, { scope: '/' });
+ await navigator.serviceWorker.ready;
+ if (!navigator.serviceWorker.controller)
+ await new Promise(resolve => navigator.serviceWorker.addEventListener('controllerchange', resolve, { once: true }));
+ location.replace(snapshotUrl);
+}
+
async function runCommandOnSnapshot(server: { url: string, stop: () => Promise<void> }, browserArgs: string[]) {
const browser = await playwright.chromium.launch({ headless: true });
const context = await browser.newContext();
const page = await context.newPage();
await page.goto(server.url);
+ await page.waitForURL(url => new URL(url).pathname.startsWith('/snapshot/'));
const backend = new BrowserBackend({
snapshot: { mode: 'full' },
diff --git a/tests/mcp/trace-cli-fixtures.ts b/tests/mcp/trace-cli-fixtures.ts
index 647991b855..1c39e81887 100644
--- a/tests/mcp/trace-cli-fixtures.ts
+++ b/tests/mcp/trace-cli-fixtures.ts
@@ -44,16 +44,22 @@ export const test = baseTest
const page = await context.newPage();
server.setContent('/', `
<html>
- <head><title>Test Page</title></head>
+ <head>
+ <title>Test Page</title>
+ <link rel="stylesheet" href="/style.css">
+ </head>
<body>
<h1>Hello World</h1>
<button id="btn">Click me</button>
<input id="search" type="text" placeholder="Search..." />
<a href="/page2">Go to page 2</a>
+ <div id="styled">Styled text</div>
</body>
</html>
`, 'text/html');
+ server.setContent('/style.css', '#styled { color: rgb(255, 0, 0); }', 'text/css');
+
server.setContent('/page2', `
<html>
<head><title>Page 2</title></head>
@@ -114,6 +120,8 @@ export const test = baseTest
await context.tracing.stop({ path: tracePath });
await browser.close();
+ server.reset();
+
await use(tracePath);
await fs.promises.rm(tmpDir, { recursive: true, force: true });
diff --git a/tests/mcp/trace-cli.spec.ts b/tests/mcp/trace-cli.spec.ts
index 3bc4c01fd0..7b886ad1f6 100644
--- a/tests/mcp/trace-cli.spec.ts
+++ b/tests/mcp/trace-cli.spec.ts
@@ -15,9 +15,9 @@
*/
import fs from 'fs';
+import path from 'path';
import { test, expect } from './trace-cli-fixtures';
-import path from 'path';
test.skip(({ mcpBrowser }) => mcpBrowser !== 'chrome', 'Chrome-only');
@@ -185,6 +185,20 @@ test('trace snapshot resolves inner frames', async ({ runTraceCli }) => {
expect(stdout).toContain('Innermost');
});
+test('trace snapshot replays sub-resource stylesheets from the archive', async ({ runTraceCli }) => {
+ const { stdout: listOutput } = await runTraceCli(['actions', '--grep', 'Click']);
+ const match = listOutput.match(/^\s+(\d+)\.\s/m);
+ expect(match).toBeTruthy();
+ const ordinal = match![1];
+
+ const { stdout, exitCode } = await runTraceCli([
+ 'snapshot', '--name', 'before', ordinal,
+ '--', 'eval', 'el => getComputedStyle(el).color', '#styled',
+ ]);
+ expect(exitCode).toBe(0);
+ expect(stdout).toContain('rgb(255, 0, 0)');
+});
+
test('trace screenshot saves image file', async ({ runTraceCli }, testInfo) => {
const { stdout: listOutput } = await runTraceCli(['actions', '--grep', 'Navigate']);
const match = listOutput.match(/^\s+(\d+)\.\s/m);