Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

core: remove protocol timeout for Page.navigate #6413

Merged
merged 11 commits into from
Nov 20, 2018
Merged

core: remove protocol timeout for Page.navigate #6413

Changes from 4 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
d798047
core: increase Page.navigate timeout (#6412)
connorjclark Oct 27, 2018
9af14cc
disable timeout for Page.navigate
connorjclark Oct 29, 2018
273166c
add comment
connorjclark Oct 30, 2018
e0fa246
pr changes
connorjclark Oct 30, 2018
7dd175a
no ternary
connorjclark Oct 31, 2018
81c00a1
edit comment
connorjclark Oct 31, 2018
3c58396
innerSendCommand
connorjclark Nov 19, 2018
0383285
update comment
connorjclark Nov 19, 2018
175cc67
Merge branch 'master' into issue-6407-increase-page-navigate-timeout
connorjclark Nov 19, 2018
6f88aaf
add tests
connorjclark Nov 20, 2018
c08cb46
update test
connorjclark Nov 20, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions lighthouse-core/gather/driver.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,6 +259,8 @@ class Driver {
}

/**
* If > 0, timeout is used for the next call to 'sendCommand'.
* If <= 0, no timeout is used.
Copy link
Member

@brendankenny brendankenny Oct 30, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The >/<= describe literally what's allowed, but probably aren't worth including. Maybe go with timeout is used for the next call to 'sendCommand'. If 0, no timeout is used.

* NOTE: This can eventually be replaced when TypeScript
* resolves https://github.com/Microsoft/TypeScript/issues/5453.
* @param {number} timeout
Expand Down Expand Up @@ -286,18 +288,20 @@ class Driver {
}
}
return new Promise(async (resolve, reject) => {
const asyncTimeout = setTimeout((_ => {
const asyncTimeout = timeout > 0 ? setTimeout((_ => {
Copy link
Member

@brendankenny brendankenny Oct 30, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: the ternary ends up stretching pretty far. What about just

let asyncTimeout;
if (timeout > 0) {
  asyncTimeout = setTimeout(...)
}

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should also add a note about the 0 behavior to setNextProtocolTimeout

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would have gone that route first, but it would need to be let, and my personal preferences led me to choose the ternary before reaching for let. wdyt

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

whoops, yeah, let. And what's with that explicit undefined. Going to edit my comment because my brain was apparently off while writing that :)

The main issue is that you have to look down four lines to see the other half of the conditional, and the syntax makes it harder to parse than normal control flow mechanisms (like an if block). Generally long ternaries just aren't worth it, but at the very least, the null branch should be first

const err = new LHError(LHError.errors.PROTOCOL_TIMEOUT);
err.message += ` Method: ${method}`;
reject(err);
}), timeout);
}), timeout) : null;
try {
const result = await this._connection.sendCommand(method, ...params);
clearTimeout(asyncTimeout);
resolve(result);
} catch (err) {
clearTimeout(asyncTimeout);
reject(err);
} finally {
if (asyncTimeout) {
clearTimeout(asyncTimeout);
}
}
});
}
Expand Down Expand Up @@ -840,7 +844,7 @@ class Driver {
// happen _after_ onload: https://crbug.com/768961
this.sendCommand('Page.enable');
this.sendCommand('Emulation.setScriptExecutionDisabled', {value: disableJS});
this.setNextProtocolTimeout(30 * 1000);
this.setNextProtocolTimeout(0); // We don't need a timeout for Page.navigate. See #6413.
this.sendCommand('Page.navigate', {url});

if (waitForLoad) {
Expand Down