Add upgraders for all the source table changes

Author: canova

docs-developer/CHANGELOG-formats.md

@@ -6,6 +6,14 @@ Note that this is not an exhaustive list. Processed profile format upgraders can
 
 ## Processed profile format
 
+### Version 61
+
+The `SourceTable` in `profile.shared.sources` was updated:
+
+- The `uuid` field was renamed to `id`.
+- Two new fields `startLine` and `startColumn` were added (1-based, defaulting to 1). These describe the start position of the script within its resource, useful for inline scripts.
+- A new `sourceMapURL` field was added (defaulting to `null`).
+
 ### Version 60
 
 The following tables have moved into `profile.shared`: `stackTable`, `frameTable`, `funcTable`, `resourceTable`, `nativeSymbols`. They are no longer per-thread.
@@ -137,6 +145,14 @@ Older versions are not documented in this changelog but can be found in [process
 
 ## Gecko profile format
 
+### Version 34
+
+The `SourceTable` schema was updated:
+
+- The `uuid` field was renamed to `id`.
+- Two new fields `startLine` and `startColumn` were added (1-based, defaulting to 1).
+- A new `sourceMapURL` field was added (defaulting to `null`).
+
 ### 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.

src/app-logic/constants.ts

@@ -7,12 +7,12 @@ 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 = 33;
+export const GECKO_PROFILE_VERSION = 34;
 
 // The current version of the "processed" profile format.
 // Please don't forget to update the processed profile format changelog in
 // `docs-developer/CHANGELOG-formats.md`.
-export const PROCESSED_PROFILE_VERSION = 60;
+export const PROCESSED_PROFILE_VERSION = 61;
 
 // The following are the margin sizes for the left and right of the timeline. Independent
 // components need to share these values.

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

@@ -1522,6 +1522,38 @@ const _upgraders: {
     convertToVersion33Recursive(profile);
   },
 
+  [34]: (profile: any) => {
+    // The source table schema was updated:
+    // - The "uuid" field was renamed to "id".
+    // - startLine and startColumn are added, defaulting to 1 as they are 1-based.
+    // - sourceMapURL was added, defaulting to null.
+    function convertToVersion34Recursive(p: any) {
+      if (p.sources) {
+        const schema = p.sources.schema;
+
+        schema.id = schema.uuid;
+        delete schema.uuid;
+
+        // Set the canonical indices for the new required fields and fill the
+        // arrays with default values.
+        schema.startLine = 2;
+        schema.startColumn = 3;
+        schema.sourceMapURL = 4;
+
+        for (const row of p.sources.data) {
+          row[2] = 1;
+          row[3] = 1;
+          row[4] = null;
+        }
+      }
+
+      for (const subprocessProfile of p.processes) {
+        convertToVersion34Recursive(subprocessProfile);
+      }
+    }
+    convertToVersion34Recursive(profile);
+  },
+
   // If you add a new upgrader here, please document the change in
   // `docs-developer/CHANGELOG-formats.md`.
 };

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

@@ -3029,6 +3029,26 @@ const _upgraders: {
     profile.shared.nativeSymbols = newNativeSymbols;
     upgradeInfo.v60 = { threadMappings, newFuncCount: newFuncTable.length };
   },
+
+  [61]: (profile: any) => {
+    // The source table schema was updated:
+    // - The "uuid" field was renamed to "id". Profiles stored at v58-60 before
+    //   this rename may still have the old "uuid" field name.
+    // - startLine and startColumn were added, defaulting to 1 as they are 1-based.
+    // - sourceMapURL was added, defaulting to null.
+    const sources = profile.shared && profile.shared.sources;
+    if (sources) {
+      if (sources.uuid !== undefined && sources.id === undefined) {
+        sources.id = sources.uuid;
+        delete sources.uuid;
+      }
+      const length = sources.length;
+      sources.startLine = new Array(length).fill(1);
+      sources.startColumn = new Array(length).fill(1);
+      sources.sourceMapURL = new Array(length).fill(null);
+    }
+  },
+
   // If you add a new upgrader here, please document the change in
   // `docs-developer/CHANGELOG-formats.md`.
 };

src/test/integration/symbolicator-cli/__snapshots__/symbolicator-cli.test.ts.snap

@@ -87,7 +87,7 @@ Object {
     "markerSchema": Array [],
     "oscpu": "macOS 14.6.1",
     "pausedRanges": Array [],
-    "preprocessedProfileVersion": 60,
+    "preprocessedProfileVersion": 61,
     "processType": 0,
     "product": "a.out",
     "sampleUnits": Object {
@@ -727,6 +727,9 @@ Object {
       "filename": Array [],
       "id": Array [],
       "length": 0,
+      "sourceMapURL": Array [],
+      "startColumn": Array [],
+      "startLine": Array [],
     },
     "stackTable": Object {
       "frame": Array [
@@ -1412,7 +1415,7 @@ Object {
     "markerSchema": Array [],
     "oscpu": "macOS 14.6.1",
     "pausedRanges": Array [],
-    "preprocessedProfileVersion": 60,
+    "preprocessedProfileVersion": 61,
     "processType": 0,
     "product": "a.out",
     "sampleUnits": Object {
@@ -2052,6 +2055,9 @@ Object {
       "filename": Array [],
       "id": Array [],
       "length": 0,
+      "sourceMapURL": Array [],
+      "startColumn": Array [],
+      "startLine": Array [],
     },
     "stackTable": Object {
       "frame": Array [

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

@@ -418,15 +418,15 @@ Object {
     "oscpu": "",
     "physicalCPUs": 0,
     "platform": "",
-    "preprocessedProfileVersion": 60,
+    "preprocessedProfileVersion": 61,
     "processType": 0,
     "product": "Firefox",
     "sourceURL": "",
     "stackwalk": 0,
     "startTime": 0,
     "symbolicated": true,
     "toolkit": "",
-    "version": 33,
+    "version": 34,
   },
   "pages": Array [
     Object {