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
fix(snapshotter): mismatching snapshot index (#37258)
Dmitry Gozmanf9e53c33263b
diff --git a/packages/playwright-core/src/server/trace/recorder/snapshotter.ts b/packages/playwright-core/src/server/trace/recorder/snapshotter.tsindex 5d0139df07..9b55439052 100644--- a/packages/playwright-core/src/server/trace/recorder/snapshotter.ts+++ b/packages/playwright-core/src/server/trace/recorder/snapshotter.ts@@ -100,13 +100,26 @@ export class Snapshotter {eventsHelper.removeEventListeners(this._eventListeners);}- async captureSnapshot(page: Page, callId: string, snapshotName: string): Promise<void> {+ private async _captureFrameSnapshot(frame: Frame): Promise<SnapshotData | void> {// Prepare expression synchronously.- const expression = `window["${this._snapshotStreamer}"].captureSnapshot(${JSON.stringify(snapshotName)})`;+ const needsReset = !!(frame as any)[kNeedsResetSymbol];+ (frame as any)[kNeedsResetSymbol] = false;+ const expression = `window["${this._snapshotStreamer}"].captureSnapshot(${needsReset ? 'true' : 'false'})`;+ try {+ return await frame.nonStallingRawEvaluateInExistingMainContext(expression);+ } catch (e) {+ // If we fail to capture snapshot in this frame, we cannot rely on the snapshot index+ // being the same here and in snapshotter injected script.+ // Therefore, next time force a reset to avoid using node references.+ (frame as any)[kNeedsResetSymbol] = true;+ debugLogger.log('error', e);+ }+ }+ async captureSnapshot(page: Page, callId: string, snapshotName: string): Promise<void> {// In each frame, in a non-stalling manner, capture the snapshots.const snapshots = page.frames().map(async frame => {- const data = await frame.nonStallingRawEvaluateInExistingMainContext(expression).catch(e => debugLogger.log('error', e)) as SnapshotData;+ const data = await this._captureFrameSnapshot(frame);// Something went wrong -> bail out, our snapshots are best-efforty.if (!data || !this._started)return;@@ -163,3 +176,5 @@ export class Snapshotter {}}}++const kNeedsResetSymbol = Symbol('kNeedsReset');diff --git a/packages/playwright-core/src/server/trace/recorder/snapshotterInjected.ts b/packages/playwright-core/src/server/trace/recorder/snapshotterInjected.tsindex 953868585b..86fa015eb3 100644--- a/packages/playwright-core/src/server/trace/recorder/snapshotterInjected.ts+++ b/packages/playwright-core/src/server/trace/recorder/snapshotterInjected.ts@@ -318,9 +318,11 @@ export function frameSnapshotStreamer(snapshotStreamer: string, removeNoScript:}}- captureSnapshot(): SnapshotData | undefined {+ captureSnapshot(needsReset: boolean): SnapshotData | undefined {const timestamp = performance.now();const snapshotNumber = ++this._lastSnapshotNumber;+ if (needsReset)+ this.reset();let nodeCounter = 0;let shadowDomNesting = 0;let headNesting = 0;diff --git a/tests/library/trace-viewer.spec.ts b/tests/library/trace-viewer.spec.tsindex 5352621baf..47fc325b28 100644--- a/tests/library/trace-viewer.spec.ts+++ b/tests/library/trace-viewer.spec.ts@@ -1979,3 +1979,37 @@ test('should show all actions', async ({ runAndTrace, page }) => {/Expect "toBeChecked"/,]);});++test('should handle failed snapshots due to dialog', async ({ page, server, runAndTrace }) => {+ const traceViewer = await runAndTrace(async () => {+ await page.setContent(`+ <head>+ <style>+ button { color: red; }+ </style>+ </head>+ <body>+ <button>Click me</button>+ <script>+ const button = document.querySelector('button');+ window.history.pushState({ page: 'stay' }, '', window.location.href);+ window.addEventListener('popstate', () => {+ if (window.confirm('ready?'))+ button.textContent = 'Clicked';+ });+ </script>+ </body>+ `);+ let dialogMessage = '';+ page.on('dialog', async dialog => {+ dialogMessage = dialog.message();+ await dialog.accept();+ });+ await page.goBack();+ await expect.poll(() => dialogMessage).toBe('ready?');+ await expect(page.getByRole('button')).toHaveText('Clicked');+ });++ const frame = await traceViewer.snapshotFrame('Expect');+ await expect(frame.getByRole('button')).toHaveCSS('color', 'rgb(255, 0, 0)');+});