lighthouse 10.0.2-dev.20230320 → 10.0.2-dev.20230322

package/flow-report/src/summary/category.tsx

@@ -42,7 +42,6 @@ function getScoreToBeGained(audit: ScoredAuditRef): number {
 function getOverallSavings(audit: LH.ReportResult.AuditRef): number {
   return (
     audit.result.details &&
-    audit.result.details.type === 'opportunity' &&
     audit.result.details.overallSavingsMs
   ) || 0;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "lighthouse",
   "type": "module",
-  "version": "10.0.2-dev.20230320",
+  "version": "10.0.2-dev.20230322",
   "description": "Automated auditing, performance metrics, and best practices for the web.",
   "main": "./core/index.js",
   "bin": {
@@ -173,7 +173,7 @@
     "resolve": "^1.20.0",
     "rollup": "^2.52.7",
     "rollup-plugin-node-resolve": "^5.2.0",
-    "rollup-plugin-polyfill-node": "^0.8.0",
+    "rollup-plugin-polyfill-node": "^0.12.0",
     "rollup-plugin-replace": "^2.2.0",
     "rollup-plugin-shim": "^1.0.0",
     "rollup-plugin-terser": "^7.0.2",
@@ -192,7 +192,7 @@
     "configstore": "^5.0.1",
     "csp_evaluator": "1.1.1",
     "enquirer": "^2.3.6",
-    "http-link-header": "^0.8.0",
+    "http-link-header": "^1.1.0",
     "intl-messageformat": "^4.4.0",
     "jpeg-js": "^0.4.4",
     "js-library-detector": "^6.6.0",

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

@@ -68,7 +68,7 @@ export class PerformanceCategoryRenderer extends CategoryRenderer {
       return element;
     }
     const details = audit.result.details;
-    if (details.type !== 'opportunity') {
+    if (details.overallSavingsMs === undefined) {
       return element;
     }
 
@@ -98,7 +98,7 @@ export class PerformanceCategoryRenderer extends CategoryRenderer {
    * @return {number}
    */
   _getWastedMs(audit) {
-    if (audit.result.details && audit.result.details.type === 'opportunity') {
+    if (audit.result.details) {
       const details = audit.result.details;
       if (typeof details.overallSavingsMs !== 'number') {
         throw new Error('non-opportunity details passed to _getWastedMs');
@@ -165,7 +165,7 @@ export class PerformanceCategoryRenderer extends CategoryRenderer {
    */
   _classifyPerformanceAudit(audit) {
     if (audit.group) return null;
-    if (audit.result.details && audit.result.details.type === 'opportunity') {
+    if (audit.result.details?.overallSavingsMs !== undefined) {
       return 'load-opportunity';
     }
     return 'diagnostic';

package/shared/tsconfig.json

@@ -2,7 +2,7 @@
   "extends": "../tsconfig-base.json",
   "compilerOptions": {
     // Limit defs to base JS.
-    "lib": ["es2020"],
+    "lib": ["es2020", "es2022.intl"],
     // Only include `@types/node` from node_modules/.
     "types": ["node"],
     // "listFiles": true,

package/shared/util.d.ts

@@ -67,6 +67,12 @@ export class Util {
         isLink: false;
         text: string;
     }>;
+    /**
+     * @param {string} string
+     * @param {number} characterLimit
+     * @param {string} ellipseSuffix
+     */
+    static truncate(string: string, characterLimit: number, ellipseSuffix?: string): string;
     /**
      * @param {URL} parsedUrl
      * @param {{numPathParts?: number, preserveQuery?: boolean, preserveHost?: boolean}=} options

package/shared/util.js

@@ -153,6 +153,39 @@ class Util {
     return segments;
   }
 
+  /**
+   * @param {string} string
+   * @param {number} characterLimit
+   * @param {string} ellipseSuffix
+   */
+  static truncate(string, characterLimit, ellipseSuffix = '…') {
+    // Early return for the case where there are fewer bytes than the character limit.
+    if (string.length <= characterLimit) {
+      return string;
+    }
+
+    const segmenter = new Intl.Segmenter(undefined, {granularity: 'grapheme'});
+    const iterator = segmenter.segment(string)[Symbol.iterator]();
+
+    let lastSegmentIndex = 0;
+    for (let i = 0; i <= characterLimit - ellipseSuffix.length; i++) {
+      const result = iterator.next();
+      if (result.done) {
+        return string;
+      }
+
+      lastSegmentIndex = result.value.index;
+    }
+
+    for (let i = 0; i < ellipseSuffix.length; i++) {
+      if (iterator.next().done) {
+        return string;
+      }
+    }
+
+    return string.slice(0, lastSegmentIndex) + ellipseSuffix;
+  }
+
   /**
    * @param {URL} parsedUrl
    * @param {{numPathParts?: number, preserveQuery?: boolean, preserveHost?: boolean}=} options

package/types/artifacts.d.ts

@@ -974,6 +974,7 @@ export interface TraceEvent {
     };
     data?: {
       frame?: string;
+      frameID?: string;
       processId?: number;
       isLoadingMainFrame?: boolean;
       documentLoaderURL?: string;

package/types/lhr/audit-details.d.ts

@@ -7,6 +7,16 @@
 import {IcuMessage} from './i18n.js';
 import Treemap from './treemap.js';
 
+/** Common properties for all details types. */
+interface BaseDetails {
+  /** If present and audit is part of the performance category, audit is treated as an Opportunity. */
+  overallSavingsMs?: number;
+  /** Optional additional Opportunity information. */
+  overallSavingsBytes?: number;
+  /** Additional information, usually used for including debug or meta information in the LHR */
+  debugData?: Details.DebugData;
+}
+
 type Details =
   Details.CriticalRequestChain |
   Details.DebugData |
@@ -19,7 +29,7 @@ type Details =
 
 // Details namespace.
 declare module Details {
-  interface CriticalRequestChain {
+  interface CriticalRequestChain extends BaseDetails {
     type: 'criticalrequestchain';
     longestChain: {
       duration: number;
@@ -42,7 +52,7 @@ declare module Details {
     }
   }
 
-  interface Filmstrip {
+  interface Filmstrip extends BaseDetails {
     type: 'filmstrip';
     scale: number;
     items: {
@@ -55,20 +65,17 @@ declare module Details {
     }[];
   }
 
-  interface List {
+  interface List extends BaseDetails {
     type: 'list';
     // NOTE: any `Details` type *should* be usable in `items`, but check
     // styles/report-ui-features are good before adding.
     items: Array<Table | DebugData>;
   }
 
-  interface Opportunity {
+  interface Opportunity extends BaseDetails {
     type: 'opportunity';
-    overallSavingsMs: number;
-    overallSavingsBytes?: number;
     headings: TableColumnHeading[];
     items: OpportunityItem[];
-    debugData?: DebugData;
     /**
      * Columns to sort the items by, during grouping.
      * If omitted, entity groups will be sorted by the audit ordering vs. the new totals.
@@ -80,7 +87,7 @@ declare module Details {
     skipSumming?: Array<string>;
   }
 
-  interface Screenshot {
+  interface Screenshot extends BaseDetails {
     type: 'screenshot';
     timing: number;
     timestamp: number;
@@ -96,7 +103,7 @@ declare module Details {
     left: number;
   }
 
-  interface Table {
+  interface Table extends BaseDetails {
     type: 'table';
     headings: TableColumnHeading[];
     items: TableItem[];
@@ -104,7 +111,6 @@ declare module Details {
       wastedMs?: number;
       wastedBytes?: number;
     };
-    debugData?: DebugData;
     /**
      * Columns to sort the items by, during grouping.
      * If omitted, entity groups will be sorted by the audit ordering vs. the new totals.
@@ -131,7 +137,7 @@ declare module Details {
     [p: string]: any;
   }
 
-  interface TreemapData {
+  interface TreemapData extends BaseDetails {
     type: 'treemap-data';
     nodes: Treemap.Node[];
   }