fix(profiling): Add platform to envelope item header

Author: s1gr1d

dev-packages/browser-integration-tests/suites/profiling/manualMode/test.ts

@@ -7,7 +7,7 @@ import {
   properFullEnvelopeRequestParser,
   shouldSkipTracingTest,
 } from '../../../utils/helpers';
-import { validateProfile, validateProfilePayloadMetadata } from '../test-utils';
+import { validateProfile, validateProfileItemHeader, validateProfilePayloadMetadata } from '../test-utils';
 
 sentryTest(
   'does not send profile envelope when document-policy is not set',
@@ -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');
+  validateProfileItemHeader(envelopeItemHeader);
   expect(envelopeItemPayload1.profile).toBeDefined();
 
   const profilerId1 = envelopeItemPayload1.profiler_id;
@@ -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');
+  validateProfileItemHeader(envelopeItemHeader2);
   expect(envelopeItemPayload2.profile).toBeDefined();
 
   expect(envelopeItemPayload2.profiler_id).toBe(profilerId1); // same profiler id for the whole session

dev-packages/browser-integration-tests/suites/profiling/test-utils.ts

@@ -7,6 +7,11 @@ interface ValidateProfileOptions {
   isChunkFormat?: boolean;
 }
 
+export function validateProfileItemHeader(header: Record<string, unknown>): void {
+  expect(header).toHaveProperty('type', 'profile_chunk');
+  expect(header).toHaveProperty('platform', 'javascript');
+}
+
 /**
  * Validates the metadata of a profile chunk envelope.
  * https://develop.sentry.dev/sdk/telemetry/profiles/sample-format-v2/

dev-packages/browser-integration-tests/suites/profiling/traceLifecycleMode_multiple-chunks/test.ts

@@ -7,7 +7,7 @@ import {
   properFullEnvelopeRequestParser,
   shouldSkipTracingTest,
 } from '../../../utils/helpers';
-import { validateProfile, validateProfilePayloadMetadata } from '../test-utils';
+import { validateProfile, validateProfileItemHeader, validateProfilePayloadMetadata } from '../test-utils';
 
 sentryTest(
   'does not send profile envelope when document-policy is not set',
@@ -51,7 +51,7 @@ sentryTest(
     const envelopeItemHeader = profileChunkEnvelopeItem[0];
     const envelopeItemPayload1 = profileChunkEnvelopeItem[1];
 
-    expect(envelopeItemHeader).toHaveProperty('type', 'profile_chunk');
+    validateProfileItemHeader(envelopeItemHeader);
     expect(envelopeItemPayload1.profile).toBeDefined();
 
     validateProfilePayloadMetadata(envelopeItemPayload1);
@@ -77,7 +77,7 @@ sentryTest(
     const envelopeItemHeader2 = profileChunkEnvelopeItem2[0];
     const envelopeItemPayload2 = profileChunkEnvelopeItem2[1];
 
-    expect(envelopeItemHeader2).toHaveProperty('type', 'profile_chunk');
+    validateProfileItemHeader(envelopeItemHeader2);
     expect(envelopeItemPayload2.profile).toBeDefined();
 
     validateProfilePayloadMetadata(envelopeItemPayload2);

dev-packages/browser-integration-tests/suites/profiling/traceLifecycleMode_overlapping-spans/test.ts

@@ -8,7 +8,7 @@ import {
   shouldSkipTracingTest,
   waitForTransactionRequestOnUrl,
 } from '../../../utils/helpers';
-import { validateProfile, validateProfilePayloadMetadata } from '../test-utils';
+import { validateProfile, validateProfileItemHeader, validateProfilePayloadMetadata } from '../test-utils';
 
 sentryTest(
   'does not send profile envelope when document-policy is not set',
@@ -52,7 +52,7 @@ sentryTest(
     const envelopeItemHeader = profileChunkEnvelopeItem[0];
     const envelopeItemPayload = profileChunkEnvelopeItem[1];
 
-    expect(envelopeItemHeader).toHaveProperty('type', 'profile_chunk');
+    validateProfileItemHeader(envelopeItemHeader);
     expect(envelopeItemPayload.profile).toBeDefined();
 
     validateProfilePayloadMetadata(envelopeItemPayload);

packages/browser/src/profiling/UIProfiler.ts

@@ -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 => {

packages/browser/test/profiling/UIProfiler.test.ts

@@ -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');
     });
 
@@ -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);
@@ -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 () => {