report: group third-party entities (#14655)

GoogleChrome · Mar 6, 2023 · 5aca9f3 · 5aca9f3
1 parent 4336376
commit 5aca9f3
Show file tree

Hide file tree

Showing 37 changed files with 1,103 additions and 130 deletions.
diff --git a/core/audits/audit.js b/core/audits/audit.js
@@ -15,12 +15,18 @@ const DEFAULT_PASS = 'defaultPass';
  * @typedef TableOptions
  * @property {number=} wastedMs
  * @property {number=} wastedBytes
+ * @property {LH.Audit.Details.Table['sortedBy']=} sortedBy
+ * @property {LH.Audit.Details.Table['skipSumming']=} skipSumming
+ * @property {LH.Audit.Details.Table['isEntityGrouped']=} isEntityGrouped
  */
 
 /**
  * @typedef OpportunityOptions
  * @property {number} overallSavingsMs
  * @property {number=} overallSavingsBytes
+ * @property {LH.Audit.Details.Opportunity['sortedBy']=} sortedBy
+ * @property {LH.Audit.Details.Opportunity['skipSumming']=} skipSumming
+ * @property {LH.Audit.Details.Opportunity['isEntityGrouped']=} isEntityGrouped
  */
 
 /**
@@ -139,7 +145,7 @@ class Audit {
    * @return {LH.Audit.Details.Table}
    */
   static makeTableDetails(headings, results, options = {}) {
-    const {wastedBytes, wastedMs} = options;
+    const {wastedBytes, wastedMs, sortedBy, skipSumming, isEntityGrouped} = options;
     const summary = (wastedBytes || wastedMs) ? {wastedBytes, wastedMs} : undefined;
     if (results.length === 0) {
       return {
@@ -157,6 +163,9 @@ class Audit {
       headings: headings,
       items: results,
       summary,
+      sortedBy,
+      skipSumming,
+      isEntityGrouped,
     };
   }
 
@@ -234,14 +243,17 @@ class Audit {
    */
   static makeOpportunityDetails(headings, items, options) {
     Audit.assertHeadingKeysExist(headings, items);
-    const {overallSavingsMs, overallSavingsBytes} = options;
+    const {overallSavingsMs, overallSavingsBytes, sortedBy, skipSumming, isEntityGrouped} = options;
 
     return {
       type: 'opportunity',
       headings: items.length === 0 ? [] : headings,
       items,
       overallSavingsMs,
       overallSavingsBytes,
+      sortedBy,
+      skipSumming,
+      isEntityGrouped,
     };
   }
 

diff --git a/core/audits/bootup-time.js b/core/audits/bootup-time.js
@@ -117,8 +117,6 @@ class BootupTime extends Audit {
       runWarnings = [str_(UIStrings.chromeExtensionsWarning)];
     }
 
-    const summary = {wastedMs: totalBootupTime};
-
     /** @type {LH.Audit.Details.Table['headings']} */
     const headings = [
       {key: 'url', valueType: 'url', label: str_(i18n.UIStrings.columnURL)},
@@ -128,7 +126,8 @@ class BootupTime extends Audit {
         label: str_(UIStrings.columnScriptParse)},
     ];
 
-    const details = BootupTime.makeTableDetails(headings, results, summary);
+    const details = BootupTime.makeTableDetails(headings, results,
+      {wastedMs: totalBootupTime, sortedBy: ['total']});
 
     const score = Audit.computeLogNormalScore(
       {p10: context.options.p10, median: context.options.median},

diff --git a/core/audits/byte-efficiency/byte-efficiency-audit.js b/core/audits/byte-efficiency/byte-efficiency-audit.js
@@ -29,6 +29,7 @@ const WASTED_MS_FOR_SCORE_OF_ZERO = 5000;
  * @property {LH.IcuMessage} [displayValue]
  * @property {LH.IcuMessage} [explanation]
  * @property {Array<string | LH.IcuMessage>} [warnings]
+ * @property {Array<string>} [sortedBy]
  */
 
 /**
@@ -228,8 +229,9 @@ class ByteEfficiencyAudit extends Audit {
       displayValue = str_(i18n.UIStrings.displayValueByteSavings, {wastedBytes});
     }
 
+    const sortedBy = result.sortedBy || ['wastedBytes'];
     const details = Audit.makeOpportunityDetails(result.headings, results,
-      {overallSavingsMs: wastedMs, overallSavingsBytes: wastedBytes});
+      {overallSavingsMs: wastedMs, overallSavingsBytes: wastedBytes, sortedBy});
 
     return {
       explanation: result.explanation,

diff --git a/core/audits/byte-efficiency/total-byte-weight.js b/core/audits/byte-efficiency/total-byte-weight.js
@@ -93,7 +93,7 @@ class TotalByteWeight extends Audit {
       {key: 'totalBytes', valueType: 'bytes', label: str_(i18n.UIStrings.columnTransferSize)},
     ];
 
-    const tableDetails = Audit.makeTableDetails(headings, results);
+    const tableDetails = Audit.makeTableDetails(headings, results, {sortedBy: ['totalBytes']});
 
     return {
       score,

diff --git a/core/audits/byte-efficiency/uses-long-cache-ttl.js b/core/audits/byte-efficiency/uses-long-cache-ttl.js
@@ -280,8 +280,8 @@ class CacheHeaders extends Audit {
         displayUnit: 'kb', granularity: 1},
     ];
 
-    const summary = {wastedBytes: totalWastedBytes};
-    const details = Audit.makeTableDetails(headings, results, summary);
+    const details = Audit.makeTableDetails(headings, results,
+      {wastedBytes: totalWastedBytes, sortedBy: ['totalBytes'], skipSumming: ['cacheLifetimeMs']});
 
     return {
       score,

diff --git a/core/audits/long-tasks.js b/core/audits/long-tasks.js
@@ -104,7 +104,8 @@ class LongTasks extends Audit {
       /* eslint-enable max-len */
     ];
 
-    const tableDetails = Audit.makeTableDetails(headings, results);
+    const tableDetails = Audit.makeTableDetails(headings, results,
+      {sortedBy: ['duration'], skipSumming: ['startTime']});
 
     let displayValue;
     if (results.length > 0) {

diff --git a/core/audits/mainthread-work-breakdown.js b/core/audits/mainthread-work-breakdown.js
@@ -114,7 +114,8 @@ class MainThreadWorkBreakdown extends Audit {
     ];
 
     results.sort((a, b) => categoryTotals[b.group] - categoryTotals[a.group]);
-    const tableDetails = MainThreadWorkBreakdown.makeTableDetails(headings, results);
+    const tableDetails = MainThreadWorkBreakdown.makeTableDetails(headings, results,
+      {sortedBy: ['duration']});
 
     const score = Audit.computeLogNormalScore(
       {p10: context.options.p10, median: context.options.median},

diff --git a/core/audits/network-rtt.js b/core/audits/network-rtt.js
@@ -73,7 +73,7 @@ class NetworkRTT extends Audit {
       {key: 'rtt', valueType: 'ms', granularity: 1, label: str_(i18n.UIStrings.columnTimeSpent)},
     ];
 
-    const tableDetails = Audit.makeTableDetails(headings, results);
+    const tableDetails = Audit.makeTableDetails(headings, results, {sortedBy: ['rtt']});
 
     return {
       score: 1,

diff --git a/core/audits/network-server-latency.js b/core/audits/network-server-latency.js
@@ -72,7 +72,8 @@ class NetworkServerLatency extends Audit {
         label: str_(i18n.UIStrings.columnTimeSpent)},
     ];
 
-    const tableDetails = Audit.makeTableDetails(headings, results);
+    const tableDetails = Audit.makeTableDetails(headings, results,
+      {sortedBy: ['serverResponseTime']});
 
     return {
       score: Math.max(1 - (maxLatency / 500), 0),

diff --git a/core/audits/performance-budget.js b/core/audits/performance-budget.js
@@ -144,7 +144,7 @@ class ResourceBudget extends Audit {
 
     return {
       details: Audit.makeTableDetails(headers,
-        this.tableItems(budget, summary)),
+        this.tableItems(budget, summary), {sortedBy: ['sizeOverBudget']}),
       score: 1,
     };
   }

diff --git a/core/audits/prioritize-lcp-image.js b/core/audits/prioritize-lcp-image.js
@@ -319,7 +319,7 @@ class PrioritizeLcpImage extends Audit {
       {key: 'wastedMs', valueType: 'timespanMs', label: str_(i18n.UIStrings.columnWastedMs)},
     ];
     const details = Audit.makeOpportunityDetails(headings, results,
-      {overallSavingsMs: wastedMs});
+      {overallSavingsMs: wastedMs, sortedBy: ['wastedMs']});
 
     // If LCP element was an image and had valid network records (regardless of
     // if it should be preloaded), it will be found first in the `initiatorPath`.

diff --git a/core/audits/third-party-summary.js b/core/audits/third-party-summary.js
@@ -243,12 +243,15 @@ class ThirdPartySummary extends Audit {
       };
     }
 
+    const details = Audit.makeTableDetails(headings, results,
+      {...overallSummary, isEntityGrouped: true});
+
     return {
       score: Number(overallSummary.wastedMs <= PASS_THRESHOLD_IN_MS),
       displayValue: str_(UIStrings.displayValue, {
         timeInMs: overallSummary.wastedMs,
       }),
-      details: Audit.makeTableDetails(headings, results, overallSummary),
+      details,
     };
   }
 }

diff --git a/core/audits/timing-budget.js b/core/audits/timing-budget.js
@@ -164,7 +164,8 @@ class TimingBudget extends Audit {
     ];
 
     return {
-      details: Audit.makeTableDetails(headers, this.tableItems(budget, summary)),
+      details: Audit.makeTableDetails(headers, this.tableItems(budget, summary),
+      {sortedBy: ['overBudget']}),
       score: 1,
     };
   }

diff --git a/core/audits/uses-rel-preconnect.js b/core/audits/uses-rel-preconnect.js
@@ -234,7 +234,7 @@ class UsesRelPreconnectAudit extends Audit {
     ];
 
     const details = Audit.makeOpportunityDetails(headings, results,
-      {overallSavingsMs: maxWasted});
+      {overallSavingsMs: maxWasted, sortedBy: ['wastedMs']});
 
     return {
       score: ByteEfficiencyAudit.scoreForWastedMs(maxWasted),

diff --git a/core/audits/uses-rel-preload.js b/core/audits/uses-rel-preload.js
@@ -240,7 +240,7 @@ class UsesRelPreloadAudit extends Audit {
       {key: 'wastedMs', valueType: 'timespanMs', label: str_(i18n.UIStrings.columnWastedMs)},
     ];
     const details = Audit.makeOpportunityDetails(headings, results,
-      {overallSavingsMs: wastedMs});
+      {overallSavingsMs: wastedMs, sortedBy: ['wastedMs']});
 
     return {
       score: ByteEfficiencyAudit.scoreForWastedMs(wastedMs),

diff --git a/core/audits/work-during-interaction.js b/core/audits/work-during-interaction.js
@@ -193,7 +193,7 @@ class WorkDuringInteraction extends Audit {
     ];
 
     return {
-      table: Audit.makeTableDetails(headings, items),
+      table: Audit.makeTableDetails(headings, items, {sortedBy: ['total']}),
       phases,
     };
   }

diff --git a/core/lib/lighthouse-compatibility.js b/core/lib/lighthouse-compatibility.js
@@ -81,6 +81,23 @@ function upgradeLhrForCompatibility(lhr) {
         }
       }
 
+      // In 10.0, third-party-summary deprecated entity: LinkValue and switched to entity name string
+      if (audit.id === 'third-party-summary') {
+        if (audit.details.type === 'opportunity' || audit.details.type === 'table') {
+          const {headings, items} = audit.details;
+          if (headings[0].valueType === 'link') {
+            // Apply upgrade only if we are dealing with an older version (valueType=link marker).
+            headings[0].valueType = 'text';
+            for (const item of items) {
+              if (typeof item.entity === 'object' && item.entity.type === 'link') {
+                item.entity = item.entity.text;
+              }
+            }
+            audit.details.isEntityGrouped = true;
+          }
+        }
+      }
+
       // TODO: convert printf-style displayValue.
       // Added:   #5099, v3
       // Removed: #6767, v4

diff --git a/core/runner.js b/core/runner.js
@@ -170,6 +170,7 @@ class Runner {
       // Reduce payload size in LHR JSON by omitting whats falsy.
       if (entity === classifiedEntities.firstParty) shortEntity.isFirstParty = true;
       if (entity.isUnrecognized) shortEntity.isUnrecognized = true;
+      if (entity.category) shortEntity.category = entity.category;
       entities.push(shortEntity);
     }
 

diff --git a/core/test/audits/byte-efficiency/byte-efficiency-audit-test.js b/core/test/audits/byte-efficiency/byte-efficiency-audit-test.js
@@ -356,6 +356,7 @@ describe('Byte efficiency base audit', () => {
       GatherContext: {gatherMode: 'timespan'},
       traces: {defaultPass: trace},
       devtoolsLogs: {defaultPass: []},
+      URL: {},
     };
     const computedCache = new Map();
 

diff --git a/core/test/audits/byte-efficiency/total-byte-weight-test.js b/core/test/audits/byte-efficiency/total-byte-weight-test.js
@@ -34,6 +34,7 @@ function generateArtifacts(records) {
 
   return {
     devtoolsLogs: {defaultPass: networkRecordsToDevtoolsLog(records)},
+    URL: {},
   };
 }
 

diff --git a/core/test/audits/byte-efficiency/uses-long-cache-ttl-test.js b/core/test/audits/byte-efficiency/uses-long-cache-ttl-test.js
@@ -48,6 +48,7 @@ describe('Cache headers audit', () => {
       devtoolsLogs: {
         [CacheHeadersAudit.DEFAULT_PASS]: devtoolLogs,
       },
+      URL: {},
     };
   }
 

diff --git a/core/test/audits/work-during-interaction-test.js b/core/test/audits/work-during-interaction-test.js
@@ -63,6 +63,7 @@ Object {
             "valueType": "node",
           },
         ],
+        "isEntityGrouped": undefined,
         "items": Array [
           Object {
             "node": Object {
@@ -83,6 +84,8 @@ Object {
             },
           },
         ],
+        "skipSumming": undefined,
+        "sortedBy": undefined,
         "summary": undefined,
         "type": "table",
       },
@@ -139,6 +142,7 @@ Object {
             "valueType": "ms",
           },
         ],
+        "isEntityGrouped": undefined,
         "items": Array [
           Object {
             "phase": Object {
@@ -215,6 +219,10 @@ Object {
             "total": 285,
           },
         ],
+        "skipSumming": undefined,
+        "sortedBy": Array [
+          "total",
+        ],
         "summary": undefined,
         "type": "table",
       },
-Original file line number
+Diff line change
@@ Expand Up / @@ -193,7 +193,7 @@ class WorkDuringInteraction extends Audit { @@
         ];
         return {
-          table: Audit.makeTableDetails(headings, items),
+          table: Audit.makeTableDetails(headings, items, {sortedBy: ['total']}),
           phases,
         };
       }
@@ Expand Down @@