core(fr): extract driver preparation methods #12445
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,177 @@ | ||
| /** | ||
| * @license Copyright 2021 The Lighthouse Authors. All Rights Reserved. | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 | ||
| * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. | ||
| */ | ||
| 'use strict'; | ||
|
|
||
| const log = require('lighthouse-logger'); | ||
| const storage = require('./storage.js'); | ||
| const emulation = require('../../lib/emulation.js'); | ||
| const pageFunctions = require('../../lib/page-functions.js'); | ||
|
|
||
| /** | ||
| * Enables `Debugger` domain to receive async stacktrace information on network request initiators. | ||
| * This is critical for tracking attribution of tasks and performance simulation accuracy. | ||
| * @param {LH.Gatherer.FRProtocolSession} session | ||
| */ | ||
| async function enableAsyncStacks(session) { | ||
| const enable = async () => { | ||
| await session.sendCommand('Debugger.enable'); | ||
| await session.sendCommand('Debugger.setSkipAllPauses', {skip: true}); | ||
| await session.sendCommand('Debugger.setAsyncCallStackDepth', {maxDepth: 8}); | ||
| }; | ||
|
|
||
| // Resume any pauses that make it through `setSkipAllPauses` | ||
| session.on('Debugger.paused', () => session.sendCommand('Debugger.resume')); | ||
|
|
||
| // `Debugger.setSkipAllPauses` is reset after every navigation, so retrigger it on main frame navigations. | ||
| // See https://bugs.chromium.org/p/chromium/issues/detail?id=990945&q=setSkipAllPauses&can=2 | ||
| session.on('Page.frameNavigated', event => { | ||
| if (event.frame.parentId) return; | ||
| enable().catch(err => log.error('Driver', err)); | ||
| }); | ||
|
|
||
| await enable(); | ||
| } | ||
|
|
||
| /** | ||
| * Use a RequestIdleCallback shim for tests run with simulated throttling, so that the deadline can be used without | ||
| * a penalty. | ||
| * @param {LH.Gatherer.FRTransitionalDriver} driver | ||
| * @param {LH.Config.Settings} settings | ||
| * @return {Promise<void>} | ||
| */ | ||
| async function shimRequestIdleCallbackOnNewDocument(driver, settings) { | ||
| await driver.executionContext.evaluateOnNewDocument(pageFunctions.wrapRequestIdleCallback, { | ||
|
|
||
| args: [settings.throttling.cpuSlowdownMultiplier], | ||
| }); | ||
| } | ||
|
|
||
| /** | ||
| * Dismiss JavaScript dialogs (alert, confirm, prompt), providing a | ||
| * generic promptText in case the dialog is a prompt. | ||
| * @param {LH.Gatherer.FRProtocolSession} session | ||
| * @return {Promise<void>} | ||
| */ | ||
| async function dismissJavaScriptDialogs(session) { | ||
| session.on('Page.javascriptDialogOpening', data => { | ||
|
There was a problem hiding this comment. same exact impl |
||
| log.warn('Driver', `${data.type} dialog opened by the page automatically suppressed.`); | ||
|
|
||
| session | ||
| .sendCommand('Page.handleJavaScriptDialog', { | ||
| accept: true, | ||
| promptText: 'Lighthouse prompt response', | ||
| }) | ||
| .catch(err => log.warn('Driver', err)); | ||
| }); | ||
|
|
||
| await session.sendCommand('Page.enable'); | ||
| } | ||
|
|
||
| /** | ||
| * @param {LH.Gatherer.FRProtocolSession} session | ||
| * @param {{url: string}} navigation | ||
| * @return {Promise<{warnings: Array<LH.IcuMessage>}>} | ||
| */ | ||
| async function resetStorageForNavigation(session, navigation) { | ||
| /** @type {Array<LH.IcuMessage>} */ | ||
| const warnings = []; | ||
|
|
||
| // Reset the storage and warn if there appears to be other important data. | ||
| const warning = await storage.getImportantStorageWarning(session, navigation.url); | ||
| if (warning) warnings.push(warning); | ||
| await storage.clearDataForOrigin(session, navigation.url); | ||
| await storage.clearBrowserCaches(session); | ||
|
There was a problem hiding this comment. it's new that these two |
||
|
|
||
| return {warnings}; | ||
| } | ||
|
|
||
| /** | ||
| * Prepares a target for a particular navigation by resetting storage and setting throttling. | ||
| * | ||
| * This method assumes `prepareTargetForNavigationMode` has already been invoked. | ||
| * | ||
| * @param {LH.Gatherer.FRProtocolSession} session | ||
| * @param {LH.Config.Settings} settings | ||
| * @param {Pick<LH.Config.NavigationDefn, 'disableThrottling'|'disableStorageReset'|'blockedUrlPatterns'> & {url: string}} navigation | ||
| */ | ||
| async function prepareNetworkForNavigation(session, settings, navigation) { | ||
|
There was a problem hiding this comment. this is effectively the same as |
||
| const status = {msg: 'Preparing network conditions', id: `lh:gather:prepareNetworkForNavigation`}; | ||
| log.time(status); | ||
|
|
||
| if (navigation.disableThrottling) await emulation.clearThrottling(session); | ||
| else await emulation.throttle(session, settings); | ||
|
|
||
| // Set request blocking before any network activity. | ||
| // No "clearing" is done at the end of the navigation since Network.setBlockedURLs([]) will unset all if | ||
| // neccessary at the beginning of the next navigation. | ||
| const blockedUrls = (navigation.blockedUrlPatterns || []).concat( | ||
| settings.blockedUrlPatterns || [] | ||
| ); | ||
| await session.sendCommand('Network.setBlockedURLs', {urls: blockedUrls}); | ||
|
|
||
| const headers = settings.extraHeaders; | ||
| if (headers) await session.sendCommand('Network.setExtraHTTPHeaders', {headers}); | ||
|
|
||
| log.timeEnd(status); | ||
| } | ||
|
|
||
| /** | ||
| * Prepares a target to be analyzed in navigation mode by enabling protocol domains, emulation, and new document | ||
| * handlers for global APIs or error handling. | ||
| * | ||
| * This method should be used in combination with `prepareTargetForIndividualNavigation` before a specific navigation occurs. | ||
| * | ||
| * @param {LH.Gatherer.FRTransitionalDriver} driver | ||
| * @param {LH.Config.Settings} settings | ||
| */ | ||
| async function prepareTargetForNavigationMode(driver, settings) { | ||
|
There was a problem hiding this comment. the same as |
||
| // Emulate our target device screen and user agent. | ||
| await emulation.emulate(driver.defaultSession, settings); | ||
|
|
||
| // Enable better stacks on network requests. | ||
| await enableAsyncStacks(driver.defaultSession); | ||
|
|
||
| // Automatically handle any JavaScript dialogs to prevent a hung renderer. | ||
| await dismissJavaScriptDialogs(driver.defaultSession); | ||
|
|
||
| // Inject our snippet to cache important web platform APIs before they're (possibly) ponyfilled by the page. | ||
| await driver.executionContext.cacheNativesOnNewDocument(); | ||
|
|
||
| // Wrap requestIdleCallback so pages under simulation receive the correct rIC deadlines. | ||
| if (settings.throttlingMethod === 'simulate') { | ||
| await shimRequestIdleCallbackOnNewDocument(driver, settings); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Prepares a target for a particular navigation by resetting storage and setting network. | ||
| * | ||
| * This method assumes `prepareTargetForNavigationMode` has already been invoked. | ||
| * | ||
| * @param {LH.Gatherer.FRProtocolSession} session | ||
| * @param {LH.Config.Settings} settings | ||
| * @param {Pick<LH.Config.NavigationDefn, 'disableThrottling'|'disableStorageReset'|'blockedUrlPatterns'> & {url: string}} navigation | ||
| * @return {Promise<{warnings: Array<LH.IcuMessage>}>} | ||
| */ | ||
| async function prepareTargetForIndividualNavigation(session, settings, navigation) { | ||
| /** @type {Array<LH.IcuMessage>} */ | ||
| const warnings = []; | ||
|
|
||
| const shouldResetStorage = !settings.disableStorageReset && !navigation.disableStorageReset; | ||
|
There was a problem hiding this comment. storage reset was moved here for three main reasons:
|
||
| if (shouldResetStorage) { | ||
| const {warnings: storageWarnings} = await resetStorageForNavigation(session, navigation); | ||
| warnings.push(...storageWarnings); | ||
| } | ||
|
|
||
| await prepareNetworkForNavigation(session, settings, navigation); | ||
|
|
||
| return {warnings}; | ||
| } | ||
|
|
||
| module.exports = { | ||
| prepareNetworkForNavigation, | ||
| prepareTargetForNavigationMode, | ||
| prepareTargetForIndividualNavigation, | ||
| }; | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this little 4 lines is new based on https://bugs.chromium.org/p/chromium/issues/detail?id=990945&q=setSkipAllPauses&can=2