lighthouse 11.7.0-dev.20240408 → 11.7.0-dev.20240410

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/splash-screen.d.ts

@@ -1,37 +0,0 @@
-export default SplashScreen;
-/**
- * @fileoverview
- * Audits if a page is configured for a custom splash screen when launched
- * https://github.com/GoogleChrome/lighthouse/issues/24
- *
- * Requirements:
- *   * manifest is not empty
- *   * manifest has a valid name
- *   * manifest has a valid background_color
- *   * manifest has a valid theme_color
- *   * manifest contains icon that's a png and size >= 512px
- */
-declare class SplashScreen extends MultiCheckAudit {
-    /**
-     * @param {LH.Artifacts.ManifestValues} manifestValues
-     * @param {Array<string>} failures
-     */
-    static assessManifest(manifestValues: LH.Artifacts.ManifestValues, failures: Array<string>): void;
-    /**
-     * @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;
-    }>;
-}
-export namespace UIStrings {
-    const title: string;
-    const failureTitle: string;
-    const description: string;
-}
-import MultiCheckAudit from './multi-check-audit.js';
-import { ManifestValues } from '../computed/manifest-values.js';
-//# sourceMappingURL=splash-screen.d.ts.map

package/core/audits/splash-screen.js

@@ -1,98 +0,0 @@
-/**
- * @license
- * Copyright 2017 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-import MultiCheckAudit from './multi-check-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 splash screens. This descriptive title is shown to users when the site has a custom splash screen. */
-  title: 'Configured for a custom splash screen',
-  /** Title of a Lighthouse audit that provides detail on splash screens. This descriptive title is shown to users when the site does not have a custom splash screen. */
-  failureTitle: 'Is not configured for a custom splash screen',
-  /** Description of a Lighthouse audit that tells the user why they should configure a custom splash screen. 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 themed splash screen ensures a high-quality experience when ' +
-    'users launch your app from their homescreens. ' +
-    '[Learn more about splash screens](https://developer.chrome.com/docs/lighthouse/pwa/splash-screen/).',
-};
-
-const str_ = i18n.createIcuMessageFn(import.meta.url, UIStrings);
-
-/**
- * @fileoverview
- * Audits if a page is configured for a custom splash screen when launched
- * https://github.com/GoogleChrome/lighthouse/issues/24
- *
- * Requirements:
- *   * manifest is not empty
- *   * manifest has a valid name
- *   * manifest has a valid background_color
- *   * manifest has a valid theme_color
- *   * manifest contains icon that's a png and size >= 512px
- */
-
-class SplashScreen extends MultiCheckAudit {
-  /**
-   * @return {LH.Audit.Meta}
-   */
-  static get meta() {
-    return {
-      id: 'splash-screen',
-      title: str_(UIStrings.title),
-      failureTitle: str_(UIStrings.failureTitle),
-      description: str_(UIStrings.description),
-      supportedModes: ['navigation'],
-      requiredArtifacts: ['WebAppManifest', 'InstallabilityErrors'],
-    };
-  }
-
-  /**
-   * @param {LH.Artifacts.ManifestValues} manifestValues
-   * @param {Array<string>} failures
-   */
-  static assessManifest(manifestValues, failures) {
-    if (manifestValues.isParseFailure && manifestValues.parseFailureReason) {
-      failures.push(manifestValues.parseFailureReason);
-      return;
-    }
-
-    const splashScreenCheckIds = [
-      'hasName',
-      'hasBackgroundColor',
-      'hasThemeColor',
-      'hasIconsAtLeast512px',
-    ];
-
-    manifestValues.allChecks
-      .filter(item => splashScreenCheckIds.includes(item.id))
-      .forEach(item => {
-        if (!item.passing) {
-          failures.push(item.failureText);
-        }
-      });
-  }
-
-  /**
-   * @param {LH.Artifacts} artifacts
-   * @param {LH.Audit.Context} context
-   * @return {Promise<{failures: Array<string>, manifestValues: LH.Artifacts.ManifestValues}>}
-   */
-  static async audit_(artifacts, context) {
-    /** @type {Array<string>} */
-    const failures = [];
-
-    const manifestValues = await ManifestValues.request(artifacts, context);
-    SplashScreen.assessManifest(manifestValues, failures);
-
-    return {
-      failures,
-      manifestValues,
-    };
-  }
-}
-
-export default SplashScreen;
-export {UIStrings};

package/core/audits/themed-omnibox.d.ts

@@ -1,42 +0,0 @@
-export default ThemedOmnibox;
-/**
- * @fileoverview
- * Audits if a page is configured for a themed address bar
- *
- * Requirements:
- *   * manifest is not empty
- *   * manifest has a theme_color
- *   * HTML has a theme-color meta
- *
- * Color validity is explicitly not checked.
- */
-declare class ThemedOmnibox extends MultiCheckAudit {
-    /**
-     * @param {LH.Artifacts.MetaElement|undefined} themeColorMeta
-     * @param {Array<string>} failures
-     */
-    static assessMetaThemecolor(themeColorMeta: LH.Artifacts.MetaElement | undefined, failures: Array<string>): void;
-    /**
-     * @param {LH.Artifacts.ManifestValues} manifestValues
-     * @param {Array<string>} failures
-     */
-    static assessManifest(manifestValues: LH.Artifacts.ManifestValues, failures: Array<string>): void;
-    /**
-     * @param {LH.Artifacts} artifacts
-     * @param {LH.Audit.Context} context
-     * @return {Promise<{failures: Array<string>, manifestValues: LH.Artifacts.ManifestValues, themeColor: ?string}>}
-     */
-    static audit_(artifacts: LH.Artifacts, context: LH.Audit.Context): Promise<{
-        failures: Array<string>;
-        manifestValues: LH.Artifacts.ManifestValues;
-        themeColor: string | null;
-    }>;
-}
-export namespace UIStrings {
-    const title: string;
-    const failureTitle: string;
-    const description: string;
-}
-import MultiCheckAudit from './multi-check-audit.js';
-import { ManifestValues } from '../computed/manifest-values.js';
-//# sourceMappingURL=themed-omnibox.d.ts.map

package/core/audits/themed-omnibox.js

@@ -1,102 +0,0 @@
-/**
- * @license
- * Copyright 2017 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-import MultiCheckAudit from './multi-check-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 the theme color the web page has set for the browser's address bar. This descriptive title is shown to users when an address-bar theme color has been set. */
-  title: 'Sets a theme color for the address bar.',
-  /** Title of a Lighthouse audit that provides detail on the theme color the web page has set for the browser's address bar. This descriptive title is shown to users when an address-bar theme color has not been set. */
-  failureTitle: 'Does not set a theme color for the address bar.',
-  /** Description of a Lighthouse audit that tells the user why they should set a theme color for the browser's address bar. 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: 'The browser address bar can be themed to match your site. ' +
-    '[Learn more about theming the address bar](https://developer.chrome.com/docs/lighthouse/pwa/themed-omnibox/).',
-};
-
-const str_ = i18n.createIcuMessageFn(import.meta.url, UIStrings);
-
-/**
- * @fileoverview
- * Audits if a page is configured for a themed address bar
- *
- * Requirements:
- *   * manifest is not empty
- *   * manifest has a theme_color
- *   * HTML has a theme-color meta
- *
- * Color validity is explicitly not checked.
- */
-
-class ThemedOmnibox extends MultiCheckAudit {
-  /**
-   * @return {LH.Audit.Meta}
-   */
-  static get meta() {
-    return {
-      id: 'themed-omnibox',
-      title: str_(UIStrings.title),
-      failureTitle: str_(UIStrings.failureTitle),
-      description: str_(UIStrings.description),
-      supportedModes: ['navigation'],
-      requiredArtifacts: ['WebAppManifest', 'InstallabilityErrors', 'MetaElements'],
-    };
-  }
-
-  /**
-   * @param {LH.Artifacts.MetaElement|undefined} themeColorMeta
-   * @param {Array<string>} failures
-   */
-  static assessMetaThemecolor(themeColorMeta, failures) {
-    if (!themeColorMeta) {
-      // TODO(#7238): i18n
-      failures.push('No `<meta name="theme-color">` tag found');
-    } else if (!themeColorMeta.content) {
-      failures.push('The theme-color meta tag did not contain a content value');
-    }
-  }
-
-  /**
-   * @param {LH.Artifacts.ManifestValues} manifestValues
-   * @param {Array<string>} failures
-   */
-  static assessManifest(manifestValues, failures) {
-    if (manifestValues.isParseFailure && manifestValues.parseFailureReason) {
-      failures.push(manifestValues.parseFailureReason);
-      return;
-    }
-
-    const themeColorCheck = manifestValues.allChecks.find(i => i.id === 'hasThemeColor');
-    if (themeColorCheck && !themeColorCheck.passing) {
-      failures.push(themeColorCheck.failureText);
-    }
-  }
-
-  /**
-   * @param {LH.Artifacts} artifacts
-   * @param {LH.Audit.Context} context
-   * @return {Promise<{failures: Array<string>, manifestValues: LH.Artifacts.ManifestValues, themeColor: ?string}>}
-   */
-  static async audit_(artifacts, context) {
-    /** @type {Array<string>} */
-    const failures = [];
-
-    const themeColorMeta = artifacts.MetaElements.find(meta => meta.name === 'theme-color');
-    const manifestValues = await ManifestValues.request(artifacts, context);
-    ThemedOmnibox.assessManifest(manifestValues, failures);
-    ThemedOmnibox.assessMetaThemecolor(themeColorMeta, failures);
-
-    return {
-      failures,
-      manifestValues,
-      themeColor: themeColorMeta?.content || null,
-    };
-  }
-}
-
-export default ThemedOmnibox;
-export {UIStrings};

package/core/computed/manifest-values.d.ts

@@ -1,24 +0,0 @@
-export { ManifestValuesComputed as ManifestValues };
-declare const ManifestValuesComputed: typeof ManifestValues & {
-    request: (dependencies: Pick<import("../index.js").Artifacts, "InstallabilityErrors" | "WebAppManifest">, context: import("../../types/utility-types.js").default.ImmutableObject<{
-        computedCache: Map<string, import("../lib/arbitrary-equality-map.js").ArbitraryEqualityMap>;
-    }>) => Promise<import("../index.js").Artifacts.ManifestValues>;
-};
-declare class ManifestValues {
-    /** @typedef {(val: NonNullable<LH.Artifacts.Manifest['value']>, errors: LH.Artifacts.InstallabilityErrors['errors']) => boolean} Validator */
-    /**
-     * @return {Array<{id: LH.Artifacts.ManifestValueCheckID, failureText: string, validate: Validator}>}
-     */
-    static get manifestChecks(): {
-        id: LH.Artifacts.ManifestValueCheckID;
-        failureText: string;
-        validate: (val: NonNullable<LH.Artifacts.Manifest['value']>, errors: LH.Artifacts.InstallabilityErrors['errors']) => boolean;
-    }[];
-    /**
-     * Returns results of all manifest checks
-     * @param {Pick<LH.Artifacts, 'WebAppManifest'|'InstallabilityErrors'>} Manifest
-     * @return {Promise<LH.Artifacts.ManifestValues>}
-     */
-    static compute_({ WebAppManifest, InstallabilityErrors }: Pick<LH.Artifacts, 'WebAppManifest' | 'InstallabilityErrors'>): Promise<LH.Artifacts.ManifestValues>;
-}
-//# sourceMappingURL=manifest-values.d.ts.map

package/core/computed/manifest-values.js

@@ -1,136 +0,0 @@
-/**
- * @license
- * Copyright 2016 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-import {makeComputedArtifact} from './computed-artifact.js';
-import * as icons from '../lib/icons.js';
-
-const PWA_DISPLAY_VALUES = ['minimal-ui', 'fullscreen', 'standalone'];
-
-// Historically, Chrome recommended 12 chars as the maximum short_name length to prevent truncation.
-// For more discussion, see https://github.com/GoogleChrome/lighthouse/issues/69 and https://developer.chrome.com/apps/manifest/name#short_name
-const SUGGESTED_SHORTNAME_LENGTH = 12;
-
-class ManifestValues {
-  /** @typedef {(val: NonNullable<LH.Artifacts.Manifest['value']>, errors: LH.Artifacts.InstallabilityErrors['errors']) => boolean} Validator */
-
-  /**
-   * @return {Array<{id: LH.Artifacts.ManifestValueCheckID, failureText: string, validate: Validator}>}
-   */
-  static get manifestChecks() {
-    return [
-      {
-        id: 'hasStartUrl',
-        failureText: 'Manifest does not contain a `start_url`',
-        validate: manifestValue => !!manifestValue.start_url.value,
-      },
-      {
-        id: 'hasIconsAtLeast144px',
-        failureText: 'Manifest does not have a PNG icon of at least 144px',
-        validate: manifestValue => icons.doExist(manifestValue) &&
-            icons.pngSizedAtLeast(144, manifestValue).length > 0,
-      },
-      {
-        id: 'hasIconsAtLeast512px',
-        failureText: 'Manifest does not have a PNG icon of at least 512px',
-        validate: manifestValue => icons.doExist(manifestValue) &&
-            icons.pngSizedAtLeast(512, manifestValue).length > 0,
-      },
-      {
-        id: 'fetchesIcon',
-        failureText: 'Manifest icon failed to be fetched',
-        validate: (manifestValue, errors) => {
-          const failedToFetchIconErrorIds = [
-            'cannot-download-icon',
-            'no-icon-available',
-          ];
-          return icons.doExist(manifestValue) &&
-            !errors.some(error => failedToFetchIconErrorIds.includes(error.errorId));
-        },
-      },
-      {
-        id: 'hasPWADisplayValue',
-        failureText: 'Manifest\'s `display` value is not one of: ' + PWA_DISPLAY_VALUES.join(' | '),
-        validate: manifestValue => PWA_DISPLAY_VALUES.includes(manifestValue.display.value),
-      },
-      {
-        id: 'hasBackgroundColor',
-        failureText: 'Manifest does not have `background_color`',
-        validate: manifestValue => !!manifestValue.background_color.value,
-      },
-      {
-        id: 'hasThemeColor',
-        failureText: 'Manifest does not have `theme_color`',
-        validate: manifestValue => !!manifestValue.theme_color.value,
-      },
-      {
-        id: 'hasShortName',
-        failureText: 'Manifest does not have `short_name`',
-        validate: manifestValue => !!manifestValue.short_name.value,
-      },
-      {
-        id: 'shortNameLength',
-        failureText: `Manifest's \`short_name\` is too long (>${SUGGESTED_SHORTNAME_LENGTH} ` +
-          `characters) to be displayed on a homescreen without truncation`,
-        // Pass if there's no short_name. Don't want to report a non-existent string is too long
-        validate: manifestValue => !!manifestValue.short_name.value &&
-            manifestValue.short_name.value.length <= SUGGESTED_SHORTNAME_LENGTH,
-      },
-      {
-        id: 'hasName',
-        failureText: 'Manifest does not have `name`',
-        validate: manifestValue => !!manifestValue.name.value,
-      },
-      {
-        id: 'hasMaskableIcon',
-        failureText: 'Manifest does not have at least one icon that is maskable',
-        validate: ManifestValue => icons.doExist(ManifestValue) &&
-            icons.containsMaskableIcon(ManifestValue),
-      },
-    ];
-  }
-
-  /**
-   * Returns results of all manifest checks
-   * @param {Pick<LH.Artifacts, 'WebAppManifest'|'InstallabilityErrors'>} Manifest
-   * @return {Promise<LH.Artifacts.ManifestValues>}
-   */
-  static async compute_({WebAppManifest, InstallabilityErrors}) {
-    // if the manifest isn't there or is invalid json, we report that and bail
-    if (WebAppManifest === null) {
-      return {
-        isParseFailure: true,
-        parseFailureReason: 'No manifest was fetched',
-        allChecks: [],
-      };
-    }
-    const manifestValue = WebAppManifest.value;
-    if (manifestValue === undefined) {
-      return {
-        isParseFailure: true,
-        parseFailureReason: 'Manifest failed to parse as valid JSON',
-        allChecks: [],
-      };
-    }
-
-    // manifest is valid, so do the rest of the checks
-    const remainingChecks = ManifestValues.manifestChecks.map(item => {
-      return {
-        id: item.id,
-        failureText: item.failureText,
-        passing: item.validate(manifestValue, InstallabilityErrors.errors),
-      };
-    });
-
-    return {
-      isParseFailure: false,
-      allChecks: remainingChecks,
-    };
-  }
-}
-
-const ManifestValuesComputed =
-  makeComputedArtifact(ManifestValues, ['InstallabilityErrors', 'WebAppManifest']);
-export {ManifestValuesComputed as ManifestValues};

package/core/gather/gatherers/installability-errors.d.ts

@@ -1,17 +0,0 @@
-export default InstallabilityErrors;
-declare class InstallabilityErrors extends BaseGatherer {
-    /**
-     * Creates an Artifacts.InstallabilityErrors, tranforming data from the protocol
-     * for old versions of Chrome.
-     * @param {LH.Gatherer.ProtocolSession} session
-     * @return {Promise<LH.Artifacts['InstallabilityErrors']>}
-     */
-    static getInstallabilityErrors(session: LH.Gatherer.ProtocolSession): Promise<LH.Artifacts['InstallabilityErrors']>;
-    /**
-     * @param {LH.Gatherer.Context} context
-     * @return {Promise<LH.Artifacts['InstallabilityErrors']>}
-     */
-    getArtifact(context: LH.Gatherer.Context): Promise<LH.Artifacts['InstallabilityErrors']>;
-}
-import BaseGatherer from '../base-gatherer.js';
-//# sourceMappingURL=installability-errors.d.ts.map

package/core/gather/gatherers/installability-errors.js

@@ -1,56 +0,0 @@
-/**
- * @license
- * Copyright 2021 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-import log from 'lighthouse-logger';
-
-import BaseGatherer from '../base-gatherer.js';
-
-class InstallabilityErrors extends BaseGatherer {
-  /** @type {LH.Gatherer.GathererMeta} */
-  meta = {
-    supportedModes: ['snapshot', 'navigation'],
-  };
-
-  /**
-   * Creates an Artifacts.InstallabilityErrors, tranforming data from the protocol
-   * for old versions of Chrome.
-   * @param {LH.Gatherer.ProtocolSession} session
-   * @return {Promise<LH.Artifacts['InstallabilityErrors']>}
-   */
-  static async getInstallabilityErrors(session) {
-    const status = {
-      msg: 'Get webapp installability errors',
-      id: 'lh:gather:getInstallabilityErrors',
-    };
-    log.time(status);
-    const response = await session.sendCommand('Page.getInstallabilityErrors');
-
-    const errors = response.installabilityErrors;
-
-    log.timeEnd(status);
-    return {errors};
-  }
-
-  /**
-   * @param {LH.Gatherer.Context} context
-   * @return {Promise<LH.Artifacts['InstallabilityErrors']>}
-   */
-  async getArtifact(context) {
-    const driver = context.driver;
-
-    try {
-      return await InstallabilityErrors.getInstallabilityErrors(driver.defaultSession);
-    } catch {
-      return {
-        errors: [
-          {errorId: 'protocol-timeout', errorArguments: []},
-        ],
-      };
-    }
-  }
-}
-
-export default InstallabilityErrors;

package/core/gather/gatherers/web-app-manifest.d.ts

@@ -1,32 +0,0 @@
-export default WebAppManifest;
-declare class WebAppManifest extends BaseGatherer {
-    /**
-     * @param {LH.Gatherer.ProtocolSession} session
-     * @return {Promise<{url: string, data: string}|null>}
-     */
-    static fetchAppManifest(session: LH.Gatherer.ProtocolSession): Promise<{
-        url: string;
-        data: string;
-    } | null>;
-    /**
-     * Uses the debugger protocol to fetch the manifest from within the context of
-     * the target page, reusing any credentials, emulation, etc, already established
-     * there.
-     *
-     * Returns the parsed manifest or null if the page had no manifest. If the manifest
-     * was unparseable as JSON, manifest.value will be undefined and manifest.warning
-     * will have the reason. See manifest-parser.js for more information.
-     *
-     * @param {LH.Gatherer.ProtocolSession} session
-     * @param {string} pageUrl
-     * @return {Promise<LH.Artifacts.Manifest|null>}
-     */
-    static getWebAppManifest(session: LH.Gatherer.ProtocolSession, pageUrl: string): Promise<LH.Artifacts.Manifest | null>;
-    /**
-     * @param {LH.Gatherer.Context} context
-     * @return {Promise<LH.Artifacts['WebAppManifest']>}
-     */
-    getArtifact(context: LH.Gatherer.Context): Promise<LH.Artifacts['WebAppManifest']>;
-}
-import BaseGatherer from '../base-gatherer.js';
-//# sourceMappingURL=web-app-manifest.d.ts.map