Skip to content

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

chore(trace): remove snapshot pointers from action events (#42431)

Dmitry Gozman9a450a2ff5f9
diff --git a/packages/isomorphic/trace/entries.ts b/packages/isomorphic/trace/entries.ts
index a762d285bd..cdba1834d1 100644
--- a/packages/isomorphic/trace/entries.ts
+++ b/packages/isomorphic/trace/entries.ts
@@ -39,6 +39,7 @@ export type ContextEntry = {
actions: ActionEntry[];
screenshots: trace.ScreenshotTraceEvent[];
ariaSnapshots: trace.AriaSnapshotTraceEvent[];
+ domSnapshots: { callId: string, phase: trace.ActionPhase }[];
videos: trace.VideoTraceEvent[];
events: (trace.EventTraceEvent | trace.ConsoleMessageTraceEvent)[];
stdio: trace.StdioTraceEvent[];
diff --git a/packages/isomorphic/trace/snapshotRenderer.ts b/packages/isomorphic/trace/snapshotRenderer.ts
index 433ee074c7..0e2a96aef9 100644
--- a/packages/isomorphic/trace/snapshotRenderer.ts
+++ b/packages/isomorphic/trace/snapshotRenderer.ts
@@ -326,7 +326,7 @@ function snapshotScript(viewport: ViewportSize, ...targetIds: (string | undefine
const canvasElements: HTMLCanvasElement[] = [];
let topSnapshotWindow: Window = win;
- while (topSnapshotWindow !== topSnapshotWindow.parent && !topSnapshotWindow.location.pathname.match(/\/page@[a-z0-9]+$/))
+ while (topSnapshotWindow !== topSnapshotWindow.parent && new URLSearchParams(topSnapshotWindow.location.search).has('frameId'))
topSnapshotWindow = topSnapshotWindow.parent;
const visit = (root: Document | ShadowRoot) => {
@@ -401,13 +401,12 @@ function snapshotScript(viewport: ViewportSize, ...targetIds: (string | undefine
if (!src) {
iframe.setAttribute('src', blankSnapshotUrl);
} else {
- // Retain query parameters to inherit name=, time=, pointX=, pointY= and other values from parent.
+ // The attribute value is recorded as `/snapshot/<frameId>` by the snapshotter.
+ const frameId = src.substring(src.lastIndexOf('/') + 1);
+ // All frames of a page share the snapshot name in the path, so we only swap the frame id.
+ // Retain query parameters to inherit time=, pointX=, pointY= and other values from parent.
const url = new URL(win.location.href);
- // We can be loading iframe from within iframe, reset base to be absolute.
- const index = url.pathname.lastIndexOf('/snapshot/');
- if (index !== -1)
- url.pathname = url.pathname.substring(0, index + 1);
- url.pathname += src.substring(1);
+ url.searchParams.set('frameId', frameId);
iframe.setAttribute('src', url.toString());
}
}
diff --git a/packages/isomorphic/trace/snapshotServer.ts b/packages/isomorphic/trace/snapshotServer.ts
index 8149a10f85..89a83ea29f 100644
--- a/packages/isomorphic/trace/snapshotServer.ts
+++ b/packages/isomorphic/trace/snapshotServer.ts
@@ -18,6 +18,7 @@ import type { URLSearchParams } from 'url';
import type { SnapshotRenderer } from './snapshotRenderer';
import type { SnapshotStorage } from './snapshotStorage';
import type { ResourceSnapshot } from '@trace/snapshot';
+import type { ActionPhase } from '@trace/trace';
export class SnapshotServer {
private _snapshotStorage: SnapshotStorage;
@@ -29,8 +30,8 @@ export class SnapshotServer {
this._resourceLoader = resourceLoader;
}
- serveSnapshot(pageOrFrameId: string, searchParams: URLSearchParams, snapshotUrl: string): Response {
- const snapshot = this._snapshot(pageOrFrameId, searchParams);
+ serveSnapshot(callId: string, searchParams: URLSearchParams, snapshotUrl: string): Response {
+ const snapshot = this._snapshot(callId, searchParams);
if (!snapshot)
return new Response(null, { status: 404 });
@@ -39,16 +40,16 @@ export class SnapshotServer {
return new Response(renderedSnapshot.html, { status: 200, headers: { 'Content-Type': 'text/html; charset=utf-8' } });
}
- async serveClosestScreenshot(pageOrFrameId: string, searchParams: URLSearchParams): Promise<Response> {
- const snapshot = this._snapshot(pageOrFrameId, searchParams);
+ async serveClosestScreenshot(callId: string, searchParams: URLSearchParams): Promise<Response> {
+ const snapshot = this._snapshot(callId, searchParams);
const file = snapshot?.closestScreenshot();
if (!file)
return new Response(null, { status: 404 });
return new Response(await this._resourceLoader(file));
}
- serveSnapshotInfo(pageOrFrameId: string, searchParams: URLSearchParams): Response {
- const snapshot = this._snapshot(pageOrFrameId, searchParams);
+ serveSnapshotInfo(callId: string, searchParams: URLSearchParams): Response {
+ const snapshot = this._snapshot(callId, searchParams);
return this._respondWithJson(snapshot ? {
viewport: snapshot.viewport(),
url: snapshot.snapshot().frameUrl,
@@ -59,9 +60,8 @@ export class SnapshotServer {
});
}
- private _snapshot(pageOrFrameId: string, params: URLSearchParams) {
- const name = params.get('name')!;
- return this._snapshotStorage.snapshotByName(pageOrFrameId, name);
+ private _snapshot(callId: string, params: URLSearchParams) {
+ return this._snapshotStorage.snapshotForCall(callId, params.get('phase') as ActionPhase, params.get('frameId') || undefined);
}
private _respondWithJson(object: any): Response {
diff --git a/packages/isomorphic/trace/snapshotStorage.ts b/packages/isomorphic/trace/snapshotStorage.ts
index d71407146b..ee80afef64 100644
--- a/packages/isomorphic/trace/snapshotStorage.ts
+++ b/packages/isomorphic/trace/snapshotStorage.ts
@@ -18,14 +18,13 @@ import { rewriteURLForCustomProtocol, SnapshotRenderer } from './snapshotRendere
import { LRUCache } from '../lruCache';
import type { FrameSnapshot, ResourceSnapshot } from '@trace/snapshot';
+import type { ActionPhase } from '@trace/trace';
import type { PageEntry } from './entries';
export class SnapshotStorage {
- private _frameSnapshots = new Map<string, {
- raw: FrameSnapshot[],
- renderers: SnapshotRenderer[],
- }>();
+ private _snapshotsByFrameId = new Map<string, FrameSnapshot[]>();
+ private _renderersByCallIdAndPhase = new Map<string, SnapshotRenderer[]>();
private _cache = new LRUCache<SnapshotRenderer, string>(100_000_000); // 100MB per each trace
private _resources: ResourceSnapshot[] = [];
private _resourceUrlsWithOverrides = new Set<string>();
@@ -38,29 +37,32 @@ export class SnapshotStorage {
addFrameSnapshot(snapshot: FrameSnapshot, screencastFrames: PageEntry['screencastFrames']) {
for (const override of snapshot.resourceOverrides)
override.url = rewriteURLForCustomProtocol(override.url);
- let frameSnapshots = this._frameSnapshots.get(snapshot.frameId);
+ let frameSnapshots = this._snapshotsByFrameId.get(snapshot.frameId);
if (!frameSnapshots) {
- frameSnapshots = {
- raw: [],
- renderers: [],
- };
- this._frameSnapshots.set(snapshot.frameId, frameSnapshots);
- if (snapshot.isMainFrame)
- this._frameSnapshots.set(snapshot.pageId, frameSnapshots);
+ frameSnapshots = [];
+ this._snapshotsByFrameId.set(snapshot.frameId, frameSnapshots);
+ }
+ frameSnapshots.push(snapshot);
+ const renderer = new SnapshotRenderer(this._cache, this._resources, frameSnapshots, screencastFrames, frameSnapshots.length - 1);
+ if (snapshot.phase) {
+ const key = callIdAndPhase(snapshot.callId, snapshot.phase);
+ let renderers = this._renderersByCallIdAndPhase.get(key);
+ if (!renderers) {
+ renderers = [];
+ this._renderersByCallIdAndPhase.set(key, renderers);
+ }
+ renderers.push(renderer);
}
- frameSnapshots.raw.push(snapshot);
- const renderer = new SnapshotRenderer(this._cache, this._resources, frameSnapshots.raw, screencastFrames, frameSnapshots.raw.length - 1);
- frameSnapshots.renderers.push(renderer);
return renderer;
}
- snapshotByName(pageOrFrameId: string, snapshotName: string): SnapshotRenderer | undefined {
- const snapshot = this._frameSnapshots.get(pageOrFrameId);
- return snapshot?.renderers.find(r => r.snapshotName === snapshotName);
+ snapshotForCall(callId: string, phase: ActionPhase, frameId?: string): SnapshotRenderer | undefined {
+ const renderers = this._renderersByCallIdAndPhase.get(callIdAndPhase(callId, phase)) || [];
+ return renderers.find(r => frameId ? r.snapshot().frameId === frameId : r.snapshot().isMainFrame);
}
snapshotsForTest() {
- return [...this._frameSnapshots.keys()];
+ return [...this._renderersByCallIdAndPhase.keys()];
}
finalize() {
@@ -68,8 +70,8 @@ export class SnapshotStorage {
this._resources.sort((a, b) => (a._monotonicTime || 0) - (b._monotonicTime || 0));
// Resources that have overrides should not be cached, otherwise we might get stale content
// while serving snapshots with different override values.
- for (const frameSnapshots of this._frameSnapshots.values()) {
- for (const snapshot of frameSnapshots.raw) {
+ for (const frameSnapshots of this._snapshotsByFrameId.values()) {
+ for (const snapshot of frameSnapshots) {
for (const override of snapshot.resourceOverrides)
this._resourceUrlsWithOverrides.add(override.url);
}
@@ -80,3 +82,7 @@ export class SnapshotStorage {
return this._resourceUrlsWithOverrides.has(url);
}
}
+
+function callIdAndPhase(callId: string, phase: ActionPhase): string {
+ return `${callId}/${phase}`;
+}
diff --git a/packages/isomorphic/trace/traceLoader.ts b/packages/isomorphic/trace/traceLoader.ts
index 9daa159473..6803a3977a 100644
--- a/packages/isomorphic/trace/traceLoader.ts
+++ b/packages/isomorphic/trace/traceLoader.ts
@@ -152,6 +152,7 @@ function createEmptyContext(): ContextEntry {
actions: [],
screenshots: [],
ariaSnapshots: [],
+ domSnapshots: [],
videos: [],
events: [],
errors: [],
diff --git a/packages/isomorphic/trace/traceModel.ts b/packages/isomorphic/trace/traceModel.ts
index 3580cc7d9d..44503a467e 100644
--- a/packages/isomorphic/trace/traceModel.ts
+++ b/packages/isomorphic/trace/traceModel.ts
@@ -94,6 +94,7 @@ export class TraceModel {
private _eventsForAction = new Map<ActionEntry, (trace.EventTraceEvent | trace.ConsoleMessageTraceEvent)[]>();
private _screenshots = new Map<string, trace.ScreenshotTraceEvent>();
private _ariaSnapshots = new Map<string, trace.AriaSnapshotTraceEvent>();
+ private _domSnapshots = new Set<string>();
constructor(traceUri: string, contexts: ContextEntry[]) {
const libraryContext = contexts.find(context => context.origin === 'library');
@@ -131,9 +132,11 @@ export class TraceModel {
this._screenshots.set(`${event.callId}/${event.phase}`, event);
for (const event of context.ariaSnapshots || [])
this._ariaSnapshots.set(`${event.callId}/${event.phase}`, event);
+ for (const entry of context.domSnapshots || [])
+ this._domSnapshots.add(`${entry.callId}/${entry.phase}`);
this.videos.push(...(context.videos || []));
}
- this.hasDomSnapshots = this.actions.some(action => !!action.beforeSnapshot || !!action.afterSnapshot || !!action.inputSnapshot);
+ this.hasDomSnapshots = !!this._domSnapshots.size;
this.hasAriaSnapshots = !!this._screenshots.size || !!this._ariaSnapshots.size;
this.attachments = this.actions.flatMap(action => action.attachments?.map(attachment => ({ ...attachment, callId: action.callId, traceUri })) ?? []);
this.visibleAttachments = this.attachments.filter(attachment => !attachment.name.startsWith('_'));
@@ -177,6 +180,10 @@ export class TraceModel {
return this._screenshots.get(`${callId}/${phase}`);
}
+ hasDomSnapshotForCall(callId: string, phase: trace.ActionPhase): boolean {
+ return this._domSnapshots.has(`${callId}/${phase}`);
+ }
+
ariaSnapshotForCall(callId: string, phase: trace.ActionPhase): trace.AriaSnapshotTraceEvent | undefined {
return this._ariaSnapshots.get(`${callId}/${phase}`);
}
diff --git a/packages/isomorphic/trace/traceModernizer.ts b/packages/isomorphic/trace/traceModernizer.ts
index 20047ddb4d..474569fc12 100644
--- a/packages/isomorphic/trace/traceModernizer.ts
+++ b/packages/isomorphic/trace/traceModernizer.ts
@@ -21,6 +21,7 @@ import type * as traceV5 from './versions/traceV5';
import type * as traceV6 from './versions/traceV6';
import type * as traceV7 from './versions/traceV7';
import type * as traceV8 from './versions/traceV8';
+import type { FrameSnapshot } from '@trace/snapshot';
import type { ActionEntry, ContextEntry, PageEntry } from './entries';
import type { SnapshotStorage } from './snapshotStorage';
@@ -48,6 +49,7 @@ export class TraceModernizer {
private _jsHandles = new Map<string, { preview: string }>();
private _consoleObjects = new Map<string, { type: string, text: string, location: { url: string, lineNumber: number, columnNumber: number }, args?: { preview: string, value: string }[] }>();
private _apiRequestRef: string | undefined;
+ private _snapshotPhases = new Map<string, trace.ActionPhase>();
constructor(contextEntry: ContextEntry, snapshotStorage: SnapshotStorage) {
this._contextEntry = contextEntry;
@@ -63,6 +65,11 @@ export class TraceModernizer {
return [...this._actionMap.values()];
}
+ private _collectSnapshotPhase(snapshotName: string | undefined, phase: trace.ActionPhase) {
+ if (snapshotName)
+ this._snapshotPhases.set(snapshotName, phase);
+ }
+
private _pageEntry(pageId: string): PageEntry {
let pageEntry = this._pageEntries.get(pageId);
if (!pageEntry) {
@@ -129,7 +136,6 @@ export class TraceModernizer {
}
case 'input': {
const existing = this._actionMap.get(event.callId);
- existing!.inputSnapshot = event.inputSnapshot;
existing!.point = event.point;
existing!.box = event.box;
break;
@@ -147,7 +153,6 @@ export class TraceModernizer {
}
case 'after': {
const existing = this._actionMap.get(event.callId);
- existing!.afterSnapshot = event.afterSnapshot;
existing!.endTime = event.endTime;
existing!.result = event.result;
existing!.error = event.error;
@@ -162,6 +167,9 @@ export class TraceModernizer {
break;
}
case 'event': {
+ // Make sure there is a page entry for each page.
+ if ((event.method === 'page' || event.method === 'pageClosed') && event.params?.pageId)
+ this._pageEntry(event.params.pageId);
contextEntry.events.push(event);
break;
}
@@ -185,9 +193,13 @@ export class TraceModernizer {
this._snapshotStorage.addResource(event.snapshot);
contextEntry.resources.push(event.snapshot);
break;
- case 'frame-snapshot':
- this._snapshotStorage.addFrameSnapshot(event.snapshot, this._pageEntry(event.snapshot.pageId).screencastFrames);
+ case 'frame-snapshot': {
+ const snapshot = event.snapshot;
+ this._snapshotStorage.addFrameSnapshot(snapshot, this._pageEntry(snapshot.pageId).screencastFrames);
+ if (snapshot.isMainFrame && snapshot.phase)
+ contextEntry.domSnapshots.push({ callId: snapshot.callId, phase: snapshot.phase });
break;
+ }
}
// Make sure there is a page entry for each page, even without screencast frames,
// to show in the metadata view.
@@ -500,6 +512,19 @@ export class TraceModernizer {
_modernize_8_to_9(events: traceV8.TraceEvent[]): trace.TraceEvent[] {
for (const event of events) {
+ // Actions used to point at their snapshots by name, now snapshots know their own phase.
+ if (event.type === 'before' || event.type === 'input' || event.type === 'after' || event.type === 'action') {
+ const action = event as traceV8.ActionTraceEvent;
+ this._collectSnapshotPhase(action.beforeSnapshot, 'before');
+ this._collectSnapshotPhase(action.inputSnapshot, 'action');
+ this._collectSnapshotPhase(action.afterSnapshot, 'after');
+ delete action.beforeSnapshot;
+ delete action.inputSnapshot;
+ delete action.afterSnapshot;
+ }
+ if (event.type === 'frame-snapshot' && event.snapshot.snapshotName)
+ (event.snapshot as FrameSnapshot).phase = this._snapshotPhases.get(event.snapshot.snapshotName);
+
if (event.type !== 'resource-snapshot')
continue;
const snapshot = event.snapshot;
diff --git a/packages/playwright-core/src/server/dispatchers/dispatcher.ts b/packages/playwright-core/src/server/dispatchers/dispatcher.ts
index 3a164f9f31..1cc3b578e0 100644
--- a/packages/playwright-core/src/server/dispatchers/dispatcher.ts
+++ b/packages/playwright-core/src/server/dispatchers/dispatcher.ts
@@ -348,8 +348,6 @@ export class DispatcherConnection {
internal: validMetadata.internal,
stepId: validMetadata.stepId,
objectId: sdkObject.guid,
- pageId: sdkObject.attribution?.page?.guid,
- frameId: sdkObject.attribution?.frame?.guid,
startTime: monotonicTime(),
endTime: 0,
type: dispatcher._type,
@@ -440,8 +438,6 @@ export class DispatcherConnection {
internal: validMetadata.internal,
stepId: validMetadata.stepId,
objectId: sdkObject.guid,
- pageId: sdkObject.attribution?.page?.guid,
- frameId: sdkObject.attribution?.frame?.guid,
startTime: monotonicTime(),
endTime: 0,
type: dispatcher._type,
diff --git a/packages/playwright-core/src/server/instrumentation.ts b/packages/playwright-core/src/server/instrumentation.ts
index 5b8563874f..20187cca4d 100644
--- a/packages/playwright-core/src/server/instrumentation.ts
+++ b/packages/playwright-core/src/server/instrumentation.ts
@@ -103,8 +103,6 @@ export type CallMetadata = {
error?: SerializedError;
result?: any;
objectId?: string;
- pageId?: string;
- frameId?: string;
};
export interface Instrumentation {
diff --git a/packages/playwright-core/src/server/page.ts b/packages/playwright-core/src/server/page.ts
index 9f562d5e0d..00ee7449d2 100644
--- a/packages/playwright-core/src/server/page.ts
+++ b/packages/playwright-core/src/server/page.ts
@@ -259,7 +259,7 @@ export class Page extends SdkObject<PageEventMap> {
// corresponding Close event after it is reported on the context.
if (this.isClosed())
this.emit(Page.Events.Close);
- else
+ else if (!this.isStorageStatePage)
this.instrumentation.onPageOpen(this);
// Note: it is important to resolve _initializedPromise at the end,
@@ -315,7 +315,8 @@ export class Page extends SdkObject<PageEventMap> {
this.emit(Page.Events.Close);
this.browserContext.emit(BrowserContext.Events.PageClosed, this);
this.closedPromise.resolve();
- this.instrumentation.onPageClose(this);
+ if (!this.isStorageStatePage)
+ this.instrumentation.onPageClose(this);
}
_didCrash() {
diff --git a/packages/playwright-core/src/server/trace/recorder/snapshotter.ts b/packages/playwright-core/src/server/trace/recorder/snapshotter.ts
index b7c5122e13..2601ecb05a 100644
--- a/packages/playwright-core/src/server/trace/recorder/snapshotter.ts
+++ b/packages/playwright-core/src/server/trace/recorder/snapshotter.ts
@@ -29,6 +29,7 @@ import type { RegisteredListener } from '@utils/eventsHelper';
import type { Frame } from '../../frames';
import type { InitScript } from '../../page';
import type { FrameSnapshot } from '@trace/snapshot';
+import type { ActionPhase } from '@trace/trace';
import type { Progress } from '../../progress';
export type SnapshotterBlob = {
@@ -120,7 +121,7 @@ export class Snapshotter {
}
}
- async captureSnapshot(page: Page, callId: string, snapshotName: string, resetTargets: boolean): Promise<void> {
+ async captureSnapshot(page: Page, callId: string, phase: ActionPhase, resetTargets: boolean): Promise<void> {
// In each frame, in a non-stalling manner, capture the snapshots.
const snapshots = page.frames().map(async frame => {
const data = await this._captureFrameSnapshot(frame, resetTargets);
@@ -130,7 +131,7 @@ export class Snapshotter {
const snapshot: FrameSnapshot = {
callId,
- snapshotName,
+ phase,
pageId: page.guid,
frameId: frame.guid,
frameUrl: data.url,
diff --git a/packages/playwright-core/src/server/trace/recorder/tracing.ts b/packages/playwright-core/src/server/trace/recorder/tracing.ts
index b66f1ceb81..7bb1ff24d7 100644
--- a/packages/playwright-core/src/server/trace/recorder/tracing.ts
+++ b/packages/playwright-core/src/server/trace/recorder/tracing.ts
@@ -229,6 +229,10 @@ export class Tracing extends SdkObject implements InstrumentationListener, Snaps
eventsHelper.addEventListener(this._context, BrowserContext.Events.Console, this._onConsoleMessage.bind(this)),
eventsHelper.addEventListener(this._context, BrowserContext.Events.PageError, this._onPageError.bind(this)),
);
+ if (this._context instanceof BrowserContext) {
+ for (const page of this._context.pages())
+ this.onPageOpen(page);
+ }
if (this._state.options.screencast)
this._startScreencast();
this._harTracer.setOmitWebSocketFrames(!!process.env.PLAYWRIGHT_TRACING_NO_WEBSOCKET_FRAMES);
@@ -469,34 +473,26 @@ export class Tracing extends SdkObject implements InstrumentationListener, Snaps
return { artifact };
}
- private async _captureSnapshot(progress: Progress, sdkObject: SdkObject, phase: trace.ActionPhase, domSnapshotName: string | undefined): Promise<void> {
+ private async _captureSnapshot(progress: Progress, sdkObject: SdkObject, phase: trace.ActionPhase): Promise<void> {
const page = sdkObject.attribution.page;
if (!page)
return;
+ if (!this._shouldCaptureAtPhase(progress.metadata, phase))
+ return;
- if (domSnapshotName) {
+ if (this._snapshotter?.started()) {
// Node references are only reset by the first snapshot of the action.
const resetTargets = phase === 'before';
- await this._snapshotter?.captureSnapshot(page, progress.metadata.id, domSnapshotName, resetTargets).catch(() => {});
+ await this._snapshotter?.captureSnapshot(page, progress.metadata.id, phase, resetTargets).catch(() => {});
}
const options = this._state?.options;
- if (!options?.snapshotScreen && !options?.snapshotAria)
- return;
- if (!this._shouldCaptureAtPhase(progress.metadata, phase))
- return;
- if (options.snapshotScreen)
+ if (options?.snapshotScreen)
await this._captureScreenshot(progress, page, phase);
- if (options.snapshotAria)
+ if (options?.snapshotAria)
await this._captureAriaSnapshot(progress, page, phase);
}
- private _shouldCaptureDOMSnapshot(sdkObject: SdkObject, metadata: CallMetadata, phase: trace.ActionPhase) {
- if (!sdkObject.attribution.page || !this._snapshotter?.started())
- return false;
- return this._shouldCaptureAtPhase(metadata, phase);
- }
-
private _shouldCaptureAtPhase(metadata: CallMetadata, phase: trace.ActionPhase) {
const metainfo = getMetainfo(metadata);
if (!metainfo?.snapshot)
@@ -537,11 +533,9 @@ export class Tracing extends SdkObject implements InstrumentationListener, Snaps
if (!event)
return Promise.resolve();
this._temporarilyDisableThrottling(sdkObject.attribution.page);
- if (this._shouldCaptureDOMSnapshot(sdkObject, metadata, 'before'))
- event.beforeSnapshot = `before@${metadata.id}`;
this._state?.callsInProgress.add(metadata.id);
this._appendTraceEvent(event);
- return this._captureSnapshot(progress, sdkObject, 'before', event.beforeSnapshot);
+ return this._captureSnapshot(progress, sdkObject, 'before');
}
onBeforeInputAction(progress: Progress, sdkObject: SdkObject, point?: types.Point, box?: types.Rect) {
@@ -553,10 +547,8 @@ export class Tracing extends SdkObject implements InstrumentationListener, Snaps
if (!event)
return Promise.resolve();
this._temporarilyDisableThrottling(sdkObject.attribution.page);
- if (this._shouldCaptureDOMSnapshot(sdkObject, metadata, 'action'))
- event.inputSnapshot = `input@${metadata.id}`;
this._appendTraceEvent(event);
- return this._captureSnapshot(progress, sdkObject, 'action', event.inputSnapshot);
+ return this._captureSnapshot(progress, sdkObject, 'action');
}
onCallLog(sdkObject: SdkObject, metadata: CallMetadata, logName: string, message: string) {
@@ -581,10 +573,8 @@ export class Tracing extends SdkObject implements InstrumentationListener, Snaps
if (!event)
return Promise.resolve();
this._temporarilyDisableThrottling(sdkObject.attribution.page);
- if (this._shouldCaptureDOMSnapshot(sdkObject, metadata, 'after'))
- event.afterSnapshot = `after@${metadata.id}`;
this._appendTraceEvent(event);
- return this._captureSnapshot(progress, sdkObject, 'after', event.afterSnapshot);
+ return this._captureSnapshot(progress, sdkObject, 'after');
}
onEntryStarted(entry: har.Entry) {
@@ -795,7 +785,6 @@ function createBeforeActionTraceEvent(metadata: CallMetadata, parentId?: string)
method: metadata.method,
params: metadata.timeout ? { ...metadata.params, timeout: metadata.timeout } : metadata.params,
stepId: metadata.stepId,
- pageId: metadata.pageId,
};
if (parentId)
event.parentId = parentId;
diff --git a/packages/playwright-core/src/tools/skills/playwright-trace/SKILL.md b/packages/playwright-core/src/tools/skills/playwright-trace/SKILL.md
index c92e2a5d83..126b17a08d 100644
--- a/packages/playwright-core/src/tools/skills/playwright-trace/SKILL.md
+++ b/packages/playwright-core/src/tools/skills/playwright-trace/SKILL.md
@@ -55,7 +55,7 @@ npx playwright trace actions --errors-only
npx playwright trace action <action-id>
```
-The `action` command displays available snapshot phases (before, input, after) and the exact command to extract them.
+The `action` command displays available snapshot phases (before, action, after) and the exact command to extract them.
### Requests
@@ -115,7 +115,7 @@ The `snapshot` command loads the DOM snapshot for an action into a headless brow
npx playwright trace snapshot <action-id>
# Use a specific phase
-npx playwright trace snapshot <action-id> --name before
+npx playwright trace snapshot <action-id> --phase before
# Run eval to query the DOM
npx playwright trace snapshot <action-id> -- eval "document.title"
diff --git a/packages/playwright-core/src/tools/trace/traceActions.ts b/packages/playwright-core/src/tools/trace/traceActions.ts
index 6332aa3f7d..8056666180 100644
--- a/packages/playwright-core/src/tools/trace/traceActions.ts
+++ b/packages/playwright-core/src/tools/trace/traceActions.ts
@@ -20,6 +20,8 @@ import { buildActionTree } from '@isomorphic/trace/traceModel';
import { msToString } from '@isomorphic/formatUtils';
import { loadTrace, formatTimestamp, actionFullTitle, actionSubtitle, actionTitle } from './traceUtils';
+import { kActionPhases } from './traceUtils';
+
import type { ActionEntry } from '@isomorphic/trace/entries';
export async function traceActions(options: { grep?: string, errorsOnly?: boolean }) {
@@ -121,17 +123,11 @@ export async function traceAction(actionId: string) {
}
// Snapshots
- const snapshots: string[] = [];
- if (action.beforeSnapshot)
- snapshots.push('before');
- if (action.inputSnapshot)
- snapshots.push('input');
- if (action.afterSnapshot)
- snapshots.push('after');
- if (snapshots.length) {
+ const phases = kActionPhases.filter(phase => trace.model.hasDomSnapshotForCall(action.callId, phase));
+ if (phases.length) {
console.log('\n Snapshots');
- console.log(` available: ${snapshots.join(', ')}`);
- console.log(` usage: npx playwright trace snapshot ${actionId} --name <${snapshots.join('|')}>`);
+ console.log(` available: ${phases.join(', ')}`);
+ console.log(` usage: npx playwright trace snapshot ${actionId} --phase <${phases.join('|')}>`);
}
console.log('');
}
diff --git a/packages/playwright-core/src/tools/trace/traceCli.ts b/packages/playwright-core/src/tools/trace/traceCli.ts
index 91a64b0304..4737826a32 100644
--- a/packages/playwright-core/src/tools/trace/traceCli.ts
+++ b/packages/playwright-core/src/tools/trace/traceCli.ts
@@ -105,11 +105,11 @@ export function addTraceCommands(program: Command, logErrorAndExit: (e: Error) =
traceCommand
.command('snapshot <action-id>')
.description('run a playwright-cli command against a DOM snapshot')
- .option('--name <name>', 'snapshot phase: before, input, or after')
+ .option('--phase <phase>', 'snapshot phase: before, action, or after')
.option('--serve', 'serve snapshot on localhost and keep running')
.allowUnknownOption(true)
.allowExcessArguments(true)
- .action(async (actionId: string, options: { name?: string, serve?: boolean }, cmd: Command) => {
+ .action(async (actionId: string, options: { phase?: string, serve?: boolean }, cmd: Command) => {
try {
// Collect everything after '--' as the browser command.
const browserArgs = cmd.args.slice(1);
diff --git a/packages/playwright-core/src/tools/trace/traceScreenshot.ts b/packages/playwright-core/src/tools/trace/traceScreenshot.ts
index 4082f17e53..b2f7191d84 100644
--- a/packages/playwright-core/src/tools/trace/traceScreenshot.ts
+++ b/packages/playwright-core/src/tools/trace/traceScreenshot.ts
@@ -16,7 +16,7 @@
/* eslint-disable no-console */
-import { loadTrace, saveOutputFile } from './traceUtils';
+import { kActionPhases, loadTrace, saveOutputFile } from './traceUtils';
export async function traceScreenshot(actionId: string, options: { output?: string }) {
const trace = await loadTrace();
@@ -28,19 +28,11 @@ export async function traceScreenshot(actionId: string, options: { output?: stri
return;
}
- const pageId = action.pageId;
- if (!pageId) {
- console.error(`Action '${actionId}' has no associated page.`);
- process.exitCode = 1;
- return;
- }
-
const callId = action.callId;
const storage = trace.loader.storage();
- const snapshotNames = ['input', 'before', 'after'];
let file: string | undefined;
- for (const name of snapshotNames) {
- const renderer = storage.snapshotByName(pageId, `${name}@${callId}`);
+ for (const phase of kActionPhases) {
+ const renderer = storage.snapshotForCall(callId, phase);
file = renderer?.closestScreenshot();
if (file)
break;
diff --git a/packages/playwright-core/src/tools/trace/traceSnapshot.ts b/packages/playwright-core/src/tools/trace/traceSnapshot.ts
index b4f003f56f..cf219379cb 100644
--- a/packages/playwright-core/src/tools/trace/traceSnapshot.ts
+++ b/packages/playwright-core/src/tools/trace/traceSnapshot.ts
@@ -26,11 +26,12 @@ import { playwright } from '../../inprocess';
import { parseCommand } from '../cli-daemon/command';
import { minimist } from '../cli-client/minimist';
import { commands } from '../cli-daemon/commands';
-import { loadTrace } from './traceUtils';
+import { kActionPhases, loadTrace } from './traceUtils';
import type { SnapshotStorage } from '@isomorphic/trace/snapshotStorage';
+import type { ActionPhase } from '@trace/trace';
-export async function traceSnapshot(actionId: string, options: { name?: string, serve?: boolean, browserArgs?: string[] }): Promise<void> {
+export async function traceSnapshot(actionId: string, options: { phase?: string, serve?: boolean, browserArgs?: string[] }): Promise<void> {
const trace = await loadTrace();
const action = trace.resolveActionId(actionId);
@@ -40,39 +41,28 @@ export async function traceSnapshot(actionId: string, options: { name?: string,
return;
}
- const pageId = action.pageId;
- if (!pageId) {
- console.error(`Action '${actionId}' has no associated page.`);
- process.exitCode = 1;
- return;
- }
-
const callId = action.callId;
const storage = trace.loader.storage();
- let snapshotName: string | undefined;
- let renderer;
- if (options.name) {
- snapshotName = options.name;
- renderer = storage.snapshotByName(pageId, `${snapshotName}@${callId}`);
- } else {
- for (const candidate of ['input', 'before', 'after']) {
- renderer = storage.snapshotByName(pageId, `${candidate}@${callId}`);
- if (renderer) {
- snapshotName = candidate;
- break;
- }
+ let phase: ActionPhase | undefined;
+ if (options.phase) {
+ phase = kActionPhases.find(p => p === options.phase);
+ if (!phase) {
+ console.error(`Unknown snapshot phase '${options.phase}', expected one of: ${kActionPhases.join(', ')}.`);
+ process.exitCode = 1;
+ return;
}
+ } else {
+ phase = kActionPhases.find(p => storage.snapshotForCall(callId, p));
}
- if (!renderer || !snapshotName) {
+ if (!phase || !storage.snapshotForCall(callId, phase)) {
console.error(`No snapshot found for action '${actionId}'.`);
process.exitCode = 1;
return;
}
- const snapshotKey = `${snapshotName}@${callId}`;
- const server = await serveTraceSnapshot(storage, trace.loader, pageId, snapshotKey);
+ const server = await serveTraceSnapshot(storage, trace.loader, callId, phase);
if (options.serve) {
console.log(`Serving snapshot at ${server.url}`);
@@ -83,16 +73,14 @@ export async function traceSnapshot(actionId: string, options: { name?: string,
await runCommandOnSnapshot(server, options.browserArgs || []);
}
-async function serveTraceSnapshot(storage: SnapshotStorage, loader: TraceLoader, pageId: string, snapshotKey: string): Promise<{ url: string, stop: () => Promise<void> }> {
+async function serveTraceSnapshot(storage: SnapshotStorage, loader: TraceLoader, callId: string, phase: ActionPhase): Promise<{ url: string, stop: () => Promise<void> }> {
const snapshotServer = new SnapshotServer(storage, file => loader.resourceEntry(file));
const httpServer = new HttpServer();
httpServer.routePrefix('/snapshot/', (request: any, response: any) => {
const url = new URL('http://localhost' + request.url!);
- const pageOrFrameId = url.pathname.substring('/snapshot/'.length);
- const searchParams = url.searchParams;
- searchParams.set('name', snapshotKey);
- const snapshotResponse = snapshotServer.serveSnapshot(pageOrFrameId, searchParams, url.href);
+ const snapshotCallId = decodeURIComponent(url.pathname.substring('/snapshot/'.length));
+ const snapshotResponse = snapshotServer.serveSnapshot(snapshotCallId, url.searchParams, url.href);
response.statusCode = snapshotResponse.status;
snapshotResponse.headers.forEach((value: string, key: string) => response.setHeader(key, value));
snapshotResponse.text().then((text: string) => response.end(text));
@@ -125,7 +113,7 @@ async function serveTraceSnapshot(storage: SnapshotStorage, loader: TraceLoader,
});
const startTime = Date.now();
- const snapshotUrl = `/snapshot/${pageId}?name=${encodeURIComponent(snapshotKey)}`;
+ const snapshotUrl = `/snapshot/${encodeURIComponent(callId)}?phase=${phase}`;
httpServer.routePrefix('/', (_request: any, response: any) => {
response.statusCode = 200;
response.setHeader('Content-Type', 'text/html; charset=utf-8');
diff --git a/packages/playwright-core/src/tools/trace/traceUtils.ts b/packages/playwright-core/src/tools/trace/traceUtils.ts
index 2734a22069..09ad49ec14 100644
--- a/packages/playwright-core/src/tools/trace/traceUtils.ts
+++ b/packages/playwright-core/src/tools/trace/traceUtils.ts
@@ -24,6 +24,7 @@ import { resolveWithinRoot } from '@utils/fileUtils';
import { DirTraceLoaderBackend, extractTrace } from './traceParser';
import type { ActionEntry } from '@isomorphic/trace/entries';
+import type { ActionPhase } from '@trace/trace';
const traceDir = path.join('.playwright-cli', 'trace');
const cliOutputDir = '.playwright-cli';
@@ -133,6 +134,8 @@ export async function saveOutputFile(fileName: string, content: string | Buffer,
}
+export const kActionPhases: ActionPhase[] = ['before', 'action', 'after'];
+
function buildOrdinalMap(model: TraceModel): { ordinalToCallId: Map<number, string>, callIdToOrdinal: Map<string, number> } {
const actions = model.actions.filter(a => a.group !== 'configuration');
const { rootItem } = buildActionTree(actions);
diff --git a/packages/trace-viewer/src/sw/main.ts b/packages/trace-viewer/src/sw/main.ts
index 79d1bc4911..362d37f0aa 100644
--- a/packages/trace-viewer/src/sw/main.ts
+++ b/packages/trace-viewer/src/sw/main.ts
@@ -164,8 +164,8 @@ async function doFetch(event: FetchEvent): Promise<Response> {
const { errorResponse, loadedTrace } = await loadTraceOrError(event.resultingClientId!, url, noopProgress);
if (errorResponse)
return errorResponse;
- const pageOrFrameId = relativePath.substring('/snapshot/'.length);
- const response = loadedTrace!.snapshotServer.serveSnapshot(pageOrFrameId, url.searchParams, url.href);
+ const callId = decodeURIComponent(relativePath.substring('/snapshot/'.length));
+ const response = loadedTrace!.snapshotServer.serveSnapshot(callId, url.searchParams, url.href);
if (isDeployedAsHttps)
response.headers.set('Content-Security-Policy', 'upgrade-insecure-requests');
return response;
@@ -212,13 +212,13 @@ async function doFetch(event: FetchEvent): Promise<Response> {
}
if (relativePath.startsWith('/snapshotInfo/')) {
- const pageOrFrameId = relativePath.substring('/snapshotInfo/'.length);
- return loadedTrace!.snapshotServer.serveSnapshotInfo(pageOrFrameId, url.searchParams);
+ const callId = decodeURIComponent(relativePath.substring('/snapshotInfo/'.length));
+ return loadedTrace!.snapshotServer.serveSnapshotInfo(callId, url.searchParams);
}
if (relativePath.startsWith('/closest-screenshot/')) {
- const pageOrFrameId = relativePath.substring('/closest-screenshot/'.length);
- return loadedTrace!.snapshotServer.serveClosestScreenshot(pageOrFrameId, url.searchParams);
+ const callId = decodeURIComponent(relativePath.substring('/closest-screenshot/'.length));
+ return loadedTrace!.snapshotServer.serveClosestScreenshot(callId, url.searchParams);
}
if (relativePath.startsWith('/file/')) {
diff --git a/packages/trace-viewer/src/ui/snapshotTab.tsx b/packages/trace-viewer/src/ui/snapshotTab.tsx
index 5a968cad2d..70492660c8 100644
--- a/packages/trace-viewer/src/ui/snapshotTab.tsx
+++ b/packages/trace-viewer/src/ui/snapshotTab.tsx
@@ -16,7 +16,7 @@
import './snapshotTab.css';
import * as React from 'react';
-import type { ActionTraceEvent } from '@trace/trace';
+import type { ActionPhase, ActionTraceEvent } from '@trace/trace';
import { nextActionByStartTime, previousActionByEndTime } from '@isomorphic/trace/traceModel';
import type { TraceModel } from '@isomorphic/trace/traceModel';
import { Toolbar } from '@web/components/toolbar';
@@ -61,8 +61,8 @@ export const SnapshotTabsView: React.FunctionComponent<{
const displayAriaMode = shouldDisplayAriaMode(model, displayAriaModeSetting);
const snapshots = React.useMemo(() => {
- return collectSnapshots(action);
- }, [action]);
+ return collectSnapshots(model, action);
+ }, [model, action]);
const ariaModeTargets = React.useMemo(() => {
return model && displayAriaMode ? collectAriaModeTargets(model, action) : {};
}, [model, action, displayAriaMode]);
@@ -356,30 +356,16 @@ function createRecorders(recorders: { recorder: Recorder, frameSelector: string
export type Snapshot = {
action: ActionTraceEvent;
- snapshotName: string;
- pageId: string;
+ phase: ActionPhase;
point?: { x: number, y: number };
};
-const createSnapshot = (action: ActionTraceEvent, snapshotNameKey: 'beforeSnapshot' | 'afterSnapshot' | 'inputSnapshot'): Snapshot | undefined => {
- if (!action)
+const createSnapshot = (model: TraceModel, action: ActionTraceEvent | undefined, phase: ActionPhase): Snapshot | undefined => {
+ if (!action || !model.hasDomSnapshotForCall(action.callId, phase))
return undefined;
-
- const snapshotName = action[snapshotNameKey];
-
- if (!snapshotName)
- return undefined;
-
- if (!action.pageId) {
- // eslint-disable-next-line no-console
- console.error('snapshot action must have a pageId');
- return undefined;
- }
-
return {
action,
- snapshotName,
- pageId: action.pageId,
+ phase,
point: action.point,
};
};
@@ -403,22 +389,24 @@ export type SnapshotUrls = {
popoutUrl: string;
};
-export function collectSnapshots(action: ActionTraceEvent | undefined): Snapshots {
- if (!action)
+export function collectSnapshots(model: TraceModel | undefined, action: ActionTraceEvent | undefined): Snapshots {
+ if (!model || !action)
return {};
- let beforeSnapshot = createSnapshot(action, 'beforeSnapshot');
+ const hasSnapshot = (callId: string, phase: ActionPhase) => model.hasDomSnapshotForCall(callId, phase);
+
+ let beforeSnapshot = createSnapshot(model, action, 'before');
if (!beforeSnapshot) {
- // If the action has no beforeSnapshot, use the last available afterSnapshot.
+ // If the action has no "before" snapshot, use the last available "after" one.
for (let a = previousActionByEndTime(action); a; a = previousActionByEndTime(a)) {
- if (a.endTime <= action.startTime && a.afterSnapshot) {
- beforeSnapshot = createSnapshot(a, 'afterSnapshot');
+ if (a.endTime <= action.startTime && hasSnapshot(a.callId, 'after')) {
+ beforeSnapshot = createSnapshot(model, a, 'after');
break;
}
}
}
- let afterSnapshot = createSnapshot(action, 'afterSnapshot');
+ let afterSnapshot = createSnapshot(model, action, 'after');
if (!afterSnapshot) {
let last: ActionTraceEvent | undefined;
// - For test.step, we want to use the snapshot of the last nested action.
@@ -426,22 +414,22 @@ export function collectSnapshots(action: ActionTraceEvent | undefined): Snapshot
// as a best effort.
// - If there are no "nested" actions, use the beforeSnapshot which works best
// for simple `expect(a).toBe(b);` case. Also if the action doesn't have
- // afterSnapshot, it likely doesn't have its own beforeSnapshot either,
+ // an "after" snapshot, it likely doesn't have its own "before" one either,
// and we calculated it above from a previous action.
for (let a = nextActionByStartTime(action); a && a.startTime <= action.endTime; a = nextActionByStartTime(a)) {
- if (a.endTime > action.endTime || !a.afterSnapshot)
+ if (a.endTime > action.endTime || !hasSnapshot(a.callId, 'after'))
continue;
if (last && last.endTime > a.endTime)
continue;
last = a;
}
if (last)
- afterSnapshot = createSnapshot(last, 'afterSnapshot');
+ afterSnapshot = createSnapshot(model, last, 'after');
else
afterSnapshot = beforeSnapshot;
}
- const actionSnapshot = createSnapshot(action, 'inputSnapshot') ?? afterSnapshot;
+ const actionSnapshot = createSnapshot(model, action, 'action') ?? afterSnapshot;
if (actionSnapshot)
actionSnapshot.point = action.point;
return { action: actionSnapshot, before: beforeSnapshot, after: afterSnapshot };
@@ -452,7 +440,6 @@ const isUnderTest = new URLSearchParams(window.location.search).has('isUnderTest
export function extendSnapshot(traceUri: string, snapshot: Snapshot, shouldPopulateCanvasFromScreenshot: boolean): SnapshotUrls {
const params = new URLSearchParams();
params.set('trace', traceUri);
- params.set('name', snapshot.snapshotName);
if (isUnderTest)
params.set('isUnderTest', 'true');
if (snapshot.point) {
@@ -462,8 +449,11 @@ export function extendSnapshot(traceUri: string, snapshot: Snapshot, shouldPopul
if (shouldPopulateCanvasFromScreenshot)
params.set('shouldPopulateCanvasFromScreenshot', '1');
- const snapshotUrl = new URL(`snapshot/${snapshot.pageId}?${params.toString()}`, window.location.href).toString();
- const snapshotInfoUrl = new URL(`snapshotInfo/${snapshot.pageId}?${params.toString()}`, window.location.href).toString();
+ params.set('phase', snapshot.phase);
+
+ const callId = encodeURIComponent(snapshot.action.callId);
+ const snapshotUrl = new URL(`snapshot/${callId}?${params.toString()}`, window.location.href).toString();
+ const snapshotInfoUrl = new URL(`snapshotInfo/${callId}?${params.toString()}`, window.location.href).toString();
const popoutParams = new URLSearchParams();
popoutParams.set('r', snapshotUrl);
diff --git a/packages/trace/src/snapshot.ts b/packages/trace/src/snapshot.ts
index 06334a2b78..8f3b01f7e7 100644
--- a/packages/trace/src/snapshot.ts
+++ b/packages/trace/src/snapshot.ts
@@ -15,6 +15,7 @@
*/
import type { Entry as HAREntry } from './har';
+import type { ActionPhase } from './trace';
export type ResourceSnapshot = HAREntry;
@@ -38,7 +39,8 @@ export type ResourceOverride = {
};
export type FrameSnapshot = {
- snapshotName?: string,
+ phase?: ActionPhase,
+ snapshotName?: string, // Legacy, only present in traces recorded before phase was introduced.
callId: string,
pageId: string,
frameId: string,
diff --git a/packages/trace/src/trace.ts b/packages/trace/src/trace.ts
index 4ef8f0c6e2..d029a4a6a7 100644
--- a/packages/trace/src/trace.ts
+++ b/packages/trace/src/trace.ts
@@ -140,9 +140,7 @@ export type BeforeActionTraceEvent = {
method: string;
params: Record<string, any>;
stepId?: string;
- beforeSnapshot?: string;
stack?: StackFrame[];
- pageId?: string;
parentId?: string;
group?: string;
};
@@ -150,7 +148,6 @@ export type BeforeActionTraceEvent = {
export type InputActionTraceEvent = {
type: 'input',
callId: string;
- inputSnapshot?: string;
point?: Point;
box?: Rect;
};
@@ -172,7 +169,6 @@ export type AfterActionTraceEvent = {
type: 'after',
callId: string;
endTime: number;
- afterSnapshot?: string;
error?: SerializedError['error'];
attachments?: AfterActionTraceEventAttachment[];
annotations?: TraceEventAnnotation[];
diff --git a/tests/config/utils.ts b/tests/config/utils.ts
index 4f96e4d811..751721cbfc 100644
--- a/tests/config/utils.ts
+++ b/tests/config/utils.ts
@@ -128,11 +128,9 @@ export async function parseTraceRaw(file: string): Promise<{ events: any[], reso
actionMap.set(event.callId, action);
} else if (event.type === 'input') {
const existing = actionMap.get(event.callId);
- existing.inputSnapshot = event.inputSnapshot;
existing.point = event.point;
} else if (event.type === 'after') {
const existing = actionMap.get(event.callId);
- existing.afterSnapshot = event.afterSnapshot;
existing.endTime = event.endTime;
existing.error = event.error;
existing.result = event.result;
diff --git a/tests/library/trace-viewer.spec.ts b/tests/library/trace-viewer.spec.ts
index e537588fc2..04c942b397 100644
--- a/tests/library/trace-viewer.spec.ts
+++ b/tests/library/trace-viewer.spec.ts
@@ -1010,8 +1010,7 @@ test('empty adopted style sheets should not prevent node refs', async ({ page })
const trace = await parseTrace(traceFile);
const secondEvaluate = trace.model.actions.findLast(a => a.method === 'evaluateExpression');
- expect(secondEvaluate.beforeSnapshot).toBeTruthy();
- const snapshot = trace.snapshots.snapshotByName(trace.snapshots.snapshotsForTest()[0], secondEvaluate.beforeSnapshot);
+ const snapshot = trace.snapshots.snapshotForCall(secondEvaluate.callId, 'before');
// Second snapshot should be just a copy of the first one.
expect(snapshot.snapshot().html).toEqual([[1, 9]]);
});
diff --git a/tests/library/tracing.spec.ts b/tests/library/tracing.spec.ts
index 898379927a..f12de90308 100644
--- a/tests/library/tracing.spec.ts
+++ b/tests/library/tracing.spec.ts
@@ -181,10 +181,11 @@ test('should not include buffers in the trace', async ({ context, page, server }
await page.goto(server.PREFIX + '/empty.html');
await page.screenshot();
await context.tracing.stop({ path: testInfo.outputPath('trace.zip') });
- const { actionObjects } = await parseTraceRaw(testInfo.outputPath('trace.zip'));
+ const { events, actionObjects } = await parseTraceRaw(testInfo.outputPath('trace.zip'));
const screenshotEvent = actionObjects.find(a => a.method === 'screenshot');
- expect(screenshotEvent.beforeSnapshot).toBeTruthy();
- expect(screenshotEvent.afterSnapshot).toBeTruthy();
+ const phases = events.filter(e => e.type === 'frame-snapshot' && e.snapshot.callId === screenshotEvent.callId).map(e => e.snapshot.phase);
+ expect(phases).toContain('before');
+ expect(phases).toContain('after');
expect(screenshotEvent.result).toEqual({
'binary': '<Buffer>',
});
@@ -201,7 +202,7 @@ test('should exclude internal pages', async ({ browserName, context, page, serve
const trace = await parseTraceRaw(testInfo.outputPath('trace.zip'));
const pageIds = new Set();
trace.events.forEach(e => {
- const pageId = e.pageId;
+ const pageId = e.pageId ?? e.params?.pageId;
if (pageId)
pageIds.add(pageId);
});
diff --git a/tests/mcp/trace-cli.spec.ts b/tests/mcp/trace-cli.spec.ts
index 32385694ca..f1192a7d31 100644
--- a/tests/mcp/trace-cli.spec.ts
+++ b/tests/mcp/trace-cli.spec.ts
@@ -186,12 +186,12 @@ test('trace snapshot runs command on snapshot', async ({ runTraceCli }) => {
expect(stdout).toBeTruthy();
});
-test('trace snapshot --name before', async ({ runTraceCli }) => {
+test('trace snapshot --phase before', async ({ runTraceCli }) => {
const { stdout: listOutput } = await runTraceCli(['actions', '--grep', 'Click']);
const match = listOutput.match(/^\s+(\d+)\.\s/m);
expect(match).toBeTruthy();
- const { stdout, exitCode } = await runTraceCli(['snapshot', '--name', 'before', match![1]]);
+ const { stdout, exitCode } = await runTraceCli(['snapshot', '--phase', 'before', match![1]]);
expect(exitCode).toBe(0);
expect(stdout).toBeTruthy();
});
@@ -202,7 +202,7 @@ test('trace snapshot resolves inner frames', async ({ runTraceCli }) => {
expect(ordinals.length).toBeGreaterThanOrEqual(2);
const anchorClickOrdinal = ordinals[ordinals.length - 1];
- const { stdout } = await runTraceCli(['snapshot', '--name', 'after', anchorClickOrdinal]);
+ const { stdout } = await runTraceCli(['snapshot', '--phase', 'after', anchorClickOrdinal]);
expect(stdout).toContain('Innermost');
});
@@ -213,7 +213,7 @@ test('trace snapshot replays sub-resource stylesheets from the archive', async (
const ordinal = match![1];
const { stdout, exitCode } = await runTraceCli([
- 'snapshot', '--name', 'before', ordinal,
+ 'snapshot', '--phase', 'before', ordinal,
'--', 'eval', 'el => getComputedStyle(el).color', '#styled',
]);
expect(exitCode).toBe(0);
diff --git a/tests/playwright-test/playwright.trace.spec.ts b/tests/playwright-test/playwright.trace.spec.ts
index 31319a6667..3e2c804068 100644
--- a/tests/playwright-test/playwright.trace.spec.ts
+++ b/tests/playwright-test/playwright.trace.spec.ts
@@ -284,7 +284,7 @@ test('should expand snapshots object in trace option', async ({ runInlineTest },
const { model } = await parseTrace(testInfo.outputPath('test-results', 'a-pass', 'trace.zip'));
const click = model.actions.find(a => a.method === 'click')!;
- expect(click.afterSnapshot).toBeTruthy();
+ expect(model.hasDomSnapshotForCall(click.callId, 'after')).toBeTruthy();
expect(model.screenshotForCall(click.callId, 'after')).toBeTruthy();
expect(model.ariaSnapshotForCall(click.callId, 'after')).toBeTruthy();
});
@@ -312,7 +312,7 @@ test('should keep trace config options when forcing mode with --trace', async ({
// The 'on' mode is forced, while the snapshots configuration is preserved.
const { model } = await parseTrace(testInfo.outputPath('test-results', 'a-pass', 'trace.zip'));
const click = model.actions.find(a => a.method === 'click')!;
- expect(click.afterSnapshot).toBeTruthy();
+ expect(model.hasDomSnapshotForCall(click.callId, 'after')).toBeTruthy();
expect(model.screenshotForCall(click.callId, 'after')).toBeTruthy();
expect(model.ariaSnapshotForCall(click.callId, 'after')).toBeTruthy();
});
@@ -1470,19 +1470,13 @@ test('should record trace snapshot for more obscure commands', async ({ runInlin
'After Hooks',
]);
- const snapshotFrameOrPageId = trace.snapshots.snapshotsForTest()[0];
-
const countAction = trace.model.actions.find(a => a.method === 'queryCount');
- expect(countAction.beforeSnapshot).toBeTruthy();
- expect(countAction.afterSnapshot).toBeTruthy();
- expect(trace.snapshots.snapshotByName(snapshotFrameOrPageId, countAction.beforeSnapshot)).toBeTruthy();
- expect(trace.snapshots.snapshotByName(snapshotFrameOrPageId, countAction.afterSnapshot)).toBeTruthy();
+ expect(trace.snapshots.snapshotForCall(countAction.callId, 'before')).toBeTruthy();
+ expect(trace.snapshots.snapshotForCall(countAction.callId, 'after')).toBeTruthy();
const boundingBoxAction = trace.model.actions.find(a => a.title === 'Bounding box');
- expect(boundingBoxAction.beforeSnapshot).toBeTruthy();
- expect(boundingBoxAction.afterSnapshot).toBeTruthy();
- expect(trace.snapshots.snapshotByName(snapshotFrameOrPageId, boundingBoxAction.beforeSnapshot)).toBeTruthy();
- expect(trace.snapshots.snapshotByName(snapshotFrameOrPageId, boundingBoxAction.afterSnapshot)).toBeTruthy();
+ expect(trace.snapshots.snapshotForCall(boundingBoxAction.callId, 'before')).toBeTruthy();
+ expect(trace.snapshots.snapshotForCall(boundingBoxAction.callId, 'after')).toBeTruthy();
});
test('should record default test timeout in trace', async ({ runInlineTest }, testInfo) => {