lighthouse 8.5.1-dev.20211012 → 8.5.1

package/lighthouse-core/fraggle-rock/config/filters.js

@@ -162,23 +162,6 @@ function filterAuditsByGatherMode(audits, mode) {
   });
 }
 
-/**
- * Optional `supportedModes` property can explicitly exclude a category even if some audits are available.
- *
- * @param {LH.Config.Config['categories']} categories
- * @param {LH.Gatherer.GatherMode} mode
- * @return {LH.Config.Config['categories']}
- */
-function filterCategoriesByGatherMode(categories, mode) {
-  if (!categories) return null;
-
-  const categoriesToKeep = Object.entries(categories)
-    .filter(([_, category]) => {
-      return !category.supportedModes || category.supportedModes.includes(mode);
-    });
-  return Object.fromEntries(categoriesToKeep);
-}
-
 /**
  * Filters a categories object and their auditRefs down to the specified category ids.
  *
@@ -242,10 +225,9 @@ function filterCategoriesByAvailableAudits(categories, availableAudits) {
  */
 function filterConfigByGatherMode(config, mode) {
   const artifacts = filterArtifactsByGatherMode(config.artifacts, mode);
-  const supportedAudits = filterAuditsByGatherMode(config.audits, mode);
-  const audits = filterAuditsByAvailableArtifacts(supportedAudits, artifacts || []);
-  const supportedCategories = filterCategoriesByGatherMode(config.categories, mode);
-  const categories = filterCategoriesByAvailableAudits(supportedCategories, audits || []);
+  const availableAudits = filterAuditsByAvailableArtifacts(config.audits, artifacts || []);
+  const audits = filterAuditsByGatherMode(availableAudits, mode);
+  const categories = filterCategoriesByAvailableAudits(config.categories, audits || []);
 
   return {
     ...config,
@@ -309,5 +291,4 @@ module.exports = {
   filterAuditsByGatherMode,
   filterCategoriesByAvailableAudits,
   filterCategoriesByExplicitFilters,
-  filterCategoriesByGatherMode,
 };

package/lighthouse-core/fraggle-rock/gather/driver.js

@@ -5,7 +5,6 @@
  */
 'use strict';
 
-const log = require('lighthouse-logger');
 const ProtocolSession = require('./session.js');
 const ExecutionContext = require('../../gather/driver/execution-context.js');
 const Fetcher = require('../../gather/fetcher.js');
@@ -69,13 +68,10 @@ class Driver {
   /** @return {Promise<void>} */
   async connect() {
     if (this._session) return;
-    const status = {msg: 'Connecting to browser', id: 'lh:driver:connect'};
-    log.time(status);
     const session = await this._page.target().createCDPSession();
     this._session = this.defaultSession = new ProtocolSession(session);
     this._executionContext = new ExecutionContext(this._session);
     this._fetcher = new Fetcher(this._session, this._executionContext);
-    log.timeEnd(status);
   }
 
   /** @return {Promise<void>} */

package/lighthouse-core/fraggle-rock/gather/navigation-runner.js

@@ -20,7 +20,7 @@ const emulation = require('../../lib/emulation.js');
 const {defaultNavigationConfig} = require('../../config/constants.js');
 const {initializeConfig} = require('../config/config.js');
 const {getBaseArtifacts, finalizeArtifacts} = require('./base-artifacts.js');
-const format = require('../../../shared/localization/format.js');
+const i18n = require('../../lib/i18n/i18n.js');
 const LighthouseError = require('../../lib/lh-error.js');
 const {getPageLoadError} = require('../../lib/navigation-error.js');
 const Trace = require('../../gather/gatherers/trace.js');
@@ -165,7 +165,7 @@ async function _computeNavigationResult(
 
   if (pageLoadError) {
     const locale = navigationContext.config.settings.locale;
-    const localizedMessage = format.getFormatted(pageLoadError.friendlyMessage, locale);
+    const localizedMessage = i18n.getFormatted(pageLoadError.friendlyMessage, locale);
     log.error('NavigationRunner', localizedMessage, navigationContext.requestedUrl);
 
     /** @type {Partial<LH.GathererArtifacts>} */

package/lighthouse-core/fraggle-rock/user-flow.js

@@ -6,13 +6,11 @@
 'use strict';
 
 const {generateFlowReportHtml} = require('../../report/generator/report-generator.js');
-const {snapshot} = require('./gather/snapshot-runner.js');
-const {startTimespan} = require('./gather/timespan-runner.js');
-const {navigation} = require('./gather/navigation-runner.js');
+const {navigation, startTimespan, snapshot} = require('./api.js');
 
 /** @typedef {Parameters<snapshot>[0]} FrOptions */
-/** @typedef {Omit<FrOptions, 'page'> & {name?: string}} UserFlowOptions */
-/** @typedef {Omit<FrOptions, 'page'> & {stepName?: string}} StepOptions */
+/** @typedef {Omit<FrOptions, 'page'>} UserFlowOptions */
+/** @typedef {UserFlowOptions & {stepName?: string}} StepOptions */
 
 class UserFlow {
   /**
@@ -22,8 +20,6 @@ class UserFlow {
   constructor(page, options) {
     /** @type {FrOptions} */
     this.options = {page, ...options};
-    /** @type {string|undefined} */
-    this.name = options && options.name;
     /** @type {LH.FlowResult.Step[]} */
     this.steps = [];
   }
@@ -53,29 +49,6 @@ class UserFlow {
     }
   }
 
-  /**
-   * @param {string} url
-   * @param {StepOptions=} stepOptions
-   */
-  _getNextNavigationOptions(url, stepOptions) {
-    const options = {url, ...this.options, ...stepOptions};
-
-    // On repeat navigations, we want to disable storage reset by default (i.e. it's not a cold load).
-    const isSubsequentNavigation = this.steps.some(step => step.lhr.gatherMode === 'navigation');
-    if (isSubsequentNavigation) {
-      const configContext = {...options.configContext};
-      const settingsOverrides = {...configContext.settingsOverrides};
-      if (settingsOverrides.disableStorageReset === undefined) {
-        settingsOverrides.disableStorageReset = true;
-      }
-
-      configContext.settingsOverrides = settingsOverrides;
-      options.configContext = configContext;
-    }
-
-    return options;
-  }
-
   /**
    * @param {string} url
    * @param {StepOptions=} stepOptions
@@ -83,7 +56,8 @@ class UserFlow {
   async navigate(url, stepOptions) {
     if (this.currentTimespan) throw Error('Timespan already in progress');
 
-    const result = await navigation(this._getNextNavigationOptions(url, stepOptions));
+    const options = {url, ...this.options, ...stepOptions};
+    const result = await navigation(options);
     if (!result) throw Error('Navigation returned undefined');
 
     const providedName = stepOptions && stepOptions.stepName;
@@ -146,10 +120,7 @@ class UserFlow {
    * @return {LH.FlowResult}
    */
   getFlowResult() {
-    if (!this.steps.length) throw Error('Need at least one step before getting the flow result');
-    const url = new URL(this.steps[0].lhr.finalUrl);
-    const name = this.name || `User flow (${url.hostname})`;
-    return {steps: this.steps, name};
+    return {steps: this.steps};
   }
 
   /**

package/lighthouse-core/gather/driver/navigation.js

@@ -5,7 +5,6 @@
  */
 'use strict';
 
-const log = require('lighthouse-logger');
 const NetworkMonitor = require('./network-monitor.js');
 const {waitForFullyLoaded, waitForFrameNavigated, waitForUserToContinue} = require('./wait-for-condition.js'); // eslint-disable-line max-len
 const constants = require('../../config/constants.js');
@@ -83,9 +82,6 @@ function resolveWaitForFullyLoadedOptions(options) {
  * @return {Promise<{finalUrl: string, warnings: Array<LH.IcuMessage>}>}
  */
 async function gotoURL(driver, url, options) {
-  const status = {msg: `Navigating to ${url}`, id: 'lh:driver:navigate'};
-  log.time(status);
-
   const session = driver.defaultSession;
   const networkMonitor = new NetworkMonitor(driver.defaultSession);
 
@@ -129,7 +125,6 @@ async function gotoURL(driver, url, options) {
     await waitForUserToContinue(driver);
   }
 
-  log.timeEnd(status);
   return {
     finalUrl,
     warnings: getNavigationWarnings({timedOut, finalUrl, requestedUrl: url}),

package/lighthouse-core/gather/driver/prepare.js

@@ -142,16 +142,11 @@ async function prepareDeviceEmulationAndAsyncStacks(driver, settings) {
  * @param {LH.Config.Settings} settings
  */
 async function prepareTargetForTimespanMode(driver, settings) {
-  const status = {msg: 'Preparing target for timespan mode', id: 'lh:prepare:timespanMode'};
-  log.time(status);
-
   await prepareDeviceEmulationAndAsyncStacks(driver, settings);
   await prepareThrottlingAndNetwork(driver.defaultSession, settings, {
     disableThrottling: false,
     blockedUrlPatterns: undefined,
   });
-
-  log.timeEnd(status);
 }
 
 /**
@@ -164,9 +159,6 @@ async function prepareTargetForTimespanMode(driver, settings) {
  * @param {LH.Config.Settings} settings
  */
 async function prepareTargetForNavigationMode(driver, settings) {
-  const status = {msg: 'Preparing target for navigation mode', id: 'lh:prepare:navigationMode'};
-  log.time(status);
-
   await prepareDeviceEmulationAndAsyncStacks(driver, settings);
 
   // Automatically handle any JavaScript dialogs to prevent a hung renderer.
@@ -179,8 +171,6 @@ async function prepareTargetForNavigationMode(driver, settings) {
   if (settings.throttlingMethod === 'simulate') {
     await shimRequestIdleCallbackOnNewDocument(driver, settings);
   }
-
-  log.timeEnd(status);
 }
 
 /**
@@ -194,9 +184,6 @@ async function prepareTargetForNavigationMode(driver, settings) {
  * @return {Promise<{warnings: Array<LH.IcuMessage>}>}
  */
 async function prepareTargetForIndividualNavigation(session, settings, navigation) {
-  const status = {msg: 'Preparing target for navigation', id: 'lh:prepare:navigation'};
-  log.time(status);
-
   /** @type {Array<LH.IcuMessage>} */
   const warnings = [];
 
@@ -208,7 +195,6 @@ async function prepareTargetForIndividualNavigation(session, settings, navigatio
 
   await prepareThrottlingAndNetwork(session, settings, navigation);
 
-  log.timeEnd(status);
   return {warnings};
 }
 

package/lighthouse-core/gather/driver/storage.js

@@ -33,9 +33,6 @@ const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
  * @return {Promise<void>}
  */
 async function clearDataForOrigin(session, url) {
-  const status = {msg: 'Cleaning origin data', id: 'lh:storage:clearDataForOrigin'};
-  log.time(status);
-
   const origin = new URL(url).origin;
 
   // Clear some types of storage.
@@ -66,8 +63,6 @@ async function clearDataForOrigin(session, url) {
     } else {
       throw err;
     }
-  } finally {
-    log.timeEnd(status);
   }
 }
 

package/lighthouse-core/gather/gather-runner.js

@@ -10,7 +10,7 @@ const NetworkRecords = require('../computed/network-records.js');
 const {getPageLoadError} = require('../lib/navigation-error.js');
 const emulation = require('../lib/emulation.js');
 const constants = require('../config/constants.js');
-const format = require('../../shared/localization/format.js');
+const i18n = require('../lib/i18n/i18n.js');
 const {getBenchmarkIndex, getEnvironmentWarnings} = require('./driver/environment.js');
 const prepare = require('./driver/prepare.js');
 const storage = require('./driver/storage.js');
@@ -574,7 +574,7 @@ class GatherRunner {
       networkRecords: loadData.networkRecords,
     });
     if (pageLoadError) {
-      const localizedMessage = format.getFormatted(pageLoadError.friendlyMessage,
+      const localizedMessage = i18n.getFormatted(pageLoadError.friendlyMessage,
           passContext.settings.locale);
       log.error('GatherRunner', localizedMessage, passContext.url);
 

package/lighthouse-core/gather/gatherers/dobetterweb/response-compression.js

@@ -20,11 +20,7 @@ const {fetchResponseBodyFromCache} = require('../../driver/network.js');
 const NetworkRecords = require('../../../computed/network-records.js');
 
 const CHROME_EXTENSION_PROTOCOL = 'chrome-extension:';
-const compressionHeaders = [
-  'content-encoding',
-  'x-original-content-encoding',
-  'x-content-encoding-over-network',
-];
+const compressionHeaders = ['content-encoding', 'x-original-content-encoding'];
 const compressionTypes = ['gzip', 'br', 'deflate'];
 const binaryMimeTypes = ['image', 'audio', 'video'];
 /** @type {LH.Crdp.Network.ResourceType[]} */

package/lighthouse-core/gather/gatherers/full-page-screenshot.js

@@ -22,26 +22,6 @@ function snakeCaseToCamelCase(str) {
   return str.replace(/(-\w)/g, m => m[1].toUpperCase());
 }
 
-/* c8 ignore start */
-
-// eslint-disable-next-line no-inner-declarations
-function getObservedDeviceMetrics() {
-  // Convert the Web API's snake case (landscape-primary) to camel case (landscapePrimary).
-  const screenOrientationType = /** @type {LH.Crdp.Emulation.ScreenOrientationType} */ (
-    snakeCaseToCamelCase(window.screen.orientation.type));
-  return {
-    width: document.documentElement.clientWidth,
-    height: document.documentElement.clientHeight,
-    screenOrientation: {
-      type: screenOrientationType,
-      angle: window.screen.orientation.angle,
-    },
-    deviceScaleFactor: window.devicePixelRatio,
-  };
-}
-
-/* c8 ignore stop */
-
 class FullPageScreenshot extends FRGatherer {
   /** @type {LH.Gatherer.GathererMeta} */
   meta = {
@@ -160,17 +140,9 @@ class FullPageScreenshot extends FRGatherer {
     const executionContext = context.driver.executionContext;
     const settings = context.settings;
 
-    // In case some other program is controlling emulation, remember what the device looks
+    // In case some other program is controlling emulation, try to remember what the device looks
     // like now and reset after gatherer is done.
-    let observedDeviceMetrics;
     const lighthouseControlsEmulation = !settings.screenEmulation.disabled;
-    if (!lighthouseControlsEmulation) {
-      observedDeviceMetrics = await executionContext.evaluate(getObservedDeviceMetrics, {
-        args: [],
-        useIsolation: true,
-        deps: [snakeCaseToCamelCase],
-      });
-    }
 
     try {
       return {
@@ -181,7 +153,7 @@ class FullPageScreenshot extends FRGatherer {
       // Revert resized page.
       if (lighthouseControlsEmulation) {
         await emulation.emulate(session, settings);
-      } else if (observedDeviceMetrics) {
+      } else {
         // Best effort to reset emulation to what it was.
         // https://github.com/GoogleChrome/lighthouse/pull/10716#discussion_r428970681
         // TODO: seems like this would be brittle. Should at least work for devtools, but what
@@ -189,6 +161,28 @@ class FullPageScreenshot extends FRGatherer {
         // in the LH runner api, which for ex. puppeteer consumers would setup puppeteer emulation,
         // and then just call that to reset?
         // https://github.com/GoogleChrome/lighthouse/issues/11122
+
+        // eslint-disable-next-line no-inner-declarations
+        function getObservedDeviceMetrics() {
+          // Convert the Web API's snake case (landscape-primary) to camel case (landscapePrimary).
+          const screenOrientationType = /** @type {LH.Crdp.Emulation.ScreenOrientationType} */ (
+            snakeCaseToCamelCase(window.screen.orientation.type));
+          return {
+            width: document.documentElement.clientWidth,
+            height: document.documentElement.clientHeight,
+            screenOrientation: {
+              type: screenOrientationType,
+              angle: window.screen.orientation.angle,
+            },
+            deviceScaleFactor: window.devicePixelRatio,
+          };
+        }
+
+        const observedDeviceMetrics = await executionContext.evaluate(getObservedDeviceMetrics, {
+          args: [],
+          useIsolation: true,
+          deps: [snakeCaseToCamelCase],
+        });
         await session.sendCommand('Emulation.setDeviceMetricsOverride', {
           mobile: settings.formFactor === 'mobile',
           ...observedDeviceMetrics,

package/{shared/localization/i18n-module.js → lighthouse-core/lib/cdt/Common.js}

@@ -1,9 +1,14 @@
 /**
- * @license Copyright 2021 Google Inc. All Rights Reserved.
+ * @license Copyright 2020 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';
 
-module.exports.swapLocale = require('./swap-locale.js');
-module.exports.format = require('./format.js');
+/** @fileoverview Needed for the generated/SourceMap.js file */
+
+const Common = {
+  console,
+};
+
+module.exports = Common;

package/lighthouse-core/lib/cdt/SDK.js

@@ -4,25 +4,145 @@
  * 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 SDK = {
   TextSourceMap: require('./generated/SourceMap.js'),
 };
 
+/**
+ * CDT pollutes Array.prototype w/ `lowerBound/upperBound`. SourceMap
+ * relies on this, but only for a couple method return values. To avoid global pollution,
+ * we explicitly set the extension functions on the return values.
+ *
+ * @param {unknown[]} array
+ */
+function extendArray(array) {
+  // @ts-expect-error
+  if (array.lowerBound) return;
+
+  // @ts-expect-error
+  array.lowerBound = lowerBound.bind(array);
+  // @ts-expect-error
+  array.upperBound = upperBound.bind(array);
+
+  array.slice = function(start, end) {
+    const retVal = Array.prototype.slice.call(array, start, end);
+    extendArray(retVal);
+    return retVal;
+  };
+  // @ts-expect-error
+  array.filter = function(fn) {
+    const retVal = Array.prototype.filter.call(array, fn);
+    extendArray(retVal);
+    return retVal;
+  };
+}
+
+const originalMappings = SDK.TextSourceMap.prototype.mappings;
+SDK.TextSourceMap.prototype.mappings = function() {
+  const mappings = originalMappings.call(this);
+  extendArray(mappings);
+  return mappings;
+};
+
+const originalReversedMappings = SDK.TextSourceMap.prototype._reversedMappings;
+/** @param {string} sourceURL */
+SDK.TextSourceMap.prototype._reversedMappings = function(sourceURL) {
+  const mappings = originalReversedMappings.call(this, sourceURL);
+  extendArray(mappings);
+  return mappings;
+};
+
+/**
+ * `upperBound` and `lowerBound` are copied from CDT utilities.js.
+ * These are the only methods needed from that file.
+ */
+
+/**
+ * Return index of the leftmost element that is greater
+ * than the specimen object. If there's no such element (i.e. all
+ * elements are smaller or equal to the specimen) returns right bound.
+ * The function works for sorted array.
+ * When specified, |left| (inclusive) and |right| (exclusive) indices
+ * define the search window.
+ *
+ * @param {!T} object
+ * @param {function(!T,!S):number=} comparator
+ * @param {number=} left
+ * @param {number=} right
+ * @return {number}
+ * @this {Array.<!S>}
+ * @template T,S
+ */
+function upperBound(object, comparator, left, right) {
+  // @ts-expect-error
+  function defaultComparator(a, b) {
+    return a < b ? -1 : (a > b ? 1 : 0);
+  }
+  comparator = comparator || defaultComparator;
+  let l = left || 0;
+  let r = right !== undefined ? right : this.length;
+  while (l < r) {
+    const m = (l + r) >> 1;
+    if (comparator(object, this[m]) >= 0) {
+      l = m + 1;
+    } else {
+      r = m;
+    }
+  }
+  return r;
+}
+
+/**
+ * Return index of the leftmost element that is equal or greater
+ * than the specimen object. If there's no such element (i.e. all
+ * elements are smaller than the specimen) returns right bound.
+ * The function works for sorted array.
+ * When specified, |left| (inclusive) and |right| (exclusive) indices
+ * define the search window.
+ *
+ * @param {!T} object
+ * @param {function(!T,!S):number=} comparator
+ * @param {number=} left
+ * @param {number=} right
+ * @return {number}
+ * @this {Array.<!S>}
+ * @template T,S
+ */
+function lowerBound(object, comparator, left, right) {
+  // @ts-expect-error
+  function defaultComparator(a, b) {
+    return a < b ? -1 : (a > b ? 1 : 0);
+  }
+  comparator = comparator || defaultComparator;
+  let l = left || 0;
+  let r = right !== undefined ? right : this.length;
+  while (l < r) {
+    const m = (l + r) >> 1;
+    if (comparator(object, this[m]) > 0) {
+      l = m + 1;
+    } else {
+      r = m;
+    }
+  }
+  return r;
+}
+
 // Add `lastColumnNumber` to mappings. This will eventually be added to CDT.
 // @ts-expect-error
 SDK.TextSourceMap.prototype.computeLastGeneratedColumns = function() {
   const mappings = this.mappings();
-  if (mappings.length && mappings[0].lastColumnNumber !== undefined) return;
+  // @ts-expect-error: `lastColumnNumber` is not on types yet.
+  if (mappings.length && typeof mappings[0].lastColumnNumber !== 'undefined') return;
 
   for (let i = 0; i < mappings.length - 1; i++) {
     const mapping = mappings[i];
     const nextMapping = mappings[i + 1];
     if (mapping.lineNumber === nextMapping.lineNumber) {
+      // @ts-expect-error: `lastColumnNumber` is not on types yet.
       mapping.lastColumnNumber = nextMapping.columnNumber;
     }
   }
-
-  // Now, all but the last mapping on each line will have 'lastColumnNumber' set to a number.
 };
 
 module.exports = SDK;