lighthouse 10.4.0-dev.20230712 → 10.4.0-dev.20230714

package/cli/cli-flags.d.ts

@@ -24,7 +24,7 @@ export function getYargsParser(manualArgv?: string | undefined): yargs.Argv<yarg
         default: boolean;
         describe: string;
     };
-}>, "port" | "screenEmulation" | "emulatedUserAgent" | "hostname" | "preset" | "save-assets" | "list-all-audits" | "list-locales" | "list-trace-categories" | "debug-navigation" | "legacy-navigation" | "additional-trace-categories" | "config-path" | "chrome-flags" | "form-factor" | "max-wait-for-load" | "enable-error-reporting" | "gather-mode" | "audit-mode" | "only-audits" | "only-categories" | "skip-audits" | "budget-path" | "disable-full-page-screenshot"> & yargs.InferredOptionTypes<{
+}>, "port" | "screenEmulation" | "emulatedUserAgent" | "hostname" | "preset" | "save-assets" | "list-all-audits" | "list-locales" | "list-trace-categories" | "debug-navigation" | "additional-trace-categories" | "config-path" | "chrome-flags" | "form-factor" | "max-wait-for-load" | "enable-error-reporting" | "gather-mode" | "audit-mode" | "only-audits" | "only-categories" | "skip-audits" | "budget-path" | "disable-full-page-screenshot"> & yargs.InferredOptionTypes<{
     'save-assets': {
         type: "boolean";
         default: boolean;
@@ -49,11 +49,6 @@ export function getYargsParser(manualArgv?: string | undefined): yargs.Argv<yarg
         type: "boolean";
         describe: string;
     };
-    'legacy-navigation': {
-        type: "boolean";
-        default: boolean;
-        describe: string;
-    };
     'additional-trace-categories': {
         type: "string";
         describe: string;

package/cli/cli-flags.js

@@ -117,11 +117,6 @@ function getYargsParser(manualArgv) {
         type: 'boolean',
         describe: 'Pause after page load to wait for permission to continue the run, evaluate `continueLighthouseRun` in the console to continue.',
       },
-      'legacy-navigation': {
-        type: 'boolean',
-        default: false,
-        describe: '[DEPRECATED] Use the legacy navigation runner to gather results. Only use this if you are using a pre-10.0 custom Lighthouse config, or if Lighthouse unexpectedly fails after updating to 10.0. Please file a bug if you need this flag for Lighthouse to work.',
-      },
       'additional-trace-categories': {
         type: 'string',
         describe: 'Additional categories to capture with the trace (comma-delimited).',

package/cli/run.js

@@ -16,7 +16,7 @@ import log from 'lighthouse-logger';
 import open from 'open';
 
 import * as Printer from './printer.js';
-import lighthouse, {legacyNavigation} from '../core/index.js';
+import lighthouse from '../core/index.js';
 import {getLhrFilenamePrefix} from '../report/generator/file-namer.js';
 import * as assetSaver from '../core/lib/asset-saver.js';
 import UrlUtils from '../core/lib/url-utils.js';
@@ -238,16 +238,9 @@ async function runLighthouse(url, flags, config) {
       flags.port = launchedChrome.port;
     }
 
-    if (flags.legacyNavigation) {
-      log.warn('CLI', 'Legacy navigation CLI is deprecated');
-      flags.channel = 'legacy-navigation-cli';
-    } else if (!flags.channel) {
-      flags.channel = 'cli';
-    }
+    flags.channel = 'cli';
 
-    const runnerResult = flags.legacyNavigation ?
-       await legacyNavigation(url, flags, config) :
-       await lighthouse(url, flags, config);
+    const runnerResult = await lighthouse(url, flags, config);
 
     // If in gatherMode only, there will be no runnerResult.
     if (runnerResult) {

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

@@ -56,6 +56,7 @@ async function runBundledLighthouse(url, config, testRunnerOptions) {
 
   const originalBuffer = global.Buffer;
   const originalRequire = global.require;
+  const originalProcess = global.process;
   if (typeof globalThis === 'undefined') {
     // @ts-expect-error - exposing for loading of dt-bundle.
     global.globalThis = global;
@@ -66,6 +67,7 @@ async function runBundledLighthouse(url, config, testRunnerOptions) {
 
   global.require = originalRequire;
   global.Buffer = originalBuffer;
+  global.process = originalProcess;
 
   /** @type {import('../../../../core/index.js')['default']} */
   // @ts-expect-error - not worth giving test global an actual type.
@@ -122,7 +124,7 @@ async function runLighthouse(url, config, testRunnerOptions = {}) {
   const log = logs.join('') + '\n';
 
   if (workerResponse.type === 'error') {
-    new Error(`Worker returned an error: ${workerResponse.value}\nLog:\n${log}`);
+    throw new Error(`Worker returned an error: ${workerResponse.value}\nLog:\n${log}`);
   }
 
   const result = workerResponse.value;

package/core/config/config-helpers.d.ts

@@ -1,4 +1,4 @@
-export type GathererConstructor = typeof import('../gather/gatherers/gatherer.js').Gatherer;
+export type GathererConstructor = typeof import('../gather/base-gatherer.js').default;
 export type Audit = typeof import('../audits/audit.js')['Audit'];
 export type Gatherer = InstanceType<GathererConstructor>;
 /**
@@ -71,9 +71,9 @@ export function resolveAuditsToDefns(audits: LH.Config['audits'], configDir?: st
  * @param {LH.Config.GathererJson} gathererJson
  * @param {Array<string>} coreGathererList
  * @param {string=} configDir
- * @return {Promise<LH.Config.GathererDefn>}
+ * @return {Promise<LH.Config.AnyGathererDefn>}
  */
-export function resolveGathererToDefn(gathererJson: LH.Config.GathererJson, coreGathererList: Array<string>, configDir?: string | undefined): Promise<LH.Config.GathererDefn>;
+export function resolveGathererToDefn(gathererJson: LH.Config.GathererJson, coreGathererList: Array<string>, configDir?: string | undefined): Promise<LH.Config.AnyGathererDefn>;
 /**
  * Resolves the location of the specified module and returns an absolute
  * string path to the file. Used for loading custom audits and gatherers.

package/core/config/config-helpers.js

@@ -20,7 +20,7 @@ import {getModuleDirectory} from '../../esm-utils.js';
 
 const require = createRequire(import.meta.url);
 
-/** @typedef {typeof import('../gather/gatherers/gatherer.js').Gatherer} GathererConstructor */
+/** @typedef {typeof import('../gather/base-gatherer.js').default} GathererConstructor */
 /** @typedef {typeof import('../audits/audit.js')['Audit']} Audit */
 /** @typedef {InstanceType<GathererConstructor>} Gatherer */
 
@@ -160,7 +160,7 @@ function mergeConfigFragmentArrayByKey(baseArray, extensionArray, keyFn) {
  *  - {instance: myGathererInstance}
  *
  * @param {LH.Config.GathererJson} gatherer
- * @return {{instance?: Gatherer, implementation?: GathererConstructor, path?: string}} passes
+ * @return {{instance?: Gatherer, implementation?: GathererConstructor, path?: string}}
  */
 function expandGathererShorthand(gatherer) {
   if (typeof gatherer === 'string') {
@@ -178,7 +178,7 @@ function expandGathererShorthand(gatherer) {
   } else if (typeof gatherer === 'function') {
     // just GathererConstructor
     return {implementation: gatherer};
-  } else if (gatherer && typeof gatherer.beforePass === 'function') {
+  } else if (gatherer && typeof gatherer.getArtifact === 'function') {
     // just GathererInstance
     return {instance: gatherer};
   } else {
@@ -254,7 +254,7 @@ async function requireWrapper(requirePath) {
  * @param {string} gathererPath
  * @param {Array<string>} coreGathererList
  * @param {string=} configDir
- * @return {Promise<LH.Config.GathererDefn>}
+ * @return {Promise<LH.Config.AnyGathererDefn>}
  */
 async function requireGatherer(gathererPath, coreGathererList, configDir) {
   const coreGatherer = coreGathererList.find(a => a === `${gathererPath}.js`);
@@ -399,7 +399,7 @@ async function mergePlugins(config, configDir, flags) {
  * @param {LH.Config.GathererJson} gathererJson
  * @param {Array<string>} coreGathererList
  * @param {string=} configDir
- * @return {Promise<LH.Config.GathererDefn>}
+ * @return {Promise<LH.Config.AnyGathererDefn>}
  */
 async function resolveGathererToDefn(gathererJson, coreGathererList, configDir) {
   const gathererDefn = expandGathererShorthand(gathererJson);
@@ -595,13 +595,6 @@ function deepCloneConfigJson(json) {
 
   // Copy arrays that could contain non-serializable properties to allow for programmatic
   // injection of audit and gatherer implementations.
-  if (Array.isArray(cloned.passes) && Array.isArray(json.passes)) {
-    for (let i = 0; i < cloned.passes.length; i++) {
-      const pass = cloned.passes[i];
-      pass.gatherers = (json.passes[i].gatherers || []).map(gatherer => shallowClone(gatherer));
-    }
-  }
-
   if (Array.isArray(json.audits)) {
     cloned.audits = json.audits.map(audit => shallowClone(audit));
   }

package/core/config/config.js

@@ -12,7 +12,6 @@ import {Runner} from '../runner.js';
 import defaultConfig from './default-config.js';
 import {defaultNavigationConfig, nonSimulatedPassConfigOverrides} from './constants.js'; // eslint-disable-line max-len
 import {
-  isFRGathererDefn,
   throwInvalidDependencyOrder,
   isValidArtifactDependency,
   throwInvalidArtifactDependency,
@@ -104,7 +103,7 @@ function resolveExtensions(config) {
  * Looks up the required artifact IDs for each dependency, throwing if no earlier artifact satisfies the dependency.
  *
  * @param {LH.Config.ArtifactJson} artifact
- * @param {LH.Config.AnyFRGathererDefn} gatherer
+ * @param {LH.Config.AnyGathererDefn} gatherer
  * @param {Map<Symbol, LH.Config.AnyArtifactDefn>} artifactDefnsBySymbol
  * @return {LH.Config.AnyArtifactDefn['dependencies']}
  */
@@ -154,14 +153,9 @@ async function resolveArtifactsToDefns(artifacts, configDir) {
   const coreGathererList = Runner.getGathererList();
   const artifactDefns = [];
   for (const artifactJson of sortedArtifacts) {
-    /** @type {LH.Config.GathererJson} */
-    // @ts-expect-error - remove when legacy runner path is removed.
     const gathererJson = artifactJson.gatherer;
 
     const gatherer = await resolveGathererToDefn(gathererJson, coreGathererList, configDir);
-    if (!isFRGathererDefn(gatherer)) {
-      throw new Error(`${gatherer.instance.name} gatherer does not have a Fraggle Rock meta obj`);
-    }
 
     /** @type {LH.Config.AnyArtifactDefn} */
     // @ts-expect-error - Typescript can't validate the gatherer and dependencies match

package/core/config/constants.d.ts

@@ -48,8 +48,6 @@ export namespace userAgents {
 }
 /** @type {LH.Config.Settings} */
 export const defaultSettings: LH.Config.Settings;
-/** @type {LH.Config.Pass} */
-export const defaultPassConfig: LH.Config.Pass;
 /** @type {Required<LH.Config.NavigationJson>} */
 export const defaultNavigationConfig: Required<LH.Config.NavigationJson>;
 export namespace nonSimulatedPassConfigOverrides {

package/core/config/constants.js

@@ -127,21 +127,6 @@ const defaultSettings = {
   skipAudits: null,
 };
 
-/** @type {LH.Config.Pass} */
-const defaultPassConfig = {
-  passName: 'defaultPass',
-  loadFailureMode: 'fatal',
-  recordTrace: false,
-  useThrottling: false,
-  pauseAfterFcpMs: 0,
-  pauseAfterLoadMs: 0,
-  networkQuietThresholdMs: 0,
-  cpuQuietThresholdMs: 0,
-  blockedUrlPatterns: [],
-  blankPage: 'about:blank',
-  gatherers: [],
-};
-
 /** @type {Required<LH.Config.NavigationJson>} */
 const defaultNavigationConfig = {
   id: 'default',
@@ -169,7 +154,6 @@ export {
   screenEmulationMetrics,
   userAgents,
   defaultSettings,
-  defaultPassConfig,
   defaultNavigationConfig,
   nonSimulatedPassConfigOverrides,
 };

package/core/config/filters.js

@@ -8,7 +8,7 @@ import log from 'lighthouse-logger';
 
 import {Audit} from '../audits/audit.js';
 
-/** @type {Record<keyof LH.FRBaseArtifacts, string>} */
+/** @type {Record<keyof LH.BaseArtifacts, string>} */
 const baseArtifactKeySource = {
   fetchTime: '',
   LighthouseRunWarnings: '',

package/core/config/validation.d.ts

@@ -1,17 +1,12 @@
-/**
- * @param {LH.Config.GathererDefn | LH.Config.AnyFRGathererDefn} gathererDefn
- * @return {gathererDefn is LH.Config.AnyFRGathererDefn}
- */
-export function isFRGathererDefn(gathererDefn: LH.Config.GathererDefn | LH.Config.AnyFRGathererDefn): gathererDefn is import("../../types/config.js").default.AnyFRGathererDefn;
 /**
  * Determines if the artifact dependency direction is valid. The dependency's minimum supported mode
  * must be less than or equal to the dependent's.
  *
- * @param {LH.Config.AnyFRGathererDefn} dependent The artifact that depends on the other.
- * @param {LH.Config.AnyFRGathererDefn} dependency The artifact that is being depended on by the other.
+ * @param {LH.Config.AnyGathererDefn} dependent The artifact that depends on the other.
+ * @param {LH.Config.AnyGathererDefn} dependency The artifact that is being depended on by the other.
  * @return {boolean}
  */
-export function isValidArtifactDependency(dependent: LH.Config.AnyFRGathererDefn, dependency: LH.Config.AnyFRGathererDefn): boolean;
+export function isValidArtifactDependency(dependent: LH.Config.AnyGathererDefn, dependency: LH.Config.AnyGathererDefn): boolean;
 /**
  * Throws if pluginName is invalid or (somehow) collides with a category in the
  * config being added to.
@@ -21,9 +16,9 @@ export function isValidArtifactDependency(dependent: LH.Config.AnyFRGathererDefn
 export function assertValidPluginName(config: LH.Config, pluginName: string): void;
 /**
  * Throws an error if the provided object does not implement the required Fraggle Rock gatherer interface.
- * @param {LH.Config.AnyFRGathererDefn} gathererDefn
+ * @param {LH.Config.AnyArtifactDefn} artifactDefn
  */
-export function assertValidFRGatherer(gathererDefn: LH.Config.AnyFRGathererDefn): void;
+export function assertValidArtifact(artifactDefn: LH.Config.AnyArtifactDefn): void;
 /**
  * Throws an error if the provided object does not implement the required navigations interface.
  * @param {LH.Config.ResolvedConfig['navigations']} navigationsDefn

package/core/config/validation.js

@@ -5,23 +5,15 @@
  */
 
 import {Audit} from '../audits/audit.js';
-import BaseFRGatherer from '../gather/base-gatherer.js';
+import BaseGatherer from '../gather/base-gatherer.js';
 import * as i18n from '../lib/i18n/i18n.js';
 
-/**
- * @param {LH.Config.GathererDefn | LH.Config.AnyFRGathererDefn} gathererDefn
- * @return {gathererDefn is LH.Config.AnyFRGathererDefn}
- */
-function isFRGathererDefn(gathererDefn) {
-  return 'meta' in gathererDefn.instance;
-}
-
 /**
  * Determines if the artifact dependency direction is valid. The dependency's minimum supported mode
  * must be less than or equal to the dependent's.
  *
- * @param {LH.Config.AnyFRGathererDefn} dependent The artifact that depends on the other.
- * @param {LH.Config.AnyFRGathererDefn} dependency The artifact that is being depended on by the other.
+ * @param {LH.Config.AnyGathererDefn} dependent The artifact that depends on the other.
+ * @param {LH.Config.AnyGathererDefn} dependency The artifact that is being depended on by the other.
  * @return {boolean}
  */
 function isValidArtifactDependency(dependent, dependency) {
@@ -55,25 +47,24 @@ function assertValidPluginName(config, pluginName) {
 
 /**
  * Throws an error if the provided object does not implement the required Fraggle Rock gatherer interface.
- * @param {LH.Config.AnyFRGathererDefn} gathererDefn
+ * @param {LH.Config.AnyArtifactDefn} artifactDefn
  */
-function assertValidFRGatherer(gathererDefn) {
-  const gatherer = gathererDefn.instance;
-  const gathererName = gatherer.name;
+function assertValidArtifact(artifactDefn) {
+  const gatherer = artifactDefn.gatherer.instance;
 
   if (typeof gatherer.meta !== 'object') {
-    throw new Error(`${gathererName} gatherer did not provide a meta object.`);
+    throw new Error(`Gatherer for ${artifactDefn.id} did not provide a meta object.`);
   }
 
   if (gatherer.meta.supportedModes.length === 0) {
-    throw new Error(`${gathererName} gatherer did not support any gather modes.`);
+    throw new Error(`Gatherer for ${artifactDefn.id} did not support any gather modes.`);
   }
 
   if (
     typeof gatherer.getArtifact !== 'function' ||
-    gatherer.getArtifact === BaseFRGatherer.prototype.getArtifact
+    gatherer.getArtifact === BaseGatherer.prototype.getArtifact
   ) {
-    throw new Error(`${gathererName} gatherer did not define a "getArtifact" method.`);
+    throw new Error(`Gatherer for ${artifactDefn.id} did not define a "getArtifact" method.`);
   }
 }
 
@@ -266,7 +257,7 @@ function assertValidConfig(resolvedConfig) {
       throw new Error(`Config defined multiple artifacts with id '${artifactDefn.id}'`);
     }
     artifactIds.add(artifactDefn.id);
-    assertValidFRGatherer(artifactDefn.gatherer);
+    assertValidArtifact(artifactDefn);
   }
 
   for (const auditDefn of resolvedConfig.audits || []) {
@@ -309,10 +300,9 @@ function throwInvalidArtifactDependency(artifactId, dependencyKey) {
 }
 
 export {
-  isFRGathererDefn,
   isValidArtifactDependency,
   assertValidPluginName,
-  assertValidFRGatherer,
+  assertValidArtifact,
   assertValidFRNavigations,
   assertValidAudit,
   assertValidCategories,

package/core/gather/base-artifacts.d.ts

@@ -1,16 +1,16 @@
 /**
  * @param {LH.Config.ResolvedConfig} resolvedConfig
- * @param {LH.Gatherer.FRTransitionalDriver} driver
+ * @param {LH.Gatherer.Driver} driver
  * @param {{gatherMode: LH.Gatherer.GatherMode}} context
  * @return {Promise<LH.BaseArtifacts>}
  */
-export function getBaseArtifacts(resolvedConfig: LH.Config.ResolvedConfig, driver: LH.Gatherer.FRTransitionalDriver, context: {
+export function getBaseArtifacts(resolvedConfig: LH.Config.ResolvedConfig, driver: LH.Gatherer.Driver, context: {
     gatherMode: LH.Gatherer.GatherMode;
 }): Promise<LH.BaseArtifacts>;
 /**
- * @param {LH.FRBaseArtifacts} baseArtifacts
+ * @param {LH.BaseArtifacts} baseArtifacts
  * @param {Partial<LH.Artifacts>} gathererArtifacts
  * @return {LH.Artifacts}
  */
-export function finalizeArtifacts(baseArtifacts: LH.FRBaseArtifacts, gathererArtifacts: Partial<LH.Artifacts>): LH.Artifacts;
+export function finalizeArtifacts(baseArtifacts: LH.BaseArtifacts, gathererArtifacts: Partial<LH.Artifacts>): LH.Artifacts;
 //# sourceMappingURL=base-artifacts.d.ts.map

package/core/gather/base-artifacts.js

@@ -13,7 +13,7 @@ import {
 
 /**
  * @param {LH.Config.ResolvedConfig} resolvedConfig
- * @param {LH.Gatherer.FRTransitionalDriver} driver
+ * @param {LH.Gatherer.Driver} driver
  * @param {{gatherMode: LH.Gatherer.GatherMode}} context
  * @return {Promise<LH.BaseArtifacts>}
  */
@@ -38,10 +38,6 @@ async function getBaseArtifacts(resolvedConfig, driver, context) {
     },
     PageLoadError: null,
     GatherContext: context,
-    // Artifacts that have been replaced by regular gatherers in Fraggle Rock.
-    NetworkUserAgent: '',
-    traces: {},
-    devtoolsLogs: {},
   };
 }
 
@@ -63,7 +59,7 @@ function deduplicateWarnings(warnings) {
 }
 
 /**
- * @param {LH.FRBaseArtifacts} baseArtifacts
+ * @param {LH.BaseArtifacts} baseArtifacts
  * @param {Partial<LH.Artifacts>} gathererArtifacts
  * @return {LH.Artifacts}
  */

package/core/gather/base-gatherer.d.ts

@@ -1,70 +1,45 @@
-export default FRGatherer;
+export default BaseGatherer;
 /**
  * Base class for all gatherers.
  *
  * @implements {LH.Gatherer.GathererInstance}
- * @implements {LH.Gatherer.FRGathererInstance}
  */
-declare class FRGatherer implements LH.Gatherer.GathererInstance, LH.Gatherer.FRGathererInstance {
+declare class BaseGatherer implements LH.Gatherer.GathererInstance {
     /** @type {LH.Gatherer.GathererMeta} */
     meta: LH.Gatherer.GathererMeta;
     /**
      * Method to start observing a page for an arbitrary period of time.
-     * @param {LH.Gatherer.FRTransitionalContext} passContext
+     * @param {LH.Gatherer.Context} passContext
      * @return {Promise<void>|void}
      */
-    startInstrumentation(passContext: LH.Gatherer.FRTransitionalContext): Promise<void> | void;
+    startInstrumentation(passContext: LH.Gatherer.Context): Promise<void> | void;
     /**
      * Method to start observing a page when the measurements are very sensitive and
      * should observe as little Lighthouse-induced work as possible.
-     * @param {LH.Gatherer.FRTransitionalContext} passContext
+     * @param {LH.Gatherer.Context} passContext
      * @return {Promise<void>|void}
      */
-    startSensitiveInstrumentation(passContext: LH.Gatherer.FRTransitionalContext): Promise<void> | void;
+    startSensitiveInstrumentation(passContext: LH.Gatherer.Context): Promise<void> | void;
     /**
      * Method to stop observing a page when the measurements are very sensitive and
      * should observe as little Lighthouse-induced work as possible.
      *
-     * @param {LH.Gatherer.FRTransitionalContext} passContext
+     * @param {LH.Gatherer.Context} passContext
      * @return {Promise<void>|void}
      */
-    stopSensitiveInstrumentation(passContext: LH.Gatherer.FRTransitionalContext): Promise<void> | void;
+    stopSensitiveInstrumentation(passContext: LH.Gatherer.Context): Promise<void> | void;
     /**
      * Method to end observing a page after an arbitrary period of time.
-     * @param {LH.Gatherer.FRTransitionalContext} passContext
+     * @param {LH.Gatherer.Context} passContext
      * @return {Promise<void>|void}
      */
-    stopInstrumentation(passContext: LH.Gatherer.FRTransitionalContext): Promise<void> | void;
+    stopInstrumentation(passContext: LH.Gatherer.Context): Promise<void> | void;
     /**
      * Method to gather results about a page.
-     * @param {LH.Gatherer.FRTransitionalContext} passContext
+     * @param {LH.Gatherer.Context} passContext
      * @return {LH.Gatherer.PhaseResult}
      */
-    getArtifact(passContext: LH.Gatherer.FRTransitionalContext): LH.Gatherer.PhaseResult;
-    /**
-     * Legacy property used to define the artifact ID. In Fraggle Rock, the artifact ID lives on the config.
-     * @return {keyof LH.GathererArtifacts}
-     */
-    get name(): keyof LH.GathererArtifacts;
-    /**
-     * Legacy method. Called before navigation to target url, roughly corresponds to `startInstrumentation`.
-     * @param {LH.Gatherer.PassContext} passContext
-     * @return {Promise<LH.Gatherer.PhaseResultNonPromise>}
-     */
-    beforePass(passContext: LH.Gatherer.PassContext): Promise<LH.Gatherer.PhaseResultNonPromise>;
-    /**
-     * Legacy method. Should never be used by a Fraggle Rock gatherer, here for compat only.
-     * @param {LH.Gatherer.PassContext} passContext
-     * @return {LH.Gatherer.PhaseResult}
-     */
-    pass(passContext: LH.Gatherer.PassContext): LH.Gatherer.PhaseResult;
-    /**
-     * Legacy method. Roughly corresponds to `stopInstrumentation` or `getArtifact` depending on type of gatherer.
-     * @param {LH.Gatherer.PassContext} passContext
-     * @param {LH.Gatherer.LoadData} loadData
-     * @return {Promise<LH.Gatherer.PhaseResultNonPromise>}
-     */
-    afterPass(passContext: LH.Gatherer.PassContext, loadData: LH.Gatherer.LoadData): Promise<LH.Gatherer.PhaseResultNonPromise>;
+    getArtifact(passContext: LH.Gatherer.Context): LH.Gatherer.PhaseResult;
 }
 import * as LH from '../../types/lh.js';
 //# sourceMappingURL=base-gatherer.d.ts.map

package/core/gather/base-gatherer.js

@@ -12,15 +12,14 @@ import * as LH from '../../types/lh.js';
  * Base class for all gatherers.
  *
  * @implements {LH.Gatherer.GathererInstance}
- * @implements {LH.Gatherer.FRGathererInstance}
  */
-class FRGatherer {
+class BaseGatherer {
   /** @type {LH.Gatherer.GathererMeta} */
   meta = {supportedModes: []};
 
   /**
    * Method to start observing a page for an arbitrary period of time.
-   * @param {LH.Gatherer.FRTransitionalContext} passContext
+   * @param {LH.Gatherer.Context} passContext
    * @return {Promise<void>|void}
    */
   startInstrumentation(passContext) { }
@@ -28,7 +27,7 @@ class FRGatherer {
   /**
    * Method to start observing a page when the measurements are very sensitive and
    * should observe as little Lighthouse-induced work as possible.
-   * @param {LH.Gatherer.FRTransitionalContext} passContext
+   * @param {LH.Gatherer.Context} passContext
    * @return {Promise<void>|void}
    */
   startSensitiveInstrumentation(passContext) { }
@@ -37,70 +36,24 @@ class FRGatherer {
    * Method to stop observing a page when the measurements are very sensitive and
    * should observe as little Lighthouse-induced work as possible.
    *
-   * @param {LH.Gatherer.FRTransitionalContext} passContext
+   * @param {LH.Gatherer.Context} passContext
    * @return {Promise<void>|void}
    */
   stopSensitiveInstrumentation(passContext) { }
 
   /**
    * Method to end observing a page after an arbitrary period of time.
-   * @param {LH.Gatherer.FRTransitionalContext} passContext
+   * @param {LH.Gatherer.Context} passContext
    * @return {Promise<void>|void}
    */
   stopInstrumentation(passContext) { }
 
   /**
    * Method to gather results about a page.
-   * @param {LH.Gatherer.FRTransitionalContext} passContext
+   * @param {LH.Gatherer.Context} passContext
    * @return {LH.Gatherer.PhaseResult}
    */
   getArtifact(passContext) { }
-
-  /**
-   * Legacy property used to define the artifact ID. In Fraggle Rock, the artifact ID lives on the config.
-   * @return {keyof LH.GathererArtifacts}
-   */
-  get name() {
-    let name = this.constructor.name;
-    // Rollup will mangle class names in an known way–just trim until `$`.
-    if (name.includes('$')) {
-      name = name.substr(0, name.indexOf('$'));
-    }
-    // @ts-expect-error - assume that class name has been added to LH.GathererArtifacts.
-    return name;
-  }
-
-  /**
-   * Legacy method. Called before navigation to target url, roughly corresponds to `startInstrumentation`.
-   * @param {LH.Gatherer.PassContext} passContext
-   * @return {Promise<LH.Gatherer.PhaseResultNonPromise>}
-   */
-  async beforePass(passContext) {
-    await this.startInstrumentation({...passContext, dependencies: {}});
-    await this.startSensitiveInstrumentation({...passContext, dependencies: {}});
-  }
-
-  /**
-   * Legacy method. Should never be used by a Fraggle Rock gatherer, here for compat only.
-   * @param {LH.Gatherer.PassContext} passContext
-   * @return {LH.Gatherer.PhaseResult}
-   */
-  pass(passContext) { }
-
-  /**
-   * Legacy method. Roughly corresponds to `stopInstrumentation` or `getArtifact` depending on type of gatherer.
-   * @param {LH.Gatherer.PassContext} passContext
-   * @param {LH.Gatherer.LoadData} loadData
-   * @return {Promise<LH.Gatherer.PhaseResultNonPromise>}
-   */
-  async afterPass(passContext, loadData) {
-    if ('dependencies' in this.meta) {
-      throw Error('Gatherer with dependencies should override afterPass');
-    }
-    await this.stopSensitiveInstrumentation({...passContext, dependencies: {}});
-    await this.stopInstrumentation({...passContext, dependencies: {}});
-    return this.getArtifact({...passContext, dependencies: {}});
-  }
 }
 
-export default FRGatherer;
+export default BaseGatherer;

package/core/gather/driver/dom.d.ts

@@ -2,19 +2,19 @@
  * Resolves a backend node ID (from a trace event, protocol, etc) to the object ID for use with
  * `Runtime.callFunctionOn`. `undefined` means the node could not be found.
  *
- * @param {LH.Gatherer.FRProtocolSession} session
+ * @param {LH.Gatherer.ProtocolSession} session
  * @param {number} backendNodeId
  * @return {Promise<string|undefined>}
  */
-export function resolveNodeIdToObjectId(session: LH.Gatherer.FRProtocolSession, backendNodeId: number): Promise<string | undefined>;
+export function resolveNodeIdToObjectId(session: LH.Gatherer.ProtocolSession, backendNodeId: number): Promise<string | undefined>;
 /**
  * Resolves a proprietary devtools node path (created from page-function.js) to the object ID for use
  * with `Runtime.callFunctionOn`. `undefined` means the node could not be found.
  * Requires `DOM.getDocument` to have been called since the object's creation or it will always be `undefined`.
  *
- * @param {LH.Gatherer.FRProtocolSession} session
+ * @param {LH.Gatherer.ProtocolSession} session
  * @param {string} path
  * @return {Promise<string|undefined>}
  */
-export function resolveDevtoolsNodePathToObjectId(session: LH.Gatherer.FRProtocolSession, path: string): Promise<string | undefined>;
+export function resolveDevtoolsNodePathToObjectId(session: LH.Gatherer.ProtocolSession, path: string): Promise<string | undefined>;
 //# sourceMappingURL=dom.d.ts.map

package/core/gather/driver/dom.js

@@ -22,7 +22,7 @@ function handlePotentialMissingNodeError(err) {
  * Resolves a backend node ID (from a trace event, protocol, etc) to the object ID for use with
  * `Runtime.callFunctionOn`. `undefined` means the node could not be found.
  *
- * @param {LH.Gatherer.FRProtocolSession} session
+ * @param {LH.Gatherer.ProtocolSession} session
  * @param {number} backendNodeId
  * @return {Promise<string|undefined>}
  */
@@ -40,7 +40,7 @@ async function resolveNodeIdToObjectId(session, backendNodeId) {
  * with `Runtime.callFunctionOn`. `undefined` means the node could not be found.
  * Requires `DOM.getDocument` to have been called since the object's creation or it will always be `undefined`.
  *
- * @param {LH.Gatherer.FRProtocolSession} session
+ * @param {LH.Gatherer.ProtocolSession} session
  * @param {string} path
  * @return {Promise<string|undefined>}
  */