new_audit: entity-classification

core/audits/audit.js

@@ -214,17 +214,23 @@ class Audit {
   /**
    * @param {LH.Audit.Details.Opportunity['headings']} headings
    * @param {LH.Audit.Details.Opportunity['items']} items
+   * @param {LH.Artifacts.EntityClassification|null} classifiedEntities
    * @param {number} overallSavingsMs
    * @param {number=} overallSavingsBytes
    * @return {LH.Audit.Details.Opportunity}
    */
-  static makeOpportunityDetails(headings, items, overallSavingsMs, overallSavingsBytes) {
+  static makeOpportunityDetails(headings, items, classifiedEntities,
+      overallSavingsMs, overallSavingsBytes) {
     Audit.assertHeadingKeysExist(headings, items);
 
     return {
       type: 'opportunity',
       headings: items.length === 0 ? [] : headings,
-      items,
+      items: items.map(
+        // We let an existing item.entity take precedence if it was set during
+        // the audit (eg., uses-rel-preconnect).
+        item => ({entity: classifiedEntities?.getEntityName(item.url), ...item})
+      ),
       overallSavingsMs,
       overallSavingsBytes,
     };

core/audits/bootup-time.js

@@ -5,6 +5,7 @@
  */
 
 import {Audit} from './audit.js';
+import {EntityClassification} from '../computed/entity-classification.js';
 import {taskGroups} from '../lib/tracehouse/task-groups.js';
 import * as i18n from '../lib/i18n/i18n.js';
 import {NetworkRecords} from '../computed/network-records.js';
@@ -44,7 +45,7 @@ class BootupTime extends Audit {
       failureTitle: str_(UIStrings.failureTitle),
       description: str_(UIStrings.description),
       scoreDisplayMode: Audit.SCORING_MODES.NUMERIC,
-      requiredArtifacts: ['traces', 'devtoolsLogs'],
+      requiredArtifacts: ['traces', 'devtoolsLogs', 'URL'],
     };
   }
 
@@ -72,6 +73,8 @@ class BootupTime extends Audit {
     const devtoolsLog = artifacts.devtoolsLogs[BootupTime.DEFAULT_PASS];
     const networkRecords = await NetworkRecords.request(devtoolsLog, context);
     const tasks = await MainThreadTasks.request(trace, context);
+    const classifiedEntities = await EntityClassification.request(
+      {URL: artifacts.URL, devtoolsLog}, context);
     const multiplier = settings.throttlingMethod === 'simulate' ?
       settings.throttling.cpuSlowdownMultiplier : 1;
 
@@ -105,6 +108,7 @@ class BootupTime extends Audit {
           // Highlight the JavaScript task costs
           scripting: scriptingTotal,
           scriptParseCompile: parseCompileTotal,
+          entity: classifiedEntities?.getEntityName(url),
         };
       })
       .filter(result => result.total >= context.options.thresholdInMs)

core/audits/byte-efficiency/byte-efficiency-audit.js

@@ -5,6 +5,7 @@
  */
 
 import {Audit} from '../audit.js';
+import {EntityClassification} from '../../computed/entity-classification.js';
 import {linearInterpolation} from '../../lib/statistics.js';
 import {LanternInteractive} from '../../computed/metrics/lantern-interactive.js';
 import * as i18n from '../../lib/i18n/i18n.js';
@@ -116,6 +117,7 @@ class ByteEfficiencyAudit extends Audit {
     };
     const networkRecords = await NetworkRecords.request(devtoolsLog, context);
     const hasContentfulRecords = networkRecords.some(record => record.transferSize);
+    const classifiedEntities = await EntityClassification.request({URL, devtoolsLog}, context);
 
     // Requesting load simulator requires non-empty network records.
     // Timespans are not guaranteed to have any network activity.
@@ -136,7 +138,7 @@ class ByteEfficiencyAudit extends Audit {
       LoadSimulator.request(simulatorOptions, context),
     ]);
 
-    return this.createAuditProduct(result, graph, simulator, gatherContext);
+    return this.createAuditProduct(result, graph, simulator, gatherContext, classifiedEntities);
   }
 
   /**
@@ -206,11 +208,11 @@ class ByteEfficiencyAudit extends Audit {
    * @param {Node|null} graph
    * @param {Simulator} simulator
    * @param {LH.Artifacts['GatherContext']} gatherContext
+   * @param {LH.Artifacts.EntityClassification} classifiedEntities
    * @return {LH.Audit.Product}
    */
-  static createAuditProduct(result, graph, simulator, gatherContext) {
+  static createAuditProduct(result, graph, simulator, gatherContext, classifiedEntities) {
     const results = result.items.sort((itemA, itemB) => itemB.wastedBytes - itemA.wastedBytes);
-
     const wastedBytes = results.reduce((sum, item) => sum + item.wastedBytes, 0);
 
     let wastedMs;
@@ -228,7 +230,8 @@ class ByteEfficiencyAudit extends Audit {
       displayValue = str_(i18n.UIStrings.displayValueByteSavings, {wastedBytes});
     }
 
-    const details = Audit.makeOpportunityDetails(result.headings, results, wastedMs, wastedBytes);
+    const details = Audit.makeOpportunityDetails(result.headings, results,
+      classifiedEntities, wastedMs, wastedBytes);
 
     return {
       explanation: result.explanation,

core/audits/byte-efficiency/legacy-javascript.js

@@ -19,10 +19,11 @@
 
 import fs from 'fs';
 
+import {Audit} from '../audit.js';
 import {ByteEfficiencyAudit} from './byte-efficiency-audit.js';
+import {EntityClassification} from '../../computed/entity-classification.js';
 import {JSBundles} from '../../computed/js-bundles.js';
 import * as i18n from '../../lib/i18n/i18n.js';
-import thirdPartyWeb from '../../lib/third-party-web.js';
 import {getRequestForScript} from '../../lib/script-helpers.js';
 import {LH_ROOT} from '../../../root.js';
 
@@ -401,7 +402,10 @@ class LegacyJavascript extends ByteEfficiencyAudit {
    * @return {Promise<ByteEfficiencyProduct>}
    */
   static async audit_(artifacts, networkRecords, context) {
-    const mainDocumentEntity = thirdPartyWeb.getEntity(artifacts.URL.finalDisplayedUrl);
+    const devtoolsLog = artifacts.devtoolsLogs[Audit.DEFAULT_PASS];
+    const classifiedEntities = await EntityClassification.request(
+      {URL: artifacts.URL, devtoolsLog}, context);
+
     const bundles = await JSBundles.request(artifacts, context);
 
     /** @type {Item[]} */
@@ -431,6 +435,7 @@ class LegacyJavascript extends ByteEfficiencyAudit {
         },
         // Not needed, but keeps typescript happy.
         totalBytes: 0,
+        entity: classifiedEntities.getEntityName(script.url),
       };
 
       const bundle = bundles.find(bundle => bundle.script.scriptId === script.scriptId);
@@ -450,7 +455,7 @@ class LegacyJavascript extends ByteEfficiencyAudit {
     const wastedBytesByUrl = new Map();
     for (const item of items) {
       // Only estimate savings if first party code has legacy code.
-      if (thirdPartyWeb.isFirstParty(item.url, mainDocumentEntity)) {
+      if (classifiedEntities.isFirstParty(item.url)) {
         wastedBytesByUrl.set(item.url, item.wastedBytes);
       }
     }

core/audits/byte-efficiency/render-blocking-resources.js

@@ -13,6 +13,7 @@ import {Audit} from '../audit.js';
 import * as i18n from '../../lib/i18n/i18n.js';
 import {BaseNode} from '../../lib/dependency-graph/base-node.js';
 import {ByteEfficiencyAudit} from './byte-efficiency-audit.js';
+import {EntityClassification} from '../../computed/entity-classification.js';
 import {UnusedCSS} from '../../computed/unused-css.js';
 import {NetworkRequest} from '../../lib/network-request.js';
 import {ProcessedTrace} from '../../computed/processed-trace.js';
@@ -278,6 +279,9 @@ class RenderBlockingResources extends Audit {
    * @return {Promise<LH.Audit.Product>}
    */
   static async audit(artifacts, context) {
+    const devtoolsLog = artifacts.devtoolsLogs[Audit.DEFAULT_PASS];
+    const URL = artifacts.URL;
+    const classifiedEntities = await EntityClassification.request({URL, devtoolsLog}, context);
     const {results, wastedMs} = await RenderBlockingResources.computeResults(artifacts, context);
 
     let displayValue;
@@ -292,7 +296,7 @@ class RenderBlockingResources extends Audit {
       {key: 'wastedMs', valueType: 'timespanMs', label: str_(i18n.UIStrings.columnWastedMs)},
     ];
 
-    const details = Audit.makeOpportunityDetails(headings, results, wastedMs);
+    const details = Audit.makeOpportunityDetails(headings, results, classifiedEntities, wastedMs);
 
     return {
       displayValue,

core/audits/byte-efficiency/total-byte-weight.js

@@ -5,6 +5,7 @@
  */
 
 import {Audit} from '../audit.js';
+import {EntityClassification} from '../../computed/entity-classification.js';
 import * as i18n from '../../lib/i18n/i18n.js';
 import {NetworkRequest} from '../../lib/network-request.js';
 import {NetworkRecords} from '../../computed/network-records.js';
@@ -35,7 +36,7 @@ class TotalByteWeight extends Audit {
       failureTitle: str_(UIStrings.failureTitle),
       description: str_(UIStrings.description),
       scoreDisplayMode: Audit.SCORING_MODES.NUMERIC,
-      requiredArtifacts: ['devtoolsLogs'],
+      requiredArtifacts: ['devtoolsLogs', 'URL'],
     };
   }
 
@@ -60,6 +61,8 @@ class TotalByteWeight extends Audit {
   static async audit(artifacts, context) {
     const devtoolsLog = artifacts.devtoolsLogs[Audit.DEFAULT_PASS];
     const records = await NetworkRecords.request(devtoolsLog, context);
+    const classifiedEntities = await EntityClassification.request(
+      {URL: artifacts.URL, devtoolsLog}, context);
 
     let totalBytes = 0;
     /** @type {Array<{url: string, totalBytes: number}>} */
@@ -72,6 +75,7 @@ class TotalByteWeight extends Audit {
       const result = {
         url: record.url,
         totalBytes: record.transferSize,
+        entity: classifiedEntities.getEntityName(record.url),
       };
 
       totalBytes += result.totalBytes;

core/audits/byte-efficiency/uses-long-cache-ttl.js

@@ -7,6 +7,7 @@
 import parseCacheControl from 'parse-cache-control';
 
 import {Audit} from '../audit.js';
+import {EntityClassification} from '../../computed/entity-classification.js';
 import {NetworkRequest} from '../../lib/network-request.js';
 import UrlUtils from '../../lib/url-utils.js';
 import {linearInterpolation} from '../../lib/statistics.js';
@@ -45,7 +46,7 @@ class CacheHeaders extends Audit {
       failureTitle: str_(UIStrings.failureTitle),
       description: str_(UIStrings.description),
       scoreDisplayMode: Audit.SCORING_MODES.NUMERIC,
-      requiredArtifacts: ['devtoolsLogs'],
+      requiredArtifacts: ['devtoolsLogs', 'URL'],
     };
   }
 
@@ -195,8 +196,10 @@ class CacheHeaders extends Audit {
    * @return {Promise<LH.Audit.Product>}
    */
   static async audit(artifacts, context) {
-    const devtoolsLogs = artifacts.devtoolsLogs[Audit.DEFAULT_PASS];
-    const records = await NetworkRecords.request(devtoolsLogs, context);
+    const devtoolsLog = artifacts.devtoolsLogs[Audit.DEFAULT_PASS];
+    const classifiedEntities = await EntityClassification.request(
+      {URL: artifacts.URL, devtoolsLog}, context);
+    const records = await NetworkRecords.request(devtoolsLog, context);
     const results = [];
     let totalWastedBytes = 0;
 
@@ -256,6 +259,7 @@ class CacheHeaders extends Audit {
         cacheHitProbability,
         totalBytes,
         wastedBytes,
+        entity: classifiedEntities?.getEntityName(url),
       });
     }
 

core/audits/dobetterweb/geolocation-on-start.js

@@ -37,7 +37,8 @@ class GeolocationOnStart extends ViolationAudit {
       failureTitle: str_(UIStrings.failureTitle),
       description: str_(UIStrings.description),
       supportedModes: ['navigation'],
-      requiredArtifacts: ['ConsoleMessages', 'SourceMaps', 'Scripts'],
+      requiredArtifacts: ['ConsoleMessages', 'SourceMaps', 'Scripts',
+        ...ViolationAudit.partialMeta.requiredArtifacts],
     };
   }
 

core/audits/dobetterweb/no-document-write.js

@@ -53,7 +53,8 @@ class NoDocWriteAudit extends ViolationAudit {
       title: str_(UIStrings.title),
       failureTitle: str_(UIStrings.failureTitle),
       description: str_(UIStrings.description),
-      requiredArtifacts: ['ConsoleMessages', 'SourceMaps', 'Scripts'],
+      requiredArtifacts: ['ConsoleMessages', 'SourceMaps', 'Scripts',
+        ...ViolationAudit.partialMeta.requiredArtifacts],
     };
   }
 

core/audits/dobetterweb/notification-on-start.js

@@ -37,7 +37,8 @@ class NotificationOnStart extends ViolationAudit {
       failureTitle: str_(UIStrings.failureTitle),
       description: str_(UIStrings.description),
       supportedModes: ['navigation'],
-      requiredArtifacts: ['ConsoleMessages', 'SourceMaps', 'Scripts'],
+      requiredArtifacts: ['ConsoleMessages', 'SourceMaps', 'Scripts',
+        ...ViolationAudit.partialMeta.requiredArtifacts],
     };
   }
 

core/audits/dobetterweb/uses-http2.js

@@ -13,6 +13,7 @@
 /** @typedef {import('../../lib/dependency-graph/base-node.js').Node} Node */
 
 import {Audit} from '../audit.js';
+import {EntityClassification} from '../../computed/entity-classification.js';
 import ThirdParty from '../../lib/third-party-web.js';
 import UrlUtils from '../../lib/url-utils.js';
 import {ByteEfficiencyAudit} from '../byte-efficiency/byte-efficiency-audit.js';
@@ -204,6 +205,7 @@ class UsesHTTP2Audit extends Audit {
     const URL = artifacts.URL;
     const networkRecords = await NetworkRecords.request(devtoolsLog, context);
     const resources = UsesHTTP2Audit.determineNonHttp2Resources(networkRecords);
+    const classifiedEntities = await EntityClassification.request({URL, devtoolsLog}, context);
 
     let displayValue;
     if (resources.length > 0) {
@@ -218,7 +220,13 @@ class UsesHTTP2Audit extends Audit {
         {key: 'protocol', valueType: 'text', label: str_(UIStrings.columnProtocol)},
       ];
 
-      const details = Audit.makeTableDetails(headings, resources);
+      const details = Audit.makeTableDetails(
+        headings,
+        resources.map(resource => ({
+          entity: classifiedEntities.getEntityName(resource.url),
+          ...resource,
+        }))
+      );
 
       return {
         displayValue,
@@ -242,7 +250,7 @@ class UsesHTTP2Audit extends Audit {
       {key: 'protocol', valueType: 'text', label: str_(UIStrings.columnProtocol)},
     ];
 
-    const details = Audit.makeOpportunityDetails(headings, resources, wastedMs);
+    const details = Audit.makeOpportunityDetails(headings, resources, classifiedEntities, wastedMs);
 
     return {
       displayValue,

core/audits/dobetterweb/uses-passive-event-listeners.js

@@ -36,7 +36,8 @@ class PassiveEventsAudit extends ViolationAudit {
       title: str_(UIStrings.title),
       failureTitle: str_(UIStrings.failureTitle),
       description: str_(UIStrings.description),
-      requiredArtifacts: ['ConsoleMessages', 'SourceMaps', 'Scripts'],
+      requiredArtifacts: ['ConsoleMessages', 'SourceMaps', 'Scripts',
+        ...ViolationAudit.partialMeta.requiredArtifacts],
     };
   }
 

core/audits/entity-classification.js

@@ -0,0 +1,62 @@
+/**
+ * @license Copyright 2022 The Lighthouse Authors. All Rights Reserved.
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+ */
+
+import {Audit} from './audit.js';
+import {EntityClassification as ComputedEntityClassification}
+  from '../computed/entity-classification.js';
+
+class EntityClassification extends Audit {
+  /**
+   * @return {LH.Audit.Meta}
+   */
+  static get meta() {
+    return {
+      id: 'entity-classification',
+      scoreDisplayMode: Audit.SCORING_MODES.INFORMATIVE,
+      title: 'Entity Classification',
+      description: 'All 1st and 3rd party entities on the page classified',
+      requiredArtifacts: ['devtoolsLogs', 'URL'],
+    };
+  }
+
+  /**
+   * @param {LH.Artifacts} artifacts
+   * @param {LH.Audit.Context} context
+   * @return {Promise<LH.Audit.Product>}
+   */
+  static async audit(artifacts, context) {
+    const devtoolsLog = artifacts.devtoolsLogs[Audit.DEFAULT_PASS];
+    const classifiedEntities = await ComputedEntityClassification.request(
+      {URL: artifacts.URL, devtoolsLog}, context);
+
+    /** @type {Record<string, LH.Audit.Details.EntityClassificationEntity>} */
+    const entities = {};
+
+    for (const entity of classifiedEntities.entityToURLs.keys()) {
+      /** @type {LH.Audit.Details.EntityClassificationEntity} */
+      const shortEntity = {
+        homepage: entity.homepage,
+      };
+
+      // Reduce payload size in LHR JSON by omitting whats falsy.
+      if (entity === classifiedEntities.firstParty) shortEntity.isFirstParty = true;
+      if (entity.isUnrecognized) shortEntity.isUnrecognized = true;
+
+      entities[entity.name] = shortEntity;
+    }
+
+    return {
+      score: 1,
+      details: {
+        type: 'entity-classification',
+        entities,
+        firstParty: classifiedEntities.firstParty?.name,
+      },
+    };
+  }
+}
+
+export default EntityClassification;