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(perform): pass noAutoWaiting option when generating actions (#38780)
Dmitry Gozman68263ef95a08
diff --git a/packages/playwright-core/src/server/agent/actionRunner.ts b/packages/playwright-core/src/server/agent/actionRunner.tsindex 900d4dca0b..fe889d9555 100644--- a/packages/playwright-core/src/server/agent/actionRunner.ts+++ b/packages/playwright-core/src/server/agent/actionRunner.ts@@ -42,7 +42,7 @@ export async function runAction(parentProgress: Progress, mode: 'generate' | 'ruawait frame.instrumentation.onBeforeCall(frame, callMetadata, parentProgress.metadata.id);let error: Error | undefined;- const result = await innerRunAction(progress, page, action, secrets).catch(e => error = e);+ const result = await innerRunAction(progress, mode, page, action, secrets).catch(e => error = e);callMetadata.endTime = monotonicTime();callMetadata.error = error ? serializeError(error) : undefined;callMetadata.result = error ? undefined : result;@@ -53,8 +53,9 @@ export async function runAction(parentProgress: Progress, mode: 'generate' | 'ru}, minDeadline - mt);}-async function innerRunAction(progress: Progress, page: Page, action: actions.Action, secrets: NameValue[]) {+async function innerRunAction(progress: Progress, mode: 'generate' | 'run', page: Page, action: actions.Action, secrets: NameValue[]) {const frame = page.mainFrame();+ const commonOptions = { strict: true, noAutoWaiting: mode === 'generate' };switch (action.method) {case 'navigate':await frame.goto(progress, action.url);@@ -64,43 +65,43 @@ async function innerRunAction(progress: Progress, page: Page, action: actions.Acbutton: action.button,clickCount: action.clickCount,modifiers: action.modifiers,- ...strictTrue+ ...commonOptions});break;case 'drag':- await frame.dragAndDrop(progress, action.sourceSelector, action.targetSelector, { ...strictTrue });+ await frame.dragAndDrop(progress, action.sourceSelector, action.targetSelector, { ...commonOptions });break;case 'hover':await frame.hover(progress, action.selector, {modifiers: action.modifiers,- ...strictTrue+ ...commonOptions});break;case 'selectOption':- await frame.selectOption(progress, action.selector, [], action.labels.map(a => ({ label: a })), { ...strictTrue });+ await frame.selectOption(progress, action.selector, [], action.labels.map(a => ({ label: a })), { ...commonOptions });break;case 'pressKey':await page.keyboard.press(progress, action.key);break;case 'pressSequentially': {const secret = secrets?.find(s => s.name === action.text)?.value ?? action.text;- await frame.type(progress, action.selector, secret, { ...strictTrue });+ await frame.type(progress, action.selector, secret, { ...commonOptions });if (action.submit)await page.keyboard.press(progress, 'Enter');break;}case 'fill': {const secret = secrets?.find(s => s.name === action.text)?.value ?? action.text;- await frame.fill(progress, action.selector, secret, { ...strictTrue });+ await frame.fill(progress, action.selector, secret, { ...commonOptions });if (action.submit)await page.keyboard.press(progress, 'Enter');break;}case 'setChecked':if (action.checked)- await frame.check(progress, action.selector, { ...strictTrue });+ await frame.check(progress, action.selector, { ...commonOptions });else- await frame.uncheck(progress, action.selector, { ...strictTrue });+ await frame.uncheck(progress, action.selector, { ...commonOptions });break;case 'expectVisible': {const result = await frame.expect(progress, action.selector, { expression: 'to.be.visible', isNot: !!action.isNot });@@ -320,4 +321,3 @@ function callMetadataForAction(frame: Frame, action: actions.Action): CallMetada}const kDefaultTimeout = 5000;-const strictTrue = { strict: true };diff --git a/packages/playwright-core/src/server/dom.ts b/packages/playwright-core/src/server/dom.tsindex d5a06c5c9a..de84b41652 100644--- a/packages/playwright-core/src/server/dom.ts+++ b/packages/playwright-core/src/server/dom.ts@@ -294,10 +294,11 @@ export class ElementHandle<T extends Node = Node> extends js.JSHandle<T> {};}- async _retryAction(progress: Progress, actionName: string, action: (retry: number) => Promise<PerformActionResult>, options: { trial?: boolean, force?: boolean, skipActionPreChecks?: boolean }): Promise<'error:notconnected' | 'done'> {+ async _retryAction(progress: Progress, actionName: string, action: (retry: number) => Promise<PerformActionResult>, options: { trial?: boolean, force?: boolean, skipActionPreChecks?: boolean, noAutoWaiting?: boolean }): Promise<'error:notconnected' | 'done'> {let retry = 0;// We progressively wait longer between retries, up to 500ms.const waitTime = [0, 20, 100, 100, 500];+ const noAutoWaiting = (options as any).__testHookNoAutoWaiting ?? options.noAutoWaiting;while (true) {if (retry) {@@ -312,35 +313,43 @@ export class ElementHandle<T extends Node = Node> extends js.JSHandle<T> {} else {progress.log(`attempting ${actionName} action${options.trial ? ' (trial run)' : ''}`);}- if (!options.skipActionPreChecks && !options.force)+ if (!options.skipActionPreChecks && !options.force && !noAutoWaiting)await this._frame._page.performActionPreChecks(progress);const result = await action(retry);++retry;if (result === 'error:notvisible') {- if (options.force)+ if (options.force || noAutoWaiting)throw new NonRecoverableDOMError('Element is not visible');progress.log(' element is not visible');continue;}if (result === 'error:notinviewport') {- if (options.force)+ if (options.force || noAutoWaiting)throw new NonRecoverableDOMError('Element is outside of the viewport');progress.log(' element is outside of the viewport');continue;}if (result === 'error:optionsnotfound') {+ if (noAutoWaiting)+ throw new NonRecoverableDOMError('Did not find some options');progress.log(' did not find some options');continue;}if (result === 'error:optionnotenabled') {+ if (noAutoWaiting)+ throw new NonRecoverableDOMError('Option being selected is not enabled');progress.log(' option being selected is not enabled');continue;}if (typeof result === 'object' && 'hitTargetDescription' in result) {+ if (noAutoWaiting)+ throw new NonRecoverableDOMError(`${result.hitTargetDescription} intercepts pointer events`);progress.log(` ${result.hitTargetDescription} intercepts pointer events`);continue;}if (typeof result === 'object' && 'missingState' in result) {+ if (noAutoWaiting)+ throw new NonRecoverableDOMError(`Element is not ${result.missingState}`);progress.log(` element is not ${result.missingState}`);continue;}diff --git a/packages/playwright-core/src/server/frames.ts b/packages/playwright-core/src/server/frames.tsindex d6c2285c41..619d4973f2 100644--- a/packages/playwright-core/src/server/frames.ts+++ b/packages/playwright-core/src/server/frames.ts@@ -1100,17 +1100,21 @@ export class Frame extends SdkObject<FrameEventMap> {private async _retryWithProgressIfNotConnected<R>(progress: Progress,selector: string,- strict: boolean | undefined,- performActionPreChecks: boolean,+ options: { strict?: boolean, noAutoWaiting?: boolean, force?: boolean, performActionPreChecks?: boolean },action: (handle: dom.ElementHandle<Element>) => Promise<R | 'error:notconnected'>): Promise<R> {progress.log(`waiting for ${this._asLocator(selector)}`);+ const noAutoWaiting = (options as any).__testHookNoAutoWaiting ?? options.noAutoWaiting;+ const performActionPreChecks = (options.performActionPreChecks ?? !options.force) && !noAutoWaiting;return this.retryWithProgressAndTimeouts(progress, [0, 20, 50, 100, 100, 500], async continuePolling => {if (performActionPreChecks)await this._page.performActionPreChecks(progress);- const resolved = await progress.race(this.selectors.resolveInjectedForSelector(selector, { strict }));- if (!resolved)+ const resolved = await progress.race(this.selectors.resolveInjectedForSelector(selector, { strict: options.strict }));+ if (!resolved) {+ if (noAutoWaiting)+ throw new dom.NonRecoverableDOMError('Element(s) not found');return continuePolling;+ }const result = await progress.race(resolved.injected.evaluateHandle((injected, { info, callId }) => {const elements = injected.querySelectorAll(info.parsed, document);if (callId)@@ -1131,6 +1135,8 @@ export class Frame extends SdkObject<FrameEventMap> {if (log)progress.log(log);if (!success) {+ if (noAutoWaiting)+ throw new dom.NonRecoverableDOMError('Element(s) not found');result.dispose();return continuePolling;}@@ -1139,6 +1145,8 @@ export class Frame extends SdkObject<FrameEventMap> {try {const result = await action(element);if (result === 'error:notconnected') {+ if (noAutoWaiting)+ throw new dom.NonRecoverableDOMError('Element is not attached to the DOM');progress.log('element was detached from the DOM, retrying');return continuePolling;}@@ -1150,22 +1158,22 @@ export class Frame extends SdkObject<FrameEventMap> {}async rafrafTimeoutScreenshotElementWithProgress(progress: Progress, selector: string, timeout: number, options: ScreenshotOptions): Promise<Buffer> {- return await this._retryWithProgressIfNotConnected(progress, selector, true /* strict */, true /* performActionPreChecks */, async handle => {+ return await this._retryWithProgressIfNotConnected(progress, selector, { strict: true, performActionPreChecks: true }, async handle => {await handle._frame.rafrafTimeout(progress, timeout);return await this._page.screenshotter.screenshotElement(progress, handle, options);});}async click(progress: Progress, selector: string, options: { noWaitAfter?: boolean } & types.MouseClickOptions & types.PointerActionWaitOptions) {- return dom.assertDone(await this._retryWithProgressIfNotConnected(progress, selector, options.strict, !options.force /* performActionPreChecks */, handle => handle._click(progress, { ...options, waitAfter: !options.noWaitAfter })));+ return dom.assertDone(await this._retryWithProgressIfNotConnected(progress, selector, options, handle => handle._click(progress, { ...options, waitAfter: !options.noWaitAfter })));}async dblclick(progress: Progress, selector: string, options: types.MouseMultiClickOptions & types.PointerActionWaitOptions) {- return dom.assertDone(await this._retryWithProgressIfNotConnected(progress, selector, options.strict, !options.force /* performActionPreChecks */, handle => handle._dblclick(progress, options)));+ return dom.assertDone(await this._retryWithProgressIfNotConnected(progress, selector, options, handle => handle._dblclick(progress, options)));}async dragAndDrop(progress: Progress, source: string, target: string, options: types.DragActionOptions & types.PointerActionWaitOptions) {- dom.assertDone(await this._retryWithProgressIfNotConnected(progress, source, options.strict, !options.force /* performActionPreChecks */, async handle => {+ dom.assertDone(await this._retryWithProgressIfNotConnected(progress, source, options, async handle => {return handle._retryPointerAction(progress, 'move and down', false, async point => {await this._page.mouse.move(progress, point.x, point.y);await this._page.mouse.down(progress);@@ -1176,7 +1184,7 @@ export class Frame extends SdkObject<FrameEventMap> {});}));// Note: do not perform locator handlers checkpoint to avoid moving the mouse in the middle of a drag operation.- dom.assertDone(await this._retryWithProgressIfNotConnected(progress, target, options.strict, false /* performActionPreChecks */, async handle => {+ dom.assertDone(await this._retryWithProgressIfNotConnected(progress, target, { ...options, performActionPreChecks: false }, async handle => {return handle._retryPointerAction(progress, 'move and up', false, async point => {await this._page.mouse.move(progress, point.x, point.y, { steps: options.steps });await this._page.mouse.up(progress);@@ -1191,19 +1199,19 @@ export class Frame extends SdkObject<FrameEventMap> {async tap(progress: Progress, selector: string, options: types.PointerActionWaitOptions) {if (!this._page.browserContext._options.hasTouch)throw new Error('The page does not support tap. Use hasTouch context option to enable touch support.');- return dom.assertDone(await this._retryWithProgressIfNotConnected(progress, selector, options.strict, !options.force /* performActionPreChecks */, handle => handle._tap(progress, options)));+ return dom.assertDone(await this._retryWithProgressIfNotConnected(progress, selector, options, handle => handle._tap(progress, options)));}- async fill(progress: Progress, selector: string, value: string, options: types.StrictOptions & { force?: boolean }) {- return dom.assertDone(await this._retryWithProgressIfNotConnected(progress, selector, options.strict, !options.force /* performActionPreChecks */, handle => handle._fill(progress, value, options)));+ async fill(progress: Progress, selector: string, value: string, options: types.CommonActionOptions) {+ return dom.assertDone(await this._retryWithProgressIfNotConnected(progress, selector, options, handle => handle._fill(progress, value, options)));}- async focus(progress: Progress, selector: string, options: types.StrictOptions) {- dom.assertDone(await this._retryWithProgressIfNotConnected(progress, selector, options.strict, true /* performActionPreChecks */, handle => handle._focus(progress)));+ async focus(progress: Progress, selector: string, options: types.StrictOptions & { noAutoWaiting?: boolean }) {+ dom.assertDone(await this._retryWithProgressIfNotConnected(progress, selector, options, handle => handle._focus(progress)));}- async blur(progress: Progress, selector: string, options: types.StrictOptions) {- dom.assertDone(await this._retryWithProgressIfNotConnected(progress, selector, options.strict, true /* performActionPreChecks */, handle => handle._blur(progress)));+ async blur(progress: Progress, selector: string, options: types.StrictOptions & { noAutoWaiting?: boolean }) {+ dom.assertDone(await this._retryWithProgressIfNotConnected(progress, selector, options, handle => handle._blur(progress)));}async resolveSelector(progress: Progress, selector: string, options: { mainWorld?: boolean } = {}): Promise<{ resolvedSelector: string }> {@@ -1336,32 +1344,32 @@ export class Frame extends SdkObject<FrameEventMap> {}async hover(progress: Progress, selector: string, options: types.PointerActionOptions & types.PointerActionWaitOptions) {- return dom.assertDone(await this._retryWithProgressIfNotConnected(progress, selector, options.strict, !options.force /* performActionPreChecks */, handle => handle._hover(progress, options)));+ return dom.assertDone(await this._retryWithProgressIfNotConnected(progress, selector, options, handle => handle._hover(progress, options)));}async selectOption(progress: Progress, selector: string, elements: dom.ElementHandle[], values: types.SelectOption[], options: types.CommonActionOptions): Promise<string[]> {- return await this._retryWithProgressIfNotConnected(progress, selector, options.strict, !options.force /* performActionPreChecks */, handle => handle._selectOption(progress, elements, values, options));+ return await this._retryWithProgressIfNotConnected(progress, selector, options, handle => handle._selectOption(progress, elements, values, options));}- async setInputFiles(progress: Progress, selector: string, params: Omit<channels.FrameSetInputFilesParams, 'timeout'>): Promise<channels.FrameSetInputFilesResult> {+ async setInputFiles(progress: Progress, selector: string, params: Omit<channels.FrameSetInputFilesParams, 'timeout'> & { noAutoWaiting?: boolean }): Promise<channels.FrameSetInputFilesResult> {const inputFileItems = await prepareFilesForUpload(this, params);- return dom.assertDone(await this._retryWithProgressIfNotConnected(progress, selector, params.strict, true /* performActionPreChecks */, handle => handle._setInputFiles(progress, inputFileItems)));+ return dom.assertDone(await this._retryWithProgressIfNotConnected(progress, selector, params, handle => handle._setInputFiles(progress, inputFileItems)));}- async type(progress: Progress, selector: string, text: string, options: { delay?: number } & types.StrictOptions) {- return dom.assertDone(await this._retryWithProgressIfNotConnected(progress, selector, options.strict, true /* performActionPreChecks */, handle => handle._type(progress, text, options)));+ async type(progress: Progress, selector: string, text: string, options: { delay?: number, noAutoWaiting?: boolean } & types.StrictOptions) {+ return dom.assertDone(await this._retryWithProgressIfNotConnected(progress, selector, options, handle => handle._type(progress, text, options)));}- async press(progress: Progress, selector: string, key: string, options: { delay?: number, noWaitAfter?: boolean } & types.StrictOptions) {- return dom.assertDone(await this._retryWithProgressIfNotConnected(progress, selector, options.strict, true /* performActionPreChecks */, handle => handle._press(progress, key, options)));+ async press(progress: Progress, selector: string, key: string, options: { delay?: number, noWaitAfter?: boolean, noAutoWaiting?: boolean } & types.StrictOptions) {+ return dom.assertDone(await this._retryWithProgressIfNotConnected(progress, selector, options, handle => handle._press(progress, key, options)));}async check(progress: Progress, selector: string, options: types.PointerActionWaitOptions) {- return dom.assertDone(await this._retryWithProgressIfNotConnected(progress, selector, options.strict, !options.force /* performActionPreChecks */, handle => handle._setChecked(progress, true, options)));+ return dom.assertDone(await this._retryWithProgressIfNotConnected(progress, selector, options, handle => handle._setChecked(progress, true, options)));}async uncheck(progress: Progress, selector: string, options: types.PointerActionWaitOptions) {- return dom.assertDone(await this._retryWithProgressIfNotConnected(progress, selector, options.strict, !options.force /* performActionPreChecks */, handle => handle._setChecked(progress, false, options)));+ return dom.assertDone(await this._retryWithProgressIfNotConnected(progress, selector, options, handle => handle._setChecked(progress, false, options)));}async waitForTimeout(progress: Progress, timeout: number) {@@ -1369,7 +1377,7 @@ export class Frame extends SdkObject<FrameEventMap> {}async ariaSnapshot(progress: Progress, selector: string): Promise<string> {- return await this._retryWithProgressIfNotConnected(progress, selector, true /* strict */, true /* performActionPreChecks */, handle => progress.race(handle.ariaSnapshot()));+ return await this._retryWithProgressIfNotConnected(progress, selector, { strict: true, performActionPreChecks: true }, handle => progress.race(handle.ariaSnapshot()));}async expect(progress: Progress, selector: string | undefined, options: FrameExpectParams, timeout?: number): Promise<ExpectResult> {diff --git a/packages/playwright-core/src/server/types.ts b/packages/playwright-core/src/server/types.tsindex 9f5ef8c7ea..a400152d7f 100644--- a/packages/playwright-core/src/server/types.ts+++ b/packages/playwright-core/src/server/types.ts@@ -36,6 +36,7 @@ export type NavigateOptions = {export type CommonActionOptions = StrictOptions & {force?: boolean,+ noAutoWaiting?: boolean,};export type PointerActionWaitOptions = CommonActionOptions & {diff --git a/tests/page/page-click.spec.ts b/tests/page/page-click.spec.tsindex 05b1c3068b..5221be5b95 100644--- a/tests/page/page-click.spec.ts+++ b/tests/page/page-click.spec.ts@@ -1321,3 +1321,30 @@ it('should click with tweened mouse movement', async ({ page, browserName, isAnd[200, 300]]);});++it('should not wait with noAutoWaiting', async ({ page }) => {+ await page.setContent(`<button>click me</button>`);+ const error = await page.locator('#target').click({ __testHookNoAutoWaiting: true } as any).catch(e => e);+ expect(error.message).toContain('locator.click: Element(s) not found');+});++it('should not wait with noAutoWaiting 2', async ({ page }) => {+ await page.setContent(`+ <style>+ div:hover button {+ margin-left: 200px;+ }+ </style>+ <div>+ <button>click me</button>+ </div>+ `);+ const error = await page.locator('button').click({ __testHookNoAutoWaiting: true } as any).catch(e => e);+ expect(error.message).toContain('locator.click: <div>…</div> intercepts pointer events');+});++it('should not wait with noAutoWaiting 3', async ({ page }) => {+ await page.setContent(`<button disabled>click me</button>`);+ const error = await page.locator('button').click({ __testHookNoAutoWaiting: true } as any).catch(e => e);+ expect(error.message).toContain('locator.click: Element is not enabled');+});