add baggage in envelope header integration test

Lms24 · Lms24 · commit 5bb03a9e752c · 2022-05-17T11:03:32.000+02:00
diff --git a/packages/core/src/envelope.ts b/packages/core/src/envelope.ts
@@ -119,11 +119,11 @@ export function createEventEnvelope(
   if (eventType === 'transaction') {
     const baggage = dropUndefinedKeys(
       createBaggage({
-        environment: event.environment && event.environment,
+        environment: event.environment,
         release: event.release,
         transaction: event.transaction,
         userid: event.user && event.user.id,
-        // TODO user.segment currently doesn't exist explicitly in interface User (just as a record key)
+        // user.segment currently doesn't exist explicitly in interface User (just as a record key)
         usersegment: event.user && event.user.segment,
       } as BaggageObj),
     );
diff --git a/packages/integration-tests/suites/tracing/baggage/init.js b/packages/integration-tests/suites/tracing/baggage/init.js
@@ -0,0 +1,14 @@
+import * as Sentry from '@sentry/browser';
+import { Integrations } from '@sentry/tracing';
+
+window.Sentry = Sentry;
+
+Sentry.init({
+  dsn: 'https://public@dsn.ingest.sentry.io/1337',
+  integrations: [new Integrations.BrowserTracing()],
+  release: '1.0.0',
+  environment: 'production',
+  tracesSampleRate: 1,
+});
+
+Sentry.configureScope(scope => scope.setUser({ id: 'user123', segment: 'segmentB' }));
diff --git a/packages/integration-tests/suites/tracing/baggage/subject.js b/packages/integration-tests/suites/tracing/baggage/subject.js
@@ -0,0 +1,4 @@
+document.getElementById('start-transaction').addEventListener('click', () => {
+  window.transaction = Sentry.startTransaction({ name: 'test-transaction' });
+  Sentry.getCurrentHub().configureScope(scope => scope.setSpan(window.transaction));
+});
diff --git a/packages/integration-tests/suites/tracing/baggage/template.html b/packages/integration-tests/suites/tracing/baggage/template.html
@@ -0,0 +1,8 @@
+<html>
+  <head>
+    <meta charset="utf-8" />
+  </head>
+  <body>
+    <button id="start-transaction">Start Transaction</button>
+  </body>
+</html>
diff --git a/packages/integration-tests/suites/tracing/baggage/test.ts b/packages/integration-tests/suites/tracing/baggage/test.ts
@@ -0,0 +1,21 @@
+import { expect } from '@playwright/test';
+import { EventEnvelopeHeaders } from '@sentry/types';
+
+import { sentryTest } from '../../../utils/fixtures';
+import { envelopeHeaderRequestParser, getFirstSentryEnvelopeRequest } from '../../../utils/helpers';
+
+sentryTest('should send baggage data in transaction envelope header', async ({ getLocalTestPath, page }) => {
+  const url = await getLocalTestPath({ testDir: __dirname });
+
+  const pageloadTransaction = await getFirstSentryEnvelopeRequest<Event>(page, url);
+  expect(pageloadTransaction).toBeDefined();
+
+  await page.click('#start-transaction');
+
+  const envHeader = await getFirstSentryEnvelopeRequest<EventEnvelopeHeaders>(page, url, envelopeHeaderRequestParser);
+
+  expect(envHeader.baggage).toBeDefined();
+  expect(envHeader.baggage).toEqual(
+    'sentry-environment=production,sentry-release=1.0.0,sentry-transaction=test-transaction,sentry-userid=user123,sentry-usersegment=segmentB',
+  );
+});
diff --git a/packages/integration-tests/utils/helpers.ts b/packages/integration-tests/utils/helpers.ts
@@ -1,5 +1,5 @@
 import { Page, Request } from '@playwright/test';
-import { Event } from '@sentry/types';
+import { Event, EventEnvelopeHeaders } from '@sentry/types';
 
 const envelopeUrlRegex = /\.sentry\.io\/api\/\d+\/envelope\//;
 
@@ -11,6 +11,14 @@ const envelopeRequestParser = (request: Request | null): Event => {
   return envelope.split('\n').map(line => JSON.parse(line))[2];
 };
 
+export const envelopeHeaderRequestParser = (request: Request | null): EventEnvelopeHeaders => {
+  // https://develop.sentry.dev/sdk/envelopes/
+  const envelope = request?.postData() || '';
+
+  // First row of the envelop is the event payload.
+  return envelope.split('\n').map(line => JSON.parse(line))[0];
+};
+
 /**
  * Run script at the given path inside the test environment.
  *
@@ -122,10 +130,11 @@ async function getMultipleSentryEnvelopeRequests<T>(
     url?: string;
     timeout?: number;
   },
+  requestParser: (req: Request) => T = envelopeRequestParser as (req: Request) => T,
 ): Promise<T[]> {
   // TODO: This is not currently checking the type of envelope, just casting for now.
   // We can update this to include optional type-guarding when we have types for Envelope.
-  return getMultipleRequests(page, count, envelopeUrlRegex, envelopeRequestParser, options) as Promise<T[]>;
+  return getMultipleRequests(page, count, envelopeUrlRegex, requestParser, options) as Promise<T[]>;
 }
 
 /**
@@ -136,8 +145,12 @@ async function getMultipleSentryEnvelopeRequests<T>(
  * @param {string} [url]
  * @return {*}  {Promise<T>}
  */
-async function getFirstSentryEnvelopeRequest<T>(page: Page, url?: string): Promise<T> {
-  return (await getMultipleSentryEnvelopeRequests<T>(page, 1, { url }))[0];
+async function getFirstSentryEnvelopeRequest<T>(
+  page: Page,
+  url?: string,
+  requestParser: (req: Request) => T = envelopeRequestParser as (req: Request) => T,
+): Promise<T> {
+  return (await getMultipleSentryEnvelopeRequests<T>(page, 1, { url }, requestParser))[0];
 }
 
 /**

-Original file line number
+Diff line change
@@ @@ -0,0 +1,8 @@ @@
 +<html>
 +  <head>
 +    <meta charset="utf-8" />
 +  </head>
 +  <body>
 +    <button id="start-transaction">Start Transaction</button>
 +  </body>
 +</html>