[RPP] Fix annotation key breaking on trace export

Annotations are keyed by trace event index number. On export, w/o an
experiment enabled, some trace events were being filtered out. This
broke annotation keys. Now, instead of being filtered out those events
are replaced with a stub event.

Bug: 409707727
Change-Id: Iaab3559fa97b5a30fdab8cdaa06591551c9faa67
Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/6448571
Commit-Queue: Connor Clark <[email protected]>
Reviewed-by: Paul Irish <[email protected]>
Auto-Submit: Connor Clark <[email protected]>
Commit-Queue: Paul Irish <[email protected]>

Author: Connor Clark

front_end/models/trace/types/TraceEvents.ts

@@ -3154,3 +3154,24 @@ export function isV8SourceRundownSourcesLargeScriptCatchupEvent(event: Event):
     event is V8SourceRundownSourcesLargeScriptCatchupEvent {
   return event.cat === 'disabled-by-default-devtools.v8-source-rundown-sources' && event.name === 'LargeScriptCatchup';
 }
+
+export interface V8SourceRundownSourcesStubScriptCatchupEvent extends Event {
+  cat: 'disabled-by-default-devtools.v8-source-rundown-sources';
+  name: 'StubScriptCatchup';
+  args: Args&{
+    data: {
+      isolate: string,
+      scriptId: number,
+    },
+  };
+}
+
+export function isV8SourceRundownSourcesStubScriptCatchupEvent(event: Event):
+    event is V8SourceRundownSourcesStubScriptCatchupEvent {
+  return event.cat === 'disabled-by-default-devtools.v8-source-rundown-sources' && event.name === 'StubScriptCatchup';
+}
+
+export function isAnyScriptCatchupEvent(event: Event): event is V8SourceRundownSourcesScriptCatchupEvent|
+    V8SourceRundownSourcesLargeScriptCatchupEvent|V8SourceRundownSourcesStubScriptCatchupEvent {
+  return event.cat === 'disabled-by-default-devtools.v8-source-rundown-sources';
+}

front_end/panels/timeline/TimelinePanel.ts

@@ -1344,7 +1344,7 @@ export class TimelinePanel extends UI.Panel.Panel implements Client, TimelineMod
     void contextMenu.show();
   }
 
-  async saveToFile(isEnhancedTrace = false, addModifications = false): Promise<void> {
+  async saveToFile(savingEnhancedTrace = false, addModifications = false): Promise<void> {
     if (this.state !== State.IDLE) {
       return;
     }
@@ -1357,17 +1357,32 @@ export class TimelinePanel extends UI.Panel.Panel implements Client, TimelineMod
       return;
     }
 
-    if (!isEnhancedTrace ||
-        !Root.Runtime.experiments.isEnabled(Root.Runtime.ExperimentName.TIMELINE_COMPILED_SOURCES)) {
-      traceEvents = traceEvents.filter(event => {
-        return event.cat !== 'disabled-by-default-devtools.v8-source-rundown-sources';
+    const shouldRetainScriptSources = savingEnhancedTrace &&
+        Root.Runtime.experiments.isEnabled(Root.Runtime.ExperimentName.TIMELINE_COMPILED_SOURCES);
+    if (!shouldRetainScriptSources) {
+      traceEvents = traceEvents.map(event => {
+        if (Trace.Types.Events.isAnyScriptCatchupEvent(event) && event.name !== 'StubScriptCatchup') {
+          return {
+            cat: event.cat,
+            name: 'StubScriptCatchup',
+            ts: event.ts,
+            ph: event.ph,
+            pid: event.pid,
+            tid: event.tid,
+            args: {
+              data: {isolate: event.args.data.isolate, scriptId: event.args.data.scriptId},
+            },
+          } as Trace.Types.Events.V8SourceRundownSourcesStubScriptCatchupEvent;
+        }
+
+        return event;
       });
     }
 
     if (metadata) {
       metadata.modifications = addModifications ? ModificationsManager.activeManager()?.toJSON() : undefined;
       metadata.enhancedTraceVersion =
-          isEnhancedTrace ? SDK.EnhancedTracesParser.EnhancedTracesParser.enhancedTraceVersion : undefined;
+          savingEnhancedTrace ? SDK.EnhancedTracesParser.EnhancedTracesParser.enhancedTraceVersion : undefined;
     }
 
     const traceStart = Platform.DateUtilities.toISO8601Compact(new Date());
@@ -1402,7 +1417,7 @@ export class TimelinePanel extends UI.Panel.Panel implements Client, TimelineMod
       } else {
         const formattedTraceIter = traceJsonGenerator(traceEvents, {
           ...metadata,
-          sourceMaps: isEnhancedTrace ? metadata?.sourceMaps : undefined,
+          sourceMaps: savingEnhancedTrace ? metadata?.sourceMaps : undefined,
         });
         traceAsString = Array.from(formattedTraceIter).join('');
       }