lighthouse 10.1.1-dev.20230430 → 10.1.1-dev.20230502

package/core/audits/network-requests.js

@@ -63,6 +63,7 @@ class NetworkRequests extends Audit {
 
       return {
         url: UrlUtils.elideDataURI(record.url),
+        sessionTargetType: record.sessionTargetType,
         protocol: record.protocol,
         rendererStartTime: normalizeTime(record.rendererStartTime),
         networkRequestTime: normalizeTime(record.networkRequestTime),

package/core/audits/predictive-perf.js

@@ -34,7 +34,7 @@ class PredictivePerf extends Audit {
         'a cellular connection on a mobile device.',
       scoreDisplayMode: Audit.SCORING_MODES.NUMERIC,
       supportedModes: ['navigation'],
-      requiredArtifacts: ['traces', 'devtoolsLogs', 'GatherContext'],
+      requiredArtifacts: ['traces', 'devtoolsLogs', 'GatherContext', 'URL'],
     };
   }
 

package/core/gather/driver/target-manager.d.ts

@@ -45,9 +45,10 @@ export class TargetManager extends TargetManager_base {
     /**
      * Returns a listener for all protocol events from session, and augments the
      * event with the sessionId.
+     * @param {LH.Protocol.TargetType} targetType
      * @param {string} sessionId
      */
-    _getProtocolEventListener(sessionId: string): <EventName extends keyof import("puppeteer-core").ProtocolMapping.Events>(method: EventName, params: import("../../../types/protocol.js").default.RawEventMessageRecord[EventName]["params"]) => void;
+    _getProtocolEventListener(targetType: LH.Protocol.TargetType, sessionId: string): <EventName extends keyof import("puppeteer-core").ProtocolMapping.Events>(method: EventName, params: import("../../../types/protocol.js").default.RawEventMessageRecord[EventName]["params"]) => void;
     /**
      * @return {Promise<void>}
      */

package/core/gather/driver/target-manager.js

@@ -119,7 +119,7 @@ class TargetManager extends ProtocolEventEmitter {
       const targetName = target.targetInfo.url || target.targetInfo.targetId;
       log.verbose('target-manager', `target ${targetName} attached`);
 
-      const trueProtocolListener = this._getProtocolEventListener(newSession.id());
+      const trueProtocolListener = this._getProtocolEventListener(targetType, newSession.id());
       /** @type {(event: unknown) => void} */
       // @ts-expect-error - pptr currently typed only for single arg emits.
       const protocolListener = trueProtocolListener;
@@ -156,9 +156,10 @@ class TargetManager extends ProtocolEventEmitter {
   /**
    * Returns a listener for all protocol events from session, and augments the
    * event with the sessionId.
+   * @param {LH.Protocol.TargetType} targetType
    * @param {string} sessionId
    */
-  _getProtocolEventListener(sessionId) {
+  _getProtocolEventListener(targetType, sessionId) {
     /**
      * @template {keyof LH.Protocol.RawEventMessageRecord} EventName
      * @param {EventName} method
@@ -166,7 +167,8 @@ class TargetManager extends ProtocolEventEmitter {
      */
     const onProtocolEvent = (method, params) => {
       // Cast because tsc 4.7 still can't quite track the dependent parameters.
-      const payload = /** @type {LH.Protocol.RawEventMessage} */ ({method, params, sessionId});
+      const payload = /** @type {LH.Protocol.RawEventMessage} */ (
+        {method, params, targetType, sessionId});
       this.emit('protocolevent', payload);
     };
 

package/core/gather/gatherers/dobetterweb/optimized-images.js

@@ -54,8 +54,8 @@ class OptimizedImages extends FRGatherer {
     /** @type {Set<string>} */
     const seenUrls = new Set();
     return networkRecords.reduce((prev, record) => {
-      // Skip records that we've seen before, never finished, or came from child targets (OOPIFS).
-      if (seenUrls.has(record.url) || !record.finished || record.sessionId) {
+      // Skip records that we've seen before, never finished, or came from OOPIFs.
+      if (seenUrls.has(record.url) || !record.finished || record.isOutOfProcessIframe) {
         return prev;
       }
 

package/core/gather/gatherers/dobetterweb/response-compression.js

@@ -55,8 +55,7 @@ class ResponseCompression extends FRGatherer {
     const unoptimizedResponses = [];
 
     networkRecords.forEach(record => {
-      // Ignore records from child targets (OOPIFS).
-      if (record.sessionId) return;
+      if (record.isOutOfProcessIframe) return;
 
       const mimeType = record.mimeType;
       const resourceType = record.resourceType || NetworkRequest.TYPES.Other;

package/core/gather/gatherers/script-elements.js

@@ -65,8 +65,7 @@ class ScriptElements extends FRGatherer {
 
     const scriptRecords = networkRecords
       .filter(record => record.resourceType === NetworkRequest.TYPES.Script)
-      // Ignore records from OOPIFs
-      .filter(record => !record.sessionId);
+      .filter(record => !record.isOutOfProcessIframe);
 
     for (let i = 0; i < scriptRecords.length; i++) {
       const record = scriptRecords[i];

package/core/gather/gatherers/scripts.d.ts

@@ -7,8 +7,6 @@ declare class Scripts extends FRGatherer {
     _scriptParsedEvents: LH.Crdp.Debugger.ScriptParsedEvent[];
     /** @type {Array<string | undefined>} */
     _scriptContents: Array<string | undefined>;
-    /** @type {string|null|undefined} */
-    _mainSessionId: string | null | undefined;
     /**
      * @param {LH.Crdp.Debugger.ScriptParsedEvent} params
      */

package/core/gather/gatherers/scripts.js

@@ -59,9 +59,6 @@ class Scripts extends FRGatherer {
   /** @type {Array<string | undefined>} */
   _scriptContents = [];
 
-  /** @type {string|null|undefined} */
-  _mainSessionId = null;
-
   constructor() {
     super();
     this.onScriptParsed = this.onScriptParsed.bind(this);

package/core/legacy/gather/connections/connection.d.ts

@@ -17,6 +17,8 @@ export class Connection {
     _lastCommandId: number;
     /** @type {Map<number, CommandCallback>} */
     _callbacks: Map<number, CommandCallback>;
+    /** @type {Map<string, LH.Protocol.TargetType>} */
+    _sessionIdToTargetType: Map<string, LH.Protocol.TargetType>;
     _eventEmitter: CrdpEventMessageEmitter | null;
     /**
      * @return {Promise<void>}

package/core/legacy/gather/connections/connection.js

@@ -25,6 +25,8 @@ class Connection {
     this._lastCommandId = 0;
     /** @type {Map<number, CommandCallback>} */
     this._callbacks = new Map();
+    /** @type {Map<string, LH.Protocol.TargetType>} */
+    this._sessionIdToTargetType = new Map();
 
     this._eventEmitter = /** @type {?CrdpEventMessageEmitter} */ (new EventEmitter());
   }
@@ -129,6 +131,18 @@ class Connection {
     if (!('id' in object)) {
       log.formatProtocol('<= event',
           {method: object.method, params: object.params}, 'verbose');
+      if (object.method === 'Target.attachedToTarget') {
+        const type = object.params.targetInfo.type;
+        if (type === 'page' || type === 'iframe') {
+          this._sessionIdToTargetType.set(object.params.sessionId, type);
+        }
+      }
+      if (object.sessionId) {
+        const type = this._sessionIdToTargetType.get(object.sessionId);
+        if (type) {
+          object.targetType = type;
+        }
+      }
       this.emitProtocolEvent(object);
       return;
     }
@@ -175,6 +189,7 @@ class Connection {
       this._eventEmitter.removeAllListeners();
       this._eventEmitter = null;
     }
+    this._sessionIdToTargetType.clear();
   }
 }
 

package/core/lib/network-recorder.d.ts

@@ -22,8 +22,6 @@ export class NetworkRecorder extends NetworkRecorder_base {
     _records: NetworkRequest[];
     /** @type {Map<string, NetworkRequest>} */
     _recordsById: Map<string, NetworkRequest>;
-    /** @type {string|null|undefined} */
-    _mainSessionId: string | null | undefined;
     /**
      * Returns the array of raw network request data without finalizing the initiator and
      * redirect chain.
@@ -45,52 +43,59 @@ export class NetworkRecorder extends NetworkRecorder_base {
      */
     private onRequestFinished;
     /**
-     * @param {{params: LH.Crdp.Network.RequestWillBeSentEvent, sessionId?: string}} event
+     * @param {{params: LH.Crdp.Network.RequestWillBeSentEvent, targetType: LH.Protocol.TargetType, sessionId?: string}} event
      */
     onRequestWillBeSent(event: {
         params: LH.Crdp.Network.RequestWillBeSentEvent;
+        targetType: LH.Protocol.TargetType;
         sessionId?: string;
     }): void;
     /**
-     * @param {{params: LH.Crdp.Network.RequestServedFromCacheEvent, sessionId?: string}} event
+     * @param {{params: LH.Crdp.Network.RequestServedFromCacheEvent, targetType: LH.Protocol.TargetType, sessionId?: string}} event
      */
     onRequestServedFromCache(event: {
         params: LH.Crdp.Network.RequestServedFromCacheEvent;
+        targetType: LH.Protocol.TargetType;
         sessionId?: string;
     }): void;
     /**
-     * @param {{params: LH.Crdp.Network.ResponseReceivedEvent, sessionId?: string}} event
+     * @param {{params: LH.Crdp.Network.ResponseReceivedEvent, targetType: LH.Protocol.TargetType, sessionId?: string}} event
      */
     onResponseReceived(event: {
         params: LH.Crdp.Network.ResponseReceivedEvent;
+        targetType: LH.Protocol.TargetType;
         sessionId?: string;
     }): void;
     /**
-     * @param {{params: LH.Crdp.Network.DataReceivedEvent, sessionId?: string}} event
+     * @param {{params: LH.Crdp.Network.DataReceivedEvent, targetType: LH.Protocol.TargetType, sessionId?: string}} event
      */
     onDataReceived(event: {
         params: LH.Crdp.Network.DataReceivedEvent;
+        targetType: LH.Protocol.TargetType;
         sessionId?: string;
     }): void;
     /**
-     * @param {{params: LH.Crdp.Network.LoadingFinishedEvent, sessionId?: string}} event
+     * @param {{params: LH.Crdp.Network.LoadingFinishedEvent, targetType: LH.Protocol.TargetType, sessionId?: string}} event
      */
     onLoadingFinished(event: {
         params: LH.Crdp.Network.LoadingFinishedEvent;
+        targetType: LH.Protocol.TargetType;
         sessionId?: string;
     }): void;
     /**
-     * @param {{params: LH.Crdp.Network.LoadingFailedEvent, sessionId?: string}} event
+     * @param {{params: LH.Crdp.Network.LoadingFailedEvent, targetType: LH.Protocol.TargetType, sessionId?: string}} event
      */
     onLoadingFailed(event: {
         params: LH.Crdp.Network.LoadingFailedEvent;
+        targetType: LH.Protocol.TargetType;
         sessionId?: string;
     }): void;
     /**
-     * @param {{params: LH.Crdp.Network.ResourceChangedPriorityEvent, sessionId?: string}} event
+     * @param {{params: LH.Crdp.Network.ResourceChangedPriorityEvent, targetType: LH.Protocol.TargetType, sessionId?: string}} event
      */
     onResourceChangedPriority(event: {
         params: LH.Crdp.Network.ResourceChangedPriorityEvent;
+        targetType: LH.Protocol.TargetType;
         sessionId?: string;
     }): void;
     /**
@@ -105,10 +110,11 @@ export class NetworkRecorder extends NetworkRecorder_base {
      * message is referring.
      *
      * @param {string} requestId
+     * @param {LH.Protocol.TargetType} targetType
      * @param {string|undefined} sessionId
      * @return {NetworkRequest|undefined}
      */
-    _findRealRequestAndSetSession(requestId: string, sessionId: string | undefined): NetworkRequest | undefined;
+    _findRealRequestAndSetSession(requestId: string, targetType: LH.Protocol.TargetType, sessionId: string | undefined): NetworkRequest | undefined;
 }
 import { NetworkRequest } from './network-request.js';
 export {};

package/core/lib/network-recorder.js

@@ -31,8 +31,6 @@ class NetworkRecorder extends RequestEventEmitter {
     this._records = [];
     /** @type {Map<string, NetworkRequest>} */
     this._recordsById = new Map();
-    /** @type {string|null|undefined} */
-    this._mainSessionId = null;
   }
 
   /**
@@ -71,11 +69,12 @@ class NetworkRecorder extends RequestEventEmitter {
   // DevTools SDK network layer.
 
   /**
-   * @param {{params: LH.Crdp.Network.RequestWillBeSentEvent, sessionId?: string}} event
+   * @param {{params: LH.Crdp.Network.RequestWillBeSentEvent, targetType: LH.Protocol.TargetType, sessionId?: string}} event
    */
   onRequestWillBeSent(event) {
     const data = event.params;
-    const originalRequest = this._findRealRequestAndSetSession(data.requestId, event.sessionId);
+    const originalRequest = this._findRealRequestAndSetSession(
+      data.requestId, event.targetType, event.sessionId);
     // This is a simple new request, create the NetworkRequest object and finish.
     if (!originalRequest) {
       const request = new NetworkRequest();
@@ -114,44 +113,48 @@ class NetworkRecorder extends RequestEventEmitter {
   }
 
   /**
-   * @param {{params: LH.Crdp.Network.RequestServedFromCacheEvent, sessionId?: string}} event
+   * @param {{params: LH.Crdp.Network.RequestServedFromCacheEvent, targetType: LH.Protocol.TargetType, sessionId?: string}} event
    */
   onRequestServedFromCache(event) {
     const data = event.params;
-    const request = this._findRealRequestAndSetSession(data.requestId, event.sessionId);
+    const request = this._findRealRequestAndSetSession(
+      data.requestId, event.targetType, event.sessionId);
     if (!request) return;
     log.verbose('network', `${request.url} served from cache`);
     request.onRequestServedFromCache();
   }
 
   /**
-   * @param {{params: LH.Crdp.Network.ResponseReceivedEvent, sessionId?: string}} event
+   * @param {{params: LH.Crdp.Network.ResponseReceivedEvent, targetType: LH.Protocol.TargetType, sessionId?: string}} event
    */
   onResponseReceived(event) {
     const data = event.params;
-    const request = this._findRealRequestAndSetSession(data.requestId, event.sessionId);
+    const request = this._findRealRequestAndSetSession(
+      data.requestId, event.targetType, event.sessionId);
     if (!request) return;
     log.verbose('network', `${request.url} response received`);
     request.onResponseReceived(data);
   }
 
   /**
-   * @param {{params: LH.Crdp.Network.DataReceivedEvent, sessionId?: string}} event
+   * @param {{params: LH.Crdp.Network.DataReceivedEvent, targetType: LH.Protocol.TargetType, sessionId?: string}} event
    */
   onDataReceived(event) {
     const data = event.params;
-    const request = this._findRealRequestAndSetSession(data.requestId, event.sessionId);
+    const request = this._findRealRequestAndSetSession(
+      data.requestId, event.targetType, event.sessionId);
     if (!request) return;
     log.verbose('network', `${request.url} data received`);
     request.onDataReceived(data);
   }
 
   /**
-   * @param {{params: LH.Crdp.Network.LoadingFinishedEvent, sessionId?: string}} event
+   * @param {{params: LH.Crdp.Network.LoadingFinishedEvent, targetType: LH.Protocol.TargetType, sessionId?: string}} event
    */
   onLoadingFinished(event) {
     const data = event.params;
-    const request = this._findRealRequestAndSetSession(data.requestId, event.sessionId);
+    const request = this._findRealRequestAndSetSession(
+      data.requestId, event.targetType, event.sessionId);
     if (!request) return;
     log.verbose('network', `${request.url} loading finished`);
     request.onLoadingFinished(data);
@@ -159,11 +162,12 @@ class NetworkRecorder extends RequestEventEmitter {
   }
 
   /**
-   * @param {{params: LH.Crdp.Network.LoadingFailedEvent, sessionId?: string}} event
+   * @param {{params: LH.Crdp.Network.LoadingFailedEvent, targetType: LH.Protocol.TargetType, sessionId?: string}} event
    */
   onLoadingFailed(event) {
     const data = event.params;
-    const request = this._findRealRequestAndSetSession(data.requestId, event.sessionId);
+    const request = this._findRealRequestAndSetSession(
+      data.requestId, event.targetType, event.sessionId);
     if (!request) return;
     log.verbose('network', `${request.url} loading failed`);
     request.onLoadingFailed(data);
@@ -171,11 +175,12 @@ class NetworkRecorder extends RequestEventEmitter {
   }
 
   /**
-   * @param {{params: LH.Crdp.Network.ResourceChangedPriorityEvent, sessionId?: string}} event
+   * @param {{params: LH.Crdp.Network.ResourceChangedPriorityEvent, targetType: LH.Protocol.TargetType, sessionId?: string}} event
    */
   onResourceChangedPriority(event) {
     const data = event.params;
-    const request = this._findRealRequestAndSetSession(data.requestId, event.sessionId);
+    const request = this._findRealRequestAndSetSession(
+      data.requestId, event.targetType, event.sessionId);
     if (!request) return;
     request.onResourceChangedPriority(data);
   }
@@ -204,24 +209,11 @@ class NetworkRecorder extends RequestEventEmitter {
    * message is referring.
    *
    * @param {string} requestId
+   * @param {LH.Protocol.TargetType} targetType
    * @param {string|undefined} sessionId
    * @return {NetworkRequest|undefined}
    */
-  _findRealRequestAndSetSession(requestId, sessionId) {
-    // The very first sessionId processed is always the main sessionId. In all but DevTools,
-    // this sessionId is undefined. However, in DevTools the main Lighthouse protocol connection
-    // does send events with sessionId set to a string, because of how DevTools routes the protocol
-    // to Lighthouse.
-    // Many places in Lighthouse use `record.sessionId === undefined` to mean that the session is not
-    // an OOPIF. To maintain this property, we intercept sessionId here and set it to undefined if
-    // it matches the first value seen.
-    if (this._mainSessionId === null) {
-      this._mainSessionId = sessionId;
-    }
-    if (this._mainSessionId === sessionId) {
-      sessionId = undefined;
-    }
-
+  _findRealRequestAndSetSession(requestId, targetType, sessionId) {
     let request = this._recordsById.get(requestId);
     if (!request || !request.isValid) return undefined;
 
@@ -230,6 +222,7 @@ class NetworkRecorder extends RequestEventEmitter {
     }
 
     request.setSession(sessionId);
+    request.sessionTargetType = targetType;
 
     return request;
   }

package/core/lib/network-request.d.ts

@@ -133,12 +133,10 @@ export class NetworkRequest {
     fetchedViaServiceWorker: boolean;
     /** @type {string|undefined} */
     frameId: string | undefined;
-    /**
-     * @type {string|undefined}
-     * Only set for child targets (OOPIFs). This is the sessionId of the protocol connection on
-     * which this request was discovered. `undefined` means it came from the root.
-     */
+    /** @type {string|undefined} */
     sessionId: string | undefined;
+    /** @type {LH.Protocol.TargetType|undefined} */
+    sessionTargetType: LH.Protocol.TargetType | undefined;
     isLinkPreload: boolean;
     /**
      * @return {boolean}
@@ -178,9 +176,10 @@ export class NetworkRequest {
      */
     onRedirectResponse(data: LH.Crdp.Network.RequestWillBeSentEvent): void;
     /**
-     * @param {string=} sessionId
+     * @param {string|undefined} sessionId
      */
-    setSession(sessionId?: string | undefined): void;
+    setSession(sessionId: string | undefined): void;
+    get isOutOfProcessIframe(): boolean;
     /**
      * @param {LH.Crdp.Network.Response} response
      * @param {number} timestamp in seconds

package/core/lib/network-request.js

@@ -178,12 +178,10 @@ class NetworkRequest {
     this.fetchedViaServiceWorker = false;
     /** @type {string|undefined} */
     this.frameId = '';
-    /**
-     * @type {string|undefined}
-     * Only set for child targets (OOPIFs). This is the sessionId of the protocol connection on
-     * which this request was discovered. `undefined` means it came from the root.
-     */
+    /** @type {string|undefined} */
     this.sessionId = undefined;
+    /** @type {LH.Protocol.TargetType|undefined} */
+    this.sessionTargetType = undefined;
     this.isLinkPreload = false;
   }
 
@@ -320,12 +318,16 @@ class NetworkRequest {
   }
 
   /**
-   * @param {string=} sessionId
+   * @param {string|undefined} sessionId
    */
   setSession(sessionId) {
     this.sessionId = sessionId;
   }
 
+  get isOutOfProcessIframe() {
+    return this.sessionTargetType === 'iframe';
+  }
+
   /**
    * @param {LH.Crdp.Network.Response} response
    * @param {number} timestamp in seconds

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "lighthouse",
   "type": "module",
-  "version": "10.1.1-dev.20230430",
+  "version": "10.1.1-dev.20230502",
   "description": "Automated auditing, performance metrics, and best practices for the web.",
   "main": "./core/index.js",
   "bin": {

package/types/protocol.d.ts

@@ -10,6 +10,8 @@ type CrdpEvents = CrdpMappings.Events;
 type CrdpCommands = CrdpMappings.Commands;
 
 declare module Protocol {
+  type TargetType = 'page' | 'iframe' | 'worker';
+
   /**
    * An intermediate type, used to create a record of all possible Crdp raw event
    * messages, keyed on method. e.g. {
@@ -22,6 +24,7 @@ declare module Protocol {
       method: K,
       // Drop [] for `undefined` (so a JS value is valid).
       params: CrdpEvents[K] extends [] ? undefined: CrdpEvents[K][number]
+      targetType: TargetType;
       // If sessionId is not set, it means the event was from the root target.
       sessionId?: string;
     };