Skip to content

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

Revert "chore: upstream the frame tree snapshot" (#35911)

Pavel Feldman9de2bd49e430
diff --git a/packages/playwright-core/src/client/locator.ts b/packages/playwright-core/src/client/locator.ts
index 0dd097a498..be42ffc60e 100644
--- a/packages/playwright-core/src/client/locator.ts
+++ b/packages/playwright-core/src/client/locator.ts
@@ -303,13 +303,8 @@ export class Locator implements api.Locator {
return await this._withElement((h, timeout) => h.screenshot({ ...options, mask, timeout }), options.timeout);
}
- async ariaSnapshot(options?: TimeoutOptions): Promise<string> {
- const result = await this._frame._channel.ariaSnapshot({ ...options, selector: this._selector });
- return result.snapshot;
- }
-
- async _snapshotForAI(): Promise<string> {
- const result = await this._frame._channel.snapshotForAI({ selector: this._selector });
+ async ariaSnapshot(options?: { _forAI?: boolean } & TimeoutOptions): Promise<string> {
+ const result = await this._frame._channel.ariaSnapshot({ ...options, forAI: options?._forAI, selector: this._selector });
return result.snapshot;
}
diff --git a/packages/playwright-core/src/protocol/debug.ts b/packages/playwright-core/src/protocol/debug.ts
index 58b1282a16..c58c3e4aaf 100644
--- a/packages/playwright-core/src/protocol/debug.ts
+++ b/packages/playwright-core/src/protocol/debug.ts
@@ -95,7 +95,6 @@ export const commandsWithTracingSnapshots = new Set([
'Frame.addScriptTag',
'Frame.addStyleTag',
'Frame.ariaSnapshot',
- 'Frame.snapshotForAI',
'Frame.blur',
'Frame.check',
'Frame.click',
diff --git a/packages/playwright-core/src/protocol/validator.ts b/packages/playwright-core/src/protocol/validator.ts
index 5b870ad841..361742b8f6 100644
--- a/packages/playwright-core/src/protocol/validator.ts
+++ b/packages/playwright-core/src/protocol/validator.ts
@@ -1484,17 +1484,12 @@ scheme.FrameAddStyleTagResult = tObject({
});
scheme.FrameAriaSnapshotParams = tObject({
selector: tString,
+ forAI: tOptional(tBoolean),
timeout: tOptional(tNumber),
});
scheme.FrameAriaSnapshotResult = tObject({
snapshot: tString,
});
-scheme.FrameSnapshotForAIParams = tObject({
- selector: tString,
-});
-scheme.FrameSnapshotForAIResult = tObject({
- snapshot: tString,
-});
scheme.FrameBlurParams = tObject({
selector: tString,
strict: tOptional(tBoolean),
diff --git a/packages/playwright-core/src/server/dispatchers/frameDispatcher.ts b/packages/playwright-core/src/server/dispatchers/frameDispatcher.ts
index e87a8bfd8f..ef8b891d2f 100644
--- a/packages/playwright-core/src/server/dispatchers/frameDispatcher.ts
+++ b/packages/playwright-core/src/server/dispatchers/frameDispatcher.ts
@@ -271,8 +271,4 @@ export class FrameDispatcher extends Dispatcher<Frame, channels.FrameChannel, Br
async ariaSnapshot(params: channels.FrameAriaSnapshotParams, metadata: CallMetadata): Promise<channels.FrameAriaSnapshotResult> {
return { snapshot: await this._frame.ariaSnapshot(metadata, params.selector, params) };
}
-
- async snapshotForAI(params: channels.FrameSnapshotForAIParams, metadata: CallMetadata): Promise<channels.FrameSnapshotForAIResult> {
- return { snapshot: await this._frame.snapshotForAI(metadata, params.selector) };
- }
}
diff --git a/packages/playwright-core/src/server/dom.ts b/packages/playwright-core/src/server/dom.ts
index 331611108a..a047680092 100644
--- a/packages/playwright-core/src/server/dom.ts
+++ b/packages/playwright-core/src/server/dom.ts
@@ -811,7 +811,7 @@ export class ElementHandle<T extends Node = Node> extends js.JSHandle<T> {
return this._page.delegate.getBoundingBox(this);
}
- async ariaSnapshot(options?: { forAI?: boolean }): Promise<string> {
+ async ariaSnapshot(options: { forAI?: boolean }): Promise<string> {
return await this.evaluateInUtility(([injected, element, options]) => injected.ariaSnapshot(element, options), options);
}
diff --git a/packages/playwright-core/src/server/frames.ts b/packages/playwright-core/src/server/frames.ts
index 937c452031..b45bba2fb8 100644
--- a/packages/playwright-core/src/server/frames.ts
+++ b/packages/playwright-core/src/server/frames.ts
@@ -1411,41 +1411,13 @@ export class Frame extends SdkObject {
});
}
- async ariaSnapshot(metadata: CallMetadata, selector: string, options: types.TimeoutOptions = {}): Promise<string> {
+ async ariaSnapshot(metadata: CallMetadata, selector: string, options: { forAI?: boolean } & types.TimeoutOptions = {}): Promise<string> {
const controller = new ProgressController(metadata, this);
return controller.run(async progress => {
- return await this._retryWithProgressIfNotConnected(progress, selector, true /* strict */, true /* performActionPreChecks */, handle => handle.ariaSnapshot());
+ return await this._retryWithProgressIfNotConnected(progress, selector, true /* strict */, true /* performActionPreChecks */, handle => handle.ariaSnapshot(options));
}, this._page.timeoutSettings.timeout(options));
}
- async snapshotForAI(metadata: CallMetadata, selector: string): Promise<string> {
- const allFrameSnapshot = async (selector: string): Promise<string> => {
- const controller = new ProgressController(metadata, this);
- const snapshot = await controller.run(async progress => {
- return await this._retryWithProgressIfNotConnected(progress, selector, true /* strict */, true /* performActionPreChecks */, handle => handle.ariaSnapshot({ forAI: true }));
- }, this._page.timeoutSettings.defaultTimeout());
-
- const lines = snapshot.split('\n');
- const result = [];
- for (const line of lines) {
- const match = line.match(/^(\s*)- iframe \[ref=(.*)\]/);
- if (!match) {
- result.push(line);
- continue;
- }
-
- const leadingSpace = match[1];
- const ref = match[2];
- const childSelector = `${selector} >> aria-ref=${ref} >> internal:control=enter-frame >> body`;
- const childSnapshot = await allFrameSnapshot(childSelector);
- result.push(line + ':', childSnapshot.split('\n').map(l => leadingSpace + ' ' + l).join('\n'));
- }
- return result.join('\n');
- };
-
- return await allFrameSnapshot(selector);
- }
-
async expect(metadata: CallMetadata, selector: string, options: FrameExpectParams): Promise<{ matches: boolean, received?: any, log?: string[], timedOut?: boolean }> {
const result = await this._expectImpl(metadata, selector, options);
// Library mode special case for the expect errors which are return values, not exceptions.
diff --git a/packages/protocol/src/channels.d.ts b/packages/protocol/src/channels.d.ts
index 97913011b4..0b7fa280e6 100644
--- a/packages/protocol/src/channels.d.ts
+++ b/packages/protocol/src/channels.d.ts
@@ -2589,7 +2589,6 @@ export interface FrameChannel extends FrameEventTarget, Channel {
addScriptTag(params: FrameAddScriptTagParams, metadata?: CallMetadata): Promise<FrameAddScriptTagResult>;
addStyleTag(params: FrameAddStyleTagParams, metadata?: CallMetadata): Promise<FrameAddStyleTagResult>;
ariaSnapshot(params: FrameAriaSnapshotParams, metadata?: CallMetadata): Promise<FrameAriaSnapshotResult>;
- snapshotForAI(params: FrameSnapshotForAIParams, metadata?: CallMetadata): Promise<FrameSnapshotForAIResult>;
blur(params: FrameBlurParams, metadata?: CallMetadata): Promise<FrameBlurResult>;
check(params: FrameCheckParams, metadata?: CallMetadata): Promise<FrameCheckResult>;
click(params: FrameClickParams, metadata?: CallMetadata): Promise<FrameClickResult>;
@@ -2696,23 +2695,16 @@ export type FrameAddStyleTagResult = {
};
export type FrameAriaSnapshotParams = {
selector: string,
+ forAI?: boolean,
timeout?: number,
};
export type FrameAriaSnapshotOptions = {
+ forAI?: boolean,
timeout?: number,
};
export type FrameAriaSnapshotResult = {
snapshot: string,
};
-export type FrameSnapshotForAIParams = {
- selector: string,
-};
-export type FrameSnapshotForAIOptions = {
-
-};
-export type FrameSnapshotForAIResult = {
- snapshot: string,
-};
export type FrameBlurParams = {
selector: string,
strict?: boolean,
diff --git a/packages/protocol/src/protocol.yml b/packages/protocol/src/protocol.yml
index d3ca7190c5..94553efd79 100644
--- a/packages/protocol/src/protocol.yml
+++ b/packages/protocol/src/protocol.yml
@@ -1976,20 +1976,13 @@ Frame:
ariaSnapshot:
parameters:
selector: string
+ forAI: boolean?
timeout: number?
returns:
snapshot: string
flags:
snapshot: true
- snapshotForAI:
- parameters:
- selector: string
- returns:
- snapshot: string
- flags:
- snapshot: true
-
blur:
parameters:
selector: string
diff --git a/tests/page/page-aria-snapshot-ai.spec.ts b/tests/page/page-aria-snapshot-ai.spec.ts
index b1b060fccc..16872d2b5f 100644
--- a/tests/page/page-aria-snapshot-ai.spec.ts
+++ b/tests/page/page-aria-snapshot-ai.spec.ts
@@ -14,11 +14,10 @@
* limitations under the License.
*/
+import type { FrameLocator, Page } from '@playwright/test';
import { test as it, expect } from './pageTest';
-function snapshotForAI(page: any): Promise<string> {
- return page.locator('body')._snapshotForAI();
-}
+const forAI = { _forAI: true } as any;
it('should generate refs', async ({ page }) => {
await page.setContent(`
@@ -27,7 +26,7 @@ it('should generate refs', async ({ page }) => {
<button>Three</button>
`);
- const snapshot1 = await snapshotForAI(page);
+ const snapshot1 = await page.locator('body').ariaSnapshot(forAI);
expect(snapshot1).toContainYaml(`
- generic [ref=e1]:
- button "One" [ref=e2]
@@ -42,7 +41,7 @@ it('should generate refs', async ({ page }) => {
e.textContent = 'Not Two';
});
- const snapshot2 = await snapshotForAI(page);
+ const snapshot2 = await page.locator('body').ariaSnapshot(forAI);
expect(snapshot2).toContainYaml(`
- generic [ref=e1]:
- button "One" [ref=e2]
@@ -57,17 +56,37 @@ it('should list iframes', async ({ page }) => {
<iframe name="foo" src="data:text/html,<h1>World</h1>">
`);
- const snapshot1 = await snapshotForAI(page);
+ const snapshot1 = await page.locator('body').ariaSnapshot(forAI);
expect(snapshot1).toContain('- iframe');
const frameSnapshot = await page.frameLocator(`iframe`).locator('body').ariaSnapshot();
expect(frameSnapshot).toEqual('- heading "World" [level=1]');
});
-it('should stitch all frame snapshots', async ({ page, server }) => {
+it('ref mode can be used to stitch all frame snapshots', async ({ page, server }) => {
await page.goto(server.PREFIX + '/frames/nested-frames.html');
- const snapshot = await snapshotForAI(page);
- expect(snapshot).toContainYaml(`
+
+ async function allFrameSnapshot(frame: Page | FrameLocator): Promise<string> {
+ const snapshot = await frame.locator('body').ariaSnapshot(forAI);
+ const lines = snapshot.split('\n');
+ const result = [];
+ for (const line of lines) {
+ const match = line.match(/^(\s*)- iframe \[ref=(.*)\]/);
+ if (!match) {
+ result.push(line);
+ continue;
+ }
+
+ const leadingSpace = match[1];
+ const ref = match[2];
+ const childFrame = frame.frameLocator(`aria-ref=${ref}`);
+ const childSnapshot = await allFrameSnapshot(childFrame);
+ result.push(line + ':', childSnapshot.split('\n').map(l => leadingSpace + ' ' + l).join('\n'));
+ }
+ return result.join('\n');
+ }
+
+ expect(await allFrameSnapshot(page)).toContainYaml(`
- generic [ref=e1]:
- iframe [ref=e2]:
- generic [ref=e1]:
@@ -87,7 +106,7 @@ it('should not generate refs for hidden elements', async ({ page }) => {
<button>Three</button>
`);
- const snapshot = await snapshotForAI(page);
+ const snapshot = await page.locator('body').ariaSnapshot(forAI);
expect(snapshot).toContainYaml(`
- generic [ref=e1]:
- button "One" [ref=e2]
@@ -119,7 +138,7 @@ it('should not generate refs for elements with pointer-events:none', async ({ pa
</div>
`);
- const snapshot = await snapshotForAI(page);
+ const snapshot = await page.locator('body').ariaSnapshot(forAI);
expect(snapshot).toContainYaml(`
- generic [ref=e1]:
- button "no-ref"
@@ -163,7 +182,7 @@ it('emit generic roles for nodes w/o roles', async ({ page }) => {
</div>
`);
- const snapshot = await snapshotForAI(page);
+ const snapshot = await page.locator('body').ariaSnapshot(forAI);
expect(snapshot).toContainYaml(`
- generic [ref=e2]:
@@ -193,7 +212,7 @@ it('should collapse generic nodes', async ({ page }) => {
</div>
`);
- const snapshot = await snapshotForAI(page);
+ const snapshot = await page.locator('body').ariaSnapshot(forAI);
expect(snapshot).toContainYaml(`
- button \"Button\" [ref=e5]
`);
@@ -204,7 +223,7 @@ it('should include cursor pointer hint', async ({ page }) => {
<button style="cursor: pointer">Button</button>
`);
- const snapshot = await snapshotForAI(page);
+ const snapshot = await page.locator('body').ariaSnapshot(forAI);
expect(snapshot).toContainYaml(`
- button \"Button\" [ref=e2] [cursor=pointer]
`);