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

package/core/gather/gatherers/web-app-manifest.js

@@ -1,106 +0,0 @@
-/**
- * @license
- * Copyright 2021 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-import log from 'lighthouse-logger';
-
-import {parseManifest} from '../../lib/manifest-parser.js';
-import BaseGatherer from '../base-gatherer.js';
-
-class WebAppManifest extends BaseGatherer {
-  /** @type {LH.Gatherer.GathererMeta} */
-  meta = {
-    supportedModes: ['snapshot', 'navigation'],
-  };
-
-  /**
-   * @param {LH.Gatherer.ProtocolSession} session
-   * @return {Promise<{url: string, data: string}|null>}
-   */
-  static async fetchAppManifest(session) {
-    // In all environments but LR, Page.getAppManifest finishes very quickly.
-    // In LR, there is a bug that causes this command to hang until outgoing
-    // requests finish. This has been seen in long polling (where it will never
-    // return) and when other requests take a long time to finish. We allow 10 seconds
-    // for outgoing requests to finish. Anything more, and we continue the run without
-    // a manifest.
-    // Googlers, see: http://b/124008171
-    session.setNextProtocolTimeout(10000);
-    let response;
-    try {
-      response = await session.sendCommand('Page.getAppManifest');
-    } catch (err) {
-      if (err.code === 'PROTOCOL_TIMEOUT') {
-        // LR will timeout fetching the app manifest in some cases, move on without one.
-        // https://github.com/GoogleChrome/lighthouse/issues/7147#issuecomment-461210921
-        log.error('WebAppManifest', 'Failed fetching manifest', err);
-        return null;
-      }
-
-      throw err;
-    }
-
-    let data = response.data;
-
-    // We're not reading `response.errors` however it may contain critical and noncritical
-    // errors from Blink's manifest parser:
-    //   https://chromedevtools.github.io/debugger-protocol-viewer/tot/Page/#type-AppManifestError
-    if (!data) {
-      // If the data is empty, the page had no manifest.
-      return null;
-    }
-
-    const BOM_LENGTH = 3;
-    const BOM_FIRSTCHAR = 65279;
-    const isBomEncoded = data.charCodeAt(0) === BOM_FIRSTCHAR;
-
-    if (isBomEncoded) {
-      data = Buffer.from(data)
-        .slice(BOM_LENGTH)
-        .toString();
-    }
-
-    return {...response, data};
-  }
-
-  /**
-   * 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 async getWebAppManifest(session, pageUrl) {
-    const status = {msg: 'Get webapp manifest', id: 'lh:gather:getWebAppManifest'};
-    log.time(status);
-    const response = await WebAppManifest.fetchAppManifest(session);
-    if (!response) return null;
-    const manifest = parseManifest(response.data, response.url, pageUrl);
-    log.timeEnd(status);
-    return manifest;
-  }
-
-  /**
-   * @param {LH.Gatherer.Context} context
-   * @return {Promise<LH.Artifacts['WebAppManifest']>}
-   */
-  async getArtifact(context) {
-    const driver = context.driver;
-    const {finalDisplayedUrl} = context.baseArtifacts.URL;
-    try {
-      return await WebAppManifest.getWebAppManifest(driver.defaultSession, finalDisplayedUrl);
-    } catch {
-      return null;
-    }
-  }
-}
-
-export default WebAppManifest;

package/report/renderer/pwa-category-renderer.d.ts

@@ -1,55 +0,0 @@
-export class PwaCategoryRenderer extends CategoryRenderer {
-    /**
-     * Alters SVG id references so multiple instances of an SVG element can coexist
-     * in a single page. If `svgRoot` has a `<defs>` block, gives all elements defined
-     * in it unique ids, then updates id references (`<use xlink:href="...">`,
-     * `fill="url(#...)"`) to the altered ids in all descendents of `svgRoot`.
-     * @param {SVGElement} svgRoot
-     */
-    static _makeSvgReferencesUnique(svgRoot: SVGElement): void;
-    /**
-     * @param {LH.ReportResult.Category} category
-     * @param {Object<string, LH.Result.ReportGroup>} [groupDefinitions]
-     * @return {Element}
-     */
-    render(category: LH.ReportResult.Category, groupDefinitions?: {
-        [x: string]: import("../../types/lhr/lhr.js").default.ReportGroup;
-    } | undefined): Element;
-    /**
-     * @param {LH.ReportResult.Category} category
-     * @param {Record<string, LH.Result.ReportGroup>} groupDefinitions
-     * @return {DocumentFragment}
-     */
-    renderCategoryScore(category: LH.ReportResult.Category, groupDefinitions: Record<string, LH.Result.ReportGroup>): DocumentFragment;
-    /**
-     * Returns the group IDs found in auditRefs.
-     * @param {Array<LH.ReportResult.AuditRef>} auditRefs
-     * @return {!Set<string>}
-     */
-    _getGroupIds(auditRefs: Array<LH.ReportResult.AuditRef>): Set<string>;
-    /**
-     * Returns the group IDs whose audits are all considered passing.
-     * @param {Array<LH.ReportResult.AuditRef>} auditRefs
-     * @return {Set<string>}
-     */
-    _getPassingGroupIds(auditRefs: Array<LH.ReportResult.AuditRef>): Set<string>;
-    /**
-     * Returns a tooltip string summarizing group pass rates.
-     * @param {Array<LH.ReportResult.AuditRef>} auditRefs
-     * @param {Record<string, LH.Result.ReportGroup>} groupDefinitions
-     * @return {string}
-     */
-    _getGaugeTooltip(auditRefs: Array<LH.ReportResult.AuditRef>, groupDefinitions: Record<string, LH.Result.ReportGroup>): string;
-    /**
-     * Render non-manual audits in groups, giving a badge to any group that has
-     * all passing audits.
-     * @param {Array<LH.ReportResult.AuditRef>} auditRefs
-     * @param {Object<string, LH.Result.ReportGroup>} groupDefinitions
-     * @return {Element}
-     */
-    _renderAudits(auditRefs: Array<LH.ReportResult.AuditRef>, groupDefinitions: {
-        [x: string]: LH.Result.ReportGroup;
-    }): Element;
-}
-import { CategoryRenderer } from './category-renderer.js';
-//# sourceMappingURL=pwa-category-renderer.d.ts.map

package/report/renderer/pwa-category-renderer.js

@@ -1,184 +0,0 @@
-/**
- * @license
- * Copyright 2018 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-
-import {CategoryRenderer} from './category-renderer.js';
-import {ReportUtils} from './report-utils.js';
-import {Globals} from './report-globals.js';
-
-export class PwaCategoryRenderer extends CategoryRenderer {
-  /**
-   * @param {LH.ReportResult.Category} category
-   * @param {Object<string, LH.Result.ReportGroup>} [groupDefinitions]
-   * @return {Element}
-   */
-  render(category, groupDefinitions = {}) {
-    const categoryElem = this.dom.createElement('div', 'lh-category');
-    categoryElem.id = category.id;
-    // Deprecation warning banner.
-    const pwaMessageContainer = this.dom.createComponent('warningsToplevel');
-    const pwaMessageEl = this.dom.find('.lh-warnings__msg', pwaMessageContainer);
-    pwaMessageEl.append(this.dom.convertMarkdownLinkSnippets(Globals.strings.pwaRemovalMessage));
-
-    categoryElem.append(pwaMessageContainer);
-    categoryElem.append(this.renderCategoryHeader(category, groupDefinitions));
-
-    const auditRefs = category.auditRefs;
-
-    // Regular audits aren't split up into pass/fail/notApplicable clumps, they're
-    // all put in a top-level clump that isn't expandable/collapsible.
-    const regularAuditRefs = auditRefs.filter(ref => ref.result.scoreDisplayMode !== 'manual');
-    const auditsElem = this._renderAudits(regularAuditRefs, groupDefinitions);
-    categoryElem.append(auditsElem);
-
-    // Manual audits are still in a manual clump.
-    const manualAuditRefs = auditRefs.filter(ref => ref.result.scoreDisplayMode === 'manual');
-    const manualElem = this.renderClump('manual', {
-      auditRefsOrEls: manualAuditRefs,
-      description: category.manualDescription,
-      openByDefault: true,
-    });
-    categoryElem.append(manualElem);
-
-    return categoryElem;
-  }
-
-  /**
-   * @param {LH.ReportResult.Category} category
-   * @param {Record<string, LH.Result.ReportGroup>} groupDefinitions
-   * @return {DocumentFragment}
-   */
-  renderCategoryScore(category, groupDefinitions) {
-    // Defer to parent-gauge style if category error.
-    if (category.score === null) {
-      return super.renderScoreGauge(category, groupDefinitions);
-    }
-
-    const tmpl = this.dom.createComponent('gaugePwa');
-    const wrapper = this.dom.find('a.lh-gauge--pwa__wrapper', tmpl);
-
-    // Correct IDs in case multiple instances end up in the page.
-    const svgRoot = tmpl.querySelector('svg');
-    if (!svgRoot) throw new Error('no SVG element found in PWA score gauge template');
-    PwaCategoryRenderer._makeSvgReferencesUnique(svgRoot);
-
-    const allGroups = this._getGroupIds(category.auditRefs);
-    const passingGroupIds = this._getPassingGroupIds(category.auditRefs);
-
-    if (passingGroupIds.size === allGroups.size) {
-      wrapper.classList.add('lh-badged--all');
-    } else {
-      for (const passingGroupId of passingGroupIds) {
-        wrapper.classList.add(`lh-badged--${passingGroupId}`);
-      }
-    }
-
-    this.dom.find('.lh-gauge__label', tmpl).textContent = category.title;
-    wrapper.title = this._getGaugeTooltip(category.auditRefs, groupDefinitions);
-    return tmpl;
-  }
-
-  /**
-   * Returns the group IDs found in auditRefs.
-   * @param {Array<LH.ReportResult.AuditRef>} auditRefs
-   * @return {!Set<string>}
-   */
-  _getGroupIds(auditRefs) {
-    const groupIds = auditRefs.map(ref => ref.group).filter(/** @return {g is string} */ g => !!g);
-    return new Set(groupIds);
-  }
-
-  /**
-   * Returns the group IDs whose audits are all considered passing.
-   * @param {Array<LH.ReportResult.AuditRef>} auditRefs
-   * @return {Set<string>}
-   */
-  _getPassingGroupIds(auditRefs) {
-    const uniqueGroupIds = this._getGroupIds(auditRefs);
-
-    // Remove any that have a failing audit.
-    for (const auditRef of auditRefs) {
-      if (!ReportUtils.showAsPassed(auditRef.result) && auditRef.group) {
-        uniqueGroupIds.delete(auditRef.group);
-      }
-    }
-
-    return uniqueGroupIds;
-  }
-
-  /**
-   * Returns a tooltip string summarizing group pass rates.
-   * @param {Array<LH.ReportResult.AuditRef>} auditRefs
-   * @param {Record<string, LH.Result.ReportGroup>} groupDefinitions
-   * @return {string}
-   */
-  _getGaugeTooltip(auditRefs, groupDefinitions) {
-    const groupIds = this._getGroupIds(auditRefs);
-
-    const tips = [];
-    for (const groupId of groupIds) {
-      const groupAuditRefs = auditRefs.filter(ref => ref.group === groupId);
-      const auditCount = groupAuditRefs.length;
-      const passedCount = groupAuditRefs.filter(ref => ReportUtils.showAsPassed(ref.result)).length;
-
-      const title = groupDefinitions[groupId].title;
-      tips.push(`${title}: ${passedCount}/${auditCount}`);
-    }
-
-    return tips.join(', ');
-  }
-
-  /**
-   * Render non-manual audits in groups, giving a badge to any group that has
-   * all passing audits.
-   * @param {Array<LH.ReportResult.AuditRef>} auditRefs
-   * @param {Object<string, LH.Result.ReportGroup>} groupDefinitions
-   * @return {Element}
-   */
-  _renderAudits(auditRefs, groupDefinitions) {
-    const auditsElem = this.renderUnexpandableClump(auditRefs, groupDefinitions);
-
-    // Add a 'badged' class to group if all audits in that group pass.
-    const passsingGroupIds = this._getPassingGroupIds(auditRefs);
-    for (const groupId of passsingGroupIds) {
-      const groupElem = this.dom.find(`.lh-audit-group--${groupId}`, auditsElem);
-      groupElem.classList.add('lh-badged');
-    }
-
-    return auditsElem;
-  }
-
-  /**
-   * Alters SVG id references so multiple instances of an SVG element can coexist
-   * in a single page. If `svgRoot` has a `<defs>` block, gives all elements defined
-   * in it unique ids, then updates id references (`<use xlink:href="...">`,
-   * `fill="url(#...)"`) to the altered ids in all descendents of `svgRoot`.
-   * @param {SVGElement} svgRoot
-   */
-  static _makeSvgReferencesUnique(svgRoot) {
-    const defsEl = svgRoot.querySelector('defs');
-    if (!defsEl) return;
-
-    const idSuffix = Globals.getUniqueSuffix();
-    const elementsToUpdate = defsEl.querySelectorAll('[id]');
-    for (const el of elementsToUpdate) {
-      const oldId = el.id;
-      const newId = `${oldId}-${idSuffix}`;
-      el.id = newId;
-
-      // Update all <use>s.
-      const useEls = svgRoot.querySelectorAll(`use[href="#${oldId}"]`);
-      for (const useEl of useEls) {
-        useEl.setAttribute('href', `#${newId}`);
-      }
-
-      // Update all fill="url(#...)"s.
-      const fillEls = svgRoot.querySelectorAll(`[fill="url(#${oldId})"]`);
-      for (const fillEl of fillEls) {
-        fillEl.setAttribute('fill', `url(#${newId})`);
-      }
-    }
-  }
-}

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

@@ -1,79 +0,0 @@
-/**
- * @license
- * Copyright 2020 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-'use strict';
-
-import fetch from 'node-fetch';
-
-import {UIStrings} from '../../core/audits/installable-manifest.js';
-
-describe('installabilityErrors', () => {
-  let chromiumErrorIds;
-
-  before(async () => {
-    const installableLoggingGitTilesUrl =
-      'https://chromium.googlesource.com/chromium/src/+/main/components/webapps/browser/installable/installable_logging.cc?format=TEXT';
-    const resp = await fetch(installableLoggingGitTilesUrl);
-    if (!resp.ok) {
-      throw new Error(`Chromium source fetch failed: ${resp.status} ${resp.statusText}`);
-    }
-    const base64 = await resp.text();
-    const buff = Buffer.from(base64, 'base64');
-    const text = buff.toString('utf-8');
-
-    // Apply some *beautiful* regexes to parse the C++ of https://chromium.googlesource.com/chromium/src/+/main/chrome/browser/installable/installable_logging.cc
-    const handledErrorConsts = [...text.matchAll(/error_id = (k.*?);/g)].map(([_, match]) => match);
-    const errorConstsToIdsCode = [...text.matchAll(/static const char k.*?Id\[\](.|\n)*?;/g)].map(
-      ([match]) => match.replace(/\n/, '')
-    );
-    const errorConstsToIds = errorConstsToIdsCode.map(txt => [
-      txt.match(/char (k.*?)\[/)[1],
-      txt.match(/ "(.*?)"/)[1],
-    ]);
-    const errorConstsToIdsDict = Object.fromEntries(errorConstsToIds);
-
-    chromiumErrorIds = handledErrorConsts.map(varName => {
-      if (!errorConstsToIdsDict[varName]) throw new Error(`Error const (${varName}) not found!`);
-      return errorConstsToIdsDict[varName];
-    }).sort();
-  });
-
-  it('should notify us if something changed', () => {
-    expect(chromiumErrorIds).toMatchInlineSnapshot(`
-Array [
-  "already-installed",
-  "cannot-download-icon",
-  "ids-do-not-match",
-  "in-incognito",
-  "manifest-display-not-supported",
-  "manifest-display-override-not-supported",
-  "manifest-location-changed",
-  "manifest-missing-name-or-short-name",
-  "manifest-missing-suitable-icon",
-  "manifest-parsing-or-network-error",
-  "no-acceptable-icon",
-  "no-icon-available",
-  "no-id-specified",
-  "no-manifest",
-  "no-url-for-service-worker",
-  "not-from-secure-origin",
-  "not-offline-capable",
-  "pipeline-restarted",
-  "platform-not-supported-on-android",
-  "prefer-related-applications",
-  "prefer-related-applications-only-beta-stable",
-  "start-url-not-valid",
-  "url-not-supported-for-webapk",
-]
-`);
-  });
-
-  it('are each handled explicitly in the gatherer', () => {
-    const errorStrings = Object.keys(UIStrings)
-      .filter(key => chromiumErrorIds.includes(key))
-      .sort();
-    expect(errorStrings).toEqual(chromiumErrorIds);
-  });
-});