lighthouse 11.7.0 → 12.0.0-dev.20240422

package/core/audits/maskable-icon.js

@@ -1,70 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-import {Audit} from './audit.js';
-import {ManifestValues} from '../computed/manifest-values.js';
-import * as i18n from '../lib/i18n/i18n.js';
-
-const UIStrings = {
-  /** Title of a Lighthouse audit that provides detail on if the manifest contains a maskable icon. This descriptive title is shown to users when the manifest contains at least one maskable icon. */
-  title: 'Manifest has a maskable icon',
-  /** Title of a Lighthouse audit that provides detial on if the manifest contains a maskable icon. this descriptive title is shown to users when the manifest contains no icons that are maskable. */
-  failureTitle: 'Manifest doesn\'t have a maskable icon',
-  /** Description of a Lighthouse audit that tells the user why they their manifest should have at least one maskable icon. 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: 'A maskable icon ensures that the image fills the entire ' +
-    'shape without being letterboxed when installing ' +
-    'the app on a device. [Learn about maskable manifest icons](https://developer.chrome.com/docs/lighthouse/pwa/maskable-icon-audit/).',
-};
-
-const str_ = i18n.createIcuMessageFn(import.meta.url, UIStrings);
-
-/**
- * @fileoverview
- * Audits if a manifest contains at least one icon that is maskable
- *
- * Requirements:
- *    * manifest is not empty
- *    * manifest has valid icons
- *    * at least one of the icons has a purpose of 'maskable'
- */
-
-class MaskableIcon extends Audit {
-  /**
-   * @return {LH.Audit.Meta}
-   */
-  static get meta() {
-    return {
-      id: 'maskable-icon',
-      title: str_(UIStrings.title),
-      failureTitle: str_(UIStrings.failureTitle),
-      description: str_(UIStrings.description),
-      supportedModes: ['navigation'],
-      requiredArtifacts: ['WebAppManifest', 'InstallabilityErrors'],
-    };
-  }
-
-  /**
-   * @param {LH.Artifacts} artifacts
-   * @param {LH.Audit.Context} context
-   * @return {Promise<LH.Audit.Product>}
-   */
-  static async audit(artifacts, context) {
-    const manifestValues = await ManifestValues.request(artifacts, context);
-    if (manifestValues.isParseFailure) {
-      return {
-        score: 0,
-        explanation: manifestValues.parseFailureReason,
-      };
-    }
-    const maskableIconCheck = manifestValues.allChecks.find(i => i.id === 'hasMaskableIcon');
-    return {
-      score: maskableIconCheck?.passing ? 1 : 0,
-    };
-  }
-}
-
-export default MaskableIcon;
-export {UIStrings};

package/core/audits/multi-check-audit.d.ts

@@ -1,28 +0,0 @@
-export default MultiCheckAudit;
-declare class MultiCheckAudit extends Audit {
-    /**
-     * @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>;
-    /**
-     * @param {{failures: Array<string>, manifestValues?: LH.Artifacts.ManifestValues}} result
-     * @return {LH.Audit.Product}
-     */
-    static createAuditProduct(result: {
-        failures: Array<string>;
-        manifestValues?: LH.Artifacts.ManifestValues;
-    }): LH.Audit.Product;
-    /**
-     * @param {LH.Artifacts} artifacts
-     * @param {LH.Audit.Context} context
-     * @return {Promise<{failures: Array<string>, manifestValues?: LH.Artifacts.ManifestValues}>}
-     */
-    static audit_(artifacts: LH.Artifacts, context: LH.Audit.Context): Promise<{
-        failures: Array<string>;
-        manifestValues?: LH.Artifacts.ManifestValues;
-    }>;
-}
-import { Audit } from './audit.js';
-//# sourceMappingURL=multi-check-audit.d.ts.map

package/core/audits/multi-check-audit.js

@@ -1,82 +0,0 @@
-/**
- * @license
- * Copyright 2017 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-/**
- * @fileoverview Base class for boolean audits that can have multiple reasons for failure
- */
-
-import {Audit} from './audit.js';
-
-class MultiCheckAudit extends Audit {
-  /**
-   * @param {LH.Artifacts} artifacts
-   * @param {LH.Audit.Context} context
-   * @return {Promise<LH.Audit.Product>}
-   */
-  static async audit(artifacts, context) {
-    const multiProduct = await this.audit_(artifacts, context);
-    return this.createAuditProduct(multiProduct);
-  }
-
-  /**
-   * @param {{failures: Array<string>, manifestValues?: LH.Artifacts.ManifestValues}} result
-   * @return {LH.Audit.Product}
-   */
-  static createAuditProduct(result) {
-    /** @type {LH.Audit.MultiCheckAuditDetails} */
-    const detailsItem = {
-      ...result,
-      ...result.manifestValues,
-      manifestValues: undefined,
-      allChecks: undefined,
-    };
-
-    if (result.manifestValues?.allChecks) {
-      result.manifestValues.allChecks.forEach(check => {
-        detailsItem[check.id] = check.passing;
-      });
-    }
-
-    // Include the detailed pass/fail checklist as a diagnostic.
-    /** @type {LH.Audit.Details.DebugData} */
-    const details = {
-      type: 'debugdata',
-      // TODO: Consider not nesting detailsItem under `items`.
-      items: [detailsItem],
-    };
-
-    // If we fail, share the failures
-    if (result.failures.length > 0) {
-      return {
-        score: 0,
-        // TODO(#11495): make this i18n-able.
-        explanation: `Failures: ${result.failures.join(',\n')}.`,
-        details,
-      };
-    }
-
-    // Otherwise, we pass
-    return {
-      score: 1,
-      details,
-    };
-  }
-
-  /* eslint-disable no-unused-vars */
-
-  /**
-   * @param {LH.Artifacts} artifacts
-   * @param {LH.Audit.Context} context
-   * @return {Promise<{failures: Array<string>, manifestValues?: LH.Artifacts.ManifestValues}>}
-   */
-  static audit_(artifacts, context) {
-    throw new Error('audit_ unimplemented');
-  }
-
-  /* eslint-enable no-unused-vars */
-}
-
-export default MultiCheckAudit;

package/core/audits/no-unload-listeners.d.ts

@@ -1,16 +0,0 @@
-export default NoUnloadListeners;
-declare class NoUnloadListeners extends Audit {
-    /**
-     * @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 namespace UIStrings {
-    const title: string;
-    const failureTitle: string;
-    const description: string;
-}
-import { Audit } from './audit.js';
-//# sourceMappingURL=no-unload-listeners.d.ts.map

package/core/audits/no-unload-listeners.js

@@ -1,86 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-import {Audit} from './audit.js';
-import {JSBundles} from '../computed/js-bundles.js';
-import * as i18n from './../lib/i18n/i18n.js';
-
-const UIStrings = {
-  /** Descriptive title of a Lighthouse audit that checks if a web page has 'unload' event listeners and finds none. */
-  title: 'Avoids `unload` event listeners',
-  /** Descriptive title of a Lighthouse audit that checks if a web page has 'unload' event listeners and finds that it is using them. */
-  failureTitle: 'Registers an `unload` listener',
-  /** Description of a Lighthouse audit that tells the user why pages should not use the 'unload' event. This is displayed after a user expands the section to see more. The last sentence starting with 'Learn' becomes link text to additional documentation. */
-  description: 'The `unload` event does not fire reliably and listening for it can prevent browser optimizations like the Back-Forward Cache. Use `pagehide` or `visibilitychange` events instead. [Learn more about unload event listeners](https://web.dev/articles/bfcache#never_use_the_unload_event)',
-};
-
-const str_ = i18n.createIcuMessageFn(import.meta.url, UIStrings);
-
-class NoUnloadListeners extends Audit {
-  /**
-   * @return {LH.Audit.Meta}
-   */
-  static get meta() {
-    return {
-      id: 'no-unload-listeners',
-      title: str_(UIStrings.title),
-      failureTitle: str_(UIStrings.failureTitle),
-      description: str_(UIStrings.description),
-      requiredArtifacts: ['GlobalListeners', 'SourceMaps', 'Scripts'],
-    };
-  }
-
-  /**
-   * @param {LH.Artifacts} artifacts
-   * @param {LH.Audit.Context} context
-   * @return {Promise<LH.Audit.Product>}
-   */
-  static async audit(artifacts, context) {
-    const unloadListeners = artifacts.GlobalListeners.filter(l => l.type === 'unload');
-    if (!unloadListeners.length) {
-      return {
-        score: 1,
-      };
-    }
-
-    const bundles = await JSBundles.request(artifacts, context);
-
-    /** @type {LH.Audit.Details.Table['headings']} */
-    const headings = [
-      {key: 'source', valueType: 'source-location', label: str_(i18n.UIStrings.columnSource)},
-    ];
-
-    /** @type {Array<{source: LH.Audit.Details.ItemValue}>} */
-    const tableItems = unloadListeners.map(listener => {
-      const {lineNumber, columnNumber} = listener;
-      const script = artifacts.Scripts.find(s => s.scriptId === listener.scriptId);
-
-      // If we can't find a url, still show something so the user can manually
-      // look for where an `unload` handler is being created.
-      if (!script) {
-        return {
-          source: {
-            type: 'url',
-            value: `(unknown):${lineNumber}:${columnNumber}`,
-          },
-        };
-      }
-
-      const bundle = bundles.find(bundle => bundle.script.scriptId === script.scriptId);
-      return {
-        source: Audit.makeSourceLocation(script.url, lineNumber, columnNumber, bundle),
-      };
-    });
-
-    return {
-      score: 0,
-      details: Audit.makeTableDetails(headings, tableItems),
-    };
-  }
-}
-
-export default NoUnloadListeners;
-export {UIStrings};

package/core/audits/performance-budget.d.ts

@@ -1,39 +0,0 @@
-export default ResourceBudget;
-export type ResourceEntry = import('../computed/resource-summary.js').ResourceEntry;
-export type BudgetItem = {
-    resourceType: LH.Budget.ResourceType;
-    label: LH.IcuMessage;
-    requestCount: number;
-    transferSize: number;
-    sizeOverBudget: number | undefined;
-    countOverBudget: LH.IcuMessage | undefined;
-};
-/** @typedef {import('../computed/resource-summary.js').ResourceEntry} ResourceEntry */
-/** @typedef {{resourceType: LH.Budget.ResourceType, label: LH.IcuMessage, requestCount: number, transferSize: number, sizeOverBudget: number | undefined, countOverBudget: LH.IcuMessage | undefined}} BudgetItem */
-declare class ResourceBudget extends Audit {
-    /**
-     * @param {LH.Budget.ResourceType} resourceType
-     * @return {string}
-     */
-    static getRowLabel(resourceType: LH.Budget.ResourceType): string;
-    /**
-     * @param {LH.Util.Immutable<LH.Budget>} budget
-     * @param {Record<LH.Budget.ResourceType, ResourceEntry>} summary
-     * @return {Array<BudgetItem>}
-     */
-    static tableItems(budget: LH.Util.Immutable<LH.Budget>, summary: Record<LH.Budget.ResourceType, ResourceEntry>): Array<BudgetItem>;
-    /**
-     * @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 namespace UIStrings {
-    const title: string;
-    const description: string;
-    const requestCountOverBudget: string;
-}
-import { Budget } from '../config/budget.js';
-import { Audit } from './audit.js';
-//# sourceMappingURL=performance-budget.d.ts.map

package/core/audits/performance-budget.js

@@ -1,154 +0,0 @@
-/**
- * @license
- * Copyright 2019 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-import {Audit} from './audit.js';
-import {ResourceSummary} from '../computed/resource-summary.js';
-import {MainResource} from '../computed/main-resource.js';
-import {Budget} from '../config/budget.js';
-import * as i18n from '../lib/i18n/i18n.js';
-
-const UIStrings = {
-  /** Title of a Lighthouse audit that compares the size and quantity of page resources against targets set by the user. These targets are thought of as "performance budgets" because these metrics impact page performance (i.e. how quickly a page loads). */
-  title: 'Performance budget',
-  /** Description of a Lighthouse audit where a user sets budgets for the quantity and size of page resources. No character length limits. The last sentence starting with 'Learn' becomes link text to additional documentation. */
-  description: 'Keep the quantity and size of network requests under the targets ' +
-    'set by the provided performance budget. ' +
-    '[Learn more about performance budgets](https://developers.google.com/web/tools/lighthouse/audits/budgets).',
-  /** [ICU Syntax] Entry in a data table identifying the number of network requests of a particular type. Count will be a whole number. String should be as short as possible to be able to fit well into the table. */
-  requestCountOverBudget: `{count, plural,
-    =1 {1 request}
-    other {# requests}
-   }`,
-};
-
-const str_ = i18n.createIcuMessageFn(import.meta.url, UIStrings);
-
-/** @typedef {import('../computed/resource-summary.js').ResourceEntry} ResourceEntry */
-/** @typedef {{resourceType: LH.Budget.ResourceType, label: LH.IcuMessage, requestCount: number, transferSize: number, sizeOverBudget: number | undefined, countOverBudget: LH.IcuMessage | undefined}} BudgetItem */
-
-class ResourceBudget extends Audit {
-  /**
-   * @return {LH.Audit.Meta}
-   */
-  static get meta() {
-    return {
-      id: 'performance-budget',
-      title: str_(UIStrings.title),
-      description: str_(UIStrings.description),
-      scoreDisplayMode: Audit.SCORING_MODES.INFORMATIVE,
-      supportedModes: ['navigation'],
-      requiredArtifacts: ['devtoolsLogs', 'URL'],
-    };
-  }
-
-  /**
-   * @param {LH.Budget.ResourceType} resourceType
-   * @return {string}
-   */
-  static getRowLabel(resourceType) {
-    /** @type {Record<LH.Budget.ResourceType,string>} */
-    const strMappings = {
-      'total': i18n.UIStrings.totalResourceType,
-      'document': i18n.UIStrings.documentResourceType,
-      'script': i18n.UIStrings.scriptResourceType,
-      'stylesheet': i18n.UIStrings.stylesheetResourceType,
-      'image': i18n.UIStrings.imageResourceType,
-      'media': i18n.UIStrings.mediaResourceType,
-      'font': i18n.UIStrings.fontResourceType,
-      'other': i18n.UIStrings.otherResourceType,
-      'third-party': i18n.UIStrings.thirdPartyResourceType,
-    };
-    return strMappings[resourceType];
-  }
-
-  /**
-   * @param {LH.Util.Immutable<LH.Budget>} budget
-   * @param {Record<LH.Budget.ResourceType, ResourceEntry>} summary
-   * @return {Array<BudgetItem>}
-   */
-  static tableItems(budget, summary) {
-    const resourceTypes = /** @type {Array<LH.Budget.ResourceType>} */ (Object.keys(summary));
-    return resourceTypes.map((resourceType) => {
-      const label = str_(this.getRowLabel(resourceType));
-      const requestCount = summary[resourceType].count;
-      const transferSize = summary[resourceType].transferSize;
-
-      let sizeOverBudget;
-      let countOverBudget;
-
-      if (budget.resourceSizes) {
-        const sizeBudget = budget.resourceSizes.find(b => b.resourceType === resourceType);
-        if (sizeBudget && (transferSize > (sizeBudget.budget * 1024))) {
-          sizeOverBudget = transferSize - (sizeBudget.budget * 1024);
-        }
-      }
-      if (budget.resourceCounts) {
-        const countBudget = budget.resourceCounts.find(b => b.resourceType === resourceType);
-        if (countBudget && (requestCount > countBudget.budget)) {
-          const requestDifference = requestCount - countBudget.budget;
-          countOverBudget = str_(UIStrings.requestCountOverBudget, {count: requestDifference});
-        }
-      }
-      return {
-        resourceType,
-        label,
-        requestCount,
-        transferSize,
-        countOverBudget,
-        sizeOverBudget,
-      };
-    }).filter((row) => {
-      // Only resources with budgets should be included in the table
-      if (budget.resourceSizes) {
-        if (budget.resourceSizes.some(b => b.resourceType === row.resourceType)) return true;
-      }
-      if (budget.resourceCounts) {
-        if (budget.resourceCounts.some(b => b.resourceType === row.resourceType)) return true;
-      }
-      return false;
-    }).sort((a, b) => {
-      return (b.sizeOverBudget || 0) - (a.sizeOverBudget || 0);
-    });
-  }
-
-  /**
-   * @param {LH.Artifacts} artifacts
-   * @param {LH.Audit.Context} context
-   * @return {Promise<LH.Audit.Product>}
-   */
-  static async audit(artifacts, context) {
-    const devtoolsLog = artifacts.devtoolsLogs[Audit.DEFAULT_PASS];
-    const data = {devtoolsLog, URL: artifacts.URL, budgets: context.settings.budgets};
-    const summary = await ResourceSummary.request(data, context);
-    const mainResource = await MainResource.request({URL: artifacts.URL, devtoolsLog}, context);
-    const budget = Budget.getMatchingBudget(context.settings.budgets, mainResource.url);
-
-    if (!budget) {
-      return {
-        score: 0,
-        notApplicable: true,
-      };
-    }
-
-    /** @type {LH.Audit.Details.Table['headings']} */
-    const headers = [
-      {key: 'label', valueType: 'text', label: str_(i18n.UIStrings.columnResourceType)},
-      {key: 'requestCount', valueType: 'numeric', label: str_(i18n.UIStrings.columnRequests)},
-      {key: 'transferSize', valueType: 'bytes', label: str_(i18n.UIStrings.columnTransferSize)},
-      {key: 'countOverBudget', valueType: 'text', label: ''},
-      {key: 'sizeOverBudget', valueType: 'bytes', label: str_(i18n.UIStrings.columnOverBudget)},
-    ];
-
-    return {
-      details: Audit.makeTableDetails(headers,
-        this.tableItems(budget, summary), {sortedBy: ['sizeOverBudget']}),
-      score: 1,
-    };
-  }
-}
-
-export default ResourceBudget;
-export {UIStrings};

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/audits/seo/plugins.d.ts

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