lighthouse 9.5.0-dev.20220413 → 9.5.0-dev.20220416

package/lighthouse-cli/run.js

@@ -194,27 +194,6 @@ async function potentiallyKillChrome(launchedChrome) {
   });
 }
 
-/**
- * @param {string} url
- * @param {LH.CliFlags} flags
- * @param {LH.Config.Json|undefined} config
- * @param {ChromeLauncher.LaunchedChrome} launchedChrome
- * @return {Promise<LH.RunnerResult|undefined>}
- */
-async function runLighthouseWithFraggleRock(url, flags, config, launchedChrome) {
-  const fraggleRock = (await import('../lighthouse-core/fraggle-rock/api.js')).default;
-  const puppeteer = (await import('puppeteer')).default;
-  const browser = await puppeteer.connect({browserURL: `http://localhost:${launchedChrome.port}`});
-  const page = await browser.newPage();
-  flags.channel = 'fraggle-rock-cli';
-  const configContext = {
-    configPath: flags.configPath,
-    settingsOverrides: flags,
-    logLevel: flags.logLevel,
-  };
-  return fraggleRock.navigation(url, {page, config, configContext});
-}
-
 /**
  * @param {string} url
  * @param {LH.CliFlags} flags
@@ -247,9 +226,15 @@ async function runLighthouse(url, flags, config) {
       flags.port = launchedChrome.port;
     }
 
-    const runnerResult = flags.fraggleRock && launchedChrome ?
-       await runLighthouseWithFraggleRock(url, flags, config, launchedChrome) :
-       await lighthouse(url, flags, config);
+    if (flags.fraggleRock) {
+      flags.channel = 'fraggle-rock-cli';
+    } else {
+      flags.channel = 'cli';
+    }
+
+    const runnerResult = flags.fraggleRock ?
+       await lighthouse(url, flags, config) :
+       await lighthouse.legacyNavigation(url, flags, config);
 
     // If in gatherMode only, there will be no runnerResult.
     if (runnerResult) {

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

@@ -13,11 +13,13 @@
 
 import fs from 'fs';
 
+import puppeteer from 'puppeteer-core';
 import ChromeLauncher from 'chrome-launcher';
 
 import ChromeProtocol from '../../../../lighthouse-core/gather/connections/cri.js';
 import {LH_ROOT} from '../../../../root.js';
 
+const originalBuffer = global.Buffer;
 const originalRequire = global.require;
 if (typeof globalThis === 'undefined') {
   // @ts-expect-error - exposing for loading of dt-bundle.
@@ -28,28 +30,38 @@ if (typeof globalThis === 'undefined') {
 eval(fs.readFileSync(LH_ROOT + '/dist/lighthouse-dt-bundle.js', 'utf-8'));
 
 global.require = originalRequire;
+global.Buffer = originalBuffer;
 
 /** @type {import('../../../../lighthouse-core/index.js')} */
 // @ts-expect-error - not worth giving test global an actual type.
 const lighthouse = global.runBundledLighthouse;
 
 /**
- * Launch Chrome and do a full Lighthouse run via the Lighthouse CLI.
+ * Launch Chrome and do a full Lighthouse run via the Lighthouse DevTools bundle.
  * @param {string} url
  * @param {LH.Config.Json=} configJson
- * @param {{isDebug?: boolean}=} testRunnerOptions
+ * @param {{isDebug?: boolean, useFraggleRock?: boolean}=} testRunnerOptions
  * @return {Promise<{lhr: LH.Result, artifacts: LH.Artifacts, log: string}>}
  */
 async function runLighthouse(url, configJson, testRunnerOptions = {}) {
   // Launch and connect to Chrome.
   const launchedChrome = await ChromeLauncher.launch();
   const port = launchedChrome.port;
-  const connection = new ChromeProtocol(port);
 
   try {
     // Run Lighthouse.
     const logLevel = testRunnerOptions.isDebug ? 'info' : undefined;
-    const runnerResult = await lighthouse(url, {port, logLevel}, configJson, connection);
+    let runnerResult;
+    if (testRunnerOptions.useFraggleRock) {
+      // 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');
 
     return {

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

@@ -220,10 +220,10 @@ function makeComparison(name, actualResult, expectedResult) {
  * @param {LocalConsole} localConsole
  * @param {LH.Result} lhr
  * @param {Smokehouse.ExpectedRunnerResult} expected
- * @param {{runner?: string, isBundled?: boolean}=} reportOptions
+ * @param {{runner?: string, isBundled?: boolean, useFraggleRock?: boolean}=} reportOptions
  */
 function pruneExpectations(localConsole, lhr, expected, reportOptions) {
-  const isFraggleRock = lhr.configSettings.channel === 'fraggle-rock-cli';
+  const isFraggleRock = reportOptions?.useFraggleRock;
   const isBundled = reportOptions?.isBundled;
 
   /**
@@ -456,7 +456,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}=} reportOptions
+ * @param {{runner?: string, isDebug?: boolean, isBundled?: boolean, useFraggleRock?: boolean}=} reportOptions
  * @return {{passed: number, failed: number, log: string}}
  */
 function getAssertionReport(actual, expected, reportOptions = {}) {

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

@@ -162,6 +162,7 @@ async function runSmokeTest(smokeTestDefn, testOptions) {
     report = getAssertionReport(result, expectations, {
       runner: lighthouseRunner.runnerName,
       isDebug,
+      useFraggleRock,
     });
 
     runs.push({

package/lighthouse-core/fraggle-rock/api.js

@@ -13,7 +13,7 @@ const {generateFlowReportHtml} = require('../../report/generator/report-generato
 const Runner = require('../runner.js');
 
 /**
- * @param {import('puppeteer').Page} page
+ * @param {LH.Puppeteer.Page} page
  * @param {ConstructorParameters<LH.UserFlow>[1]} [options]
  */
 async function startFlow(page, options) {

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

@@ -35,7 +35,7 @@ const defaultSession = {
 /** @implements {LH.Gatherer.FRTransitionalDriver} */
 class Driver {
   /**
-   * @param {import('puppeteer').Page} page
+   * @param {LH.Puppeteer.Page} page
    */
   constructor(page) {
     this._page = page;

package/lighthouse-core/fraggle-rock/gather/navigation-runner.js

@@ -298,8 +298,8 @@ async function _cleanup({requestedUrl, driver, config}) {
 }
 
 /**
- * @param {LH.NavigationRequestor} requestor
- * @param {{page: import('puppeteer').Page, config?: LH.Config.Json, configContext?: LH.Config.FRContext}} options
+ * @param {LH.NavigationRequestor|undefined} requestor
+ * @param {{page: LH.Puppeteer.Page, config?: LH.Config.Json, configContext?: LH.Config.FRContext}} options
  * @return {Promise<LH.Gatherer.FRGatherResult>}
  */
 async function navigationGather(requestor, options) {
@@ -313,7 +313,8 @@ async function navigationGather(requestor, options) {
   };
 
   // We can't trigger the navigation through user interaction if we reset the page before starting.
-  if (typeof requestor !== 'string') {
+  const isCallback = typeof requestor === 'function';
+  if (isCallback) {
     internalOptions.skipAboutBlank = true;
   }
 
@@ -324,7 +325,7 @@ async function navigationGather(requestor, options) {
       const context = {
         driver,
         config,
-        requestor: typeof requestor === 'string' ? URL.normalizeUrl(requestor) : requestor,
+        requestor: isCallback ? requestor : URL.normalizeUrl(requestor),
         options: internalOptions,
       };
       const {baseArtifacts} = await _setup(context);

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

@@ -14,7 +14,7 @@ const DEFAULT_PROTOCOL_TIMEOUT = 30000;
 /** @implements {LH.Gatherer.FRProtocolSession} */
 class ProtocolSession {
   /**
-   * @param {import('puppeteer').CDPSession} session
+   * @param {LH.Puppeteer.CDPSession} session
    */
   constructor(session) {
     this._session = session;
@@ -93,7 +93,7 @@ class ProtocolSession {
    * @param {(session: ProtocolSession) => void} callback
    */
   addSessionAttachedListener(callback) {
-    /** @param {import('puppeteer').CDPSession} session */
+    /** @param {LH.Puppeteer.CDPSession} session */
     const listener = session => callback(new ProtocolSession(session));
     this._callbackMap.set(callback, listener);
     this._session.connection().on('sessionattached', listener);

package/lighthouse-core/fraggle-rock/gather/snapshot-runner.js

@@ -17,7 +17,7 @@ const {initializeConfig} = require('../config/config.js');
 const {getBaseArtifacts, finalizeArtifacts} = require('./base-artifacts.js');
 
 /**
- * @param {{page: import('puppeteer').Page, config?: LH.Config.Json, configContext?: LH.Config.FRContext}} options
+ * @param {{page: LH.Puppeteer.Page, config?: LH.Config.Json, configContext?: LH.Config.FRContext}} options
  * @return {Promise<LH.Gatherer.FRGatherResult>}
  */
 async function snapshotGather(options) {

package/lighthouse-core/fraggle-rock/gather/timespan-runner.js

@@ -18,7 +18,7 @@ const {initializeConfig} = require('../config/config.js');
 const {getBaseArtifacts, finalizeArtifacts} = require('./base-artifacts.js');
 
 /**
- * @param {{page: import('puppeteer').Page, config?: LH.Config.Json, configContext?: LH.Config.FRContext}} options
+ * @param {{page: LH.Puppeteer.Page, config?: LH.Config.Json, configContext?: LH.Config.FRContext}} options
  * @return {Promise<{endTimespanGather(): Promise<LH.Gatherer.FRGatherResult>}>}
  */
 async function startTimespanGather(options) {

package/lighthouse-core/index.js

@@ -5,14 +5,19 @@
  */
 'use strict';
 
+const puppeteer = require('puppeteer-core');
 const Runner = require('./runner.js');
 const log = require('lighthouse-logger');
 const ChromeProtocol = require('./gather/connections/cri.js');
 const Config = require('./config/config.js');
 const URL = require('./lib/url-shim.js');
+const fraggleRock = require('./fraggle-rock/api.js');
 
 /** @typedef {import('./gather/connections/connection.js')} Connection */
 
+const DEFAULT_HOSTNAME = '127.0.0.1';
+const DEFAULT_PORT = 9222;
+
 /*
  * The relationship between these root modules:
  *
@@ -33,10 +38,35 @@ const URL = require('./lib/url-shim.js');
  *   they will override any settings in the config.
  * @param {LH.Config.Json=} configJSON Configuration for the Lighthouse run. If
  *   not present, the default config is used.
+ * @param {LH.Puppeteer.Page=} page
+ * @return {Promise<LH.RunnerResult|undefined>}
+ */
+async function lighthouse(url, flags = {}, configJSON, page) {
+  if (!page) {
+    const {hostname = DEFAULT_HOSTNAME, port = DEFAULT_PORT} = flags;
+    const browser = await puppeteer.connect({browserURL: `http://${hostname}:${port}`});
+    page = await browser.newPage();
+  }
+  const configContext = {
+    configPath: flags.configPath,
+    settingsOverrides: flags,
+    logLevel: flags.logLevel,
+  };
+  return fraggleRock.navigation(url, {page, config: configJSON, configContext});
+}
+
+/**
+ * Run Lighthouse using the legacy navigation runner.
+ * This is left in place for any clients that don't support FR navigations yet (e.g. Lightrider)
+ * @param {string=} url The URL to test. Optional if running in auditMode.
+ * @param {LH.Flags=} flags Optional settings for the Lighthouse run. If present,
+ *   they will override any settings in the config.
+ * @param {LH.Config.Json=} configJSON Configuration for the Lighthouse run. If
+ *   not present, the default config is used.
  * @param {Connection=} userConnection
  * @return {Promise<LH.RunnerResult|undefined>}
  */
-async function lighthouse(url, flags = {}, configJSON, userConnection) {
+async function legacyNavigation(url, flags = {}, configJSON, userConnection) {
   // set logging preferences, assume quiet
   flags.logLevel = flags.logLevel || 'error';
   log.setLevel(flags.logLevel);
@@ -66,6 +96,7 @@ function generateConfig(configJson, flags) {
   return new Config(configJson, flags);
 }
 
+lighthouse.legacyNavigation = legacyNavigation;
 lighthouse.generateConfig = generateConfig;
 lighthouse.getAuditList = Runner.getAuditList;
 lighthouse.traceCategories = require('./gather/driver.js').traceCategories;

package/lighthouse-core/lib/tracehouse/trace-processor.js

@@ -82,11 +82,15 @@ class TraceProcessor {
    * Returns true if the event is a navigation start event of a document whose URL seems valid.
    *
    * @param {LH.TraceEvent} event
+   * @return {boolean}
    */
   static _isNavigationStartOfInterest(event) {
-    return event.name === 'navigationStart' &&
-      (!event.args.data || !event.args.data.documentLoaderURL ||
-        ACCEPTABLE_NAVIGATION_URL_REGEX.test(event.args.data.documentLoaderURL));
+    if (event.name !== 'navigationStart') return false;
+    // COMPAT: support pre-m67 test traces before `args.data` added to all navStart events.
+    // TODO: remove next line when old test traces (e.g. progressive-app-m60.json) are updated.
+    if (event.args.data?.documentLoaderURL === undefined) return true;
+    if (!event.args.data?.documentLoaderURL) return false;
+    return ACCEPTABLE_NAVIGATION_URL_REGEX.test(event.args.data.documentLoaderURL);
   }
 
   /**
@@ -462,8 +466,9 @@ class TraceProcessor {
     // If we can't find either TracingStarted event, then we'll fallback to the first navStart that
     // looks like it was loading the main frame with a real URL. Because the schema for this event
     // has changed across Chrome versions, we'll be extra defensive about finding this case.
-    const navStartEvt = events.find(e => Boolean(e.name === 'navigationStart' &&
-      e.args?.data?.isLoadingMainFrame && e.args.data.documentLoaderURL));
+    const navStartEvt = events.find(e =>
+      this._isNavigationStartOfInterest(e) && e.args.data?.isLoadingMainFrame
+    );
     // Find the first resource that was requested and make sure it agrees on the id.
     const firstResourceSendEvt = events.find(e => e.name === 'ResourceSendRequest');
     // We know that these properties exist if we found the events, but TSC doesn't.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lighthouse",
-  "version": "9.5.0-dev.20220413",
+  "version": "9.5.0-dev.20220416",
   "description": "Automated auditing, performance metrics, and best practices for the web.",
   "main": "./lighthouse-core/index.js",
   "bin": {
@@ -24,7 +24,7 @@
     "build-smokehouse-bundle": "node ./build/build-smokehouse-bundle.js",
     "build-lr": "yarn reset-link && node ./build/build-lightrider-bundles.js",
     "build-pack": "bash build/build-pack.sh",
-    "build-report": "node build/build-report-components.js && yarn eslint --fix report/renderer/components.js && bash lighthouse-core/scripts/copy-util-commonjs.sh && node build/build-report.js",
+    "build-report": "node build/build-report-components.js && bash lighthouse-core/scripts/copy-util-commonjs.sh && node build/build-report.js",
     "build-sample-reports": "yarn build-report && node build/build-sample-reports.js",
     "build-treemap": "node ./build/build-treemap.js",
     "build-viewer": "node ./build/build-viewer.js",
@@ -37,7 +37,7 @@
     "start": "yarn build-report --standalone && node ./lighthouse-cli/index.js",
     "jest": "node --experimental-vm-modules ./node_modules/jest/bin/jest.js",
     "test": "yarn diff:sample-json && yarn lint --quiet && yarn unit && yarn type-check",
-    "test-bundle": "yarn smoke --runner bundle -j=1 --retries=2 --invert-match forms",
+    "test-bundle": "yarn smoke --runner bundle -j=1 --retries=2",
     "test-clients": "yarn jest \"$PWD/clients/\" && yarn jest --testMatch=\"**/clients/test/**/*-test-pptr.js\"",
     "test-viewer": "yarn unit-viewer && yarn jest --testMatch=\"**/viewer/**/*-test-pptr.js\"",
     "test-treemap": "yarn unit-treemap && yarn jest --testMatch=\"**/treemap/**/*-test-pptr.js\"",
@@ -164,7 +164,7 @@
     "pako": "^2.0.3",
     "preact": "^10.5.14",
     "pretty-json-stringify": "^0.0.2",
-    "puppeteer": "^10.2.0",
+    "puppeteer": "10.2.0",
     "resolve": "^1.20.0",
     "rollup": "^2.52.7",
     "rollup-plugin-node-resolve": "^5.2.0",
@@ -200,6 +200,7 @@
     "open": "^8.4.0",
     "parse-cache-control": "1.0.1",
     "ps-list": "^8.0.0",
+    "puppeteer-core": "^10.2.0",
     "robots-parser": "^3.0.0",
     "semver": "^5.3.0",
     "speedline-core": "^1.4.3",
@@ -209,7 +210,8 @@
     "yargs-parser": "^21.0.0"
   },
   "resolutions": {
-    "puppeteer/**/devtools-protocol": "0.0.975298"
+    "puppeteer/**/devtools-protocol": "0.0.975298",
+    "puppeteer-core/**/devtools-protocol": "0.0.975298"
   },
   "repository": "GoogleChrome/lighthouse",
   "keywords": [