lighthouse 9.5.0-dev.20220509 → 9.6.1

package/shared/test/localization/format-test.js

@@ -12,6 +12,8 @@ const i18n = require('../../../lighthouse-core/lib/i18n/i18n.js');
 const constants = require('../../../lighthouse-core/config/constants.js');
 const locales = require('../../localization/locales.js');
 
+/* eslint-env jest */
+
 describe('format', () => {
   describe('DEFAULT_LOCALE', () => {
     it('is the same as the default config locale', () => {

package/shared/test/localization/locales-test.js

@@ -8,6 +8,8 @@
 const locales = require('../../localization/locales.js');
 const assert = require('assert').strict;
 
+/* eslint-env jest */
+
 describe('locales', () => {
   it('has only canonical (or expected-deprecated) language tags', () => {
     // Map of deprecated codes to their canonical version. Depending on the ICU

package/shared/test/localization/swap-locale-test.js

@@ -8,6 +8,8 @@
 const swapLocale = require('../../localization/swap-locale.js');
 
 const lhr = require('../../../lighthouse-core/test/results/sample_v2.json');
+
+/* eslint-env jest */
 describe('swap-locale', () => {
   it('does not mutate the original lhr', () => {
     /** @type {LH.Result} */

package/third-party/chromium-synchronization/inspector-issueAdded-types-test.js

@@ -13,6 +13,8 @@ const inspectorIssuesGathererPath = LH_ROOT +
   '/lighthouse-core/gather/gatherers/inspector-issues.js';
 const inspectorIssuesGathererSource = fs.readFileSync(inspectorIssuesGathererPath, 'utf-8');
 
+/* eslint-env jest */
+
 describe('issueAdded types', () => {
   /** @type {Array<LH.Crdp.Audits.InspectorIssueDetails>} */
   let inspectorIssueDetailsTypes;

package/third-party/chromium-synchronization/installability-errors-test.js

@@ -9,6 +9,8 @@ const fetch = require('node-fetch');
 
 const InstallableManifestAudit = require('../../lighthouse-core/audits/installable-manifest.js');
 
+/* eslint-env jest */
+
 jest.setTimeout(20_000);
 
 describe('installabilityErrors', () => {

package/tsconfig.json

@@ -11,7 +11,6 @@
     {"path": "./report/"},
     {"path": "./report/generator/"},
     {"path": "./shared/"},
-    {"path": "./treemap/"},
   ],
   "include": [
     "root.js",

package/types/artifacts.d.ts

@@ -66,7 +66,7 @@ interface UniversalBaseArtifacts {
  */
 interface ContextualBaseArtifacts {
   /** The URL initially requested and the post-redirects URL that was actually loaded. */
-  URL: Artifacts.URL;
+  URL: {requestedUrl: string, finalUrl: string};
   /** If loading the page failed, value is the error that caused it. Otherwise null. */
   PageLoadError: LighthouseError | null;
 }
@@ -147,9 +147,8 @@ export interface GathererArtifacts extends PublicGathererArtifacts,LegacyBaseArt
   GlobalListeners: Array<Artifacts.GlobalListener>;
   /** The issues surfaced in the devtools Issues panel */
   InspectorIssues: Artifacts.InspectorIssues;
-  /** JS coverage information for code used during audit. Keyed by script id. */
-  // 'url' is excluded because it can be overriden by a magic sourceURL= comment, which makes keeping it a dangerous footgun!
-  JsUsage: Record<string, Omit<LH.Crdp.Profiler.ScriptCoverage, 'url'>>;
+  /** JS coverage information for code used during page load. Keyed by network URL. */
+  JsUsage: Record<string, Array<Omit<LH.Crdp.Profiler.ScriptCoverage, 'url'>>>;
   /** Parsed version of the page's Web App Manifest, or null if none found. */
   Manifest: Artifacts.Manifest | null;
   /** The URL loaded with interception */
@@ -162,8 +161,6 @@ export interface GathererArtifacts extends PublicGathererArtifacts,LegacyBaseArt
   ResponseCompression: {requestId: string, url: string, mimeType: string, transferSize: number, resourceSize: number, gzipSize?: number}[];
   /** Information on fetching and the content of the /robots.txt file. */
   RobotsTxt: {status: number|null, content: string|null, errorMessage?: string};
-  /** Information on all scripts in the page. */
-  Scripts: Artifacts.Script[];
   /** Version information for all ServiceWorkers active after the first page load. */
   ServiceWorker: {versions: LH.Crdp.ServiceWorker.ServiceWorkerVersion[], registrations: LH.Crdp.ServiceWorker.ServiceWorkerRegistration[]};
   /** Source maps of scripts executed in the page. */
@@ -187,27 +184,6 @@ declare module Artifacts {
   type TaskNode = _TaskNode;
   type MetaElement = Artifacts['MetaElements'][0];
 
-  interface URL {
-    /** URL of the main frame before Lighthouse starts. */
-    initialUrl: string;
-    /**
-     * URL of the initially requested URL during a Lighthouse navigation.
-     * Will be `undefined` in timespan/snapshot.
-     */
-    requestedUrl?: string;
-    /**
-     * URL of the last document request during a Lighthouse navigation.
-     * Will be `undefined` in timespan/snapshot.
-     */
-    mainDocumentUrl?: string;
-    /**
-     * Will be the same as `mainDocumentUrl` in navigation mode.
-     * Wil be the URL of the main frame after Lighthouse finishes in timespan/snapshot.
-     * TODO: Use the main frame URL in navigation mode as well.
-     */
-    finalUrl: string;
-  }
-
   interface NodeDetails {
     lhId: string,
     devtoolsNodePath: string,
@@ -238,7 +214,6 @@ declare module Artifacts {
   interface Accessibility {
     violations: Array<AxeRuleResult>;
     notApplicable: Array<Pick<AxeRuleResult, 'id'>>;
-    passes: Array<Pick<AxeRuleResult, 'id'>>;
     incomplete: Array<AxeRuleResult>;
     version: string;
   }
@@ -252,7 +227,6 @@ declare module Artifacts {
     name: string;
     publicId: string;
     systemId: string;
-    documentCompatMode: string;
   }
 
   interface DOMStats {
@@ -313,16 +287,6 @@ declare module Artifacts {
 
   interface PasswordInputsWithPreventedPaste {node: NodeDetails}
 
-  interface Script extends Omit<LH.Crdp.Debugger.ScriptParsedEvent, 'url'|'embedderName'> {
-    /**
-     * Set by a sourceURL= magic comment if present, otherwise this is the same as the URL.
-     * Use this field for presentational purposes only.
-     */
-    name: string;
-    url: string;
-    content?: string;
-  }
-
   interface ScriptElement {
     type: string | null
     src: string | null
@@ -334,6 +298,10 @@ declare module Artifacts {
     node: NodeDetails | null
     /** Where the script was discovered, either in the head, the body, or network records. */
     source: 'head'|'body'|'network'
+    /** The content of the inline script or the network record with the matching URL, null if the script had a src and no network record could be found. */
+    content: string | null
+    /** The ID of the network request that matched the URL of the src or the main document if inline, null if no request could be found. */
+    requestId: string | null
   }
 
   /** @see https://sourcemaps.info/spec.html#h.qz3o9nc69um5 */
@@ -365,8 +333,6 @@ declare module Artifacts {
    * parsing the map, errorMessage will be defined instead of map.
    */
   type SourceMap = {
-    /** The DevTools protocol script identifier. */
-    scriptId: string;
     /** URL of code that source map applies to. */
     scriptUrl: string
     /** URL of the source map. undefined if from data URL. */
@@ -374,8 +340,6 @@ declare module Artifacts {
     /** Source map data structure. */
     map: RawSourceMap
   } | {
-    /** The DevTools protocol script identifier. */
-    scriptId: string;
     /** URL of code that source map applies to. */
     scriptUrl: string
     /** URL of the source map. undefined if from data URL. */
@@ -388,7 +352,7 @@ declare module Artifacts {
 
   interface Bundle {
     rawMap: RawSourceMap;
-    script: LH.Artifacts.Script;
+    script: ScriptElement;
     map: TextSourceMap;
     sizes: {
       // TODO(cjamcl): Rename to `sources`.
@@ -573,7 +537,7 @@ declare module Artifacts {
   }
 
   interface TraceElement {
-    traceEventType: 'largest-contentful-paint'|'layout-shift'|'animation';
+    traceEventType: 'largest-contentful-paint'|'layout-shift'|'animation'|'responsiveness';
     score?: number;
     node: NodeDetails;
     nodeId?: number;
@@ -642,7 +606,6 @@ declare module Artifacts {
     settings: Immutable<Config.Settings>;
     gatherContext: Artifacts['GatherContext'];
     simulator?: InstanceType<typeof LanternSimulator>;
-    URL: Artifacts['URL'];
   }
 
   interface MetricComputationData extends MetricComputationDataInput {
@@ -885,8 +848,6 @@ declare module Artifacts {
     stackTrace?: LH.Crdp.Runtime.StackTrace;
     /** The URL of the log/exception, if known. */
     url?: string;
-    /** The script id of the log/exception, if known. */
-    scriptId?: string;
     /** Line number in the script (0-indexed), if known. */
     lineNumber?: number;
     /** Column number in the script (0-indexed), if known. */

package/types/config.d.ts

@@ -66,8 +66,6 @@ declare module Config {
     settingsOverrides?: SharedFlagsSettings & Pick<LH.Flags, 'plugins'>;
     skipAboutBlank?: boolean;
     logLevel?: string;
-    hostname?: string;
-    port?: number;
   }
 
   interface SharedPassNavigationJson {

package/types/externs.d.ts

@@ -149,8 +149,8 @@ export interface CliFlags extends Flags {
   quiet: boolean;
   /** A flag to print the normalized config for the given config and options, then exit. */
   printConfig: boolean;
-  /** Use the legacy navigation runner to gather CLI results. */
-  legacyNavigation: boolean;
+  /** Use the new Fraggle Rock navigation runner to gather CLI results. */
+  fraggleRock: boolean;
   /** Path to the file where precomputed lantern data should be read from. */
   precomputedLanternDataPath?: string;
   /** Path to the file where precomputed lantern data should be written to. */

package/types/gatherer.d.ts

@@ -42,11 +42,12 @@ declare module Gatherer {
     defaultSession: FRProtocolSession;
     executionContext: ExecutionContext;
     fetcher: Fetcher;
-    url: () => Promise<string>;
   }
 
   /** The limited context interface shared between pre and post Fraggle Rock Lighthouse. */
   interface FRTransitionalContext<TDependencies extends DependencyKey = DefaultDependenciesKey> {
+    /** The URL of the page that is currently active. Might be `about:blank` in the before phases */
+    url: string;
     /** The gather mode Lighthouse is currently in. */
     gatherMode: GatherMode;
     /** The connection to the page being analyzed. */

package/types/global-lh.d.ts

@@ -22,7 +22,6 @@ import * as Settings from './lhr/settings';
 import StructuredData_ from './structured-data';
 import Treemap_ from './lhr/treemap';
 import UserFlow_ from './user-flow';
-import puppeteer from 'puppeteer-core';
 
 // Construct hierarchy of global types under the LH namespace.
 declare global {
@@ -30,8 +29,6 @@ declare global {
     export type ArbitraryEqualityMap = ArbitraryEqualityMap_;
     export type NavigationRequestor = string | (() => Promise<void> | void);
 
-    export import Puppeteer = puppeteer;
-
     // artifacts.d.ts
     export import Artifacts = Artifacts_.Artifacts;
     export import BaseArtifacts = Artifacts_.BaseArtifacts;

package/types/lhr/audit-details.d.ts

@@ -58,7 +58,9 @@ declare module Details {
 
   interface List {
     type: 'list';
-    items: SnippetValue[]
+    // NOTE: any `Details` type *should* be usable in `items`, but check
+    // styles/report-ui-features are good before adding.
+    items: Array<Table | DebugData>;
   }
 
   interface Opportunity {

package/types/lhr/lhr.d.ts

@@ -13,8 +13,8 @@ import {ConfigSettings} from './settings';
 interface Result {
   /** Gather mode used to collect artifacts for this result. */
   gatherMode: Result.GatherMode;
-  /** The URL that Lighthouse initially navigated to. Will be `undefined` in timespan/snapshot. */
-  requestedUrl?: string;
+  /** The URL that was supplied to Lighthouse and initially navigated to. */
+  requestedUrl: string;
   /** The post-redirects URL that Lighthouse loaded. */
   finalUrl: string;
   /** The ISO-8601 timestamp of when the results were generated. */

package/types/lhr/treemap.d.ts

@@ -10,6 +10,7 @@ import {Locale} from './settings';
 declare module Treemap {
   interface Options {
     lhr: {
+      requestedUrl: string;
       finalUrl: string;
       audits: {
         'script-treemap-data': AuditResult;

package/lighthouse-core/audits/script-elements-test-audit.js

@@ -1,30 +0,0 @@
-/**
- * @license Copyright 2022 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 This is a fake audit used exclusively in smoke tests to force inclusion of ScriptElements artifact.
- * It is included here for complex reasons in the way the bundled smoketests work.
- *
- * The smokehouse configs are evaluated first in the node CLI side (which requires an absolute path using LH_ROOT).
- * The smokehouse configs are then *re-evaluated* in the bundled context for execution by Lighthouse (which *cannot* use an absolute path using LH_ROOT).
- *
- * This mismatch in environment demands that the audit path in the config must be context-aware,
- * yet the require-graph for the config is included before even the CLI knows that it will be using
- * a bundled runner. Rather than force a massive smoketest architecture change, we include a harmless,
- * test-only audit in our core list instead.
- */
-
-module.exports = {
-  meta: {
-    id: 'script-elements-test-audit',
-    title: 'ScriptElements',
-    failureTitle: 'ScriptElements',
-    description: 'Audit to force the inclusion of ScriptElements artifact',
-    requiredArtifacts: ['ScriptElements'],
-  },
-  audit: () => ({score: 1}),
-};

package/lighthouse-core/gather/gatherers/scripts.js

@@ -1,154 +0,0 @@
-/**
- * @license Copyright 2022 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';
-
-const FRGatherer = require('../../fraggle-rock/gather/base-gatherer.js');
-
-/**
- * @template T, U
- * @param {Array<T>} values
- * @param {(value: T) => Promise<U>} promiseMapper
- * @param {boolean} runInSeries
- * @return {Promise<Array<U>>}
- */
-async function runInSeriesOrParallel(values, promiseMapper, runInSeries) {
-  if (runInSeries) {
-    const results = [];
-    for (const value of values) {
-      const result = await promiseMapper(value);
-      results.push(result);
-    }
-    return results;
-  } else {
-    const promises = values.map(promiseMapper);
-    return await Promise.all(promises);
-  }
-}
-
-/**
- * Returns true if the script was created via our own calls
- * to Runtime.evaluate.
- * @param {LH.Crdp.Debugger.ScriptParsedEvent} script
- */
-function isLighthouseRuntimeEvaluateScript(script) {
-  // Scripts created by Runtime.evaluate that run on the main session/frame
-  // result in an empty string for the embedderName.
-  // Or, it means the script was dynamically created (eval, new Function, onload, ...)
-  if (!script.embedderName) return true;
-
-  // Otherwise, when running our own code inside other frames, the embedderName
-  // is set to the frame's url. In that case, we rely on the special sourceURL that
-  // we set.
-  return script.hasSourceURL && script.url === '_lighthouse-eval.js';
-}
-
-/**
- * @fileoverview Gets JavaScript file contents.
- */
-class Scripts extends FRGatherer {
-  /** @type {LH.Gatherer.GathererMeta} */
-  meta = {
-    supportedModes: ['timespan', 'navigation'],
-  };
-
-  /** @type {LH.Crdp.Debugger.ScriptParsedEvent[]} */
-  _scriptParsedEvents = [];
-
-  /** @type {Array<string | undefined>} */
-  _scriptContents = [];
-
-  /** @type {string|null|undefined} */
-  _mainSessionId = null;
-
-  constructor() {
-    super();
-    this.onProtocolMessage = this.onProtocolMessage.bind(this);
-  }
-
-  /**
-   * @param {LH.Protocol.RawEventMessage} event
-   */
-  onProtocolMessage(event) {
-    // Go read the comments in network-recorder.js _findRealRequestAndSetSession.
-    let sessionId = event.sessionId;
-    if (this._mainSessionId === null) {
-      this._mainSessionId = sessionId;
-    }
-    if (this._mainSessionId === sessionId) {
-      sessionId = undefined;
-    }
-
-    // We want to ignore scripts from OOPIFs. In reality, this does more than block just OOPIFs,
-    // it also blocks scripts from the same origin but that happen to run in a different process,
-    // like a worker.
-    if (event.method === 'Debugger.scriptParsed' && !sessionId) {
-      if (!isLighthouseRuntimeEvaluateScript(event.params)) {
-        this._scriptParsedEvents.push(event.params);
-      }
-    }
-  }
-
-  /**
-   * @param {LH.Gatherer.FRTransitionalContext} context
-   */
-  async startInstrumentation(context) {
-    const session = context.driver.defaultSession;
-    session.addProtocolMessageListener(this.onProtocolMessage);
-    await session.sendCommand('Debugger.enable');
-  }
-
-  /**
-   * @param {LH.Gatherer.FRTransitionalContext} context
-   */
-  async stopInstrumentation(context) {
-    const session = context.driver.defaultSession;
-    const formFactor = context.baseArtifacts.HostFormFactor;
-
-    session.removeProtocolMessageListener(this.onProtocolMessage);
-
-    // Without this line the Debugger domain will be off in FR runner,
-    // because only the legacy gatherer has special handling for multiple,
-    // overlapped enabled/disable calls.
-    await session.sendCommand('Debugger.enable');
-
-    // If run on a mobile device, be sensitive to memory limitations and only
-    // request one at a time.
-    this._scriptContents = await runInSeriesOrParallel(
-      this._scriptParsedEvents,
-      ({scriptId}) => {
-        return session.sendCommand('Debugger.getScriptSource', {scriptId})
-          .then((resp) => resp.scriptSource)
-          .catch(() => undefined);
-      },
-      formFactor === 'mobile' /* runInSeries */
-    );
-    await session.sendCommand('Debugger.disable');
-  }
-
-  async getArtifact() {
-    /** @type {LH.Artifacts['Scripts']} */
-    const scripts = this._scriptParsedEvents.map((event, i) => {
-      // 'embedderName' and 'url' are confusingly named, so we rewrite them here.
-      // On the protocol, 'embedderName' always refers to the URL of the script (or HTML if inline).
-      // Same for 'url' ... except, magic "sourceURL=" comments will override the value.
-      // It's nice to display the user-provided value in Lighthouse, so we add a field 'name'
-      // to make it clear this is for presentational purposes.
-      // See https://chromium-review.googlesource.com/c/v8/v8/+/2317310
-      return {
-        name: event.url,
-        ...event,
-        // embedderName is optional on the protocol because backends like Node may not set it.
-        // For our purposes, it is always set. But just in case it isn't... fallback to the url.
-        url: event.embedderName || event.url,
-        content: this._scriptContents[i],
-      };
-    });
-
-    return scripts;
-  }
-}
-
-module.exports = Scripts;

package/report/test/.eslintrc.cjs

@@ -1,11 +0,0 @@
-/**
- * @license Copyright 2022 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.
- */
-
-module.exports = {
-  env: {
-    jest: true,
-  },
-};

package/shared/test/localization/.eslintrc.cjs

@@ -1,11 +0,0 @@
-/**
- * @license Copyright 2022 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.
- */
-
-module.exports = {
-  env: {
-    jest: true,
-  },
-};