lighthouse 9.5.0-dev.20220622 → 9.5.0-dev.20220623

package/lighthouse-core/fraggle-rock/gather/session.js

@@ -11,7 +11,7 @@ const LHError = require('../../lib/lh-error.js');
 // Controls how long to wait for a response after sending a DevTools protocol command.
 const DEFAULT_PROTOCOL_TIMEOUT = 30000;
 
-/** @typedef {new () => LH.Protocol.StrictEventEmitter<LH.CrdpEvents>} CrdpEventMessageEmitter */
+/** @typedef {LH.Protocol.StrictEventEmitterClass<LH.CrdpEvents>} CrdpEventMessageEmitter */
 const CrdpEventEmitter = /** @type {CrdpEventMessageEmitter} */ (EventEmitter);
 
 /** @implements {LH.Gatherer.FRProtocolSession} */

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

@@ -16,14 +16,14 @@ const NetworkRecorder = require('../../lib/network-recorder.js');
 const NetworkRequest = require('../../lib/network-request.js');
 const URL = require('../../lib/url-shim.js');
 
-/** @typedef {import('../../lib/network-recorder.js').NetworkRecorderEvent} NetworkRecorderEvent */
+/** @typedef {import('../../lib/network-recorder.js').NetworkRecorderEventMap} NetworkRecorderEventMap */
 /** @typedef {'network-2-idle'|'network-critical-idle'|'networkidle'|'networkbusy'|'network-critical-busy'|'network-2-busy'} NetworkMonitorEvent_ */
-/** @typedef {NetworkRecorderEvent|NetworkMonitorEvent_} NetworkMonitorEvent */
-/** @typedef {Record<NetworkMonitorEvent_, []> & Record<NetworkRecorderEvent, [NetworkRequest]>} NetworkMonitorEventMap */
-/** @typedef {LH.Protocol.StrictEventEmitter<NetworkMonitorEventMap>} NetworkMonitorEmitter */
+/** @typedef {Record<NetworkMonitorEvent_, []> & NetworkRecorderEventMap} NetworkMonitorEventMap */
+/** @typedef {keyof NetworkMonitorEventMap} NetworkMonitorEvent */
+/** @typedef {LH.Protocol.StrictEventEmitterClass<NetworkMonitorEventMap>} NetworkMonitorEmitter */
+const NetworkMonitorEventEmitter = /** @type {NetworkMonitorEmitter} */ (EventEmitter);
 
-/** @implements {NetworkMonitorEmitter} */
-class NetworkMonitor {
+class NetworkMonitor extends NetworkMonitorEventEmitter {
   /** @type {NetworkRecorder|undefined} */
   _networkRecorder = undefined;
   /** @type {Array<LH.Crdp.Page.Frame>} */
@@ -32,6 +32,8 @@ class NetworkMonitor {
   // TODO(FR-COMPAT): switch to real TargetManager when legacy removed.
   /** @param {LH.Gatherer.FRTransitionalDriver['targetManager']} targetManager */
   constructor(targetManager) {
+    super();
+
     /** @type {LH.Gatherer.FRTransitionalDriver['targetManager']} */
     this._targetManager = targetManager;
 
@@ -46,25 +48,6 @@ class NetworkMonitor {
       if (!this._networkRecorder) return;
       this._networkRecorder.dispatch(event);
     };
-
-    // Attach the event emitter types to this class.
-    const emitter = /** @type {NetworkMonitorEmitter} */ (new EventEmitter());
-    /** @type {typeof emitter['emit']} */
-    this.emit = emitter.emit.bind(emitter);
-    /** @type {typeof emitter['on']} */
-    this.on = emitter.on.bind(emitter);
-    /** @type {typeof emitter['once']} */
-    this.once = emitter.once.bind(emitter);
-    /** @type {typeof emitter['off']} */
-    this.off = emitter.off.bind(emitter);
-    /** @type {typeof emitter['addListener']} */
-    this.addListener = emitter.addListener.bind(emitter);
-    /** @type {typeof emitter['removeListener']} */
-    this.removeListener = emitter.removeListener.bind(emitter);
-    /** @type {typeof emitter['removeAllListeners']} */
-    this.removeAllListeners = emitter.removeAllListeners.bind(emitter);
-    /** @type {typeof emitter['listenerCount']} */
-    this.listenerCount = emitter.listenerCount.bind(emitter);
   }
 
   /**
@@ -78,7 +61,7 @@ class NetworkMonitor {
 
     /**
      * Reemit the same network recorder events.
-     * @param {NetworkRecorderEvent} event
+     * @param {keyof NetworkRecorderEventMap} event
      * @return {(r: NetworkRequest) => void}
      */
     const reEmit = event => r => {

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

@@ -19,8 +19,8 @@ const ProtocolSession = require('../../fraggle-rock/gather/session.js');
  */
 
 // Add protocol event types to EventEmitter.
-/** @typedef {{'protocolevent': [LH.Protocol.RawEventMessage]}} ProtocolEventRecord */
-/** @typedef {new () => LH.Protocol.StrictEventEmitter<ProtocolEventRecord>} ProtocolEventMessageEmitter */
+/** @typedef {{'protocolevent': [LH.Protocol.RawEventMessage]}} ProtocolEventMap */
+/** @typedef {LH.Protocol.StrictEventEmitterClass<ProtocolEventMap>} ProtocolEventMessageEmitter */
 const ProtocolEventEmitter = /** @type {ProtocolEventMessageEmitter} */ (EventEmitter);
 
 /**

package/lighthouse-core/lib/network-recorder.js

@@ -9,9 +9,16 @@ const log = require('lighthouse-logger');
 const NetworkRequest = require('./network-request.js');
 const EventEmitter = require('events').EventEmitter;
 
-/** @typedef {'requeststarted'|'requestfinished'} NetworkRecorderEvent */
+/**
+ * @typedef {{
+ *   requeststarted: [NetworkRequest],
+ *   requestfinished: [NetworkRequest],
+ * }} NetworkRecorderEventMap
+ */
+/** @typedef {LH.Protocol.StrictEventEmitterClass<NetworkRecorderEventMap>} RequestEmitter */
+const RequestEventEmitter = /** @type {RequestEmitter} */ (EventEmitter);
 
-class NetworkRecorder extends EventEmitter {
+class NetworkRecorder extends RequestEventEmitter {
   /**
    * Creates an instance of NetworkRecorder.
    */
@@ -35,22 +42,6 @@ class NetworkRecorder extends EventEmitter {
     return Array.from(this._records);
   }
 
-  /**
-   * @param {NetworkRecorderEvent} event
-   * @param {*} listener
-   */
-  on(event, listener) {
-    return super.on(event, listener);
-  }
-
-  /**
-   * @param {NetworkRecorderEvent} event
-   * @param {*} listener
-   */
-  once(event, listener) {
-    return super.once(event, listener);
-  }
-
   /**
    * Listener for the DevTools SDK NetworkManager's RequestStarted event, which includes both
    * web socket and normal request creation.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lighthouse",
-  "version": "9.5.0-dev.20220622",
+  "version": "9.5.0-dev.20220623",
   "description": "Automated auditing, performance metrics, and best practices for the web.",
   "main": "./lighthouse-core/index.js",
   "bin": {

package/types/protocol.d.ts

@@ -53,7 +53,7 @@ declare module Protocol {
    * serve as the arguments to event listener callbacks.
    * Inspired by work from https://github.com/bterlson/strict-event-emitter-types.
    */
-  type StrictEventEmitter<TEventRecord extends Record<keyof TEventRecord, any[]>> = {
+  type StrictEventEmitter<TEventRecord extends Record<keyof TEventRecord, unknown[]>> = {
     on<E extends keyof TEventRecord>(event: E, listener: (...args: TEventRecord[E]) => void): void;
 
     off<E extends keyof TEventRecord>(event: E, listener: Function): void;
@@ -70,6 +70,13 @@ declare module Protocol {
 
     listenerCount<E extends keyof TEventRecord>(event: E): number;
   }
+
+  /**
+   * A constructable StrictEventEmitter.
+   */
+  interface StrictEventEmitterClass<TEventRecord extends Record<keyof TEventRecord, unknown[]>> {
+    new(): StrictEventEmitter<TEventRecord>;
+  }
 }
 
 export default Protocol;