chrome-devtools-frontend 1.0.1516909 → 1.0.1519267

package/front_end/models/ai_assistance/data_formatters/PerformanceInsightFormatter.ts

@@ -5,11 +5,10 @@
 import * as Common from '../../../core/common/common.js';
 import * as Trace from '../../trace/trace.js';
 import type {ConversationSuggestions} from '../agents/AiAgent.js';
+import type {AgentFocus} from '../performance/AIContext.js';
 
-import {
-  NetworkRequestFormatter,
-} from './NetworkRequestFormatter.js';
-import {bytes, micros, millis} from './UnitFormatters.js';
+import {PerformanceTraceFormatter} from './PerformanceTraceFormatter.js';
+import {bytes, millis} from './UnitFormatters.js';
 
 /**
  * For a given frame ID and navigation ID, returns the LCP Event and the LCP Request, if the resource was an image.
@@ -40,13 +39,14 @@ function getLCPData(parsedTrace: Trace.TraceModel.ParsedTrace, frameId: string,
   };
 }
 
-export class PerformanceInsightFormatter {
+export class PerformanceInsightFormatter extends PerformanceTraceFormatter {
   #insight: Trace.Insights.Types.InsightModel;
   #parsedTrace: Trace.TraceModel.ParsedTrace;
 
-  constructor(parsedTrace: Trace.TraceModel.ParsedTrace, insight: Trace.Insights.Types.InsightModel) {
+  constructor(focus: AgentFocus, insight: Trace.Insights.Types.InsightModel) {
+    super(focus);
     this.#insight = insight;
-    this.#parsedTrace = parsedTrace;
+    this.#parsedTrace = focus.data.parsedTrace;
   }
 
   #formatMilli(x?: number): string {
@@ -89,8 +89,8 @@ export class PerformanceInsightFormatter {
 
     if (lcpRequest) {
       parts.push(`${theLcpElement} is an image fetched from \`${lcpRequest.args.data.url}\`.`);
-      const request = TraceEventFormatter.networkRequests(
-          [lcpRequest], this.#parsedTrace, {verbose: true, customTitle: 'LCP resource network request'});
+      const request =
+          this.formatNetworkRequests([lcpRequest], {verbose: true, customTitle: 'LCP resource network request'});
       parts.push(request);
     } else {
       parts.push(`${theLcpElement} is text and was not fetched from the network.`);
@@ -100,6 +100,12 @@ export class PerformanceInsightFormatter {
   }
 
   insightIsSupported(): boolean {
+    // Although our types don't show it, Insights can end up as Errors if there
+    // is an issue in the processing stage. In this case we should gracefully
+    // ignore this error.
+    if (this.#insight instanceof Error) {
+      return false;
+    }
     return this.#description().length > 0;
   }
 
@@ -266,7 +272,7 @@ ${shiftsFormatted.join('\n')}`;
 
     return `${this.#lcpMetricSharedContext()}
 
-${TraceEventFormatter.networkRequests([documentRequest], this.#parsedTrace, {
+${this.formatNetworkRequests([documentRequest], {
       verbose: true,
       customTitle: 'Document network request'
     })}
@@ -592,8 +598,8 @@ ${filesFormatted}`;
    */
   formatModernHttpInsight(insight: Trace.Insights.Models.ModernHTTP.ModernHTTPInsightModel): string {
     const requestSummary = (insight.http1Requests.length === 1) ?
-        TraceEventFormatter.networkRequests(insight.http1Requests, this.#parsedTrace, {verbose: true}) :
-        TraceEventFormatter.networkRequests(insight.http1Requests, this.#parsedTrace);
+        this.formatNetworkRequests(insight.http1Requests, {verbose: true}) :
+        this.formatNetworkRequests(insight.http1Requests);
 
     if (requestSummary.length === 0) {
       return 'There are no requests that were served over a legacy HTTP protocol.';
@@ -690,7 +696,7 @@ ${requestSummary}`;
    * @returns a string formatted for sending to Ask AI.
    */
   formatRenderBlockingInsight(insight: Trace.Insights.Models.RenderBlocking.RenderBlockingInsightModel): string {
-    const requestSummary = TraceEventFormatter.networkRequests(insight.renderBlockingRequests, this.#parsedTrace);
+    const requestSummary = this.formatNetworkRequests(insight.renderBlockingRequests);
 
     if (requestSummary.length === 0) {
       return 'There are no network requests that are render blocking.';
@@ -1060,11 +1066,6 @@ Polyfills and transforms enable older browsers to use new JavaScript features. H
   }
 }
 
-export interface NetworkRequestFormatOptions {
-  verbose?: boolean;
-  customTitle?: string;
-}
-
 export class TraceEventFormatter {
   static layoutShift(
       shift: Trace.Types.Events.SyntheticLayoutShift, index: number, parsedTrace: Trace.TraceModel.ParsedTrace,
@@ -1105,301 +1106,4 @@ export class TraceEventFormatter {
 - Score: ${shift.args.data?.weighted_score_delta.toFixed(4)}
 ${rootCauseText}`;
   }
-
-  // Stringify network requests for the LLM model.
-  static networkRequests(
-      requests: readonly Trace.Types.Events.SyntheticNetworkRequest[], parsedTrace: Trace.TraceModel.ParsedTrace,
-      options?: NetworkRequestFormatOptions): string {
-    if (requests.length === 0) {
-      return '';
-    }
-
-    let verbose;
-    if (options?.verbose !== undefined) {
-      verbose = options.verbose;
-    } else {
-      verbose = requests.length === 1;
-    }
-
-    // Use verbose format for a single network request. With the compressed format, a format description
-    // needs to be provided, which is not worth sending if only one network request is being stringified.
-    // For a single request, use `formatRequestVerbosely`, which formats with all fields specified and does not require a
-    // format description.
-    if (verbose) {
-      return requests.map(request => this.#networkRequestVerbosely(request, parsedTrace, options?.customTitle))
-          .join('\n');
-    }
-
-    return this.#networkRequestsArrayCompressed(requests, parsedTrace);
-  }
-
-  /**
-   * This is the data passed to a network request when the Performance Insights
-   * agent is asking for information. It is a slimmed down version of the
-   * request's data to avoid using up too much of the context window.
-   * IMPORTANT: these set of fields have been reviewed by Chrome Privacy &
-   * Security; be careful about adding new data here. If you are in doubt please
-   * talk to jacktfranklin@.
-   */
-  static #networkRequestVerbosely(
-      request: Trace.Types.Events.SyntheticNetworkRequest, parsedTrace: Trace.TraceModel.ParsedTrace,
-      customTitle?: string): string {
-    const {
-      url,
-      statusCode,
-      initialPriority,
-      priority,
-      fromServiceWorker,
-      mimeType,
-      responseHeaders,
-      syntheticData,
-      protocol
-    } = request.args.data;
-
-    const titlePrefix = `## ${customTitle ?? 'Network request'}`;
-
-    // Note: unlike other agents, we do have the ability to include
-    // cross-origins, hence why we do not sanitize the URLs here.
-    const navigationForEvent = Trace.Helpers.Trace.getNavigationForTraceEvent(
-        request,
-        request.args.data.frame,
-        parsedTrace.data.Meta.navigationsByFrameId,
-    );
-    const baseTime = navigationForEvent?.ts ?? parsedTrace.data.Meta.traceBounds.min;
-
-    // Gets all the timings for this request, relative to the base time.
-    // Note that this is the start time, not total time. E.g. "queuedAt: X"
-    // means that the request was queued at Xms, not that it queued for Xms.
-    const startTimesForLifecycle = {
-      queuedAt: request.ts - baseTime,
-      requestSentAt: syntheticData.sendStartTime - baseTime,
-      downloadCompletedAt: syntheticData.finishTime - baseTime,
-      processingCompletedAt: request.ts + request.dur - baseTime,
-    } as const;
-
-    const mainThreadProcessingDuration =
-        startTimesForLifecycle.processingCompletedAt - startTimesForLifecycle.downloadCompletedAt;
-    const downloadTime = syntheticData.finishTime - syntheticData.downloadStart;
-
-    const renderBlocking = Trace.Helpers.Network.isSyntheticNetworkRequestEventRenderBlocking(request);
-    const initiator = parsedTrace.data.NetworkRequests.eventToInitiator.get(request);
-
-    const priorityLines = [];
-    if (initialPriority === priority) {
-      priorityLines.push(`Priority: ${priority}`);
-    } else {
-      priorityLines.push(`Initial priority: ${initialPriority}`);
-      priorityLines.push(`Final priority: ${priority}`);
-    }
-
-    const redirects = request.args.data.redirects.map((redirect, index) => {
-      const startTime = redirect.ts - baseTime;
-      return `#### Redirect ${index + 1}: ${redirect.url}
-- Start time: ${micros(startTime)}
-- Duration: ${micros(redirect.dur)}`;
-    });
-
-    const initiators = this.#getInitiatorChain(parsedTrace, request);
-    const initiatorUrls = initiators.map(initiator => initiator.args.data.url);
-
-    return `${titlePrefix}: ${url}
-Timings:
-- Queued at: ${micros(startTimesForLifecycle.queuedAt)}
-- Request sent at: ${micros(startTimesForLifecycle.requestSentAt)}
-- Download complete at: ${micros(startTimesForLifecycle.downloadCompletedAt)}
-- Main thread processing completed at: ${micros(startTimesForLifecycle.processingCompletedAt)}
-Durations:
-- Download time: ${micros(downloadTime)}
-- Main thread processing time: ${micros(mainThreadProcessingDuration)}
-- Total duration: ${micros(request.dur)}${initiator ? `\nInitiator: ${initiator.args.data.url}` : ''}
-Redirects:${redirects.length ? '\n' + redirects.join('\n') : ' no redirects'}
-Status code: ${statusCode}
-MIME Type: ${mimeType}
-Protocol: ${protocol}
-${priorityLines.join('\n')}
-Render blocking: ${renderBlocking ? 'Yes' : 'No'}
-From a service worker: ${fromServiceWorker ? 'Yes' : 'No'}
-Initiators (root request to the request that directly loaded this one): ${initiatorUrls.join(', ') || 'none'}
-${NetworkRequestFormatter.formatHeaders('Response headers', responseHeaders ?? [], true)}`;
-  }
-
-  static #getOrAssignUrlIndex(urlIdToIndex: Map<string, number>, url: string): number {
-    let index = urlIdToIndex.get(url);
-    if (index !== undefined) {
-      return index;
-    }
-    index = urlIdToIndex.size;
-    urlIdToIndex.set(url, index);
-    return index;
-  }
-
-  // A compact network requests format designed to save tokens when sending multiple network requests to the model.
-  // It creates a map that maps request URLs to IDs and references the IDs in the compressed format.
-  //
-  // Important: Do not use this method for stringifying a single network request. With this format, a format description
-  // needs to be provided, which is not worth sending if only one network request is being stringified.
-  // For a single request, use `formatRequestVerbosely`, which formats with all fields specified and does not require a
-  // format description.
-  static #networkRequestsArrayCompressed(
-      requests: readonly Trace.Types.Events.SyntheticNetworkRequest[],
-      parsedTrace: Trace.TraceModel.ParsedTrace): string {
-    const networkDataString = `
-Network requests data:
-
-`;
-    const urlIdToIndex = new Map<string, number>();
-    const allRequestsText =
-        requests
-            .map(request => {
-              const urlIndex = TraceEventFormatter.#getOrAssignUrlIndex(urlIdToIndex, request.args.data.url);
-              return this.#networkRequestCompressedFormat(urlIndex, request, parsedTrace, urlIdToIndex);
-            })
-            .join('\n');
-
-    const urlsMapString = 'allUrls = ' +
-        `[${
-                              Array.from(urlIdToIndex.entries())
-                                  .map(([url, index]) => {
-                                    return `${index}: ${url}`;
-                                  })
-                                  .join(', ')}]`;
-
-    return networkDataString + '\n\n' + urlsMapString + '\n\n' + allRequestsText;
-  }
-
-  /**
-   * Network requests format description that is sent to the model as a fact.
-   */
-  static networkDataFormatDescription = `Network requests are formatted like this:
-\`urlIndex;queuedTime;requestSentTime;downloadCompleteTime;processingCompleteTime;totalDuration;downloadDuration;mainThreadProcessingDuration;statusCode;mimeType;priority;initialPriority;finalPriority;renderBlocking;protocol;fromServiceWorker;initiators;redirects:[[redirectUrlIndex|startTime|duration]];responseHeaders:[header1Value|header2Value|...]\`
-
-- \`urlIndex\`: Numerical index for the request's URL, referencing the "All URLs" list.
-Timings (all in milliseconds, relative to navigation start):
-- \`queuedTime\`: When the request was queued.
-- \`requestSentTime\`: When the request was sent.
-- \`downloadCompleteTime\`: When the download completed.
-- \`processingCompleteTime\`: When main thread processing finished.
-Durations (all in milliseconds):
-- \`totalDuration\`: Total time from the request being queued until its main thread processing completed.
-- \`downloadDuration\`: Time spent actively downloading the resource.
-- \`mainThreadProcessingDuration\`: Time spent on the main thread after the download completed.
-- \`statusCode\`: The HTTP status code of the response (e.g., 200, 404).
-- \`mimeType\`: The MIME type of the resource (e.g., "text/html", "application/javascript").
-- \`priority\`: The final network request priority (e.g., "VeryHigh", "Low").
-- \`initialPriority\`: The initial network request priority.
-- \`finalPriority\`: The final network request priority (redundant if \`priority\` is always final, but kept for clarity if \`initialPriority\` and \`priority\` differ).
-- \`renderBlocking\`: 't' if the request was render-blocking, 'f' otherwise.
-- \`protocol\`: The network protocol used (e.g., "h2", "http/1.1").
-- \`fromServiceWorker\`: 't' if the request was served from a service worker, 'f' otherwise.
-- \`initiators\`: A list (separated by ,) of URL indices for the initiator chain of this request. Listed in order starting from the root request to the request that directly loaded this one. This represents the network dependencies necessary to load this request. If there is no initiator, this is empty.
-- \`redirects\`: A comma-separated list of redirects, enclosed in square brackets. Each redirect is formatted as
-\`[redirectUrlIndex|startTime|duration]\`, where: \`redirectUrlIndex\`: Numerical index for the redirect's URL. \`startTime\`: The start time of the redirect in milliseconds, relative to navigation start. \`duration\`: The duration of the redirect in milliseconds.
-- \`responseHeaders\`: A list (separated by '|') of values for specific, pre-defined response headers, enclosed in square brackets.
-The order of headers corresponds to an internal fixed list. If a header is not present, its value will be empty.
-`;
-
-  /**
-   *
-   * This is the network request data passed to the Performance agent.
-   *
-   * The `urlIdToIndex` Map is used to map URLs to numerical indices in order to not need to pass whole url every time it's mentioned.
-   * The map content is passed in the response together will all the requests data.
-   *
-   * See `networkDataFormatDescription` above for specifics.
-   */
-  static #networkRequestCompressedFormat(
-      urlIndex: number, request: Trace.Types.Events.SyntheticNetworkRequest, parsedTrace: Trace.TraceModel.ParsedTrace,
-      urlIdToIndex: Map<string, number>): string {
-    const {
-      statusCode,
-      initialPriority,
-      priority,
-      fromServiceWorker,
-      mimeType,
-      responseHeaders,
-      syntheticData,
-      protocol,
-    } = request.args.data;
-
-    const navigationForEvent = Trace.Helpers.Trace.getNavigationForTraceEvent(
-        request,
-        request.args.data.frame,
-        parsedTrace.data.Meta.navigationsByFrameId,
-    );
-    const baseTime = navigationForEvent?.ts ?? parsedTrace.data.Meta.traceBounds.min;
-    const queuedTime = micros(request.ts - baseTime);
-    const requestSentTime = micros(syntheticData.sendStartTime - baseTime);
-    const downloadCompleteTime = micros(syntheticData.finishTime - baseTime);
-    const processingCompleteTime = micros(request.ts + request.dur - baseTime);
-    const totalDuration = micros(request.dur);
-    const downloadDuration = micros(syntheticData.finishTime - syntheticData.downloadStart);
-    const mainThreadProcessingDuration = micros(request.ts + request.dur - syntheticData.finishTime);
-    const renderBlocking = Trace.Helpers.Network.isSyntheticNetworkRequestEventRenderBlocking(request) ? 't' : 'f';
-    const finalPriority = priority;
-    const headerValues = responseHeaders
-                             ?.map(header => {
-                               const value =
-                                   NetworkRequestFormatter.allowHeader(header.name) ? header.value : '<redacted>';
-                               return `${header.name}: ${value}`;
-                             })
-                             .join('|');
-    const redirects = request.args.data.redirects
-                          .map(redirect => {
-                            const urlIndex = TraceEventFormatter.#getOrAssignUrlIndex(urlIdToIndex, redirect.url);
-                            const redirectStartTime = micros(redirect.ts - baseTime);
-                            const redirectDuration = micros(redirect.dur);
-                            return `[${urlIndex}|${redirectStartTime}|${redirectDuration}]`;
-                          })
-                          .join(',');
-
-    const initiators = this.#getInitiatorChain(parsedTrace, request);
-    const initiatorUrlIndices =
-        initiators.map(initiator => TraceEventFormatter.#getOrAssignUrlIndex(urlIdToIndex, initiator.args.data.url));
-
-    const parts = [
-      urlIndex,
-      queuedTime,
-      requestSentTime,
-      downloadCompleteTime,
-      processingCompleteTime,
-      totalDuration,
-      downloadDuration,
-      mainThreadProcessingDuration,
-      statusCode,
-      mimeType,
-      priority,
-      initialPriority,
-      finalPriority,
-      renderBlocking,
-      protocol,
-      fromServiceWorker ? 't' : 'f',
-      initiatorUrlIndices.join(','),
-      `[${redirects}]`,
-      `[${headerValues ?? ''}]`,
-    ];
-    return parts.join(';');
-  }
-
-  static #getInitiatorChain(
-      parsedTrace: Trace.TraceModel.ParsedTrace,
-      request: Trace.Types.Events.SyntheticNetworkRequest): Trace.Types.Events.SyntheticNetworkRequest[] {
-    const initiators: Trace.Types.Events.SyntheticNetworkRequest[] = [];
-
-    let cur: Trace.Types.Events.SyntheticNetworkRequest|undefined = request;
-    while (cur) {
-      const initiator = parsedTrace.data.NetworkRequests.eventToInitiator.get(cur);
-      if (initiator) {
-        // Should never happen, but if it did that would be an infinite loop.
-        if (initiators.includes(initiator)) {
-          return [];
-        }
-
-        initiators.unshift(initiator);
-      }
-
-      cur = initiator;
-    }
-
-    return initiators;
-  }
 }