lighthouse 9.6.8 → 10.0.0-dev.20230209

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

@@ -1,13 +0,0 @@
-/**
- * @license Copyright 2019 The Lighthouse Authors. All Rights Reserved.
- * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
- * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
- */
-'use strict';
-
-/**
- * @fileoverview A smokehouse frontend for running within a node process.
- */
-
-// Smokehouse is runnable from within node, so just a no-op for now.
-export * from '../smokehouse.js';

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

@@ -1,262 +0,0 @@
-#!/usr/bin/env node
-/**
- * @license Copyright 2019 The Lighthouse Authors. All Rights Reserved.
- * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
- * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
- */
-'use strict';
-
-/**
- * @fileoverview A smokehouse frontend for running from the command line. Parse
- * flags, start fixture webservers, then run smokehouse.
- */
-
-/* eslint-disable no-console */
-
-import path from 'path';
-import fs from 'fs';
-import url from 'url';
-
-import cloneDeep from 'lodash/cloneDeep.js';
-import yargs from 'yargs';
-import * as yargsHelpers from 'yargs/helpers';
-import log from 'lighthouse-logger';
-
-import {runSmokehouse, getShardedDefinitions} 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/core-tests.js');
-
-/**
- * Possible Lighthouse runners. Loaded dynamically so e.g. a CLI run isn't
- * contingent on having built all the bundles.
- */
-const runnerPaths = {
-  cli: '../lighthouse-runners/cli.js',
-  bundle: '../lighthouse-runners/bundle.js',
-  devtools: '../lighthouse-runners/devtools.js',
-};
-
-/**
- * Determine batches of smoketests to run, based on the `requestedIds`.
- * @param {Array<Smokehouse.TestDfn>} allTestDefns
- * @param {Array<string>} requestedIds
- * @param {{invertMatch: boolean}} options
- * @return {Array<Smokehouse.TestDfn>}
- */
-function getDefinitionsToRun(allTestDefns, requestedIds, {invertMatch}) {
-  let smokes = [];
-  const usage = `    ${log.dim}yarn smoke ${allTestDefns.map(t => t.id).join(' ')}${log.reset}\n`;
-
-  if (requestedIds.length === 0 && !invertMatch) {
-    smokes = [...allTestDefns];
-    console.log('Running ALL smoketests. Equivalent to:');
-    console.log(usage);
-  } else {
-    smokes = allTestDefns.filter(test => {
-      // Include all tests that *include* requested id.
-      // e.g. a requested 'pwa' will match 'pwa-airhorner', 'pwa-caltrain', etc
-      let isRequested = requestedIds.some(requestedId => test.id.includes(requestedId));
-      if (invertMatch) isRequested = !isRequested;
-      return isRequested;
-    });
-    console.log(`Running ONLY smoketests for: ${smokes.map(t => t.id).join(' ')}\n`);
-  }
-
-  const unmatchedIds = requestedIds.filter(requestedId => {
-    return !allTestDefns.map(t => t.id).some(id => id.includes(requestedId));
-  });
-  if (unmatchedIds.length) {
-    console.log(log.redify(`Smoketests not found for: ${unmatchedIds.join(' ')}`));
-    console.log(usage);
-  }
-
-  if (!smokes.length) {
-    throw new Error('no smoketest found to run');
-  }
-
-  return smokes;
-}
-
-/**
- * Prune the `networkRequests` from the test expectations when `takeNetworkRequestUrls`
- * is not defined. Custom servers may not have this method available in-process.
- * Also asserts that any expectation with `networkRequests` is run serially. For core
- * tests, we don't currently have a good way to map requests to test definitions if
- * the tests are run in parallel.
- * @param {Array<Smokehouse.TestDfn>} testDefns
- * @param {Function|undefined} takeNetworkRequestUrls
- * @return {Array<Smokehouse.TestDfn>}
- */
-function pruneExpectedNetworkRequests(testDefns, takeNetworkRequestUrls) {
-  const pruneNetworkRequests = !takeNetworkRequestUrls;
-
-  const clonedDefns = cloneDeep(testDefns);
-  for (const {id, expectations, runSerially} of clonedDefns) {
-    if (!runSerially && expectations.networkRequests) {
-      throw new Error(`'${id}' must be set to 'runSerially: true' to assert 'networkRequests'`);
-    }
-
-    if (pruneNetworkRequests && expectations.networkRequests) {
-      // eslint-disable-next-line max-len
-      const msg = `'networkRequests' cannot be asserted in test '${id}'. They should only be asserted on tests from an in-process server`;
-      if (process.env.CI) {
-        // If we're in CI, we require any networkRequests expectations to be asserted.
-        throw new Error(msg);
-      }
-
-      console.warn(log.redify('Warning:'),
-          `${msg}. Pruning expectation: ${JSON.stringify(expectations.networkRequests)}`);
-      expectations.networkRequests = undefined;
-    }
-  }
-
-  return clonedDefns;
-}
-
-/**
- * CLI entry point.
- */
-async function begin() {
-  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')
-    .example('node $0 --invert-match byte', 'run all smoke tests but `byte`')
-    .option('_', {
-      array: true,
-      type: 'string',
-    })
-    .options({
-      'debug': {
-        type: 'boolean',
-        default: false,
-        describe: 'Save test artifacts and output verbose logs',
-      },
-      'fraggle-rock': {
-        type: 'boolean',
-        default: false,
-        describe: 'Use the new Fraggle Rock runner',
-      },
-      'jobs': {
-        type: 'number',
-        alias: 'j',
-        describe: 'Manually set the number of jobs to run at once. `1` runs all tests serially',
-      },
-      'retries': {
-        type: 'number',
-        describe: 'The number of times to retry failing tests before accepting. Defaults to 0',
-      },
-      'runner': {
-        default: 'cli',
-        choices: ['cli', 'bundle', 'devtools'],
-        describe: 'The method of running Lighthouse',
-      },
-      'tests-path': {
-        type: 'string',
-        describe: 'The path to a set of test definitions to run. Defaults to core smoke tests.',
-      },
-      'invert-match': {
-        type: 'boolean',
-        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(y.terminalWidth())
-    .argv;
-
-  // Augmenting yargs type with auto-camelCasing breaks in tsc@4.1.2 and @types/yargs@15.0.11,
-  // so for now cast to add yarg's camelCase properties to type.
-  const argv =
-    /** @type {Awaited<typeof rawArgv> & CamelCasify<Awaited<typeof rawArgv>>} */ (rawArgv);
-
-  const jobs = Number.isFinite(argv.jobs) ? argv.jobs : undefined;
-  const retries = Number.isFinite(argv.retries) ? argv.retries : undefined;
-
-  const runnerPath = runnerPaths[/** @type {keyof typeof runnerPaths} */ (argv.runner)];
-  if (argv.runner === 'bundle') {
-    console.log('\n✨ Be sure to have recently run this: yarn build-all');
-  }
-  const {runLighthouse} = await import(runnerPath);
-  runLighthouse.runnerName = argv.runner;
-
-  // Find test definition file and filter by requestedTestIds.
-  let testDefnPath = argv.testsPath || coreTestDefnsPath;
-  testDefnPath = path.resolve(process.cwd(), testDefnPath);
-  const requestedTestIds = argv._;
-  const {default: rawTestDefns} = await import(url.pathToFileURL(testDefnPath).href);
-  const allTestDefns = updateTestDefnFormat(rawTestDefns);
-  const invertMatch = argv.invertMatch;
-  const requestedTestDefns = getDefinitionsToRun(allTestDefns, requestedTestIds, {invertMatch});
-  const testDefns = getShardedDefinitions(requestedTestDefns, argv.shard);
-
-  let smokehouseResult;
-  let server;
-  let serverForOffline;
-  let takeNetworkRequestUrls = undefined;
-
-  try {
-    // If running the core tests, spin up the test server.
-    if (testDefnPath === coreTestDefnsPath) {
-      ({server, serverForOffline} = await import('../../fixtures/static-server.js'));
-      server.listen(10200, 'localhost');
-      serverForOffline.listen(10503, 'localhost');
-      takeNetworkRequestUrls = server.takeRequestUrls.bind(server);
-    }
-
-    const prunedTestDefns = pruneExpectedNetworkRequests(testDefns, takeNetworkRequestUrls);
-    const options = {
-      jobs,
-      retries,
-      isDebug: argv.debug,
-      useFraggleRock: argv.fraggleRock,
-      lighthouseRunner: runLighthouse,
-      takeNetworkRequestUrls,
-    };
-
-    smokehouseResult = (await runSmokehouse(prunedTestDefns, options));
-  } finally {
-    if (server) await server.close();
-    if (serverForOffline) await serverForOffline.close();
-  }
-
-  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}`);
-  }
-
-  const exitCode = smokehouseResult.success ? 0 : 1;
-  process.exit(exitCode);
-}
-
-begin().catch(e => {
-  console.error(e);
-  process.exit(1);
-});

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

@@ -1,26 +0,0 @@
-/**
- * @license Copyright 2019 The Lighthouse Authors. All Rights Reserved.
- * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
- * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
- */
-'use strict';
-
-/**
- * An extension of Error that includes any stdout or stderr from a child
- * process. Based on the error thrown by `child_process.exec()`.
- * https://github.com/nodejs/node/blob/3aeae8d81b7b78668c37f7a07a72d94781126d49/lib/child_process.js#L150-L176
- */
-class ChildProcessError extends Error {
-  /**
-   * @param {string} message
-   * @param {string=} stdout
-   * @param {string=} stderr
-   */
-  constructor(message, stdout = '', stderr = '') {
-    super(message);
-    this.stdout = stdout;
-    this.stderr = stderr;
-  }
-}
-
-export {ChildProcessError};

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

@@ -1,126 +0,0 @@
-/**
- * @license Copyright 2019 The Lighthouse Authors. All Rights Reserved.
- * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
- * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
- */
-'use strict';
-
-/**
- * A class that maintains a concurrency pool to coordinate many jobs that should
- * only be run `concurrencyLimit` at a time.
- * API inspired by http://bluebirdjs.com/docs/api/promise.map.html, but
- * independent callers of `concurrentMap()` share the same concurrency limit.
- */
-class ConcurrentMapper {
-  constructor() {
-    /** @type {Set<Promise<unknown>>} */
-    this._promisePool = new Set();
-
-    /**
-     * The limits of all currently running jobs. There will be duplicates.
-     * @type {Array<number>}
-     */
-    this._allConcurrencyLimits = [];
-  }
-
-  /**
-   * Runs callbackfn on `values` in parallel, at a max of `concurrency` at a
-   * time. Resolves to an array of the results or rejects with the first
-   * rejected result. Default `concurrency` limit is `Infinity`.
-   * @template T, U
-   * @param {Array<T>} values
-   * @param {(value: T, index: number, array: Array<T>) => Promise<U>} callbackfn
-   * @param {{concurrency: number}} [options]
-   * @return {Promise<Array<U>>}
-   */
-  static async map(values, callbackfn, options) {
-    const cm = new ConcurrentMapper();
-    return cm.pooledMap(values, callbackfn, options);
-  }
-
-  /**
-   * Returns whether there are fewer running jobs than the minimum current
-   * concurrency limit and the proposed new `concurrencyLimit`.
-   * @param {number} concurrencyLimit
-   */
-  _canRunMoreAtLimit(concurrencyLimit) {
-    return this._promisePool.size < concurrencyLimit &&
-        this._promisePool.size < Math.min(...this._allConcurrencyLimits);
-  }
-
-  /**
-   * Add a job to pool.
-   * @param {Promise<unknown>} job
-   * @param {number} concurrencyLimit
-   */
-  _addJob(job, concurrencyLimit) {
-    this._promisePool.add(job);
-    this._allConcurrencyLimits.push(concurrencyLimit);
-  }
-
-  /**
-   * Remove a job from pool.
-   * @param {Promise<unknown>} job
-   * @param {number} concurrencyLimit
-   */
-  _removeJob(job, concurrencyLimit) {
-    this._promisePool.delete(job);
-
-    const limitIndex = this._allConcurrencyLimits.indexOf(concurrencyLimit);
-    if (limitIndex === -1) {
-      throw new Error('No current limit found for finishing job');
-    }
-    this._allConcurrencyLimits.splice(limitIndex, 1);
-  }
-
-  /**
-   * Runs callbackfn on `values` in parallel, at a max of `concurrency` at
-   * a time across all callers on this instance. Resolves to an array of the
-   * results (for each caller separately) or rejects with the first rejected
-   * result. Default `concurrency` limit is `Infinity`.
-   * @template T, U
-   * @param {Array<T>} values
-   * @param {(value: T, index: number, array: Array<T>) => Promise<U>} callbackfn
-   * @param {{concurrency: number}} [options]
-   * @return {Promise<Array<U>>}
-   */
-  async pooledMap(values, callbackfn, options = {concurrency: Infinity}) {
-    const {concurrency} = options;
-    const result = [];
-
-    for (let i = 0; i < values.length; i++) {
-      // Wait until concurrency allows another run.
-      while (!this._canRunMoreAtLimit(concurrency)) {
-        // Unconditionally catch since we only care about our own failures
-        // (caught in the Promise.all below), not other callers.
-        await Promise.race(this._promisePool).catch(() => {});
-      }
-
-      // innerPromise removes itself from the pool and resolves on return from callback.
-      const innerPromise = callbackfn(values[i], i, values)
-        .finally(() => this._removeJob(innerPromise, concurrency));
-
-      this._addJob(innerPromise, concurrency);
-      result.push(innerPromise);
-    }
-
-    return Promise.all(result);
-  }
-
-  /**
-   * Runs `fn` concurrent to other operations in the pool, at a max of
-   * `concurrency` at a time across all callers on this instance. Default
-   * `concurrency` limit is `Infinity`.
-   * @template U
-   * @param {() => Promise<U>} fn
-   * @param {{concurrency: number}} [options]
-   * @return {Promise<U>}
-   */
-  async runInPool(fn, options = {concurrency: Infinity}) {
-    // Let pooledMap handle the pool management for the cost of boxing a fake `value`.
-    const result = await this.pooledMap([''], fn, options);
-    return result[0];
-  }
-}
-
-export {ConcurrentMapper};

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

@@ -1,51 +0,0 @@
-/**
- * @license Copyright 2019 The Lighthouse Authors. All Rights Reserved.
- * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
- * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
- */
-'use strict';
-
-/**
- * A simple buffered log to use in place of `console`.
- */
-class LocalConsole {
-  constructor() {
-    this._log = '';
-  }
-
-  /**
-   * @param {string} str
-   */
-  log(str) {
-    this._log += str + '\n';
-  }
-
-  /**
-   * Log but without the ending newline.
-   * @param {string} str
-   */
-  write(str) {
-    this._log += str;
-  }
-
-  /**
-   * @return {string}
-   */
-  getLog() {
-    return this._log;
-  }
-
-  /**
-   * Append a stdout and stderr to this log.
-   * @param {{stdout: string, stderr: string}} stdStrings
-   */
-  adoptStdStrings(stdStrings) {
-    this.write(stdStrings.stdout);
-    // stderr accrues many empty lines. Don't log unless there's content.
-    if (/\S/.test(stdStrings.stderr)) {
-      this.write(stdStrings.stderr);
-    }
-  }
-}
-
-export {LocalConsole};

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

@@ -1,68 +0,0 @@
-/**
- * @license Copyright 2019 The Lighthouse Authors. All Rights Reserved.
- * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
- * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
- */
-'use strict';
-
-/**
- * @fileoverview  A runner that launches Chrome and executes Lighthouse via a
- * bundle to test that bundling has produced correct and runnable code.
- * Currently uses `lighthouse-dt-bundle.js`.
- */
-
-import fs from 'fs';
-
-import ChromeLauncher from 'chrome-launcher';
-
-import ChromeProtocol from '../../../../lighthouse-core/gather/connections/cri.js';
-import {LH_ROOT} from '../../../../root.js';
-
-const originalRequire = global.require;
-if (typeof globalThis === 'undefined') {
-  // @ts-expect-error - exposing for loading of dt-bundle.
-  global.globalThis = global;
-}
-
-// Load bundle, which creates a `global.runBundledLighthouse`.
-eval(fs.readFileSync(LH_ROOT + '/dist/lighthouse-dt-bundle.js', 'utf-8'));
-
-global.require = originalRequire;
-
-/** @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.
- * @param {string} url
- * @param {LH.Config.Json=} configJson
- * @param {{isDebug?: 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);
-    if (!runnerResult) throw new Error('No runnerResult');
-
-    return {
-      lhr: runnerResult.lhr,
-      artifacts: runnerResult.artifacts,
-      log: '', // TODO: if want to run in parallel, need to capture lighthouse-logger output.
-    };
-  } finally {
-    // Clean up and return results.
-    await launchedChrome.kill();
-  }
-}
-
-export {
-  runLighthouse,
-};