Skip to content

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

chore: allow describing the aria refs (#36071)

Pavel Feldman0ab13695e745
diff --git a/packages/playwright-core/src/server/dom.ts b/packages/playwright-core/src/server/dom.ts
index 9b33ca0b0f..593e1e7a78 100644
--- a/packages/playwright-core/src/server/dom.ts
+++ b/packages/playwright-core/src/server/dom.ts
@@ -186,12 +186,35 @@ export class ElementHandle<T extends Node = Node> extends js.JSHandle<T> {
}
async generateLocatorString(): Promise<string | undefined> {
+ const selectors = await this._generateSelectorString();
+ if (!selectors.length)
+ return;
+ return asLocator('javascript', selectors.reverse().join(' >> internal:control=enter-frame >> '));
+ }
+
+ private async _generateSelectorString(): Promise<string[]> {
const selector = await this.evaluateInUtility(async ([injected, node]) => {
return injected.generateSelectorSimple(node as unknown as Element);
}, {});
if (selector === 'error:notconnected')
- return;
- return asLocator('javascript', selector);
+ return [];
+
+ let frame: frames.Frame | null = this._frame;
+ const result: string[] = [selector];
+ while (frame?.parentFrame()) {
+ const frameElement = await frame.frameElement();
+ if (frameElement) {
+ const selector = await frameElement.evaluateInUtility(async ([injected, node]) => {
+ return injected.generateSelectorSimple(node as unknown as Element);
+ }, {});
+ frameElement.dispose();
+ if (selector === 'error:notconnected')
+ return [];
+ result.push(selector);
+ }
+ frame = frame.parentFrame();
+ }
+ return result;
}
async getAttribute(metadata: CallMetadata, name: string): Promise<string | null> {
diff --git a/packages/playwright-core/src/server/frameSelectors.ts b/packages/playwright-core/src/server/frameSelectors.ts
index cf8e5eb971..2c72f147ee 100644
--- a/packages/playwright-core/src/server/frameSelectors.ts
+++ b/packages/playwright-core/src/server/frameSelectors.ts
@@ -111,31 +111,23 @@ export class FrameSelectors {
return Promise.all(result);
}
- private _resolveForLastAISnapshot(selector: string, options: types.StrictOptions = {}): SelectorInFrame | null {
- const match = selector.match(/^aria-ref=f(\d+)e\d+$/);
+ private _jumpToAriaRefFrameIfNeeded(selector: string, info: SelectorInfo, frame: Frame): Frame {
+ if (info.parsed.parts[0].name !== 'aria-ref')
+ return frame;
+ const body = info.parsed.parts[0].body as string;
+ const match = body.match(/^f(\d+)e\d+$/);
if (!match)
- return null;
-
+ return frame;
const frameIndex = +match[1];
const page = this.frame._page;
const frameId = page.lastSnapshotFrameIds[frameIndex - 1];
- if (!frameId)
- return null;
- const frameManager = page.frameManager;
- const frame = frameManager.frame(frameId);
- if (!frame)
- return null;
- return {
- frame,
- info: frame.selectors._parseSelector(selector, options),
- };
+ const jumptToFrame = frameId ? page.frameManager.frame(frameId) : null;
+ if (!jumptToFrame)
+ throw new InvalidSelectorError(`Invalid frame in aria-ref selector "${selector}"`);
+ return jumptToFrame;
}
async resolveFrameForSelector(selector: string, options: types.StrictOptions = {}, scope?: ElementHandle): Promise<SelectorInFrame | null> {
- const resolvedForSnapshot = this._resolveForLastAISnapshot(selector, options);
- if (resolvedForSnapshot)
- return resolvedForSnapshot;
-
let frame: Frame = this.frame;
const frameChunks = splitSelectorByFrame(selector);
@@ -150,6 +142,7 @@ export class FrameSelectors {
for (let i = 0; i < frameChunks.length - 1; ++i) {
const info = this._parseSelector(frameChunks[i], options);
+ frame = this._jumpToAriaRefFrameIfNeeded(selector, info, frame);
const context = await frame._context(info.world);
const injectedScript = await context.injectedScript();
const handle = await injectedScript.evaluateHandle((injected, { info, scope, selectorString }) => {
@@ -170,7 +163,9 @@ export class FrameSelectors {
// If we end up in the different frame, we should start from the frame root, so throw away the scope.
if (frame !== this.frame)
scope = undefined;
- return { frame, info: frame.selectors._parseSelector(frameChunks[frameChunks.length - 1], options), scope };
+ const lastChunk = frame.selectors._parseSelector(frameChunks[frameChunks.length - 1], options);
+ frame = this._jumpToAriaRefFrameIfNeeded(selector, lastChunk, frame);
+ return { frame, info: lastChunk, scope };
}
async resolveInjectedForSelector(selector: string, options?: { strict?: boolean, mainWorld?: boolean }, scope?: ElementHandle): Promise<{ injected: JSHandle<InjectedScript>, info: SelectorInfo, frame: Frame, scope?: ElementHandle } | undefined> {
diff --git a/packages/playwright-core/src/server/page.ts b/packages/playwright-core/src/server/page.ts
index c1721caa89..8e4fcbcb0a 100644
--- a/packages/playwright-core/src/server/page.ts
+++ b/packages/playwright-core/src/server/page.ts
@@ -805,9 +805,8 @@ export class Page extends SdkObject {
}
async snapshotForAI(metadata: CallMetadata): Promise<string> {
- const frameIds: string[] = [];
- const snapshot = await snapshotFrameForAI(this.mainFrame(), 0, frameIds);
- this.lastSnapshotFrameIds = frameIds;
+ this.lastSnapshotFrameIds = [];
+ const snapshot = await snapshotFrameForAI(this.mainFrame(), 0, this.lastSnapshotFrameIds);
return snapshot.join('\n');
}
}
diff --git a/tests/page/page-aria-snapshot-ai.spec.ts b/tests/page/page-aria-snapshot-ai.spec.ts
index c00b3e2c3e..b9a7759649 100644
--- a/tests/page/page-aria-snapshot-ai.spec.ts
+++ b/tests/page/page-aria-snapshot-ai.spec.ts
@@ -87,22 +87,20 @@ it('should stitch all frame snapshots', async ({ page, server }) => {
const href3 = await page.locator('aria-ref=f3e2').evaluate(e => e.ownerDocument.defaultView.location.href);
expect(href3).toBe(server.PREFIX + '/frames/frame.html');
-});
-
-it('should not generate refs for hidden elements', async ({ page }) => {
- await page.setContent(`
- <button>One</button>
- <button style="width: 0; height: 0; appearance: none; border: 0; padding: 0;">Two</button>
- <button>Three</button>
- `);
- const snapshot = await snapshotForAI(page);
- expect(snapshot).toContainYaml(`
- - generic [ref=e1]:
- - button "One" [ref=e2]
- - button "Two"
- - button "Three" [ref=e4]
- `);
+ {
+ const locator = await (page.locator('aria-ref=e1') as any)._generateLocatorString();
+ expect(locator).toBe(`locator('body')`);
+ }
+ {
+ const locator = await (page.locator('aria-ref=f3e2') as any)._generateLocatorString();
+ expect(locator).toBe(`locator('iframe[name="2frames"]').contentFrame().locator('iframe[name="dos"]').contentFrame().getByText('Hi, I\\'m frame')`);
+ }
+ {
+ // Should tolerate .describe().
+ const locator = await (page.locator('aria-ref=f2e2').describe('foo bar') as any)._generateLocatorString();
+ expect(locator).toBe(`locator('iframe[name=\"2frames\"]').contentFrame().locator('iframe[name=\"uno\"]').contentFrame().getByText('Hi, I\\'m frame')`);
+ }
});
it('should not generate refs for elements with pointer-events:none', async ({ page }) => {