lighthouse 8.4.0 → 8.5.0-dev.20210921

package/flow-report/tsconfig.json

@@ -1,39 +1,23 @@
 {
+  "extends": "../tsconfig-base.json",
   "compilerOptions": {
-    "composite": true,
     "outDir": "../.tmp/tsbuildinfo/flow-report",
-    "emitDeclarationOnly": false,
-    "declarationMap": true,
 
     // Limit to base JS and DOM defs.
     "lib": ["es2020", "dom", "dom.iterable"],
-    // Selectively include types from node_modules.
+    // Selectively include types from node_modules/.
     "types": ["node", "jest"],
-    "target": "es2020",
-    "module": "es2020",
-    "moduleResolution": "node",
-    "esModuleInterop": true,
-
-    "allowJs": true,
-    "checkJs": true,
-    "strict": true,
-    // TODO: remove the next line to be fully `strict`.
-    "useUnknownInCatchVariables": false,
-
-    // "listFiles": true,
-    // "noErrorTruncation": true,
-    "extendedDiagnostics": true,
 
     "jsx": "react-jsx",
     "jsxImportSource": "preact",
   },
+  "references": [
+    {"path": "../types/lhr/"},
+    {"path": "../report"},
+  ],
   "include": [
     "**/*.ts",
     "**/*.tsx",
     "./types",
   ],
-  "references": [
-    {"path": "../types/lhr/"},
-    {"path": "../report"},
-  ],
 }

package/{lighthouse-core/gather/gatherers/gather-context.js → lighthouse-cli/.eslintrc.cjs}

@@ -5,21 +5,23 @@
  */
 'use strict';
 
-const FRGatherer = require('../../fraggle-rock/gather/base-gatherer.js');
-
-class GatherContext extends FRGatherer {
-   /** @type {LH.Gatherer.GathererMeta} */
-   meta = {
-     supportedModes: ['snapshot', 'timespan', 'navigation'],
-   }
-
-   /**
-    * @param {LH.Gatherer.FRTransitionalContext} phaseContext
-    * @return {Promise<LH.Artifacts['GatherContext']>}
-    */
-   async getArtifact(phaseContext) {
-     return {gatherMode: phaseContext.gatherMode};
-   }
-}
-
-module.exports = GatherContext;
+module.exports = {
+  env: {
+    browser: true,
+  },
+  rules: {
+    // TODO(esmodules): move to root eslint when all code is ESM
+    // or when this is resolved: https://github.com/import-js/eslint-plugin-import/issues/2214
+    'import/order': [2, {
+      'groups': [
+        'builtin',
+        'external',
+        ['sibling', 'parent'],
+        'index',
+        'object',
+        'type',
+      ],
+      'newlines-between': 'always',
+    }],
+  },
+};

package/lighthouse-cli/bin.js

@@ -18,19 +18,23 @@
  *               cli-flags        lh-core/index
  */
 
-const fs = require('fs');
-const path = require('path');
-const commands = require('./commands/commands.js');
-const printer = require('./printer.js');
-const {getFlags} = require('./cli-flags.js');
-const {runLighthouse} = require('./run.js');
-const {generateConfig} = require('../lighthouse-core/index.js');
-const log = require('lighthouse-logger');
-const pkg = require('../package.json');
-const Sentry = require('../lighthouse-core/lib/sentry.js');
-const updateNotifier = require('update-notifier');
-const {askPermission} = require('./sentry-prompt.js');
-const {LH_ROOT} = require('../root.js');
+import fs from 'fs';
+import path from 'path';
+import url from 'url';
+
+import log from 'lighthouse-logger';
+import updateNotifier from 'update-notifier';
+
+import * as commands from './commands/commands.js';
+import * as Printer from './printer.js';
+import {getFlags} from './cli-flags.js';
+import {runLighthouse} from './run.js';
+import lighthouse from '../lighthouse-core/index.js';
+import * as Sentry from '../lighthouse-core/lib/sentry.js';
+import {askPermission} from './sentry-prompt.js';
+import {LH_ROOT} from '../root.js';
+
+const pkg = JSON.parse(fs.readFileSync(LH_ROOT + '/package.json', 'utf-8'));
 
 /**
  * @return {boolean}
@@ -58,16 +62,22 @@ async function begin() {
     commands.listTraceCategories();
   }
 
-  const url = cliFlags._[0];
+  const urlUnderTest = cliFlags._[0];
 
   /** @type {LH.Config.Json|undefined} */
   let configJson;
   if (cliFlags.configPath) {
     // Resolve the config file path relative to where cli was called.
     cliFlags.configPath = path.resolve(process.cwd(), cliFlags.configPath);
-    configJson = require(cliFlags.configPath);
+
+    if (cliFlags.configPath.endsWith('.json')) {
+      configJson = JSON.parse(fs.readFileSync(cliFlags.configPath, 'utf-8'));
+    } else {
+      const configModuleUrl = url.pathToFileURL(cliFlags.configPath).href;
+      configJson = (await import(configModuleUrl)).default;
+    }
   } else if (cliFlags.preset) {
-    configJson = require(`../lighthouse-core/config/${cliFlags.preset}-config.js`);
+    configJson = (await import(`../lighthouse-core/config/${cliFlags.preset}-config.js`)).default;
   }
 
   if (cliFlags.budgetPath) {
@@ -88,7 +98,7 @@ async function begin() {
 
   if (
     cliFlags.output.length === 1 &&
-    cliFlags.output[0] === printer.OutputMode.json &&
+    cliFlags.output[0] === Printer.OutputMode.json &&
     !cliFlags.outputPath
   ) {
     cliFlags.outputPath = 'stdout';
@@ -106,7 +116,7 @@ async function begin() {
   }
 
   if (cliFlags.printConfig) {
-    const config = generateConfig(configJson, cliFlags);
+    const config = lighthouse.generateConfig(configJson, cliFlags);
     process.stdout.write(config.getPrintString());
     return;
   }
@@ -119,7 +129,7 @@ async function begin() {
   }
   if (cliFlags.enableErrorReporting) {
     Sentry.init({
-      url,
+      url: urlUnderTest,
       flags: cliFlags,
       environmentData: {
         name: 'redacted', // prevent sentry from using hostname
@@ -132,9 +142,9 @@ async function begin() {
     });
   }
 
-  return runLighthouse(url, cliFlags, configJson);
+  return runLighthouse(urlUnderTest, cliFlags, configJson);
 }
 
-module.exports = {
+export {
   begin,
 };

package/lighthouse-cli/cli-flags.js

@@ -7,9 +7,12 @@
 
 /* eslint-disable max-len */
 
-const yargs = require('yargs');
-const fs = require('fs');
-const {isObjectOfUnknownValues} = require('../lighthouse-core/lib/type-verifiers.js');
+import fs from 'fs';
+
+import yargs from 'yargs';
+import * as yargsHelpers from 'yargs/helpers';
+
+import {isObjectOfUnknownValues} from '../lighthouse-core/lib/type-verifiers.js';
 
 /**
  * @param {string=} manualArgv
@@ -17,8 +20,10 @@ const {isObjectOfUnknownValues} = require('../lighthouse-core/lib/type-verifiers
  * @return {LH.CliFlags}
  */
 function getFlags(manualArgv, options = {}) {
-  // @ts-expect-error - undocumented, but yargs() supports parsing a single `string`.
-  const y = manualArgv ? yargs(manualArgv) : yargs;
+  const y = manualArgv ?
+    // @ts-expect-error - undocumented, but yargs() supports parsing a single `string`.
+    yargs(manualArgv) :
+    yargs(yargsHelpers.hideBin(process.argv));
 
   let parser = y.help('help')
       .showHelpOnFail(false, 'Specify --help for available options')
@@ -318,7 +323,7 @@ function getFlags(manualArgv, options = {}) {
         throw new Error('Please provide a url');
       })
       .epilogue('For more information on Lighthouse, see https://developers.google.com/web/tools/lighthouse/.')
-      .wrap(yargs.terminalWidth());
+      .wrap(y.terminalWidth());
 
   if (options.noExitOnFailure) {
     // Silence console.error() logging and don't process.exit().
@@ -499,6 +504,6 @@ function coerceScreenEmulation(value) {
   return screenEmulationSettings;
 }
 
-module.exports = {
+export {
   getFlags,
 };

package/lighthouse-cli/commands/commands.js

@@ -5,10 +5,5 @@
  */
 'use strict';
 
-const listAudits = require('./list-audits.js');
-const listTraceCategories = require('./list-trace-categories.js');
-
-module.exports = {
-  listAudits,
-  listTraceCategories,
-};
+export {listAudits} from './list-audits.js';
+export {listTraceCategories} from './list-trace-categories.js';

package/lighthouse-cli/commands/list-audits.js

@@ -5,7 +5,7 @@
  */
 'use strict';
 
-const lighthouse = require('../../lighthouse-core/index.js');
+import lighthouse from '../../lighthouse-core/index.js';
 
 function listAudits() {
   const audits = lighthouse.getAuditList().map((i) => i.replace(/\.js$/, ''));
@@ -13,4 +13,4 @@ function listAudits() {
   process.exit(0);
 }
 
-module.exports = listAudits;
+export {listAudits};

package/lighthouse-cli/commands/list-trace-categories.js

@@ -5,7 +5,7 @@
  */
 'use strict';
 
-const lighthouse = require('../../lighthouse-core/index.js');
+import lighthouse from '../../lighthouse-core/index.js';
 
 function listTraceCategories() {
   const traceCategories = lighthouse.traceCategories;
@@ -13,4 +13,4 @@ function listTraceCategories() {
   process.exit(0);
 }
 
-module.exports = listTraceCategories;
+export {listTraceCategories};

package/lighthouse-cli/index.js

@@ -6,7 +6,9 @@
  */
 'use strict';
 
-require('./bin.js').begin().catch(err => {
+import {begin} from './bin.js';
+
+begin().catch(err => {
   process.stderr.write(err.stack);
   process.exit(1);
 });

package/lighthouse-cli/package.json

@@ -0,0 +1,4 @@
+{
+  "type": "module",
+  "//": "Any directory that uses `import ... from` or `export ...` must be type module. Temporary file until root package.json is type: module"
+}

package/lighthouse-cli/printer.js

@@ -5,8 +5,9 @@
  */
 'use strict';
 
-const fs = require('fs');
-const log = require('lighthouse-logger');
+import fs from 'fs';
+
+import log from 'lighthouse-logger';
 
 /**
  * An enumeration of acceptable output modes:
@@ -91,7 +92,7 @@ function getValidOutputOptions() {
   return Object.keys(OutputMode);
 }
 
-module.exports = {
+export {
   checkOutputPath,
   write,
   OutputMode,

package/lighthouse-cli/run.js

@@ -7,20 +7,19 @@
 
 /* eslint-disable no-console */
 
-const path = require('path');
-const psList = require('ps-list');
+import path from 'path';
 
-const Printer = require('./printer.js');
-const ChromeLauncher = require('chrome-launcher');
+import psList from 'ps-list';
+import * as ChromeLauncher from 'chrome-launcher';
+import yargsParser from 'yargs-parser';
+import log from 'lighthouse-logger';
+import open from 'open';
 
-const yargsParser = require('yargs-parser');
-const lighthouse = require('../lighthouse-core/index.js');
-const log = require('lighthouse-logger');
-const getFilenamePrefix = require('../report/generator/file-namer.js').getFilenamePrefix;
-const assetSaver = require('../lighthouse-core/lib/asset-saver.js');
-const URL = require('../lighthouse-core/lib/url-shim.js');
-
-const open = require('open');
+import * as Printer from './printer.js';
+import lighthouse from '../lighthouse-core/index.js';
+import {getFilenamePrefix} from '../report/generator/file-namer.js';
+import * as assetSaver from '../lighthouse-core/lib/asset-saver.js';
+import URL from '../lighthouse-core/lib/url-shim.js';
 
 /** @typedef {Error & {code: string, friendlyMessage?: string}} ExitError */
 
@@ -203,8 +202,8 @@ async function potentiallyKillChrome(launchedChrome) {
  * @return {Promise<LH.RunnerResult|undefined>}
  */
 async function runLighthouseWithFraggleRock(url, flags, config, launchedChrome) {
-  const fraggleRock = require('../lighthouse-core/fraggle-rock/api.js');
-  const puppeteer = require('puppeteer');
+  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';
@@ -272,7 +271,7 @@ async function runLighthouse(url, flags, config) {
   }
 }
 
-module.exports = {
+export {
   parseChromeFlags,
   saveResults,
   runLighthouse,

package/lighthouse-cli/sentry-prompt.js

@@ -5,10 +5,9 @@
  */
 'use strict';
 
-const Configstore = require('configstore');
-const {Confirm} = require('enquirer');
-
-const log = require('lighthouse-logger');
+import Configstore from 'configstore';
+import Confirm from 'enquirer';
+import log from 'lighthouse-logger';
 
 const MAXIMUM_WAIT_TIME = 20 * 1000;
 
@@ -29,7 +28,7 @@ function prompt() {
   /** @type {NodeJS.Timer|undefined} */
   let timeout;
 
-  const prompt = new Confirm({
+  const prompt = new Confirm.Confirm({
     name: 'isErrorReportingEnabled',
     initial: false,
     message: MESSAGE,
@@ -75,6 +74,6 @@ function askPermission() {
   }).catch(_ => false);
 }
 
-module.exports = {
+export {
   askPermission,
 };

package/lighthouse-cli/test/smokehouse/frontends/back-compat-util.js

@@ -37,6 +37,6 @@ function updateTestDefnFormat(allTestDefns) {
   return expandedTestDefns.flat();
 }
 
-module.exports = {
+export {
   updateTestDefnFormat,
 };

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

@@ -13,9 +13,10 @@
 
 /* eslint-disable no-console */
 
-const cloneDeep = require('lodash.clonedeep');
-const smokeTests = require('../test-definitions/core-tests.js');
-const {runSmokehouse} = require('../smokehouse.js');
+import cloneDeep from 'lodash.clonedeep';
+
+import smokeTests from '../test-definitions/core-tests.js';
+import {runSmokehouse} from '../smokehouse.js';
 
 /**
  * @param {Smokehouse.SmokehouseLibOptions} options
@@ -43,4 +44,4 @@ async function smokehouse(options) {
   return runSmokehouse(modifiedTests, smokehouseOptions);
 }
 
-module.exports = smokehouse;
+export {smokehouse};

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

@@ -10,4 +10,4 @@
  */
 
 // Smokehouse is runnable from within node, so just a no-op for now.
-module.exports = require('../smokehouse.js');
+export * from '../smokehouse.js';

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

@@ -13,14 +13,22 @@
 
 /* eslint-disable no-console */
 
-const path = require('path');
-const cloneDeep = require('lodash.clonedeep');
-const yargs = require('yargs');
-const log = require('lighthouse-logger');
-const {runSmokehouse} = require('../smokehouse.js');
-const {updateTestDefnFormat} = require('./back-compat-util.js');
+import {strict as assert} from 'assert';
+import path from 'path';
+import fs from 'fs';
+import url from 'url';
 
-const coreTestDefnsPath = path.join(__dirname, '../test-definitions/core-tests.js');
+import cloneDeep from 'lodash.clonedeep';
+import yargs from 'yargs';
+import * as yargsHelpers from 'yargs/helpers';
+import log from 'lighthouse-logger';
+
+import {runSmokehouse} from '../smokehouse.js';
+import {updateTestDefnFormat} from './back-compat-util.js';
+import {LH_ROOT} from '../../../../root.js';
+
+const coreTestDefnsPath =
+  path.join(LH_ROOT, 'lighthouse-cli/test/smokehouse/test-definitions/core-tests.js');
 
 /**
  * Possible Lighthouse runners. Loaded dynamically so e.g. a CLI run isn't
@@ -72,6 +80,52 @@ function getDefinitionsToRun(allTestDefns, requestedIds, {invertMatch}) {
   return smokes;
 }
 
+/**
+ * Parses the cli `shardArg` flag into `shardNumber/shardTotal`. Splits
+ * `testDefns` into `shardTotal` shards and returns the `shardNumber`th shard.
+ * Shards will differ in size by at most 1.
+ * Shard params must be 1 ≤ shardNumber ≤ shardTotal.
+ * @param {Array<Smokehouse.TestDfn>} testDefns
+ * @param {string=} shardArg
+ * @return {Array<Smokehouse.TestDfn>}
+ */
+function getShardedDefinitions(testDefns, shardArg) {
+  if (!shardArg) return testDefns;
+
+  // eslint-disable-next-line max-len
+  const errorMessage = `'shard' must be of the form 'n/d' and n and d must be positive integers with 1 ≤ n ≤ d. Got '${shardArg}'`;
+  const match = /^(?<shardNumber>\d+)\/(?<shardTotal>\d+)$/.exec(shardArg);
+  assert(match && match.groups, errorMessage);
+  const shardNumber = Number(match.groups.shardNumber);
+  const shardTotal = Number(match.groups.shardTotal);
+  assert(shardNumber > 0 && Number.isInteger(shardNumber), errorMessage);
+  assert(shardTotal > 0 && Number.isInteger(shardTotal));
+  assert(shardNumber <= shardTotal, errorMessage);
+
+  // Array is sharded with `Math.ceil(length / shardTotal)` shards first
+  // and then the remaining `Math.floor(length / shardTotal) shards.
+  // e.g. `[0, 1, 2, 3]` split into 3 shards is `[[0, 1], [2], [3]]`.
+  const baseSize = Math.floor(testDefns.length / shardTotal);
+  const biggerSize = baseSize + 1;
+  const biggerShardCount = testDefns.length % shardTotal;
+
+  // Since we don't have tests for this file, construct all shards so correct
+  // structure can be asserted.
+  const shards = [];
+  let index = 0;
+  for (let i = 0; i < shardTotal; i++) {
+    const shardSize = i < biggerShardCount ? biggerSize : baseSize;
+    shards.push(testDefns.slice(index, index + shardSize));
+    index += shardSize;
+  }
+  assert.equal(shards.length, shardTotal);
+  assert.deepEqual(shards.flat(), testDefns);
+
+  const shardDefns = shards[shardNumber - 1];
+  console.log(`In this shard (${shardArg}), running: ${shardDefns.map(d => d.id).join(' ')}\n`);
+  return shardDefns;
+}
+
 /**
  * Prune the `networkRequests` from the test expectations when `takeNetworkRequestUrls`
  * is not defined. Custom servers may not have this method available in-process.
@@ -112,7 +166,8 @@ function pruneExpectedNetworkRequests(testDefns, takeNetworkRequestUrls) {
  * CLI entry point.
  */
 async function begin() {
-  const rawArgv = yargs
+  const y = yargs(yargsHelpers.hideBin(process.argv));
+  const rawArgv = y
     .help('help')
     .usage('node $0 [<options>] <test-ids>')
     .example('node $0 -j=1 pwa seo', 'run pwa and seo tests serially')
@@ -155,8 +210,13 @@ async function begin() {
         default: false,
         describe: 'Run all available tests except the ones provided',
       },
+      'shard': {
+        type: 'string',
+        // eslint-disable-next-line max-len
+        describe: 'A argument of the form "n/d", which divides the selected tests into d groups and runs the nth group. n and d must be positive integers with 1 ≤ n ≤ d.',
+      },
     })
-    .wrap(yargs.terminalWidth())
+    .wrap(y.terminalWidth())
     .argv;
 
   // Augmenting yargs type with auto-camelCasing breaks in tsc@4.1.2 and @types/yargs@15.0.11,
@@ -170,16 +230,17 @@ async function begin() {
   if (argv.runner === 'bundle') {
     console.log('\n✨ Be sure to have recently run this: yarn build-all');
   }
-  const lighthouseRunner = require(runnerPath).runLighthouse;
+  const {runLighthouse} = await import(runnerPath);
 
   // Find test definition file and filter by requestedTestIds.
   let testDefnPath = argv.testsPath || coreTestDefnsPath;
   testDefnPath = path.resolve(process.cwd(), testDefnPath);
   const requestedTestIds = argv._;
-  const rawTestDefns = require(testDefnPath);
+  const {default: rawTestDefns} = await import(url.pathToFileURL(testDefnPath).href);
   const allTestDefns = updateTestDefnFormat(rawTestDefns);
   const invertMatch = argv.invertMatch;
-  const testDefns = getDefinitionsToRun(allTestDefns, requestedTestIds, {invertMatch});
+  const requestedTestDefns = getDefinitionsToRun(allTestDefns, requestedTestIds, {invertMatch});
+  const testDefns = getShardedDefinitions(requestedTestDefns, argv.shard);
 
   let smokehouseResult;
   let server;
@@ -189,7 +250,7 @@ async function begin() {
   try {
     // If running the core tests, spin up the test server.
     if (testDefnPath === coreTestDefnsPath) {
-      ({server, serverForOffline} = require('../../fixtures/static-server.js'));
+      ({server, serverForOffline} = await import('../../fixtures/static-server.js'));
       server.listen(10200, 'localhost');
       serverForOffline.listen(10503, 'localhost');
       takeNetworkRequestUrls = server.takeRequestUrls.bind(server);
@@ -201,7 +262,7 @@ async function begin() {
       retries,
       isDebug: argv.debug,
       useFraggleRock: argv.fraggleRock,
-      lighthouseRunner,
+      lighthouseRunner: runLighthouse,
       takeNetworkRequestUrls,
     };
 
@@ -213,6 +274,24 @@ async function begin() {
 
   if (!smokehouseResult.success) {
     const failedTestResults = smokehouseResult.testResults.filter(r => r.failed);
+
+    // For CI, save failed runs to directory to be uploaded.
+    if (process.env.CI) {
+      const failuresDir = `${LH_ROOT}/.tmp/smokehouse-ci-failures`;
+      fs.mkdirSync(failuresDir, {recursive: true});
+
+      for (const testResult of failedTestResults) {
+        for (let i = 0; i < testResult.runs.length; i++) {
+          const run = testResult.runs[i];
+          fs.writeFileSync(`${failuresDir}/${testResult.id}-${i}.json`, JSON.stringify({
+            ...run,
+            lighthouseLog: run.lighthouseLog.split('\n'),
+            assertionLog: run.assertionLog.split('\n'),
+          }, null, 2));
+        }
+      }
+    }
+
     const cmd = `yarn smoke ${failedTestResults.map(r => r.id).join(' ')}`;
     console.log(`rerun failures: ${cmd}`);
   }

package/lighthouse-cli/test/smokehouse/lib/child-process-error.js

@@ -23,4 +23,4 @@ class ChildProcessError extends Error {
   }
 }
 
-module.exports = ChildProcessError;
+export {ChildProcessError};

package/lighthouse-cli/test/smokehouse/lib/concurrent-mapper.js

@@ -123,4 +123,4 @@ class ConcurrentMapper {
   }
 }
 
-module.exports = ConcurrentMapper;
+export {ConcurrentMapper};

package/lighthouse-cli/test/smokehouse/lib/local-console.js

@@ -48,4 +48,4 @@ class LocalConsole {
   }
 }
 
-module.exports = LocalConsole;
+export {LocalConsole};