lighthouse 9.5.0-dev.20220628 → 9.5.0-dev.20220701

package/lighthouse-cli/run.js

@@ -250,7 +250,7 @@ async function runLighthouse(url, flags, config) {
     if (runnerResult?.lhr.runtimeError) {
       const {runtimeError} = runnerResult.lhr;
       return printErrorAndExit({
-        name: 'LHError',
+        name: 'LighthouseError',
         friendlyMessage: runtimeError.message,
         code: runtimeError.code,
         message: runtimeError.message,

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

@@ -6,8 +6,8 @@
 
 /* eslint-disable no-control-regex */
 
+import {readJson} from '../../../lighthouse-core/test/test-utils.js';
 import {findDifferences, getAssertionReport} from './report-assert.js';
-import {readJson} from '../../../root.js';
 
 describe('findDiffersences', () => {
   const testCases = {

package/lighthouse-core/audits/byte-efficiency/uses-responsive-images.js

@@ -33,6 +33,9 @@ const str_ = i18n.createMessageInstanceIdFn(__filename, UIStrings);
 
 const IGNORE_THRESHOLD_IN_BYTES = 4096;
 
+// Ignore up to 12KB of waste if an effort was made with breakpoints.
+const IGNORE_THRESHOLD_IN_BYTES_BREAKPOINTS_PRESENT = 12288;
+
 class UsesResponsiveImages extends ByteEfficiencyAudit {
   /**
    * @return {LH.Audit.Meta}
@@ -112,6 +115,18 @@ class UsesResponsiveImages extends ByteEfficiencyAudit {
     };
   }
 
+
+  /**
+   * @param {LH.Artifacts.ImageElement} image
+   * @return {number};
+   */
+  static determineAllowableWaste(image) {
+    if (image.srcset || image.isPicture) {
+      return IGNORE_THRESHOLD_IN_BYTES_BREAKPOINTS_PRESENT;
+    }
+    return IGNORE_THRESHOLD_IN_BYTES;
+  }
+
   /**
    * @param {LH.Artifacts} artifacts
    * @param {Array<LH.Artifacts.NetworkRequest>} networkRecords
@@ -126,6 +141,8 @@ class UsesResponsiveImages extends ByteEfficiencyAudit {
     const ViewportDimensions = artifacts.ViewportDimensions;
     /** @type {Map<string, LH.Audit.ByteEfficiencyItem>} */
     const resultsMap = new Map();
+    /** @type {Array<string>} */
+    const passedImageList = [];
     for (const image of images) {
       // Give SVG a free pass because creating a "responsive" SVG is of questionable value.
       // Ignore CSS images because it's difficult to determine what is a spritesheet,
@@ -147,15 +164,23 @@ class UsesResponsiveImages extends ByteEfficiencyAudit {
         );
       if (!processed) continue;
 
-      // Don't warn about an image that was later used appropriately
+      // Verify the image wastes more than the minimum.
+      const exceedsAllowableWaste = processed.wastedBytes > this.determineAllowableWaste(image);
+
       const existing = resultsMap.get(processed.url);
-      if (!existing || existing.wastedBytes > processed.wastedBytes) {
-        resultsMap.set(processed.url, processed);
+      // Don't warn about an image that was later used appropriately, or wastes a trivial amount of data.
+      if (exceedsAllowableWaste && !passedImageList.includes(processed.url)) {
+        if ((!existing || existing.wastedBytes > processed.wastedBytes)) {
+          resultsMap.set(processed.url, processed);
+        }
+      } else {
+        // Ensure this url passes for future tests.
+        resultsMap.delete(processed.url);
+        passedImageList.push(processed.url);
       }
     }
 
-    const items = Array.from(resultsMap.values())
-        .filter(item => item.wastedBytes > IGNORE_THRESHOLD_IN_BYTES);
+    const items = Array.from(resultsMap.values());
 
     /** @type {LH.Audit.Details.Opportunity['headings']} */
     const headings = [

package/lighthouse-core/audits/final-screenshot.js

@@ -6,7 +6,7 @@
 'use strict';
 
 const Audit = require('./audit.js');
-const LHError = require('../lib/lh-error.js');
+const LighthouseError = require('../lib/lh-error.js');
 const ProcessedTrace = require('../computed/processed-trace.js');
 const Screenshots = require('../computed/screenshots.js');
 
@@ -41,7 +41,7 @@ class FinalScreenshot extends Audit {
       if (artifacts.GatherContext.gatherMode === 'timespan') return {notApplicable: true, score: 1};
 
       // If it was another mode, that's a fatal error.
-      throw new LHError(LHError.errors.NO_SCREENSHOTS);
+      throw new LighthouseError(LighthouseError.errors.NO_SCREENSHOTS);
     }
 
     return {

package/lighthouse-core/audits/screenshot-thumbnails.js

@@ -6,7 +6,7 @@
 'use strict';
 
 const Audit = require('./audit.js');
-const LHError = require('../lib/lh-error.js');
+const LighthouseError = require('../lib/lh-error.js');
 const jpeg = require('jpeg-js');
 const Speedline = require('../computed/speedline.js');
 
@@ -88,7 +88,7 @@ class ScreenshotThumbnails extends Audit {
     const timelineEnd = Math.max(maxFrameTime, minimumTimelineDuration);
 
     if (!analyzedFrames.length || !Number.isFinite(timelineEnd)) {
-      throw new LHError(LHError.errors.INVALID_SPEEDLINE);
+      throw new LighthouseError(LighthouseError.errors.INVALID_SPEEDLINE);
     }
 
     for (let i = 1; i <= NUMBER_OF_THUMBNAILS; i++) {
@@ -144,10 +144,10 @@ class ScreenshotThumbnails extends Audit {
       return await this._audit(artifacts, context);
     } catch (err) {
       const noFramesErrors = new Set([
-        LHError.errors.NO_SCREENSHOTS.code,
-        LHError.errors.SPEEDINDEX_OF_ZERO.code,
-        LHError.errors.NO_SPEEDLINE_FRAMES.code,
-        LHError.errors.INVALID_SPEEDLINE.code,
+        LighthouseError.errors.NO_SCREENSHOTS.code,
+        LighthouseError.errors.SPEEDINDEX_OF_ZERO.code,
+        LighthouseError.errors.NO_SPEEDLINE_FRAMES.code,
+        LighthouseError.errors.INVALID_SPEEDLINE.code,
       ]);
 
       // If a timespan didn't happen to contain frames, that's fine. Just mark not applicable.

package/lighthouse-core/audits/work-during-interaction.js

@@ -15,7 +15,7 @@ const {taskGroups} = require('../lib/tracehouse/task-groups.js');
 const TraceProcessor = require('../lib/tracehouse/trace-processor.js');
 const {getExecutionTimingsByURL} = require('../lib/tracehouse/task-summary.js');
 const inpThresholds = require('./metrics/experimental-interaction-to-next-paint.js').defaultOptions;
-const LHError = require('../lib/lh-error.js');
+const LighthouseError = require('../lib/lh-error.js');
 
 /** @typedef {import('../computed/metrics/responsiveness.js').EventTimingEvent} EventTimingEvent */
 /** @typedef {import('../lib/tracehouse/main-thread-tasks.js').TaskNode} TaskNode */
@@ -237,8 +237,8 @@ class WorkDuringInteraction extends Audit {
     }
     // TODO: remove workaround once 103.0.5052.0 is sufficiently released.
     if (interactionEvent.name === 'FallbackTiming') {
-      throw new LHError(
-        LHError.errors.UNSUPPORTED_OLD_CHROME,
+      throw new LighthouseError(
+        LighthouseError.errors.UNSUPPORTED_OLD_CHROME,
         {featureName: 'detailed EventTiming trace events'}
       );
     }

package/lighthouse-core/computed/metrics/cumulative-layout-shift.js

@@ -7,7 +7,7 @@
 
 const makeComputedArtifact = require('../computed-artifact.js');
 const ProcessedTrace = require('../processed-trace.js');
-const LHError = require('../../lib/lh-error.js');
+const LighthouseError = require('../../lib/lh-error.js');
 
 /** @typedef {{ts: number, isMainFrame: boolean, weightedScore: number}} LayoutShiftEvent */
 
@@ -40,8 +40,8 @@ class CumulativeLayoutShift {
       // For all-frames CLS calculation, we rely on `weighted_score_delta`, which
       // was added in Chrome 90: https://crbug.com/1173139
       if (event.args.data.weighted_score_delta === undefined) {
-        throw new LHError(
-          LHError.errors.UNSUPPORTED_OLD_CHROME,
+        throw new LighthouseError(
+          LighthouseError.errors.UNSUPPORTED_OLD_CHROME,
           {featureName: 'Cumulative Layout Shift'}
         );
       }

package/lighthouse-core/computed/metrics/first-meaningful-paint.js

@@ -7,7 +7,7 @@
 
 const makeComputedArtifact = require('../computed-artifact.js');
 const NavigationMetric = require('./navigation-metric.js');
-const LHError = require('../../lib/lh-error.js');
+const LighthouseError = require('../../lib/lh-error.js');
 const LanternFirstMeaningfulPaint = require('./lantern-first-meaningful-paint.js');
 
 class FirstMeaningfulPaint extends NavigationMetric {
@@ -28,7 +28,7 @@ class FirstMeaningfulPaint extends NavigationMetric {
   static async computeObservedMetric(data) {
     const {processedNavigation} = data;
     if (processedNavigation.timings.firstMeaningfulPaint === undefined) {
-      throw new LHError(LHError.errors.NO_FMP);
+      throw new LighthouseError(LighthouseError.errors.NO_FMP);
     }
 
     return {

package/lighthouse-core/computed/metrics/interactive.js

@@ -11,7 +11,7 @@ const LanternInteractive = require('./lantern-interactive.js');
 
 const NetworkMonitor = require('../../gather/driver/network-monitor.js');
 const TracingProcessor = require('../../lib/tracehouse/trace-processor.js');
-const LHError = require('../../lib/lh-error.js');
+const LighthouseError = require('../../lib/lh-error.js');
 
 const REQUIRED_QUIET_WINDOW = 5000;
 const ALLOWED_CONCURRENT_REQUESTS = 2;
@@ -133,10 +133,10 @@ class Interactive extends NavigationMetric {
       }
     }
 
-    throw new LHError(
+    throw new LighthouseError(
       cpuCandidate
-        ? LHError.errors.NO_TTI_NETWORK_IDLE_PERIOD
-        : LHError.errors.NO_TTI_CPU_IDLE_PERIOD
+        ? LighthouseError.errors.NO_TTI_NETWORK_IDLE_PERIOD
+        : LighthouseError.errors.NO_TTI_CPU_IDLE_PERIOD
     );
   }
 
@@ -158,7 +158,7 @@ class Interactive extends NavigationMetric {
     const {processedTrace, processedNavigation, networkRecords} = data;
 
     if (!processedNavigation.timestamps.domContentLoaded) {
-      throw new LHError(LHError.errors.NO_DCL);
+      throw new LighthouseError(LighthouseError.errors.NO_DCL);
     }
 
     const longTasks = TracingProcessor.getMainThreadTopLevelEvents(processedTrace)

package/lighthouse-core/computed/metrics/lantern-first-meaningful-paint.js

@@ -7,7 +7,7 @@
 
 const makeComputedArtifact = require('../computed-artifact.js');
 const LanternMetric = require('./lantern-metric.js');
-const LHError = require('../../lib/lh-error.js');
+const LighthouseError = require('../../lib/lh-error.js');
 const LanternFirstContentfulPaint = require('./lantern-first-contentful-paint.js');
 
 /** @typedef {import('../../lib/dependency-graph/base-node.js').Node} Node */
@@ -32,7 +32,7 @@ class LanternFirstMeaningfulPaint extends LanternMetric {
   static getOptimisticGraph(dependencyGraph, processedNavigation) {
     const fmp = processedNavigation.timestamps.firstMeaningfulPaint;
     if (!fmp) {
-      throw new LHError(LHError.errors.NO_FMP);
+      throw new LighthouseError(LighthouseError.errors.NO_FMP);
     }
 
     return LanternFirstContentfulPaint.getFirstPaintBasedGraph(
@@ -52,7 +52,7 @@ class LanternFirstMeaningfulPaint extends LanternMetric {
   static getPessimisticGraph(dependencyGraph, processedNavigation) {
     const fmp = processedNavigation.timestamps.firstMeaningfulPaint;
     if (!fmp) {
-      throw new LHError(LHError.errors.NO_FMP);
+      throw new LighthouseError(LighthouseError.errors.NO_FMP);
     }
 
     return LanternFirstContentfulPaint.getFirstPaintBasedGraph(

package/lighthouse-core/computed/metrics/lantern-largest-contentful-paint.js

@@ -7,7 +7,7 @@
 
 const makeComputedArtifact = require('../computed-artifact.js');
 const LanternMetric = require('./lantern-metric.js');
-const LHError = require('../../lib/lh-error.js');
+const LighthouseError = require('../../lib/lh-error.js');
 const LanternFirstContentfulPaint = require('./lantern-first-contentful-paint.js');
 
 /** @typedef {import('../../lib/dependency-graph/base-node.js').Node} Node */
@@ -47,7 +47,7 @@ class LanternLargestContentfulPaint extends LanternMetric {
   static getOptimisticGraph(dependencyGraph, processedNavigation) {
     const lcp = processedNavigation.timestamps.largestContentfulPaint;
     if (!lcp) {
-      throw new LHError(LHError.errors.NO_LCP);
+      throw new LighthouseError(LighthouseError.errors.NO_LCP);
     }
 
     return LanternFirstContentfulPaint.getFirstPaintBasedGraph(
@@ -65,7 +65,7 @@ class LanternLargestContentfulPaint extends LanternMetric {
   static getPessimisticGraph(dependencyGraph, processedNavigation) {
     const lcp = processedNavigation.timestamps.largestContentfulPaint;
     if (!lcp) {
-      throw new LHError(LHError.errors.NO_LCP);
+      throw new LighthouseError(LighthouseError.errors.NO_LCP);
     }
 
     return LanternFirstContentfulPaint.getFirstPaintBasedGraph(

package/lighthouse-core/computed/metrics/largest-contentful-paint-all-frames.js

@@ -11,7 +11,7 @@
 
 const makeComputedArtifact = require('../computed-artifact.js');
 const NavigationMetric = require('./navigation-metric.js');
-const LHError = require('../../lib/lh-error.js');
+const LighthouseError = require('../../lib/lh-error.js');
 
 class LargestContentfulPaintAllFrames extends NavigationMetric {
   /**
@@ -29,7 +29,7 @@ class LargestContentfulPaintAllFrames extends NavigationMetric {
   static async computeObservedMetric(data) {
     const {processedNavigation} = data;
     if (processedNavigation.timings.largestContentfulPaintAllFrames === undefined) {
-      throw new LHError(LHError.errors.NO_LCP_ALL_FRAMES);
+      throw new LighthouseError(LighthouseError.errors.NO_LCP_ALL_FRAMES);
     }
 
     return {

package/lighthouse-core/computed/metrics/largest-contentful-paint.js

@@ -15,7 +15,7 @@
 
 const makeComputedArtifact = require('../computed-artifact.js');
 const NavigationMetric = require('./navigation-metric.js');
-const LHError = require('../../lib/lh-error.js');
+const LighthouseError = require('../../lib/lh-error.js');
 const LanternLargestContentfulPaint = require('./lantern-largest-contentful-paint.js');
 
 class LargestContentfulPaint extends NavigationMetric {
@@ -36,7 +36,7 @@ class LargestContentfulPaint extends NavigationMetric {
   static async computeObservedMetric(data) {
     const {processedNavigation} = data;
     if (processedNavigation.timings.largestContentfulPaint === undefined) {
-      throw new LHError(LHError.errors.NO_LCP);
+      throw new LighthouseError(LighthouseError.errors.NO_LCP);
     }
 
     return {

package/lighthouse-core/computed/speedline.js

@@ -7,7 +7,7 @@
 
 const makeComputedArtifact = require('./computed-artifact.js');
 const speedline = require('speedline-core');
-const LHError = require('../lib/lh-error.js');
+const LighthouseError = require('../lib/lh-error.js');
 const ProcessedTrace = require('./processed-trace.js');
 
 class Speedline {
@@ -33,17 +33,17 @@ class Speedline {
       });
     }).catch(err => {
       if (/No screenshots found in trace/.test(err.message)) {
-        throw new LHError(LHError.errors.NO_SCREENSHOTS);
+        throw new LighthouseError(LighthouseError.errors.NO_SCREENSHOTS);
       }
 
       throw err;
     }).then(speedline => {
       if (speedline.frames.length === 0) {
-        throw new LHError(LHError.errors.NO_SPEEDLINE_FRAMES);
+        throw new LighthouseError(LighthouseError.errors.NO_SPEEDLINE_FRAMES);
       }
 
       if (speedline.speedIndex === 0) {
-        throw new LHError(LHError.errors.SPEEDINDEX_OF_ZERO);
+        throw new LighthouseError(LighthouseError.errors.SPEEDINDEX_OF_ZERO);
       }
 
       return speedline;

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

@@ -23,6 +23,24 @@ function isObjectOfUnknownProperties(val) {
   return typeof val === 'object' && val !== null && !Array.isArray(val);
 }
 
+/**
+ * @param {unknown} str
+ * @return {str is LH.Gatherer.GatherMode}
+ */
+function objectIsGatherMode(str) {
+  if (typeof str !== 'string') return false;
+  return str === 'navigation' || str === 'timespan' || str === 'snapshot';
+}
+
+/**
+ * @param {unknown} arr
+ * @return {arr is Array<LH.Gatherer.GatherMode>}
+ */
+function isArrayOfGatherModes(arr) {
+  if (!Array.isArray(arr)) return false;
+  return arr.every(objectIsGatherMode);
+}
+
 /**
  * Asserts that obj has no own properties, throwing a nice error message if it does.
  * Plugin and object name are included for nicer logging.
@@ -124,6 +142,7 @@ class ConfigPlugin {
       description,
       manualDescription,
       auditRefs: auditRefsJson,
+      supportedModes,
       ...invalidRest
     } = categoryJson;
 
@@ -138,6 +157,12 @@ class ConfigPlugin {
     if (!i18n.isStringOrIcuMessage(manualDescription) && manualDescription !== undefined) {
       throw new Error(`${pluginName} has an invalid category manualDescription.`);
     }
+    if (!isArrayOfGatherModes(supportedModes) && supportedModes !== undefined) {
+      throw new Error(
+        `${pluginName} supportedModes must be an array, ` +
+        `valid array values are "navigation", "timespan", and "snapshot".`
+      );
+    }
     const auditRefs = ConfigPlugin._parseAuditRefsList(auditRefsJson, pluginName);
 
     return {
@@ -145,6 +170,7 @@ class ConfigPlugin {
       auditRefs,
       description: description,
       manualDescription: manualDescription,
+      supportedModes,
     };
   }
 

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

@@ -178,6 +178,7 @@ async function _computeNavigationResult(
       url: mainDocumentUrl,
       loadFailureMode: navigationContext.navigation.loadFailureMode,
       networkRecords: debugData.records,
+      warnings,
     })
     : navigationError;
 

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

@@ -6,7 +6,7 @@
 'use strict';
 
 const EventEmitter = require('events').EventEmitter;
-const LHError = require('../../lib/lh-error.js');
+const LighthouseError = require('../../lib/lh-error.js');
 
 // Controls how long to wait for a response after sending a DevTools protocol command.
 const DEFAULT_PROTOCOL_TIMEOUT = 30000;
@@ -87,7 +87,8 @@ class ProtocolSession extends CrdpEventEmitter {
     const timeoutPromise = new Promise((resolve, reject) => {
       if (timeoutMs === Infinity) return;
 
-      timeout = setTimeout(reject, timeoutMs, new LHError(LHError.errors.PROTOCOL_TIMEOUT, {
+      // eslint-disable-next-line max-len
+      timeout = setTimeout(reject, timeoutMs, new LighthouseError(LighthouseError.errors.PROTOCOL_TIMEOUT, {
         protocolMethod: method,
       }));
     });

package/lighthouse-core/gather/connections/connection.js

@@ -7,7 +7,7 @@
 
 const EventEmitter = require('events').EventEmitter;
 const log = require('lighthouse-logger');
-const LHError = require('../../lib/lh-error.js');
+const LighthouseError = require('../../lib/lh-error.js');
 
 // TODO(bckenny): CommandCallback properties should be tied by command type after
 // https://github.com/Microsoft/TypeScript/pull/22348. See driver.js TODO.
@@ -138,7 +138,7 @@ class Connection {
       callback.resolve(Promise.resolve().then(_ => {
         if (object.error) {
           log.formatProtocol('method <= browser ERR', {method: callback.method}, 'error');
-          throw LHError.fromProtocolMessage(callback.method, object.error);
+          throw LighthouseError.fromProtocolMessage(callback.method, object.error);
         }
 
         log.formatProtocol('method <= browser OK',

package/lighthouse-core/gather/driver/wait-for-condition.js

@@ -8,7 +8,7 @@
 /* global window */
 
 const log = require('lighthouse-logger');
-const LHError = require('../../lib/lh-error.js');
+const LighthouseError = require('../../lib/lh-error.js');
 const ExecutionContext = require('./execution-context.js');
 
 /** @typedef {import('./network-monitor.js')} NetworkMonitor */
@@ -75,7 +75,7 @@ function waitForFcp(session, pauseAfterFcpMs, maxWaitForFcpMs) {
   /** @type {Promise<void>} */
   const promise = new Promise((resolve, reject) => {
     const maxWaitTimeout = setTimeout(() => {
-      reject(new LHError(LHError.errors.NO_FCP));
+      reject(new LighthouseError(LighthouseError.errors.NO_FCP));
     }, maxWaitForFcpMs);
     /** @type {NodeJS.Timeout|undefined} */
     let loadTimeout;
@@ -476,7 +476,7 @@ async function waitForFullyLoaded(session, networkMonitor, options) {
         log.warn('waitFor', 'Page appears to be hung, killing JavaScript...');
         await session.sendCommand('Emulation.setScriptExecutionDisabled', {value: true});
         await session.sendCommand('Runtime.terminateExecution');
-        throw new LHError(LHError.errors.PAGE_HUNG);
+        throw new LighthouseError(LighthouseError.errors.PAGE_HUNG);
       }
 
       return {timedOut: true};

package/lighthouse-core/gather/driver.js

@@ -7,7 +7,7 @@
 
 const Fetcher = require('./fetcher.js');
 const ExecutionContext = require('./driver/execution-context.js');
-const LHError = require('../lib/lh-error.js');
+const LighthouseError = require('../lib/lh-error.js');
 const {fetchResponseBodyFromCache} = require('../gather/driver/network.js');
 const EventEmitter = require('events').EventEmitter;
 
@@ -343,7 +343,8 @@ class Driver {
     let asyncTimeout;
     const timeoutPromise = new Promise((resolve, reject) => {
       if (timeout === Infinity) return;
-      asyncTimeout = setTimeout(reject, timeout, new LHError(LHError.errors.PROTOCOL_TIMEOUT, {
+      // eslint-disable-next-line max-len
+      asyncTimeout = setTimeout(reject, timeout, new LighthouseError(LighthouseError.errors.PROTOCOL_TIMEOUT, {
         protocolMethod: method,
       }));
     });

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

@@ -90,7 +90,7 @@ class GatherRunner {
         passContext.LighthouseRunWarnings.push(...warnings);
       }
     } catch (err) {
-      // If it's one of our loading-based LHErrors, we'll treat it as a page load error.
+      // If it's one of our loading-based LighthouseErrors, we'll treat it as a page load error.
       if (err.code === 'NO_FCP' || err.code === 'PAGE_HUNG') {
         return {navigationError: err};
       }
@@ -604,6 +604,7 @@ class GatherRunner {
       url: passContext.url,
       loadFailureMode: passConfig.loadFailureMode,
       networkRecords: loadData.networkRecords,
+      warnings: passContext.LighthouseRunWarnings,
     });
     if (pageLoadError) {
       const localizedMessage = format.getFormatted(pageLoadError.friendlyMessage,

package/lighthouse-core/gather/gatherers/main-document-content.js

@@ -21,7 +21,6 @@ class MainDocumentContent extends FRGatherer {
   };
 
   /**
-   *
    * @param {LH.Gatherer.FRTransitionalContext} context
    * @param {LH.Artifacts['DevtoolsLog']} devtoolsLog
    * @return {Promise<LH.Artifacts['MainDocumentContent']>}
@@ -34,7 +33,6 @@ class MainDocumentContent extends FRGatherer {
   }
 
   /**
-   *
    * @param {LH.Gatherer.FRTransitionalContext<'DevtoolsLog'>} context
    * @return {Promise<LH.Artifacts['MainDocumentContent']>}
    */

package/lighthouse-core/lib/asset-saver.js

@@ -15,7 +15,7 @@ const lanternTraceSaver = require('./lantern-trace-saver.js');
 const Metrics = require('./traces/pwmetrics-events.js');
 const NetworkAnalysisComputed = require('../computed/network-analysis.js');
 const LoadSimulatorComputed = require('../computed/load-simulator.js');
-const LHError = require('../lib/lh-error.js');
+const LighthouseError = require('../lib/lh-error.js');
 // TODO(esmodules): Rollup does not support `promisfy` or `stream.pipeline`. Bundled files
 // don't need anything in this file except for `stringifyReplacer`, so a check for
 // truthiness before using is enough.
@@ -48,10 +48,10 @@ function loadArtifacts(basePath) {
     throw new Error('No saved artifacts found at ' + basePath);
   }
 
-  // load artifacts.json using a reviver to deserialize any LHErrors in artifacts.
+  // load artifacts.json using a reviver to deserialize any LighthouseErrors in artifacts.
   const artifactsStr = fs.readFileSync(path.join(basePath, artifactsFilename), 'utf8');
   /** @type {LH.Artifacts} */
-  const artifacts = JSON.parse(artifactsStr, LHError.parseReviver);
+  const artifacts = JSON.parse(artifactsStr, LighthouseError.parseReviver);
 
   const filenames = fs.readdirSync(basePath);
 
@@ -87,9 +87,9 @@ function loadArtifacts(basePath) {
  * @param {any} value
  */
 function stringifyReplacer(key, value) {
-  // Currently only handle LHError and other Error types.
+  // Currently only handle LighthouseError and other Error types.
   if (value instanceof Error) {
-    return LHError.stringifyReplacer(value);
+    return LighthouseError.stringifyReplacer(value);
   }
 
   return value;
@@ -128,7 +128,7 @@ async function saveArtifacts(artifacts, basePath) {
     await saveDevtoolsLog(devtoolsLog, `${basePath}/${passName}${devtoolsLogSuffix}`);
   }
 
-  // save everything else, using a replacer to serialize LHErrors in the artifacts.
+  // save everything else, using a replacer to serialize LighthouseErrors in the artifacts.
   const restArtifactsString = JSON.stringify(restArtifacts, stringifyReplacer, 2) + '\n';
   fs.writeFileSync(`${basePath}/${artifactsFilename}`, restArtifactsString, 'utf8');
   log.log('Artifacts saved to disk in folder:', basePath);

package/lighthouse-core/lib/lh-env.js

@@ -8,7 +8,7 @@
 const process = require('process');
 
 module.exports = {
-  // NODE_ENV is set to test by jest and by smokehouse CLI runner
+  // NODE_ENV is set to test by mocha-setup.js and the smokehouse CLI runner
   // CI as a catchall for everything we do in GitHub Actions
   isUnderTest: !!process.env.CI || process.env.NODE_ENV === 'test',
 };

package/lighthouse-core/lib/lh-error.js

@@ -114,7 +114,7 @@ class LighthouseError extends Error {
    */
   constructor(errorDefinition, properties) {
     super(errorDefinition.code);
-    this.name = 'LHError';
+    this.name = 'LighthouseError';
     this.code = errorDefinition.code;
     // Add additional properties to be ICU replacements in the error string.
     // `code` is always added as `errorCode` so callers don't need to specify the code multiple times.
@@ -148,7 +148,7 @@ class LighthouseError extends Error {
   }
 
   /**
-   * A JSON.stringify replacer to serialize LHErrors and (as a fallback) Errors.
+   * A JSON.stringify replacer to serialize LighthouseErrors and (as a fallback) Errors.
    * Returns a simplified version of the error object that can be reconstituted
    * as a copy of the original error at parse time.
    * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#The_replacer_parameter
@@ -169,7 +169,7 @@ class LighthouseError extends Error {
       };
     }
 
-    // Unexpected errors won't be LHErrors, but we want them serialized as well.
+    // Unexpected errors won't be LighthouseErrors, but we want them serialized as well.
     if (err instanceof Error) {
       const {message, stack} = err;
       // @ts-expect-error - code can be helpful for e.g. node errors, so preserve it if it's present.
@@ -182,12 +182,12 @@ class LighthouseError extends Error {
       };
     }
 
-    throw new Error('Invalid value for LHError stringification');
+    throw new Error('Invalid value for LighthouseError stringification');
   }
 
   /**
    * A JSON.parse reviver. If any value passed in is a serialized Error or
-   * LHError, the error is recreated as the original object. Otherwise, the
+   * LighthouseError, the error is recreated as the original object. Otherwise, the
    * value is passed through unchanged.
    * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse#Using_the_reviver_parameter
    * @param {string} key