Skip to content

Bump the Gecko profile version to make sure that the Text and Log marker changes are picked up in the frontends #6252

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
canova merged 1 commit into from
Aug 10, 2026
Merged

Bump the Gecko profile version to make sure that the Text and Log marker changes are picked up in the frontends #6252

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs-developer/CHANGELOG-formats.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,12 @@ Older versions are not documented in this changelog but can be found in [process

## Gecko profile format

### Version 36

The `Text` marker's `name` field and the `Log` marker's `message` field are now unique strings, so their payloads hold a string table index instead of the text itself. Both marker schemas declare this with the `unique-string` field format.

No profile format upgrade is needed, as the frontend reads the field format from the marker schema. But older frontends read these two fields directly instead of looking at their schema, so they throw an error while sanitizing the profile for upload and while extracting the MOZ_LOG output. This version bump makes sure that these older frontend versions get updated.

### Version 35

A new `hexadecimal` marker schema field format type has been added, which displays an integer value in hexadecimal with a `0x` prefix.
Expand Down
2 changes: 1 addition & 1 deletion src/app-logic/constants.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 = 35;
export const GECKO_PROFILE_VERSION = 36;

// The current version of the "processed" profile format.
// Please don't forget to update the processed profile format changelog in
Expand Down
8 changes: 8 additions & 0 deletions src/profile-logic/gecko-profile-versioning.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1570,6 +1570,14 @@ const _upgraders: {
// marker data with hexadecimal typed data, and no modification is needed in the
// frontend to display older formats.
},
[36]: (_: any) => {
// The Text marker's "name" field and the Log marker's "message" field are
// now unique strings, so their payloads hold a string table index instead
// of the text itself.
// No upgrade is needed, as the frontend reads the field format from the
// marker schema. This bump is only here so that older frontends, which read
// these two fields directly, get updated.
},

// If you add a new upgrader here, please document the change in
// `docs-developer/CHANGELOG-formats.md`.
Expand Down
2 changes: 1 addition & 1 deletion src/test/store/__snapshots__/profile-view.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -436,7 +436,7 @@ Object {
"startTime": 0,
"symbolicated": true,
"toolkit": "",
"version": 35,
"version": 36,
},
"pages": Array [
Object {
Expand Down
32 changes: 16 additions & 16 deletions src/test/unit/__snapshots__/profile-conversion.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Object {
"preprocessedProfileVersion": 69,
"product": "ART Trace (Android)",
"symbolicated": true,
"version": 35,
"version": 36,
},
"sharedCounts": Object {
"frames": 2686,
Expand Down Expand Up @@ -1025,7 +1025,7 @@ Object {
"preprocessedProfileVersion": 69,
"product": "ART Trace (Android)",
"symbolicated": true,
"version": 35,
"version": 36,
},
"sharedCounts": Object {
"frames": 5412,
Expand Down Expand Up @@ -2308,7 +2308,7 @@ Object {
"preprocessedProfileVersion": 69,
"product": "Chrome Trace",
"symbolicated": true,
"version": 35,
"version": 36,
},
"sharedCounts": Object {
"frames": 26,
Expand Down Expand Up @@ -2700,7 +2700,7 @@ Object {
"preprocessedProfileVersion": 69,
"product": "Chrome Trace",
"symbolicated": true,
"version": 35,
"version": 36,
},
"sharedCounts": Object {
"frames": 26,
Expand Down Expand Up @@ -3089,7 +3089,7 @@ Object {
"preprocessedProfileVersion": 69,
"product": "Chrome Trace",
"symbolicated": true,
"version": 35,
"version": 36,
},
"sharedCounts": Object {
"frames": 47,
Expand Down Expand Up @@ -3190,7 +3190,7 @@ Object {
"preprocessedProfileVersion": 69,
"product": "Chrome Trace",
"symbolicated": true,
"version": 35,
"version": 36,
},
"sharedCounts": Object {
"frames": 0,
Expand Down Expand Up @@ -3543,7 +3543,7 @@ Object {
"preprocessedProfileVersion": 69,
"product": "Chrome Trace",
"symbolicated": true,
"version": 35,
"version": 36,
},
"sharedCounts": Object {
"frames": 164,
Expand Down Expand Up @@ -3608,7 +3608,7 @@ Object {
"preprocessedProfileVersion": 69,
"product": "Chrome Trace",
"symbolicated": true,
"version": 35,
"version": 36,
},
"sharedCounts": Object {
"frames": 231,
Expand Down Expand Up @@ -3762,7 +3762,7 @@ Object {
"preprocessedProfileVersion": 69,
"product": "Chrome Trace",
"symbolicated": true,
"version": 35,
"version": 36,
},
"sharedCounts": Object {
"frames": 47,
Expand Down Expand Up @@ -3820,7 +3820,7 @@ Object {
"preprocessedProfileVersion": 69,
"product": "Firefox",
"symbolicated": true,
"version": 35,
"version": 36,
},
"sharedCounts": Object {
"frames": 202,
Expand Down Expand Up @@ -4210,7 +4210,7 @@ Object {
"preprocessedProfileVersion": 69,
"product": "Firefox",
"symbolicated": true,
"version": 35,
"version": 36,
},
"sharedCounts": Object {
"frames": 610,
Expand Down Expand Up @@ -4268,7 +4268,7 @@ Object {
"preprocessedProfileVersion": 69,
"product": "Firefox",
"symbolicated": true,
"version": 35,
"version": 36,
},
"sharedCounts": Object {
"frames": 229,
Expand Down Expand Up @@ -4326,7 +4326,7 @@ Object {
"preprocessedProfileVersion": 69,
"product": "Firefox",
"symbolicated": true,
"version": 35,
"version": 36,
},
"sharedCounts": Object {
"frames": 802,
Expand Down Expand Up @@ -5322,7 +5322,7 @@ Object {
"preprocessedProfileVersion": 69,
"product": "target/debug/examples/work_log (dhat)",
"symbolicated": true,
"version": 35,
"version": 36,
},
"sharedCounts": Object {
"frames": 430,
Expand Down Expand Up @@ -5455,7 +5455,7 @@ Object {
"preprocessedProfileVersion": 69,
"product": "Flamegraph",
"symbolicated": true,
"version": 35,
"version": 36,
},
"sharedCounts": Object {
"frames": 154,
Expand Down Expand Up @@ -5513,7 +5513,7 @@ Object {
"preprocessedProfileVersion": 69,
"product": "Flamegraph",
"symbolicated": true,
"version": 35,
"version": 36,
},
"sharedCounts": Object {
"frames": 5,
Expand Down
6 changes: 3 additions & 3 deletions src/test/unit/__snapshots__/profile-upgrading.test.ts.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Object {
"symbolicated": true,
"toolkit": undefined,
"updateChannel": undefined,
"version": 35,
"version": 36,
"visualMetrics": undefined,
},
"pages": Array [],
Expand Down Expand Up @@ -4610,7 +4610,7 @@ Object {
"stackwalk": 1,
"startTime": 1460221352723.438,
"toolkit": "cocoa",
"version": 35,
"version": 36,
},
"pausedRanges": Array [],
"processes": Array [
Expand Down Expand Up @@ -6086,7 +6086,7 @@ Object {
"stackwalk": 1,
"startTime": 1460221352723.438,
"toolkit": "cocoa",
"version": 35,
"version": 36,
},
"pages": Array [
Object {
Expand Down
Loading