Skip to content

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

fix(aria): frame refs should be persistent (#37962)

Dmitry Gozman0e2df69a5907
diff --git a/packages/playwright-core/src/server/frameSelectors.ts b/packages/playwright-core/src/server/frameSelectors.ts
index f4e20ae16b..9118041532 100644
--- a/packages/playwright-core/src/server/frameSelectors.ts
+++ b/packages/playwright-core/src/server/frameSelectors.ts
@@ -119,10 +119,8 @@ export class FrameSelectors {
const match = body.match(/^f(\d+)e\d+$/);
if (!match)
return frame;
- const frameIndex = +match[1];
- const page = this.frame._page;
- const frameId = page.lastSnapshotFrameIds[frameIndex - 1];
- const jumptToFrame = frameId ? page.frameManager.frame(frameId) : null;
+ const frameSeq = +match[1];
+ const jumptToFrame = this.frame._page.frameManager.frames().find(frame => frame.seq === frameSeq);
if (!jumptToFrame)
throw new InvalidSelectorError(`Invalid frame in aria-ref selector "${selector}"`);
return jumptToFrame;
diff --git a/packages/playwright-core/src/server/frames.ts b/packages/playwright-core/src/server/frames.ts
index 16a3b17e54..b89faf28fb 100644
--- a/packages/playwright-core/src/server/frames.ts
+++ b/packages/playwright-core/src/server/frames.ts
@@ -101,12 +101,17 @@ export class FrameManager {
readonly _consoleMessageTags = new Map<string, ConsoleTagHandler>();
readonly _signalBarriers = new Set<SignalBarrier>();
private _webSockets = new Map<string, network.WebSocket>();
+ private _nextFrameSeq = 0;
constructor(page: Page) {
this._page = page;
this._mainFrame = undefined as any as Frame;
}
+ nextFrameSeq() {
+ return this._nextFrameSeq++;
+ }
+
createDummyMainFrameIfNeeded() {
if (!this._mainFrame)
this.frameAttached(kDummyFrameId, null);
@@ -444,6 +449,7 @@ export class Frame extends SdkObject {
};
_id: string;
+ readonly seq: number;
_firedLifecycleEvents = new Set<types.LifecycleEvent>();
private _firedNetworkIdleSelf = false;
_currentDocument: DocumentInfo;
@@ -465,6 +471,7 @@ export class Frame extends SdkObject {
constructor(page: Page, id: string, parentFrame: Frame | null) {
super(page, 'frame');
this.attribution.frame = this;
+ this.seq = page.frameManager.nextFrameSeq();
this._id = id;
this._page = page;
this._parentFrame = parentFrame;
diff --git a/packages/playwright-core/src/server/page.ts b/packages/playwright-core/src/server/page.ts
index 1ad565ab0b..80270f2ea0 100644
--- a/packages/playwright-core/src/server/page.ts
+++ b/packages/playwright-core/src/server/page.ts
@@ -172,7 +172,6 @@ export class Page extends SdkObject {
// When throttling for tracing, 200ms between frames, except for 10 frames around the action.
private _frameThrottler = new FrameThrottler(10, 35, 200);
closeReason: string | undefined;
- lastSnapshotFrameIds: string[] = [];
constructor(delegate: PageDelegate, browserContext: BrowserContext) {
super(browserContext, 'page');
@@ -860,8 +859,7 @@ export class Page extends SdkObject {
}
async snapshotForAI(progress: Progress, options: { track?: string, mode?: 'full' | 'incremental' }): Promise<string> {
- this.lastSnapshotFrameIds = [];
- const snapshot = await snapshotFrameForAI(progress, this.mainFrame(), 0, this.lastSnapshotFrameIds, options);
+ const snapshot = await snapshotFrameForAI(progress, this.mainFrame(), options);
return snapshot.join('\n');
}
}
@@ -1037,7 +1035,7 @@ class FrameThrottler {
}
}
-async function snapshotFrameForAI(progress: Progress, frame: frames.Frame, frameOrdinal: number, frameIds: string[], options: { track?: string, mode?: 'full' | 'incremental' }): Promise<string[]> {
+async function snapshotFrameForAI(progress: Progress, frame: frames.Frame, options: { track?: string, mode?: 'full' | 'incremental' }): Promise<string[]> {
// Only await the topmost navigations, inner frames will be empty when racing.
const snapshot = await frame.retryWithProgressAndTimeouts(progress, [1000, 2000, 4000, 8000], async continuePolling => {
try {
@@ -1048,7 +1046,7 @@ async function snapshotFrameForAI(progress: Progress, frame: frames.Frame, frame
if (!node)
return true;
return injected.ariaSnapshot(node, { mode: 'ai', ...options });
- }, { refPrefix: frameOrdinal ? 'f' + frameOrdinal : '', incremental: options.mode === 'incremental', track: options.track }));
+ }, { refPrefix: frame.seq ? 'f' + frame.seq : '', incremental: options.mode === 'incremental', track: options.track }));
if (snapshotOrRetry === true)
return continuePolling;
return snapshotOrRetry;
@@ -1077,10 +1075,8 @@ async function snapshotFrameForAI(progress: Progress, frame: frames.Frame, frame
result.push(line);
continue;
}
- const frameOrdinal = frameIds.length + 1;
- frameIds.push(child.frame._id);
try {
- const childSnapshot = await snapshotFrameForAI(progress, child.frame, frameOrdinal, frameIds, options);
+ const childSnapshot = await snapshotFrameForAI(progress, child.frame, options);
result.push(line + ':', ...childSnapshot.map(l => leadingSpace + ' ' + l));
} catch {
result.push(line);
diff --git a/tests/mcp/iframes.spec.ts b/tests/mcp/iframes.spec.ts
index 3c53de170b..aef7e07879 100644
--- a/tests/mcp/iframes.spec.ts
+++ b/tests/mcp/iframes.spec.ts
@@ -30,7 +30,7 @@ test('stitched aria frames', async ({ client }) => {
- button "World" [ref=f1e2]
- main [ref=f1e3]:
- iframe [ref=f1e4]:
- - paragraph [ref=f2e2]: Nested
+ - paragraph [ref=f3e2]: Nested
\`\`\``),
});
diff --git a/tests/page/page-aria-snapshot-ai.spec.ts b/tests/page/page-aria-snapshot-ai.spec.ts
index 0e9b8e907c..e79c3d388c 100644
--- a/tests/page/page-aria-snapshot-ai.spec.ts
+++ b/tests/page/page-aria-snapshot-ai.spec.ts
@@ -75,11 +75,11 @@ it('should stitch all frame snapshots', async ({ page, server }) => {
- iframe [ref=e2]:
- generic [active] [ref=f1e1]:
- iframe [ref=f1e2]:
- - generic [ref=f2e2]: Hi, I'm frame
- - iframe [ref=f1e3]:
- generic [ref=f3e2]: Hi, I'm frame
+ - iframe [ref=f1e3]:
+ - generic [ref=f4e2]: Hi, I'm frame
- iframe [ref=e3]:
- - generic [ref=f4e2]: Hi, I'm frame
+ - generic [ref=f2e2]: Hi, I'm frame
`);
const href = await page.locator('aria-ref=e1').evaluate(e => e.ownerDocument.defaultView.location.href);
@@ -88,7 +88,7 @@ it('should stitch all frame snapshots', async ({ page, server }) => {
const href2 = await page.locator('aria-ref=f1e2').evaluate(e => e.ownerDocument.defaultView.location.href);
expect(href2).toBe(server.PREFIX + '/frames/two-frames.html');
- const href3 = await page.locator('aria-ref=f3e2').evaluate(e => e.ownerDocument.defaultView.location.href);
+ const href3 = await page.locator('aria-ref=f4e2').evaluate(e => e.ownerDocument.defaultView.location.href);
expect(href3).toBe(server.PREFIX + '/frames/frame.html');
{
@@ -97,13 +97,13 @@ it('should stitch all frame snapshots', async ({ page, server }) => {
expect(sourceCode).toBe(`locator('body')`);
}
{
- const { resolvedSelector } = await (page.locator('aria-ref=f3e2') as any)._resolveSelector();
+ const { resolvedSelector } = await (page.locator('aria-ref=f4e2') as any)._resolveSelector();
const sourceCode = asLocator('javascript', resolvedSelector);
expect(sourceCode).toBe(`locator('iframe[name="2frames"]').contentFrame().locator('iframe[name="dos"]').contentFrame().getByText('Hi, I\\'m frame')`);
}
{
// Should tolerate .describe().
- const { resolvedSelector } = await (page.locator('aria-ref=f2e2').describe('foo bar') as any)._resolveSelector();
+ const { resolvedSelector } = await (page.locator('aria-ref=f3e2').describe('foo bar') as any)._resolveSelector();
const sourceCode = asLocator('javascript', resolvedSelector);
expect(sourceCode).toBe(`locator('iframe[name=\"2frames\"]').contentFrame().locator('iframe[name=\"uno\"]').contentFrame().getByText('Hi, I\\'m frame')`);
}
@@ -113,6 +113,51 @@ it('should stitch all frame snapshots', async ({ page, server }) => {
}
});
+it('should persist iframe references', async ({ page }) => {
+ await page.setContent(`
+ <ul>
+ <li><iframe srcdoc="<button>button1</button>"></iframe></li>
+ <li><iframe srcdoc="<button>button2</button>"></iframe></li>
+ </ul>
+ `);
+ expect(await snapshotForAI(page)).toContainYaml(`
+ - list [ref=e2]:
+ - listitem [ref=e3]:
+ - iframe [ref=e4]:
+ - button "button1" [ref=f1e2]
+ - listitem [ref=e5]:
+ - iframe [ref=e6]:
+ - button "button2" [ref=f2e2]
+ `);
+
+ await page.evaluate(() => document.querySelector('iframe').remove());
+ expect(await snapshotForAI(page)).toContainYaml(`
+ - list [ref=e2]:
+ - listitem [ref=e3]
+ - listitem [ref=e5]:
+ - iframe [ref=e6]:
+ - button "button2" [ref=f2e2]
+ `);
+ await expect(page.locator('aria-ref=f2e2')).toHaveText('button2');
+
+ await page.evaluate(() => {
+ const frame = document.createElement('iframe');
+ frame.setAttribute('srcdoc', '<button>button1</button>');
+ document.querySelector('li').appendChild(frame);
+ });
+ expect(await snapshotForAI(page)).toContainYaml(`
+ - list [ref=e2]:
+ - listitem [ref=e3]:
+ - iframe [ref=e7]:
+ - button "button1" [ref=f3e2]
+ - listitem [ref=e5]:
+ - iframe [ref=e6]:
+ - button "button2" [ref=f2e2]
+ `);
+ await expect(page.locator('aria-ref=f3e2')).toHaveText('button1');
+ await expect(page.locator('aria-ref=f2e2')).toHaveText('button2');
+});
+
it('should not generate refs for elements with pointer-events:none', async ({ page }) => {
await page.setContent(`
<button style="pointer-events: none">no-ref</button>