Skip to content

fix(profiling): Add platform to envelope item header #18954

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
s1gr1d merged 2 commits into from
Jan 23, 2026
Merged

fix(profiling): Add platform to envelope item header #18954

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2155d95
fix(profiling): Add `platform` to envelope item header
s1gr1d Jan 23, 2026
92696ae
use direct assertion
s1gr1d Jan 23, 2026
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
4 changes: 2 additions & 2 deletions dev-packages/browser-integration-tests/suites/profiling/manualMode/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ sentryTest('sends profile_chunk envelopes in manual mode', async ({ page, getLoc
const envelopeItemHeader = profileChunkEnvelopeItem[0];
const envelopeItemPayload1 = profileChunkEnvelopeItem[1];

expect(envelopeItemHeader).toHaveProperty('type', 'profile_chunk');
expect(envelopeItemHeader).toEqual({ type: 'profile_chunk', platform: 'javascript' });
expect(envelopeItemPayload1.profile).toBeDefined();

const profilerId1 = envelopeItemPayload1.profiler_id;
Expand All @@ -71,7 +71,7 @@ sentryTest('sends profile_chunk envelopes in manual mode', async ({ page, getLoc
const envelopeItemHeader2 = profileChunkEnvelopeItem2[0];
const envelopeItemPayload2 = profileChunkEnvelopeItem2[1];

expect(envelopeItemHeader2).toHaveProperty('type', 'profile_chunk');
expect(envelopeItemHeader2).toEqual({ type: 'profile_chunk', platform: 'javascript' });
expect(envelopeItemPayload2.profile).toBeDefined();

expect(envelopeItemPayload2.profiler_id).toBe(profilerId1); // same profiler id for the whole session
Expand Down
4 changes: 2 additions & 2 deletions ...ges/browser-integration-tests/suites/profiling/traceLifecycleMode_multiple-chunks/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ sentryTest(
const envelopeItemHeader = profileChunkEnvelopeItem[0];
const envelopeItemPayload1 = profileChunkEnvelopeItem[1];

expect(envelopeItemHeader).toHaveProperty('type', 'profile_chunk');
expect(envelopeItemHeader).toEqual({ type: 'profile_chunk', platform: 'javascript' });
expect(envelopeItemPayload1.profile).toBeDefined();

validateProfilePayloadMetadata(envelopeItemPayload1);
Expand All @@ -77,7 +77,7 @@ sentryTest(
const envelopeItemHeader2 = profileChunkEnvelopeItem2[0];
const envelopeItemPayload2 = profileChunkEnvelopeItem2[1];

expect(envelopeItemHeader2).toHaveProperty('type', 'profile_chunk');
expect(envelopeItemHeader2).toEqual({ type: 'profile_chunk', platform: 'javascript' });
expect(envelopeItemPayload2.profile).toBeDefined();

validateProfilePayloadMetadata(envelopeItemPayload2);
Expand Down
2 changes: 1 addition & 1 deletion ...s/browser-integration-tests/suites/profiling/traceLifecycleMode_overlapping-spans/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ sentryTest(
const envelopeItemHeader = profileChunkEnvelopeItem[0];
const envelopeItemPayload = profileChunkEnvelopeItem[1];

expect(envelopeItemHeader).toHaveProperty('type', 'profile_chunk');
expect(envelopeItemHeader).toEqual({ type: 'profile_chunk', platform: 'javascript' });
expect(envelopeItemPayload.profile).toBeDefined();

validateProfilePayloadMetadata(envelopeItemPayload);
Expand Down
2 changes: 1 addition & 1 deletion packages/browser/src/profiling/UIProfiler.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -401,7 +401,7 @@ export class UIProfiler implements ContinuousProfiler<Client> {
...(sdkInfo && { sdk: sdkInfo }),
...(!!tunnel && dsn && { dsn: dsnToString(dsn) }),
},
[[{ type: 'profile_chunk' }, chunk]],
[[{ type: 'profile_chunk', platform: 'javascript' }, chunk]],
);

client.sendEnvelope(envelope).then(null, reason => {
Expand Down
3 changes: 3 additions & 0 deletions packages/browser/test/profiling/UIProfiler.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,7 @@ describe('Browser Profiling v2 trace lifecycle', () => {
const transactionEnvelopeHeader = send.mock.calls?.[0]?.[0]?.[1]?.[0]?.[0];
const profileChunkEnvelopeHeader = send.mock.calls?.[1]?.[0]?.[1]?.[0]?.[0];
expect(profileChunkEnvelopeHeader?.type).toBe('profile_chunk');
expect(profileChunkEnvelopeHeader?.platform).toBe('javascript');
expect(transactionEnvelopeHeader?.type).toBe('transaction');
});

Expand Down Expand Up @@ -207,6 +208,7 @@ describe('Browser Profiling v2 trace lifecycle', () => {
expect(mockConstructor.mock.calls.length).toBe(2);
const firstChunkHeader = send.mock.calls?.[0]?.[0]?.[1]?.[0]?.[0];
expect(firstChunkHeader?.type).toBe('profile_chunk');
expect(firstChunkHeader?.platform).toBe('javascript');

// Second chunk after another 60s
vi.advanceTimersByTime(60_000);
Expand Down Expand Up @@ -679,6 +681,7 @@ describe('Browser Profiling v2 manual lifecycle', () => {
expect(send).toHaveBeenCalledTimes(1);
const envelopeHeader = send.mock.calls?.[0]?.[0]?.[1]?.[0]?.[0];
expect(envelopeHeader?.type).toBe('profile_chunk');
expect(envelopeHeader?.platform).toBe('javascript');
});

it('calling start and stop while profile session is running prints warnings', async () => {
Expand Down
Loading