lighthouse 9.5.0-dev.20220608 → 9.5.0-dev.20220609

package/esm-utils.mjs

@@ -0,0 +1,40 @@
+/**
+ * @license Copyright 2021 The Lighthouse Authors. All Rights Reserved.
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+ */
+'use strict';
+// TODO(esmodules): rename to .js when root is type: module
+
+import module from 'module';
+import url from 'url';
+import path from 'path';
+
+/**
+ * Commonjs equivalent of `require.resolve`.
+ * @param {string} packageName
+ */
+function resolveModulePath(packageName) {
+  const require = module.createRequire(import.meta.url);
+  return require.resolve(packageName);
+}
+
+/**
+ * @param {ImportMeta} importMeta
+ */
+function getModulePath(importMeta) {
+  return url.fileURLToPath(importMeta.url);
+}
+
+/**
+ * @param {ImportMeta} importMeta
+ */
+function getModuleDirectory(importMeta) {
+  return path.dirname(getModulePath(importMeta));
+}
+
+export {
+  resolveModulePath,
+  getModulePath,
+  getModuleDirectory,
+};

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

@@ -26,8 +26,6 @@ const throwingSession = {
   off: throwNotConnectedFn,
   addProtocolMessageListener: throwNotConnectedFn,
   removeProtocolMessageListener: throwNotConnectedFn,
-  addSessionAttachedListener: throwNotConnectedFn,
-  removeSessionAttachedListener: throwNotConnectedFn,
   sendCommand: throwNotConnectedFn,
   dispose: throwNotConnectedFn,
 };

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

@@ -27,6 +27,7 @@ class ProtocolSession {
 
   sessionId() {
     return this._targetInfo && this._targetInfo.type === 'iframe' ?
+      // TODO: use this._session.id() for real session id.
       this._targetInfo.targetId :
       undefined;
   }
@@ -77,27 +78,6 @@ class ProtocolSession {
     this._cdpSession.once(eventName, /** @type {*} */ (callback));
   }
 
-  /**
-   * Bind to the puppeteer `sessionattached` listener and return an LH ProtocolSession.
-   * @param {(session: ProtocolSession) => void} callback
-   */
-  addSessionAttachedListener(callback) {
-    /** @param {LH.Puppeteer.CDPSession} session */
-    const listener = session => callback(new ProtocolSession(session));
-    this._callbackMap.set(callback, listener);
-    this._getConnection().on('sessionattached', listener);
-  }
-
-  /**
-   * Unbind to the puppeteer `sessionattached` listener.
-   * @param {(session: ProtocolSession) => void} callback
-   */
-  removeSessionAttachedListener(callback) {
-    const listener = this._callbackMap.get(callback);
-    if (!listener) return;
-    this._getConnection().off('sessionattached', listener);
-  }
-
   /**
    * Bind to puppeteer's '*' event that fires for *any* protocol event,
    * and wrap it with data about the protocol message instead of just the event.
@@ -172,12 +152,6 @@ class ProtocolSession {
     this._cdpSession.removeAllListeners();
     await this._cdpSession.detach();
   }
-
-  _getConnection() {
-    const connection = this._cdpSession.connection();
-    if (!connection) throw new Error('Connection has been closed.');
-    return connection;
-  }
 }
 
 module.exports = ProtocolSession;

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

@@ -90,7 +90,10 @@ class NetworkMonitor {
     this._frameNavigations = [];
     this._sessions = new Map();
     this._networkRecorder = new NetworkRecorder();
-    this._targetManager = new TargetManager(this._session);
+    /** @type {LH.Puppeteer.CDPSession} */
+    // @ts-expect-error - temporarily reach in to get CDPSession
+    const rootCdpSession = this._session._cdpSession;
+    this._targetManager = new TargetManager(rootCdpSession);
 
     /**
      * Reemit the same network recorder events.

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

@@ -11,21 +11,23 @@
   */
 
 const log = require('lighthouse-logger');
+const ProtocolSession = require('../../fraggle-rock/gather/session.js');
 
 /** @typedef {{target: LH.Crdp.Target.TargetInfo, session: LH.Gatherer.FRProtocolSession}} TargetWithSession */
 
 class TargetManager {
-  /** @param {LH.Gatherer.FRProtocolSession} session */
-  constructor(session) {
+  /** @param {LH.Puppeteer.CDPSession} cdpSession */
+  constructor(cdpSession) {
     this._enabled = false;
-    this._session = session;
+    this._rootCdpSession = cdpSession;
+
     /** @type {Array<(targetWithSession: TargetWithSession) => Promise<void>|void>} */
     this._listeners = [];
 
     this._onSessionAttached = this._onSessionAttached.bind(this);
 
     /** @type {Map<string, TargetWithSession>} */
-    this._targets = new Map();
+    this._targetIdToTargets = new Map();
 
     /** @param {LH.Crdp.Page.FrameNavigatedEvent} event */
     this._onFrameNavigated = async event => {
@@ -35,7 +37,7 @@ class TargetManager {
       // It's not entirely clear when this is necessary, but when the page switches processes on
       // navigating from about:blank to the `requestedUrl`, resetting `setAutoAttach` has been
       // necessary in the past.
-      await this._session.sendCommand('Target.setAutoAttach', {
+      await this._rootCdpSession.send('Target.setAutoAttach', {
         autoAttach: true,
         flatten: true,
         waitForDebuggerOnStart: true,
@@ -44,9 +46,11 @@ class TargetManager {
   }
 
   /**
-   * @param {LH.Gatherer.FRProtocolSession} session
+   * @param {LH.Puppeteer.CDPSession} cdpSession
    */
-  async _onSessionAttached(session) {
+  async _onSessionAttached(cdpSession) {
+    const session = new ProtocolSession(cdpSession);
+
     try {
       const target = await session.sendCommand('Target.getTargetInfo').catch(() => null);
       const targetType = target?.targetInfo?.type;
@@ -55,13 +59,13 @@ class TargetManager {
 
       const targetId = target.targetInfo.targetId;
       session.setTargetInfo(target.targetInfo);
-      if (this._targets.has(targetId)) return;
+      if (this._targetIdToTargets.has(targetId)) return;
 
       const targetName = target.targetInfo.url || target.targetInfo.targetId;
       log.verbose('target-manager', `target ${targetName} attached`);
 
       const targetWithSession = {target: target.targetInfo, session};
-      this._targets.set(targetId, targetWithSession);
+      this._targetIdToTargets.set(targetId, targetWithSession);
       for (const listener of this._listeners) await listener(targetWithSession);
 
       await session.sendCommand('Target.setAutoAttach', {
@@ -87,24 +91,32 @@ class TargetManager {
     if (this._enabled) return;
 
     this._enabled = true;
-    this._targets = new Map();
+    this._targetIdToTargets = new Map();
+
+    this._rootCdpSession.on('Page.frameNavigated', this._onFrameNavigated);
+
+    const rootConnection = this._rootCdpSession.connection();
+    if (!rootConnection) {
+      throw new Error('Connection has been closed.');
+    }
+    rootConnection.on('sessionattached', this._onSessionAttached);
 
-    this._session.on('Page.frameNavigated', this._onFrameNavigated);
-    this._session.addSessionAttachedListener(this._onSessionAttached);
+    await this._rootCdpSession.send('Page.enable');
 
-    await this._session.sendCommand('Page.enable');
-    await this._onSessionAttached(this._session);
+    // Start with the already attached root session.
+    await this._onSessionAttached(this._rootCdpSession);
   }
 
   /**
    * @return {Promise<void>}
    */
   async disable() {
-    this._session.off('Page.frameNavigated', this._onFrameNavigated);
-    this._session.removeSessionAttachedListener(this._onSessionAttached);
+    this._rootCdpSession.off('Page.frameNavigated', this._onFrameNavigated);
+    // No need to remove listener if connection is already closed.
+    this._rootCdpSession.connection()?.off('sessionattached', this._onSessionAttached);
 
     this._enabled = false;
-    this._targets = new Map();
+    this._targetIdToTargets = new Map();
   }
 
   /**

package/lighthouse-core/gather/driver.js

@@ -12,7 +12,7 @@ const {fetchResponseBodyFromCache} = require('../gather/driver/network.js');
 const EventEmitter = require('events').EventEmitter;
 
 const log = require('lighthouse-logger');
-const DevtoolsLog = require('./devtools-log.js');
+const DevtoolsMessageLog = require('./gatherers/devtools-log.js').DevtoolsMessageLog;
 const TraceGatherer = require('./gatherers/trace.js');
 
 // Pulled in for Connection type checking.
@@ -41,7 +41,7 @@ class Driver {
    * @private
    * Used to save network and lifecycle protocol traffic. Just Page and Network are needed.
    */
-  _devtoolsLog = new DevtoolsLog(/^(Page|Network)\./);
+  _devtoolsLog = new DevtoolsMessageLog(/^(Page|Network)\./);
 
   /**
    * @private
@@ -208,16 +208,6 @@ class Driver {
     // OOPIF handling in legacy driver is implicit.
   }
 
-  /** @param {(session: LH.Gatherer.FRProtocolSession) => void} callback */
-  addSessionAttachedListener(callback) { // eslint-disable-line no-unused-vars
-    // OOPIF handling in legacy driver is implicit.
-  }
-
-  /** @param {(session: LH.Gatherer.FRProtocolSession) => void} callback */
-  removeSessionAttachedListener(callback) { // eslint-disable-line no-unused-vars
-    // OOPIF handling in legacy driver is implicit.
-  }
-
   /**
    * Debounce enabling or disabling domains to prevent driver users from
    * stomping on each other. Maintains an internal count of the times a domain

package/lighthouse-core/gather/gatherers/devtools-log.js

@@ -12,7 +12,6 @@
  */
 
 const NetworkMonitor = require('../driver/network-monitor.js');
-const MessageLog = require('../devtools-log.js');
 const FRGatherer = require('../../fraggle-rock/gather/base-gatherer.js');
 
 class DevtoolsLog extends FRGatherer {
@@ -30,7 +29,7 @@ class DevtoolsLog extends FRGatherer {
     /** @type {NetworkMonitor|undefined} */
     this._networkMonitor = undefined;
 
-    this._messageLog = new MessageLog(/^(Page|Network|Target|Runtime)\./);
+    this._messageLog = new DevtoolsMessageLog(/^(Page|Network|Target|Runtime)\./);
 
     /** @param {LH.Protocol.RawEventMessage} e */
     this._onProtocolMessage = e => this._messageLog.record(e);
@@ -63,4 +62,59 @@ class DevtoolsLog extends FRGatherer {
   }
 }
 
+
+/**
+ * This class saves all protocol messages whose method match a particular
+ * regex filter. Used when saving assets for later analysis by another tool such as
+ * Webpagetest.
+ */
+class DevtoolsMessageLog {
+  /**
+   * @param {RegExp=} regexFilter
+   */
+  constructor(regexFilter) {
+    this._filter = regexFilter;
+
+    /** @type {LH.DevtoolsLog} */
+    this._messages = [];
+    this._isRecording = false;
+  }
+
+  /**
+   * @return {LH.DevtoolsLog}
+   */
+  get messages() {
+    return this._messages;
+  }
+
+  reset() {
+    this._messages = [];
+  }
+
+  beginRecording() {
+    this._isRecording = true;
+  }
+
+  endRecording() {
+    this._isRecording = false;
+  }
+
+  /**
+   * Records a message if method matches filter and recording has been started.
+   * @param {LH.Protocol.RawEventMessage} message
+   */
+  record(message) {
+    // We're not recording, skip the rest of the checks.
+    if (!this._isRecording) return;
+    // The event was likely an internal puppeteer method that uses Symbols.
+    if (typeof message.method !== 'string') return;
+    // The event didn't pass our filter, do not record it.
+    if (this._filter && !this._filter.test(message.method)) return;
+
+    // We passed all the checks, record the message.
+    this._messages.push(message);
+  }
+}
+
 module.exports = DevtoolsLog;
+module.exports.DevtoolsMessageLog = DevtoolsMessageLog;

package/package.json

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

package/tsconfig.json

@@ -30,6 +30,7 @@
     "third-party/snyk/snapshot.json",
     "lighthouse-core/audits/byte-efficiency/polyfill-graph-data.json",
     "shared/localization/locales/en-US.json",
+    "esm-utils.mjs",
   ],
   "exclude": [
     "lighthouse-core/test/audits/**/*.js",
@@ -46,11 +47,11 @@
     "lighthouse-core/test/config/config-test.js",
     "lighthouse-core/test/config/default-config-test.js",
     "lighthouse-core/test/create-test-trace.js",
-    "lighthouse-core/test/gather/devtools-log-test.js",
     "lighthouse-core/test/gather/driver/wait-for-condition-test.js",
     "lighthouse-core/test/gather/gatherers/accessibility-test.js",
     "lighthouse-core/test/gather/gatherers/cache-contents-test.js",
     "lighthouse-core/test/gather/gatherers/console-messages-test.js",
+    "lighthouse-core/test/gather/gatherers/devtools-log-test.js",
     "lighthouse-core/test/gather/gatherers/dobetterweb/optimized-images-test.js",
     "lighthouse-core/test/gather/gatherers/dobetterweb/password-inputs-with-prevented-paste-test.js",
     "lighthouse-core/test/gather/gatherers/dobetterweb/response-compression-test.js",

package/types/gatherer.d.ts

@@ -30,8 +30,6 @@ declare module Gatherer {
     once<TEvent extends keyof LH.CrdpEvents>(event: TEvent, callback: (...args: LH.CrdpEvents[TEvent]) => void): void;
     addProtocolMessageListener(callback: (payload: Protocol.RawEventMessage) => void): void
     removeProtocolMessageListener(callback: (payload: Protocol.RawEventMessage) => void): void
-    addSessionAttachedListener(callback: (session: FRProtocolSession) => void): void
-    removeSessionAttachedListener(callback: (session: FRProtocolSession) => void): void
     off<TEvent extends keyof LH.CrdpEvents>(event: TEvent, callback: (...args: LH.CrdpEvents[TEvent]) => void): void;
     sendCommand<TMethod extends keyof LH.CrdpCommands>(method: TMethod, ...params: LH.CrdpCommands[TMethod]['paramsType']): Promise<LH.CrdpCommands[TMethod]['returnType']>;
     dispose(): Promise<void>;

package/lighthouse-core/gather/devtools-log.js

@@ -1,61 +0,0 @@
-/**
- * @license Copyright 2017 The Lighthouse Authors. All Rights Reserved.
- * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
- * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
- */
-'use strict';
-
-/**
- * @fileoverview This class saves all protocol messages whose method match a particular
- *    regex filter. Used when saving assets for later analysis by another tool such as
- *    Webpagetest.
- */
-class DevtoolsLog {
-  /**
-   * @param {RegExp=} regexFilter
-   */
-  constructor(regexFilter) {
-    this._filter = regexFilter;
-
-    /** @type {LH.DevtoolsLog} */
-    this._messages = [];
-    this._isRecording = false;
-  }
-
-  /**
-   * @return {LH.DevtoolsLog}
-   */
-  get messages() {
-    return this._messages;
-  }
-
-  reset() {
-    this._messages = [];
-  }
-
-  beginRecording() {
-    this._isRecording = true;
-  }
-
-  endRecording() {
-    this._isRecording = false;
-  }
-
-  /**
-   * Records a message if method matches filter and recording has been started.
-   * @param {LH.Protocol.RawEventMessage} message
-   */
-  record(message) {
-    // We're not recording, skip the rest of the checks.
-    if (!this._isRecording) return;
-    // The event was likely an internal puppeteer method that uses Symbols.
-    if (typeof message.method !== 'string') return;
-    // The event didn't pass our filter, do not record it.
-    if (this._filter && !this._filter.test(message.method)) return;
-
-    // We passed all the checks, record the message.
-    this._messages.push(message);
-  }
-}
-
-module.exports = DevtoolsLog;