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
chore: remove Locator.ariaRef() (#40597)
Pavel Feldmana8c04532b61c
diff --git a/docs/src/api/class-locator.md b/docs/src/api/class-locator.mdindex 5d8a763480..4c1eb276df 100644--- a/docs/src/api/class-locator.md+++ b/docs/src/api/class-locator.md@@ -150,21 +150,6 @@ var button = page.GetByRole(AriaRole.Button).And(page.GetByTitle("Subscribe"));Additional locator to match.-## async method: Locator.ariaRef-* since: v1.60-* langs: js-- returns: <[null]|[string]>--Returns the aria ref (for example `e1`, `e2`) assigned to this element by the most recent aria snapshot, or `null`-if no ref has been assigned yet. Call [`method: Locator.ariaSnapshot`] or [`method: Page.ariaSnapshot`] before this-method to ensure a ref is available.--### option: Locator.ariaRef.timeout = %%-input-timeout-%%-* since: v1.60--### option: Locator.ariaRef.timeout = %%-input-timeout-js-%%-* since: v1.60-## async method: Locator.ariaSnapshot* since: v1.49- returns: <[string]>diff --git a/packages/isomorphic/protocolMetainfo.ts b/packages/isomorphic/protocolMetainfo.tsindex 5c56bc4b52..34ad4a6d70 100644--- a/packages/isomorphic/protocolMetainfo.ts+++ b/packages/isomorphic/protocolMetainfo.ts@@ -160,7 +160,6 @@ export const methodMetainfo = new Map<string, MethodMetainfo>([['Frame.evalOnSelectorAll', { title: 'Evaluate', snapshot: true, pause: true, }],['Frame.addScriptTag', { title: 'Add script tag', snapshot: true, pause: true, }],['Frame.addStyleTag', { title: 'Add style tag', snapshot: true, pause: true, }],- ['Frame.ariaRef', { internal: true, }],['Frame.ariaSnapshot', { title: 'Aria snapshot', group: 'getter', }],['Frame.blur', { title: 'Blur', slowMo: true, snapshot: true, pause: true, }],['Frame.check', { title: 'Check', slowMo: true, snapshot: true, pause: true, input: true, isAutoWaiting: true, }],diff --git a/packages/playwright-client/types/types.d.ts b/packages/playwright-client/types/types.d.tsindex 25643e901c..ae1e5d711f 100644--- a/packages/playwright-client/types/types.d.ts+++ b/packages/playwright-client/types/types.d.ts@@ -12984,24 +12984,6 @@ export interface Locator {*/and(locator: Locator): Locator;- /**- * Returns the aria ref (for example `e1`, `e2`) assigned to this element by the most recent aria snapshot, or `null`- * if no ref has been assigned yet. Call- * [locator.ariaSnapshot([options])](https://playwright.dev/docs/api/class-locator#locator-aria-snapshot) or- * [page.ariaSnapshot([options])](https://playwright.dev/docs/api/class-page#page-aria-snapshot) before this method to- * ensure a ref is available.- * @param options- */- ariaRef(options?: {- /**- * Maximum time in milliseconds. Defaults to `0` - no timeout. The default value can be changed via `actionTimeout`- * option in the config, or by using the- * [browserContext.setDefaultTimeout(timeout)](https://playwright.dev/docs/api/class-browsercontext#browser-context-set-default-timeout)- * or [page.setDefaultTimeout(timeout)](https://playwright.dev/docs/api/class-page#page-set-default-timeout) methods.- */- timeout?: number;- }): Promise<null|string>;-/*** Captures the aria snapshot of the given element. Read more about [aria snapshots](https://playwright.dev/docs/aria-snapshots) and* [expect(locator).toMatchAriaSnapshot(expected[, options])](https://playwright.dev/docs/api/class-locatorassertions#locator-assertions-to-match-aria-snapshot)diff --git a/packages/playwright-core/src/client/locator.ts b/packages/playwright-core/src/client/locator.tsindex 071e6a4efa..fcd2165e7d 100644--- a/packages/playwright-core/src/client/locator.ts+++ b/packages/playwright-core/src/client/locator.ts@@ -324,11 +324,6 @@ export class Locator implements api.Locator {return await this._withElement((h, timeout) => h.screenshot({ ...options, mask, timeout }), { title: 'Screenshot', timeout: options.timeout });}- async ariaRef(options: TimeoutOptions = {}): Promise<string | null> {- const { ref } = await this._frame._channel.ariaRef({ selector: this._selector, timeout: this._frame._timeout(options) });- return ref ?? null;- }-async ariaSnapshot(options: TimeoutOptions & { mode?: 'ai' | 'default', depth?: number, boxes?: boolean } = {}): Promise<string> {const result = await this._frame._channel.ariaSnapshot({ timeout: this._frame._timeout(options), mode: options.mode, selector: this._selector, depth: options.depth, boxes: options.boxes });return result.snapshot;diff --git a/packages/playwright-core/src/protocol/validator.ts b/packages/playwright-core/src/protocol/validator.tsindex d0f5d2b4ea..891326d306 100644--- a/packages/playwright-core/src/protocol/validator.ts+++ b/packages/playwright-core/src/protocol/validator.ts@@ -1655,13 +1655,6 @@ scheme.FrameAddStyleTagParams = tObject({scheme.FrameAddStyleTagResult = tObject({element: tChannel(['ElementHandle']),});-scheme.FrameAriaRefParams = tObject({- selector: tString,- timeout: tFloat,-});-scheme.FrameAriaRefResult = tObject({- ref: tOptional(tString),-});scheme.FrameAriaSnapshotParams = tObject({mode: tOptional(tEnum(['ai', 'default'])),track: tOptional(tString),diff --git a/packages/playwright-core/src/server/dispatchers/frameDispatcher.ts b/packages/playwright-core/src/server/dispatchers/frameDispatcher.tsindex cc7605bd39..33b88d7633 100644--- a/packages/playwright-core/src/server/dispatchers/frameDispatcher.ts+++ b/packages/playwright-core/src/server/dispatchers/frameDispatcher.ts@@ -135,10 +135,6 @@ export class FrameDispatcher extends Dispatcher<Frame, channels.FrameChannel, Brreturn { element: ElementHandleDispatcher.from(this, await this._frame.addStyleTag(progress, params)) };}- async ariaRef(params: channels.FrameAriaRefParams, progress: Progress): Promise<channels.FrameAriaRefResult> {- return await this._frame.ariaRef(progress, params.selector);- }-async ariaSnapshot(params: channels.FrameAriaSnapshotParams, progress: Progress): Promise<channels.FrameAriaSnapshotResult> {return await this._frame.ariaSnapshot(progress, params);}diff --git a/packages/playwright-core/src/server/frames.ts b/packages/playwright-core/src/server/frames.tsindex 39a6a7d774..f7e3424546 100644--- a/packages/playwright-core/src/server/frames.ts+++ b/packages/playwright-core/src/server/frames.ts@@ -1762,15 +1762,6 @@ export class Frame extends SdkObject<FrameEventMap> {}, { source, arg });}- async ariaRef(progress: Progress, selector: string): Promise<{ ref?: string }> {- const ref = await this._retryWithProgressIfNotConnected(progress, selector, { strict: true, performActionPreChecks: true }, async (progress, handle) => {- return await progress.race(handle.evaluateInUtility(([injected, element]) => {- return (element as any)._ariaRef?.ref as string | undefined;- }, {}));- });- return { ref };- }-async ariaSnapshot(progress: Progress, options: { mode?: 'ai' | 'default', track?: string, doNotRenderActive?: boolean, selector?: string, depth?: number, boxes?: boolean } = {}): Promise<{ snapshot: string }> {if (options.selector && options.track)throw new Error('Cannot specify both selector and track options');diff --git a/packages/playwright-core/types/types.d.ts b/packages/playwright-core/types/types.d.tsindex 25643e901c..ae1e5d711f 100644--- a/packages/playwright-core/types/types.d.ts+++ b/packages/playwright-core/types/types.d.ts@@ -12984,24 +12984,6 @@ export interface Locator {*/and(locator: Locator): Locator;- /**- * Returns the aria ref (for example `e1`, `e2`) assigned to this element by the most recent aria snapshot, or `null`- * if no ref has been assigned yet. Call- * [locator.ariaSnapshot([options])](https://playwright.dev/docs/api/class-locator#locator-aria-snapshot) or- * [page.ariaSnapshot([options])](https://playwright.dev/docs/api/class-page#page-aria-snapshot) before this method to- * ensure a ref is available.- * @param options- */- ariaRef(options?: {- /**- * Maximum time in milliseconds. Defaults to `0` - no timeout. The default value can be changed via `actionTimeout`- * option in the config, or by using the- * [browserContext.setDefaultTimeout(timeout)](https://playwright.dev/docs/api/class-browsercontext#browser-context-set-default-timeout)- * or [page.setDefaultTimeout(timeout)](https://playwright.dev/docs/api/class-page#page-set-default-timeout) methods.- */- timeout?: number;- }): Promise<null|string>;-/*** Captures the aria snapshot of the given element. Read more about [aria snapshots](https://playwright.dev/docs/aria-snapshots) and* [expect(locator).toMatchAriaSnapshot(expected[, options])](https://playwright.dev/docs/api/class-locatorassertions#locator-assertions-to-match-aria-snapshot)diff --git a/packages/protocol/src/channels.d.ts b/packages/protocol/src/channels.d.tsindex 9847c692d5..e43bf63f90 100644--- a/packages/protocol/src/channels.d.ts+++ b/packages/protocol/src/channels.d.ts@@ -2810,7 +2810,6 @@ export interface FrameChannel extends FrameEventTarget, Channel {evalOnSelectorAll(params: FrameEvalOnSelectorAllParams, progress?: Progress): Promise<FrameEvalOnSelectorAllResult>;addScriptTag(params: FrameAddScriptTagParams, progress?: Progress): Promise<FrameAddScriptTagResult>;addStyleTag(params: FrameAddStyleTagParams, progress?: Progress): Promise<FrameAddStyleTagResult>;- ariaRef(params: FrameAriaRefParams, progress?: Progress): Promise<FrameAriaRefResult>;ariaSnapshot(params: FrameAriaSnapshotParams, progress?: Progress): Promise<FrameAriaSnapshotResult>;blur(params: FrameBlurParams, progress?: Progress): Promise<FrameBlurResult>;check(params: FrameCheckParams, progress?: Progress): Promise<FrameCheckResult>;@@ -2919,16 +2918,6 @@ export type FrameAddStyleTagOptions = {export type FrameAddStyleTagResult = {element: ElementHandleChannel,};-export type FrameAriaRefParams = {- selector: string,- timeout: number,-};-export type FrameAriaRefOptions = {--};-export type FrameAriaRefResult = {- ref?: string,-};export type FrameAriaSnapshotParams = {mode?: 'ai' | 'default',track?: string,diff --git a/packages/protocol/src/protocol.yml b/packages/protocol/src/protocol.ymlindex 26145d4799..fe16fe1e55 100644--- a/packages/protocol/src/protocol.yml+++ b/packages/protocol/src/protocol.yml@@ -2311,14 +2311,6 @@ Frame:snapshot: truepause: true- ariaRef:- internal: true- parameters:- selector: string- timeout: float- returns:- ref: string?-ariaSnapshot:title: Aria snapshotgroup: getter