fix(actions): wait for some time before retrying the action (#4001)

This saves some CPU cycles while waiting for the page to
change the state, e.g. for animations to complete.

Note that retrying logic is only applicable in rare
circumstances like unexpected scroll in the middle of an
action, or some overlay blocking the click. Usually,
action times out in this cases while retrying.
This commit is contained in:
Dmitry Gozman 2020-09-29 10:28:19 -07:00 committed by GitHub
parent 109688a066
commit b3497b333e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 15 additions and 3 deletions

View file

@ -273,11 +273,22 @@ export class ElementHandle<T extends Node = Node> extends js.JSHandle<T> {
async _retryPointerAction(progress: Progress, actionName: string, waitForEnabled: boolean, action: (point: types.Point) => Promise<void>,
options: types.PointerActionOptions & types.PointerActionWaitOptions & types.NavigatingActionWaitOptions): Promise<'error:notconnected' | 'done'> {
let first = true;
let retry = 0;
// We progressively wait longer between retries, up to 500ms.
const waitTime = [0, 20, 100, 500];
while (progress.isRunning()) {
progress.log(`${first ? 'attempting' : 'retrying'} ${actionName} action`);
if (retry) {
progress.log(`retrying ${actionName} action, attempt #${retry}`);
const timeout = waitTime[Math.min(retry - 1, waitTime.length - 1)];
if (timeout) {
progress.log(` waiting ${timeout}ms`);
await this._evaluateInUtility(([injected, node, timeout]) => new Promise(f => setTimeout(f, timeout)), timeout);
}
} else {
progress.log(`attempting ${actionName} action`);
}
const result = await this._performPointerAction(progress, actionName, waitForEnabled, action, options);
first = false;
++retry;
if (result === 'error:notvisible') {
if (options.force)
throw new Error('Element is not visible');

View file

@ -54,6 +54,7 @@ it('should timeout waiting for hit target', async ({page, server}) => {
expect(error.message).toContain('elementHandle.click: Timeout 5000ms exceeded.');
expect(error.message).toContain('<div id="blocker"></div> intercepts pointer events');
expect(error.message).toContain('retrying click action');
expect(error.message).toContain('waiting 500ms');
});
it('should report wrong hit target subtree', async ({page, server}) => {