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
feat: auto-generate toBeVisible assertion while recording (#36812)
Dmitry Gozmanf3666e1e5f1c
diff --git a/packages/injected/src/ariaSnapshot.ts b/packages/injected/src/ariaSnapshot.tsindex 2088b81cdc..cf084eb889 100644--- a/packages/injected/src/ariaSnapshot.ts+++ b/packages/injected/src/ariaSnapshot.ts@@ -48,7 +48,9 @@ type AriaRef = {let lastRef = 0;-export function generateAriaTree(rootElement: Element, options?: { forAI?: boolean, refPrefix?: string }): AriaSnapshot {+export type AriaTreeOptions = { forAI?: boolean, refPrefix?: string, refs?: boolean, visibleOnly?: boolean };++export function generateAriaTree(rootElement: Element, options?: AriaTreeOptions): AriaSnapshot {const visited = new Set<Node>();const snapshot: AriaSnapshot = {@@ -91,7 +93,7 @@ export function generateAriaTree(rootElement: Element, options?: { forAI?: boole}}- const visible = !isElementHiddenForAria || isElementVisible(element);+ const visible = options?.visibleOnly ? isElementVisible(element) : !isElementHiddenForAria || isElementVisible(element);const childAriaNode = visible ? toAriaNode(element, options) : null;if (childAriaNode) {if (childAriaNode.ref) {@@ -155,8 +157,8 @@ export function generateAriaTree(rootElement: Element, options?: { forAI?: boolereturn snapshot;}-function ariaRef(element: Element, role: string, name: string, options?: { forAI?: boolean, refPrefix?: string }): string | undefined {- if (!options?.forAI)+function ariaRef(element: Element, role: string, name: string, options?: AriaTreeOptions): string | undefined {+ if (!options?.forAI && !options?.refs)return undefined;let ariaRef: AriaRef | undefined;@@ -168,7 +170,7 @@ function ariaRef(element: Element, role: string, name: string, options?: { forAIreturn ariaRef.ref;}-function toAriaNode(element: Element, options?: { forAI?: boolean, refPrefix?: string }): AriaNode | null {+function toAriaNode(element: Element, options?: AriaTreeOptions): AriaNode | null {const active = element.ownerDocument.activeElement === element;if (element.nodeName === 'IFRAME') {return {@@ -409,7 +411,7 @@ function matchesNodeDeep(root: AriaNode, template: AriaTemplateNode, collectAll:return results;}-export function renderAriaTree(ariaSnapshot: AriaSnapshot, options?: { mode?: 'raw' | 'regex', forAI?: boolean }): string {+export function renderAriaTree(ariaSnapshot: AriaSnapshot, options?: { mode?: 'raw' | 'regex', forAI?: boolean, refs?: boolean }): string {const lines: string[] = [];const includeText = options?.mode === 'regex' ? textContributesInfo : () => true;const renderString = options?.mode === 'regex' ? convertToBestGuessRegex : (str: string) => str;@@ -450,11 +452,12 @@ export function renderAriaTree(ariaSnapshot: AriaSnapshot, options?: { mode?: 'rkey += ` [pressed]`;if (ariaNode.selected === true)key += ` [selected]`;- if (options?.forAI && receivesPointerEvents(ariaNode)) {- const ref = ariaNode.ref;- const cursor = hasPointerCursor(ariaNode) ? ' [cursor=pointer]' : '';- if (ref)- key += ` [ref=${ref}]${cursor}`;++ const includeRef = (options?.forAI && receivesPointerEvents(ariaNode)) || options?.refs;+ if (includeRef && ariaNode.ref) {+ key += ` [ref=${ariaNode.ref}]`;+ if (hasPointerCursor(ariaNode))+ key += ' [cursor=pointer]';}const escapedKey = indent + '- ' + yamlEscapeKeyIfNeeded(key);diff --git a/packages/injected/src/injectedScript.ts b/packages/injected/src/injectedScript.tsindex e315b9d324..80b58b09eb 100644--- a/packages/injected/src/injectedScript.ts+++ b/packages/injected/src/injectedScript.ts@@ -39,7 +39,7 @@ import type { CSSComplexSelectorList } from '@isomorphic/cssParser';import type { Language } from '@isomorphic/locatorGenerators';import type { NestedSelectorBody, ParsedSelector, ParsedSelectorPart } from '@isomorphic/selectorParser';import type * as channels from '@protocol/channels';-import type { AriaSnapshot } from './ariaSnapshot';+import type { AriaSnapshot, AriaTreeOptions } from './ariaSnapshot';import type { LayoutSelectorName } from './layoutSelectorUtils';import type { SelectorEngine, SelectorRoot } from './selectorEngine';import type { GenerateSelectorOptions } from './selectorGenerator';@@ -297,7 +297,7 @@ export class InjectedScript {return new Set<Element>(result.map(r => r.element));}- ariaSnapshot(node: Node, options?: { mode?: 'raw' | 'regex', forAI?: boolean, refPrefix?: string }): string {+ ariaSnapshot(node: Node, options?: { mode?: 'raw' | 'regex' } & AriaTreeOptions): string {if (node.nodeType !== Node.ELEMENT_NODE)throw this.createStacklessError('Can only capture aria snapshot of Element nodes.');this._lastAriaSnapshot = generateAriaTree(node as Element, options);diff --git a/packages/injected/src/recorder/recorder.ts b/packages/injected/src/recorder/recorder.tsindex bd9d21cfd8..7e20c8c78a 100644--- a/packages/injected/src/recorder/recorder.ts+++ b/packages/injected/src/recorder/recorder.ts@@ -383,7 +383,7 @@ class RecordActionTool implements RecorderTool {const target = this._recorder.deepEventTarget(event);if (target.nodeName === 'INPUT' && (target as HTMLInputElement).type.toLowerCase() === 'file') {- this._recorder.recordAction({+ this._recordAction({name: 'setInputFiles',selector: this._activeModel!.selector,signals: [],@@ -393,7 +393,7 @@ class RecordActionTool implements RecorderTool {}if (isRangeInput(target)) {- this._recorder.recordAction({+ this._recordAction({name: 'fill',// must use hoveredModel instead of activeModel for it to work in webkitselector: this._hoveredModel!.selector,@@ -412,7 +412,7 @@ class RecordActionTool implements RecorderTool {// Non-navigating actions are simply recorded by Playwright.if (this._consumedDueWrongTarget(event))return;- this._recorder.recordAction({+ this._recordAction({name: 'fill',selector: this._activeModel!.selector,signals: [],@@ -545,9 +545,21 @@ class RecordActionTool implements RecorderTool {consumeEvent(event);}+ private _captureAriaSnapshotForAction(action: actions.Action) {+ const documentElement = this._recorder.injectedScript.document.documentElement;+ if (documentElement)+ action.ariaSnapshot = this._recorder.injectedScript.ariaSnapshot(documentElement, { mode: 'raw', refs: true, visibleOnly: true });+ }++ private _recordAction(action: actions.Action) {+ this._captureAriaSnapshotForAction(action);+ this._recorder.recordAction(action);+ }+private _performAction(action: actions.PerformOnRecordAction) {this._recorder.updateHighlight(null, false);+ this._captureAriaSnapshotForAction(action);this._performingActions.add(action);const promise = this._recorder.performAction(action).then(() => {diff --git a/packages/playwright-core/src/server/codegen/jsonl.ts b/packages/playwright-core/src/server/codegen/jsonl.tsindex 9457c45f4c..a15acfb8f8 100644--- a/packages/playwright-core/src/server/codegen/jsonl.ts+++ b/packages/playwright-core/src/server/codegen/jsonl.ts@@ -31,6 +31,7 @@ export class JsonlLanguageGenerator implements LanguageGenerator {...actionInContext.action,...actionInContext.frame,locator,+ ariaSnapshot: undefined,};return JSON.stringify(entry);}diff --git a/packages/playwright-core/src/server/frameSelectors.ts b/packages/playwright-core/src/server/frameSelectors.tsindex 65c1534fdb..ff2a4268b4 100644--- a/packages/playwright-core/src/server/frameSelectors.ts+++ b/packages/playwright-core/src/server/frameSelectors.ts@@ -49,7 +49,7 @@ export class FrameSelectors {return this.frame._page.browserContext.selectors().parseSelector(selector, strict);}- async query(selector: string, options?: types.StrictOptions, scope?: ElementHandle): Promise<ElementHandle<Element> | null> {+ async query(selector: string, options?: types.StrictOptions & { mainWorld?: boolean }, scope?: ElementHandle): Promise<ElementHandle<Element> | null> {const resolved = await this.resolveInjectedForSelector(selector, options, scope);// Be careful, |this.frame| can be different from |resolved.frame|.if (!resolved)diff --git a/packages/playwright-core/src/server/frames.ts b/packages/playwright-core/src/server/frames.tsindex d417f27a60..e4fd5ab84e 100644--- a/packages/playwright-core/src/server/frames.ts+++ b/packages/playwright-core/src/server/frames.ts@@ -1179,8 +1179,8 @@ export class Frame extends SdkObject {dom.assertDone(await this._retryWithProgressIfNotConnected(progress, selector, options.strict, true /* performActionPreChecks */, handle => handle._blur(progress)));}- async resolveSelector(progress: Progress, selector: string): Promise<{ resolvedSelector: string }> {- const element = await progress.race(this.selectors.query(selector));+ async resolveSelector(progress: Progress, selector: string, options: { mainWorld?: boolean } = {}): Promise<{ resolvedSelector: string }> {+ const element = await progress.race(this.selectors.query(selector, options));if (!element)throw new Error(`No element matching ${selector}`);diff --git a/packages/playwright-core/src/server/recorder.ts b/packages/playwright-core/src/server/recorder.tsindex cbf0aa8c47..152aa9bea1 100644--- a/packages/playwright-core/src/server/recorder.ts+++ b/packages/playwright-core/src/server/recorder.ts@@ -20,7 +20,7 @@ import fs from 'fs';import { isUnderTest } from '../utils';import { BrowserContext } from './browserContext';import { Debugger } from './debugger';-import { buildFullSelector, generateFrameSelector, metadataToCallLog } from './recorder/recorderUtils';+import { buildFullSelector, generateFrameSelector, isAssertAction, metadataToCallLog, shouldMergeAction } from './recorder/recorderUtils';import { locatorOrSelectorAsSelector } from '../utils/isomorphic/locatorParser';import { stringifySelector } from '../utils/isomorphic/selectorParser';import { ProgressController } from './progress';@@ -31,6 +31,8 @@ import { eventsHelper, monotonicTime } from './../utils';import { Frame } from './frames';import { Page } from './page';import { performAction } from './recorder/recorderRunner';+import { findNewElementRef } from '../utils/isomorphic/ariaSnapshot';+import { yaml } from '../utilsBundle';import type { Language } from './codegen/types';import type { CallMetadata, InstrumentationListener, SdkObject } from './instrumentation';@@ -520,16 +522,69 @@ export class Recorder extends EventEmitter<RecorderEventMap> implements Instrumereturn actionInContext;}+ private async _maybeGenerateAssertAction(frame: Frame, actionInContext: actions.ActionInContext) {+ const lastAction = getLastFrameAction(frame);+ if (isAssertAction(actionInContext.action))+ return;+ if (lastAction && (isAssertAction(lastAction.action) || shouldMergeAction(actionInContext, lastAction)))+ return;+ const newSnapshot = actionInContext.action.ariaSnapshot;+ if (!newSnapshot)+ return;+ const lastSnapshot = lastAction?.action.ariaSnapshot || `- document [ref=e1]\n`;+ if (!lastSnapshot)+ return;+ const callMetadata = serverSideCallMetadata();+ const controller = new ProgressController(callMetadata, frame);+ const selector = await controller.run(async progress => {+ const ref = findNewElementRef(yaml, lastSnapshot, newSnapshot);+ if (!ref)+ return;+ // Note: recorder runs in the main world, so we need to resolve the ref in the main world.+ // Note: resolveSelector always returns a |page|-based selector, not |frame|-based.+ const { resolvedSelector } = await frame.resolveSelector(progress, `aria-ref=${ref}`, { mainWorld: true }).catch(() => ({ resolvedSelector: undefined }));+ if (!resolvedSelector)+ return;+ const isVisible = await frame._page.mainFrame().isVisible(progress, resolvedSelector, { strict: true }).catch(() => false);+ return isVisible ? resolvedSelector : undefined;+ }).catch(() => undefined);+ if (!selector)+ return;+ if (!actionInContext.frame.framePath.length && 'selector' in actionInContext.action && actionInContext.action.selector === selector)+ return; // Do not assert the action target, auto-waiting takes care of it.+ const assertActionInContext: actions.ActionInContext = {+ frame: {+ pageGuid: actionInContext.frame.pageGuid,+ pageAlias: actionInContext.frame.pageAlias,+ framePath: [],+ },+ action: {+ name: 'assertVisible',+ selector,+ signals: [],+ },+ startTime: actionInContext.startTime,+ endTime: actionInContext.startTime,+ };+ return assertActionInContext;+ }+private async _performAction(frame: Frame, action: actions.PerformOnRecordAction) {const actionInContext = await this._createActionInContext(frame, action);+ const assertActionInContext = await this._maybeGenerateAssertAction(frame, actionInContext);+ if (assertActionInContext)+ this._signalProcessor.addAction(assertActionInContext);this._signalProcessor.addAction(actionInContext);+ setLastFrameAction(frame, actionInContext);if (actionInContext.action.name !== 'openPage' && actionInContext.action.name !== 'closePage')await performAction(this._pageAliases, actionInContext);actionInContext.endTime = monotonicTime();}private async _recordAction(frame: Frame, action: actions.Action) {- this._signalProcessor.addAction(await this._createActionInContext(frame, action));+ const actionInContext = await this._createActionInContext(frame, action);+ this._signalProcessor.addAction(actionInContext);+ setLastFrameAction(frame, actionInContext);}private _onFrameNavigated(frame: Frame, page: Page) {@@ -569,3 +624,11 @@ function languageForFile(file: string) {return 'csharp';return 'javascript';}++const kLastFrameActionSymbol = Symbol('lastFrameAction');+function getLastFrameAction(frame: Frame): actions.ActionInContext | undefined {+ return (frame as any)[kLastFrameActionSymbol];+}+function setLastFrameAction(frame: Frame, action: actions.ActionInContext | undefined) {+ (frame as any)[kLastFrameActionSymbol] = action;+}diff --git a/packages/playwright-core/src/server/recorder/recorderUtils.ts b/packages/playwright-core/src/server/recorder/recorderUtils.tsindex 03693b3f58..c1026d343e 100644--- a/packages/playwright-core/src/server/recorder/recorderUtils.ts+++ b/packages/playwright-core/src/server/recorder/recorderUtils.ts@@ -73,6 +73,10 @@ export async function frameForAction(pageAliases: Map<Page, string>, actionInConreturn result.frame;}+export function isAssertAction(action: actions.Action): action is actions.AssertAction {+ return action.name.startsWith('assert');+}+function isSameAction(a: actions.ActionInContext, b: actions.ActionInContext): boolean {return a.action.name === b.action.name && a.frame.pageAlias === b.frame.pageAlias && a.frame.framePath.join('|') === b.frame.framePath.join('|');}diff --git a/packages/playwright-core/src/utils/isomorphic/ariaSnapshot.ts b/packages/playwright-core/src/utils/isomorphic/ariaSnapshot.tsindex 24c908b100..69a2f5819d 100644--- a/packages/playwright-core/src/utils/isomorphic/ariaSnapshot.ts+++ b/packages/playwright-core/src/utils/isomorphic/ariaSnapshot.ts@@ -32,6 +32,7 @@ export type AriaProps = {level?: number;pressed?: boolean | 'mixed';selected?: boolean;+ ref?: string;};// We pass parsed template between worlds using JSON, make it easy.@@ -64,22 +65,23 @@ type YamlLibrary = {};type ParsedYamlPosition = { line: number; col: number; };+type ParsingOptions = yamlTypes.ParseOptions & { allowRef?: boolean, allowUnknownAttributes?: boolean };export type ParsedYamlError = {message: string;range: [ParsedYamlPosition, ParsedYamlPosition];};-export function parseAriaSnapshotUnsafe(yaml: YamlLibrary, text: string): AriaTemplateNode {- const result = parseAriaSnapshot(yaml, text);+export function parseAriaSnapshotUnsafe(yaml: YamlLibrary, text: string, options: ParsingOptions = {}): AriaTemplateNode {+ const result = parseAriaSnapshot(yaml, text, options);if (result.errors.length)throw new Error(result.errors[0].message);return result.fragment;}-export function parseAriaSnapshot(yaml: YamlLibrary, text: string, options: yamlTypes.ParseOptions = {}): { fragment: AriaTemplateNode, errors: ParsedYamlError[] } {+export function parseAriaSnapshot(yaml: YamlLibrary, text: string, options: ParsingOptions = {}): { fragment: AriaTemplateNode, errors: ParsedYamlError[] } {const lineCounter = new yaml.LineCounter();- const parseOptions: yamlTypes.ParseOptions = {+ const parseOptions: ParsingOptions = {keepSourceTokens: true,lineCounter,...options,@@ -265,10 +267,11 @@ export class KeyParser {private _input: string;private _pos: number;private _length: number;+ private _options: ParsingOptions;- static parse(text: yamlTypes.Scalar<string>, options: yamlTypes.ParseOptions, errors: ParsedYamlError[]): AriaTemplateRoleNode | null {+ static parse(text: yamlTypes.Scalar<string>, options: ParsingOptions, errors: ParsedYamlError[]): AriaTemplateRoleNode | null {try {- return new KeyParser(text.value)._parse();+ return new KeyParser(text.value, options)._parse();} catch (e) {if (e instanceof ParserError) {const message = options.prettyErrors === false ? e.message : e.message + ':\n\n' + text.value + '\n' + ' '.repeat(e.pos) + '^\n';@@ -282,10 +285,11 @@ export class KeyParser {}}- constructor(input: string) {+ constructor(input: string, options: ParsingOptions) {this._input = input;this._pos = 0;this._length = input.length;+ this._options = options;}private _peek() {@@ -430,6 +434,10 @@ export class KeyParser {}private _applyAttribute(node: AriaTemplateRoleNode, key: string, value: string, errorPos: number) {+ if (this._options.allowRef && key === 'ref') {+ node.ref = value;+ return;+ }if (key === 'checked') {this._assert(value === 'true' || value === 'false' || value === 'mixed', 'Value of "checked\" attribute must be a boolean or "mixed"', errorPos);node.checked = value === 'true' ? true : value === 'false' ? false : 'mixed';@@ -465,6 +473,8 @@ export class KeyParser {node.selected = value === 'true';return;}+ if (this._options.allowUnknownAttributes)+ return;this._assert(false, `Unsupported attribute [${key}]`, errorPos);}@@ -482,3 +492,55 @@ export class ParserError extends Error {this.pos = pos;}}++export function findNewElementRef(yaml: YamlLibrary, fromSnapshot: string, toSnapshot: string): string | undefined {+ type ByRoleAndName = Map<string, Map<string, { node: AriaTemplateRoleNode, sizeAndPosition: number }>>;++ function fillMap(root: AriaTemplateRoleNode, map: ByRoleAndName, position: number) {+ let size = 1;+ let childPosition = position + size;+ for (const child of root.children || []) {+ if (child.kind === 'role') {+ size += fillMap(child, map, childPosition);+ childPosition += size;+ } else {+ size++;+ childPosition++;+ }+ }+ if (!['none', 'presentation', 'fragment', 'iframe', 'generic'].includes(root.role) && typeof root.name === 'string' && root.name) {+ let byRole = map.get(root.role);+ if (!byRole) {+ byRole = new Map();+ map.set(root.role, byRole);+ }+ const existing = byRole.get(root.name);+ // This heuristic prioritizes elements at the top of the page, even if somewhat smaller.+ const sizeAndPosition = size * 100 - position;+ if (!existing || existing.sizeAndPosition < sizeAndPosition)+ byRole.set(root.name, { node: root, sizeAndPosition });+ }+ return size;+ }++ const fromMap: ByRoleAndName = new Map();+ const from = parseAriaSnapshotUnsafe(yaml, fromSnapshot, { allowRef: true, allowUnknownAttributes: true });+ if (from.kind === 'role')+ fillMap(from, fromMap, 0);++ const toMap: ByRoleAndName = new Map();+ const to = parseAriaSnapshotUnsafe(yaml, toSnapshot, { allowRef: true, allowUnknownAttributes: true });+ if (to.kind === 'role')+ fillMap(to, toMap, 0);++ const result: { node: AriaTemplateRoleNode, sizeAndPosition: number }[] = [];+ for (const [role, byRole] of toMap) {+ for (const [name, byName] of byRole) {+ const inFrom = fromMap.get(role)?.get(name);+ if (!inFrom)+ result.push(byName);+ }+ }+ result.sort((a, b) => b.sizeAndPosition - a.sizeAndPosition);+ return result.find(r => r.node.ref)?.node.ref;+}diff --git a/tests/library/inspector/cli-codegen-2.spec.ts b/tests/library/inspector/cli-codegen-2.spec.tsindex 313acc6b18..3b961d543e 100644--- a/tests/library/inspector/cli-codegen-2.spec.ts+++ b/tests/library/inspector/cli-codegen-2.spec.ts@@ -517,4 +517,61 @@ await page.Locator("#textarea").FillAsync(\"Hello'\\"\`\\nWorld\");`);expect.soft(sources.get('Python Async')!.text).toContain(`await page.get_by_test_id("foo").click()`);expect.soft(sources.get('C#')!.text).toContain(`await page.GetByTestId("foo").ClickAsync();`);});++ test('should auto-generate toBeVisible', async ({ openRecorder }) => {+ const { page, recorder } = await openRecorder();++ await recorder.setContentAndWait(`+ <button id=one>one</button>+ <div id=insertion></div>+ <button id=two>two</button>+ <script>+ const one = document.getElementById('one');+ const insertion = document.getElementById('insertion');+ one.addEventListener('click', () => {+ insertion.innerHTML = '<h2>new header</h2>';+ console.log('clicked one');+ });+ two.addEventListener('click', () => {+ console.log('clicked two');+ });+ </script>+ `);++ const locatorOne = await recorder.hoverOverElement('#one');+ expect(locatorOne).toBe(`getByRole('button', { name: 'one' })`);+ await Promise.all([+ page.waitForEvent('console', msg => msg.text() === 'clicked one'),+ recorder.waitForOutput('JavaScript', 'one'),+ recorder.trustedClick(),+ ]);++ const locatorTwo = await recorder.hoverOverElement('#two');+ expect(locatorTwo).toBe(`getByRole('button', { name: 'two' })`);+ const [sources] = await Promise.all([+ recorder.waitForOutput('JavaScript', 'two'),+ page.waitForEvent('console', msg => msg.text() === 'clicked two'),+ recorder.trustedClick(),+ ]);++ expect.soft(sources.get('Playwright Test')!.text).toContain(`+ await expect(page.getByRole('heading', { name: 'new header' })).toBeVisible();+ await page.getByRole('button', { name: 'two' }).click();`);++ expect.soft(sources.get('Python')!.text).toContain(`+ expect(page.get_by_role("heading", name="new header")).to_be_visible()+ page.get_by_role("button", name="two").click()`);++ expect.soft(sources.get('Python Async')!.text).toContain(`+ await expect(page.get_by_role("heading", name="new header")).to_be_visible()+ await page.get_by_role("button", name="two").click()`);++ expect.soft(sources.get('Java')!.text).toContain(`+ assertThat(page.getByRole(AriaRole.HEADING, new Page.GetByRoleOptions().setName("new header"))).isVisible();+ page.getByRole(AriaRole.BUTTON, new Page.GetByRoleOptions().setName("two")).click();`);++ expect.soft(sources.get('C#')!.text).toContain(`+await Expect(page.GetByRole(AriaRole.Heading, new() { Name = "new header" })).ToBeVisibleAsync();+await page.GetByRole(AriaRole.Button, new() { Name = "two" }).ClickAsync();`);+ });});