Make the source table non-optional in the gecko profile format

docs-developer/CHANGELOG-formats.md

@@ -128,13 +128,17 @@ We've also cleaned up the ResourceTable format:
 
 ### Older Versions
 
-Older versions are not documented in this changelog but can be found in [processed-profile-versioning.jt](../src/profile-logic/processed-profile-versioning.ts).
+Older versions are not documented in this changelog but can be found in [processed-profile-versioning.ts](../src/profile-logic/processed-profile-versioning.ts).
 
 ## Gecko profile format
 
+### Version 33
+
+The `sources` field in the Gecko profile format is now non-optional. An upgrader was added that creates an empty `SourceTable` for profiles that don't have one.
+
 ### Version 32
 
-`frameTable` `location` string field was changed to include an optional `sourceIndex` at the end of the string inside brackets for JS sources. For example, new JS frames look like this: `functionName (http://script.url/:1234:1234)[1234]` with the last number being its `sourceIndex`. This index references entries in the shared `SourceTable` in `profile.sources` (added in in the same version) which centralizes all source file information.
+`frameTable` `location` string field was changed to include an optional `sourceIndex` at the end of the string inside brackets for JS sources. For example, new JS frames look like this: `functionName (http://script.url/:1234:1234)[1234]` with the last number being its `sourceIndex`. This index references entries in the shared `SourceTable` in `profile.sources` (added in the same version) which centralizes all source file information.
 
 ### Version 31
 
@@ -163,4 +167,4 @@ The `searchable` property is implemented in the marker schema. Previously all th
 
 ### Older Versions
 
-Older versions are not documented in this changelog but can be found in [gecko-profile-versioning.jt](../src/profile-logic/gecko-profile-versioning.ts).
+Older versions are not documented in this changelog but can be found in [gecko-profile-versioning.ts](../src/profile-logic/gecko-profile-versioning.ts).

src/app-logic/constants.ts

@@ -7,7 +7,7 @@ import type { MarkerPhase } from 'firefox-profiler/types';
 // The current version of the Gecko profile format.
 // Please don't forget to update the gecko profile format changelog in
 // `docs-developer/CHANGELOG-formats.md`.
-export const GECKO_PROFILE_VERSION = 32;
+export const GECKO_PROFILE_VERSION = 33;
 
 // The current version of the "processed" profile format.
 // Please don't forget to update the processed profile format changelog in

src/profile-logic/gecko-profile-versioning.ts

@@ -1498,6 +1498,29 @@ const _upgraders: {
     //   within the existing location string.
     // - The source ID is optional, so v31 profiles are valid v32 profiles.
   },
+  [33]: (profile: any) => {
+    // Make SourceTable non-optional by adding an empty one if it doesn't exist.
+    // The sources table was added as optional in version 32, but we now require
+    // it to always be present to simplify the code that uses it and support
+    // source maps in the future.
+    // Source IDs are still optional in the frameTable location strings.
+    function convertToVersion33Recursive(p: any) {
+      if (!p.sources) {
+        p.sources = {
+          schema: {
+            uuid: 0,
+            filename: 1,
+          },
+          data: [],
+        };
+      }
+
+      for (const subprocessProfile of p.processes) {
+        convertToVersion33Recursive(subprocessProfile);
+      }
+    }
+    convertToVersion33Recursive(profile);
+  },
 
   // If you add a new upgrader here, please document the change in
   // `docs-developer/CHANGELOG-formats.md`.

src/profile-logic/process-profile.ts

@@ -196,7 +196,7 @@ type ExtractionInfo = {
     { funcIndex: IndexIntoFuncTable; frameAddress: Address | null }
   >;
   globalDataCollector: GlobalDataCollector;
-  geckoSourceTable: GeckoSourceTable | undefined;
+  geckoSourceTable: GeckoSourceTable;
 };
 
 /**
@@ -214,7 +214,7 @@ export function extractFuncsAndResourcesFromFrameLocations(
   libs: LibMapping[],
   extensions: ExtensionTable = getEmptyExtensions(),
   globalDataCollector: GlobalDataCollector,
-  geckoSourceTable: GeckoSourceTable | undefined
+  geckoSourceTable: GeckoSourceTable
 ): {
   funcTable: FuncTable;
   resourceTable: ResourceTable;
@@ -539,7 +539,7 @@ function _extractJsFunction(
   if (sourceIndex !== undefined) {
     const geckoSourceIdx = parseInt(sourceIndex, 10);
     // Look up the UUID for this source index from the process's sources table
-    if (geckoSourceTable && geckoSourceIdx < geckoSourceTable.data.length) {
+    if (geckoSourceIdx < geckoSourceTable.data.length) {
       const uuidIndex = geckoSourceTable.schema.uuid;
       const filenameIndex = geckoSourceTable.schema.filename;
       const uuid = geckoSourceTable.data[geckoSourceIdx][uuidIndex];

src/test/fixtures/profiles/gecko-profile.ts

@@ -21,6 +21,7 @@ import type {
   GeckoMarkerTuple,
   VisualMetrics,
   Nanoseconds,
+  GeckoSourceTable,
 } from 'firefox-profiler/types';
 
 import {
@@ -45,6 +46,16 @@ function getEmptyMarkers(): GeckoMarkers {
   };
 }
 
+export function getEmptySourceTable(): GeckoSourceTable {
+  return {
+    schema: {
+      uuid: 0 as const,
+      filename: 1 as const,
+    },
+    data: [],
+  };
+}
+
 export function createGeckoMarkerStack({
   stackIndex,
   time,
@@ -111,6 +122,7 @@ export function createGeckoSubprocessProfile(
     meta: contentProcessMeta,
     pausedRanges: [],
     libs: [contentProcessBinary, ...parentProfile.libs.slice(1)], // libs are stringified in the Gecko profile
+    sources: getEmptySourceTable(),
     pages: [
       {
         tabID: 123123,
@@ -315,6 +327,7 @@ export function createGeckoProfile(): GeckoProfile {
     meta: parentProcessMeta,
     libs: [parentProcessBinary].concat(extraBinaries),
     pages: parentProcessPages,
+    sources: getEmptySourceTable(),
     counters: parentProcessCounters,
     profilerOverhead: parentProcessOverhead,
     pausedRanges: [],
@@ -384,6 +397,7 @@ export function createGeckoProfileWithMarkers(
     meta: geckoProfile.meta,
     libs: geckoProfile.libs,
     pages: geckoProfile.pages,
+    sources: geckoProfile.sources,
     pausedRanges: [],
     threads: [_createGeckoThreadWithMarkers(markers)],
     processes: [],
@@ -950,6 +964,7 @@ export function createGeckoProfileWithJsTimings(): GeckoProfile {
     meta: geckoProfile.meta,
     libs: geckoProfile.libs,
     pages: geckoProfile.pages,
+    sources: geckoProfile.sources,
     pausedRanges: [],
     threads: [
       _createGeckoThreadWithJsTimings('GeckoMain'),

src/test/store/__snapshots__/profile-view.test.ts.snap

@@ -426,7 +426,7 @@ Object {
     "startTime": 0,
     "symbolicated": true,
     "toolkit": "",
-    "version": 32,
+    "version": 33,
   },
   "pages": Array [
     Object {

src/test/unit/__snapshots__/profile-conversion.test.ts.snap

@@ -604,7 +604,7 @@ Object {
     "symbolicated": true,
     "toolkit": undefined,
     "updateChannel": undefined,
-    "version": 32,
+    "version": 33,
     "visualMetrics": undefined,
   },
   "pages": Array [],
@@ -85577,7 +85577,7 @@ Object {
     "symbolicated": true,
     "toolkit": undefined,
     "updateChannel": undefined,
-    "version": 32,
+    "version": 33,
     "visualMetrics": undefined,
   },
   "pages": Array [],
@@ -334708,7 +334708,7 @@ Object {
     "startTime": 0,
     "symbolicated": true,
     "toolkit": "",
-    "version": 32,
+    "version": 33,
   },
   "pages": Array [],
   "shared": Object {
@@ -370190,7 +370190,7 @@ Object {
     "startTime": 0,
     "symbolicated": true,
     "toolkit": "",
-    "version": 32,
+    "version": 33,
   },
   "pages": Array [],
   "shared": Object {
@@ -405651,7 +405651,7 @@ Object {
     "startTime": 0,
     "symbolicated": true,
     "toolkit": "",
-    "version": 32,
+    "version": 33,
   },
   "pages": Array [],
   "shared": Object {
@@ -408280,7 +408280,7 @@ Object {
     "startTime": 0,
     "symbolicated": true,
     "toolkit": "",
-    "version": 32,
+    "version": 33,
   },
   "pages": Array [],
   "shared": Object {
@@ -410641,7 +410641,7 @@ Object {
     "startTime": 1700159839203.051,
     "symbolicated": true,
     "toolkit": "",
-    "version": 32,
+    "version": 33,
   },
   "pages": Array [],
   "shared": Object {
@@ -414171,7 +414171,7 @@ Object {
     "startTime": 0,
     "symbolicated": true,
     "toolkit": "",
-    "version": 32,
+    "version": 33,
   },
   "pages": Array [],
   "shared": Object {
@@ -419436,7 +419436,7 @@ Object {
     "startTime": 0,
     "symbolicated": true,
     "toolkit": "",
-    "version": 32,
+    "version": 33,
   },
   "pages": Array [],
   "shared": Object {
@@ -420466,7 +420466,7 @@ Object {
     "symbolicated": true,
     "toolkit": undefined,
     "updateChannel": undefined,
-    "version": 32,
+    "version": 33,
     "visualMetrics": undefined,
   },
   "pages": Array [],
@@ -426405,7 +426405,7 @@ Object {
     "symbolicated": true,
     "toolkit": undefined,
     "updateChannel": undefined,
-    "version": 32,
+    "version": 33,
     "visualMetrics": undefined,
   },
   "pages": Array [],
@@ -441300,7 +441300,7 @@ Object {
     "symbolicated": true,
     "toolkit": undefined,
     "updateChannel": undefined,
-    "version": 32,
+    "version": 33,
     "visualMetrics": undefined,
   },
   "pages": Array [],
@@ -447504,7 +447504,7 @@ Object {
     "symbolicated": true,
     "toolkit": undefined,
     "updateChannel": undefined,
-    "version": 32,
+    "version": 33,
     "visualMetrics": undefined,
   },
   "pages": Array [],
@@ -606878,7 +606878,7 @@ Object {
     "startTime": 0,
     "symbolicated": true,
     "toolkit": "",
-    "version": 32,
+    "version": 33,
   },
   "pages": Array [],
   "shared": Object {
@@ -630473,7 +630473,7 @@ Object {
     "startTime": 0,
     "symbolicated": true,
     "toolkit": "",
-    "version": 32,
+    "version": 33,
   },
   "pages": Array [],
   "shared": Object {
@@ -938356,7 +938356,7 @@ Object {
     "startTime": 0,
     "symbolicated": true,
     "toolkit": "",
-    "version": 32,
+    "version": 33,
   },
   "pages": Array [],
   "shared": Object {

src/test/unit/__snapshots__/profile-upgrading.test.ts.snap

@@ -53,7 +53,7 @@ Object {
     "symbolicated": true,
     "toolkit": undefined,
     "updateChannel": undefined,
-    "version": 32,
+    "version": 33,
     "visualMetrics": undefined,
   },
   "pages": Array [],
@@ -6389,7 +6389,7 @@ Object {
     "stackwalk": 1,
     "startTime": 1460221352723.438,
     "toolkit": "cocoa",
-    "version": 32,
+    "version": 33,
   },
   "pausedRanges": Array [],
   "processes": Array [
@@ -6501,6 +6501,13 @@ Object {
       },
       "pausedRanges": Array [],
       "processes": Array [],
+      "sources": Object {
+        "data": Array [],
+        "schema": Object {
+          "filename": 1,
+          "uuid": 0,
+        },
+      },
       "threads": Array [
         Object {
           "frameTable": Object {
@@ -6783,6 +6790,13 @@ Object {
       ],
     },
   ],
+  "sources": Object {
+    "data": Array [],
+    "schema": Object {
+      "filename": 1,
+      "uuid": 0,
+    },
+  },
   "threads": Array [
     Object {
       "frameTable": Object {
@@ -7845,7 +7859,7 @@ Object {
     "stackwalk": 1,
     "startTime": 1460221352723.438,
     "toolkit": "cocoa",
-    "version": 32,
+    "version": 33,
   },
   "pages": Array [
     Object {
@@ -7985,6 +7999,13 @@ Object {
       ],
       "pausedRanges": Array [],
       "processes": Array [],
+      "sources": Object {
+        "data": Array [],
+        "schema": Object {
+          "filename": 1,
+          "uuid": 0,
+        },
+      },
       "threads": Array [
         Object {
           "frameTable": Object {
@@ -8349,6 +8370,13 @@ Object {
       ],
     },
   ],
+  "sources": Object {
+    "data": Array [],
+    "schema": Object {
+      "filename": 1,
+      "uuid": 0,
+    },
+  },
   "threads": Array [
     Object {
       "frameTable": Object {