Playwright is a framework for Web Testing and Automation. It allows testing Chromium, Firefox and WebKit with a single API.
TypeScript automationchromechromiume2e-testingelectronend-to-end-testingfirefoxjavascriptplaywrighttesttest-automationtestingtesting-toolswebwebkit
chore: support opening .trace files via .link indirection (#39975)
Pavel Feldman6896c34880b7
diff --git a/packages/playwright-core/src/cli/program.ts b/packages/playwright-core/src/cli/program.tsindex 558ddb8170..e47b9c4159 100644--- a/packages/playwright-core/src/cli/program.ts+++ b/packages/playwright-core/src/cli/program.ts@@ -249,7 +249,7 @@ program.action(async options => {const { program: cliProgram } = await import('../tools/cli-client/program');process.argv.splice(process.argv.indexOf('cli'), 1);- cliProgram();+ cliProgram().catch(logErrorAndExit);});function logErrorAndExit(e: Error) {diff --git a/packages/playwright-core/src/tools/backend/tracing.ts b/packages/playwright-core/src/tools/backend/tracing.tsindex f042d93ff5..075727f712 100644--- a/packages/playwright-core/src/tools/backend/tracing.ts+++ b/packages/playwright-core/src/tools/backend/tracing.ts@@ -64,6 +64,11 @@ const tracingStop = defineTool({await browserContext.tracing.stop();// eslint-disable-next-line no-restricted-syntaxconst traceLegend = (browserContext.tracing as any)[traceLegendSymbol];+ if (!traceLegend)+ throw new Error('Tracing is not started');+ // eslint-disable-next-line no-restricted-syntax+ delete (browserContext.tracing as any)[traceLegendSymbol];+response.addTextResult(`Trace recording stopped.`);response.addFileLink('Trace', `${traceLegend.tracesDir}/${traceLegend.name}.trace`);response.addFileLink('Network log', `${traceLegend.tracesDir}/${traceLegend.name}.network`);diff --git a/packages/playwright-core/src/tools/trace/traceUtils.ts b/packages/playwright-core/src/tools/trace/traceUtils.tsindex a066d76773..6d37f64d84 100644--- a/packages/playwright-core/src/tools/trace/traceUtils.ts+++ b/packages/playwright-core/src/tools/trace/traceUtils.ts@@ -68,15 +68,28 @@ export async function openTrace(traceFile: string) {throw new Error(`Trace file not found: ${filePath}`);await closeTrace();await fs.promises.mkdir(traceDir, { recursive: true });- await extractTrace(filePath, traceDir);+ if (filePath.endsWith('.zip'))+ await extractTrace(filePath, traceDir);+ else+ await fs.promises.writeFile(path.join(traceDir, '.link'), filePath, 'utf-8');}export async function loadTrace(): Promise<LoadedTrace> {const dir = ensureTraceOpen();- const backend = new DirTraceLoaderBackend(dir);+ const linkFile = path.join(dir, '.link');+ let traceDir: string;+ let traceFile: string | undefined;+ if (fs.existsSync(linkFile)) {+ const tracePath = await fs.promises.readFile(linkFile, 'utf-8');+ traceDir = path.dirname(tracePath);+ traceFile = path.basename(tracePath);+ } else {+ traceDir = dir;+ }+ const backend = new DirTraceLoaderBackend(traceDir);const loader = new TraceLoader();- await loader.load(backend, () => undefined);- const model = new TraceModel(dir, loader.contextEntries);+ await loader.load(backend, traceFile);+ const model = new TraceModel(traceDir, loader.contextEntries);return new LoadedTrace(model, loader, buildOrdinalMap(model));}diff --git a/packages/playwright-core/src/utils/isomorphic/trace/traceLoader.ts b/packages/playwright-core/src/utils/isomorphic/trace/traceLoader.tsindex 5c9a1e3e22..8547a32e14 100644--- a/packages/playwright-core/src/utils/isomorphic/trace/traceLoader.ts+++ b/packages/playwright-core/src/utils/isomorphic/trace/traceLoader.ts@@ -38,38 +38,39 @@ export class TraceLoader {constructor() {}- async load(backend: TraceLoaderBackend, unzipProgress: (done: number, total: number) => void) {+ async load(backend: TraceLoaderBackend, traceFile?: string, unzipProgress?: (done: number, total: number) => void) {this._backend = backend;- const ordinals: string[] = [];+ const prefix = traceFile?.match(/(.+)\.trace$/)?.[1];+ const prefixes: string[] = [];let hasSource = false;for (const entryName of await this._backend.entryNames()) {const match = entryName.match(/(.+)\.trace$/);- if (match)- ordinals.push(match[1] || '');+ if (match && (!prefix || prefix === match[1]))+ prefixes.push(match[1] || '');if (entryName.includes('src@'))hasSource = true;}- if (!ordinals.length)+ if (!prefixes.length)throw new Error('Cannot find .trace file');this._snapshotStorage = new SnapshotStorage();// 3 * ordinals progress increments below.- const total = ordinals.length * 3;+ const total = prefixes.length * 3;let done = 0;- for (const ordinal of ordinals) {+ for (const prefix of prefixes) {const contextEntry = createEmptyContext();contextEntry.hasSource = hasSource;const modernizer = new TraceModernizer(contextEntry, this._snapshotStorage);- const trace = await this._backend.readText(ordinal + '.trace') || '';+ const trace = await this._backend.readText(prefix + '.trace') || '';modernizer.appendTrace(trace);- unzipProgress(++done, total);+ unzipProgress?.(++done, total);- const network = await this._backend.readText(ordinal + '.network') || '';+ const network = await this._backend.readText(prefix + '.network') || '';modernizer.appendTrace(network);- unzipProgress(++done, total);+ unzipProgress?.(++done, total);contextEntry.actions = modernizer.actions().sort((a1, a2) => a1.startTime - a2.startTime);@@ -87,13 +88,13 @@ export class TraceLoader {}}- const stacks = await this._backend.readText(ordinal + '.stacks');+ const stacks = await this._backend.readText(prefix + '.stacks');if (stacks) {const callMetadata = parseClientSideCallMetadata(JSON.parse(stacks));for (const action of contextEntry.actions)action.stack = action.stack || callMetadata.get(action.callId);}- unzipProgress(++done, total);+ unzipProgress?.(++done, total);for (const resource of contextEntry.resources) {if (resource.request.postData?._sha1)diff --git a/packages/trace-viewer/src/sw/main.ts b/packages/trace-viewer/src/sw/main.tsindex 02cb68aeaf..15a5f23d3d 100644--- a/packages/trace-viewer/src/sw/main.ts+++ b/packages/trace-viewer/src/sw/main.ts@@ -111,7 +111,7 @@ async function innerLoadTrace(traceUri: string, progress: Progress): Promise<Loa// Allow 10% to hop from sw to page.const [fetchProgress, unzipProgress] = splitProgress(progress, [0.5, 0.4, 0.1]);const backend = isLiveTrace(traceUri) || traceUri.endsWith('traces.dir') ? new FetchTraceLoaderBackend(traceUri) : new ZipTraceLoaderBackend(traceUri, fetchProgress);- await traceLoader.load(backend, unzipProgress);+ await traceLoader.load(backend, undefined, unzipProgress);} catch (error: any) {// eslint-disable-next-line no-consoleconsole.error(error);diff --git a/tests/config/utils.ts b/tests/config/utils.tsindex d3a58ab54f..85c21b8c00 100644--- a/tests/config/utils.ts+++ b/tests/config/utils.ts@@ -170,7 +170,7 @@ export async function parseTrace(file: string): Promise<{ snapshots: SnapshotStoawait extractTrace(file, dir);const backend = new DirTraceLoaderBackend(dir);const loader = new TraceLoader();- await loader.load(backend, () => {});+ await loader.load(backend);return { model: new TraceModel(dir, loader.contextEntries), snapshots: loader.storage() };}diff --git a/tests/mcp/trace-cli.spec.ts b/tests/mcp/trace-cli.spec.tsindex 92c32a285f..82668761d5 100644--- a/tests/mcp/trace-cli.spec.ts+++ b/tests/mcp/trace-cli.spec.ts@@ -203,6 +203,31 @@ test('trace close removes extracted trace', async ({ traceFile, runTraceCli }) =expect(exitCode3).toBe(0);});+test('trace open with .trace file creates link', async ({ traceFile, traceCwd, runTraceCli }) => {+ // Extract the zip using the CLI to get raw trace files.+ const extractCwd = path.join(path.dirname(traceFile), 'extracted');+ fs.mkdirSync(extractCwd, { recursive: true });+ const cliPath = path.resolve(__dirname, '../../packages/playwright-core/cli.js');+ const { execFileSync } = require('child_process');+ execFileSync(process.execPath, [cliPath, 'trace', 'open', traceFile], { cwd: extractCwd });+ const extractDir = path.join(extractCwd, '.playwright-cli', 'trace');++ const traceEntries = fs.readdirSync(extractDir).filter((f: string) => f.endsWith('.trace'));+ expect(traceEntries.length).toBeGreaterThan(0);+ const dotTraceFile = path.join(extractDir, traceEntries[0]);+ const { exitCode } = await runTraceCli(['open', dotTraceFile]);+ expect(exitCode).toBe(0);++ const linkFile = path.join(traceCwd, '.playwright-cli', 'trace', '.link');+ expect(fs.existsSync(linkFile)).toBe(true);+ expect(fs.readFileSync(linkFile, 'utf-8')).toBe(dotTraceFile);++ const { stdout: actionsOutput, exitCode: actionsExitCode } = await runTraceCli(['actions']);+ expect(actionsExitCode).toBe(0);+ expect(actionsOutput).toContain('Navigate');+ expect(actionsOutput).toContain('Click');+});+test('trace attachments lists attachments', async ({ runTraceCli }) => {const { stdout, exitCode } = await runTraceCli(['attachments']);expect(exitCode).toBe(0);