lighthouse 9.5.0-dev.20220908 → 9.5.0-dev.20220909

package/CONTRIBUTING.md

@@ -128,7 +128,7 @@ accept your pull requests.
 
 ## Tracking Errors
 
-We track our errors in the wild with Sentry. In general, do not worry about wrapping your audits or gatherers in try/catch blocks and reporting every error that could possibly occur; `core/runner.js` and `core/gather/gather-runner.js` already catch and report any errors that occur while running a gatherer or audit, including errors fatal to the entire run. However, there are some situations when you might want to explicitly handle an error and report it to Sentry or wrap it to avoid reporting. Generally, you can interact with Sentry simply by requiring the `core/lib/sentry.js` file and call its methods. The module exports a delegate that will correctly handle the error reporting based on the user's opt-in preference and will simply no-op if they haven't so you don't need to check.
+We track our errors in the wild with Sentry. In general, do not worry about wrapping your audits or gatherers in try/catch blocks and reporting every error that could possibly occur; `core/runner.js` and `core/fraggle-rock/gather/*-runner.js` already catch and report any errors that occur while running a gatherer or audit, including errors fatal to the entire run. However, there are some situations when you might want to explicitly handle an error and report it to Sentry or wrap it to avoid reporting. Generally, you can interact with Sentry simply by requiring the `core/lib/sentry.js` file and call its methods. The module exports a delegate that will correctly handle the error reporting based on the user's opt-in preference and will simply no-op if they haven't so you don't need to check.
 
 
 #### If you have an expected error that is recoverable but want to track how frequently it happens, *use Sentry.captureException*.

package/cli/test/smokehouse/lighthouse-runners/bundle.js

@@ -19,7 +19,7 @@ import {once} from 'events';
 import puppeteer from 'puppeteer-core';
 import ChromeLauncher from 'chrome-launcher';
 
-import {CriConnection} from '../../../../core/gather/connections/cri.js';
+import {CriConnection} from '../../../../core/legacy/gather/connections/cri.js';
 import {LH_ROOT} from '../../../../root.js';
 import {loadArtifacts, saveArtifacts} from '../../../../core/lib/asset-saver.js';
 

package/core/gather/driver/execution-context.js

@@ -110,7 +110,7 @@ class ExecutionContext {
         return new Promise(function (resolve) {
           return Promise.resolve()
             .then(_ => ${expression})
-            .catch(${pageFunctions.wrapRuntimeEvalErrorInBrowserString})
+            .catch(${pageFunctions.wrapRuntimeEvalErrorInBrowser})
             .then(resolve);
         });
       }())

package/core/gather/gatherers/accessibility.js

@@ -173,7 +173,7 @@ class Accessibility extends FRGatherer {
       useIsolation: true,
       deps: [
         axeSource,
-        pageFunctions.getNodeDetailsString,
+        pageFunctions.getNodeDetails,
         createAxeRuleResultArtifact,
       ],
     });

package/core/gather/gatherers/anchor-elements.js

@@ -106,8 +106,8 @@ class AnchorElements extends FRGatherer {
       args: [],
       useIsolation: true,
       deps: [
-        pageFunctions.getElementsInDocumentString,
-        pageFunctions.getNodeDetailsString,
+        pageFunctions.getElementsInDocument,
+        pageFunctions.getNodeDetails,
       ],
     });
     await session.sendCommand('DOM.enable');

package/core/gather/gatherers/dobetterweb/domstats.js

@@ -92,7 +92,7 @@ class DOMStats extends FRGatherer {
     const results = await driver.executionContext.evaluate(getDOMStats, {
       args: [],
       useIsolation: true,
-      deps: [pageFunctions.getNodeDetailsString],
+      deps: [pageFunctions.getNodeDetails],
     });
     await driver.defaultSession.sendCommand('DOM.disable');
     return results;

package/core/gather/gatherers/dobetterweb/password-inputs-with-prevented-paste.js

@@ -40,7 +40,7 @@ class PasswordInputsWithPreventedPaste extends FRGatherer {
   getArtifact(passContext) {
     return passContext.driver.executionContext.evaluate(findPasswordInputsWithPreventedPaste, {
       args: [],
-      deps: [pageFunctions.getNodeDetailsString],
+      deps: [pageFunctions.getNodeDetails],
     });
   }
 }

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

@@ -163,7 +163,7 @@ class FullPageScreenshot extends FRGatherer {
       return context.driver.executionContext.evaluate(resolveNodes, {
         args: [],
         useIsolation,
-        deps: [pageFunctions.getBoundingClientRectString],
+        deps: [pageFunctions.getBoundingClientRect],
       });
     }
 

package/core/gather/gatherers/iframe-elements.js

@@ -55,9 +55,9 @@ class IFrameElements extends FRGatherer {
       args: [],
       useIsolation: true,
       deps: [
-        pageFunctions.getElementsInDocumentString,
-        pageFunctions.isPositionFixedString,
-        pageFunctions.getNodeDetailsString,
+        pageFunctions.getElementsInDocument,
+        pageFunctions.isPositionFixed,
+        pageFunctions.getNodeDetails,
       ],
     });
     return iframeElements;

package/core/gather/gatherers/image-elements.js

@@ -344,9 +344,9 @@ class ImageElements extends FRGatherer {
       args: [],
       useIsolation: true,
       deps: [
-        pageFunctions.getElementsInDocumentString,
-        pageFunctions.getBoundingClientRectString,
-        pageFunctions.getNodeDetailsString,
+        pageFunctions.getElementsInDocument,
+        pageFunctions.getBoundingClientRect,
+        pageFunctions.getNodeDetails,
         getClientRect,
         getPosition,
         getHTMLImages,

package/core/gather/gatherers/inputs.js

@@ -102,8 +102,8 @@ class Inputs extends FRGatherer {
       args: [],
       useIsolation: true,
       deps: [
-        pageFunctions.getElementsInDocumentString,
-        pageFunctions.getNodeDetailsString,
+        pageFunctions.getElementsInDocument,
+        pageFunctions.getNodeDetails,
       ],
     });
   }

package/core/gather/gatherers/link-elements.js

@@ -104,7 +104,7 @@ class LinkElements extends FRGatherer {
       args: [],
       useIsolation: true,
       deps: [
-        pageFunctions.getNodeDetailsString,
+        pageFunctions.getNodeDetails,
         pageFunctions.getElementsInDocument,
       ],
     });

package/core/gather/gatherers/meta-elements.js

@@ -58,7 +58,7 @@ class MetaElements extends FRGatherer {
       useIsolation: true,
       deps: [
         pageFunctions.getElementsInDocument,
-        pageFunctions.getNodeDetailsString,
+        pageFunctions.getNodeDetails,
       ],
     });
   }

package/core/gather/gatherers/script-elements.js

@@ -58,7 +58,7 @@ class ScriptElements extends FRGatherer {
       args: [],
       useIsolation: true,
       deps: [
-        pageFunctions.getNodeDetailsString,
+        pageFunctions.getNodeDetails,
         pageFunctions.getElementsInDocument,
       ],
     });

package/core/gather/gatherers/seo/embedded-content.js

@@ -54,7 +54,7 @@ class EmbeddedContent extends FRGatherer {
       args: [],
       deps: [
         pageFunctions.getElementsInDocument,
-        pageFunctions.getNodeDetailsString,
+        pageFunctions.getNodeDetails,
       ],
     });
   }

package/core/gather/gatherers/seo/font-size.js

@@ -22,7 +22,7 @@ const MINIMAL_LEGIBLE_FONT_SIZE_PX = 12;
 // limit number of protocol calls to make sure that gatherer doesn't take more than 1-2s
 const MAX_NODES_SOURCE_RULE_FETCHED = 50; // number of nodes to fetch the source font-size rule
 
-/** @typedef {import('../../driver.js')} Driver */
+/** @typedef {import('../../../legacy/gather/driver.js')} Driver */
 /** @typedef {LH.Artifacts.FontSize['analyzedFailingNodesData'][0]} NodeFontData */
 /** @typedef {Map<number, {fontSize: number, textLength: number}>} BackendIdsToFontData */
 

package/core/gather/gatherers/seo/tap-targets.js

@@ -341,7 +341,7 @@ class TapTargets extends FRGatherer {
       args: [tapTargetsSelector, className],
       useIsolation: true,
       deps: [
-        pageFunctions.getNodeDetailsString,
+        pageFunctions.getNodeDetails,
         pageFunctions.getElementsInDocument,
         disableFixedAndStickyElementPointerEvents,
         elementIsVisible,

package/core/gather/gatherers/trace-elements.js

@@ -295,7 +295,7 @@ class TraceElements extends FRGatherer {
             objectId,
             functionDeclaration: `function () {
               ${getNodeDetailsData.toString()};
-              ${pageFunctions.getNodeDetailsString};
+              ${pageFunctions.getNodeDetails};
               return getNodeDetailsData.call(this);
             }`,
             returnByValue: true,

package/core/index.js

@@ -7,14 +7,14 @@
 import log from 'lighthouse-logger';
 
 import {Runner} from './runner.js';
-import {CriConnection} from './gather/connections/cri.js';
-import {Config} from './config/config.js';
+import {CriConnection} from './legacy/gather/connections/cri.js';
+import {Config} from './legacy/config/config.js';
 import UrlUtils from './lib/url-utils.js';
 import * as fraggleRock from './fraggle-rock/api.js';
-import {Driver} from './gather/driver.js';
+import {Driver} from './legacy/gather/driver.js';
 import {initializeConfig} from './fraggle-rock/config/config.js';
 
-/** @typedef {import('./gather/connections/connection.js').Connection} Connection */
+/** @typedef {import('./legacy/gather/connections/connection.js').Connection} Connection */
 
 /*
  * The relationship between these root modules:

package/core/{config → legacy/config}/config.js

@@ -9,10 +9,10 @@ import path from 'path';
 import log from 'lighthouse-logger';
 
 import legacyDefaultConfig from './legacy-default-config.js';
-import * as constants from './constants.js';
-import * as format from '../../shared/localization/format.js';
-import * as validation from './../fraggle-rock/config/validation.js';
-import {Runner} from '../runner.js';
+import * as constants from '../../config/constants.js';
+import * as format from '../../../shared/localization/format.js';
+import * as validation from '../../fraggle-rock/config/validation.js';
+import {Runner} from '../../runner.js';
 import {
   mergePlugins,
   mergeConfigFragment,
@@ -21,12 +21,12 @@ import {
   resolveGathererToDefn,
   deepClone,
   deepCloneConfigJson,
-} from './config-helpers.js';
-import {getModuleDirectory} from '../../esm-utils.js';
+} from '../../config/config-helpers.js';
+import {getModuleDirectory} from '../../../esm-utils.js';
 
 const defaultConfigPath = './legacy-default-config.js';
 
-/** @typedef {typeof import('../gather/gatherers/gatherer.js').Gatherer} GathererConstructor */
+/** @typedef {typeof import('../../gather/gatherers/gatherer.js').Gatherer} GathererConstructor */
 /** @typedef {InstanceType<GathererConstructor>} Gatherer */
 
 /**

package/core/{config → legacy/config}/legacy-default-config.js

@@ -8,7 +8,7 @@
  * @fileoverview Construct the legacy default config from the standard default config.
  */
 
-import defaultConfig from './default-config.js';
+import defaultConfig from '../../config/default-config.js';
 
 /** @type {LH.Config.Json} */
 const legacyDefaultConfig = JSON.parse(JSON.stringify(defaultConfig));

package/core/{gather → legacy/gather}/connections/connection.js

@@ -8,7 +8,7 @@ import {EventEmitter} from 'events';
 
 import log from 'lighthouse-logger';
 
-import {LighthouseError} from '../../lib/lh-error.js';
+import {LighthouseError} from '../../../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.

package/core/{gather → legacy/gather}/connections/cri.js

@@ -10,7 +10,7 @@ import WebSocket from 'ws';
 import log from 'lighthouse-logger';
 
 import {Connection} from './connection.js';
-import {LighthouseError} from '../../lib/lh-error.js';
+import {LighthouseError} from '../../../lib/lh-error.js';
 
 const DEFAULT_HOSTNAME = '127.0.0.1';
 const CONNECT_TIMEOUT = 10000;

package/core/{gather → legacy/gather}/driver.js

@@ -8,13 +8,13 @@ import {EventEmitter} from 'events';
 
 import log from 'lighthouse-logger';
 
-import {Fetcher} from './fetcher.js';
-import {ExecutionContext} from './driver/execution-context.js';
-import {LighthouseError} from '../lib/lh-error.js';
-import {fetchResponseBodyFromCache} from '../gather/driver/network.js';
-import {DevtoolsMessageLog} from './gatherers/devtools-log.js';
-import TraceGatherer from './gatherers/trace.js';
-import {getBrowserVersion} from './driver/environment.js';
+import {Fetcher} from '../../gather/fetcher.js';
+import {ExecutionContext} from '../../gather/driver/execution-context.js';
+import {LighthouseError} from '../../lib/lh-error.js';
+import {fetchResponseBodyFromCache} from '../../gather/driver/network.js';
+import {DevtoolsMessageLog} from '../../gather/gatherers/devtools-log.js';
+import TraceGatherer from '../../gather/gatherers/trace.js';
+import {getBrowserVersion} from '../../gather/driver/environment.js';
 
 // Controls how long to wait for a response after sending a DevTools protocol command.
 const DEFAULT_PROTOCOL_TIMEOUT = 30000;

package/core/{gather → legacy/gather}/gather-runner.js

@@ -6,25 +6,25 @@
 
 import log from 'lighthouse-logger';
 
-import {NetworkRecords} from '../computed/network-records.js';
-import {getPageLoadError} from '../lib/navigation-error.js';
-import * as emulation from '../lib/emulation.js';
-import * as constants from '../config/constants.js';
-import * as format from '../../shared/localization/format.js';
-import {getBenchmarkIndex, getEnvironmentWarnings} from './driver/environment.js';
-import * as prepare from './driver/prepare.js';
-import * as storage from './driver/storage.js';
-import * as navigation from './driver/navigation.js';
-import * as serviceWorkers from './driver/service-workers.js';
-import WebAppManifest from './gatherers/web-app-manifest.js';
-import InstallabilityErrors from './gatherers/installability-errors.js';
-import NetworkUserAgent from './gatherers/network-user-agent.js';
-import Stacks from './gatherers/stacks.js';
-import {finalizeArtifacts} from '../fraggle-rock/gather/base-artifacts.js';
-import UrlUtils from '../lib/url-utils.js';
-
-/** @typedef {import('../gather/driver.js').Driver} Driver */
-/** @typedef {import('../lib/arbitrary-equality-map.js').ArbitraryEqualityMap} ArbitraryEqualityMap */
+import {NetworkRecords} from '../../computed/network-records.js';
+import {getPageLoadError} from '../../lib/navigation-error.js';
+import * as emulation from '../../lib/emulation.js';
+import * as constants from '../../config/constants.js';
+import * as format from '../../../shared/localization/format.js';
+import {getBenchmarkIndex, getEnvironmentWarnings} from '../../gather/driver/environment.js';
+import * as prepare from '../../gather/driver/prepare.js';
+import * as storage from '../../gather/driver/storage.js';
+import * as navigation from '../../gather/driver/navigation.js';
+import * as serviceWorkers from '../../gather/driver/service-workers.js';
+import WebAppManifest from '../../gather/gatherers/web-app-manifest.js';
+import InstallabilityErrors from '../../gather/gatherers/installability-errors.js';
+import NetworkUserAgent from '../../gather/gatherers/network-user-agent.js';
+import Stacks from '../../gather/gatherers/stacks.js';
+import {finalizeArtifacts} from '../../fraggle-rock/gather/base-artifacts.js';
+import UrlUtils from '../../lib/url-utils.js';
+
+/** @typedef {import('./driver.js').Driver} Driver */
+/** @typedef {import('../../lib/arbitrary-equality-map.js').ArbitraryEqualityMap} ArbitraryEqualityMap */
 
 /**
  * Each entry in each gatherer result array is the output of a gatherer phase:

package/core/lib/page-functions.js

@@ -539,35 +539,28 @@ function getNodeDetails(element) {
   return details;
 }
 
-const getNodeDetailsString = `function getNodeDetails(element) {
-  ${getNodePath.toString()};
-  ${getNodeSelector.toString()};
-  ${getBoundingClientRect.toString()};
-  ${getOuterHTMLSnippet.toString()};
-  ${getNodeLabel.toString()};
-  return (${getNodeDetails.toString()})(element);
+/** @type {string} */
+const getNodeDetailsRawString = getNodeDetails.toString();
+getNodeDetails.toString = () => `function getNodeDetails(element) {
+  ${getNodePath};
+  ${getNodeSelector};
+  ${getBoundingClientRect};
+  ${getOuterHTMLSnippet};
+  ${getNodeLabel};
+  return (${getNodeDetailsRawString})(element);
 }`;
 
-// TODO(esmodules): should this be refactored to export each function individually?
 export const pageFunctions = {
-  wrapRuntimeEvalErrorInBrowserString: wrapRuntimeEvalErrorInBrowser.toString(),
   wrapRuntimeEvalErrorInBrowser,
   getElementsInDocument,
-  getElementsInDocumentString: getElementsInDocument.toString(),
-  getOuterHTMLSnippetString: getOuterHTMLSnippet.toString(),
   getOuterHTMLSnippet,
   computeBenchmarkIndex,
-  computeBenchmarkIndexString: computeBenchmarkIndex.toString(),
   getMaxTextureSize,
-  getNodeDetailsString,
   getNodeDetails,
-  getNodePathString: getNodePath.toString(),
-  getNodeSelectorString: getNodeSelector.toString(),
   getNodePath,
   getNodeSelector,
   getNodeLabel,
-  getNodeLabelString: getNodeLabel.toString(),
-  isPositionFixedString: isPositionFixed.toString(),
+  isPositionFixed,
   wrapRequestIdleCallback,
-  getBoundingClientRectString: getBoundingClientRect.toString(),
+  getBoundingClientRect,
 };

package/core/runner.js

@@ -7,11 +7,12 @@
 import fs from 'fs';
 import path from 'path';
 
-import isDeepEqual from 'lodash/isEqual.js';
+
 import log from 'lighthouse-logger';
+import isDeepEqual from 'lodash/isEqual.js';
 
-import {Driver} from './gather/driver.js';
-import {GatherRunner} from './gather/gather-runner.js';
+import {Driver} from './legacy/gather/driver.js';
+import {GatherRunner} from './legacy/gather/gather-runner.js';
 import {ReportScoring} from './scoring.js';
 import {Audit} from './audits/audit.js';
 import * as format from '../shared/localization/format.js';
@@ -25,7 +26,7 @@ import {getModuleDirectory} from '../esm-utils.js';
 
 const moduleDir = getModuleDirectory(import.meta);
 
-/** @typedef {import('./gather/connections/connection.js').Connection} Connection */
+/** @typedef {import('./legacy/gather/connections/connection.js').Connection} Connection */
 /** @typedef {import('./lib/arbitrary-equality-map.js').ArbitraryEqualityMap} ArbitraryEqualityMap */
 /** @typedef {LH.Config.Config} Config */
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "lighthouse",
   "type": "module",
-  "version": "9.5.0-dev.20220908",
+  "version": "9.5.0-dev.20220909",
   "description": "Automated auditing, performance metrics, and best practices for the web.",
   "main": "./core/index.js",
   "bin": {

package/tsconfig.json

@@ -41,7 +41,7 @@
     "core/test/config/budget-test.js",
     "core/test/config/config-helpers-test.js",
     "core/test/config/config-plugin-test.js",
-    "core/test/config/config-test.js",
+    "core/test/legacy/config/config-test.js",
     "core/test/config/default-config-test.js",
     "core/test/create-test-trace.js",
     "core/test/gather/driver/wait-for-condition-test.js",

package/types/gatherer.d.ts

@@ -7,7 +7,7 @@
 import {NetworkNode as _NetworkNode} from '../core/lib/dependency-graph/network-node';
 import {CPUNode as _CPUNode} from '../core/lib/dependency-graph/cpu-node';
 import {Simulator as _Simulator} from '../core/lib/dependency-graph/simulator/simulator';
-import {Driver} from '../core/gather/driver';
+import {Driver} from '../core/legacy/gather/driver';
 import {ExecutionContext} from '../core/gather/driver/execution-context';
 import {Fetcher} from '../core/gather/fetcher';
 import {ArbitraryEqualityMap} from '../core/lib/arbitrary-equality-map';