core: deprecate passes, remove config navigations from FR

lighthouse-core/config/constants.js

@@ -119,6 +119,14 @@ const defaultSettings = {
   onlyAudits: null,
   onlyCategories: null,
   skipAudits: null,
+
+  // The following settings are from SharedPassNavigationJson
+  // They are historically defined on a legacy pass but have been moved here as part of FR.
+  pauseAfterFcpMs: 1000,
+  pauseAfterLoadMs: 1000,
+  networkQuietThresholdMs: 1000,
+  cpuQuietThresholdMs: 1000,
+  blankPage: 'about:blank',
 };
 
 /** @type {LH.Config.Pass} */
@@ -136,21 +144,6 @@ const defaultPassConfig = {
   gatherers: [],
 };
 
-/** @type {Required<LH.Config.NavigationJson>} */
-const defaultNavigationConfig = {
-  id: 'default',
-  loadFailureMode: 'fatal',
-  disableThrottling: false,
-  disableStorageReset: false,
-  pauseAfterFcpMs: 0,
-  pauseAfterLoadMs: 0,
-  networkQuietThresholdMs: 0,
-  cpuQuietThresholdMs: 0,
-  blockedUrlPatterns: [],
-  blankPage: 'about:blank',
-  artifacts: [],
-};
-
 const nonSimulatedPassConfigOverrides = {
   pauseAfterFcpMs: 5250,
   pauseAfterLoadMs: 5250,
@@ -164,6 +157,5 @@ module.exports = {
   userAgents,
   defaultSettings,
   defaultPassConfig,
-  defaultNavigationConfig,
   nonSimulatedPassConfigOverrides,
 };

lighthouse-core/fraggle-rock/config/config.js

@@ -9,13 +9,12 @@ const path = require('path');
 const log = require('lighthouse-logger');
 const Runner = require('../../runner.js');
 const defaultConfig = require('./default-config.js');
-const {defaultNavigationConfig, nonSimulatedPassConfigOverrides} = require('../../config/constants.js'); // eslint-disable-line max-len
+const {nonSimulatedPassConfigOverrides} = require('../../config/constants.js'); // eslint-disable-line max-len
 const {
   isFRGathererDefn,
   throwInvalidDependencyOrder,
   isValidArtifactDependency,
   throwInvalidArtifactDependency,
-  assertArtifactTopologicalOrder,
   assertValidConfig,
 } = require('./validation.js');
 const {filterConfigByGatherMode, filterConfigByExplicitFilters} = require('./filters.js');
@@ -70,7 +69,7 @@ function resolveExtensions(configJSON) {
     throw new Error('`lighthouse:default` is the only valid extension method.');
   }
 
-  const {artifacts, navigations, ...extensionJSON} = configJSON;
+  const {artifacts, ...extensionJSON} = configJSON;
   const defaultClone = deepCloneConfigJson(defaultConfig);
   const mergedConfig = mergeConfigFragment(defaultClone, extensionJSON);
 
@@ -79,11 +78,6 @@ function resolveExtensions(configJSON) {
     artifacts,
     artifact => artifact.id
   );
-  mergedConfig.navigations = mergeConfigFragmentArrayByKey(
-    defaultClone.navigations,
-    navigations,
-    navigation => navigation.id
-  );
 
   return mergedConfig;
 }
@@ -178,71 +172,33 @@ function overrideSettingsForGatherMode(settings, context) {
 /**
  * Overrides the quiet windows when throttlingMethod requires observation.
  *
- * @param {LH.Config.NavigationDefn} navigation
  * @param {LH.Config.Settings} settings
  */
-function overrideNavigationThrottlingWindows(navigation, settings) {
-  if (navigation.disableThrottling) return;
+function overrideSettingsThrottlingWindows(settings) {
   if (settings.throttlingMethod === 'simulate') return;
 
-  navigation.cpuQuietThresholdMs = Math.max(
-    navigation.cpuQuietThresholdMs || 0,
+  settings.cpuQuietThresholdMs = Math.max(
+    settings.cpuQuietThresholdMs || 0,
     nonSimulatedPassConfigOverrides.cpuQuietThresholdMs
   );
-  navigation.networkQuietThresholdMs = Math.max(
-    navigation.networkQuietThresholdMs || 0,
+  settings.networkQuietThresholdMs = Math.max(
+    settings.networkQuietThresholdMs || 0,
     nonSimulatedPassConfigOverrides.networkQuietThresholdMs
   );
-  navigation.pauseAfterFcpMs = Math.max(
-    navigation.pauseAfterFcpMs || 0,
+  settings.pauseAfterFcpMs = Math.max(
+    settings.pauseAfterFcpMs || 0,
     nonSimulatedPassConfigOverrides.pauseAfterFcpMs
   );
-  navigation.pauseAfterLoadMs = Math.max(
-    navigation.pauseAfterLoadMs || 0,
+  settings.pauseAfterLoadMs = Math.max(
+    settings.pauseAfterLoadMs || 0,
     nonSimulatedPassConfigOverrides.pauseAfterLoadMs
   );
 }
 
-/**
- *
- * @param {LH.Config.NavigationJson[]|null|undefined} navigations
- * @param {LH.Config.AnyArtifactDefn[]|null|undefined} artifactDefns
- * @param {LH.Config.Settings} settings
- * @return {LH.Config.NavigationDefn[] | null}
- */
-function resolveNavigationsToDefns(navigations, artifactDefns, settings) {
-  if (!navigations) return null;
-  if (!artifactDefns) throw new Error('Cannot use navigations without defining artifacts');
-
-  const status = {msg: 'Resolve navigation definitions', id: 'lh:config:resolveNavigationsToDefns'};
-  log.time(status, 'verbose');
-
-  const artifactsById = new Map(artifactDefns.map(defn => [defn.id, defn]));
-
-  const navigationDefns = navigations.map(navigation => {
-    const navigationWithDefaults = {...defaultNavigationConfig, ...navigation};
-    const navId = navigationWithDefaults.id;
-    const artifacts = navigationWithDefaults.artifacts.map(id => {
-      const artifact = artifactsById.get(id);
-      if (!artifact) throw new Error(`Unrecognized artifact "${id}" in navigation "${navId}"`);
-      return artifact;
-    });
-
-    const resolvedNavigation = {...navigationWithDefaults, artifacts};
-    overrideNavigationThrottlingWindows(resolvedNavigation, settings);
-    return resolvedNavigation;
-  });
-
-  assertArtifactTopologicalOrder(navigationDefns);
-
-  log.timeEnd(status);
-  return navigationDefns;
-}
-
 /**
  * @param {LH.Config.Json|undefined} configJSON
  * @param {ConfigContext} context
- * @return {{config: LH.Config.FRConfig, warnings: string[]}}
+ * @return {{config: LH.Config.FRConfig}}
  */
 function initializeConfig(configJSON, context) {
   const status = {msg: 'Initialize config', id: 'lh:config'};
@@ -257,25 +213,24 @@ function initializeConfig(configJSON, context) {
   overrideSettingsForGatherMode(settings, context);
 
   const artifacts = resolveArtifactsToDefns(configWorkingCopy.artifacts, configDir);
-  const navigations = resolveNavigationsToDefns(configWorkingCopy.navigations, artifacts, settings);
+  overrideSettingsThrottlingWindows(settings);
 
   /** @type {LH.Config.FRConfig} */
   let config = {
     artifacts,
-    navigations,
     audits: resolveAuditsToDefns(configWorkingCopy.audits, configDir),
     categories: configWorkingCopy.categories || null,
     groups: configWorkingCopy.groups || null,
     settings,
   };
 
-  const {warnings} = assertValidConfig(config);
+  assertValidConfig(config);
 
   config = filterConfigByGatherMode(config, context.gatherMode);
   config = filterConfigByExplicitFilters(config, settings);
 
   log.timeEnd(status);
-  return {config, warnings};
+  return {config};
 }
 
 module.exports = {resolveWorkingCopy, initializeConfig};

lighthouse-core/fraggle-rock/config/default-config.js

@@ -98,7 +98,6 @@ const defaultConfig = {
     {id: artifacts.EmbeddedContent, gatherer: 'seo/embedded-content'},
     {id: artifacts.FontSize, gatherer: 'seo/font-size'},
     {id: artifacts.Inputs, gatherer: 'inputs'},
-    {id: artifacts.FullPageScreenshot, gatherer: 'full-page-screenshot'},
     {id: artifacts.GlobalListeners, gatherer: 'global-listeners'},
     {id: artifacts.IFrameElements, gatherer: 'iframe-elements'},
     {id: artifacts.ImageElements, gatherer: 'image-elements'},
@@ -128,62 +127,9 @@ const defaultConfig = {
     // Artifact copies are renamed for compatibility with legacy artifacts.
     {id: artifacts.devtoolsLogs, gatherer: 'devtools-log-compat'},
     {id: artifacts.traces, gatherer: 'trace-compat'},
-  ],
-  navigations: [
-    {
-      id: 'default',
-      pauseAfterFcpMs: 1000,
-      pauseAfterLoadMs: 1000,
-      networkQuietThresholdMs: 1000,
-      cpuQuietThresholdMs: 1000,
-      artifacts: [
-        // Artifacts which can be depended on come first.
-        artifacts.DevtoolsLog,
-        artifacts.Trace,
-
-        artifacts.Accessibility,
-        artifacts.AnchorElements,
-        artifacts.CacheContents,
-        artifacts.ConsoleMessages,
-        artifacts.CSSUsage,
-        artifacts.Doctype,
-        artifacts.DOMStats,
-        artifacts.EmbeddedContent,
-        artifacts.FontSize,
-        artifacts.Inputs,
-        artifacts.GlobalListeners,
-        artifacts.IFrameElements,
-        artifacts.ImageElements,
-        artifacts.InstallabilityErrors,
-        artifacts.InspectorIssues,
-        artifacts.JsUsage,
-        artifacts.LinkElements,
-        artifacts.MainDocumentContent,
-        artifacts.MetaElements,
-        artifacts.NetworkUserAgent,
-        artifacts.OptimizedImages,
-        artifacts.PasswordInputsWithPreventedPaste,
-        artifacts.ResponseCompression,
-        artifacts.RobotsTxt,
-        artifacts.ServiceWorker,
-        artifacts.ScriptElements,
-        artifacts.Scripts,
-        artifacts.SourceMaps,
-        artifacts.Stacks,
-        artifacts.TagsBlockingFirstPaint,
-        artifacts.TapTargets,
-        artifacts.TraceElements,
-        artifacts.ViewportDimensions,
-        artifacts.WebAppManifest,
 
-        // Compat artifacts come last.
-        artifacts.devtoolsLogs,
-        artifacts.traces,
-
-        // FullPageScreenshot comes at the very end so all other node analysis is captured.
-        artifacts.FullPageScreenshot,
-      ],
-    },
+    // FullPageScreenshot comes at the very end so all other node analysis is captured.
+    {id: artifacts.FullPageScreenshot, gatherer: 'full-page-screenshot'},
   ],
   settings: legacyDefaultConfig.settings,
   audits: [

lighthouse-core/fraggle-rock/config/filters.js

@@ -105,30 +105,6 @@ 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 {Array<LH.Config.AnyArtifactDefn>} availableArtifacts
- * @return {LH.Config.FRConfig['navigations']}
- */
-function filterNavigationsByAvailableArtifacts(navigations, availableArtifacts) {
-  if (!navigations) return navigations;
-
-  const availableArtifactIds = new Set(
-    availableArtifacts.map(artifact => artifact.id).concat(baseArtifactKeys)
-  );
-
-  return navigations
-    .map(navigation => {
-      return {
-        ...navigation,
-        artifacts: navigation.artifacts.filter((artifact) => availableArtifactIds.has(artifact.id)),
-      };
-    })
-    .filter(navigation => navigation.artifacts.length);
-}
-
 /**
  * Filters an array of audits down to the set that can be computed using only the specified artifacts.
  *
@@ -310,12 +286,10 @@ function filterConfigByExplicitFilters(config, filters) {
   const availableCategories = filterCategoriesByAvailableAudits(config.categories, audits || []);
   const categories = filterCategoriesByExplicitFilters(availableCategories, onlyCategories);
   const artifacts = filterArtifactsByAvailableAudits(config.artifacts, audits);
-  const navigations = filterNavigationsByAvailableArtifacts(config.navigations, artifacts || []);
 
   return {
     ...config,
     artifacts,
-    navigations,
     audits,
     categories,
   };
@@ -326,7 +300,6 @@ module.exports = {
   filterConfigByExplicitFilters,
   filterArtifactsByGatherMode,
   filterArtifactsByAvailableAudits,
-  filterNavigationsByAvailableArtifacts,
   filterAuditsByAvailableArtifacts,
   filterAuditsByGatherMode,
   filterCategoriesByAvailableAudits,