lighthouse 11.6.0-dev.20240304 → 11.6.0-dev.20240305

package/types/gatherer.d.ts

@@ -7,9 +7,6 @@
 import {Protocol as Crdp} from 'devtools-protocol/types/protocol.js';
 import {ProtocolMapping as CrdpMappings} from 'devtools-protocol/types/protocol-mapping.js';
 
-import {NetworkNode as _NetworkNode} from '../core/lib/lantern/network-node.js';
-import {CPUNode as _CPUNode} from '../core/lib/lantern/cpu-node.js';
-import {Simulator as _Simulator} from '../core/lib/lantern/simulator/simulator.js';
 import {ExecutionContext} from '../core/gather/driver/execution-context.js';
 import {NetworkMonitor} from '../core/gather/driver/network-monitor.js';
 import {Fetcher} from '../core/gather/fetcher.js';
@@ -20,6 +17,7 @@ import Config from './config.js';
 import Result from './lhr/lhr.js';
 import Protocol from './protocol.js';
 import Puppeteer from './puppeteer.js';
+import {Lantern} from '../types/internal/lantern.js';
 
 type CrdpEvents = CrdpMappings.Events;
 type CrdpCommands = CrdpMappings.Commands;
@@ -133,38 +131,13 @@ declare module Gatherer {
   type AnyGathererInstance = GathererInstanceExpander<Gatherer.DependencyKey>
 
   namespace Simulation {
-    type GraphNode = import('../core/lib/lantern/base-node.js').Node<Artifacts.NetworkRequest>;
-    type GraphNetworkNode = _NetworkNode<Artifacts.NetworkRequest>;
-    type GraphCPUNode = _CPUNode;
-    type Simulator = _Simulator;
-
-    interface MetricCoefficients {
-      intercept: number;
-      optimistic: number;
-      pessimistic: number;
-    }
-
-    interface Options {
-      rtt?: number;
-      throughput?: number;
-      observedThroughput: number;
-      maximumConcurrentRequests?: number;
-      cpuSlowdownMultiplier?: number;
-      layoutTaskMultiplier?: number;
-      additionalRttByOrigin?: Map<string, number>;
-      serverResponseTimeByOrigin?: Map<string, number>;
-    }
-
-    interface NodeTiming {
-      startTime: number;
-      endTime: number;
-      duration: number;
-    }
-
-    interface Result {
-      timeInMs: number;
-      nodeTimings: Map<GraphNode, NodeTiming>;
-    }
+    type GraphNode = Lantern.Simulation.GraphNode<Artifacts.NetworkRequest>;
+    type GraphNetworkNode = Lantern.Simulation.GraphNetworkNode<Artifacts.NetworkRequest>;
+    type GraphCPUNode = Lantern.Simulation.GraphCPUNode;
+    type Simulator = Lantern.Simulation.Simulator<Artifacts.NetworkRequest>;
+    type NodeTiming = Lantern.Simulation.NodeTiming;
+    type MetricCoefficients = Lantern.Simulation.MetricCoefficients;
+    type Result = Lantern.Simulation.Result<Artifacts.NetworkRequest>;
   }
 }
 

package/types/internal/lantern.d.ts

@@ -4,79 +4,121 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import * as LH from '../lh.js'
+import * as LH from '../lh.js';
 
-export type ParsedURL = {
-    /**
-     * Equivalent to a `new URL(url).protocol` BUT w/o the trailing colon (:)
-     */
-    scheme: string;
-    /**
-     * Equivalent to a `new URL(url).hostname`
-     */
-    host: string;
-    securityOrigin: string;
-};
-export type LightriderStatistics = {
-    /**
-     * The difference in networkEndTime between the observed Lighthouse networkEndTime and Lightrider's derived networkEndTime.
-     */
-    endTimeDeltaMs: number;
-    /**
-     * The time spent making a TCP connection (connect + SSL). Note: this is poorly named.
-     */
-    TCPMs: number;
-    /**
-     * The time spent requesting a resource from a remote server, we use this to approx RTT. Note: this is poorly names, it really should be "server response time".
-     */
-    requestMs: number;
-    /**
-     * Time to receive the entire response payload starting the clock on receiving the first fragment (first non-header byte).
-     */
-    responseMs: number;
-};
-export class NetworkRequest<T=any> {
-    /**
-     * The canonical network record.
-     * Users of Lantern must create NetworkRequests matching this interface,
-     * but can store the source-of-truth for their network model in this `record`
-     * property. This is then accessible as a read-only property on NetworkNode.
-     */
-    record?: T;
+declare namespace Lantern {
+    type ParsedURL = {
+        /**
+         * Equivalent to a `new URL(url).protocol` BUT w/o the trailing colon (:)
+         */
+        scheme: string;
+        /**
+         * Equivalent to a `new URL(url).hostname`
+         */
+        host: string;
+        securityOrigin: string;
+    };
+    type LightriderStatistics = {
+        /**
+         * The difference in networkEndTime between the observed Lighthouse networkEndTime and Lightrider's derived networkEndTime.
+         */
+        endTimeDeltaMs: number;
+        /**
+         * The time spent making a TCP connection (connect + SSL). Note: this is poorly named.
+         */
+        TCPMs: number;
+        /**
+         * The time spent requesting a resource from a remote server, we use this to approx RTT. Note: this is poorly names, it really should be "server response time".
+         */
+        requestMs: number;
+        /**
+         * Time to receive the entire response payload starting the clock on receiving the first fragment (first non-header byte).
+         */
+        responseMs: number;
+    };
+    class NetworkRequest<T = any> {
+        /**
+         * The canonical network record.
+         * Users of Lantern must create NetworkRequests matching this interface,
+         * but can store the source-of-truth for their network model in this `record`
+         * property. This is then accessible as a read-only property on NetworkNode.
+         */
+        record?: T;
 
-    requestId: string;
-    connectionId: string;
-    connectionReused: boolean;
-    url: string;
-    protocol: string;
-    parsedURL: ParsedURL;
-    /** When the renderer process initially discovers a network request, in milliseconds. */
-    rendererStartTime: number;
-    /**
-     * When the network service is about to handle a request, ie. just before going to the
-     * HTTP cache or going to the network for DNS/connection setup, in milliseconds.
-     */
-    networkRequestTime: number;
-    /** When the last byte of the response headers is received, in milliseconds. */
-    responseHeadersEndTime: number;
-    /** When the last byte of the response body is received, in milliseconds. */
-    networkEndTime: number;
-    transferSize: number;
-    resourceSize: number;
-    fromDiskCache: boolean;
-    fromMemoryCache: boolean;
-    // TODO(15841): remove from lantern.
-    /** Extra timing information available only when run in Lightrider. */
-    lrStatistics: LightriderStatistics | undefined;
-    finished: boolean;
-    statusCode: number;
-    /** The network request that this one redirected to */
-    redirectDestination: NetworkRequest<T> | undefined;
-    failed: boolean;
-    initiator: LH.Crdp.Network.Initiator;
-    timing: LH.Crdp.Network.ResourceTiming | undefined;
-    resourceType: LH.Crdp.Network.ResourceType | undefined;
-    priority: LH.Crdp.Network.ResourcePriority;
-}
+        requestId: string;
+        connectionId: string;
+        connectionReused: boolean;
+        url: string;
+        protocol: string;
+        parsedURL: ParsedURL;
+        documentURL: string;
+        /** When the renderer process initially discovers a network request, in milliseconds. */
+        rendererStartTime: number;
+        /**
+         * When the network service is about to handle a request, ie. just before going to the
+         * HTTP cache or going to the network for DNS/connection setup, in milliseconds.
+         */
+        networkRequestTime: number;
+        /** When the last byte of the response headers is received, in milliseconds. */
+        responseHeadersEndTime: number;
+        /** When the last byte of the response body is received, in milliseconds. */
+        networkEndTime: number;
+        transferSize: number;
+        resourceSize: number;
+        fromDiskCache: boolean;
+        fromMemoryCache: boolean;
+        // TODO(15841): remove from lantern.
+        /** Extra timing information available only when run in Lightrider. */
+        lrStatistics: LightriderStatistics | undefined;
+        finished: boolean;
+        statusCode: number;
+        /** The network request that this one redirected to */
+        redirectDestination: NetworkRequest<T> | undefined;
+        failed: boolean;
+        initiator: LH.Crdp.Network.Initiator;
+        initiatorRequest: NetworkRequest<T> | undefined;
+        /** The chain of network requests that redirected to this one */
+        redirects: NetworkRequest[] | undefined;
+        timing: LH.Crdp.Network.ResourceTiming | undefined;
+        resourceType: LH.Crdp.Network.ResourceType | undefined;
+        mimeType: string;
+        priority: LH.Crdp.Network.ResourcePriority;
+        frameId: string | undefined;
+        sessionTargetType: LH.Protocol.TargetType | undefined;
+    }
+
+    export namespace Simulation {
+        type GraphNode<T> = import('../../core/lib/lantern/base-node.js').Node<T>;
+        type GraphNetworkNode<T> = import('../../core/lib/lantern/network-node.js').NetworkNode<T>;
+        type GraphCPUNode = import('../../core/lib/lantern/cpu-node.js').CPUNode;
+        type Simulator<T> = import('../../core/lib/lantern/simulator/simulator.js').Simulator<T>;
+
+        interface MetricCoefficients {
+            intercept: number;
+            optimistic: number;
+            pessimistic: number;
+        }
 
-export {};
+        interface Options {
+            rtt?: number;
+            throughput?: number;
+            observedThroughput: number;
+            maximumConcurrentRequests?: number;
+            cpuSlowdownMultiplier?: number;
+            layoutTaskMultiplier?: number;
+            additionalRttByOrigin?: Map<string, number>;
+            serverResponseTimeByOrigin?: Map<string, number>;
+        }
+
+        interface NodeTiming {
+            startTime: number;
+            endTime: number;
+            duration: number;
+        }
+
+        interface Result<T = any> {
+            timeInMs: number;
+            nodeTimings: Map<GraphNode<T>, NodeTiming>;
+        }
+    }
+}