lighthouse 11.7.0-dev.20240409 → 11.7.0-dev.20240411

package/types/artifacts.d.ts

@@ -16,6 +16,7 @@ import speedline from 'speedline-core';
 import * as CDTSourceMap from '../core/lib/cdt/generated/SourceMap.js';
 import {ArbitraryEqualityMap} from '../core/lib/arbitrary-equality-map.js';
 import type { TaskNode as _TaskNode } from '../core/lib/tracehouse/main-thread-tasks.js';
+import type {EnabledHandlers} from '../core/computed/trace-engine-result.js';
 import AuditDetails from './lhr/audit-details.js'
 import Config from './config.js';
 import Gatherer from './gatherer.js';
@@ -45,8 +46,6 @@ interface UniversalBaseArtifacts {
   LighthouseRunWarnings: Array<string | IcuMessage>;
   /** The benchmark index that indicates rough device class. */
   BenchmarkIndex: number;
-  /** Many benchmark indexes. Many. */
-  BenchmarkIndexes?: number[];
   /** An object containing information about the testing configuration used by Lighthouse. */
   settings: Config.Settings;
   /** The timing instrumentation of the gather portion of a run. */
@@ -79,18 +78,20 @@ interface ContextualBaseArtifacts {
 interface PublicGathererArtifacts {
   /** ConsoleMessages deprecation and intervention warnings, console API calls, and exceptions logged by Chrome during page load. */
   ConsoleMessages: Artifacts.ConsoleMessage[];
-  /** All the iframe elements in the page. */
-  IFrameElements: Artifacts.IFrameElement[];
-  /** The contents of the main HTML document network resource. */
-  MainDocumentContent: string;
+  /** The primary log of devtools protocol activity. */
+  DevtoolsLog: DevtoolsLog;
   /** Information on size and loading for all the images in the page. Natural size information for `picture` and CSS images is only available if the image was one of the largest 50 images. */
   ImageElements: Artifacts.ImageElement[];
   /** All the link elements on the page or equivalently declared in `Link` headers. @see https://html.spec.whatwg.org/multipage/links.html */
   LinkElements: Artifacts.LinkElement[];
+  /** The contents of the main HTML document network resource. */
+  MainDocumentContent: string;
   /** 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 scripts in the page. */
   Scripts: Artifacts.Script[];
+  /** The primary trace taken over the entire run. */
+  Trace: Trace;
   /** The dimensions and devicePixelRatio of the loaded viewport. */
   ViewportDimensions: Artifacts.ViewportDimensions;
 }
@@ -110,8 +111,6 @@ export interface GathererArtifacts extends PublicGathererArtifacts {
   CacheContents: string[];
   /** CSS coverage information for styles used by page's final state. */
   CSSUsage: {rules: Crdp.CSS.RuleUsage[], stylesheets: Artifacts.CSSStyleSheetInfo[]};
-  /** The primary log of devtools protocol activity. */
-  DevtoolsLog: DevtoolsLog;
   /** The log of devtools protocol activity if there was a page load error and Chrome navigated to a `chrome-error://` page. */
   DevtoolsLogError: DevtoolsLog;
   /** Information on the document's doctype(or null if not present), specifically the name, publicId, and systemId.
@@ -121,16 +120,14 @@ export interface GathererArtifacts extends PublicGathererArtifacts {
   DOMStats: Artifacts.DOMStats;
   /** Information on poorly sized font usage and the text affected by it. */
   FontSize: Artifacts.FontSize;
+  /** All the iframe elements in the page. */
+  IFrameElements: Artifacts.IFrameElement[];
   /** All the input elements, including associated form and label elements. */
   Inputs: {inputs: Artifacts.InputElement[]; forms: Artifacts.FormElement[]; labels: Artifacts.LabelElement[]};
   /** Screenshot of the entire page (rather than just the above the fold content). */
   FullPageScreenshot: LHResult.FullPageScreenshot | null;
-  /** Information about event listeners registered on the global object. */
-  GlobalListeners: Array<Artifacts.GlobalListener>;
   /** The issues surfaced in the devtools Issues panel */
   InspectorIssues: Artifacts.InspectorIssues;
-  /** Errors preventing page being installable as PWA. */
-  InstallabilityErrors: Artifacts.InstallabilityErrors;
   /** JS coverage information for code used during audit. Keyed by script id. */
   // 'url' is excluded because it can be overridden by a magic sourceURL= comment, which makes keeping it a dangerous footgun!
   JsUsage: Record<string, Omit<Crdp.Profiler.ScriptCoverage, 'url'>>;
@@ -150,18 +147,10 @@ export interface GathererArtifacts extends PublicGathererArtifacts {
   SourceMaps: Array<Artifacts.SourceMap>;
   /** Information on detected tech stacks (e.g. JS libraries) used by the page. */
   Stacks: Artifacts.DetectedStack[];
-  /** Information on <script> and <link> tags blocking first paint. */
-  TagsBlockingFirstPaint: Artifacts.TagBlockingFirstPaint[];
-  /** Information about tap targets including their position and size. */
-  TapTargets: Artifacts.TapTarget[];
-  /** The primary trace taken over the entire run. */
-  Trace: Trace;
   /** The trace if there was a page load error and Chrome navigated to a `chrome-error://` page. */
   TraceError: Trace;
   /** Elements associated with metrics (ie: Largest Contentful Paint element). */
   TraceElements: Artifacts.TraceElement[];
-  /** Parsed version of the page's Web App Manifest, or null if none found. */
-  WebAppManifest: Artifacts.Manifest | null;
   /** COMPAT: A set of traces, keyed by passName. */
   traces: {[passName: string]: Trace};
   /** COMPAT: A set of DevTools debugger protocol records, keyed by passName. */
@@ -193,6 +182,8 @@ declare module Artifacts {
     finalDisplayedUrl: string;
   }
 
+  type Rect = AuditDetails.Rect;
+
   interface NodeDetails {
     lhId: string,
     devtoolsNodePath: string,
@@ -298,19 +289,6 @@ declare module Artifacts {
     content?: string;
   }
 
-  interface ScriptElement {
-    type: string | null
-    src: string | null
-    /** The `id` property of the script element; null if it had no `id` or if `source` is 'network'. */
-    id: string | null
-    async: boolean
-    defer: boolean
-    /** Details for node in DOM for the script element */
-    node: NodeDetails | null
-    /** Where the script was discovered, either in the head, the body, or network records. */
-    source: 'head'|'body'|'network'
-  }
-
   /** @see https://sourcemaps.info/spec.html#h.qz3o9nc69um5 */
   type RawSourceMap = {
     /** File version and must be a positive integer. */
@@ -436,10 +414,6 @@ declare module Artifacts {
   // TODO(bckenny): real type for parsed manifest.
   type Manifest = ReturnType<typeof parseManifest>;
 
-  interface InstallabilityErrors {
-    errors: Crdp.Page.InstallabilityError[];
-  }
-
   interface ImageElement {
     /** The resolved source URL of the image. Similar to `currentSrc`, but resolved for CSS images as well. */
     src: string;
@@ -527,27 +501,6 @@ declare module Artifacts {
     resourceSize: number;
   }
 
-  interface TagBlockingFirstPaint {
-    startTime: number;
-    endTime: number;
-    transferSize: number;
-    tag: {
-      tagName: 'LINK'|'SCRIPT';
-      /** The value of `HTMLLinkElement.href` or `HTMLScriptElement.src`. */
-      url: string;
-      /** A record of when changes to the `HTMLLinkElement.media` attribute occurred and if the new media type matched the page. */
-      mediaChanges?: Array<{href: string, media: string, msSinceHTMLEnd: number, matches: boolean}>;
-    };
-  }
-
-  type Rect = AuditDetails.Rect;
-
-  interface TapTarget {
-    node: NodeDetails;
-    href: string;
-    clientRects: Rect[];
-  }
-
   interface TraceElement {
     traceEventType: 'largest-contentful-paint'|'layout-shift'|'animation'|'responsiveness';
     node: NodeDetails;
@@ -556,7 +509,10 @@ declare module Artifacts {
     type?: string;
   }
 
-  type TraceEngineResult = TraceEngine.Handlers.Types.TraceParseData;
+  interface TraceEngineResult {
+    data: TraceEngine.Handlers.Types.EnabledHandlerDataWithMeta<EnabledHandlers>;
+    insights: TraceEngine.Insights.Types.TraceInsightData<EnabledHandlers>;
+  }
 
   interface TraceEngineRootCauses {
     layoutShifts: Record<number, LayoutShiftRootCausesData>;
@@ -601,25 +557,6 @@ declare module Artifacts {
     }
   }
 
-  type ManifestValueCheckID = 'hasStartUrl'|'hasIconsAtLeast144px'|'hasIconsAtLeast512px'|'fetchesIcon'|'hasPWADisplayValue'|'hasBackgroundColor'|'hasThemeColor'|'hasShortName'|'hasName'|'shortNameLength'|'hasMaskableIcon';
-
-  type ManifestValues = {
-    isParseFailure: false;
-    allChecks: {
-      id: ManifestValueCheckID;
-      failureText: string;
-      passing: boolean;
-    }[];
-  } | {
-    isParseFailure: true;
-    parseFailureReason: string;
-    allChecks: {
-      id: ManifestValueCheckID;
-      failureText: string;
-      passing: boolean;
-    }[];
-  }
-
   type MeasureEntry = LHResult.MeasureEntry;
 
   interface MetricComputationDataInput {
@@ -838,18 +775,6 @@ declare module Artifacts {
     node: NodeDetails;
   }
 
-  /** Information about an event listener registered on the global object. */
-  interface GlobalListener {
-    /** Event listener type, limited to those events currently of interest. */
-    type: 'pagehide'|'unload'|'visibilitychange';
-    /** The DevTools protocol script identifier. */
-    scriptId: string;
-    /** Line number in the script (0-based). */
-    lineNumber: number;
-    /** Column number in the script (0-based). */
-    columnNumber: number;
-  }
-
   /** Describes a generic console message. */
   interface BaseConsoleMessage {
     /**

package/types/audit.d.ts

@@ -117,16 +117,6 @@ declare module Audit {
 
   /** Type returned by Audit.audit(). Only score is required.  */
   type Product = NonNumericProduct | NumericProduct;
-
-  type MultiCheckAuditP1 = Partial<Record<Artifacts.ManifestValueCheckID, boolean>>;
-  type MultiCheckAuditP2 = Partial<Artifacts.ManifestValues>;
-  interface MultiCheckAuditP3 {
-    failures: Array<string>;
-    manifestValues?: undefined;
-    allChecks?: undefined;
-  }
-
-  type MultiCheckAuditDetails = MultiCheckAuditP1 & MultiCheckAuditP2 & MultiCheckAuditP3;
 }
 
 export default Audit;

package/types/internal/smokehouse.d.ts

@@ -33,7 +33,7 @@ declare global {
     }
 
     export interface TestDfn {
-      /** Identification of test. Can be used for group selection (e.g. `yarn smoke pwa` will run all tests with `id.includes('pwa')`). */
+      /** Identification of test. Can be used for group selection (e.g. `yarn smoke csp` will run all tests with `id.includes('csp')`). */
       id: string;
       /** Expected test results. */
       expectations: ExpectedRunnerResult;

package/types/lhr/lhr.d.ts

@@ -71,8 +71,6 @@ declare module Result {
     networkUserAgent: string;
     /** The benchmark index number that indicates rough device class. */
     benchmarkIndex: number;
-    /** Many benchmark indexes. */
-    benchmarkIndexes?: number[];
     /** The version of libraries with which these results were generated. Ex: axe-core. */
     credits?: Record<string, string|undefined>,
   }

package/core/audits/content-width.d.ts

@@ -1,17 +0,0 @@
-export default ContentWidth;
-declare class ContentWidth extends Audit {
-    /**
-     * @param {LH.Artifacts} artifacts
-     * @param {LH.Audit.Context} context
-     * @return {LH.Audit.Product}
-     */
-    static audit(artifacts: LH.Artifacts, context: LH.Audit.Context): LH.Audit.Product;
-}
-export namespace UIStrings {
-    const title: string;
-    const failureTitle: string;
-    const description: string;
-    const explanation: string;
-}
-import { Audit } from './audit.js';
-//# sourceMappingURL=content-width.d.ts.map

package/core/audits/content-width.js

@@ -1,76 +0,0 @@
-/**
- * @license
- * Copyright 2016 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-import {Audit} from './audit.js';
-import * as i18n from '../lib/i18n/i18n.js';
-
-const UIStrings = {
-  /** Title of a Lighthouse audit that provides detail on the content size of a web site compared to the viewport, which is the size of the screen the site is displayed on. This descriptive title is shown to users when the site's content is sized appropriately. */
-  title: 'Content is sized correctly for the viewport',
-  /** Title of a Lighthouse audit that provides detail on the content size of a web site compared to the viewport, which is the size of the screen the site is displayed on. This descriptive title is shown to users when the site's content is not sized appropriately. */
-  failureTitle: 'Content is not sized correctly for the viewport',
-  /** Description of a Lighthouse audit that tells the user why they should care that a site's content size should match its viewport size, which is the size of the screen the site is displayed on. This is displayed after a user expands the section to see more. No character length limits. The last sentence starting with 'Learn' becomes link text to additional documentation. */
-  description: 'If the width of your app\'s content doesn\'t match the width ' +
-    'of the viewport, your app might not be optimized for mobile screens. ' +
-    '[Learn how to size content for the viewport](https://developer.chrome.com/docs/lighthouse/pwa/content-width/).',
-  /**
-   * @description Explanatory message stating that the viewport size and window size differ.
-   * @example {100} innerWidth
-   * @example {101} outerWidth
-   * */
-  explanation: 'The viewport size of {innerWidth}px does not match the window ' +
-    'size of {outerWidth}px.',
-};
-
-const str_ = i18n.createIcuMessageFn(import.meta.url, UIStrings);
-
-class ContentWidth extends Audit {
-  /**
-   * @return {LH.Audit.Meta}
-   */
-  static get meta() {
-    return {
-      id: 'content-width',
-      title: str_(UIStrings.title),
-      failureTitle: str_(UIStrings.failureTitle),
-      description: str_(UIStrings.description),
-      requiredArtifacts: ['ViewportDimensions'],
-    };
-  }
-
-  /**
-   * @param {LH.Artifacts} artifacts
-   * @param {LH.Audit.Context} context
-   * @return {LH.Audit.Product}
-   */
-  static audit(artifacts, context) {
-    const viewportWidth = artifacts.ViewportDimensions.innerWidth;
-    const windowWidth = artifacts.ViewportDimensions.outerWidth;
-    const widthsMatch = viewportWidth === windowWidth;
-
-    if (context.settings.formFactor === 'desktop') {
-      return {
-        score: 1,
-        notApplicable: true,
-      };
-    }
-
-    let explanation;
-    if (!widthsMatch) {
-      explanation = str_(UIStrings.explanation,
-        {innerWidth: artifacts.ViewportDimensions.innerWidth,
-          outerWidth: artifacts.ViewportDimensions.outerWidth});
-    }
-
-    return {
-      score: Number(widthsMatch),
-      explanation,
-    };
-  }
-}
-
-export default ContentWidth;
-export {UIStrings};

package/core/audits/installable-manifest.d.ts

@@ -1,111 +0,0 @@
-export default InstallableManifest;
-/**
- * @fileoverview
- * Audits if the page's web app manifest and service worker qualify for triggering a beforeinstallprompt event.
- * https://github.com/GoogleChrome/lighthouse/issues/23#issuecomment-270453303
- *
- * Requirements based on Chrome Devtools' installability requirements.
- * Origin of logging:
- * https://source.chromium.org/chromium/chromium/src/+/main:chrome/browser/installable/installable_logging.cc
- * DevTools InstallabilityError implementation:
- * https://source.chromium.org/search?q=getInstallabilityErrorMessages&ss=chromium%2Fchromium%2Fsrc:third_party%2Fdevtools-frontend%2Fsrc%2Ffront_end%2Fresources%2F
- */
-declare class InstallableManifest extends Audit {
-    /**
-     * @param {LH.Artifacts} artifacts
-     * @return {{i18nErrors: Array<LH.IcuMessage | string>; warnings: Array<LH.IcuMessage>}}
-     */
-    static getInstallabilityErrors(artifacts: LH.Artifacts): {
-        i18nErrors: Array<LH.IcuMessage | string>;
-        warnings: Array<LH.IcuMessage>;
-    };
-    /**
-     * @param {LH.Artifacts} artifacts
-     * @param {LH.Audit.Context} context
-     * @return {Promise<LH.Audit.Product>}
-     *
-     */
-    static audit(artifacts: LH.Artifacts, context: LH.Audit.Context): Promise<LH.Audit.Product>;
-}
-export const UIStrings: {
-    /** Title of a Lighthouse audit that provides detail on if a website is installable as an application. This descriptive title is shown to users when a webapp is installable. */
-    title: string;
-    /** Title of a Lighthouse audit that provides detail on if a website is installable as an application. This descriptive title is shown to users when a webapp is not installable. */
-    failureTitle: string;
-    /** Description of a Lighthouse audit that tells the user why installability is important for webapps. This is displayed after a user expands the section to see more. No character length limits. The last sentence starting with 'Learn' becomes link text to additional documentation. */
-    description: string;
-    /** Label for a column in a data table; entries in the column will be a string explaining why a failure occurred. */
-    columnValue: string;
-    /**
-     * @description [ICU Syntax] Label for an audit identifying the number of installability errors found in the page.
-     */
-    displayValue: string;
-    /**
-     * @description Error message describing a DevTools error id that was found and has not been identified by this audit.
-     * @example {platform-not-supported-on-android} errorId
-     */
-    noErrorId: string;
-    /** Error message explaining that the page is not loaded in the frame.  */
-    'not-in-main-frame': string;
-    /** Error message explaining that the page is served from a secure origin. */
-    'not-from-secure-origin': string;
-    /** Error message explaining that the page has no manifest URL. */
-    'no-manifest': string;
-    /** Error message explaining that the provided manifest URL is invalid. */
-    'start-url-not-valid': string;
-    /** Error message explaining that the provided manifest does not contain a name or short_name field. */
-    'manifest-missing-name-or-short-name': string;
-    /** Error message explaining that the manifest display property must be one of 'standalone', 'fullscreen', or 'minimal-ui'. */
-    'manifest-display-not-supported': string;
-    /** Error message explaining that the manifest could not be fetched, might be empty, or could not be parsed. */
-    'manifest-empty': string;
-    /** Error message explaining that the manifest could not be fetched, might be empty, or could not be parsed. */
-    'manifest-parsing-or-network-error': string;
-    /**
-     * @description Error message explaining that the manifest does not contain a suitable icon.
-     * @example {192} value0
-     */
-    'manifest-missing-suitable-icon': string;
-    /**
-     * @description Error message explaining that the manifest does not supply an icon of the correct format.
-     * @example {192} value0
-     */
-    'no-acceptable-icon': string;
-    /** Error message explaining that the icon could not be downloaded. */
-    'cannot-download-icon': string;
-    /** Error message explaining that the downloaded icon was empty or corrupt. */
-    'no-icon-available': string;
-    /** Error message explaining that the specified application platform is not supported on Android. */
-    'platform-not-supported-on-android': string;
-    /** Error message explaining that a Play store ID was not provided. */
-    'no-id-specified': string;
-    /** Error message explaining that the Play Store app URL and Play Store ID do not match. */
-    'ids-do-not-match': string;
-    /** Error message explaining that the app is already installed. */
-    'already-installed': string;
-    /** Error message explaining that a URL in the manifest contains a username, password, or port. */
-    'url-not-supported-for-webapk': string;
-    /** Error message explaining that the page is loaded in an incognito window. */
-    'in-incognito': string;
-    /** Error message explaining that the page does not work offline. */
-    'not-offline-capable': string;
-    /** Error message explaining that service worker could not be checked without a start_url. */
-    'no-url-for-service-worker': string;
-    /** Error message explaining that the manifest specifies prefer_related_applications: true. */
-    'prefer-related-applications': string;
-    /** Error message explaining that prefer_related_applications is only supported on Chrome Beta and Stable channels on Android. */
-    'prefer-related-applications-only-beta-stable': string;
-    /** Error message explaining that the manifest contains 'display_override' field, and the
-        first supported display mode must be one of 'standalone', 'fullscreen', or 'minimal-ui'. */
-    'manifest-display-override-not-supported': string;
-    /** Error message explaining that the web manifest's URL changed while the manifest was being downloaded by the browser. */
-    'manifest-location-changed': string;
-    /** Warning message explaining that the page does not work offline. */
-    'warn-not-offline-capable': string;
-    /** Error message explaining that Lighthouse failed while checking if the page is installable, and directing the user to try again in a new Chrome. */
-    'protocol-timeout': string;
-    /** Message logged when the web app has been uninstalled o desktop, signalling that the install banner state is being reset. */
-    'pipeline-restarted': string;
-};
-import { Audit } from './audit.js';
-//# sourceMappingURL=installable-manifest.d.ts.map