misc(chore): rename traceEngineData to parsedTrace (#16270)

Co-authored-by: Connor Clark <cjamcl@google.com>

Author: paulirish

core/audits/insights/insight-audit.js

@@ -16,7 +16,7 @@ const str_ = i18n.createIcuMessageFn(import.meta.url, {});
 /**
  * @param {LH.Artifacts} artifacts
  * @param {LH.Audit.Context} context
- * @return {Promise<{insights: import('@paulirish/trace_engine/models/trace/insights/types.js').InsightSet|undefined, parsedTrace: LH.Artifacts.TraceEngineResult['data']}>}
+ * @return {Promise<{insights: import('@paulirish/trace_engine/models/trace/insights/types.js').InsightSet|undefined, parsedTrace: LH.Artifacts.TraceEngineResult['parsedTrace']}>}
  */
 async function getInsightSet(artifacts, context) {
   const settings = context.settings;
@@ -29,13 +29,13 @@ async function getInsightSet(artifacts, context) {
   const key = navigationId ?? NO_NAVIGATION;
   const insights = traceEngineResult.insights.get(key);
 
-  return {insights, parsedTrace: traceEngineResult.data};
+  return {insights, parsedTrace: traceEngineResult.parsedTrace};
 }
 
 /**
  * @typedef CreateDetailsExtras
  * @property {import('@paulirish/trace_engine/models/trace/insights/types.js').InsightSet} insights
- * @property {LH.Artifacts.TraceEngineResult['data']} parsedTrace
+ * @property {LH.Artifacts.TraceEngineResult['parsedTrace']} parsedTrace
  */
 
 /**

core/audits/layout-shifts.js

@@ -62,7 +62,7 @@ class LayoutShifts extends Audit {
     const SourceMaps = artifacts.SourceMaps;
     const traceEngineResult =
       await TraceEngineResult.request({trace, settings, SourceMaps}, context);
-    const clusters = traceEngineResult.data.LayoutShifts.clusters ?? [];
+    const clusters = traceEngineResult.parsedTrace.LayoutShifts.clusters ?? [];
     const {cumulativeLayoutShift: clsSavings, impactByNodeId} =
       await CumulativeLayoutShiftComputed.request(trace, context);
     const traceElements = artifacts.TraceElements

core/computed/metrics/lantern-metric.js

@@ -38,14 +38,15 @@ async function getComputationDataParamsFromTrace(data, context) {
 
   const graph = await PageDependencyGraph.request({...data, fromTrace: true}, context);
   const traceEngineResult = await TraceEngineResult.request(data, context);
-  const frameId = traceEngineResult.data.Meta.mainFrameId;
-  const navigationId = traceEngineResult.data.Meta.mainFrameNavigations[0].args.data?.navigationId;
+  const frameId = traceEngineResult.parsedTrace.Meta.mainFrameId;
+  const navigationId =
+    traceEngineResult.parsedTrace.Meta.mainFrameNavigations[0].args.data?.navigationId;
   if (!navigationId) {
     throw new Error(`Lantern metrics could not be calculated due to missing navigation id`);
   }
 
   const processedNavigation = Lantern.TraceEngineComputationData.createProcessedNavigation(
-    traceEngineResult.data, frameId, navigationId);
+    traceEngineResult.parsedTrace, frameId, navigationId);
   const simulator = data.simulator || (await LoadSimulator.request(data, context));
 
   return {simulator, graph, processedNavigation};

core/computed/page-dependency-graph.js

@@ -27,11 +27,11 @@ class PageDependencyGraph {
     if (data.fromTrace) {
       const traceEngineResult =
         await TraceEngineResult.request({trace, settings, SourceMaps}, context);
-      const traceEngineData = traceEngineResult.data;
+      const parsedTrace = traceEngineResult.parsedTrace;
       const requests =
-        Lantern.TraceEngineComputationData.createNetworkRequests(trace, traceEngineData);
+        Lantern.TraceEngineComputationData.createNetworkRequests(trace, parsedTrace);
       const graph =
-        Lantern.TraceEngineComputationData.createGraph(requests, trace, traceEngineData, URL);
+        Lantern.TraceEngineComputationData.createGraph(requests, trace, parsedTrace, URL);
       // @ts-expect-error for now, ignore that this is a SyntheticNetworkEvent instead of LH's NetworkEvent.
       return graph;
     }

core/computed/trace-engine-result.js

@@ -63,7 +63,7 @@ class TraceEngineResult {
     if (!processor.parsedTrace) throw new Error('No data');
     if (!processor.insights) throw new Error('No insights');
     this.localizeInsights(processor.insights);
-    return {data: processor.parsedTrace, insights: processor.insights};
+    return {parsedTrace: processor.parsedTrace, insights: processor.insights};
   }
 
   /**

core/gather/gatherers/trace-elements.js

@@ -173,7 +173,7 @@ class TraceElements extends BaseGatherer {
    * that may have caused the shift.
    *
    * @param {LH.Trace} trace
-   * @param {LH.Artifacts.TraceEngineResult['data']} traceEngineResult
+   * @param {LH.Artifacts.TraceEngineResult['parsedTrace']} traceEngineResult
    * @param {LH.Gatherer.Context} context
    * @return {Promise<Array<{nodeId: number}>>}
    */
@@ -369,7 +369,7 @@ class TraceElements extends BaseGatherer {
       traceEngineResult, navigationId);
     const lcpNodeData = await TraceElements.getLcpElement(trace, context);
     const shiftsData = await TraceElements.getTopLayoutShifts(
-      trace, traceEngineResult.data, context);
+      trace, traceEngineResult.parsedTrace, context);
     const animatedElementData = await this.getAnimatedElements(mainThreadEvents);
     const responsivenessElementData = await TraceElements.getResponsivenessElement(trace, context);
 

types/artifacts.d.ts

@@ -508,7 +508,7 @@ declare module Artifacts {
   }
 
   interface TraceEngineResult {
-    data: TraceEngine.Handlers.Types.ParsedTrace;
+    parsedTrace: TraceEngine.Handlers.Types.ParsedTrace;
     insights: TraceEngine.Insights.Types.TraceInsightSets;
   }