adjust trace context structure

Author: AbhiPrasad

packages/core/src/envelope.ts

@@ -11,14 +11,7 @@ import {
   SessionEnvelope,
   SessionItem,
 } from '@sentry/types';
-import {
-  createBaggage,
-  createEnvelope,
-  dropUndefinedKeys,
-  dsnToString,
-  getSentryBaggageItems,
-  isBaggageEmpty,
-} from '@sentry/utils';
+import { createEnvelope, dropUndefinedKeys, dsnToString } from '@sentry/utils';
 
 /** Extract sdk info from from the API metadata */
 function getSdkMetadataForEnvelopeHeader(metadata?: SdkMetadata): SdkInfo | undefined {
@@ -127,24 +120,28 @@ function createEventEnvelopeHeaders(
   tunnel: string | undefined,
   dsn: DsnComponents,
 ): EventEnvelopeHeaders {
-  const baggage =
-    event.type === 'transaction' &&
-    createBaggage(
-      dropUndefinedKeys({
-        environment: event.environment,
-        release: event.release,
-        transaction: event.transaction,
-        userid: event.user && event.user.id,
-        // user.segment currently doesn't exist explicitly in interface User (just as a record key)
-        usersegment: event.user && event.user.segment,
-      }),
-    );
-
   return {
     event_id: event.event_id as string,
     sent_at: new Date().toISOString(),
     ...(sdkInfo && { sdk: sdkInfo }),
     ...(!!tunnel && { dsn: dsnToString(dsn) }),
-    ...(baggage && !isBaggageEmpty(baggage) && { trace: getSentryBaggageItems(baggage) }),
+    ...(event.type === 'transaction' && {
+      // TODO: Grab this from baggage
+      trace: dropUndefinedKeys({
+        // Trace context must be defined for transactions
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        trace_id: event.contexts!.trace.trace_id,
+        environment: event.environment,
+        release: event.release,
+        transaction: event.transaction,
+        user:
+          event.user &&
+          dropUndefinedKeys({
+            id: event.user.id,
+            segment: event.user.segment,
+          }),
+        public_key: dsn.publicKey,
+      }),
+    }),
   };
 }

packages/integration-tests/suites/tracing/baggage/test.ts

@@ -4,7 +4,7 @@ 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 }) => {
+sentryTest('should send trace context data in transaction envelope header', async ({ getLocalTestPath, page }) => {
   const url = await getLocalTestPath({ testDir: __dirname });
 
   const envHeader = await getFirstSentryEnvelopeRequest<EventEnvelopeHeaders>(page, url, envelopeHeaderRequestParser);
@@ -13,7 +13,9 @@ sentryTest('should send baggage data in transaction envelope header', async ({ g
   expect(envHeader.trace).toEqual({
     environment: 'production',
     transaction: 'testTransactionBaggage',
-    userid: 'user123',
-    usersegment: 'segmentB',
+    user: {
+      id: 'user123',
+      segment: 'segmentB',
+    },
   });
 });

packages/types/src/baggage.ts

@@ -0,0 +1,17 @@
+export type AllowedBaggageKeys = 'environment' | 'release' | 'userid' | 'transaction' | 'usersegment';
+export type BaggageObj = Partial<Record<AllowedBaggageKeys, string> & Record<string, string>>;
+
+/**
+ * The baggage data structure represents key,value pairs based on the baggage
+ * spec: https://www.w3.org/TR/baggage
+ *
+ * It is expected that users interact with baggage using the helpers methods:
+ * `createBaggage`, `getBaggageValue`, and `setBaggageValue`.
+ *
+ * Internally, the baggage data structure is a tuple of length 2, separating baggage values
+ * based on if they are related to Sentry or not. If the baggage values are
+ * set/used by sentry, they will be stored in an object to be easily accessed.
+ * If they are not, they are kept as a string to be only accessed when serialized
+ * at baggage propagation time.
+ */
+export type Baggage = [BaggageObj, string];

packages/types/src/envelope.ts

@@ -1,12 +1,26 @@
 import { ClientReport } from './clientreport';
+import { DsnComponents } from './dsn';
 import { Event } from './event';
 import { SdkInfo } from './sdkinfo';
 import { Session, SessionAggregates } from './session';
-import { TransactionSamplingMethod } from './transaction';
+import { Transaction, TransactionSamplingMethod } from './transaction';
 import { UserFeedback } from './user';
 
 // Based on: https://develop.sentry.dev/sdk/envelopes/
 
+// Based on https://github.com/getsentry/relay/blob/b23b8d3b2360a54aaa4d19ecae0231201f31df5e/relay-sampling/src/lib.rs#L685-L707
+export type EventTraceContext = {
+  trace_id: Transaction['traceId'];
+  public_key?: DsnComponents['publicKey'];
+  release?: string;
+  user?: {
+    id?: string;
+    segment?: string;
+  };
+  environment?: string;
+  transaction?: string;
+};
+
 export type EnvelopeItemType =
   | 'client_report'
   | 'user_report'
@@ -59,7 +73,7 @@ export type SessionItem =
   | BaseEnvelopeItem<SessionAggregatesItemHeaders, SessionAggregates>;
 export type ClientReportItem = BaseEnvelopeItem<ClientReportItemHeaders, ClientReport>;
 
-export type EventEnvelopeHeaders = { event_id: string; sent_at: string; trace?: Record<string, unknown> };
+export type EventEnvelopeHeaders = { event_id: string; sent_at: string; trace?: EventTraceContext };
 type SessionEnvelopeHeaders = { sent_at: string };
 type ClientReportEnvelopeHeaders = BaseEnvelopeHeaders;
 

packages/types/src/index.ts

@@ -1,4 +1,5 @@
 export type { Attachment } from './attachment';
+export type { AllowedBaggageKeys, Baggage, BaggageObj } from './baggage';
 export type { Breadcrumb, BreadcrumbHint } from './breadcrumb';
 export type { Client } from './client';
 export type { ClientReport, Outcome, EventDropReason } from './clientreport';

packages/types/src/user.ts

@@ -5,6 +5,7 @@ export interface User {
   ip_address?: string;
   email?: string;
   username?: string;
+  segment?: string;
 }
 
 export interface UserFeedback {

packages/utils/src/baggage.ts

@@ -1,24 +1,8 @@
+import { Baggage, BaggageObj } from '@sentry/types';
+
 import { IS_DEBUG_BUILD } from './flags';
 import { logger } from './logger';
 
-export type AllowedBaggageKeys = 'environment' | 'release' | 'userid' | 'transaction' | 'usersegment';
-export type BaggageObj = Partial<Record<AllowedBaggageKeys, string> & Record<string, string>>;
-
-/**
- * The baggage data structure represents key,value pairs based on the baggage
- * spec: https://www.w3.org/TR/baggage
- *
- * It is expected that users interact with baggage using the helpers methods:
- * `createBaggage`, `getBaggageValue`, and `setBaggageValue`.
- *
- * Internally, the baggage data structure is a tuple of length 2, separating baggage values
- * based on if they are related to Sentry or not. If the baggage values are
- * set/used by sentry, they will be stored in an object to be easily accessed.
- * If they are not, they are kept as a string to be only accessed when serialized
- * at baggage propagation time.
- */
-export type Baggage = [BaggageObj, string];
-
 export const BAGGAGE_HEADER_NAME = 'baggage';
 
 export const SENTRY_BAGGAGE_KEY_PREFIX = 'sentry-';