lighthouse 9.5.0-dev.20230103 → 9.5.0-dev.20230104

package/core/config/config.js

@@ -238,7 +238,7 @@ function resolveFakeNavigations(artifactDefns, settings) {
  * @param {LH.Gatherer.GatherMode} gatherMode
  * @param {LH.Config.Json=} configJSON
  * @param {LH.Flags=} flags
- * @return {Promise<{resolvedConfig: LH.Config.FRConfig, warnings: string[]}>}
+ * @return {Promise<{resolvedConfig: LH.Config.ResolvedConfig, warnings: string[]}>}
  */
 async function initializeConfig(gatherMode, configJSON, flags = {}) {
   const status = {msg: 'Initialize config', id: 'lh:config'};
@@ -256,7 +256,7 @@ async function initializeConfig(gatherMode, configJSON, flags = {}) {
 
   const navigations = resolveFakeNavigations(artifacts, settings);
 
-  /** @type {LH.Config.FRConfig} */
+  /** @type {LH.Config.ResolvedConfig} */
   let resolvedConfig = {
     artifacts,
     navigations,
@@ -276,11 +276,11 @@ async function initializeConfig(gatherMode, configJSON, flags = {}) {
 }
 
 /**
- * @param {LH.Config.FRConfig} resolvedConfig
+ * @param {LH.Config.ResolvedConfig} resolvedConfig
  * @return {string}
  */
 function getConfigDisplayString(resolvedConfig) {
-  /** @type {LH.Config.FRConfig} */
+  /** @type {LH.Config.ResolvedConfig} */
   const resolvedConfigCopy = JSON.parse(JSON.stringify(resolvedConfig));
 
   if (resolvedConfigCopy.navigations) {

package/core/config/filters.js

@@ -39,7 +39,7 @@ const filterResistantArtifactIds = ['Stacks', 'NetworkUserAgent'];
  * If `onlyCategories` is not set, this function returns the list of all audit IDs across all
  * categories.
  *
- * @param {LH.Config.FRConfig['categories']} allCategories
+ * @param {LH.Config.ResolvedConfig['categories']} allCategories
  * @param {string[] | undefined} onlyCategories
  * @return {Set<string>}
  */
@@ -55,9 +55,9 @@ function getAuditIdsInCategories(allCategories, onlyCategories) {
 /**
  * Filters an array of artifacts down to the set that's required by the specified audits.
  *
- * @param {LH.Config.FRConfig['artifacts']} artifacts
- * @param {LH.Config.FRConfig['audits']} audits
- * @return {LH.Config.FRConfig['artifacts']}
+ * @param {LH.Config.ResolvedConfig['artifacts']} artifacts
+ * @param {LH.Config.ResolvedConfig['audits']} audits
+ * @return {LH.Config.ResolvedConfig['artifacts']}
  */
 function filterArtifactsByAvailableAudits(artifacts, audits) {
   if (!artifacts) return null;
@@ -95,9 +95,9 @@ function filterArtifactsByAvailableAudits(artifacts, audits) {
 /**
  * Filters an array of artifacts down to the set that supports the specified gather mode.
  *
- * @param {LH.Config.FRConfig['artifacts']} artifacts
+ * @param {LH.Config.ResolvedConfig['artifacts']} artifacts
  * @param {LH.Gatherer.GatherMode} mode
- * @return {LH.Config.FRConfig['artifacts']}
+ * @return {LH.Config.ResolvedConfig['artifacts']}
  */
 function filterArtifactsByGatherMode(artifacts, mode) {
   if (!artifacts) return null;
@@ -109,9 +109,9 @@ function filterArtifactsByGatherMode(artifacts, mode) {
 /**
  * Filters an array of navigations down to the set supported by the available artifacts.
  *
- * @param {LH.Config.FRConfig['navigations']} navigations
+ * @param {LH.Config.ResolvedConfig['navigations']} navigations
  * @param {Array<LH.Config.AnyArtifactDefn>} availableArtifacts
- * @return {LH.Config.FRConfig['navigations']}
+ * @return {LH.Config.ResolvedConfig['navigations']}
  */
 function filterNavigationsByAvailableArtifacts(navigations, availableArtifacts) {
   if (!navigations) return navigations;
@@ -133,9 +133,9 @@ function filterNavigationsByAvailableArtifacts(navigations, availableArtifacts)
 /**
  * Filters an array of audits down to the set that can be computed using only the specified artifacts.
  *
- * @param {LH.Config.FRConfig['audits']} audits
+ * @param {LH.Config.ResolvedConfig['audits']} audits
  * @param {Array<LH.Config.AnyArtifactDefn>} availableArtifacts
- * @return {LH.Config.FRConfig['audits']}
+ * @return {LH.Config.ResolvedConfig['audits']}
  */
 function filterAuditsByAvailableArtifacts(audits, availableArtifacts) {
   if (!audits) return null;
@@ -152,9 +152,9 @@ function filterAuditsByAvailableArtifacts(audits, availableArtifacts) {
 /**
  * Optional `supportedModes` property can explicitly exclude an audit even if all required artifacts are available.
  *
- * @param {LH.Config.FRConfig['audits']} audits
+ * @param {LH.Config.ResolvedConfig['audits']} audits
  * @param {LH.Gatherer.GatherMode} mode
- * @return {LH.Config.FRConfig['audits']}
+ * @return {LH.Config.ResolvedConfig['audits']}
  */
 function filterAuditsByGatherMode(audits, mode) {
   if (!audits) return null;
@@ -168,9 +168,9 @@ 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.Config.LegacyResolvedConfig['categories']} categories
  * @param {LH.Gatherer.GatherMode} mode
- * @return {LH.Config.Config['categories']}
+ * @return {LH.Config.LegacyResolvedConfig['categories']}
  */
 function filterCategoriesByGatherMode(categories, mode) {
   if (!categories) return null;
@@ -185,9 +185,9 @@ function filterCategoriesByGatherMode(categories, mode) {
 /**
  * Filters a categories object and their auditRefs down to the specified category ids.
  *
- * @param {LH.Config.Config['categories']} categories
+ * @param {LH.Config.LegacyResolvedConfig['categories']} categories
  * @param {string[] | null | undefined} onlyCategories
- * @return {LH.Config.Config['categories']}
+ * @return {LH.Config.LegacyResolvedConfig['categories']}
  */
 function filterCategoriesByExplicitFilters(categories, onlyCategories) {
   if (!categories || !onlyCategories) return categories;
@@ -201,7 +201,7 @@ function filterCategoriesByExplicitFilters(categories, onlyCategories) {
  * Logs a warning if any specified onlyCategory is not a known category that can
  * be included.
  *
- * @param {LH.Config.Config['categories']} allCategories
+ * @param {LH.Config.LegacyResolvedConfig['categories']} allCategories
  * @param {string[] | null} onlyCategories
  * @return {void}
  */
@@ -219,9 +219,9 @@ function warnOnUnknownOnlyCategories(allCategories, onlyCategories) {
  * Filters a categories object and their auditRefs down to the set that can be computed using
  * only the specified audits.
  *
- * @param {LH.Config.Config['categories']} categories
+ * @param {LH.Config.LegacyResolvedConfig['categories']} categories
  * @param {Array<LH.Config.AuditDefn>} availableAudits
- * @return {LH.Config.Config['categories']}
+ * @return {LH.Config.LegacyResolvedConfig['categories']}
  */
 function filterCategoriesByAvailableAudits(categories, availableAudits) {
   if (!categories) return categories;
@@ -257,9 +257,9 @@ function filterCategoriesByAvailableAudits(categories, availableAudits) {
 /**
  * Filters a config's artifacts, audits, and categories down to the set that supports the specified gather mode.
  *
- * @param {LH.Config.FRConfig} resolvedConfig
+ * @param {LH.Config.ResolvedConfig} resolvedConfig
  * @param {LH.Gatherer.GatherMode} mode
- * @return {LH.Config.FRConfig}
+ * @return {LH.Config.ResolvedConfig}
  */
 function filterConfigByGatherMode(resolvedConfig, mode) {
   const artifacts = filterArtifactsByGatherMode(resolvedConfig.artifacts, mode);
@@ -280,9 +280,9 @@ function filterConfigByGatherMode(resolvedConfig, mode) {
  * Filters a config's artifacts, audits, and categories down to the requested set.
  * Skip audits overrides inclusion via `onlyAudits`/`onlyCategories`.
  *
- * @param {LH.Config.FRConfig} resolvedConfig
+ * @param {LH.Config.ResolvedConfig} resolvedConfig
  * @param {Pick<LH.Config.Settings, 'onlyAudits'|'onlyCategories'|'skipAudits'>} filters
- * @return {LH.Config.FRConfig}
+ * @return {LH.Config.ResolvedConfig}
  */
 function filterConfigByExplicitFilters(resolvedConfig, filters) {
   const {onlyAudits, onlyCategories, skipAudits} = filters;

package/core/config/validation.js

@@ -79,7 +79,7 @@ function assertValidFRGatherer(gathererDefn) {
 
 /**
  * Throws an error if the provided object does not implement the required navigations interface.
- * @param {LH.Config.FRConfig['navigations']} navigationsDefn
+ * @param {LH.Config.ResolvedConfig['navigations']} navigationsDefn
  * @return {{warnings: string[]}}
  */
 function assertValidFRNavigations(navigationsDefn) {
@@ -164,9 +164,9 @@ function assertValidAudit(auditDefinition) {
 }
 
 /**
- * @param {LH.Config.FRConfig['categories']} categories
- * @param {LH.Config.FRConfig['audits']} audits
- * @param {LH.Config.FRConfig['groups']} groups
+ * @param {LH.Config.ResolvedConfig['categories']} categories
+ * @param {LH.Config.ResolvedConfig['audits']} audits
+ * @param {LH.Config.ResolvedConfig['groups']} groups
  */
 function assertValidCategories(categories, audits, groups) {
   if (!categories) {
@@ -247,7 +247,7 @@ function assertArtifactTopologicalOrder(navigations) {
 }
 
 /**
- * @param {LH.Config.FRConfig} resolvedConfig
+ * @param {LH.Config.ResolvedConfig} resolvedConfig
  * @return {{warnings: string[]}}
  */
 function assertValidConfig(resolvedConfig) {

package/core/gather/base-artifacts.js

@@ -12,7 +12,7 @@ import {
 } from './driver/environment.js';
 
 /**
- * @param {LH.Config.FRConfig} resolvedConfig
+ * @param {LH.Config.ResolvedConfig} resolvedConfig
  * @param {LH.Gatherer.FRTransitionalDriver} driver
  * @param {{gatherMode: LH.Gatherer.GatherMode}} context
  * @return {Promise<LH.BaseArtifacts>}

package/core/gather/navigation-runner.js

@@ -29,7 +29,7 @@ import {NetworkRecords} from '../computed/network-records.js';
  * @typedef NavigationContext
  * @property {Driver} driver
  * @property {LH.Puppeteer.Page} page
- * @property {LH.Config.FRConfig} resolvedConfig
+ * @property {LH.Config.ResolvedConfig} resolvedConfig
  * @property {LH.Config.NavigationDefn} navigation
  * @property {LH.NavigationRequestor} requestor
  * @property {LH.FRBaseArtifacts} baseArtifacts
@@ -42,7 +42,7 @@ const DEFAULT_HOSTNAME = '127.0.0.1';
 const DEFAULT_PORT = 9222;
 
 /**
- * @param {{driver: Driver, resolvedConfig: LH.Config.FRConfig, requestor: LH.NavigationRequestor}} args
+ * @param {{driver: Driver, resolvedConfig: LH.Config.ResolvedConfig, requestor: LH.NavigationRequestor}} args
  * @return {Promise<{baseArtifacts: LH.FRBaseArtifacts}>}
  */
 async function _setup({driver, resolvedConfig, requestor}) {
@@ -250,7 +250,7 @@ async function _navigation(navigationContext) {
 }
 
 /**
- * @param {{driver: Driver, page: LH.Puppeteer.Page, resolvedConfig: LH.Config.FRConfig, requestor: LH.NavigationRequestor; baseArtifacts: LH.FRBaseArtifacts, computedCache: NavigationContext['computedCache']}} args
+ * @param {{driver: Driver, page: LH.Puppeteer.Page, resolvedConfig: LH.Config.ResolvedConfig, requestor: LH.NavigationRequestor; baseArtifacts: LH.FRBaseArtifacts, computedCache: NavigationContext['computedCache']}} args
  * @return {Promise<{artifacts: Partial<LH.FRArtifacts & LH.FRBaseArtifacts>}>}
  */
 async function _navigations(args) {
@@ -299,7 +299,7 @@ async function _navigations(args) {
 }
 
 /**
- * @param {{requestedUrl?: string, driver: Driver, resolvedConfig: LH.Config.FRConfig}} args
+ * @param {{requestedUrl?: string, driver: Driver, resolvedConfig: LH.Config.ResolvedConfig}} args
  */
 async function _cleanup({requestedUrl, driver, resolvedConfig}) {
   const didResetStorage = !resolvedConfig.settings.disableStorageReset && requestedUrl;

package/core/index.js

@@ -8,7 +8,7 @@ import log from 'lighthouse-logger';
 
 import {Runner} from './runner.js';
 import {CriConnection} from './legacy/gather/connections/cri.js';
-import {Config} from './legacy/config/config.js';
+import {LegacyResolvedConfig} from './legacy/config/config.js';
 import UrlUtils from './lib/url-utils.js';
 import {Driver} from './legacy/gather/driver.js';
 import {UserFlow, auditGatherSteps} from './user-flow.js';
@@ -63,7 +63,7 @@ async function legacyNavigation(url, flags = {}, configJSON, userConnection) {
   flags.logLevel = flags.logLevel || 'error';
   log.setLevel(flags.logLevel);
 
-  const resolvedConfig = await Config.fromJson(configJSON, flags);
+  const resolvedConfig = await LegacyResolvedConfig.fromJson(configJSON, flags);
   const computedCache = new Map();
   const options = {resolvedConfig, computedCache};
   const connection = userConnection || new CriConnection(flags.port, flags.hostname);

package/core/legacy/config/config.js

@@ -55,15 +55,15 @@ const BASE_ARTIFACT_BLANKS = {
 const BASE_ARTIFACT_NAMES = Object.keys(BASE_ARTIFACT_BLANKS);
 
 /**
- * @param {Config['passes']} passes
- * @param {Config['audits']} audits
+ * @param {LegacyResolvedConfig['passes']} passes
+ * @param {LegacyResolvedConfig['audits']} audits
  */
 function assertValidPasses(passes, audits) {
   if (!Array.isArray(passes)) {
     return;
   }
 
-  const requestedGatherers = Config.getGatherersRequestedByAudits(audits);
+  const requestedGatherers = LegacyResolvedConfig.getGatherersRequestedByAudits(audits);
   // Base artifacts are provided by GatherRunner, so start foundGatherers with them.
   const foundGatherers = new Set(BASE_ARTIFACT_NAMES);
 
@@ -129,15 +129,15 @@ function assertValidGatherer(gathererInstance, gathererName) {
 }
 
 /**
- * @implements {LH.Config.Config}
+ * @implements {LH.Config.LegacyResolvedConfig}
  */
-class Config {
+class LegacyResolvedConfig {
   /**
    * Resolves the provided config (inherits from extended config, if set), resolves
    * all referenced modules, and validates.
    * @param {LH.Config.Json=} configJSON If not provided, uses the default config.
    * @param {LH.Flags=} flags
-   * @return {Promise<Config>}
+   * @return {Promise<LegacyResolvedConfig>}
    */
   static async fromJson(configJSON, flags) {
     const status = {msg: 'Create config', id: 'lh:init:config'};
@@ -161,7 +161,8 @@ class Config {
       if (configJSON.extends !== 'lighthouse:default') {
         throw new Error('`lighthouse:default` is the only valid extension method.');
       }
-      configJSON = Config.extendConfigJSON(deepCloneConfigJson(legacyDefaultConfig), configJSON);
+      configJSON = LegacyResolvedConfig.extendConfigJSON(
+        deepCloneConfigJson(legacyDefaultConfig), configJSON);
     }
 
     // The directory of the config path, if one was provided.
@@ -173,13 +174,13 @@ class Config {
     const settings = resolveSettings(configJSON.settings || {}, flags);
 
     // Augment passes with necessary defaults and require gatherers.
-    const passesWithDefaults = Config.augmentPassesWithDefaults(configJSON.passes);
-    Config.adjustDefaultPassForThrottling(settings, passesWithDefaults);
-    const passes = await Config.requireGatherers(passesWithDefaults, configDir);
+    const passesWithDefaults = LegacyResolvedConfig.augmentPassesWithDefaults(configJSON.passes);
+    LegacyResolvedConfig.adjustDefaultPassForThrottling(settings, passesWithDefaults);
+    const passes = await LegacyResolvedConfig.requireGatherers(passesWithDefaults, configDir);
 
-    const audits = await Config.requireAudits(configJSON.audits, configDir);
+    const audits = await LegacyResolvedConfig.requireAudits(configJSON.audits, configDir);
 
-    const resolvedConfig = new Config(configJSON, {settings, passes, audits});
+    const resolvedConfig = new LegacyResolvedConfig(configJSON, {settings, passes, audits});
     log.timeEnd(status);
     return resolvedConfig;
   }
@@ -202,7 +203,7 @@ class Config {
     /** @type {?Record<string, LH.Config.Group>} */
     this.groups = configJSON.groups || null;
 
-    Config.filterConfigIfNeeded(this);
+    LegacyResolvedConfig.filterConfigIfNeeded(this);
 
     assertValidPasses(this.passes, this.audits);
     validation.assertValidCategories(this.categories, this.audits, this.groups);
@@ -308,7 +309,7 @@ class Config {
 
   /**
    * Filter out any unrequested items from the config, based on requested categories or audits.
-   * @param {Config} config
+   * @param {LegacyResolvedConfig} config
    */
   static filterConfigIfNeeded(config) {
     const settings = config.settings;
@@ -317,18 +318,19 @@ class Config {
     }
 
     // 1. Filter to just the chosen categories/audits
-    const {categories, requestedAuditNames} = Config.filterCategoriesAndAudits(config.categories,
-      settings);
+    const {categories, requestedAuditNames} =
+      LegacyResolvedConfig.filterCategoriesAndAudits(config.categories, settings);
 
     // 2. Resolve which audits will need to run
     const audits = config.audits && config.audits.filter(auditDefn =>
         requestedAuditNames.has(auditDefn.implementation.meta.id));
 
     // 3. Resolve which gatherers will need to run
-    const requestedGathererIds = Config.getGatherersRequestedByAudits(audits);
+    const requestedGathererIds = LegacyResolvedConfig.getGatherersRequestedByAudits(audits);
 
     // 4. Filter to only the neccessary passes
-    const passes = Config.generatePassesNeededByGatherers(config.passes, requestedGathererIds);
+    const passes =
+      LegacyResolvedConfig.generatePassesNeededByGatherers(config.passes, requestedGathererIds);
 
     config.categories = categories;
     config.audits = audits;
@@ -337,9 +339,9 @@ class Config {
 
   /**
    * Filter out any unrequested categories or audits from the categories object.
-   * @param {Config['categories']} oldCategories
+   * @param {LegacyResolvedConfig['categories']} oldCategories
    * @param {LH.Config.Settings} settings
-   * @return {{categories: Config['categories'], requestedAuditNames: Set<string>}}
+   * @return {{categories: LegacyResolvedConfig['categories'], requestedAuditNames: Set<string>}}
    */
   static filterCategoriesAndAudits(oldCategories, settings) {
     if (!oldCategories) {
@@ -350,7 +352,7 @@ class Config {
       throw new Error('Cannot set both skipAudits and onlyAudits');
     }
 
-    /** @type {NonNullable<Config['categories']>} */
+    /** @type {NonNullable<LegacyResolvedConfig['categories']>} */
     const categories = {};
     const filterByIncludedCategory = !!settings.onlyCategories;
     const filterByIncludedAudit = !!settings.onlyAudits;
@@ -424,7 +426,7 @@ class Config {
 
   /**
    * From some requested audits, return names of all required and optional artifacts
-   * @param {Config['audits']} audits
+   * @param {LegacyResolvedConfig['audits']} audits
    * @return {Set<string>}
    */
   static getGatherersRequestedByAudits(audits) {
@@ -447,9 +449,9 @@ class Config {
 
   /**
    * Filters to only requested passes and gatherers, returning a new passes array.
-   * @param {Config['passes']} passes
+   * @param {LegacyResolvedConfig['passes']} passes
    * @param {Set<string>} requestedGatherers
-   * @return {Config['passes']}
+   * @return {LegacyResolvedConfig['passes']}
    */
   static generatePassesNeededByGatherers(passes, requestedGatherers) {
     if (!passes) {
@@ -488,7 +490,7 @@ class Config {
    * leaving only an array of AuditDefns.
    * @param {LH.Config.Json['audits']} audits
    * @param {string=} configDir
-   * @return {Promise<Config['audits']>}
+   * @return {Promise<LegacyResolvedConfig['audits']>}
    */
   static async requireAudits(audits, configDir) {
     const status = {msg: 'Requiring audits', id: 'lh:config:requireAudits'};
@@ -504,7 +506,7 @@ class Config {
    * provided) using `resolveModulePath`, returning an array of full Passes.
    * @param {?Array<Required<LH.Config.PassJson>>} passes
    * @param {string=} configDir
-   * @return {Promise<Config['passes']>}
+   * @return {Promise<LegacyResolvedConfig['passes']>}
    */
   static async requireGatherers(passes, configDir) {
     if (!passes) {
@@ -535,4 +537,4 @@ class Config {
   }
 }
 
-export {Config};
+export {LegacyResolvedConfig};

package/core/runner.js

@@ -28,11 +28,11 @@ const moduleDir = getModuleDirectory(import.meta);
 
 /** @typedef {import('./legacy/gather/connections/connection.js').Connection} Connection */
 /** @typedef {import('./lib/arbitrary-equality-map.js').ArbitraryEqualityMap} ArbitraryEqualityMap */
-/** @typedef {LH.Config.Config} Config */
+/** @typedef {LH.Config.LegacyResolvedConfig} Config */
 
 class Runner {
   /**
-   * @template {LH.Config.Config | LH.Config.FRConfig} TConfig
+   * @template {LH.Config.LegacyResolvedConfig | LH.Config.ResolvedConfig} TConfig
    * @param {LH.Artifacts} artifacts
    * @param {{resolvedConfig: TConfig, driverMock?: Driver, computedCache: Map<string, ArbitraryEqualityMap>}} options
    * @return {Promise<LH.RunnerResult|undefined>}
@@ -142,7 +142,7 @@ class Runner {
    * -G and -A will run partial lighthouse pipelines,
    * and -GA will run everything plus save artifacts and lhr to disk.
    *
-   * @template {LH.Config.Config | LH.Config.FRConfig} TConfig
+   * @template {LH.Config.LegacyResolvedConfig | LH.Config.ResolvedConfig} TConfig
    * @param {(runnerData: {resolvedConfig: TConfig, driverMock?: Driver}) => Promise<LH.Artifacts>} gatherFn
    * @param {{resolvedConfig: TConfig, driverMock?: Driver, computedCache: Map<string, ArbitraryEqualityMap>}} options
    * @return {Promise<LH.Artifacts>}

package/package.json

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

package/types/config.d.ts

@@ -34,9 +34,9 @@ declare module Config {
   }
 
   /**
-   * The normalized and fully resolved config.
+   * The normalized and fully resolved legacy config.
    */
-  interface Config {
+  interface LegacyResolvedConfig {
     settings: Settings;
     passes: Pass[] | null;
     audits: AuditDefn[] | null;
@@ -45,9 +45,9 @@ declare module Config {
   }
 
   /**
-   * The normalized and fully resolved Fraggle Rock config.
+   * The normalized and fully resolved config.
    */
-  interface FRConfig {
+  interface ResolvedConfig {
     settings: Settings;
     artifacts: AnyArtifactDefn[] | null;
     navigations: NavigationDefn[] | null;

package/types/gatherer.d.ts

@@ -67,7 +67,7 @@ declare module Gatherer {
   interface FRGatherResult {
     artifacts: Artifacts;
     runnerOptions: {
-      resolvedConfig: Config.FRConfig;
+      resolvedConfig: Config.ResolvedConfig;
       computedCache: Map<string, ArbitraryEqualityMap>
     }
   }