AI: create common helper for LCP data

This CL adds `frameId` to each insight, this means that we can look up
data from the PageLoadMetricsHandler for an insight. This is useful as
for any LCP based Insight we can now fetch the LCP information and put
it into the prompt for the LLM.

Fixed: 401519930
Change-Id: I1d06c07a94e63f393539b2bbab3feeb584c603c8
Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/6336172
Reviewed-by: Alina Varkki <[email protected]>
Commit-Queue: Alina Varkki <[email protected]>
Auto-Submit: Jack Franklin <[email protected]>
Commit-Queue: Jack Franklin <[email protected]>

Author: jackfranklin

front_end/models/trace/handlers/PageLoadMetricsHandler.ts

@@ -20,14 +20,16 @@ import * as Types from '../types/types.js';
 import {data as metaHandlerData} from './MetaHandler.js';
 import type {HandlerName} from './types.js';
 
+// Small helpers to make the below type easier to read.
+type FrameId = string;
+type NavigationId = string;
 /**
  * This represents the metric scores for all navigations, for all frames in a trace.
  * Given a frame id, the map points to another map from navigation id to metric scores.
  * The metric scores include the event related to the metric as well as the data regarding
  * the score itself.
  */
-const metricScoresByFrameId =
-    new Map</* Frame id */ string, Map</* navigation id */ string, Map<MetricName, MetricScore>>>();
+const metricScoresByFrameId = new Map<FrameId, Map<NavigationId, Map<MetricName, MetricScore>>>();
 
 /**
  * Page load events with no associated duration that happened in the
@@ -447,3 +449,12 @@ export interface MetricScore {
   estimated?: boolean;
   timing: Types.Timing.Micro;
 }
+
+export type LCPMetricScore = MetricScore&{
+  event: Types.Events.LargestContentfulPaintCandidate,
+  metricName: MetricName.LCP,
+};
+
+export function metricIsLCP(metric: MetricScore): metric is LCPMetricScore {
+  return metric.metricName === MetricName.LCP;
+}

front_end/models/trace/insights/CLSCulprits.ts

@@ -582,6 +582,7 @@ export function generateInsight(
   }
 
   return finalize({
+    frameId: context.frameId,
     relatedEvents,
     animationFailures,
     shifts: rootCausesByShift,

front_end/models/trace/insights/DOMSize.ts

@@ -165,6 +165,7 @@ export function generateInsight(
   }
 
   return finalize({
+    frameId: context.frameId,
     largeLayoutUpdates,
     largeStyleRecalcs,
     maxDOMStats,

front_end/models/trace/insights/DocumentLatency.ts

@@ -181,13 +181,13 @@ function finalize(partialModel: PartialInsightModel<DocumentLatencyInsightModel>
 export function generateInsight(
     parsedTrace: Handlers.Types.ParsedTrace, context: InsightSetContext): DocumentLatencyInsightModel {
   if (!context.navigation) {
-    return finalize({});
+    return finalize({frameId: context.frameId});
   }
 
   const documentRequest =
       parsedTrace.NetworkRequests.byTime.find(req => req.args.data.requestId === context.navigationId);
   if (!documentRequest) {
-    return finalize({warnings: [InsightWarning.NO_DOCUMENT_REQUEST]});
+    return finalize({frameId: context.frameId, warnings: [InsightWarning.NO_DOCUMENT_REQUEST]});
   }
 
   const serverResponseTime = getServerResponseTime(documentRequest);
@@ -217,6 +217,7 @@ export function generateInsight(
   const usesCompression = uncompressedResponseBytes === 0;
 
   return finalize({
+    frameId: context.frameId,
     relatedEvents: [documentRequest],
     data: {
       serverResponseTime,

front_end/models/trace/insights/DuplicateJavaScript.ts

@@ -65,5 +65,5 @@ export function generateInsight(
   });
 
   const duplication = Extras.ScriptDuplication.computeScriptDuplication({scripts});
-  return finalize({duplication});
+  return finalize({frameId: context.frameId, duplication});
 }

front_end/models/trace/insights/FontDisplay.ts

@@ -100,6 +100,7 @@ export function generateInsight(
   const savings = Math.max(...fonts.map(f => f.wastedTime)) as Types.Timing.Milli;
 
   return finalize({
+    frameId: context.frameId,
     relatedEvents: fonts.map(f => f.request),
     fonts,
     metricSavings: {FCP: savings},

front_end/models/trace/insights/ForcedReflow.ts

@@ -15,6 +15,7 @@ import {
   InsightCategory,
   InsightKeys,
   type InsightModel,
+  type InsightSetContext,
   type PartialInsightModel,
 } from './types.js';
 
@@ -199,7 +200,8 @@ function finalize(partialModel: PartialInsightModel<ForcedReflowInsightModel>):
   };
 }
 
-export function generateInsight(traceParsedData: Handlers.Types.ParsedTrace): ForcedReflowInsightModel {
+export function generateInsight(
+    traceParsedData: Handlers.Types.ParsedTrace, context: InsightSetContext): ForcedReflowInsightModel {
   const warningsData = traceParsedData.Warnings;
   const entryToNodeMap = traceParsedData.Renderer.entryToNode;
 
@@ -215,6 +217,7 @@ export function generateInsight(traceParsedData: Handlers.Types.ParsedTrace): Fo
       aggregateForcedReflow(warningsData.perWarning, entryToNodeMap);
 
   return finalize({
+    frameId: context.frameId,
     relatedEvents: topLevelFunctionCallData?.topLevelFunctionCallEvents,
     topLevelFunctionCallData,
     aggregatedBottomUpData,

front_end/models/trace/insights/ImageDelivery.ts

@@ -309,6 +309,7 @@ export function generateInsight(
   });
 
   return finalize({
+    frameId: context.frameId,
     optimizableImages,
     totalByteSavings: optimizableImages.reduce((total, img) => total + img.byteSavings, 0),
     metricSavings: metricSavingsForWastedBytes(wastedBytesByRequestId, context),

front_end/models/trace/insights/InteractionToNextPaint.ts

@@ -80,7 +80,10 @@ export function generateInsight(parsedTrace: Handlers.Types.ParsedTrace, context
 
   if (!interactionEvents.length) {
     // A valid result, when there is no user interaction.
-    return finalize({});
+    return finalize({
+
+      frameId: context.frameId,
+    });
   }
 
   const longestByInteractionId = new Map<number, SyntheticInteractionPair>();
@@ -101,6 +104,7 @@ export function generateInsight(parsedTrace: Handlers.Types.ParsedTrace, context
   const highPercentileIndex = Math.min(9, Math.floor(normalizedInteractionEvents.length / 50));
 
   return finalize({
+    frameId: context.frameId,
     relatedEvents: [normalizedInteractionEvents[0]],
     longestInteractionEvent: normalizedInteractionEvents[0],
     highPercentileInteractionEvent: normalizedInteractionEvents[highPercentileIndex],

front_end/models/trace/insights/LCPDiscovery.ts

@@ -96,7 +96,10 @@ function finalize(partialModel: PartialInsightModel<LCPDiscoveryInsightModel>):
 export function generateInsight(
     parsedTrace: Handlers.Types.ParsedTrace, context: InsightSetContext): LCPDiscoveryInsightModel {
   if (!context.navigation) {
-    return finalize({});
+    return finalize({
+
+      frameId: context.frameId,
+    });
   }
 
   const networkRequests = parsedTrace.NetworkRequests;
@@ -113,17 +116,17 @@ export function generateInsight(
   const metricScore = navMetrics.get(Handlers.ModelHandlers.PageLoadMetrics.MetricName.LCP);
   const lcpEvent = metricScore?.event;
   if (!lcpEvent || !Types.Events.isLargestContentfulPaintCandidate(lcpEvent)) {
-    return finalize({warnings: [InsightWarning.NO_LCP]});
+    return finalize({frameId: context.frameId, warnings: [InsightWarning.NO_LCP]});
   }
 
   const docRequest = networkRequests.byTime.find(req => req.args.data.requestId === context.navigationId);
   if (!docRequest) {
-    return finalize({lcpEvent, warnings: [InsightWarning.NO_DOCUMENT_REQUEST]});
+    return finalize({frameId: context.frameId, lcpEvent, warnings: [InsightWarning.NO_DOCUMENT_REQUEST]});
   }
 
   const lcpRequest = parsedTrace.LargestImagePaint.lcpRequestByNavigation.get(context.navigation);
   if (!lcpRequest) {
-    return finalize({lcpEvent});
+    return finalize({frameId: context.frameId, lcpEvent});
   }
 
   const initiatorUrl = lcpRequest.args.data.initiator?.url;
@@ -144,6 +147,7 @@ export function generateInsight(
   const priorityHintFound = imageFetchPriorityHint === 'high';
 
   return finalize({
+    frameId: context.frameId,
     lcpEvent,
     lcpRequest,
     earliestDiscoveryTimeTs: earliestDiscoveryTime ? Types.Timing.Micro(earliestDiscoveryTime) : undefined,