core(fr): replace configContext with flags (GoogleChrome#14050)

cli/test/cli/__snapshots__/index-test.js.snap

@@ -187,6 +187,7 @@ Object {
       "mobile": true,
       "width": 360,
     },
+    "skipAboutBlank": false,
     "skipAudits": null,
     "throttling": Object {
       "cpuSlowdownMultiplier": 4,
@@ -359,6 +360,7 @@ Object {
       "mobile": true,
       "width": 360,
     },
+    "skipAboutBlank": false,
     "skipAudits": null,
     "throttling": Object {
       "cpuSlowdownMultiplier": 4,

core/config/config-helpers.js

@@ -606,20 +606,6 @@ function deepCloneConfigJson(json) {
   return cloned;
 }
 
-/**
- * @param {LH.Flags} flags
- * @return {LH.Config.FRContext}
- */
-function flagsToFRContext(flags) {
-  return {
-    configPath: flags?.configPath,
-    settingsOverrides: flags,
-    logLevel: flags?.logLevel,
-    hostname: flags?.hostname,
-    port: flags?.port,
-  };
-}
-
 export {
   deepClone,
   deepCloneConfigJson,
@@ -631,5 +617,4 @@ export {
   resolveGathererToDefn,
   resolveModulePath,
   resolveSettings,
-  flagsToFRContext,
 };

core/config/constants.js

@@ -119,6 +119,7 @@ const defaultSettings = {
   onlyAudits: null,
   onlyCategories: null,
   skipAudits: null,
+  skipAboutBlank: false,
 };
 
 /** @type {LH.Config.Pass} */

core/fraggle-rock/config/config.js

@@ -40,8 +40,6 @@ const defaultConfigPath = path.join(
   '../../config/default-config.js'
 );
 
-/** @typedef {LH.Config.FRContext & {gatherMode: LH.Gatherer.GatherMode}} ConfigContext */
-
 /**
  * @param {LH.Config.Json|undefined} configJSON
  * @param {{configPath?: string}} context
@@ -176,10 +174,10 @@ async function resolveArtifactsToDefns(artifacts, configDir) {
  * Overrides the settings that may not apply to the chosen gather mode.
  *
  * @param {LH.Config.Settings} settings
- * @param {ConfigContext} context
+ * @param {LH.Gatherer.GatherMode} gatherMode
  */
-function overrideSettingsForGatherMode(settings, context) {
-  if (context.gatherMode === 'timespan') {
+function overrideSettingsForGatherMode(settings, gatherMode) {
+  if (gatherMode === 'timespan') {
     if (settings.throttlingMethod === 'simulate') {
       settings.throttlingMethod = 'devtools';
     }
@@ -251,21 +249,22 @@ function resolveNavigationsToDefns(navigations, artifactDefns, settings) {
 }
 
 /**
- * @param {LH.Config.Json|undefined} configJSON
- * @param {ConfigContext} context
+ * @param {LH.Gatherer.GatherMode} gatherMode
+ * @param {LH.Config.Json=} configJSON
+ * @param {LH.Flags=} flags
  * @return {Promise<{config: LH.Config.FRConfig, warnings: string[]}>}
  */
-async function initializeConfig(configJSON, context) {
+async function initializeConfig(gatherMode, configJSON, flags = {}) {
   const status = {msg: 'Initialize config', id: 'lh:config'};
   log.time(status, 'verbose');
 
-  let {configWorkingCopy, configDir} = resolveWorkingCopy(configJSON, context); // eslint-disable-line prefer-const
+  let {configWorkingCopy, configDir} = resolveWorkingCopy(configJSON, flags);
 
   configWorkingCopy = resolveExtensions(configWorkingCopy);
-  configWorkingCopy = await mergePlugins(configWorkingCopy, configDir, context.settingsOverrides);
+  configWorkingCopy = await mergePlugins(configWorkingCopy, configDir, flags);
 
-  const settings = resolveSettings(configWorkingCopy.settings || {}, context.settingsOverrides);
-  overrideSettingsForGatherMode(settings, context);
+  const settings = resolveSettings(configWorkingCopy.settings || {}, flags);
+  overrideSettingsForGatherMode(settings, gatherMode);
 
   const artifacts = await resolveArtifactsToDefns(configWorkingCopy.artifacts, configDir);
   const navigations = resolveNavigationsToDefns(configWorkingCopy.navigations, artifacts, settings);
@@ -282,7 +281,7 @@ async function initializeConfig(configJSON, context) {
 
   const {warnings} = assertValidConfig(config);
 
-  config = filterConfigByGatherMode(config, context.gatherMode);
+  config = filterConfigByGatherMode(config, gatherMode);
   config = filterConfigByExplicitFilters(config, settings);
 
   log.timeEnd(status);

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

@@ -25,8 +25,6 @@ import Trace from '../../gather/gatherers/trace.js';
 import DevtoolsLog from '../../gather/gatherers/devtools-log.js';
 import NetworkRecords from '../../computed/network-records.js';
 
-/** @typedef {{skipAboutBlank?: boolean}} InternalOptions */
-
 /**
  * @typedef NavigationContext
  * @property {Driver} driver
@@ -35,7 +33,6 @@ import NetworkRecords from '../../computed/network-records.js';
  * @property {LH.NavigationRequestor} requestor
  * @property {LH.FRBaseArtifacts} baseArtifacts
  * @property {Map<string, LH.ArbitraryEqualityMap>} computedCache
- * @property {InternalOptions} [options]
  */
 
 /** @typedef {Omit<Parameters<typeof collectPhaseArtifacts>[0], 'phase'>} PhaseState */
@@ -44,12 +41,14 @@ const DEFAULT_HOSTNAME = '127.0.0.1';
 const DEFAULT_PORT = 9222;
 
 /**
- * @param {{driver: Driver, config: LH.Config.FRConfig, options?: InternalOptions}} args
+ * @param {{driver: Driver, config: LH.Config.FRConfig, requestor: LH.NavigationRequestor}} args
  * @return {Promise<{baseArtifacts: LH.FRBaseArtifacts}>}
  */
-async function _setup({driver, config, options}) {
+async function _setup({driver, config, requestor}) {
   await driver.connect();
-  if (!options?.skipAboutBlank) {
+
+  // We can't trigger the navigation through user interaction if we reset the page before starting.
+  if (typeof requestor === 'string' && !config.settings.skipAboutBlank) {
     await gotoURL(driver, defaultNavigationConfig.blankPage, {waitUntil: ['navigated']});
   }
 
@@ -64,10 +63,12 @@ async function _setup({driver, config, options}) {
  * @param {NavigationContext} navigationContext
  * @return {Promise<{warnings: Array<LH.IcuMessage>}>}
  */
-async function _setupNavigation({requestor, driver, navigation, config, options}) {
-  if (!options?.skipAboutBlank) {
+async function _setupNavigation({requestor, driver, navigation, config}) {
+  // We can't trigger the navigation through user interaction if we reset the page before starting.
+  if (typeof requestor === 'string' && !config.settings.skipAboutBlank) {
     await gotoURL(driver, navigation.blankPage, {...navigation, waitUntil: ['navigated']});
   }
+
   const {warnings} = await prepare.prepareTargetForIndividualNavigation(
     driver.defaultSession,
     config.settings,
@@ -249,10 +250,10 @@ async function _navigation(navigationContext) {
 }
 
 /**
- * @param {{driver: Driver, config: LH.Config.FRConfig, requestor: LH.NavigationRequestor; baseArtifacts: LH.FRBaseArtifacts, computedCache: NavigationContext['computedCache'], options?: InternalOptions}} args
+ * @param {{driver: Driver, config: LH.Config.FRConfig, requestor: LH.NavigationRequestor; baseArtifacts: LH.FRBaseArtifacts, computedCache: NavigationContext['computedCache']}} args
  * @return {Promise<{artifacts: Partial<LH.FRArtifacts & LH.FRBaseArtifacts>}>}
  */
-async function _navigations({driver, config, requestor, baseArtifacts, computedCache, options}) {
+async function _navigations({driver, config, requestor, baseArtifacts, computedCache}) {
   if (!config.navigations) throw new Error('No navigations configured');
 
   /** @type {Partial<LH.FRArtifacts & LH.FRBaseArtifacts>} */
@@ -268,7 +269,6 @@ async function _navigations({driver, config, requestor, baseArtifacts, computedC
       config,
       baseArtifacts,
       computedCache,
-      options,
     };
 
     let shouldHaltNavigations = false;
@@ -300,25 +300,17 @@ async function _cleanup({requestedUrl, driver, config}) {
 
 /**
  * @param {LH.NavigationRequestor|undefined} requestor
- * @param {{page?: LH.Puppeteer.Page, config?: LH.Config.Json, configContext?: LH.Config.FRContext}} options
+ * @param {{page?: LH.Puppeteer.Page, config?: LH.Config.Json, flags?: LH.Flags}} options
  * @return {Promise<LH.Gatherer.FRGatherResult>}
  */
 async function navigationGather(requestor, options) {
-  const {configContext = {}} = options;
-  log.setLevel(configContext.logLevel || 'error');
+  const {flags = {}} = options;
+  log.setLevel(flags.logLevel || 'error');
 
-  const {config} =
-    await initializeConfig(options.config, {...configContext, gatherMode: 'navigation'});
+  const {config} = await initializeConfig('navigation', options.config, flags);
   const computedCache = new Map();
-  const internalOptions = {
-    skipAboutBlank: configContext.skipAboutBlank,
-  };
 
-  // We can't trigger the navigation through user interaction if we reset the page before starting.
   const isCallback = typeof requestor === 'function';
-  if (isCallback) {
-    internalOptions.skipAboutBlank = true;
-  }
 
   const runnerOptions = {config, computedCache};
   const artifacts = await Runner.gather(
@@ -329,7 +321,7 @@ async function navigationGather(requestor, options) {
       // For navigation mode, we shouldn't connect to a browser in audit mode,
       // therefore we connect to the browser in the gatherFn callback.
       if (!page) {
-        const {hostname = DEFAULT_HOSTNAME, port = DEFAULT_PORT} = configContext;
+        const {hostname = DEFAULT_HOSTNAME, port = DEFAULT_PORT} = flags;
         const browser = await puppeteer.connect({browserURL: `http://${hostname}:${port}`});
         page = await browser.newPage();
       }
@@ -339,7 +331,6 @@ async function navigationGather(requestor, options) {
         driver,
         config,
         requestor: normalizedRequestor,
-        options: internalOptions,
       };
       const {baseArtifacts} = await _setup(context);
       const {artifacts} = await _navigations({...context, baseArtifacts, computedCache});

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

@@ -13,15 +13,14 @@ import {initializeConfig} from '../config/config.js';
 import {getBaseArtifacts, finalizeArtifacts} from './base-artifacts.js';
 
 /**
- * @param {{page: LH.Puppeteer.Page, config?: LH.Config.Json, configContext?: LH.Config.FRContext}} options
+ * @param {{page: LH.Puppeteer.Page, config?: LH.Config.Json, flags?: LH.Flags}} options
  * @return {Promise<LH.Gatherer.FRGatherResult>}
  */
 async function snapshotGather(options) {
-  const {configContext = {}} = options;
-  log.setLevel(configContext.logLevel || 'error');
+  const {flags = {}} = options;
+  log.setLevel(flags.logLevel || 'error');
 
-  const {config} =
-    await initializeConfig(options.config, {...configContext, gatherMode: 'snapshot'});
+  const {config} = await initializeConfig('snapshot', options.config, flags);
   const driver = new Driver(options.page);
   await driver.connect();
 

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

@@ -14,15 +14,14 @@ import {initializeConfig} from '../config/config.js';
 import {getBaseArtifacts, finalizeArtifacts} from './base-artifacts.js';
 
 /**
- * @param {{page: LH.Puppeteer.Page, config?: LH.Config.Json, configContext?: LH.Config.FRContext}} options
+ * @param {{page: LH.Puppeteer.Page, config?: LH.Config.Json, flags?: LH.Flags}} options
  * @return {Promise<{endTimespanGather(): Promise<LH.Gatherer.FRGatherResult>}>}
  */
 async function startTimespanGather(options) {
-  const {configContext = {}} = options;
-  log.setLevel(configContext.logLevel || 'error');
+  const {flags = {}} = options;
+  log.setLevel(flags.logLevel || 'error');
 
-  const {config} =
-    await initializeConfig(options.config, {...configContext, gatherMode: 'timespan'});
+  const {config} = await initializeConfig('timespan', options.config, flags);
   const driver = new Driver(options.page);
   await driver.connect();
 

core/fraggle-rock/user-flow.js

@@ -63,24 +63,22 @@ class UserFlow {
    */
   _getNextNavigationOptions(stepOptions) {
     const options = {...this.options, ...stepOptions};
-    const configContext = {...options.configContext};
-    const settingsOverrides = {...configContext.settingsOverrides};
+    const flags = {...options.flags};
 
-    if (configContext.skipAboutBlank === undefined) {
-      configContext.skipAboutBlank = true;
+    if (flags.skipAboutBlank === undefined) {
+      flags.skipAboutBlank = true;
     }
 
     // On repeat navigations, we want to disable storage reset by default (i.e. it's not a cold load).
     const isSubsequentNavigation = this._gatherSteps
       .some(step => step.artifacts.GatherContext.gatherMode === 'navigation');
     if (isSubsequentNavigation) {
-      if (settingsOverrides.disableStorageReset === undefined) {
-        settingsOverrides.disableStorageReset = true;
+      if (flags.disableStorageReset === undefined) {
+        flags.disableStorageReset = true;
       }
     }
 
-    configContext.settingsOverrides = settingsOverrides;
-    options.configContext = configContext;
+    options.flags = flags;
 
     return options;
   }
@@ -96,7 +94,7 @@ class UserFlow {
       artifacts: gatherResult.artifacts,
       name: providedName || this._getDefaultStepName(gatherResult.artifacts),
       config: options.config,
-      configContext: options.configContext,
+      flags: options.flags,
     };
     this._gatherSteps.push(gatherStep);
     this._gatherStepRunnerOptions.set(gatherStep, gatherResult.runnerOptions);
@@ -246,7 +244,7 @@ async function auditGatherSteps(gatherSteps, options) {
   /** @type {LH.FlowResult['steps']} */
   const steps = [];
   for (const gatherStep of gatherSteps) {
-    const {artifacts, name, configContext} = gatherStep;
+    const {artifacts, name, flags} = gatherStep;
 
     let runnerOptions = options.gatherStepRunnerOptions?.get(gatherStep);
 
@@ -255,7 +253,7 @@ async function auditGatherSteps(gatherSteps, options) {
       // Step specific configs take precedence over a config for the entire flow.
       const configJson = gatherStep.config || options.config;
       const {gatherMode} = artifacts.GatherContext;
-      const {config} = await initializeConfig(configJson, {...configContext, gatherMode});
+      const {config} = await initializeConfig(gatherMode, configJson, flags);
       runnerOptions = {
         config,
         computedCache: new Map(),

core/index.js

@@ -12,7 +12,6 @@ import {Config} from './config/config.js';
 import URL from './lib/url-shim.js';
 import * as fraggleRock from './fraggle-rock/api.js';
 import {Driver} from './gather/driver.js';
-import {flagsToFRContext} from './config/config-helpers.js';
 import {initializeConfig} from './fraggle-rock/config/config.js';
 
 /** @typedef {import('./gather/connections/connection.js').Connection} Connection */
@@ -41,8 +40,7 @@ import {initializeConfig} from './fraggle-rock/config/config.js';
  * @return {Promise<LH.RunnerResult|undefined>}
  */
 async function lighthouse(url, flags = {}, configJSON, page) {
-  const configContext = flagsToFRContext(flags);
-  return fraggleRock.navigation(url, {page, config: configJSON, configContext});
+  return fraggleRock.navigation(url, {page, config: configJSON, flags});
 }
 
 /**
@@ -86,8 +84,7 @@ async function legacyNavigation(url, flags = {}, configJSON, userConnection) {
  * @return {Promise<LH.Config.FRConfig>}
  */
 async function generateConfig(configJson, flags = {}, gatherMode = 'navigation') {
-  const configContext = flagsToFRContext(flags);
-  const {config} = await initializeConfig(configJson, {...configContext, gatherMode});
+  const {config} = await initializeConfig(gatherMode, configJson, flags);
   return config;
 }
 

core/scripts/print-a11y-scoring.js

@@ -8,7 +8,7 @@
 
 import {initializeConfig} from '../fraggle-rock/config/config.js';
 
-const {config} = await initializeConfig(undefined, {gatherMode: 'navigation'});
+const {config} = await initializeConfig('navigation');
 if (!config.categories || !config.audits) throw new Error('wut');
 
 const auditRefs = config.categories.accessibility.auditRefs;