lighthouse 9.5.0-dev.20220728 → 9.5.0-dev.20220731

package/CONTRIBUTING.md

@@ -33,13 +33,13 @@ If proposing a new audit for Lighthouse, see the [new audit proposal guide](./do
 
 A PR for a new audit or changing an existing audit almost always needs the following:
 
-1. If new, add the audit to the [default config file](lighthouse-core/config/default-config.js) (or, rarely, one of the other config files) so Lighthouse will run it.
+1. If new, add the audit to the [default config file](core/config/default-config.js) (or, rarely, one of the other config files) so Lighthouse will run it.
 
-1. **Unit tests**: in the matching test file (e.g. tests for `lighthouse-core/audits/my-swell-audit.js` go in `lighthouse-core/test/audits/my-swell-audit-test.js`).
+1. **Unit tests**: in the matching test file (e.g. tests for `core/audits/my-swell-audit.js` go in `core/test/audits/my-swell-audit-test.js`).
 
-1. **Smoke (end-to-end) tests**: search through the [existing test expectations](lighthouse-cli/test/smokehouse/test-definitions/) to see if there's a logical place to add a check for your change, or (as a last resort) add a new smoke test.
+1. **Smoke (end-to-end) tests**: search through the [existing test expectations](cli/test/smokehouse/test-definitions/) to see if there's a logical place to add a check for your change, or (as a last resort) add a new smoke test.
 
-1. Run `yarn update:sample-json` to update the [sample Lighthouse result JSON](lighthouse-core/test/results/sample_v2.json) kept in the repo for testing. This will also pull any strings needed for localization into the correct files.
+1. Run `yarn update:sample-json` to update the [sample Lighthouse result JSON](core/test/results/sample_v2.json) kept in the repo for testing. This will also pull any strings needed for localization into the correct files.
 
 ### Audit `description` Guidelines
 
@@ -68,13 +68,13 @@ It can be tempting to serialize the entire state of the world into the artifact
 
 A PR adding or changing a gatherer almost always needs to include the following:
 
-1. If new, add the gatherer to the [default config file](lighthouse-core/config/default-config.js) (or, rarely, one of the other config files) so Lighthouse will run it.
+1. If new, add the gatherer to the [default config file](core/config/default-config.js) (or, rarely, one of the other config files) so Lighthouse will run it.
 
 1. **Unit tests**: gatherer execution often takes place mostly on the browser side, either through protocol functionality or executing javascript in the test page. This makes gatherers difficult to unit test without extensive mocking, ending up mostly exercising the mocks instead of the actual gatherer.
 
-   As a result, we mostly rely on smoke testing for gatherers. However, if there are parts of a gatherer that naturally lend themselves to unit testing, the new tests would go in the matching test file (e.g. tests for `lighthouse-core/gather/gatherers/reap.js` go in `lighthouse-core/test/gather/gatherers/reap-test.js`).
+   As a result, we mostly rely on smoke testing for gatherers. However, if there are parts of a gatherer that naturally lend themselves to unit testing, the new tests would go in the matching test file (e.g. tests for `core/gather/gatherers/reap.js` go in `core/test/gather/gatherers/reap-test.js`).
 
-1. **Smoke (end-to-end) tests**: search through the [existing test expectations](lighthouse-cli/test/smokehouse/test-definitions/) to see if there's a logical place to add a check for your change, or (as a last resort) add a new smoke test if one is required.
+1. **Smoke (end-to-end) tests**: search through the [existing test expectations](cli/test/smokehouse/test-definitions/) to see if there's a logical place to add a check for your change, or (as a last resort) add a new smoke test if one is required.
 
    It's most important to get true end-to-end coverage, so be sure that audits that consume the new gatherer output are in the expectations. Artifacts can also have expectations for those intermediate results.
 
@@ -87,7 +87,7 @@ A PR adding or changing a gatherer almost always needs to include the following:
 
    This command works for updating `yarn update:sample-artifacts devtoolsLogs` or `traces` as well, but the resulting `sample_v2.json` churn may be extensive and you might be better off editing manually.
 
-1. Run `yarn update:sample-json` to update the [sample Lighthouse result JSON](lighthouse-core/test/results/sample_v2.json) kept in the repo for testing. This will also pull any strings needed for localization into the correct files.
+1. Run `yarn update:sample-json` to update the [sample Lighthouse result JSON](core/test/results/sample_v2.json) kept in the repo for testing. This will also pull any strings needed for localization into the correct files.
 
 ## Protobuf errors
 
@@ -128,13 +128,13 @@ accept your pull requests.
 
 ## Tracking Errors
 
-We track our errors in the wild with Sentry. In general, do not worry about wrapping your audits or gatherers in try/catch blocks and reporting every error that could possibly occur; `lighthouse-core/runner.js` and `lighthouse-core/gather/gather-runner.js` already catch and report any errors that occur while running a gatherer or audit, including errors fatal to the entire run. However, there are some situations when you might want to explicitly handle an error and report it to Sentry or wrap it to avoid reporting. Generally, you can interact with Sentry simply by requiring the `lighthouse-core/lib/sentry.js` file and call its methods. The module exports a delegate that will correctly handle the error reporting based on the user's opt-in preference and will simply no-op if they haven't so you don't need to check.
+We track our errors in the wild with Sentry. In general, do not worry about wrapping your audits or gatherers in try/catch blocks and reporting every error that could possibly occur; `core/runner.js` and `core/gather/gather-runner.js` already catch and report any errors that occur while running a gatherer or audit, including errors fatal to the entire run. However, there are some situations when you might want to explicitly handle an error and report it to Sentry or wrap it to avoid reporting. Generally, you can interact with Sentry simply by requiring the `core/lib/sentry.js` file and call its methods. The module exports a delegate that will correctly handle the error reporting based on the user's opt-in preference and will simply no-op if they haven't so you don't need to check.
 
 
 #### If you have an expected error that is recoverable but want to track how frequently it happens, *use Sentry.captureException*.
 
 ```js
-const Sentry = require('./lighthouse-core/lib/sentry');
+const Sentry = require('./core/lib/sentry');
 
 try {
   doRiskyThing();
@@ -152,7 +152,7 @@ try {
 NOTE: If the message you're capturing is dynamic/based on user data or you need a stack trace, then create a fake error instead and use `Sentry.captureException` so that the instances will be grouped together in Sentry.
 
 ```js
-const Sentry = require('./lighthouse-core/lib/sentry');
+const Sentry = require('./core/lib/sentry');
 
 if (networkRecords.length === 1) {
   Sentry.captureMessage('Site only had 1 network request', {level: 'info'});

package/{lighthouse-cli → cli}/bin.js

@@ -10,7 +10,7 @@
  *   index.js     : only calls bin.js's begin()
  *   cli-flags.js : leverages yargs to read argv, outputs LH.CliFlags
  *   bin.js       : CLI args processing. cwd, list/print commands
- *   run.js       : chrome-launcher bits, calling lighthouse-core, output to Printer
+ *   run.js       : chrome-launcher bits, calling core, output to Printer
  *
  *   index ---->    bin    ---->      run      ----> printer
  *                  ⭏  ⭎               ⭏  ⭎
@@ -27,11 +27,11 @@ 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 {generateConfig, generateLegacyConfig} from '../lighthouse-core/index.js';
+import {generateConfig, generateLegacyConfig} from '../core/index.js';
 import {askPermission} from './sentry-prompt.js';
 import {LH_ROOT} from '../root.js';
-import {Sentry} from '../lighthouse-core/lib/sentry.js';
-import {getConfigDisplayString} from '../lighthouse-core/fraggle-rock/config/config.js';
+import {Sentry} from '../core/lib/sentry.js';
+import {getConfigDisplayString} from '../core/fraggle-rock/config/config.js';
 
 const pkg = JSON.parse(fs.readFileSync(LH_ROOT + '/package.json', 'utf-8'));
 
@@ -78,7 +78,7 @@ async function begin() {
       configJson = (await import(configModuleUrl)).default;
     }
   } else if (cliFlags.preset) {
-    configJson = (await import(`../lighthouse-core/config/${cliFlags.preset}-config.js`)).default;
+    configJson = (await import(`../core/config/${cliFlags.preset}-config.js`)).default;
   }
 
   if (cliFlags.budgetPath) {

package/{lighthouse-cli → cli}/cli-flags.js

@@ -133,7 +133,7 @@ function getYargsParser(manualArgv) {
       'config-path': {
         type: 'string',
         describe: `The path to the config JSON.
-          An example config file: lighthouse-core/config/lr-desktop-config.js`,
+          An example config file: core/config/lr-desktop-config.js`,
       },
       'preset': {
         type: 'string',

package/{lighthouse-cli → cli}/commands/list-audits.js

@@ -4,7 +4,7 @@
  * 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.
  */
 
-import {getAuditList} from '../../lighthouse-core/index.js';
+import {getAuditList} from '../../core/index.js';
 
 function listAudits() {
   const audits = getAuditList().map((i) => i.replace(/\.js$/, ''));

package/{lighthouse-cli → cli}/commands/list-trace-categories.js

@@ -4,7 +4,7 @@
  * 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.
  */
 
-import {traceCategories} from '../../lighthouse-core/index.js';
+import {traceCategories} from '../../core/index.js';
 
 function listTraceCategories() {
   process.stdout.write(JSON.stringify({traceCategories}));

package/{lighthouse-cli → cli}/run.js

@@ -15,10 +15,10 @@ import log from 'lighthouse-logger';
 import open from 'open';
 
 import * as Printer from './printer.js';
-import lighthouse, {legacyNavigation} from '../lighthouse-core/index.js';
+import lighthouse, {legacyNavigation} from '../core/index.js';
 import {getLhrFilenamePrefix} 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';
+import * as assetSaver from '../core/lib/asset-saver.js';
+import URL from '../core/lib/url-shim.js';
 
 /** @typedef {Error & {code: string, friendlyMessage?: string}} ExitError */
 

package/{lighthouse-cli → cli}/test/smokehouse/frontends/smokehouse-bin.js

@@ -26,7 +26,7 @@ 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');
+  path.join(LH_ROOT, 'cli/test/smokehouse/core-tests.js');
 
 /**
  * Possible Lighthouse runners. Loaded dynamically so e.g. a CLI run isn't

package/{lighthouse-cli → cli}/test/smokehouse/lighthouse-runners/bundle.js

@@ -19,9 +19,9 @@ import {once} from 'events';
 import puppeteer from 'puppeteer-core';
 import ChromeLauncher from 'chrome-launcher';
 
-import {CriConnection} from '../../../../lighthouse-core/gather/connections/cri.js';
+import {CriConnection} from '../../../../core/gather/connections/cri.js';
 import {LH_ROOT} from '../../../../root.js';
-import {loadArtifacts, saveArtifacts} from '../../../../lighthouse-core/lib/asset-saver.js';
+import {loadArtifacts, saveArtifacts} from '../../../../core/lib/asset-saver.js';
 
 // This runs only in the worker. The rest runs on the main thread.
 if (!isMainThread && parentPort) {
@@ -68,11 +68,11 @@ async function runBundledLighthouse(url, configJson, testRunnerOptions) {
   global.require = originalRequire;
   global.Buffer = originalBuffer;
 
-  /** @type {import('../../../../lighthouse-core/index.js')['default']} */
+  /** @type {import('../../../../core/index.js')['default']} */
   // @ts-expect-error - not worth giving test global an actual type.
   const lighthouse = global.runBundledLighthouse;
 
-  /** @type {import('../../../../lighthouse-core/index.js')['legacyNavigation']} */
+  /** @type {import('../../../../core/index.js')['legacyNavigation']} */
   // @ts-expect-error - not worth giving test global an actual type.
   const legacyNavigation = global.runBundledLighthouseLegacyNavigation;
 

package/{lighthouse-cli → cli}/test/smokehouse/lighthouse-runners/cli.js

@@ -17,7 +17,7 @@ import {execFile} from 'child_process';
 
 import log from 'lighthouse-logger';
 
-import * as assetSaver from '../../../../lighthouse-core/lib/asset-saver.js';
+import * as assetSaver from '../../../../core/lib/asset-saver.js';
 import {LocalConsole} from '../lib/local-console.js';
 import {ChildProcessError} from '../lib/child-process-error.js';
 import {LH_ROOT} from '../../../../root.js';
@@ -57,7 +57,7 @@ async function internalRun(url, tmpPath, configJson, options) {
   const artifactsDirectory = `${tmpPath}/artifacts/`;
 
   const args = [
-    `${LH_ROOT}/lighthouse-cli/index.js`,
+    `${LH_ROOT}/cli/index.js`,
     `${url}`,
     `--output-path=${outputPath}`,
     '--output=json',

package/{lighthouse-cli → cli}/test/smokehouse/lighthouse-runners/devtools.js

@@ -13,7 +13,7 @@ import os from 'os';
 import {execFileSync} from 'child_process';
 
 import {LH_ROOT} from '../../../../root.js';
-import {testUrlFromDevtools} from '../../../../lighthouse-core/scripts/pptr-run-devtools.js';
+import {testUrlFromDevtools} from '../../../../core/scripts/pptr-run-devtools.js';
 
 const devtoolsDir =
   process.env.DEVTOOLS_PATH || `${LH_ROOT}/.tmp/chromium-web-tests/devtools/devtools-frontend`;
@@ -26,11 +26,11 @@ async function setup() {
 
   process.env.DEVTOOLS_PATH = devtoolsDir;
   execFileSync('bash',
-    ['lighthouse-core/test/devtools-tests/download-devtools.sh'],
+    ['core/test/devtools-tests/download-devtools.sh'],
     {stdio: 'inherit'}
   );
   execFileSync('bash',
-    ['lighthouse-core/test/devtools-tests/roll-devtools.sh'],
+    ['core/test/devtools-tests/roll-devtools.sh'],
     {stdio: 'inherit'}
   );
 }

package/{lighthouse-cli → cli}/test/smokehouse/readme.md

@@ -6,7 +6,7 @@ By default this is done using the Lighthouse CLI (to exercise the full pipeline)
 
 ## Options
 
-See [`SmokehouseOptions`](https://github.com/GoogleChrome/lighthouse/blob/master/lighthouse-cli/test/smokehouse/smokehouse.js#L23).
+See [`SmokehouseOptions`](https://github.com/GoogleChrome/lighthouse/blob/master/cli/test/smokehouse/smokehouse.js#L23).
 
 ## Test definitions
 

package/{lighthouse-cli → cli}/test/smokehouse/report-assert-test.js

@@ -6,7 +6,7 @@
 
 /* eslint-disable no-control-regex */
 
-import {readJson} from '../../../lighthouse-core/test/test-utils.js';
+import {readJson} from '../../../core/test/test-utils.js';
 import {findDifferences, getAssertionReport} from './report-assert.js';
 
 describe('findDiffersences', () => {
@@ -193,8 +193,8 @@ function clean(text) {
 }
 
 describe('getAssertionReport', () => {
-  const lhr = readJson('lighthouse-core/test/results/sample_v2.json');
-  const artifacts = readJson('lighthouse-core/test/results/artifacts/artifacts.json');
+  const lhr = readJson('core/test/results/sample_v2.json');
+  const artifacts = readJson('core/test/results/artifacts/artifacts.json');
 
   it('works (trivial passing)', () => {
     const report = getAssertionReport({lhr, artifacts}, {

package/{lighthouse-core → core}/audits/byte-efficiency/legacy-javascript.js

@@ -9,7 +9,7 @@
  * @fileoverview Identifies polyfills and transforms that should not be present if using module/nomodule pattern.
  * @see https://docs.google.com/document/d/1ItjJwAd6e0Ts6yMbvh8TN3BBh_sAd58rYE1whnpuxaA/edit Design document
  * @see https://docs.google.com/spreadsheets/d/1z28Au8wo8-c2UsM2lDVEOJcI3jOkb2c951xEBqzBKCc/edit?usp=sharing Legacy babel transforms / polyfills
- * ./lighthouse-core/scripts/legacy-javascript - verification tool.
+ * ./core/scripts/legacy-javascript - verification tool.
  */
 
 /** @typedef {{name: string, expression: string, estimateBytes?: (result: PatternMatchResult) => number}} Pattern */
@@ -29,7 +29,7 @@ import {getRequestForScript} from '../../lib/script-helpers.js';
 import {LH_ROOT} from '../../../root.js';
 
 const graphJson = fs.readFileSync(
-  `${LH_ROOT}/lighthouse-core/audits/byte-efficiency/polyfill-graph-data.json`, 'utf-8');
+  `${LH_ROOT}/core/audits/byte-efficiency/polyfill-graph-data.json`, 'utf-8');
 
 /** @type {import('../../scripts/legacy-javascript/create-polyfill-size-estimation.js').PolyfillSizeEstimator} */
 const graph = JSON.parse(graphJson);