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 viewer): preserve dialog.showModal() elements (#35231)

Dmitry Gozman195fe11e1bd3
diff --git a/packages/playwright-core/src/server/trace/recorder/snapshotterInjected.ts b/packages/playwright-core/src/server/trace/recorder/snapshotterInjected.ts
index 4730c3e5dd..953868585b 100644
--- a/packages/playwright-core/src/server/trace/recorder/snapshotterInjected.ts
+++ b/packages/playwright-core/src/server/trace/recorder/snapshotterInjected.ts
@@ -49,6 +49,7 @@ export function frameSnapshotStreamer(snapshotStreamer: string, removeNoScript:
const kCurrentSrcAttribute = '__playwright_current_src__';
const kBoundingRectAttribute = '__playwright_bounding_rect__';
const kPopoverOpenAttribute = '__playwright_popover_open_';
+ const kDialogOpenAttribute = '__playwright_dialog_open_';
// Symbols for our own info on Nodes/StyleSheets.
const kSnapshotFrameId = Symbol('__playwright_snapshot_frameid_');
@@ -456,6 +457,12 @@ export function frameSnapshotStreamer(snapshotStreamer: string, removeNoScript:
expectValue(value);
attrs[kPopoverOpenAttribute] = value;
}
+ if (nodeName === 'DIALOG' && (element as HTMLDialogElement).open) {
+ const value = (element as HTMLDialogElement).matches(':modal') ? 'modal' : 'true';
+ expectValue(kDialogOpenAttribute);
+ expectValue(value);
+ attrs[kDialogOpenAttribute] = value;
+ }
if (element.scrollTop) {
expectValue(kScrollTopAttribute);
expectValue(element.scrollTop);
@@ -542,6 +549,8 @@ export function frameSnapshotStreamer(snapshotStreamer: string, removeNoScript:
continue;
if (nodeName === 'FRAME' && name === 'src')
continue;
+ if (nodeName === 'DIALOG' && name === 'open')
+ continue;
let value = element.attributes[i].value;
if (nodeName === 'META')
value = this.__sanitizeMetaAttribute(name, value, (node as HTMLMetaElement).httpEquiv);
diff --git a/packages/trace-viewer/src/sw/snapshotRenderer.ts b/packages/trace-viewer/src/sw/snapshotRenderer.ts
index d9a903813a..c2b014ac3f 100644
--- a/packages/trace-viewer/src/sw/snapshotRenderer.ts
+++ b/packages/trace-viewer/src/sw/snapshotRenderer.ts
@@ -313,6 +313,16 @@ function snapshotScript(viewport: ViewportSize, ...targetIds: (string | undefine
}
element.removeAttribute('__playwright_popover_open_');
}
+ for (const element of root.querySelectorAll(`[__playwright_dialog_open_]`)) {
+ try {
+ if (element.getAttribute('__playwright_dialog_open_') === 'modal')
+ (element as HTMLDialogElement).showModal();
+ else
+ (element as HTMLDialogElement).show();
+ } catch {
+ }
+ element.removeAttribute('__playwright_dialog_open_');
+ }
for (const targetId of targetIds) {
for (const target of root.querySelectorAll(`[__playwright_target__="${targetId}"]`)) {
diff --git a/tests/library/trace-viewer.spec.ts b/tests/library/trace-viewer.spec.ts
index 97f8ece714..04a4ae5771 100644
--- a/tests/library/trace-viewer.spec.ts
+++ b/tests/library/trace-viewer.spec.ts
@@ -1694,6 +1694,30 @@ test('should show a popover', async ({ runAndTrace, page, server, platform, brow
await expect.poll(() => popover.evaluate(e => e.matches(':popover-open'))).toBe(true);
});
+test('should show a modal dialog', async ({ runAndTrace, page, platform, browserName, macVersion }) => {
+ test.skip(platform === 'darwin' && macVersion === 13 && browserName === 'webkit', 'WebKit on macOS 13.7 reliably fails on this test for some reason');
+ const traceViewer = await runAndTrace(async () => {
+ await page.setContent(`
+ <button>Show the dialog</button>
+ <dialog>
+ <p>This is a modal dialog</p>
+ </dialog>
+ <script>
+ document.querySelector('button').addEventListener('click', () => {
+ document.querySelector('dialog').showModal();
+ });
+ </script>
+ `);
+ await page.getByRole('button').click();
+ await expect(page.locator('p')).toBeVisible();
+ });
+
+ const snapshot = await traceViewer.snapshotFrame('expect.toBeVisible');
+ const dialog = snapshot.locator('dialog');
+ await expect.poll(() => dialog.evaluate(e => e.matches(':open'))).toBe(true);
+ await expect.poll(() => dialog.evaluate(e => e.matches(':modal'))).toBe(true);
+});
+
test('should open settings dialog', async ({ showTraceViewer }) => {
const traceViewer = await showTraceViewer([traceFile]);
await traceViewer.selectAction('http://localhost');