lighthouse 9.5.0-dev.20220605 → 9.5.0-dev.20220608

package/flow-report/tsconfig.json

@@ -1,8 +1,6 @@
 {
   "extends": "../tsconfig-base.json",
   "compilerOptions": {
-    "outDir": "../.tmp/tsbuildinfo/flow-report",
-
     // Limit to base JS and DOM defs.
     "lib": ["es2020", "dom", "dom.iterable"],
     // Selectively include types from node_modules/.

package/lighthouse-core/config/config.js

@@ -38,6 +38,7 @@ const BASE_ARTIFACT_BLANKS = {
   HostUserAgent: '',
   NetworkUserAgent: '',
   BenchmarkIndex: '',
+  BenchmarkIndexes: '',
   WebAppManifest: '',
   GatherContext: '',
   InstallabilityErrors: '',

package/lighthouse-core/fraggle-rock/config/filters.js

@@ -14,6 +14,7 @@ const baseArtifactKeySource = {
   fetchTime: '',
   LighthouseRunWarnings: '',
   BenchmarkIndex: '',
+  BenchmarkIndexes: '',
   settings: '',
   Timing: '',
   URL: '',

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

@@ -16,7 +16,7 @@ const throwNotConnectedFn = () => {
 };
 
 /** @type {LH.Gatherer.FRProtocolSession} */
-const defaultSession = {
+const throwingSession = {
   setTargetInfo: throwNotConnectedFn,
   hasNextProtocolTimeout: throwNotConnectedFn,
   getNextProtocolTimeout: throwNotConnectedFn,
@@ -39,14 +39,12 @@ class Driver {
    */
   constructor(page) {
     this._page = page;
-    /** @type {LH.Gatherer.FRProtocolSession|undefined} */
-    this._session = undefined;
     /** @type {ExecutionContext|undefined} */
     this._executionContext = undefined;
     /** @type {Fetcher|undefined} */
     this._fetcher = undefined;
 
-    this.defaultSession = defaultSession;
+    this.defaultSession = throwingSession;
   }
 
   /** @return {LH.Gatherer.FRTransitionalDriver['executionContext']} */
@@ -68,20 +66,20 @@ class Driver {
 
   /** @return {Promise<void>} */
   async connect() {
-    if (this._session) return;
+    if (this.defaultSession !== throwingSession) return;
     const status = {msg: 'Connecting to browser', id: 'lh:driver:connect'};
     log.time(status);
     const session = await this._page.target().createCDPSession();
-    this._session = this.defaultSession = new ProtocolSession(session);
-    this._executionContext = new ExecutionContext(this._session);
-    this._fetcher = new Fetcher(this._session);
+    this.defaultSession = new ProtocolSession(session);
+    this._executionContext = new ExecutionContext(this.defaultSession);
+    this._fetcher = new Fetcher(this.defaultSession);
     log.timeEnd(status);
   }
 
   /** @return {Promise<void>} */
   async disconnect() {
-    if (!this._session) return;
-    await this._session.dispose();
+    if (this.defaultSession === throwingSession) return;
+    await this.defaultSession.dispose();
   }
 }
 

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

@@ -6,7 +6,6 @@
 'use strict';
 
 const LHError = require('../../lib/lh-error.js');
-const SessionEmitMonkeypatch = Symbol('monkeypatch');
 
 // Controls how long to wait for a response after sending a DevTools protocol command.
 const DEFAULT_PROTOCOL_TIMEOUT = 30000;
@@ -14,32 +13,22 @@ const DEFAULT_PROTOCOL_TIMEOUT = 30000;
 /** @implements {LH.Gatherer.FRProtocolSession} */
 class ProtocolSession {
   /**
-   * @param {LH.Puppeteer.CDPSession} session
+   * @param {LH.Puppeteer.CDPSession} cdpSession
    */
-  constructor(session) {
-    this._session = session;
+  constructor(cdpSession) {
+    this._cdpSession = cdpSession;
     /** @type {LH.Crdp.Target.TargetInfo|undefined} */
     this._targetInfo = undefined;
     /** @type {number|undefined} */
     this._nextProtocolTimeout = undefined;
     /** @type {WeakMap<any, any>} */
     this._callbackMap = new WeakMap();
+  }
 
-    // FIXME: Monkeypatch puppeteer to be able to listen to *all* protocol events.
-    // This patched method will now emit a copy of every event on `*`.
-    const originalEmit = session.emit;
-    // @ts-expect-error - Test for the monkeypatch.
-    if (originalEmit[SessionEmitMonkeypatch]) return;
-    session.emit = (method, ...args) => {
-      // OOPIF sessions need to emit their sessionId so downstream processors can recognize
-      // the target the event came from.
-      const sessionId = this._targetInfo && this._targetInfo.type === 'iframe' ?
-        this._targetInfo.targetId : undefined;
-      originalEmit.call(session, '*', {method, params: args[0], sessionId});
-      return originalEmit.call(session, method, ...args);
-    };
-    // @ts-expect-error - It's monkeypatching 🤷‍♂️.
-    session.emit[SessionEmitMonkeypatch] = true;
+  sessionId() {
+    return this._targetInfo && this._targetInfo.type === 'iframe' ?
+      this._targetInfo.targetId :
+      undefined;
   }
 
   /** @param {LH.Crdp.Target.TargetInfo} targetInfo */
@@ -75,7 +64,7 @@ class ProtocolSession {
    * @param {(...args: LH.CrdpEvents[E]) => void} callback
    */
   on(eventName, callback) {
-    this._session.on(eventName, /** @type {*} */ (callback));
+    this._cdpSession.on(eventName, /** @type {*} */ (callback));
   }
 
   /**
@@ -85,7 +74,7 @@ class ProtocolSession {
    * @param {(...args: LH.CrdpEvents[E]) => void} callback
    */
   once(eventName, callback) {
-    this._session.once(eventName, /** @type {*} */ (callback));
+    this._cdpSession.once(eventName, /** @type {*} */ (callback));
   }
 
   /**
@@ -110,19 +99,31 @@ class ProtocolSession {
   }
 
   /**
-   * Bind to our custom event that fires for *any* protocol event.
+   * 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.
    * @param {(payload: LH.Protocol.RawEventMessage) => void} callback
    */
   addProtocolMessageListener(callback) {
-    this._session.on('*', /** @type {*} */ (callback));
+    /**
+     * @param {any} method
+     * @param {any} event
+     */
+    const listener = (method, event) => callback({
+      method,
+      params: event,
+      sessionId: this.sessionId(),
+    });
+    this._callbackMap.set(callback, listener);
+    this._cdpSession.on('*', /** @type {*} */ (listener));
   }
 
   /**
-   * Unbind to our custom event that fires for *any* protocol event.
    * @param {(payload: LH.Protocol.RawEventMessage) => void} callback
    */
   removeProtocolMessageListener(callback) {
-    this._session.off('*', /** @type {*} */ (callback));
+    const listener = this._callbackMap.get(callback);
+    if (!listener) return;
+    this._cdpSession.off('*', /** @type {*} */ (listener));
   }
 
   /**
@@ -132,7 +133,7 @@ class ProtocolSession {
    * @param {(...args: LH.CrdpEvents[E]) => void} callback
    */
   off(eventName, callback) {
-    this._session.off(eventName, /** @type {*} */ (callback));
+    this._cdpSession.off(eventName, /** @type {*} */ (callback));
   }
 
   /**
@@ -155,7 +156,7 @@ class ProtocolSession {
       }));
     });
 
-    const resultPromise = this._session.send(method, ...params);
+    const resultPromise = this._cdpSession.send(method, ...params);
     const resultWithTimeoutPromise = Promise.race([resultPromise, timeoutPromise]);
 
     return resultWithTimeoutPromise.finally(() => {
@@ -168,12 +169,12 @@ class ProtocolSession {
    * @return {Promise<void>}
    */
   async dispose() {
-    this._session.removeAllListeners();
-    await this._session.detach();
+    this._cdpSession.removeAllListeners();
+    await this._cdpSession.detach();
   }
 
   _getConnection() {
-    const connection = this._session.connection();
+    const connection = this._cdpSession.connection();
     if (!connection) throw new Error('Connection has been closed.');
     return connection;
   }

package/lighthouse-core/gather/connections/cri.js

@@ -82,7 +82,8 @@ class CriConnection extends Connection {
    */
   _runJsonCommand(command) {
     return new Promise((resolve, reject) => {
-      const request = http.get({
+      const request = http.request({
+        method: 'PUT', // GET and POST are deprecated: https://crrev.com/c/3595822
         hostname: this.hostname,
         port: this.port,
         path: '/json/' + command,
@@ -109,6 +110,8 @@ class CriConnection extends Connection {
         });
       });
 
+      request.end();
+
       // This error handler is critical to ensuring Lighthouse exits cleanly even when Chrome crashes.
       // See https://github.com/GoogleChrome/lighthouse/pull/8583.
       request.on('error', reject);

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

@@ -103,13 +103,20 @@ class NetworkMonitor {
     };
 
     this._networkRecorder.on('requeststarted', reEmit('requeststarted'));
-    this._networkRecorder.on('requestloaded', reEmit('requestloaded'));
+    this._networkRecorder.on('requestfinished', reEmit('requestfinished'));
 
     this._session.on('Page.frameNavigated', this._onFrameNavigated);
-    this._targetManager.addTargetAttachedListener(this._onTargetAttached);
-
     await this._session.sendCommand('Page.enable');
-    await this._targetManager.enable();
+
+    // Legacy driver does its own target management.
+    // @ts-expect-error
+    const isLegacyRunner = Boolean(this._session._domainEnabledCounts);
+    if (isLegacyRunner) {
+      this._session.addProtocolMessageListener(this._onProtocolMessage);
+    } else {
+      this._targetManager.addTargetAttachedListener(this._onTargetAttached);
+      await this._targetManager.enable();
+    }
   }
 
   /**
@@ -119,13 +126,21 @@ class NetworkMonitor {
     if (!this._targetManager) return;
 
     this._session.off('Page.frameNavigated', this._onFrameNavigated);
-    this._targetManager.removeTargetAttachedListener(this._onTargetAttached);
 
-    for (const session of this._sessions.values()) {
-      session.removeProtocolMessageListener(this._onProtocolMessage);
-    }
+    // Legacy driver does its own target management.
+    // @ts-expect-error
+    const isLegacyRunner = Boolean(this._session._domainEnabledCounts);
+    if (isLegacyRunner) {
+      this._session.removeProtocolMessageListener(this._onProtocolMessage);
+    } else {
+      this._targetManager.removeTargetAttachedListener(this._onTargetAttached);
 
-    await this._targetManager.disable();
+      for (const session of this._sessions.values()) {
+        session.removeProtocolMessageListener(this._onProtocolMessage);
+      }
+
+      await this._targetManager.disable();
+    }
 
     this._frameNavigations = [];
     this._networkRecorder = undefined;

package/lighthouse-core/gather/driver/wait-for-condition.js

@@ -164,7 +164,8 @@ function waitForNetworkIdle(session, networkMonitor, networkQuietOptions) {
       const inflightRecords = networkMonitor.getInflightRequests();
       // If there are more than 20 inflight requests, load is still in full swing.
       // Wait until it calms down a bit to be a little less spammy.
-      if (inflightRecords.length < 20) {
+      if (log.isVerbose() && inflightRecords.length < 20 && inflightRecords.length > 0) {
+        log.verbose('waitFor', `=== Waiting on ${inflightRecords.length} requests to finish`);
         for (const record of inflightRecords) {
           log.verbose('waitFor', `Waiting on ${record.url.slice(0, 120)} to finish`);
         }
@@ -172,7 +173,7 @@ function waitForNetworkIdle(session, networkMonitor, networkQuietOptions) {
     };
 
     networkMonitor.on('requeststarted', logStatus);
-    networkMonitor.on('requestloaded', logStatus);
+    networkMonitor.on('requestfinished', logStatus);
     networkMonitor.on(busyEvent, logStatus);
 
     if (!networkQuietOptions.pretendDCLAlreadyFired) {
@@ -192,7 +193,7 @@ function waitForNetworkIdle(session, networkMonitor, networkQuietOptions) {
       networkMonitor.removeListener(busyEvent, onBusy);
       networkMonitor.removeListener(idleEvent, onIdle);
       networkMonitor.removeListener('requeststarted', logStatus);
-      networkMonitor.removeListener('requestloaded', logStatus);
+      networkMonitor.removeListener('requestfinished', logStatus);
       networkMonitor.removeListener(busyEvent, logStatus);
     };
   });

package/lighthouse-core/gather/gather-runner.js

@@ -20,6 +20,7 @@ const WebAppManifest = require('./gatherers/web-app-manifest.js');
 const InstallabilityErrors = require('./gatherers/installability-errors.js');
 const NetworkUserAgent = require('./gatherers/network-user-agent.js');
 const Stacks = require('./gatherers/stacks.js');
+const URL = require('../lib/url-shim.js');
 const {finalizeArtifacts} = require('../fraggle-rock/gather/base-artifacts.js');
 
 /** @typedef {import('../gather/driver.js')} Driver */
@@ -491,6 +492,20 @@ class GatherRunner {
       const baseArtifacts = await GatherRunner.initializeBaseArtifacts(options);
       baseArtifacts.BenchmarkIndex = await getBenchmarkIndex(driver.executionContext);
 
+      // Hack for running benchmarkIndex extra times.
+      // Add a `bidx=20` query param, eg: https://www.example.com/?bidx=50
+      const parsedUrl = URL.isValid(options.requestedUrl) && new URL(options.requestedUrl);
+      if (options.settings.channel === 'lr' && parsedUrl && parsedUrl.searchParams.has('bidx')) {
+        const bidxRunCount = parsedUrl.searchParams.get('bidx') || 0;
+        // Add the first bidx into the new set
+        const indexes = [baseArtifacts.BenchmarkIndex];
+        for (let i = 0; i < bidxRunCount; i++) {
+          const bidx = await getBenchmarkIndex(driver.executionContext);
+          indexes.push(bidx);
+        }
+        baseArtifacts.BenchmarkIndexes = indexes;
+      }
+
       await GatherRunner.setupDriver(driver, options);
 
       let isFirstPass = true;

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

@@ -30,7 +30,7 @@ class DevtoolsLog extends FRGatherer {
     /** @type {NetworkMonitor|undefined} */
     this._networkMonitor = undefined;
 
-    this._messageLog = new MessageLog(/^(Page|Network)\./);
+    this._messageLog = new MessageLog(/^(Page|Network|Target|Runtime)\./);
 
     /** @param {LH.Protocol.RawEventMessage} e */
     this._onProtocolMessage = e => this._messageLog.record(e);

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

@@ -9,7 +9,7 @@ const log = require('lighthouse-logger');
 const NetworkRequest = require('./network-request.js');
 const EventEmitter = require('events').EventEmitter;
 
-/** @typedef {'requeststarted'|'requestloaded'} NetworkRecorderEvent */
+/** @typedef {'requeststarted'|'requestfinished'} NetworkRecorderEvent */
 
 class NetworkRecorder extends EventEmitter {
   /**
@@ -71,7 +71,7 @@ class NetworkRecorder extends EventEmitter {
    * @private
    */
   onRequestFinished(request) {
-    this.emit('requestloaded', request);
+    this.emit('requestfinished', request);
   }
 
   // The below methods proxy network data into the NetworkRequest object which mimics the

package/lighthouse-core/runner.js

@@ -95,6 +95,7 @@ class Runner {
           networkUserAgent: artifacts.NetworkUserAgent,
           hostUserAgent: artifacts.HostUserAgent,
           benchmarkIndex: artifacts.BenchmarkIndex,
+          benchmarkIndexes: artifacts.BenchmarkIndexes,
           credits,
         },
         audits: auditResultsById,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lighthouse",
-  "version": "9.5.0-dev.20220605",
+  "version": "9.5.0-dev.20220608",
   "description": "Automated auditing, performance metrics, and best practices for the web.",
   "main": "./lighthouse-core/index.js",
   "bin": {
@@ -125,8 +125,8 @@
     "@types/ws": "^7.0.0",
     "@types/yargs": "^17.0.8",
     "@types/yargs-parser": "^20.2.1",
-    "@typescript-eslint/eslint-plugin": "^5.6.0",
-    "@typescript-eslint/parser": "^5.6.0",
+    "@typescript-eslint/eslint-plugin": "^5.26.0",
+    "@typescript-eslint/parser": "^5.26.0",
     "acorn": "^8.5.0",
     "angular": "^1.7.4",
     "archiver": "^3.0.0",
@@ -175,7 +175,7 @@
     "terser": "^5.3.8",
     "ts-jest": "^27.0.4",
     "typed-query-selector": "^2.6.1",
-    "typescript": "^4.5.2",
+    "typescript": "^4.7.2",
     "wait-for-expect": "^3.0.2",
     "webtreemap-cdt": "^3.2.1"
   },

package/report/generator/tsconfig.json

@@ -1,8 +1,6 @@
 {
   "extends": "../../tsconfig-base.json",
   "compilerOptions": {
-    "outDir": "../../.tmp/tsbuildinfo/report/generator",
-
     // Limit defs to base JS and DOM (for URL: https://github.com/DefinitelyTyped/DefinitelyTyped/issues/34960).
     "lib": ["es2020", "dom"],
     // Only include `@types/node` from node_modules/.

package/report/renderer/swap-locale-feature.js

@@ -57,8 +57,8 @@ export class SwapLocaleFeature {
         const optionLocaleDisplay = new Intl.DisplayNames([locale], {type: 'language'});
 
         const optionLocaleName = optionLocaleDisplay.of(locale);
-        const currentLocaleName = currentLocaleDisplay.of(locale);
-        if (optionLocaleName !== currentLocaleName) {
+        const currentLocaleName = currentLocaleDisplay.of(locale) || locale;
+        if (optionLocaleName && optionLocaleName !== currentLocaleName) {
           optionEl.textContent = `${optionLocaleName} – ${currentLocaleName}`;
         } else {
           optionEl.textContent = currentLocaleName;

package/report/tsconfig.json

@@ -1,8 +1,6 @@
 {
   "extends": "../tsconfig-base.json",
   "compilerOptions": {
-    "outDir": "../.tmp/tsbuildinfo/report",
-
     // Limit to base JS and DOM defs.
     "lib": ["es2020", "dom", "dom.iterable"],
     // Don't include any types from node_modules/.

package/shared/tsconfig.json

@@ -1,8 +1,6 @@
 {
   "extends": "../tsconfig-base.json",
   "compilerOptions": {
-    "outDir": "../../.tmp/tsbuildinfo/shared/",
-
     // Limit defs to base JS.
     "lib": ["es2020"],
     // Only include `@types/node` from node_modules/.

package/tsconfig-base.json

@@ -3,8 +3,13 @@
 {
   "compilerOptions": {
     "composite": true,
+
+    // Set up incremental builds. All sub-projects emit under outDir, maintaining
+    // directory structure relative to rootDir. No effect on include, exclude, etc.
     "emitDeclarationOnly": true,
     "declarationMap": true,
+    "outDir": ".tmp/tsbuildinfo/",
+    "rootDir": ".",
 
     "target": "es2020",
     "module": "es2020",

package/tsconfig.json

@@ -1,8 +1,6 @@
 {
   "extends": "./tsconfig-base.json",
   "compilerOptions": {
-    "outDir": ".tmp/tsbuildinfo/",
-
     // TODO(esmodules): included to support require('file.json'). Remove on the switch to ES Modules.
     "resolveJsonModule": true,
   },

package/types/artifacts.d.ts

@@ -49,6 +49,8 @@ interface UniversalBaseArtifacts {
   LighthouseRunWarnings: Array<string | IcuMessage>;
   /** The benchmark index that indicates rough device class. */
   BenchmarkIndex: number;
+  /** Many benchmark indexes. Many. */
+  BenchmarkIndexes?: number[];
   /** An object containing information about the testing configuration used by Lighthouse. */
   settings: Config.Settings;
   /** The timing instrumentation of the gather portion of a run. */

package/types/lhr/lhr.d.ts

@@ -59,6 +59,8 @@ declare module Result {
     networkUserAgent: string;
     /** The benchmark index number that indicates rough device class. */
     benchmarkIndex: number;
+    /** Many benchmark indexes. */
+    benchmarkIndexes?: number[];
     /** The version of libraries with which these results were generated. Ex: axe-core. */
     credits?: Record<string, string|undefined>,
   }

package/types/lhr/tsconfig.json

@@ -1,8 +1,6 @@
 {
   "extends": "../../tsconfig-base.json",
   "compilerOptions": {
-    "outDir": "../../.tmp/tsbuildinfo/types/lhr",
-
     // We only need the base JS definitions, no DOM, etc.
     "lib": ["esnext"],
     // Don't include any types from node_modules/.

package/types/lighthouse-logger/index.d.ts

@@ -11,6 +11,7 @@ declare module 'lighthouse-logger' {
     args?: any[];
   }
   export function setLevel(level: string): void;
+  export function isVerbose(): boolean;
   export function formatProtocol(prefix: string, data: Object, level?: string): void;
   export function log(title: string, ...args: any[]): void;
   export function warn(title: string, ...args: any[]): void;