lighthouse 12.8.2 → 13.0.0

package/core/audits/byte-efficiency/uses-optimized-images.d.ts

@@ -1,33 +0,0 @@
-export default UsesOptimizedImages;
-declare class UsesOptimizedImages extends ByteEfficiencyAudit {
-    /**
-     * @param {{originalSize: number, jpegSize: number}} image
-     * @return {{bytes: number, percent: number}}
-     */
-    static computeSavings(image: {
-        originalSize: number;
-        jpegSize: number;
-    }): {
-        bytes: number;
-        percent: number;
-    };
-    /**
-     * @param {{naturalWidth: number, naturalHeight: number}} imageElement
-     * @return {number}
-     */
-    static estimateJPEGSizeFromDimensions(imageElement: {
-        naturalWidth: number;
-        naturalHeight: number;
-    }): number;
-    /**
-     * @param {LH.Artifacts} artifacts
-     * @return {import('./byte-efficiency-audit.js').ByteEfficiencyProduct}
-     */
-    static audit_(artifacts: LH.Artifacts): import("./byte-efficiency-audit.js").ByteEfficiencyProduct;
-}
-export namespace UIStrings {
-    let title: string;
-    let description: string;
-}
-import { ByteEfficiencyAudit } from './byte-efficiency-audit.js';
-//# sourceMappingURL=uses-optimized-images.d.ts.map

package/core/audits/byte-efficiency/uses-optimized-images.js

@@ -1,146 +0,0 @@
-/**
- * @license
- * Copyright 2017 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-/*
- * @fileoverview This audit determines if the images used are sufficiently larger
- * than JPEG compressed images without metadata at quality 85.
- */
-
-
-import {ByteEfficiencyAudit} from './byte-efficiency-audit.js';
-import UrlUtils from '../../lib/url-utils.js';
-import * as i18n from '../../lib/i18n/i18n.js';
-
-const UIStrings = {
-  /** Imperative title of a Lighthouse audit that tells the user to encode images with optimization (better compression). This is displayed in a list of audit titles that Lighthouse generates. */
-  title: 'Efficiently encode images',
-  /** Description of a Lighthouse audit that tells the user *why* they need to efficiently encode images. 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: 'Optimized images load faster and consume less cellular data. ' +
-  '[Learn how to efficiently encode images](https://developer.chrome.com/docs/lighthouse/performance/uses-optimized-images/).',
-};
-
-const str_ = i18n.createIcuMessageFn(import.meta.url, UIStrings);
-
-const IGNORE_THRESHOLD_IN_BYTES = 4096;
-
-class UsesOptimizedImages extends ByteEfficiencyAudit {
-  /**
-   * @return {LH.Audit.Meta}
-   */
-  static get meta() {
-    return {
-      id: 'uses-optimized-images',
-      title: str_(UIStrings.title),
-      description: str_(UIStrings.description),
-      scoreDisplayMode: ByteEfficiencyAudit.SCORING_MODES.METRIC_SAVINGS,
-      guidanceLevel: 2,
-      requiredArtifacts: ['OptimizedImages', 'ImageElements', 'GatherContext', 'DevtoolsLog',
-        'Trace', 'URL', 'SourceMaps'],
-    };
-  }
-
-  /**
-   * @param {{originalSize: number, jpegSize: number}} image
-   * @return {{bytes: number, percent: number}}
-   */
-  static computeSavings(image) {
-    const bytes = image.originalSize - image.jpegSize;
-    const percent = 100 * bytes / image.originalSize;
-    return {bytes, percent};
-  }
-
-  /**
-   * @param {{naturalWidth: number, naturalHeight: number}} imageElement
-   * @return {number}
-   */
-  static estimateJPEGSizeFromDimensions(imageElement) {
-    const totalPixels = imageElement.naturalWidth * imageElement.naturalHeight;
-    // Even JPEGs with lots of detail can usually be compressed down to <1 byte per pixel
-    // Using 4:2:2 subsampling already gets an uncompressed bitmap to 2 bytes per pixel.
-    // The compression ratio for JPEG is usually somewhere around 10:1 depending on content, so
-    // 8:1 is a reasonable expectation for web content which is 1.5MB for a 6MP image.
-    const expectedBytesPerPixel = 2 * 1 / 8;
-    return Math.round(totalPixels * expectedBytesPerPixel);
-  }
-
-  /**
-   * @param {LH.Artifacts} artifacts
-   * @return {import('./byte-efficiency-audit.js').ByteEfficiencyProduct}
-   */
-  static audit_(artifacts) {
-    const pageURL = artifacts.URL.finalDisplayedUrl;
-    const images = artifacts.OptimizedImages;
-    const imageElements = artifacts.ImageElements;
-    /** @type {Map<string, LH.Artifacts.ImageElement>} */
-    const imageElementsByURL = new Map();
-    imageElements.forEach(img => imageElementsByURL.set(img.src, img));
-
-    /** @type {Array<{node?: LH.Audit.Details.NodeValue, url: string, fromProtocol: boolean, isCrossOrigin: boolean, totalBytes: number, wastedBytes: number}>} */
-    const items = [];
-    const warnings = [];
-    for (const image of images) {
-      const imageElement = imageElementsByURL.get(image.url);
-
-      if (image.failed) {
-        warnings.push(`Unable to decode ${UrlUtils.getURLDisplayName(image.url)}`);
-        continue;
-      } else if (/(jpeg|bmp)/.test(image.mimeType) === false) {
-        continue;
-      }
-
-      let jpegSize = image.jpegSize;
-      let fromProtocol = true;
-
-      if (typeof jpegSize === 'undefined') {
-        if (!imageElement) {
-          warnings.push(`Unable to locate resource ${UrlUtils.getURLDisplayName(image.url)}`);
-          continue;
-        }
-
-        // Skip if we couldn't collect natural image size information.
-        if (!imageElement.naturalDimensions) continue;
-        const naturalHeight = imageElement.naturalDimensions.height;
-        const naturalWidth = imageElement.naturalDimensions.width;
-        // If naturalHeight or naturalWidth are falsy, information is not valid, skip.
-        if (!naturalHeight || !naturalWidth) continue;
-        jpegSize =
-          UsesOptimizedImages.estimateJPEGSizeFromDimensions({naturalHeight, naturalWidth});
-        fromProtocol = false;
-      }
-
-      if (image.originalSize < jpegSize + IGNORE_THRESHOLD_IN_BYTES) continue;
-
-      const url = UrlUtils.elideDataURI(image.url);
-      const isCrossOrigin = !UrlUtils.originsMatch(pageURL, image.url);
-      const jpegSavings = UsesOptimizedImages.computeSavings({...image, jpegSize});
-
-      items.push({
-        node: imageElement ? ByteEfficiencyAudit.makeNodeItem(imageElement.node) : undefined,
-        url,
-        fromProtocol,
-        isCrossOrigin,
-        totalBytes: image.originalSize,
-        wastedBytes: jpegSavings.bytes,
-      });
-    }
-
-    /** @type {LH.Audit.Details.Opportunity['headings']} */
-    const headings = [
-      {key: 'node', valueType: 'node', label: ''},
-      {key: 'url', valueType: 'url', label: str_(i18n.UIStrings.columnURL)},
-      {key: 'totalBytes', valueType: 'bytes', label: str_(i18n.UIStrings.columnResourceSize)},
-      {key: 'wastedBytes', valueType: 'bytes', label: str_(i18n.UIStrings.columnWastedBytes)},
-    ];
-
-    return {
-      warnings,
-      items,
-      headings,
-    };
-  }
-}
-
-export default UsesOptimizedImages;
-export {UIStrings};

package/core/audits/byte-efficiency/uses-responsive-images-snapshot.d.ts

@@ -1,16 +0,0 @@
-export default UsesResponsiveImagesSnapshot;
-declare class UsesResponsiveImagesSnapshot extends Audit {
-    /**
-     * @param {LH.Artifacts} artifacts
-     * @return {Promise<LH.Audit.Product>}
-     */
-    static audit(artifacts: LH.Artifacts): Promise<LH.Audit.Product>;
-}
-export namespace UIStrings {
-    let title: string;
-    let failureTitle: string;
-    let columnDisplayedDimensions: string;
-    let columnActualDimensions: string;
-}
-import { Audit } from '../audit.js';
-//# sourceMappingURL=uses-responsive-images-snapshot.d.ts.map

package/core/audits/byte-efficiency/uses-responsive-images-snapshot.js

@@ -1,106 +0,0 @@
-/**
- * @license
- * Copyright 2021 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-/**
- * @fileoverview Checks to see if the images used on the page are larger than
- *   their display sizes. The audit will list all images that are larger than
- *   their display size with DPR (a 1000px wide image displayed as a
- *   500px high-res image on a Retina display is 100% used);
- */
-
-
-import {Audit} from '../audit.js';
-import * as UsesResponsiveImages from './uses-responsive-images.js';
-import UrlUtils from '../../lib/url-utils.js';
-import * as i18n from '../../lib/i18n/i18n.js';
-
-const UIStrings = {
-  /** Descriptive title of a Lighthouse audit that checks if images match their displayed dimensions. This is displayed when the audit is passing. */
-  title: 'Images were appropriate for their displayed size',
-  /** Descriptive title of a Lighthouse audit that checks if images match their displayed dimensions. This is displayed when the audit is failing. */
-  failureTitle: 'Images were larger than their displayed size',
-  /** Label for a column in a data table; entries will be the dimensions of an image as it appears on the page. */
-  columnDisplayedDimensions: 'Displayed dimensions',
-  /** Label for a column in a data table; entries will be the dimensions of an image from it's source file. */
-  columnActualDimensions: 'Actual dimensions',
-};
-
-const str_ = i18n.createIcuMessageFn(import.meta.url, UIStrings);
-
-// Based on byte threshold of 4096, with 3 bytes per pixel.
-const IGNORE_THRESHOLD_IN_PIXELS = 1365;
-
-class UsesResponsiveImagesSnapshot extends Audit {
-  /**
-   * @return {LH.Audit.Meta}
-   */
-  static get meta() {
-    return {
-      id: 'uses-responsive-images-snapshot',
-      title: str_(UIStrings.title),
-      failureTitle: str_(UIStrings.failureTitle),
-      description: UsesResponsiveImages.str_(UsesResponsiveImages.UIStrings.description),
-      scoreDisplayMode: Audit.SCORING_MODES.METRIC_SAVINGS,
-      supportedModes: ['snapshot'],
-      guidanceLevel: 2,
-      requiredArtifacts: ['ImageElements', 'ViewportDimensions'],
-    };
-  }
-
-  /**
-   * @param {LH.Artifacts} artifacts
-   * @return {Promise<LH.Audit.Product>}
-   */
-  static async audit(artifacts) {
-    let score = 1;
-    /** @type {LH.Audit.Details.TableItem[]} */
-    const items = [];
-    for (const image of artifacts.ImageElements) {
-      // Ignore CSS images because it's difficult to determine what is a spritesheet,
-      // and the reward-to-effort ratio for responsive CSS images is quite low https://css-tricks.com/responsive-images-css/.
-      if (image.isCss) continue;
-
-      if (!image.naturalDimensions) continue;
-      const actual = image.naturalDimensions;
-      const displayed = UsesResponsiveImages.default.getDisplayedDimensions(
-        {...image, naturalWidth: actual.width, naturalHeight: actual.height},
-        artifacts.ViewportDimensions
-      );
-
-      const actualPixels = actual.width * actual.height;
-      const usedPixels = displayed.width * displayed.height;
-
-      if (actualPixels <= usedPixels) continue;
-      if (actualPixels - usedPixels > IGNORE_THRESHOLD_IN_PIXELS) score = 0;
-
-      items.push({
-        node: Audit.makeNodeItem(image.node),
-        url: UrlUtils.elideDataURI(image.src),
-        displayedDimensions: `${displayed.width}x${displayed.height}`,
-        actualDimensions: `${actual.width}x${actual.height}`,
-      });
-    }
-
-    /** @type {LH.Audit.Details.Table['headings']} */
-    const headings = [
-      /* eslint-disable max-len */
-      {key: 'node', valueType: 'node', label: ''},
-      {key: 'url', valueType: 'url', label: str_(i18n.UIStrings.columnURL)},
-      {key: 'displayedDimensions', valueType: 'text', label: str_(UIStrings.columnDisplayedDimensions)},
-      {key: 'actualDimensions', valueType: 'text', label: str_(UIStrings.columnActualDimensions)},
-      /* eslint-enable max-len */
-    ];
-
-    const details = Audit.makeTableDetails(headings, items);
-
-    return {
-      score,
-      details,
-    };
-  }
-}
-
-export default UsesResponsiveImagesSnapshot;
-export {UIStrings};

package/core/audits/byte-efficiency/uses-responsive-images.d.ts

@@ -1,44 +0,0 @@
-export default UsesResponsiveImages;
-declare class UsesResponsiveImages extends ByteEfficiencyAudit {
-    /**
-     * @param {LH.Artifacts.ImageElement & {naturalWidth: number, naturalHeight: number}} image
-     * @param {LH.Artifacts.ViewportDimensions} ViewportDimensions
-     * @return {{width: number, height: number}};
-     */
-    static getDisplayedDimensions(image: LH.Artifacts.ImageElement & {
-        naturalWidth: number;
-        naturalHeight: number;
-    }, ViewportDimensions: LH.Artifacts.ViewportDimensions): {
-        width: number;
-        height: number;
-    };
-    /**
-     * @param {LH.Artifacts.ImageElement & {naturalWidth: number, naturalHeight: number}} image
-     * @param {LH.Artifacts.ViewportDimensions} ViewportDimensions
-     * @param {Array<LH.Artifacts.NetworkRequest>} networkRecords
-     * @return {null|LH.Audit.ByteEfficiencyItem};
-     */
-    static computeWaste(image: LH.Artifacts.ImageElement & {
-        naturalWidth: number;
-        naturalHeight: number;
-    }, ViewportDimensions: LH.Artifacts.ViewportDimensions, networkRecords: Array<LH.Artifacts.NetworkRequest>): null | LH.Audit.ByteEfficiencyItem;
-    /**
-     * @param {LH.Artifacts.ImageElement} image
-     * @return {number};
-     */
-    static determineAllowableWaste(image: LH.Artifacts.ImageElement): number;
-    /**
-     * @param {LH.Artifacts} artifacts
-     * @param {Array<LH.Artifacts.NetworkRequest>} networkRecords
-     * @param {LH.Audit.Context} context
-     * @return {Promise<import('./byte-efficiency-audit.js').ByteEfficiencyProduct>}
-     */
-    static audit_(artifacts: LH.Artifacts, networkRecords: Array<LH.Artifacts.NetworkRequest>, context: LH.Audit.Context): Promise<import("./byte-efficiency-audit.js").ByteEfficiencyProduct>;
-}
-export namespace UIStrings {
-    let title: string;
-    let description: string;
-}
-export const str_: (message: string, values?: Record<string, string | number>) => LH.IcuMessage;
-import { ByteEfficiencyAudit } from './byte-efficiency-audit.js';
-//# sourceMappingURL=uses-responsive-images.d.ts.map

package/core/audits/byte-efficiency/uses-responsive-images.js

@@ -1,202 +0,0 @@
-/**
- * @license
- * Copyright 2017 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-/**
- * @fileoverview Checks to see if the images used on the page are larger than
- *   their display sizes. The audit will list all images that are larger than
- *   their display size with DPR (a 1000px wide image displayed as a
- *   500px high-res image on a Retina display is 100% used);
- *   However, the audit will only fail pages that use images that have waste
- *   beyond a particular byte threshold.
- */
-
-
-import {ByteEfficiencyAudit} from './byte-efficiency-audit.js';
-import {NetworkRequest} from '../../lib/network-request.js';
-import {ImageRecords} from '../../computed/image-records.js';
-import UrlUtils from '../../lib/url-utils.js';
-import * as i18n from '../../lib/i18n/i18n.js';
-
-const UIStrings = {
-  /** Imperative title of a Lighthouse audit that tells the user to resize images to match the display dimensions. This is displayed in a list of audit titles that Lighthouse generates. */
-  title: 'Properly size images',
-  /** Description of a Lighthouse audit that tells the user *why* they need to serve appropriately sized images. 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:
-  'Serve images that are appropriately-sized to save cellular data ' +
-  'and improve load time. ' +
-  '[Learn how to size images](https://developer.chrome.com/docs/lighthouse/performance/uses-responsive-images/).',
-};
-
-const str_ = i18n.createIcuMessageFn(import.meta.url, UIStrings);
-
-const IGNORE_THRESHOLD_IN_BYTES = 4096;
-
-// Ignore up to 12KB of waste if an effort was made with breakpoints.
-const IGNORE_THRESHOLD_IN_BYTES_BREAKPOINTS_PRESENT = 12288;
-
-class UsesResponsiveImages extends ByteEfficiencyAudit {
-  /**
-   * @return {LH.Audit.Meta}
-   */
-  static get meta() {
-    return {
-      id: 'uses-responsive-images',
-      title: str_(UIStrings.title),
-      description: str_(UIStrings.description),
-      scoreDisplayMode: ByteEfficiencyAudit.SCORING_MODES.METRIC_SAVINGS,
-      guidanceLevel: 2,
-      requiredArtifacts: ['ImageElements', 'ViewportDimensions', 'GatherContext',
-        'DevtoolsLog', 'Trace', 'URL', 'SourceMaps'],
-    };
-  }
-
-  /**
-   * @param {LH.Artifacts.ImageElement & {naturalWidth: number, naturalHeight: number}} image
-   * @param {LH.Artifacts.ViewportDimensions} ViewportDimensions
-   * @return {{width: number, height: number}};
-   */
-  static getDisplayedDimensions(image, ViewportDimensions) {
-    if (image.displayedWidth && image.displayedHeight) {
-      return {
-        width: image.displayedWidth * ViewportDimensions.devicePixelRatio,
-        height: image.displayedHeight * ViewportDimensions.devicePixelRatio,
-      };
-    }
-
-    // If the image has 0 dimensions, it's probably hidden/offscreen, so we'll be as forgiving as possible
-    // and assume it's the size of two viewports. See https://github.com/GoogleChrome/lighthouse/issues/7236
-    const viewportWidth = ViewportDimensions.innerWidth;
-    const viewportHeight = ViewportDimensions.innerHeight * 2;
-    const imageAspectRatio = image.naturalWidth / image.naturalHeight;
-    const viewportAspectRatio = viewportWidth / viewportHeight;
-    let usedViewportWidth = viewportWidth;
-    let usedViewportHeight = viewportHeight;
-    if (imageAspectRatio > viewportAspectRatio) {
-      usedViewportHeight = viewportWidth / imageAspectRatio;
-    } else {
-      usedViewportWidth = viewportHeight * imageAspectRatio;
-    }
-
-    return {
-      width: usedViewportWidth * ViewportDimensions.devicePixelRatio,
-      height: usedViewportHeight * ViewportDimensions.devicePixelRatio,
-    };
-  }
-
-  /**
-   * @param {LH.Artifacts.ImageElement & {naturalWidth: number, naturalHeight: number}} image
-   * @param {LH.Artifacts.ViewportDimensions} ViewportDimensions
-   * @param {Array<LH.Artifacts.NetworkRequest>} networkRecords
-   * @return {null|LH.Audit.ByteEfficiencyItem};
-   */
-  static computeWaste(image, ViewportDimensions, networkRecords) {
-    const networkRecord = networkRecords.find(record => record.url === image.src);
-    // Nothing can be done without network info, ignore images without resource size information.
-    if (!networkRecord) {
-      return null;
-    }
-
-    const displayed = this.getDisplayedDimensions(image, ViewportDimensions);
-    const usedPixels = displayed.width * displayed.height;
-
-    const url = UrlUtils.elideDataURI(image.src);
-    const actualPixels = image.naturalWidth * image.naturalHeight;
-    const wastedRatio = 1 - (usedPixels / actualPixels);
-    const totalBytes = NetworkRequest.getResourceSizeOnNetwork(networkRecord);
-    const wastedBytes = Math.round(totalBytes * wastedRatio);
-
-    return {
-      node: ByteEfficiencyAudit.makeNodeItem(image.node),
-      url,
-      totalBytes,
-      wastedBytes,
-      wastedPercent: 100 * wastedRatio,
-    };
-  }
-
-
-  /**
-   * @param {LH.Artifacts.ImageElement} image
-   * @return {number};
-   */
-  static determineAllowableWaste(image) {
-    if (image.srcset || image.isPicture) {
-      return IGNORE_THRESHOLD_IN_BYTES_BREAKPOINTS_PRESENT;
-    }
-    return IGNORE_THRESHOLD_IN_BYTES;
-  }
-
-  /**
-   * @param {LH.Artifacts} artifacts
-   * @param {Array<LH.Artifacts.NetworkRequest>} networkRecords
-   * @param {LH.Audit.Context} context
-   * @return {Promise<import('./byte-efficiency-audit.js').ByteEfficiencyProduct>}
-   */
-  static async audit_(artifacts, networkRecords, context) {
-    const images = await ImageRecords.request({
-      ImageElements: artifacts.ImageElements,
-      networkRecords,
-    }, context);
-    const ViewportDimensions = artifacts.ViewportDimensions;
-    /** @type {Map<string, LH.Audit.ByteEfficiencyItem>} */
-    const resultsMap = new Map();
-    /** @type {Array<string>} */
-    const passedImageList = [];
-    for (const image of images) {
-      // Give SVG a free pass because creating a "responsive" SVG is of questionable value.
-      // Ignore CSS images because it's difficult to determine what is a spritesheet,
-      // and the reward-to-effort ratio for responsive CSS images is quite low https://css-tricks.com/responsive-images-css/.
-      if (image.mimeType === 'image/svg+xml' || image.isCss) {
-        continue;
-      }
-
-      // Skip if we couldn't collect natural image size information.
-      if (!image.naturalDimensions) continue;
-      const naturalHeight = image.naturalDimensions.height;
-      const naturalWidth = image.naturalDimensions.width;
-      // If naturalHeight or naturalWidth are falsy, information is not valid, skip.
-      if (!naturalWidth || !naturalHeight) continue;
-      const processed =
-        UsesResponsiveImages.computeWaste(
-          {...image, naturalHeight, naturalWidth},
-          ViewportDimensions, networkRecords
-        );
-      if (!processed) continue;
-
-      // Verify the image wastes more than the minimum.
-      const exceedsAllowableWaste = processed.wastedBytes > this.determineAllowableWaste(image);
-
-      const existing = resultsMap.get(processed.url);
-      // Don't warn about an image that was later used appropriately, or wastes a trivial amount of data.
-      if (exceedsAllowableWaste && !passedImageList.includes(processed.url)) {
-        if ((!existing || existing.wastedBytes > processed.wastedBytes)) {
-          resultsMap.set(processed.url, processed);
-        }
-      } else {
-        // Ensure this url passes for future tests.
-        resultsMap.delete(processed.url);
-        passedImageList.push(processed.url);
-      }
-    }
-
-    const items = Array.from(resultsMap.values());
-
-    /** @type {LH.Audit.Details.Opportunity['headings']} */
-    const headings = [
-      {key: 'node', valueType: 'node', label: ''},
-      {key: 'url', valueType: 'url', label: str_(i18n.UIStrings.columnURL)},
-      {key: 'totalBytes', valueType: 'bytes', label: str_(i18n.UIStrings.columnResourceSize)},
-      {key: 'wastedBytes', valueType: 'bytes', label: str_(i18n.UIStrings.columnWastedBytes)},
-    ];
-
-    return {
-      items,
-      headings,
-    };
-  }
-}
-
-export default UsesResponsiveImages;
-export {UIStrings, str_};

package/core/audits/byte-efficiency/uses-text-compression.d.ts

@@ -1,14 +0,0 @@
-export default ResponsesAreCompressed;
-declare class ResponsesAreCompressed extends ByteEfficiencyAudit {
-    /**
-     * @param {LH.Artifacts} artifacts
-     * @return {import('./byte-efficiency-audit.js').ByteEfficiencyProduct}
-     */
-    static audit_(artifacts: LH.Artifacts): import("./byte-efficiency-audit.js").ByteEfficiencyProduct;
-}
-export namespace UIStrings {
-    let title: string;
-    let description: string;
-}
-import { ByteEfficiencyAudit } from './byte-efficiency-audit.js';
-//# sourceMappingURL=uses-text-compression.d.ts.map

package/core/audits/byte-efficiency/uses-text-compression.js

@@ -1,108 +0,0 @@
-/**
- * @license
- * Copyright 2017 Google LLC
- * SPDX-License-Identifier: Apache-2.0
- */
-/*
- * @fileoverview Audit a page to ensure that resources loaded with
- * gzip/br/deflate compression.
- */
-
-
-import {ByteEfficiencyAudit} from './byte-efficiency-audit.js';
-import UrlUtils from '../../lib/url-utils.js';
-import * as i18n from '../../lib/i18n/i18n.js';
-
-const UIStrings = {
-  /** Imperative title of a Lighthouse audit that tells the user to enable text compression (like gzip) in order to enhance the performance of a page. This is displayed in a list of audit titles that Lighthouse generates. */
-  title: 'Enable text compression',
-  /** Description of a Lighthouse audit that tells the user *why* their text-based resources should be served with compression (like gzip). 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: 'Text-based resources should be served with compression (gzip, deflate or' +
-    ' brotli) to minimize total network bytes.' +
-    ' [Learn more about text compression](https://developer.chrome.com/docs/lighthouse/performance/uses-text-compression/).',
-};
-
-const str_ = i18n.createIcuMessageFn(import.meta.url, UIStrings);
-
-const IGNORE_THRESHOLD_IN_BYTES = 1400;
-const IGNORE_THRESHOLD_IN_PERCENT = 0.1;
-
-class ResponsesAreCompressed extends ByteEfficiencyAudit {
-  /**
-   * @return {LH.Audit.Meta}
-   */
-  static get meta() {
-    return {
-      id: 'uses-text-compression',
-      title: str_(UIStrings.title),
-      description: str_(UIStrings.description),
-      scoreDisplayMode: ByteEfficiencyAudit.SCORING_MODES.METRIC_SAVINGS,
-      guidanceLevel: 3,
-      requiredArtifacts: ['ResponseCompression', 'GatherContext', 'DevtoolsLog', 'Trace', 'URL',
-        'SourceMaps'],
-    };
-  }
-
-  /**
-   * @param {LH.Artifacts} artifacts
-   * @return {import('./byte-efficiency-audit.js').ByteEfficiencyProduct}
-   */
-  static audit_(artifacts) {
-    const uncompressedResponses = artifacts.ResponseCompression;
-
-    /** @type {Array<LH.Audit.ByteEfficiencyItem>} */
-    const items = [];
-    uncompressedResponses.forEach(record => {
-      // Ignore invalid GZIP size values (undefined, NaN, 0, -n, etc)
-      if (!record.gzipSize || record.gzipSize < 0) return;
-
-      const originalSize = record.resourceSize;
-      const gzipSize = record.gzipSize;
-      const gzipSavings = originalSize - gzipSize;
-
-      // Not every resource is smaller when compressed.
-      if (record.transferSize < gzipSize) {
-        return;
-      }
-
-      // If savings is small, let's be generous and not surface the minor savings.
-      if (gzipSavings < IGNORE_THRESHOLD_IN_BYTES) {
-        return;
-      }
-
-      // Require at least 20kb of savings ... or some percentage of total resource size.
-      if (gzipSavings < 20_000 && 1 - gzipSize / originalSize < IGNORE_THRESHOLD_IN_PERCENT) {
-        return;
-      }
-
-      // remove duplicates
-      const url = UrlUtils.elideDataURI(record.url);
-      const isDuplicate = items.find(item => item.url === url &&
-        item.totalBytes === record.resourceSize);
-      if (isDuplicate) {
-        return;
-      }
-
-      items.push({
-        url,
-        totalBytes: originalSize,
-        wastedBytes: gzipSavings,
-      });
-    });
-
-    /** @type {LH.Audit.Details.Opportunity['headings']} */
-    const headings = [
-      {key: 'url', valueType: 'url', label: str_(i18n.UIStrings.columnURL)},
-      {key: 'totalBytes', valueType: 'bytes', label: str_(i18n.UIStrings.columnTransferSize)},
-      {key: 'wastedBytes', valueType: 'bytes', label: str_(i18n.UIStrings.columnWastedBytes)},
-    ];
-
-    return {
-      items,
-      headings,
-    };
-  }
-}
-
-export default ResponsesAreCompressed;
-export {UIStrings};