Fixing flipped logic in TimelinePanel export trace.

This CL fixes some logic that is flipped in the recently added export
trace dialog.

Before the fix: Script content will only be added to the exported trace
if "Include Script Content" and "Include Sourcemap" are BOTH selected,
something similar happening to "Include Sourcemap"

After the fix: Script content will be added correctly if the "Include
Script Content" checkbox is selected, same for the "Include Sourcemap"
checkbox.

I added a test for this behavior.

Bug: 438908750
Change-Id: I0d08ca31361788a7fb168498775a42a6fa5c3ec1
Reviewed-on: https://chromium-review.googlesource.com/c/devtools/devtools-frontend/+/6854692
Reviewed-by: Connor Clark <[email protected]>
Commit-Queue: Vidal Diazleal <[email protected]>

Author: vidorteg

front_end/panels/timeline/TimelinePanel.test.ts

@@ -311,7 +311,8 @@ describeWithEnvironment('TimelinePanel', function() {
       it('saves a regular trace file', async function() {
         const {traceEvents, metadata} = await TraceLoader.traceFile(this, 'web-dev.json.gz');
         await timeline.innerSaveToFile(traceEvents, metadata, {
-          savingEnhancedTrace: false,
+          includeScriptContent: false,
+          includeSourceMaps: false,
           addModifications: false,
         });
 
@@ -340,7 +341,8 @@ describeWithEnvironment('TimelinePanel', function() {
         const {traceEvents, metadata} = file;
 
         await timeline.innerSaveToFile(traceEvents, metadata, {
-          savingEnhancedTrace: false,
+          includeScriptContent: false,
+          includeSourceMaps: false,
           addModifications: false,
         });
 
@@ -356,10 +358,11 @@ describeWithEnvironment('TimelinePanel', function() {
         assert.deepEqual(cpuFile, profile2);
       });
 
-      it('saves an enhanced trace file', async function() {
+      it('saves an enhanced trace file without sourcemaps', async function() {
         const {traceEvents, metadata} = await TraceLoader.traceFile(this, 'enhanced-traces.json.gz');
         await timeline.innerSaveToFile(traceEvents, metadata, {
-          savingEnhancedTrace: true,
+          includeScriptContent: true,
+          includeSourceMaps: false,
           addModifications: false,
         });
 
@@ -371,6 +374,26 @@ describeWithEnvironment('TimelinePanel', function() {
 
         const file = await contentDataToFile(contentData);
         assert.isDefined(file.metadata.enhancedTraceVersion);
+        assert.isUndefined(file.metadata.sourceMaps);
+      });
+
+      it('saves an enhanced trace file with sourcemaps', async function() {
+        const {traceEvents, metadata} = await TraceLoader.traceFile(this, 'dupe-js-inline-maps.json.gz');
+        await timeline.innerSaveToFile(traceEvents, metadata, {
+          includeScriptContent: true,
+          includeSourceMaps: true,
+          addModifications: false,
+        });
+
+        sinon.assert.calledOnce(saveSpy);
+        sinon.assert.calledOnce(closeSpy);
+
+        const [fileName, contentData] = saveSpy.getCall(0).args;
+        assert.match(fileName, /EnhancedTrace-[\d|T]+\.json\.gz$/);
+
+        const file = await contentDataToFile(contentData);
+        assert.isDefined(file.metadata.enhancedTraceVersion);
+        assert.isDefined(file.metadata.sourceMaps);
       });
 
       it('saves a trace file with modifications', async function() {
@@ -407,7 +430,8 @@ describeWithEnvironment('TimelinePanel', function() {
       it('saves a regular trace file', async function() {
         const {traceEvents, metadata} = await TraceLoader.traceFile(this, 'web-dev.json.gz');
         await timeline.innerSaveToFile(traceEvents, metadata, {
-          savingEnhancedTrace: false,
+          includeScriptContent: false,
+          includeSourceMaps: false,
           addModifications: false,
         });
 

front_end/panels/timeline/TimelinePanel.ts

@@ -1409,8 +1409,7 @@ export class TimelinePanel extends Common.ObjectWrapper.eventMixin<EventTypes, t
 
     const metadata = this.#traceEngineModel.metadata(this.#viewMode.traceIndex) ?? {};
 
-    const shouldRetainScriptSources = config.includeScriptContent && config.includeSourceMaps;
-    if (!shouldRetainScriptSources) {
+    if (!config.includeScriptContent) {
       traceEvents = traceEvents.map(event => {
         if (Trace.Types.Events.isAnyScriptCatchupEvent(event) && event.name !== 'StubScriptCatchup') {
           return {
@@ -1442,9 +1441,11 @@ export class TimelinePanel extends Common.ObjectWrapper.eventMixin<EventTypes, t
     // export the config.
 
     try {
-      await this.innerSaveToFile(
-          traceEvents, metadata,
-          {savingEnhancedTrace: config.includeScriptContent, addModifications: config.addModifications});
+      await this.innerSaveToFile(traceEvents, metadata, {
+        includeScriptContent: config.includeScriptContent,
+        includeSourceMaps: config.includeSourceMaps,
+        addModifications: config.addModifications
+      });
     } catch (e) {
       // We expect the error to be an Error class, but this deals with any weird case where it's not.
       const error = e instanceof Error ? e : new Error(e);
@@ -1460,21 +1461,22 @@ export class TimelinePanel extends Common.ObjectWrapper.eventMixin<EventTypes, t
   }
 
   async innerSaveToFile(traceEvents: readonly Trace.Types.Events.Event[], metadata: Trace.Types.File.MetaData, config: {
-    savingEnhancedTrace: boolean,
+    includeScriptContent: boolean,
+    includeSourceMaps: boolean,
     addModifications: boolean,
   }): Promise<void> {
     // Base the filename on the trace's time of recording
     const isoDate =
         Platform.DateUtilities.toISO8601Compact(metadata.startTime ? new Date(metadata.startTime) : new Date());
 
     const isCpuProfile = metadata.dataOrigin === Trace.Types.File.DataOrigin.CPU_PROFILE;
-    const {savingEnhancedTrace} = config;
+    const {includeScriptContent, includeSourceMaps} = config;
     metadata.enhancedTraceVersion =
-        savingEnhancedTrace ? SDK.EnhancedTracesParser.EnhancedTracesParser.enhancedTraceVersion : undefined;
+        includeScriptContent ? SDK.EnhancedTracesParser.EnhancedTracesParser.enhancedTraceVersion : undefined;
 
     let fileName = (isCpuProfile ? `CPU-${isoDate}.cpuprofile` :
-                        savingEnhancedTrace ? `EnhancedTrace-${isoDate}.json` :
-                                              `Trace-${isoDate}.json`) as Platform.DevToolsPath.RawPathString;
+                        includeScriptContent ? `EnhancedTrace-${isoDate}.json` :
+                                               `Trace-${isoDate}.json`) as Platform.DevToolsPath.RawPathString;
 
     let blobParts: string[] = [];
     if (isCpuProfile) {
@@ -1483,7 +1485,7 @@ export class TimelinePanel extends Common.ObjectWrapper.eventMixin<EventTypes, t
     } else {
       const formattedTraceIter = traceJsonGenerator(traceEvents, {
         ...metadata,
-        sourceMaps: savingEnhancedTrace ? metadata.sourceMaps : undefined,
+        sourceMaps: includeScriptContent && includeSourceMaps ? metadata.sourceMaps : undefined,
       });
       blobParts = Array.from(formattedTraceIter);
     }