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(aria): no snapshot diff without tracks or with iframes (#37966)
Dmitry Gozman26b38629f5b7
diff --git a/packages/injected/src/ariaSnapshot.ts b/packages/injected/src/ariaSnapshot.tsindex 57e4c689f5..e86fc419dc 100644--- a/packages/injected/src/ariaSnapshot.ts+++ b/packages/injected/src/ariaSnapshot.ts@@ -505,6 +505,12 @@ function buildByRefMap(root: AriaNode | undefined, map: Map<string, AriaNode> =return map;}+function hasIframeNodes(root: AriaNode): boolean {+ if (root.role === 'iframe')+ return true;+ return (root.children || []).some(child => typeof child !== 'string' && hasIframeNodes(child));+}+function arePropsEqual(a: AriaNode, b: AriaNode): boolean {const aKeys = Object.keys(a.props);const bKeys = Object.keys(b.props);@@ -512,6 +518,9 @@ function arePropsEqual(a: AriaNode, b: AriaNode): boolean {}export function renderAriaTree(ariaSnapshot: AriaSnapshot, publicOptions: AriaTreeOptions, previous?: AriaSnapshot): string {+ if (hasIframeNodes(ariaSnapshot.root))+ previous = undefined;+const options = toInternalOptions(publicOptions);const lines: string[] = [];const includeText = options.renderStringsAsRegex ? textContributesInfo : () => true;diff --git a/packages/injected/src/injectedScript.ts b/packages/injected/src/injectedScript.tsindex a204af76c4..18a97bf83b 100644--- a/packages/injected/src/injectedScript.ts+++ b/packages/injected/src/injectedScript.ts@@ -306,7 +306,7 @@ export class InjectedScript {const ariaSnapshot = generateAriaTree(node as Element, options);let previous: AriaSnapshot | undefined;if (options.incremental)- previous = options.track ? this._lastAriaSnapshotForTrack.get(options.track) : this._lastAriaSnapshotForQuery;+ previous = options.track ? this._lastAriaSnapshotForTrack.get(options.track) : undefined;const result = renderAriaTree(ariaSnapshot, options, previous);if (options.track)this._lastAriaSnapshotForTrack.set(options.track, ariaSnapshot);diff --git a/tests/page/page-aria-snapshot-ai.spec.ts b/tests/page/page-aria-snapshot-ai.spec.tsindex e79c3d388c..6b2b1bda8e 100644--- a/tests/page/page-aria-snapshot-ai.spec.ts+++ b/tests/page/page-aria-snapshot-ai.spec.ts@@ -548,26 +548,26 @@ it('should create incremental snapshots on multiple tracks', async ({ page }) =>it('should create incremental snapshot for attribute change', async ({ page }) => {await page.setContent(`<button>a button</button>`);await page.evaluate(() => document.querySelector('button').focus());- expect(await snapshotForAI(page, { mode: 'incremental' })).toContainYaml(`+ expect(await snapshotForAI(page, { track: 'track', mode: 'incremental' })).toContainYaml(`- button "a button" [active] [ref=e2]`);await page.evaluate(() => document.querySelector('button').blur());- expect(await snapshotForAI(page, { mode: 'incremental' })).toContainYaml(`+ expect(await snapshotForAI(page, { track: 'track', mode: 'incremental' })).toContainYaml(`- button "a button" [ref=e2]`);});it('should create incremental snapshot for child removal', async ({ page }) => {await page.setContent(`<li><button>a button</button><span>some text</span></li>`);- expect(await snapshotForAI(page, { mode: 'incremental' })).toContainYaml(`+ expect(await snapshotForAI(page, { track: 'track', mode: 'incremental' })).toContainYaml(`- listitem [ref=e2]:- button "a button" [ref=e3]- text: some text`);await page.evaluate(() => document.querySelector('span').remove());- expect(await snapshotForAI(page, { mode: 'incremental' })).toContainYaml(`+ expect(await snapshotForAI(page, { track: 'track', mode: 'incremental' })).toContainYaml(`- listitem [ref=e2]:- ref=e3 [unchanged]`);@@ -575,13 +575,13 @@ it('should create incremental snapshot for child removal', async ({ page }) => {it('should create incremental snapshot for child addition', async ({ page }) => {await page.setContent(`<li><button>a button</button><span style="display:none">some text</span></li>`);- expect(await snapshotForAI(page, { mode: 'incremental' })).toContainYaml(`+ expect(await snapshotForAI(page, { track: 'track', mode: 'incremental' })).toContainYaml(`- listitem [ref=e2]:- button "a button" [ref=e3]`);await page.evaluate(() => document.querySelector('span').style.display = 'inline');- expect(await snapshotForAI(page, { mode: 'incremental' })).toContainYaml(`+ expect(await snapshotForAI(page, { track: 'track', mode: 'incremental' })).toContainYaml(`- listitem [ref=e2]:- ref=e3 [unchanged]- text: some text@@ -590,13 +590,13 @@ it('should create incremental snapshot for child addition', async ({ page }) =>it('should create incremental snapshot for prop change', async ({ page }) => {await page.setContent(`<a href="about:blank" style="cursor:pointer">a link</a>`);- expect(await snapshotForAI(page, { mode: 'incremental' })).toContainYaml(`+ expect(await snapshotForAI(page, { track: 'track', mode: 'incremental' })).toContainYaml(`- link "a link" [ref=e2] [cursor=pointer]:- /url: about:blank`);await page.evaluate(() => document.querySelector('a').setAttribute('href', 'https://playwright.dev'));- expect(await snapshotForAI(page, { mode: 'incremental' })).toContainYaml(`+ expect(await snapshotForAI(page, { track: 'track', mode: 'incremental' })).toContainYaml(`- link "a link" [ref=e2] [cursor=pointer]:- /url: https://playwright.dev`);@@ -604,13 +604,13 @@ it('should create incremental snapshot for prop change', async ({ page }) => {it('should create incremental snapshot for cursor change', async ({ page }) => {await page.setContent(`<a href="about:blank" style="cursor:pointer">a link</a>`);- expect(await snapshotForAI(page, { mode: 'incremental' })).toContainYaml(`+ expect(await snapshotForAI(page, { track: 'track', mode: 'incremental' })).toContainYaml(`- link "a link" [ref=e2] [cursor=pointer]:- /url: about:blank`);await page.evaluate(() => document.querySelector('a').style.cursor = 'default');- expect(await snapshotForAI(page, { mode: 'incremental' })).toContainYaml(`+ expect(await snapshotForAI(page, { track: 'track', mode: 'incremental' })).toContainYaml(`- link "a link" [ref=e2]:- /url: about:blank`);@@ -618,24 +618,55 @@ it('should create incremental snapshot for cursor change', async ({ page }) => {it('should create incremental snapshot for name change', async ({ page }) => {await page.setContent(`<button><span>a button</span></button>`);- expect(await snapshotForAI(page, { mode: 'incremental' })).toContainYaml(`+ expect(await snapshotForAI(page, { track: 'track', mode: 'incremental' })).toContainYaml(`- button "a button" [ref=e2]`);await page.evaluate(() => document.querySelector('span').textContent = 'new button');- expect(await snapshotForAI(page, { mode: 'incremental' })).toContainYaml(`+ expect(await snapshotForAI(page, { track: 'track', mode: 'incremental' })).toContainYaml(`- button "new button" [ref=e3]`);});it('should create incremental snapshot for text change', async ({ page }) => {await page.setContent(`<li><span>an item</span></li>`);- expect(await snapshotForAI(page, { mode: 'incremental' })).toContainYaml(`+ expect(await snapshotForAI(page, { track: 'track', mode: 'incremental' })).toContainYaml(`- listitem [ref=e2]: an item`);await page.evaluate(() => document.querySelector('span').textContent = 'new text');- expect(await snapshotForAI(page, { mode: 'incremental' })).toContainYaml(`+ expect(await snapshotForAI(page, { track: 'track', mode: 'incremental' })).toContainYaml(`- listitem [ref=e2]: new text`);});++it('should not produce incremental snapshot for iframes', async ({ page }) => {+ await page.setContent(`+ <iframe srcdoc="<h1>hello</h1>"></iframe>+ `);+ expect(await snapshotForAI(page, { track: 'track', mode: 'incremental' })).toContainYaml(`+ - iframe [ref=e2]:+ - heading "hello" [level=1] [ref=f1e2]+ `);+ expect(await snapshotForAI(page, { track: 'track', mode: 'incremental' })).toContainYaml(`+ - iframe [ref=e2]:+ - ref=f1e2 [unchanged]+ `);+});++it('should not create incremental snapshots without tracks', async ({ page }) => {+ await page.setContent(`<ul><li><button>a button</button></li><li><span>a span</span></li><li id=hidden-li style="display:none">some text</li></ul>`);++ expect(await snapshotForAI(page, { mode: 'incremental' })).toContainYaml(`+ - list [ref=e2]:+ - listitem [ref=e3]:+ - button "a button" [ref=e4]+ - listitem [ref=e5]: a span+ `);+ expect(await snapshotForAI(page, { mode: 'incremental' })).toContainYaml(`+ - list [ref=e2]:+ - listitem [ref=e3]:+ - button "a button" [ref=e4]+ - listitem [ref=e5]: a span+ `);+});