lighthouse 10.0.1-dev.20230215 → 10.0.1-dev.20230216

package/core/audits/prioritize-lcp-image.d.ts

@@ -17,32 +17,33 @@ declare class PrioritizeLcpImage extends Audit {
     static shouldPreloadRequest(request: LH.Artifacts.NetworkRequest, mainResource: LH.Artifacts.NetworkRequest, initiatorPath: Array<LH.Gatherer.Simulation.GraphNode>): boolean;
     /**
      * @param {LH.Gatherer.Simulation.GraphNode} graph
-     * @param {string} imageUrl
+     * @param {NetworkRequest} lcpRecord
      * @return {{lcpNode: LH.Gatherer.Simulation.GraphNetworkNode|undefined, path: Array<LH.Gatherer.Simulation.GraphNetworkNode>|undefined}}
      */
-    static findLCPNode(graph: LH.Gatherer.Simulation.GraphNode, imageUrl: string): {
+    static findLCPNode(graph: LH.Gatherer.Simulation.GraphNode, lcpRecord: NetworkRequest): {
         lcpNode: LH.Gatherer.Simulation.GraphNetworkNode | undefined;
         path: Array<LH.Gatherer.Simulation.GraphNetworkNode> | undefined;
     };
     /**
      * @param {LH.Artifacts.NetworkRequest} mainResource
      * @param {LH.Gatherer.Simulation.GraphNode} graph
-     * @param {string | undefined} lcpUrl
+     * @param {NetworkRequest|undefined} lcpRecord
      * @return {{lcpNodeToPreload?: LH.Gatherer.Simulation.GraphNetworkNode, initiatorPath?: InitiatorPath}}
      */
-    static getLCPNodeToPreload(mainResource: LH.Artifacts.NetworkRequest, graph: LH.Gatherer.Simulation.GraphNode, lcpUrl: string | undefined): {
+    static getLCPNodeToPreload(mainResource: LH.Artifacts.NetworkRequest, graph: LH.Gatherer.Simulation.GraphNode, lcpRecord: NetworkRequest | undefined): {
         lcpNodeToPreload?: import("../lib/dependency-graph/network-node.js").NetworkNode | undefined;
         initiatorPath?: InitiatorPath | undefined;
     };
     /**
-     * Match the LCP event with the paint event to get the URL of the image actually painted.
+     * Match the LCP event with the paint event to get the request of the image actually painted.
      * This could differ from the `ImageElement` associated with the nodeId if e.g. the LCP
      * was a pseudo-element associated with a node containing a smaller background-image.
      * @param {LH.Trace} trace
      * @param {LH.Artifacts.ProcessedNavigation} processedNavigation
-     * @return {string | undefined}
+     * @param {Array<NetworkRequest>} networkRecords
+     * @return {NetworkRequest|undefined}
      */
-    static getLcpUrl(trace: LH.Trace, processedNavigation: LH.Artifacts.ProcessedNavigation): string | undefined;
+    static getLcpRecord(trace: LH.Trace, processedNavigation: LH.Artifacts.ProcessedNavigation, networkRecords: Array<NetworkRequest>): NetworkRequest | undefined;
     /**
      * Computes the estimated effect of preloading the LCP image.
      * @param {LH.Artifacts.TraceElement} lcpElement

package/core/audits/prioritize-lcp-image.js

@@ -12,6 +12,7 @@ import {LanternLargestContentfulPaint} from '../computed/metrics/lantern-largest
 import {LoadSimulator} from '../computed/load-simulator.js';
 import {ByteEfficiencyAudit} from './byte-efficiency/byte-efficiency-audit.js';
 import {ProcessedNavigation} from '../computed/processed-navigation.js';
+import {NetworkRecords} from '../computed/network-records.js';
 
 const UIStrings = {
   /** Title of a lighthouse audit that tells a user to preload an image in order to improve their LCP time. */
@@ -64,15 +65,15 @@ class PrioritizeLcpImage extends Audit {
 
   /**
    * @param {LH.Gatherer.Simulation.GraphNode} graph
-   * @param {string} imageUrl
+   * @param {NetworkRequest} lcpRecord
    * @return {{lcpNode: LH.Gatherer.Simulation.GraphNetworkNode|undefined, path: Array<LH.Gatherer.Simulation.GraphNetworkNode>|undefined}}
    */
-  static findLCPNode(graph, imageUrl) {
+  static findLCPNode(graph, lcpRecord) {
     let lcpNode;
     let path;
     graph.traverse((node, traversalPath) => {
       if (node.type !== 'network') return;
-      if (node.record.url === imageUrl) {
+      if (node.record.requestId === lcpRecord.requestId) {
         lcpNode = node;
         path =
           traversalPath.slice(1).filter(initiator => initiator.type === 'network');
@@ -87,12 +88,12 @@ class PrioritizeLcpImage extends Audit {
   /**
    * @param {LH.Artifacts.NetworkRequest} mainResource
    * @param {LH.Gatherer.Simulation.GraphNode} graph
-   * @param {string | undefined} lcpUrl
+   * @param {NetworkRequest|undefined} lcpRecord
    * @return {{lcpNodeToPreload?: LH.Gatherer.Simulation.GraphNetworkNode, initiatorPath?: InitiatorPath}}
    */
-  static getLCPNodeToPreload(mainResource, graph, lcpUrl) {
-    if (!lcpUrl) return {};
-    const {lcpNode, path} = PrioritizeLcpImage.findLCPNode(graph, lcpUrl);
+  static getLCPNodeToPreload(mainResource, graph, lcpRecord) {
+    if (!lcpRecord) return {};
+    const {lcpNode, path} = PrioritizeLcpImage.findLCPNode(graph, lcpRecord);
     if (!lcpNode || !path) return {};
 
     // eslint-disable-next-line max-len
@@ -111,14 +112,15 @@ class PrioritizeLcpImage extends Audit {
   }
 
   /**
-   * Match the LCP event with the paint event to get the URL of the image actually painted.
+   * Match the LCP event with the paint event to get the request of the image actually painted.
    * This could differ from the `ImageElement` associated with the nodeId if e.g. the LCP
    * was a pseudo-element associated with a node containing a smaller background-image.
    * @param {LH.Trace} trace
    * @param {LH.Artifacts.ProcessedNavigation} processedNavigation
-   * @return {string | undefined}
+   * @param {Array<NetworkRequest>} networkRecords
+   * @return {NetworkRequest|undefined}
    */
-  static getLcpUrl(trace, processedNavigation) {
+  static getLcpRecord(trace, processedNavigation, networkRecords) {
     // Use main-frame-only LCP to match the metric value.
     const lcpEvent = processedNavigation.largestContentfulPaintEvt;
     if (!lcpEvent) return;
@@ -131,7 +133,31 @@ class PrioritizeLcpImage extends Audit {
     // Get last candidate, in case there was more than one.
     }).sort((a, b) => b.ts - a.ts)[0];
 
-    return lcpImagePaintEvent?.args.data?.imageUrl;
+    const lcpUrl = lcpImagePaintEvent?.args.data?.imageUrl;
+    if (!lcpUrl) return;
+
+    const candidates = networkRecords.filter(record => {
+      return record.url === lcpUrl &&
+          record.finished &&
+          // Same frame as LCP trace event.
+          record.frameId === lcpImagePaintEvent.args.frame &&
+          record.networkRequestTime < (processedNavigation.timestamps.largestContentfulPaint || 0);
+    }).map(record => {
+      // Follow any redirects to find the real image request.
+      while (record.redirectDestination) {
+        record = record.redirectDestination;
+      }
+      return record;
+    }).filter(record => {
+      // Don't select if also loaded by some other means (xhr, etc). `resourceType`
+      // isn't set on redirect _sources_, so have to check after following redirects.
+      return record.resourceType === 'Image';
+    });
+
+    // If there are still multiple candidates, at this point it appears the page
+    // simply made multiple requests for the image. The first loaded is the best
+    // guess of the request that made the image available for use.
+    return candidates.sort((a, b) => a.networkEndTime - b.networkEndTime)[0];
   }
 
   /**
@@ -233,7 +259,8 @@ class PrioritizeLcpImage extends Audit {
     const trace = artifacts.traces[PrioritizeLcpImage.DEFAULT_PASS];
     const devtoolsLog = artifacts.devtoolsLogs[PrioritizeLcpImage.DEFAULT_PASS];
     const URL = artifacts.URL;
-    const metricData = {trace, devtoolsLog, gatherContext, settings: context.settings, URL};
+    const settings = context.settings;
+    const metricData = {trace, devtoolsLog, gatherContext, settings, URL};
     const lcpElement = artifacts.TraceElements
       .find(element => element.traceEventType === 'largest-contentful-paint');
 
@@ -241,17 +268,16 @@ class PrioritizeLcpImage extends Audit {
       return {score: null, notApplicable: true};
     }
 
-    const [processedNavigation, mainResource, lanternLCP, simulator] = await Promise.all([
-      ProcessedNavigation.request(trace, context),
-      MainResource.request({devtoolsLog, URL}, context),
-      LanternLargestContentfulPaint.request(metricData, context),
-      LoadSimulator.request({devtoolsLog, settings: context.settings}, context),
-    ]);
+    const networkRecords = await NetworkRecords.request(devtoolsLog, context);
+    const processedNavigation = await ProcessedNavigation.request(trace, context);
+    const mainResource = await MainResource.request({devtoolsLog, URL}, context);
+    const lanternLCP = await LanternLargestContentfulPaint.request(metricData, context);
+    const simulator = await LoadSimulator.request({devtoolsLog, settings}, context);
 
-    const lcpUrl = PrioritizeLcpImage.getLcpUrl(trace, processedNavigation);
+    const lcpRecord = PrioritizeLcpImage.getLcpRecord(trace, processedNavigation, networkRecords);
     const graph = lanternLCP.pessimisticGraph;
-    // eslint-disable-next-line max-len
-    const {lcpNodeToPreload, initiatorPath} = PrioritizeLcpImage.getLCPNodeToPreload(mainResource, graph, lcpUrl);
+    const {lcpNodeToPreload, initiatorPath} = PrioritizeLcpImage.getLCPNodeToPreload(mainResource,
+        graph, lcpRecord);
 
     const {results, wastedMs} =
       PrioritizeLcpImage.computeWasteWithGraph(lcpElement, lcpNodeToPreload, graph, simulator);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "lighthouse",
   "type": "module",
-  "version": "10.0.1-dev.20230215",
+  "version": "10.0.1-dev.20230216",
   "description": "Automated auditing, performance metrics, and best practices for the web.",
   "main": "./core/index.js",
   "bin": {