lighthouse 9.4.0-dev.20220228 → 9.4.0-dev.20220301

package/lighthouse-cli/test/smokehouse/core-tests.js

@@ -33,6 +33,7 @@ import offlineReady from './test-definitions/offline-ready.js';
 import offlineSwBroken from './test-definitions/offline-sw-broken.js';
 import offlineSwSlow from './test-definitions/offline-sw-slow.js';
 import oopifRequests from './test-definitions/oopif-requests.js';
+import oopifScripts from './test-definitions/oopif-scripts.js';
 import perfBudgets from './test-definitions/perf-budgets.js';
 import perfDebug from './test-definitions/perf-debug.js';
 import perfDiagnosticsAnimations from './test-definitions/perf-diagnostics-animations.js';
@@ -92,6 +93,7 @@ const smokeTests = [
   offlineSwBroken,
   offlineSwSlow,
   oopifRequests,
+  oopifScripts,
   perfBudgets,
   perfDebug,
   perfDiagnosticsAnimations,

package/lighthouse-cli/test/smokehouse/frontends/lib.js

@@ -13,11 +13,13 @@
 
 /* eslint-disable no-console */
 
-import cloneDeep from 'lodash.clonedeep';
+import _ from 'lodash';
 
 import smokeTests from '../core-tests.js';
 import {runSmokehouse, getShardedDefinitions} from '../smokehouse.js';
 
+const {cloneDeep} = _;
+
 /**
  * @param {Smokehouse.SmokehouseLibOptions} options
  */

package/lighthouse-cli/test/smokehouse/frontends/smokehouse-bin.js

@@ -17,7 +17,7 @@ import path from 'path';
 import fs from 'fs';
 import url from 'url';
 
-import cloneDeep from 'lodash.clonedeep';
+import _ from 'lodash';
 import yargs from 'yargs';
 import * as yargsHelpers from 'yargs/helpers';
 import log from 'lighthouse-logger';
@@ -26,6 +26,8 @@ import {runSmokehouse, getShardedDefinitions} from '../smokehouse.js';
 import {updateTestDefnFormat} from './back-compat-util.js';
 import {LH_ROOT} from '../../../../root.js';
 
+const {cloneDeep} = _;
+
 const coreTestDefnsPath =
   path.join(LH_ROOT, 'lighthouse-cli/test/smokehouse/core-tests.js');
 

package/lighthouse-cli/test/smokehouse/report-assert.js

@@ -10,11 +10,13 @@
  * against the results actually collected from Lighthouse.
  */
 
-import cloneDeep from 'lodash.clonedeep';
+import _ from 'lodash';
 import log from 'lighthouse-logger';
 
 import {LocalConsole} from './lib/local-console.js';
 
+const {cloneDeep} = _;
+
 /**
  * @typedef Difference
  * @property {string} path

package/lighthouse-core/config/config-helpers.js

@@ -6,7 +6,7 @@
 'use strict';
 
 const path = require('path');
-const isDeepEqual = require('lodash.isequal');
+const {isEqual: isDeepEqual} = require('lodash');
 const constants = require('./constants.js');
 const Budget = require('./budget.js');
 const ConfigPlugin = require('./config-plugin.js');

package/lighthouse-core/fraggle-rock/api.js

@@ -5,9 +5,11 @@
  */
 'use strict';
 
-const {snapshot} = require('./gather/snapshot-runner.js');
-const {startTimespan} = require('./gather/timespan-runner.js');
-const {navigation} = require('./gather/navigation-runner.js');
+const {snapshotGather} = require('./gather/snapshot-runner.js');
+const {startTimespanGather} = require('./gather/timespan-runner.js');
+const {navigationGather} = require('./gather/navigation-runner.js');
+const {generateFlowReportHtml} = require('../../report/generator/report-generator.js');
+const Runner = require('../runner.js');
 const UserFlow = require('./user-flow.js');
 
 /**
@@ -18,9 +20,48 @@ async function startFlow(page, options) {
   return new UserFlow(page, options);
 }
 
+/**
+ * @param  {Parameters<navigationGather>} params
+ * @return {Promise<LH.RunnerResult|undefined>}
+ */
+async function navigation(...params) {
+  const gatherResult = await navigationGather(...params);
+  return Runner.audit(gatherResult.artifacts, gatherResult.runnerOptions);
+}
+
+/**
+ * @param  {Parameters<snapshotGather>} params
+ * @return {Promise<LH.RunnerResult|undefined>}
+ */
+async function snapshot(...params) {
+  const gatherResult = await snapshotGather(...params);
+  return Runner.audit(gatherResult.artifacts, gatherResult.runnerOptions);
+}
+
+/**
+ * @param  {Parameters<startTimespanGather>} params
+ * @return {Promise<{endTimespan: () => Promise<LH.RunnerResult|undefined>}>}
+ */
+async function startTimespan(...params) {
+  const {endTimespanGather} = await startTimespanGather(...params);
+  const endTimespan = async () => {
+    const gatherResult = await endTimespanGather();
+    return Runner.audit(gatherResult.artifacts, gatherResult.runnerOptions);
+  };
+  return {endTimespan};
+}
+
+/**
+ * @param {LH.FlowResult} flowResult
+ */
+async function generateFlowReport(flowResult) {
+  return generateFlowReportHtml(flowResult);
+}
+
 module.exports = {
   snapshot,
   startTimespan,
   navigation,
   startFlow,
+  generateFlowReport,
 };

package/lighthouse-core/fraggle-rock/gather/base-artifacts.js

@@ -6,7 +6,7 @@
 'use strict';
 
 const log = require('lighthouse-logger');
-const isEqual = require('lodash.isequal');
+const {isEqual} = require('lodash');
 const {
   getBrowserVersion,
   getBenchmarkIndex,

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

@@ -290,9 +290,9 @@ async function _cleanup({requestedUrl, driver, config}) {
 /**
  * @param {LH.NavigationRequestor} requestor
  * @param {{page: import('puppeteer').Page, config?: LH.Config.Json, configContext?: LH.Config.FRContext}} options
- * @return {Promise<LH.RunnerResult|undefined>}
+ * @return {Promise<LH.Gatherer.FRGatherResult>}
  */
-async function navigation(requestor, options) {
+async function navigationGather(requestor, options) {
   const {page, configContext = {}} = options;
   log.setLevel(configContext.logLevel || 'error');
 
@@ -325,11 +325,11 @@ async function navigation(requestor, options) {
     },
     runnerOptions
   );
-  return Runner.audit(artifacts, runnerOptions);
+  return {artifacts, runnerOptions};
 }
 
 module.exports = {
-  navigation,
+  navigationGather,
   _setup,
   _setupNavigation,
   _navigate,

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

@@ -16,8 +16,11 @@ const {
 const {initializeConfig} = require('../config/config.js');
 const {getBaseArtifacts, finalizeArtifacts} = require('./base-artifacts.js');
 
-/** @param {{page: import('puppeteer').Page, config?: LH.Config.Json, configContext?: LH.Config.FRContext}} options */
-async function snapshot(options) {
+/**
+ * @param {{page: import('puppeteer').Page, config?: LH.Config.Json, configContext?: LH.Config.FRContext}} options
+ * @return {Promise<LH.Gatherer.FRGatherResult>}
+ */
+async function snapshotGather(options) {
   const {configContext = {}} = options;
   log.setLevel(configContext.logLevel || 'error');
 
@@ -57,9 +60,9 @@ async function snapshot(options) {
     },
     runnerOptions
   );
-  return Runner.audit(artifacts, runnerOptions);
+  return {artifacts, runnerOptions};
 }
 
 module.exports = {
-  snapshot,
+  snapshotGather,
 };

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

@@ -19,9 +19,9 @@ const {getBaseArtifacts, finalizeArtifacts} = require('./base-artifacts.js');
 
 /**
  * @param {{page: import('puppeteer').Page, config?: LH.Config.Json, configContext?: LH.Config.FRContext}} options
- * @return {Promise<{endTimespan(): Promise<LH.RunnerResult|undefined>}>}
+ * @return {Promise<{endTimespanGather(): Promise<LH.Gatherer.FRGatherResult>}>}
  */
-async function startTimespan(options) {
+async function startTimespanGather(options) {
   const {configContext = {}} = options;
   log.setLevel(configContext.logLevel || 'error');
 
@@ -52,7 +52,7 @@ async function startTimespan(options) {
   await collectPhaseArtifacts({phase: 'startSensitiveInstrumentation', ...phaseOptions});
 
   return {
-    async endTimespan() {
+    async endTimespanGather() {
       const finalUrl = await driver.url();
       phaseOptions.url = finalUrl;
 
@@ -72,11 +72,11 @@ async function startTimespan(options) {
         },
         runnerOptions
       );
-      return Runner.audit(artifacts, runnerOptions);
+      return {artifacts, runnerOptions};
     },
   };
 }
 
 module.exports = {
-  startTimespan,
+  startTimespanGather,
 };

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

@@ -6,13 +6,15 @@
 '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 {snapshotGather} = require('./gather/snapshot-runner.js');
+const {startTimespanGather} = require('./gather/timespan-runner.js');
+const {navigationGather} = require('./gather/navigation-runner.js');
+const Runner = require('../runner.js');
 
-/** @typedef {Parameters<snapshot>[0]} FrOptions */
+/** @typedef {Parameters<snapshotGather>[0]} FrOptions */
 /** @typedef {Omit<FrOptions, 'page'> & {name?: string}} UserFlowOptions */
 /** @typedef {Omit<FrOptions, 'page'> & {stepName?: string}} StepOptions */
+/** @typedef {{gatherResult: LH.Gatherer.FRGatherResult, name: string}} StepArtifact */
 
 class UserFlow {
   /**
@@ -24,8 +26,8 @@ class UserFlow {
     this.options = {page, ...options};
     /** @type {string|undefined} */
     this.name = options?.name;
-    /** @type {LH.FlowResult.Step[]} */
-    this.steps = [];
+    /** @type {StepArtifact[]} */
+    this.stepArtifacts = [];
   }
 
   /**
@@ -38,12 +40,12 @@ class UserFlow {
   }
 
   /**
-   * @param {LH.Result} lhr
+   * @param {LH.Artifacts} artifacts
    * @return {string}
    */
-  _getDefaultStepName(lhr) {
-    const shortUrl = this._shortenUrl(lhr.finalUrl);
-    switch (lhr.gatherMode) {
+  _getDefaultStepName(artifacts) {
+    const shortUrl = this._shortenUrl(artifacts.URL.finalUrl);
+    switch (artifacts.GatherContext.gatherMode) {
       case 'navigation':
         return `Navigation report (${shortUrl})`;
       case 'timespan':
@@ -66,7 +68,8 @@ class UserFlow {
     }
 
     // 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');
+    const isSubsequentNavigation = this.stepArtifacts
+      .some(step => step.gatherResult.artifacts.GatherContext.gatherMode === 'navigation');
     if (isSubsequentNavigation) {
       if (settingsOverrides.disableStorageReset === undefined) {
         settingsOverrides.disableStorageReset = true;
@@ -84,85 +87,93 @@ class UserFlow {
    * @param {StepOptions=} stepOptions
    */
   async navigate(requestor, stepOptions) {
-    if (this.currentTimespan) throw Error('Timespan already in progress');
+    if (this.currentTimespan) throw new Error('Timespan already in progress');
 
-    const result = await navigation(
+    const gatherResult = await navigationGather(
       requestor,
       this._getNextNavigationOptions(stepOptions)
     );
-    if (!result) throw Error('Navigation returned undefined');
 
     const providedName = stepOptions?.stepName;
-    this.steps.push({
-      lhr: result.lhr,
-      name: providedName || this._getDefaultStepName(result.lhr),
+    this.stepArtifacts.push({
+      gatherResult,
+      name: providedName || this._getDefaultStepName(gatherResult.artifacts),
     });
 
-    return result;
+    return gatherResult;
   }
 
   /**
    * @param {StepOptions=} stepOptions
    */
   async startTimespan(stepOptions) {
-    if (this.currentTimespan) throw Error('Timespan already in progress');
+    if (this.currentTimespan) throw new Error('Timespan already in progress');
 
     const options = {...this.options, ...stepOptions};
-    const timespan = await startTimespan(options);
+    const timespan = await startTimespanGather(options);
     this.currentTimespan = {timespan, options};
   }
 
   async endTimespan() {
-    if (!this.currentTimespan) throw Error('No timespan in progress');
+    if (!this.currentTimespan) throw new Error('No timespan in progress');
 
     const {timespan, options} = this.currentTimespan;
-    const result = await timespan.endTimespan();
+    const gatherResult = await timespan.endTimespanGather();
     this.currentTimespan = undefined;
-    if (!result) throw Error('Timespan returned undefined');
 
     const providedName = options?.stepName;
-    this.steps.push({
-      lhr: result.lhr,
-      name: providedName || this._getDefaultStepName(result.lhr),
+    this.stepArtifacts.push({
+      gatherResult,
+      name: providedName || this._getDefaultStepName(gatherResult.artifacts),
     });
 
-    return result;
+    return gatherResult;
   }
 
   /**
    * @param {StepOptions=} stepOptions
    */
   async snapshot(stepOptions) {
-    if (this.currentTimespan) throw Error('Timespan already in progress');
+    if (this.currentTimespan) throw new Error('Timespan already in progress');
 
     const options = {...this.options, ...stepOptions};
-    const result = await snapshot(options);
-    if (!result) throw Error('Snapshot returned undefined');
+    const gatherResult = await snapshotGather(options);
 
     const providedName = stepOptions?.stepName;
-    this.steps.push({
-      lhr: result.lhr,
-      name: providedName || this._getDefaultStepName(result.lhr),
+    this.stepArtifacts.push({
+      gatherResult,
+      name: providedName || this._getDefaultStepName(gatherResult.artifacts),
     });
 
-    return result;
+    return gatherResult;
   }
 
   /**
-   * @return {LH.FlowResult}
+   * @returns {Promise<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};
+  async createFlowResult() {
+    if (!this.stepArtifacts.length) {
+      throw new Error('Need at least one step before getting the result');
+    }
+    const url = new URL(this.stepArtifacts[0].gatherResult.artifacts.URL.finalUrl);
+    const flowName = this.name || `User flow (${url.hostname})`;
+
+    /** @type {LH.FlowResult['steps']} */
+    const steps = [];
+    for (const {gatherResult, name} of this.stepArtifacts) {
+      const result = await Runner.audit(gatherResult.artifacts, gatherResult.runnerOptions);
+      if (!result) throw new Error(`Step "${name}" did not return a result`);
+      steps.push({lhr: result.lhr, name});
+    }
+
+    return {steps, name: flowName};
   }
 
   /**
-   * @return {string}
+   * @return {Promise<string>}
    */
-  generateReport() {
-    const flowResult = this.getFlowResult();
+  async generateReport() {
+    const flowResult = await this.createFlowResult();
     return generateFlowReportHtml(flowResult);
   }
 }

package/lighthouse-core/lib/arbitrary-equality-map.js

@@ -5,7 +5,7 @@
  */
 'use strict';
 
-const isEqual = require('lodash.isequal');
+const {isEqual} = require('lodash');
 
 /**
  * @fileoverview This class is designed to allow maps with arbitrary equality functions.

package/lighthouse-core/runner.js

@@ -5,7 +5,7 @@
  */
 'use strict';
 
-const isDeepEqual = require('lodash.isequal');
+const {isEqual: isDeepEqual} = require('lodash');
 const Driver = require('./gather/driver.js');
 const GatherRunner = require('./gather/gather-runner.js');
 const ReportScoring = require('./scoring.js');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lighthouse",
-  "version": "9.4.0-dev.20220228",
+  "version": "9.4.0-dev.20220301",
   "description": "Automated auditing, performance metrics, and best practices for the web.",
   "main": "./lighthouse-core/index.js",
   "bin": {
@@ -115,10 +115,7 @@
     "@types/jest": "^27.0.3",
     "@types/jpeg-js": "^0.3.7",
     "@types/jsdom": "^16.2.13",
-    "@types/lodash.clonedeep": "^4.5.6",
-    "@types/lodash.get": "^4.4.6",
-    "@types/lodash.isequal": "^4.5.2",
-    "@types/lodash.set": "^4.3.6",
+    "@types/lodash": "^4.14.178",
     "@types/node": "*",
     "@types/pako": "^1.0.1",
     "@types/resize-observer-browser": "^0.1.1",
@@ -195,10 +192,7 @@
     "js-library-detector": "^6.4.0",
     "lighthouse-logger": "^1.3.0",
     "lighthouse-stack-packs": "^1.7.0",
-    "lodash.clonedeep": "^4.5.0",
-    "lodash.get": "^4.4.2",
-    "lodash.isequal": "^4.5.0",
-    "lodash.set": "^4.3.2",
+    "lodash": "^4.17.21",
     "lookup-closest-locale": "6.2.0",
     "metaviewport-parser": "0.2.0",
     "open": "^8.4.0",

package/shared/localization/swap-locale.js

@@ -5,8 +5,7 @@
  */
 'use strict';
 
-const _set = require('lodash.set');
-const _get = require('lodash.get');
+const {set: _set, get: _get} = require('lodash');
 
 const format = require('./format.js');
 

package/types/gatherer.d.ts

@@ -62,6 +62,14 @@ declare module Gatherer {
     settings: Config.Settings;
   }
 
+  interface FRGatherResult {
+    artifacts: Artifacts;
+    runnerOptions: {
+      config: Config.FRConfig;
+      computedCache: Map<string, ArbitraryEqualityMap>
+    }
+  }
+
   interface PassContext {
     gatherMode: 'navigation';
     /** The url of the currently loaded page. If the main document redirects, this will be updated to keep track. */