lighthouse 9.5.0-dev.20220621 → 9.5.0-dev.20220624

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.20220621",
+  "version": "9.5.0-dev.20220624",
   "description": "Automated auditing, performance metrics, and best practices for the web.",
   "main": "./lighthouse-core/index.js",
   "bin": {
@@ -132,7 +132,7 @@
     "archiver": "^3.0.0",
     "c8": "^7.4.0",
     "chalk": "^2.4.1",
-    "chrome-devtools-frontend": "1.0.922924",
+    "chrome-devtools-frontend": "1.0.1012379",
     "concurrently": "^6.4.0",
     "conventional-changelog-cli": "^2.1.1",
     "cpy": "^8.1.2",

package/third-party/devtools-tests/README.md

@@ -0,0 +1,14 @@
+# Devtools e2e Tests
+
+These tests are rolled into the Chromium DevTools Frontend codebase. They "belong" to the devtools frontend, but are truly defined in this Lighthouse repo.
+
+Run with `sh lighthouse-core/test/devtools-tests/test-locally.sh`.
+
+See `lighthouse-core/test/chromium-web-tests/README.md` for more.
+
+## Sync
+
+```sh
+rsync -ahvz --exclude='OWNERS' --exclude='BUILD.gn' ~/src/devtools/devtools-frontend/test/e2e/lighthouse/ third-party/devtools-tests/e2e/lighthouse/
+rsync -ahvz --exclude='OWNERS' --exclude='BUILD.gn' ~/src/devtools/devtools-frontend/test/e2e/resources/lighthouse/ third-party/devtools-tests/e2e/resources/lighthouse/
+```

package/third-party/devtools-tests/e2e/lighthouse/generate-report_test.ts

@@ -0,0 +1,29 @@
+// Copyright 2020 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+import {assert} from 'chai';
+
+import {goToResource} from '../../shared/helper.js';
+import {describe, it} from '../../shared/mocha-extensions.js';
+import {isGenerateReportButtonDisabled, navigateToLighthouseTab} from '../helpers/lighthouse-helpers.js';
+
+describe('The Lighthouse Tab', function() {
+  this.timeout(20_000);
+
+  it('shows a button to generate a new report', async () => {
+    await navigateToLighthouseTab('empty.html');
+
+    const disabled = await isGenerateReportButtonDisabled();
+    assert.isFalse(disabled, 'The Generate Report button should not be disabled');
+  });
+
+  // Broken on non-debug runs
+  it.skip('[crbug.com/1057948] shows generate report button even when navigating to an unreachable page', async () => {
+    await navigateToLighthouseTab('empty.html');
+
+    await goToResource('network/unreachable.rawresponse');
+    const disabled = await isGenerateReportButtonDisabled();
+    assert.isTrue(disabled, 'The Generate Report button should be disabled');
+  });
+});

package/third-party/devtools-tests/e2e/lighthouse/indexeddb-warning_test.ts

@@ -0,0 +1,29 @@
+// Copyright 2022 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+import {assert} from 'chai';
+
+import {waitFor} from '../../shared/helper.js';
+import {describe, it} from '../../shared/mocha-extensions.js';
+import {navigateToLighthouseTab} from '../helpers/lighthouse-helpers.js';
+
+describe('IndexedDB warning', function() {
+  this.timeout(20_000);
+
+  it('displays when important data may affect performance', async () => {
+    await navigateToLighthouseTab('empty.html');
+
+    let warningElem = await waitFor('.lighthouse-warning-text.hidden');
+    const warningText1 = await warningElem.evaluate(node => node.textContent?.trim());
+    assert.strictEqual(warningText1, '');
+
+    await navigateToLighthouseTab('lighthouse/lighthouse-storage.html');
+
+    warningElem = await waitFor('.lighthouse-warning-text:not(.hidden)');
+    const expected =
+        'There may be stored data affecting loading performance in this location: IndexedDB. Audit this page in an incognito window to prevent those resources from affecting your scores.';
+    const warningText2 = await warningElem.evaluate(node => node.textContent?.trim());
+    assert.strictEqual(warningText2, expected);
+  });
+});

package/third-party/devtools-tests/e2e/resources/lighthouse/lighthouse-storage.html

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<head>
+  <meta charset="UTF-8">
+  <script>
+    // Indexeddb
+    window.indexedDB.open("DataBase", 3);
+  </script>
+</head>
+<body>
+  hi
+</body>

package/third-party/download-content-shell/README.md

@@ -6,3 +6,4 @@ Some minor patches on top from the Lighthouse Authors:
 
 * deleting code we don't need
 * changing output path
+* --resolve-executable-path

package/third-party/download-content-shell/download-content-shell.js

@@ -34,7 +34,6 @@ function main() {
     console.log('Unable to download because of error:', error);
   }
 }
-main();
 
 function onUploadedCommitPosition(commitPosition) {
   const contentShellDirPath = path.resolve(CACHE_PATH, commitPosition, 'out', TARGET);
@@ -176,3 +175,9 @@ function getContentShellBinaryPath(dirPath) {
     return path.resolve(dirPath, 'Content Shell.app', 'Contents', 'MacOS', 'Content Shell');
   }
 }
+
+if (process.argv[2] === '--resolve-executable-path') {
+  console.log(getContentShellBinaryPath(process.argv[3]));
+} else {
+  main();
+}

package/types/gatherer.d.ts

@@ -28,8 +28,6 @@ declare module Gatherer {
     setNextProtocolTimeout(ms: number): void;
     on<TEvent extends keyof LH.CrdpEvents>(event: TEvent, callback: (...args: LH.CrdpEvents[TEvent]) => void): void;
     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
     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>;
@@ -41,6 +39,11 @@ declare module Gatherer {
     executionContext: ExecutionContext;
     fetcher: Fetcher;
     url: () => Promise<string>;
+    targetManager: {
+      rootSession(): FRProtocolSession;
+      on(event: 'protocolevent', callback: (payload: Protocol.RawEventMessage) => void): void
+      off(event: 'protocolevent', callback: (payload: Protocol.RawEventMessage) => void): void
+    };
   }
 
   /** The limited context interface shared between pre and post Fraggle Rock Lighthouse. */

package/types/protocol.d.ts

@@ -5,6 +5,23 @@
  */
 
 declare module Protocol {
+  /**
+   * An intermediate type, used to create a record of all possible Crdp raw event
+   * messages, keyed on method. e.g. {
+   *   'Domain.method1Name': {method: 'Domain.method1Name', params: EventPayload1},
+   *   'Domain.method2Name': {method: 'Domain.method2Name', params: EventPayload2},
+   * }
+   */
+  type RawEventMessageRecord = {
+    [K in keyof LH.CrdpEvents]: {
+      method: K,
+      // Drop [] for `undefined` (so a JS value is valid).
+      params: LH.CrdpEvents[K] extends [] ? undefined: LH.CrdpEvents[K][number]
+      // If sessionId is not set, it means the event was from the root target.
+      sessionId?: string;
+    };
+  }
+
   /**
    * Union of raw (over the wire) message format of all possible Crdp events,
    * of the form `{method: 'Domain.event', params: eventPayload}`.
@@ -36,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;
@@ -50,24 +67,16 @@ declare module Protocol {
     once<E extends keyof TEventRecord>(event: E, listener: (...args: TEventRecord[E]) => void): void;
 
     emit<E extends keyof TEventRecord>(event: E, ...request: TEventRecord[E]): void;
+
+    listenerCount<E extends keyof TEventRecord>(event: E): number;
   }
-}
 
-/**
- * An intermediate type, used to create a record of all possible Crdp raw event
- * messages, keyed on method. e.g. {
- *   'Domain.method1Name': {method: 'Domain.method1Name', params: EventPayload1},
- *   'Domain.method2Name': {method: 'Domain.method2Name', params: EventPayload2},
- * }
- */
-type RawEventMessageRecord = {
-  [K in keyof LH.CrdpEvents]: {
-    method: K,
-    // Drop [] for `undefined` (so a JS value is valid).
-    params: LH.CrdpEvents[K] extends [] ? undefined: LH.CrdpEvents[K][number]
-    // If sessionId is not set, it means the event was from the root target.
-    sessionId?: string;
-  };
+  /**
+   * A constructable StrictEventEmitter.
+   */
+  interface StrictEventEmitterClass<TEventRecord extends Record<keyof TEventRecord, unknown[]>> {
+    new(): StrictEventEmitter<TEventRecord>;
+  }
 }
 
 export default Protocol;