lighthouse 9.5.0-dev.20220704 → 9.5.0-dev.20220707

package/.gitattributes

@@ -1,2 +1,3 @@
 *.js eol=lf
-**/locales/*.json linguist-generated=true
+**/locales/*.json linguist-generated=true
+build/** linguist-generated=false

package/lighthouse-cli/test/smokehouse/frontends/smokehouse-bin.js

@@ -135,10 +135,10 @@ async function begin() {
         default: false,
         describe: 'Save test artifacts and output verbose logs',
       },
-      'fraggle-rock': {
+      'legacy-navigation': {
         type: 'boolean',
         default: false,
-        describe: 'Use the new Fraggle Rock runner',
+        describe: 'Use the legacy navigation runner',
       },
       'jobs': {
         type: 'number',
@@ -216,7 +216,7 @@ async function begin() {
       jobs,
       retries,
       isDebug: argv.debug,
-      useFraggleRock: argv.fraggleRock,
+      useLegacyNavigation: argv.legacyNavigation,
       lighthouseRunner: runLighthouse,
       takeNetworkRequestUrls,
     };

package/lighthouse-cli/test/smokehouse/lighthouse-runners/bundle.js

@@ -47,7 +47,7 @@ if (!isMainThread && parentPort) {
 /**
  * @param {string} url
  * @param {LH.Config.Json|undefined} configJson
- * @param {{isDebug?: boolean, useFraggleRock?: boolean}} testRunnerOptions
+ * @param {{isDebug?: boolean, useLegacyNavigation?: boolean}} testRunnerOptions
  * @return {Promise<{lhr: LH.Result, artifacts: LH.Artifacts}>}
  */
 async function runBundledLighthouse(url, configJson, testRunnerOptions) {
@@ -80,15 +80,15 @@ async function runBundledLighthouse(url, configJson, testRunnerOptions) {
   try {
     const logLevel = testRunnerOptions.isDebug ? 'info' : undefined;
     let runnerResult;
-    if (testRunnerOptions.useFraggleRock) {
+    if (testRunnerOptions.useLegacyNavigation) {
+      const connection = new ChromeProtocol(port);
+      runnerResult =
+        await lighthouse.legacyNavigation(url, {port, logLevel}, configJson, connection);
+    } else {
       // Puppeteer is not included in the bundle, we must create the page here.
       const browser = await puppeteer.connect({browserURL: `http://localhost:${port}`});
       const page = await browser.newPage();
       runnerResult = await lighthouse(url, {port, logLevel}, configJson, page);
-    } else {
-      const connection = new ChromeProtocol(port);
-      runnerResult =
-        await lighthouse.legacyNavigation(url, {port, logLevel}, configJson, connection);
     }
     if (!runnerResult) throw new Error('No runnerResult');
 
@@ -106,7 +106,7 @@ async function runBundledLighthouse(url, configJson, testRunnerOptions) {
  * Launch Chrome and do a full Lighthouse run via the Lighthouse DevTools bundle.
  * @param {string} url
  * @param {LH.Config.Json=} configJson
- * @param {{isDebug?: boolean, useFraggleRock?: boolean}=} testRunnerOptions
+ * @param {{isDebug?: boolean, useLegacyNavigation?: boolean}=} testRunnerOptions
  * @return {Promise<{lhr: LH.Result, artifacts: LH.Artifacts, log: string}>}
  */
 async function runLighthouse(url, configJson, testRunnerOptions = {}) {

package/lighthouse-cli/test/smokehouse/lighthouse-runners/cli.js

@@ -41,30 +41,16 @@ async function runLighthouse(url, configJson, testRunnerOptions = {}) {
     .finally(() => !isDebug && fs.rm(tmpPath, {recursive: true, force: true}));
 }
 
-/**
- * @param {LH.Config.Json=} configJson
- * @return {LH.Config.Json|undefined}
- */
-function convertToFraggleRockConfig(configJson) {
-  if (!configJson) return configJson;
-  if (!configJson.passes) return configJson;
-
-  return {
-    ...configJson,
-    navigations: configJson.passes.map(pass => ({...pass, id: pass.passName})),
-  };
-}
-
 /**
  * Internal runner.
  * @param {string} url
  * @param {string} tmpPath
  * @param {LH.Config.Json=} configJson
- * @param {{isDebug?: boolean, useFraggleRock?: boolean}=} options
+ * @param {{isDebug?: boolean, useLegacyNavigation?: boolean}=} options
  * @return {Promise<{lhr: LH.Result, artifacts: LH.Artifacts, log: string}>}
  */
 async function internalRun(url, tmpPath, configJson, options) {
-  const {isDebug = false, useFraggleRock = false} = options || {};
+  const {isDebug = false, useLegacyNavigation = false} = options || {};
   const localConsole = new LocalConsole();
 
   const outputPath = `${tmpPath}/smokehouse.report.json`;
@@ -81,9 +67,7 @@ async function internalRun(url, tmpPath, configJson, options) {
     '--quiet',
   ];
 
-  if (useFraggleRock) {
-    configJson = convertToFraggleRockConfig(configJson);
-  } else {
+  if (useLegacyNavigation) {
     args.push('--legacy-navigation');
   }
 

package/lighthouse-cli/test/smokehouse/lighthouse-runners/devtools.js

@@ -21,10 +21,10 @@ const devtoolsDir =
  * @param {string[]} logs
  * @param {string} command
  * @param {string[]} args
+ * @return {Promise<boolean>} true if command exited successfully.
  */
-async function spawnAndLog(logs, command, args) {
-  /** @type {Promise<void>} */
-  const promise = new Promise((resolve) => {
+function spawnAndLog(logs, command, args) {
+  return new Promise((resolve) => {
     const spawnHandle = spawn(command, args);
     spawnHandle.on('close', code => {
       if (code) {
@@ -32,7 +32,7 @@ async function spawnAndLog(logs, command, args) {
       } else {
         logs.push('[SUCCESS] Command exited with code: 0\n');
       }
-      resolve();
+      resolve(code === 0);
     });
     spawnHandle.on('error', (error) => {
       logs.push(`ERROR: ${error.toString()}`);
@@ -48,21 +48,22 @@ async function spawnAndLog(logs, command, args) {
       logs.push(`STDERR: ${data}`);
     });
   });
-  await promise;
 }
 
-/** @type {Promise<void>} */
+/** @type {Promise<boolean>} */
 let buildDevtoolsPromise;
 /**
- * @param {string[]} logs
  * Download/pull latest DevTools, build Lighthouse for DevTools, roll to DevTools, and build DevTools.
+ * @param {string[]} logs
  */
 async function buildDevtools(logs) {
-  if (process.env.CI) return;
+  if (process.env.CI) return true;
 
   process.env.DEVTOOLS_PATH = devtoolsDir;
-  await spawnAndLog(logs, 'bash', ['lighthouse-core/test/chromium-web-tests/download-devtools.sh']);
-  await spawnAndLog(logs, 'bash', ['lighthouse-core/test/chromium-web-tests/roll-devtools.sh']);
+  const success =
+    await spawnAndLog(logs, 'bash', ['lighthouse-core/test/devtools-tests/download-devtools.sh']) &&
+    await spawnAndLog(logs, 'bash', ['lighthouse-core/test/devtools-tests/roll-devtools.sh']);
+  return success;
 }
 
 /**
@@ -80,7 +81,10 @@ async function runLighthouse(url, configJson, testRunnerOptions = {}) {
   const logs = [];
 
   if (!buildDevtoolsPromise) buildDevtoolsPromise = buildDevtools(logs);
-  await buildDevtoolsPromise;
+  if (!await buildDevtoolsPromise) {
+    const log = logs.join('') + '\n';
+    throw new Error(`failed to build devtools:\n${log}`);
+  }
 
   const outputDir = fs.mkdtempSync(os.tmpdir() + '/lh-smoke-cdt-runner-');
   const chromeFlags = [

package/lighthouse-cli/test/smokehouse/report-assert.js

@@ -217,10 +217,10 @@ function makeComparison(name, actualResult, expectedResult) {
  * @param {LocalConsole} localConsole
  * @param {LH.Result} lhr
  * @param {Smokehouse.ExpectedRunnerResult} expected
- * @param {{runner?: string, isBundled?: boolean, useFraggleRock?: boolean}=} reportOptions
+ * @param {{runner?: string, isBundled?: boolean, useLegacyNavigation?: boolean}=} reportOptions
  */
 function pruneExpectations(localConsole, lhr, expected, reportOptions) {
-  const isFraggleRock = reportOptions?.useFraggleRock;
+  const isLegacyNavigation = reportOptions?.useLegacyNavigation;
   const isBundled = reportOptions?.isBundled;
 
   /**
@@ -276,13 +276,13 @@ function pruneExpectations(localConsole, lhr, expected, reportOptions) {
           `Actual Chromium version: ${getChromeVersionString()}`,
         ].join(' '));
         remove(key);
-      } else if (value._legacyOnly && isFraggleRock) {
+      } else if (value._legacyOnly && !isLegacyNavigation) {
         localConsole.log([
           `[${key}] marked legacy only but run is Fraggle Rock, pruning expectation:`,
           JSON.stringify(value, null, 2),
         ].join(' '));
         remove(key);
-      } else if (value._fraggleRockOnly && !isFraggleRock) {
+      } else if (value._fraggleRockOnly && isLegacyNavigation) {
         localConsole.log([
           `[${key}] marked Fraggle Rock only but run is legacy, pruning expectation:`,
           JSON.stringify(value, null, 2),
@@ -459,7 +459,7 @@ function reportAssertion(localConsole, assertion) {
  * summary. Returns count of passed and failed tests.
  * @param {{lhr: LH.Result, artifacts: LH.Artifacts, networkRequests?: string[]}} actual
  * @param {Smokehouse.ExpectedRunnerResult} expected
- * @param {{runner?: string, isDebug?: boolean, isBundled?: boolean, useFraggleRock?: boolean}=} reportOptions
+ * @param {{runner?: string, isDebug?: boolean, isBundled?: boolean, useLegacyNavigation?: boolean}=} reportOptions
  * @return {{passed: number, failed: number, log: string}}
  */
 function getAssertionReport(actual, expected, reportOptions = {}) {

package/lighthouse-cli/test/smokehouse/smokehouse.js

@@ -53,7 +53,7 @@ const DEFAULT_RETRIES = 0;
 async function runSmokehouse(smokeTestDefns, smokehouseOptions) {
   const {
     isDebug,
-    useFraggleRock,
+    useLegacyNavigation,
     jobs = DEFAULT_CONCURRENT_RUNS,
     retries = DEFAULT_RETRIES,
     lighthouseRunner = Object.assign(cliLighthouseRunner, {runnerName: 'cli'}),
@@ -65,7 +65,13 @@ async function runSmokehouse(smokeTestDefns, smokehouseOptions) {
   // Run each testDefn in parallel based on the concurrencyLimit.
   const concurrentMapper = new ConcurrentMapper();
 
-  const testOptions = {isDebug, useFraggleRock, retries, lighthouseRunner, takeNetworkRequestUrls};
+  const testOptions = {
+    isDebug,
+    useLegacyNavigation,
+    retries,
+    lighthouseRunner,
+    takeNetworkRequestUrls,
+  };
   const smokePromises = smokeTestDefns.map(testDefn => {
     // If defn is set to `runSerially`, we'll run it in succession with other tests, not parallel.
     const concurrency = testDefn.runSerially ? 1 : jobs;
@@ -118,15 +124,35 @@ function purpleify(str) {
   return `${log.purple}${str}${log.reset}`;
 }
 
+/**
+ * @param {LH.Config.Json=} configJson
+ * @return {LH.Config.Json|undefined}
+ */
+function convertToLegacyConfig(configJson) {
+  if (!configJson) return configJson;
+  if (!configJson.navigations) return configJson;
+
+  return {
+    ...configJson,
+    passes: configJson.navigations.map(nav => ({...nav, passName: nav.id.concat('Pass')})),
+  };
+}
+
 /**
  * Run Lighthouse in the selected runner.
  * @param {Smokehouse.TestDfn} smokeTestDefn
- * @param {{isDebug?: boolean, useFraggleRock?: boolean, retries: number, lighthouseRunner: Smokehouse.LighthouseRunner, takeNetworkRequestUrls?: () => string[]}} testOptions
+ * @param {{isDebug?: boolean, useLegacyNavigation?: boolean, retries: number, lighthouseRunner: Smokehouse.LighthouseRunner, takeNetworkRequestUrls?: () => string[]}} testOptions
  * @return {Promise<SmokehouseResult>}
  */
 async function runSmokeTest(smokeTestDefn, testOptions) {
-  const {id, config: configJson, expectations} = smokeTestDefn;
-  const {lighthouseRunner, retries, isDebug, useFraggleRock, takeNetworkRequestUrls} = testOptions;
+  const {id, expectations} = smokeTestDefn;
+  const {
+    lighthouseRunner,
+    retries,
+    isDebug,
+    useLegacyNavigation,
+    takeNetworkRequestUrls,
+  } = testOptions;
   const requestedUrl = expectations.lhr.requestedUrl;
 
   console.log(`${purpleify(id)} smoketest starting…`);
@@ -143,10 +169,15 @@ async function runSmokeTest(smokeTestDefn, testOptions) {
       bufferedConsole.log(`  Retrying run (${i} out of ${retries} retries)…`);
     }
 
+    let configJson = smokeTestDefn.config;
+    if (useLegacyNavigation) {
+      configJson = convertToLegacyConfig(configJson);
+    }
+
     // Run Lighthouse.
     try {
       result = {
-        ...await lighthouseRunner(requestedUrl, configJson, {isDebug, useFraggleRock}),
+        ...await lighthouseRunner(requestedUrl, configJson, {isDebug, useLegacyNavigation}),
         networkRequests: takeNetworkRequestUrls ? takeNetworkRequestUrls() : undefined,
       };
     } catch (e) {
@@ -161,7 +192,7 @@ async function runSmokeTest(smokeTestDefn, testOptions) {
     report = getAssertionReport(result, expectations, {
       runner: lighthouseRunner.runnerName,
       isDebug,
-      useFraggleRock,
+      useLegacyNavigation,
     });
 
     runs.push({

package/lighthouse-core/gather/driver.js

@@ -41,7 +41,7 @@ class Driver {
    * @private
    * Used to save network and lifecycle protocol traffic. Just Page and Network are needed.
    */
-  _devtoolsLog = new DevtoolsMessageLog(/^(Page|Network)\./);
+  _devtoolsLog = new DevtoolsMessageLog(/^(Page|Network|Target|Runtime)\./);
 
   /**
    * @private

package/lighthouse-core/lib/lantern-trace-saver.js

@@ -154,7 +154,7 @@ function convertNodeTimingsToTrace(nodeTimings) {
       ...requestData,
       decodedBodyLength: record.resourceSize,
       didFail: !!record.failed,
-      finishTime: endTime,
+      finishTime: toMicroseconds(endTime) / (1000 * 1000),
     };
 
     /** @type {LH.TraceEvent[]} */

package/lighthouse-core/scripts/download-chrome.sh

@@ -32,5 +32,5 @@ fi
 if [ -e "$CHROME_PATH" ]; then
   echo "cached chrome found"
 else
-  wget "$url" --no-check-certificate -q -O chrome.zip && unzip -q chrome.zip
+  curl "$url" -Lo chrome.zip && unzip -q chrome.zip
 fi

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lighthouse",
-  "version": "9.5.0-dev.20220704",
+  "version": "9.5.0-dev.20220707",
   "description": "Automated auditing, performance metrics, and best practices for the web.",
   "main": "./lighthouse-core/index.js",
   "bin": {
@@ -76,8 +76,7 @@
     "update:sample-artifacts": "node lighthouse-core/scripts/update-report-fixtures.js",
     "update:sample-json": "yarn i18n:collect-strings && node ./lighthouse-cli -A=./lighthouse-core/test/results/artifacts --config-path=./lighthouse-core/test/results/sample-config.js --output=json --output-path=./lighthouse-core/test/results/sample_v2.json && node lighthouse-core/scripts/cleanup-LHR-for-diff.js ./lighthouse-core/test/results/sample_v2.json --only-remove-timing && node ./lighthouse-core/scripts/update-flow-fixtures.js",
     "update:flow-sample-json": "yarn i18n:collect-strings && node ./lighthouse-core/scripts/update-flow-fixtures.js",
-    "update:test-devtools": "bash lighthouse-core/test/chromium-web-tests/test-locally.sh --reset-results",
-    "test-devtools": "bash lighthouse-core/test/chromium-web-tests/test-locally.sh",
+    "test-devtools": "bash lighthouse-core/test/devtools-tests/test-locally.sh",
     "open-devtools": "bash lighthouse-core/scripts/open-devtools.sh",
     "run-devtools": "node lighthouse-core/scripts/pptr-run-devtools.js",
     "diff:sample-json": "yarn i18n:checks && bash lighthouse-core/scripts/assert-golden-lhr-unchanged.sh",

package/readme.md

@@ -246,7 +246,6 @@ Useful documentation, examples, and recipes to get you started.
 
 **Recipes**
 
-- [gulp](docs/recipes/gulp) - helpful for CI integration
 - [Plugin](./docs/recipes/lighthouse-plugin-example) - example Lighthouse plugin
 - [Custom Audit example](./docs/recipes/custom-audit) - extend Lighthouse, run your own audits
 

package/tsconfig.json

@@ -39,7 +39,6 @@
     "clients/test/**/*.js",
     "lighthouse-cli/test/fixtures/**/*.js",
     "lighthouse-core/scripts/legacy-javascript/variants",
-    "lighthouse-core/test/chromium-web-tests/webtests",
     // These test files require further changes before they can be type checked.
     "lighthouse-core/test/config/budget-test.js",
     "lighthouse-core/test/config/config-helpers-test.js",

package/types/smokehouse.d.ts

@@ -52,13 +52,13 @@ declare global {
       {expectations: Smokehouse.ExpectedRunnerResult | Array<Smokehouse.ExpectedRunnerResult>}
 
     export type LighthouseRunner =
-      {runnerName?: string} & ((url: string, configJson?: Config.Json, runnerOptions?: {isDebug?: boolean; useFraggleRock?: boolean}) => Promise<{lhr: LHResult, artifacts: Artifacts, log: string}>);
+      {runnerName?: string} & ((url: string, configJson?: Config.Json, runnerOptions?: {isDebug?: boolean; useLegacyNavigation?: boolean}) => Promise<{lhr: LHResult, artifacts: Artifacts, log: string}>);
 
     export interface SmokehouseOptions {
       /** If true, performs extra logging from the test runs. */
       isDebug?: boolean;
-      /** If true, uses the new Fraggle Rock runner. */
-      useFraggleRock?: boolean;
+      /** If true, use the legacy navigation runner. */
+      useLegacyNavigation?: boolean;
       /** Manually set the number of jobs to run at once. `1` runs all tests serially. */
       jobs?: number;
       /** The number of times to retry failing tests before accepting. Defaults to 0. */

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

@@ -1,14 +0,0 @@
-# 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' ~/src/devtools/devtools-frontend/test/e2e/lighthouse/ third-party/devtools-tests/e2e/lighthouse/
-rsync -ahvz --exclude='OWNERS' ~/src/devtools/devtools-frontend/test/e2e/resources/lighthouse/ third-party/devtools-tests/e2e/resources/lighthouse/
-```

package/third-party/devtools-tests/e2e/lighthouse/BUILD.gn

@@ -1,17 +0,0 @@
-# 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("../../../third_party/typescript/typescript.gni")
-
-node_ts_library("lighthouse") {
-  sources = [
-    "generate-report_test.ts",
-    "indexeddb-warning_test.ts",
-  ]
-
-  deps = [
-    "../../shared",
-    "../helpers",
-  ]
-}

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

@@ -1,29 +0,0 @@
-// 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

@@ -1,29 +0,0 @@
-// 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/BUILD.gn

@@ -1,9 +0,0 @@
-# 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("../../../../scripts/build/ninja/copy.gni")
-
-copy_to_gen("lighthouse") {
-  sources = [ "lighthouse-storage.html" ]
-}

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

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