Merge branch 'main' into fix-compare-url-upgraders

Author: mstange

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). These describe the start position of the script within its resource, useful for inline scripts. If the source covers the entire file, use `(1, 1)`.
+- A new `sourceMapURL` field was added. Use `null` for entries with no source map URL.
+
 ### 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). If the source covers the entire file, use `(1, 1)`.
+- A new `sourceMapURL` field was added. It can be omitted if it is the last element in the row and there is no source map URL.
+
 ### 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.

package.json

@@ -61,9 +61,9 @@
   },
   "dependencies": {
     "@codemirror/lang-cpp": "^6.0.3",
-    "@codemirror/lang-javascript": "^6.2.4",
+    "@codemirror/lang-javascript": "^6.2.5",
     "@codemirror/lang-rust": "^6.0.2",
-    "@codemirror/language": "^6.12.1",
+    "@codemirror/language": "^6.12.2",
     "@codemirror/state": "^6.5.4",
     "@codemirror/view": "^6.39.14",
     "@firefox-devtools/react-contextmenu": "^5.2.3",
@@ -118,15 +118,15 @@
     "@babel/preset-env": "^7.29.0",
     "@babel/preset-react": "^7.28.5",
     "@babel/preset-typescript": "^7.28.5",
-    "@eslint/js": "^9.39.3",
+    "@eslint/js": "^9.39.4",
     "@testing-library/dom": "^10.4.1",
     "@testing-library/jest-dom": "^6.9.1",
     "@testing-library/react": "^16.3.2",
     "@types/clamp": "^1.0.3",
     "@types/common-tags": "^1.8.4",
     "@types/jest": "^30.0.0",
     "@types/minimist": "^1.2.5",
-    "@types/node": "^22.19.13",
+    "@types/node": "^22.19.15",
     "@types/query-string": "^6.3.0",
     "@types/react": "^18.3.28",
     "@types/react-dom": "^18.3.1",
@@ -147,18 +147,18 @@
     "esbuild": "^0.27.0",
     "esbuild-plugin-copy": "^2.1.1",
     "esbuild-plugin-wasm": "^1.1.0",
-    "eslint": "^9.39.3",
+    "eslint": "^9.39.4",
     "eslint-config-prettier": "^10.1.8",
     "eslint-import-resolver-alias": "^1.1.2",
     "eslint-plugin-import": "^2.32.0",
-    "eslint-plugin-jest": "^29.13.0",
+    "eslint-plugin-jest": "^29.15.0",
     "eslint-plugin-jest-dom": "^5.5.0",
     "eslint-plugin-jest-formatting": "^3.1.0",
     "eslint-plugin-react": "^7.37.5",
     "eslint-plugin-testing-library": "^7.16.0",
     "fake-indexeddb": "^6.2.5",
     "fetch-mock": "^12.6.0",
-    "globals": "^17.3.0",
+    "globals": "^17.4.0",
     "husky": "^4.3.8",
     "jest": "^30.2.0",
     "jest-environment-jsdom": "^30.2.0",
@@ -169,7 +169,7 @@
     "npm-run-all2": "^8.0.4",
     "open": "^11.0.0",
     "patch-package": "^8.0.1",
-    "postcss": "^8.5.6",
+    "postcss": "^8.5.8",
     "postinstall-postinstall": "^2.1.0",
     "prettier": "^3.8.1",
     "rimraf": "^6.1.3",

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/components/app/SourceCodeFetcher.tsx

@@ -11,7 +11,7 @@ import {
   getSymbolServerUrl,
   getSourceViewFile,
   getSourceViewSourceIndex,
-  getSourceViewSourceUuid,
+  getSourceViewSourceId,
 } from 'firefox-profiler/selectors';
 import {
   beginLoadingSourceCodeFromUrl,
@@ -36,7 +36,7 @@ import type {
 type StateProps = {
   readonly sourceViewFile: string | null;
   readonly sourceViewSourceIndex: IndexIntoSourceTable | null;
-  readonly sourceViewSourceUuid: string | null;
+  readonly sourceViewSourceId: string | null;
   readonly sourceViewCode: SourceCodeStatus | void;
   readonly symbolServerUrl: string;
   readonly profile: Profile | null;
@@ -68,7 +68,7 @@ class SourceCodeFetcherImpl extends React.PureComponent<Props> {
       sourceViewSourceIndex,
       sourceViewCode,
       sourceViewFile,
-      sourceViewSourceUuid,
+      sourceViewSourceId,
       beginLoadingSourceCodeFromUrl,
       beginLoadingSourceCodeFromBrowserConnection,
       finishLoadingSourceCode,
@@ -105,7 +105,7 @@ class SourceCodeFetcherImpl extends React.PureComponent<Props> {
 
     const fetchSourceResult = await fetchSource(
       sourceViewFile,
-      sourceViewSourceUuid,
+      sourceViewSourceId,
       symbolServerUrl,
       addressProof,
       this._archiveCache,
@@ -137,7 +137,7 @@ export const SourceCodeFetcher = explicitConnect<{}, StateProps, DispatchProps>(
     mapStateToProps: (state) => ({
       sourceViewSourceIndex: getSourceViewSourceIndex(state),
       sourceViewFile: getSourceViewFile(state),
-      sourceViewSourceUuid: getSourceViewSourceUuid(state),
+      sourceViewSourceId: getSourceViewSourceId(state),
       sourceViewCode: getSourceViewCode(state),
       symbolServerUrl: getSymbolServerUrl(state),
       profile: getProfileOrNull(state),

src/profile-logic/data-structures.ts

@@ -348,8 +348,11 @@ export function getEmptySourceTable(): SourceTable {
     // If modifying this structure, please update all callers of this function to ensure
     // that they are pushing on correctly to the data structure. These pushes may not
     // be caught by the type system.
-    uuid: [],
+    id: [],
     filename: [],
+    startLine: [],
+    startColumn: [],
+    sourceMapURL: [],
     length: 0,
   };
 }

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

@@ -1522,6 +1522,41 @@ const _upgraders: {
     convertToVersion33Recursive(profile);
   },
 
+  [34]: (profile: any) => {
+    // The source table schema was updated:
+    // - The "uuid" field was renamed to "id".
+    // - startLine and startColumn were 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 source table schema indices for the new required fields.
+        // These indices specify which array position corresponds to each value.
+        // Then fill the arrays with default values.
+        // See the GeckoSourceTable type in src/types/gecko-profile.ts to see
+        // these 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/global-data-collector.ts

@@ -61,7 +61,7 @@ export class GlobalDataCollector {
   _libNameToResourceIndex: Map<IndexIntoStringTable, IndexIntoResourceTable> =
     new Map();
   _originToResourceIndex: Map<string, IndexIntoResourceTable> = new Map();
-  _uuidToSourceIndex: Map<string, IndexIntoSourceTable> = new Map();
+  _idToSourceIndex: Map<string, IndexIntoSourceTable> = new Map();
   _filenameToSourceIndex: Map<IndexIntoStringTable, IndexIntoSourceTable> =
     new Map();
 
@@ -115,26 +115,39 @@ export class GlobalDataCollector {
 
   // Return the global index for this source, adding it to the global list if
   // necessary.
-  indexForSource(uuid: string | null, filename: string): IndexIntoSourceTable {
+  indexForSource(
+    id: string | null,
+    filename: string,
+    startLine: number = 1,
+    startColumn: number = 1,
+    sourceMapURL: string | null = null
+  ): IndexIntoSourceTable {
     let index: IndexIntoSourceTable | undefined;
 
-    if (uuid !== null) {
-      index = this._uuidToSourceIndex.get(uuid);
+    if (id !== null) {
+      index = this._idToSourceIndex.get(id);
     } else {
-      // For null UUIDs, use filename-based lookup
+      // For null IDs, use filename-based lookup.
       const filenameIndex = this._stringTable.indexForString(filename);
       index = this._filenameToSourceIndex.get(filenameIndex);
     }
 
     if (index === undefined) {
       index = this._sources.length;
       const filenameIndex = this._stringTable.indexForString(filename);
-      this._sources.uuid[index] = uuid;
+      const sourceMapURLIndex =
+        sourceMapURL !== null
+          ? this._stringTable.indexForString(sourceMapURL)
+          : null;
+      this._sources.id[index] = id;
       this._sources.filename[index] = filenameIndex;
+      this._sources.startLine[index] = startLine;
+      this._sources.startColumn[index] = startColumn;
+      this._sources.sourceMapURL[index] = sourceMapURLIndex;
       this._sources.length++;
 
-      if (uuid !== null) {
-        this._uuidToSourceIndex.set(uuid, index);
+      if (id !== null) {
+        this._idToSourceIndex.set(id, index);
       } else {
         this._filenameToSourceIndex.set(filenameIndex, index);
       }

src/profile-logic/merge-compare.ts

@@ -556,17 +556,26 @@ function mergeSources(
     const oldStringToNewStringPlusOne = translationMapsForStrings[profileIndex];
 
     for (let i = 0; i < sources.length; i++) {
-      const uuid = sources.uuid[i];
+      const id = sources.id[i];
       const originalUrlIndex = sources.filename[i];
       const newUrlIndex = oldStringToNewStringPlusOne[originalUrlIndex] - 1;
 
-      const sourceKey = uuid ?? `null-uuid-${newUrlIndex}`;
+      const originalSourceMapURLIndex = sources.sourceMapURL[i];
+      const newSourceMapURLIndex =
+        originalSourceMapURLIndex !== null
+          ? oldStringToNewStringPlusOne[originalSourceMapURLIndex] - 1
+          : null;
+
+      const sourceKey = id ?? `null-id-${newUrlIndex}`;
       let insertedSourceIndex = mapOfInsertedSources.get(sourceKey);
       if (insertedSourceIndex === undefined) {
         // Add new source
         insertedSourceIndex = newSources.length;
-        newSources.uuid[insertedSourceIndex] = uuid;
+        newSources.id[insertedSourceIndex] = id;
         newSources.filename[insertedSourceIndex] = newUrlIndex;
+        newSources.startLine[insertedSourceIndex] = sources.startLine[i];
+        newSources.startColumn[insertedSourceIndex] = sources.startColumn[i];
+        newSources.sourceMapURL[insertedSourceIndex] = newSourceMapURLIndex;
         newSources.length++;
         mapOfInsertedSources.set(sourceKey, insertedSourceIndex);
       }

src/profile-logic/process-profile.ts

@@ -431,13 +431,27 @@ function _extractJsFunction(
   let processedSourceIndex = null;
   if (sourceIndex !== undefined) {
     const geckoSourceIdx = parseInt(sourceIndex, 10);
-    // Look up the UUID for this source index from the process's sources table
+    // Look up the ID for this source index from the process's sources table.
     if (geckoSourceIdx < geckoSourceTable.data.length) {
-      const uuidIndex = geckoSourceTable.schema.uuid;
+      const idIndex = geckoSourceTable.schema.id;
       const filenameIndex = geckoSourceTable.schema.filename;
-      const uuid = geckoSourceTable.data[geckoSourceIdx][uuidIndex];
+      const startLineIndex = geckoSourceTable.schema.startLine;
+      const startColumnIndex = geckoSourceTable.schema.startColumn;
+      const sourceMapURLIndex = geckoSourceTable.schema.sourceMapURL;
+      const id = geckoSourceTable.data[geckoSourceIdx][idIndex];
       const filename = geckoSourceTable.data[geckoSourceIdx][filenameIndex];
-      processedSourceIndex = globalDataCollector.indexForSource(uuid, filename);
+      const startLine = geckoSourceTable.data[geckoSourceIdx][startLineIndex];
+      const startColumn =
+        geckoSourceTable.data[geckoSourceIdx][startColumnIndex];
+      const sourceMapURL =
+        geckoSourceTable.data[geckoSourceIdx][sourceMapURLIndex];
+      processedSourceIndex = globalDataCollector.indexForSource(
+        id,
+        filename,
+        startLine,
+        startColumn,
+        sourceMapURL
+      );
     }
   }
 

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

@@ -2663,7 +2663,7 @@ const _upgraders: {
     // Create the sources table
     const sourceTable = {
       length: 0,
-      uuid: [] as Array<string | null>,
+      id: [] as Array<string | null>,
       filename: [] as Array<number>,
     };
 
@@ -2690,7 +2690,7 @@ const _upgraders: {
           if (sourceIndex === undefined) {
             // Add new entry to sources table
             sourceIndex = sourceTable.length;
-            sourceTable.uuid.push(null);
+            sourceTable.id.push(null);
             sourceTable.filename.push(fileNameIndex);
             sourceTable.length++;
             fileNameIndexToSourceIndex.set(fileNameIndex, sourceIndex);
@@ -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`.
 };