lighthouse 10.4.0 → 11.0.0

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>}
  */

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

@@ -2,18 +2,18 @@ export namespace UIStrings {
     const warningSlowHostCpu: string;
 }
 /**
- * @param {LH.Gatherer.FRProtocolSession} session
+ * @param {LH.Gatherer.ProtocolSession} session
  * @return {Promise<LH.Crdp.Browser.GetVersionResponse & {milestone: number}>}
  */
-export function getBrowserVersion(session: LH.Gatherer.FRProtocolSession): Promise<import("devtools-protocol").Protocol.Browser.GetVersionResponse & {
+export function getBrowserVersion(session: LH.Gatherer.ProtocolSession): Promise<import("devtools-protocol").Protocol.Browser.GetVersionResponse & {
     milestone: number;
 }>;
 /**
  * Computes the benchmark index to get a rough estimate of device class.
- * @param {LH.Gatherer.FRTransitionalDriver['executionContext']} executionContext
+ * @param {LH.Gatherer.Driver['executionContext']} executionContext
  * @return {Promise<number>}
  */
-export function getBenchmarkIndex(executionContext: LH.Gatherer.FRTransitionalDriver['executionContext']): Promise<number>;
+export function getBenchmarkIndex(executionContext: LH.Gatherer.Driver['executionContext']): Promise<number>;
 /**
  * Returns a warning if the host device appeared to be underpowered according to BenchmarkIndex.
  *

package/core/gather/driver/environment.js

@@ -30,7 +30,7 @@ const SLOW_CPU_BENCHMARK_INDEX_THRESHOLD = 1000;
 const str_ = i18n.createIcuMessageFn(import.meta.url, UIStrings);
 
 /**
- * @param {LH.Gatherer.FRProtocolSession} session
+ * @param {LH.Gatherer.ProtocolSession} session
  * @return {Promise<LH.Crdp.Browser.GetVersionResponse & {milestone: number}>}
  */
 async function getBrowserVersion(session) {
@@ -45,7 +45,7 @@ async function getBrowserVersion(session) {
 
 /**
  * Computes the benchmark index to get a rough estimate of device class.
- * @param {LH.Gatherer.FRTransitionalDriver['executionContext']} executionContext
+ * @param {LH.Gatherer.Driver['executionContext']} executionContext
  * @return {Promise<number>}
  */
 async function getBenchmarkIndex(executionContext) {

package/core/gather/driver/execution-context.d.ts

@@ -11,9 +11,18 @@ export class ExecutionContext {
      * @return {string}
      */
     static serializeArguments(args: unknown[]): string;
-    /** @param {LH.Gatherer.FRProtocolSession} session */
-    constructor(session: LH.Gatherer.FRProtocolSession);
-    _session: LH.Gatherer.FRProtocolSession;
+    /**
+     * Serializes an array of functions or strings.
+     *
+     * Also makes sure that an esbuild-bundled version of Lighthouse will
+     * continue to create working code to be executed within the browser.
+     * @param {Array<Function|string>=} deps
+     * @return {string}
+     */
+    static serializeDeps(deps?: Array<Function | string> | undefined): string;
+    /** @param {LH.Gatherer.ProtocolSession} session */
+    constructor(session: LH.Gatherer.ProtocolSession);
+    _session: LH.Gatherer.ProtocolSession;
     /** @type {number|undefined} */
     _executionContextId: number | undefined;
     /**

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

@@ -10,7 +10,7 @@ import * as LH from '../../../types/lh.js';
 import {pageFunctions} from '../../lib/page-functions.js';
 
 class ExecutionContext {
-  /** @param {LH.Gatherer.FRProtocolSession} session */
+  /** @param {LH.Gatherer.ProtocolSession} session */
   constructor(session) {
     this._session = session;
 
@@ -108,6 +108,7 @@ class ExecutionContext {
         ${ExecutionContext._cachedNativesPreamble};
         globalThis.__lighthouseExecutionContextUniqueIdentifier =
           ${uniqueExecutionContextIdentifier};
+        ${pageFunctions.esbuildFunctionWrapperString}
         return new Promise(function (resolve) {
           return Promise.resolve()
             .then(_ => ${expression})
@@ -196,7 +197,8 @@ class ExecutionContext {
    */
   evaluate(mainFn, options) {
     const argsSerialized = ExecutionContext.serializeArguments(options.args);
-    const depsSerialized = options.deps ? options.deps.join('\n') : '';
+    const depsSerialized = ExecutionContext.serializeDeps(options.deps);
+
     const expression = `(() => {
       ${depsSerialized}
       return (${mainFn})(${argsSerialized});
@@ -215,7 +217,7 @@ class ExecutionContext {
    */
   async evaluateOnNewDocument(mainFn, options) {
     const argsSerialized = ExecutionContext.serializeArguments(options.args);
-    const depsSerialized = options.deps ? options.deps.join('\n') : '';
+    const depsSerialized = ExecutionContext.serializeDeps(options.deps);
 
     const expression = `(() => {
       ${ExecutionContext._cachedNativesPreamble};
@@ -265,6 +267,35 @@ class ExecutionContext {
   static serializeArguments(args) {
     return args.map(arg => arg === undefined ? 'undefined' : JSON.stringify(arg)).join(',');
   }
+
+  /**
+   * Serializes an array of functions or strings.
+   *
+   * Also makes sure that an esbuild-bundled version of Lighthouse will
+   * continue to create working code to be executed within the browser.
+   * @param {Array<Function|string>=} deps
+   * @return {string}
+   */
+  static serializeDeps(deps) {
+    deps = [pageFunctions.esbuildFunctionWrapperString, ...deps || []];
+    return deps.map(dep => {
+      if (typeof dep === 'function') {
+        // esbuild will change the actual function name (ie. function actualName() {})
+        // always, and preserve the real name in `actualName.name`.
+        // See esbuildFunctionWrapperString.
+        const output = dep.toString();
+        const runtimeName = pageFunctions.getRuntimeFunctionName(dep);
+        if (runtimeName !== dep.name) {
+          // In addition to exposing the mangled name, also expose the original as an alias.
+          return `${output}; const ${dep.name} = ${runtimeName};`;
+        } else {
+          return output;
+        }
+      } else {
+        return dep;
+      }
+    }).join('\n');
+  }
 }
 
 export {ExecutionContext};

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

@@ -7,12 +7,12 @@ export type NavigationOptions = {
  * Typical use of this method involves navigating to a neutral page such as `about:blank` in between
  * navigations.
  *
- * @param {LH.Gatherer.FRTransitionalDriver} driver
+ * @param {LH.Gatherer.Driver} driver
  * @param {LH.NavigationRequestor} requestor
  * @param {NavigationOptions} options
  * @return {Promise<{requestedUrl: string, mainDocumentUrl: string, warnings: Array<LH.IcuMessage>}>}
  */
-export function gotoURL(driver: LH.Gatherer.FRTransitionalDriver, requestor: LH.NavigationRequestor, options: NavigationOptions): Promise<{
+export function gotoURL(driver: LH.Gatherer.Driver, requestor: LH.NavigationRequestor, options: NavigationOptions): Promise<{
     requestedUrl: string;
     mainDocumentUrl: string;
     warnings: Array<LH.IcuMessage>;

package/core/gather/driver/navigation.js

@@ -6,7 +6,6 @@
 
 import log from 'lighthouse-logger';
 
-import {NetworkMonitor} from './network-monitor.js';
 import {waitForFullyLoaded, waitForFrameNavigated, waitForUserToContinue} from './wait-for-condition.js'; // eslint-disable-line max-len
 import * as constants from '../../config/constants.js';
 import * as i18n from '../../lib/i18n/i18n.js';
@@ -77,7 +76,7 @@ function resolveWaitForFullyLoadedOptions(options) {
  * Typical use of this method involves navigating to a neutral page such as `about:blank` in between
  * navigations.
  *
- * @param {LH.Gatherer.FRTransitionalDriver} driver
+ * @param {LH.Gatherer.Driver} driver
  * @param {LH.NavigationRequestor} requestor
  * @param {NavigationOptions} options
  * @return {Promise<{requestedUrl: string, mainDocumentUrl: string, warnings: Array<LH.IcuMessage>}>}
@@ -89,10 +88,9 @@ async function gotoURL(driver, requestor, options) {
   log.time(status);
 
   const session = driver.defaultSession;
-  const networkMonitor = new NetworkMonitor(driver.targetManager);
+  const networkMonitor = driver.networkMonitor;
 
   // Enable the events and network monitor needed to track navigation progress.
-  await networkMonitor.enable();
   await session.sendCommand('Page.enable');
   await session.sendCommand('Page.setLifecycleEventsEnabled', {enabled: true});
 
@@ -144,7 +142,6 @@ async function gotoURL(driver, requestor, options) {
 
   // Bring `Page.navigate` errors back into the promise chain. See https://github.com/GoogleChrome/lighthouse/pull/6739.
   await waitForNavigationTriggered;
-  await networkMonitor.disable();
 
   if (options.debugNavigation) {
     await waitForUserToContinue(driver);

package/core/gather/driver/network-monitor.d.ts

@@ -17,16 +17,16 @@ export class NetworkMonitor extends NetworkMonitor_base {
         start: number;
         end: number;
     }>;
-    /** @param {LH.Gatherer.FRTransitionalDriver['targetManager']} targetManager */
-    constructor(targetManager: LH.Gatherer.FRTransitionalDriver['targetManager']);
+    /** @param {LH.Gatherer.Driver['targetManager']} targetManager */
+    constructor(targetManager: LH.Gatherer.Driver['targetManager']);
     /** @type {NetworkRecorder|undefined} */
     _networkRecorder: NetworkRecorder | undefined;
     /** @type {Array<LH.Crdp.Page.Frame>} */
     _frameNavigations: Array<LH.Crdp.Page.Frame>;
-    /** @type {LH.Gatherer.FRTransitionalDriver['targetManager']} */
-    _targetManager: LH.Gatherer.FRTransitionalDriver['targetManager'];
-    /** @type {LH.Gatherer.FRProtocolSession} */
-    _session: LH.Gatherer.FRProtocolSession;
+    /** @type {LH.Gatherer.Driver['targetManager']} */
+    _targetManager: LH.Gatherer.Driver['targetManager'];
+    /** @type {LH.Gatherer.ProtocolSession} */
+    _session: LH.Gatherer.ProtocolSession;
     /** @param {LH.Crdp.Page.FrameNavigatedEvent} event */
     _onFrameNavigated: (event: LH.Crdp.Page.FrameNavigatedEvent) => number;
     /** @param {LH.Protocol.RawEventMessage} event */
@@ -76,6 +76,7 @@ export class NetworkMonitor extends NetworkMonitor_base {
      */
     _emitNetworkStatus(): void;
 }
+import * as LH from '../../../types/lh.js';
 import { NetworkRecorder } from '../../lib/network-recorder.js';
 import { NetworkRequest } from '../../lib/network-request.js';
 export {};

package/core/gather/driver/network-monitor.js

@@ -13,6 +13,7 @@ import {EventEmitter} from 'events';
 
 import log from 'lighthouse-logger';
 
+import * as LH from '../../../types/lh.js';
 import {NetworkRecorder} from '../../lib/network-recorder.js';
 import {NetworkRequest} from '../../lib/network-request.js';
 import UrlUtils from '../../lib/url-utils.js';
@@ -30,15 +31,14 @@ class NetworkMonitor extends NetworkMonitorEventEmitter {
   /** @type {Array<LH.Crdp.Page.Frame>} */
   _frameNavigations = [];
 
-  // TODO(FR-COMPAT): switch to real TargetManager when legacy removed.
-  /** @param {LH.Gatherer.FRTransitionalDriver['targetManager']} targetManager */
+  /** @param {LH.Gatherer.Driver['targetManager']} targetManager */
   constructor(targetManager) {
     super();
 
-    /** @type {LH.Gatherer.FRTransitionalDriver['targetManager']} */
+    /** @type {LH.Gatherer.Driver['targetManager']} */
     this._targetManager = targetManager;
 
-    /** @type {LH.Gatherer.FRProtocolSession} */
+    /** @type {LH.Gatherer.ProtocolSession} */
     this._session = targetManager.rootSession();
 
     /** @param {LH.Crdp.Page.FrameNavigatedEvent} event */

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

@@ -1,10 +1,10 @@
 /**
  * Return the body of the response with the given ID. Rejects if getting the
  * body times out.
- * @param {LH.Gatherer.FRProtocolSession} session
+ * @param {LH.Gatherer.ProtocolSession} session
  * @param {string} requestId
  * @param {number} [timeout]
  * @return {Promise<string>}
  */
-export function fetchResponseBodyFromCache(session: LH.Gatherer.FRProtocolSession, requestId: string, timeout?: number | undefined): Promise<string>;
+export function fetchResponseBodyFromCache(session: LH.Gatherer.ProtocolSession, requestId: string, timeout?: number | undefined): Promise<string>;
 //# sourceMappingURL=network.d.ts.map

package/core/gather/driver/network.js

@@ -9,7 +9,7 @@ import {NetworkRequest} from '../../lib/network-request.js';
 /**
  * Return the body of the response with the given ID. Rejects if getting the
  * body times out.
- * @param {LH.Gatherer.FRProtocolSession} session
+ * @param {LH.Gatherer.ProtocolSession} session
  * @param {string} requestId
  * @param {number} [timeout]
  * @return {Promise<string>}

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

@@ -3,42 +3,42 @@
  *
  * This method assumes `prepareTargetForNavigationMode` or `prepareTargetForTimespanMode` has already been invoked.
  *
- * @param {LH.Gatherer.FRProtocolSession} session
+ * @param {LH.Gatherer.ProtocolSession} session
  * @param {LH.Config.Settings} settings
  * @param {{disableThrottling: boolean, blockedUrlPatterns?: string[]}} options
  */
-export function prepareThrottlingAndNetwork(session: LH.Gatherer.FRProtocolSession, settings: LH.Config.Settings, options: {
+export function prepareThrottlingAndNetwork(session: LH.Gatherer.ProtocolSession, settings: LH.Config.Settings, options: {
     disableThrottling: boolean;
     blockedUrlPatterns?: string[];
 }): Promise<void>;
 /**
  * Prepares a target to be analyzed in timespan mode by enabling protocol domains, emulation, and throttling.
  *
- * @param {LH.Gatherer.FRTransitionalDriver} driver
+ * @param {LH.Gatherer.Driver} driver
  * @param {LH.Config.Settings} settings
  */
-export function prepareTargetForTimespanMode(driver: LH.Gatherer.FRTransitionalDriver, settings: LH.Config.Settings): Promise<void>;
+export function prepareTargetForTimespanMode(driver: LH.Gatherer.Driver, settings: LH.Config.Settings): Promise<void>;
 /**
  * Prepares a target to be analyzed in navigation mode by enabling protocol domains, emulation, and new document
  * handlers for global APIs or error handling.
  *
  * This method should be used in combination with `prepareTargetForIndividualNavigation` before a specific navigation occurs.
  *
- * @param {LH.Gatherer.FRTransitionalDriver} driver
+ * @param {LH.Gatherer.Driver} driver
  * @param {LH.Config.Settings} settings
  */
-export function prepareTargetForNavigationMode(driver: LH.Gatherer.FRTransitionalDriver, settings: LH.Config.Settings): Promise<void>;
+export function prepareTargetForNavigationMode(driver: LH.Gatherer.Driver, settings: LH.Config.Settings): Promise<void>;
 /**
  * Prepares a target for a particular navigation by resetting storage and setting network.
  *
  * This method assumes `prepareTargetForNavigationMode` has already been invoked.
  *
- * @param {LH.Gatherer.FRProtocolSession} session
+ * @param {LH.Gatherer.ProtocolSession} session
  * @param {LH.Config.Settings} settings
  * @param {Pick<LH.Config.NavigationDefn, 'disableThrottling'|'disableStorageReset'|'blockedUrlPatterns'> & {requestor: LH.NavigationRequestor}} navigation
  * @return {Promise<{warnings: Array<LH.IcuMessage>}>}
  */
-export function prepareTargetForIndividualNavigation(session: LH.Gatherer.FRProtocolSession, settings: LH.Config.Settings, navigation: Pick<import("../../../types/config.js").default.NavigationDefn, "blockedUrlPatterns" | "disableStorageReset" | "disableThrottling"> & {
+export function prepareTargetForIndividualNavigation(session: LH.Gatherer.ProtocolSession, settings: LH.Config.Settings, navigation: Pick<import("../../../types/config.js").default.NavigationDefn, "blockedUrlPatterns" | "disableStorageReset" | "disableThrottling"> & {
     requestor: LH.NavigationRequestor;
 }): Promise<{
     warnings: Array<LH.IcuMessage>;
@@ -46,7 +46,7 @@ export function prepareTargetForIndividualNavigation(session: LH.Gatherer.FRProt
 /**
  * Enables `Debugger` domain to receive async stacktrace information on network request initiators.
  * This is critical for tracking attribution of tasks and performance simulation accuracy.
- * @param {LH.Gatherer.FRProtocolSession} session
+ * @param {LH.Gatherer.ProtocolSession} session
  */
-export function enableAsyncStacks(session: LH.Gatherer.FRProtocolSession): Promise<() => Promise<void>>;
+export function enableAsyncStacks(session: LH.Gatherer.ProtocolSession): Promise<() => Promise<void>>;
 //# sourceMappingURL=prepare.d.ts.map

package/core/gather/driver/prepare.js

@@ -13,7 +13,7 @@ import {pageFunctions} from '../../lib/page-functions.js';
 /**
  * Enables `Debugger` domain to receive async stacktrace information on network request initiators.
  * This is critical for tracking attribution of tasks and performance simulation accuracy.
- * @param {LH.Gatherer.FRProtocolSession} session
+ * @param {LH.Gatherer.ProtocolSession} session
  */
 async function enableAsyncStacks(session) {
   const enable = async () => {
@@ -54,7 +54,7 @@ async function enableAsyncStacks(session) {
 /**
  * Use a RequestIdleCallback shim for tests run with simulated throttling, so that the deadline can be used without
  * a penalty.
- * @param {LH.Gatherer.FRTransitionalDriver} driver
+ * @param {LH.Gatherer.Driver} driver
  * @param {LH.Config.Settings} settings
  * @return {Promise<void>}
  */
@@ -67,7 +67,7 @@ async function shimRequestIdleCallbackOnNewDocument(driver, settings) {
 /**
  * Dismiss JavaScript dialogs (alert, confirm, prompt), providing a
  * generic promptText in case the dialog is a prompt.
- * @param {LH.Gatherer.FRProtocolSession} session
+ * @param {LH.Gatherer.ProtocolSession} session
  * @return {Promise<void>}
  */
 async function dismissJavaScriptDialogs(session) {
@@ -87,7 +87,7 @@ async function dismissJavaScriptDialogs(session) {
 
 /**
  * Reset the storage and warn if any stored data could be affecting the scores.
- * @param {LH.Gatherer.FRProtocolSession} session
+ * @param {LH.Gatherer.ProtocolSession} session
  * @param {string} url
  * @return {Promise<{warnings: Array<LH.IcuMessage>}>}
  */
@@ -112,7 +112,7 @@ async function resetStorageForUrl(session, url) {
  *
  * This method assumes `prepareTargetForNavigationMode` or `prepareTargetForTimespanMode` has already been invoked.
  *
- * @param {LH.Gatherer.FRProtocolSession} session
+ * @param {LH.Gatherer.ProtocolSession} session
  * @param {LH.Config.Settings} settings
  * @param {{disableThrottling: boolean, blockedUrlPatterns?: string[]}} options
  */
@@ -141,7 +141,7 @@ async function prepareThrottlingAndNetwork(session, settings, options) {
  * Prepares a target to be analyzed by setting up device emulation (screen/UA, not throttling) and
  * async stack traces for network initiators.
  *
- * @param {LH.Gatherer.FRTransitionalDriver} driver
+ * @param {LH.Gatherer.Driver} driver
  * @param {LH.Config.Settings} settings
  */
 async function prepareDeviceEmulation(driver, settings) {
@@ -155,7 +155,7 @@ async function prepareDeviceEmulation(driver, settings) {
 /**
  * Prepares a target to be analyzed in timespan mode by enabling protocol domains, emulation, and throttling.
  *
- * @param {LH.Gatherer.FRTransitionalDriver} driver
+ * @param {LH.Gatherer.Driver} driver
  * @param {LH.Config.Settings} settings
  */
 async function prepareTargetForTimespanMode(driver, settings) {
@@ -176,7 +176,7 @@ async function prepareTargetForTimespanMode(driver, settings) {
  * Ensure the `Intl.Segmenter` created in `pageFunctions.truncate` is cached by v8 before
  * recording the trace begins.
  *
- * @param {LH.Gatherer.FRTransitionalDriver} driver
+ * @param {LH.Gatherer.Driver} driver
  */
 async function warmUpIntlSegmenter(driver) {
   await driver.executionContext.evaluate(pageFunctions.truncate, {
@@ -190,7 +190,7 @@ async function warmUpIntlSegmenter(driver) {
  *
  * This method should be used in combination with `prepareTargetForIndividualNavigation` before a specific navigation occurs.
  *
- * @param {LH.Gatherer.FRTransitionalDriver} driver
+ * @param {LH.Gatherer.Driver} driver
  * @param {LH.Config.Settings} settings
  */
 async function prepareTargetForNavigationMode(driver, settings) {
@@ -220,7 +220,7 @@ async function prepareTargetForNavigationMode(driver, settings) {
  *
  * This method assumes `prepareTargetForNavigationMode` has already been invoked.
  *
- * @param {LH.Gatherer.FRProtocolSession} session
+ * @param {LH.Gatherer.ProtocolSession} session
  * @param {LH.Config.Settings} settings
  * @param {Pick<LH.Config.NavigationDefn, 'disableThrottling'|'disableStorageReset'|'blockedUrlPatterns'> & {requestor: LH.NavigationRequestor}} navigation
  * @return {Promise<{warnings: Array<LH.IcuMessage>}>}