lighthouse 11.7.0-dev.20240320 → 11.7.0-dev.20240322

package/CONTRIBUTING.md

@@ -79,8 +79,8 @@ A PR adding or changing a gatherer almost always needs to include the following:
 1. **Golden artifacts**: `sample_v2.json` is generated from a set of artifacts that come from running LH against `dbw_tester.html`. Those artifacts likely need to be updated after gatherer changes with `yarn update:sample-artifacts`, but limit to just the artifact being altered if possible. For example:
 
    ```sh
-   # update just the ScriptElements artifact
-   yarn update:sample-artifacts ScriptElements
+   # update just the Scripts artifact
+   yarn update:sample-artifacts Scripts
    ```
 
    This command works for updating `yarn update:sample-artifacts DevtoolsLog` or `Trace` as well, but the resulting `sample_v2.json` churn may be extensive and you might be better off editing manually.

package/core/audits/preload-fonts.d.ts

@@ -14,11 +14,7 @@ declare class PreloadFontsAudit extends Audit {
      * @param {LH.Audit.Context} context
      * @return {Promise<LH.Audit.Product>}
      */
-    static audit_(artifacts: LH.Artifacts, context: LH.Audit.Context): Promise<LH.Audit.Product>;
-    /**
-     * @return {Promise<LH.Audit.Product>}
-     */
-    static audit(): Promise<LH.Audit.Product>;
+    static audit(artifacts: LH.Artifacts, context: LH.Audit.Context): Promise<LH.Audit.Product>;
 }
 export namespace UIStrings {
     const title: string;

package/core/audits/preload-fonts.js

@@ -62,7 +62,7 @@ class PreloadFontsAudit extends Audit {
    * @param {LH.Audit.Context} context
    * @return {Promise<LH.Audit.Product>}
    */
-  static async audit_(artifacts, context) {
+  static async audit(artifacts, context) {
     const devtoolsLog = artifacts.devtoolsLogs[this.DEFAULT_PASS];
     const networkRecords = await NetworkRecords.request(devtoolsLog, context);
 
@@ -91,15 +91,6 @@ class PreloadFontsAudit extends Audit {
       notApplicable: optionalFontURLs.size === 0,
     };
   }
-
-  /**
-   * @return {Promise<LH.Audit.Product>}
-   */
-  static async audit() {
-    // Preload advice is on hold until https://github.com/GoogleChrome/lighthouse/issues/11960
-    // is resolved.
-    return {score: 1, notApplicable: true};
-  }
 }
 
 export default PreloadFontsAudit;

package/core/audits/uses-rel-preload.d.ts

@@ -45,11 +45,7 @@ declare class UsesRelPreloadAudit extends Audit {
      * @param {LH.Audit.Context} context
      * @return {Promise<LH.Audit.Product>}
      */
-    static audit_(artifacts: LH.Artifacts, context: LH.Audit.Context): Promise<LH.Audit.Product>;
-    /**
-     * @return {Promise<LH.Audit.Product>}
-     */
-    static audit(): Promise<LH.Audit.Product>;
+    static audit(artifacts: LH.Artifacts, context: LH.Audit.Context): Promise<LH.Audit.Product>;
 }
 export namespace UIStrings {
     const title: string;

package/core/audits/uses-rel-preload.js

@@ -209,7 +209,7 @@ class UsesRelPreloadAudit extends Audit {
    * @param {LH.Audit.Context} context
    * @return {Promise<LH.Audit.Product>}
    */
-  static async audit_(artifacts, context) {
+  static async audit(artifacts, context) {
     const trace = artifacts.traces[UsesRelPreloadAudit.DEFAULT_PASS];
     const devtoolsLog = artifacts.devtoolsLogs[UsesRelPreloadAudit.DEFAULT_PASS];
     const URL = artifacts.URL;
@@ -253,16 +253,6 @@ class UsesRelPreloadAudit extends Audit {
       warnings,
     };
   }
-
-  /**
-   * @return {Promise<LH.Audit.Product>}
-   */
-  static async audit() {
-    // Preload advice is on hold until https://github.com/GoogleChrome/lighthouse/issues/11960
-    // is resolved.
-    return {score: 1, notApplicable: true,
-      details: Audit.makeOpportunityDetails([], [], {overallSavingsMs: 0})};
-  }
 }
 
 export default UsesRelPreloadAudit;

package/core/computed/js-bundles.d.ts

@@ -1,6 +1,6 @@
 export { JSBundlesComputed as JSBundles };
 declare const JSBundlesComputed: typeof JSBundles & {
-    request: (dependencies: Pick<import("../index.js").Artifacts, "Scripts" | "SourceMaps">, context: import("../../types/utility-types.js").default.ImmutableObject<{
+    request: (dependencies: Pick<import("../index.js").Artifacts, "SourceMaps" | "Scripts">, context: import("../../types/utility-types.js").default.ImmutableObject<{
         computedCache: Map<string, import("../lib/arbitrary-equality-map.js").ArbitraryEqualityMap>;
     }>) => Promise<import("../index.js").Artifacts.Bundle[]>;
 };

package/core/computed/module-duplication.d.ts

@@ -1,6 +1,6 @@
 export { ModuleDuplicationComputed as ModuleDuplication };
 declare const ModuleDuplicationComputed: typeof ModuleDuplication & {
-    request: (dependencies: Pick<import("../index.js").Artifacts, "Scripts" | "SourceMaps">, context: import("../../types/utility-types.js").default.ImmutableObject<{
+    request: (dependencies: Pick<import("../index.js").Artifacts, "SourceMaps" | "Scripts">, context: import("../../types/utility-types.js").default.ImmutableObject<{
         computedCache: Map<string, import("../lib/arbitrary-equality-map.js").ArbitraryEqualityMap>;
     }>) => Promise<Map<string, {
         scriptId: string;

package/core/config/default-config.js

@@ -155,7 +155,6 @@ const defaultConfig = {
     {id: 'ResponseCompression', gatherer: 'dobetterweb/response-compression'},
     {id: 'RobotsTxt', gatherer: 'seo/robots-txt'},
     {id: 'ServiceWorker', gatherer: 'service-worker'},
-    {id: 'ScriptElements', gatherer: 'script-elements'},
     {id: 'Scripts', gatherer: 'scripts'},
     {id: 'SourceMaps', gatherer: 'source-maps'},
     {id: 'Stacks', gatherer: 'stacks'},
@@ -201,12 +200,10 @@ const defaultConfig = {
     'content-width',
     'image-aspect-ratio',
     'image-size-responsive',
-    'preload-fonts',
     'deprecations',
     'third-party-cookies',
     'mainthread-work-breakdown',
     'bootup-time',
-    'uses-rel-preload',
     'uses-rel-preconnect',
     'font-display',
     'diagnostics',
@@ -460,7 +457,6 @@ const defaultConfig = {
         {id: 'uses-rel-preconnect', weight: 0},
         {id: 'server-response-time', weight: 0},
         {id: 'redirects', weight: 0},
-        {id: 'uses-rel-preload', weight: 0},
         {id: 'uses-http2', weight: 0},
         {id: 'efficient-animated-content', weight: 0},
         {id: 'duplicated-javascript', weight: 0},
@@ -605,7 +601,6 @@ const defaultConfig = {
         {id: 'paste-preventing-inputs', weight: 3, group: 'best-practices-ux'},
         {id: 'image-aspect-ratio', weight: 1, group: 'best-practices-ux'},
         {id: 'image-size-responsive', weight: 1, group: 'best-practices-ux'},
-        {id: 'preload-fonts', weight: 1, group: 'best-practices-ux'},
         // Browser Compatibility
         {id: 'doctype', weight: 1, group: 'best-practices-browser-compat'},
         {id: 'charset', weight: 1, group: 'best-practices-browser-compat'},

package/core/config/experimental-config.js

@@ -14,13 +14,24 @@ const config = {
   extends: 'lighthouse:default',
   audits: [
     'autocomplete',
+    // Preload advice is on hold until https://github.com/GoogleChrome/lighthouse/issues/11960
+    'preload-fonts',
+    'uses-rel-preload',
   ],
   categories: {
+    // @ts-ignore: `title` is required in CategoryJson. setting to the same value as the default
+    // config is awkward - easier to omit the property here. Will defer to default config.
+    'performance': {
+      auditRefs: [
+        {id: 'uses-rel-preload', weight: 0},
+      ],
+    },
     // @ts-ignore: `title` is required in CategoryJson. setting to the same value as the default
     // config is awkward - easier to omit the property here. Will defer to default config.
     'best-practices': {
       auditRefs: [
         {id: 'autocomplete', weight: 0, group: 'best-practices-ux'},
+        {id: 'preload-fonts', weight: 0, group: 'best-practices-ux'},
       ],
     },
   },

package/core/config/metrics-to-audits.js

@@ -12,7 +12,6 @@ const fcpRelevantAudits = [
   'critical-request-chains',
   'uses-text-compression',
   'uses-rel-preconnect',
-  'uses-rel-preload',
   'font-display',
   'unminified-javascript',
   'unminified-css',
@@ -46,7 +45,6 @@ const clsRelevantAudits = [
   'layout-shifts',
   'non-composited-animations',
   'unsized-images',
-  // 'preload-fonts', // actually in BP, rather than perf
 ];
 
 const inpRelevantAudits = [

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "lighthouse",
   "type": "module",
-  "version": "11.7.0-dev.20240320",
+  "version": "11.7.0-dev.20240322",
   "description": "Automated auditing, performance metrics, and best practices for the web.",
   "main": "./core/index.js",
   "bin": {

package/types/artifacts.d.ts

@@ -89,8 +89,8 @@ interface PublicGathererArtifacts {
   LinkElements: Artifacts.LinkElement[];
   /** The values of the <meta> elements in the head. */
   MetaElements: Array<{name?: string, content?: string, property?: string, httpEquiv?: string, charset?: string, node: Artifacts.NodeDetails}>;
-  /** Information on all script elements in the page. Also contains the content of all requested scripts and the networkRecord requestId that contained their content. Note, HTML documents will have one entry per script tag, all with the same requestId. */
-  ScriptElements: Array<Artifacts.ScriptElement>;
+  /** Information on all scripts in the page. */
+  Scripts: Artifacts.Script[];
   /** The dimensions and devicePixelRatio of the loaded viewport. */
   ViewportDimensions: Artifacts.ViewportDimensions;
 }
@@ -146,8 +146,6 @@ export interface GathererArtifacts extends PublicGathererArtifacts {
   RobotsTxt: {status: number|null, content: string|null, errorMessage?: string};
   /** The result of calling the shared trace engine root cause analysis. */
   RootCauses: Artifacts.TraceEngineRootCauses;
-  /** Information on all scripts in the page. */
-  Scripts: Artifacts.Script[];
   /** Version information for all ServiceWorkers active after the first page load. */
   ServiceWorker: {versions: Crdp.ServiceWorker.ServiceWorkerVersion[], registrations: Crdp.ServiceWorker.ServiceWorkerRegistration[]};
   /** Source maps of scripts executed in the page. */

package/core/audits/script-elements-test-audit.d.ts

@@ -1,14 +0,0 @@
-declare namespace _default {
-    namespace meta {
-        const id: string;
-        const title: string;
-        const failureTitle: string;
-        const description: string;
-        const requiredArtifacts: string[];
-    }
-    function audit(): {
-        score: number;
-    };
-}
-export default _default;
-//# sourceMappingURL=script-elements-test-audit.d.ts.map

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

@@ -1,29 +0,0 @@
-/**
- * @license
- * Copyright 2022 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @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.
- */
-
-export default {
-  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/core/gather/gatherers/script-elements.d.ts

@@ -1,21 +0,0 @@
-export default ScriptElements;
-/**
- * @fileoverview Gets JavaScript file contents.
- */
-declare class ScriptElements extends BaseGatherer {
-    /** @type {LH.Gatherer.GathererMeta<'DevtoolsLog'>} */
-    meta: LH.Gatherer.GathererMeta<'DevtoolsLog'>;
-    /**
-     * @param {LH.Gatherer.Context} context
-     * @param {LH.Artifacts.NetworkRequest[]} networkRecords
-     * @return {Promise<LH.Artifacts['ScriptElements']>}
-     */
-    _getArtifact(context: LH.Gatherer.Context, networkRecords: LH.Artifacts.NetworkRequest[]): Promise<LH.Artifacts['ScriptElements']>;
-    /**
-     * @param {LH.Gatherer.Context<'DevtoolsLog'>} context
-     */
-    getArtifact(context: LH.Gatherer.Context<'DevtoolsLog'>): Promise<import("../../index.js").Artifacts.ScriptElement[]>;
-}
-import BaseGatherer from '../base-gatherer.js';
-import { NetworkRequest } from '../../lib/network-request.js';
-//# sourceMappingURL=script-elements.d.ts.map

package/core/gather/gatherers/script-elements.js

@@ -1,100 +0,0 @@
-/**
- * @license
- * Copyright 2017 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-import BaseGatherer from '../base-gatherer.js';
-import {NetworkRecords} from '../../computed/network-records.js';
-import {NetworkRequest} from '../../lib/network-request.js';
-import {pageFunctions} from '../../lib/page-functions.js';
-import DevtoolsLog from './devtools-log.js';
-
-/* global getNodeDetails */
-
-/**
- * @return {LH.Artifacts['ScriptElements']}
- */
-/* c8 ignore start */
-function collectAllScriptElements() {
-  /** @type {HTMLScriptElement[]} */
-  // @ts-expect-error - getElementsInDocument put into scope via stringification
-  const scripts = getElementsInDocument('script'); // eslint-disable-line no-undef
-
-  return scripts.map(script => {
-    return {
-      type: script.type || null,
-      src: script.src || null,
-      id: script.id || null,
-      async: script.async,
-      defer: script.defer,
-      source: script.closest('head') ? 'head' : 'body',
-      // @ts-expect-error - getNodeDetails put into scope via stringification
-      node: getNodeDetails(script),
-    };
-  });
-}
-/* c8 ignore stop */
-
-/**
- * @fileoverview Gets JavaScript file contents.
- */
-class ScriptElements extends BaseGatherer {
-  /** @type {LH.Gatherer.GathererMeta<'DevtoolsLog'>} */
-  meta = {
-    supportedModes: ['timespan', 'navigation'],
-    dependencies: {DevtoolsLog: DevtoolsLog.symbol},
-  };
-
-  /**
-   * @param {LH.Gatherer.Context} context
-   * @param {LH.Artifacts.NetworkRequest[]} networkRecords
-   * @return {Promise<LH.Artifacts['ScriptElements']>}
-   */
-  async _getArtifact(context, networkRecords) {
-    const executionContext = context.driver.executionContext;
-
-    const scripts = await executionContext.evaluate(collectAllScriptElements, {
-      args: [],
-      useIsolation: true,
-      deps: [
-        pageFunctions.getNodeDetails,
-        pageFunctions.getElementsInDocument,
-      ],
-    });
-
-    const scriptRecords = networkRecords
-      .filter(record => record.resourceType === NetworkRequest.TYPES.Script)
-      .filter(record => record.sessionTargetType === 'page');
-
-    for (let i = 0; i < scriptRecords.length; i++) {
-      const record = scriptRecords[i];
-
-      const matchedScriptElement = scripts.find(script => script.src === record.url);
-      if (!matchedScriptElement) {
-        scripts.push({
-          type: null,
-          src: record.url,
-          id: null,
-          async: false,
-          defer: false,
-          source: 'network',
-          node: null,
-        });
-      }
-    }
-
-    return scripts;
-  }
-
-  /**
-   * @param {LH.Gatherer.Context<'DevtoolsLog'>} context
-   */
-  async getArtifact(context) {
-    const devtoolsLog = context.dependencies.DevtoolsLog;
-    const networkRecords = await NetworkRecords.request(devtoolsLog, context);
-    return this._getArtifact(context, networkRecords);
-  }
-}
-
-export default ScriptElements;