ref: Migrate transaction source from metadata to attributes (#10674)

Author: Luca Forstner

dev-packages/browser-integration-tests/suites/feedback/captureFeedback/test.ts

@@ -44,6 +44,7 @@ sentryTest('should capture feedback (@sentry-internal/feedback import)', async (
   const feedbackEvent = envelopeRequestParser((await feedbackRequestPromise).request());
   expect(feedbackEvent).toEqual({
     type: 'feedback',
+    breadcrumbs: expect.any(Array),
     contexts: {
       feedback: {
         contact_email: '[email protected]',

dev-packages/browser-integration-tests/suites/feedback/captureFeedbackAndReplay/test.ts

@@ -50,15 +50,16 @@ sentryTest('should capture feedback (@sentry-internal/feedback import)', async (
 
   expect(breadcrumbs).toEqual(
     expect.arrayContaining([
-      {
+      expect.objectContaining({
         category: 'sentry.feedback',
         data: { feedbackId: expect.any(String) },
-      },
+      }),
     ]),
   );
 
   expect(feedbackEvent).toEqual({
     type: 'feedback',
+    breadcrumbs: expect.any(Array),
     contexts: {
       feedback: {
         contact_email: '[email protected]',

dev-packages/browser-integration-tests/suites/tracing/envelope-header-transaction-name/init.js

@@ -1,4 +1,5 @@
 import * as Sentry from '@sentry/browser';
+import { SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '@sentry/browser';
 import { Integrations } from '@sentry/tracing';
 
 window.Sentry = Sentry;
@@ -17,4 +18,4 @@ scope.addEventProcessor(event => {
   event.transaction = 'testTransactionDSC';
   return event;
 });
-scope.getTransaction().setMetadata({ source: 'custom' });
+scope.getTransaction().setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, 'custom');

dev-packages/e2e-tests/test-applications/node-experimental-fastify-app/tests/propagation.test.ts

@@ -65,6 +65,7 @@ test('Propagates trace for outgoing http requests', async ({ baseURL }) => {
             'http.response.status_code': 200,
             'sentry.op': 'http.server',
             'sentry.origin': 'auto.http.otel.http',
+            'sentry.source': 'route',
           },
           op: 'http.server',
           span_id: expect.any(String),
@@ -89,6 +90,7 @@ test('Propagates trace for outgoing http requests', async ({ baseURL }) => {
             'http.response.status_code': 200,
             'sentry.op': 'http.server',
             'sentry.origin': 'auto.http.otel.http',
+            'sentry.source': 'route',
           },
           op: 'http.server',
           parent_span_id: outgoingHttpSpanId,
@@ -162,6 +164,7 @@ test('Propagates trace for outgoing fetch requests', async ({ baseURL }) => {
             'http.response.status_code': 200,
             'sentry.op': 'http.server',
             'sentry.origin': 'auto.http.otel.http',
+            'sentry.source': 'route',
           },
           op: 'http.server',
           span_id: expect.any(String),
@@ -186,6 +189,7 @@ test('Propagates trace for outgoing fetch requests', async ({ baseURL }) => {
             'http.response.status_code': 200,
             'sentry.op': 'http.server',
             'sentry.origin': 'auto.http.otel.http',
+            'sentry.source': 'route',
           },
           op: 'http.server',
           parent_span_id: outgoingHttpSpanId,

dev-packages/e2e-tests/test-applications/node-experimental-fastify-app/tests/transactions.test.ts

@@ -30,6 +30,7 @@ test('Sends an API route transaction', async ({ baseURL }) => {
             'http.response.status_code': 200,
             'sentry.op': 'http.server',
             'sentry.origin': 'auto.http.otel.http',
+            'sentry.source': 'route',
           },
           op: 'http.server',
           span_id: expect.any(String),

dev-packages/node-integration-tests/suites/express/multiple-routers/complex-router/server.ts

@@ -1,6 +1,5 @@
 import { loggingTransport, startExpressServerAndSendPortToRunner } from '@sentry-internal/node-integration-tests';
 import * as Sentry from '@sentry/node';
-import * as Tracing from '@sentry/tracing';
 import express from 'express';
 
 const app = express();
@@ -9,7 +8,7 @@ Sentry.init({
   dsn: 'https://[email protected]/1337',
   release: '1.0',
   // eslint-disable-next-line deprecation/deprecation
-  integrations: [new Sentry.Integrations.Http({ tracing: true }), new Tracing.Integrations.Express({ app })],
+  integrations: [new Sentry.Integrations.Http({ tracing: true }), new Sentry.Integrations.Express({ app })],
   tracesSampleRate: 1.0,
   transport: loggingTransport,
 });

packages/core/src/tracing/dynamicSamplingContext.ts

@@ -3,6 +3,7 @@ import { dropUndefinedKeys } from '@sentry/utils';
 
 import { DEFAULT_ENVIRONMENT } from '../constants';
 import { getClient } from '../currentScopes';
+import { SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '../semanticAttributes';
 import { getRootSpan } from '../utils/getRootSpan';
 import { spanIsSampled, spanToJSON } from '../utils/spanUtils';
 
@@ -66,14 +67,16 @@ export function getDynamicSamplingContextFromSpan(span: Span): Readonly<Partial<
   // TODO (v8): Replace txn.metadata with txn.attributes[]
   // We can't do this yet because attributes aren't always set yet.
   // eslint-disable-next-line deprecation/deprecation
-  const { sampleRate: maybeSampleRate, source } = txn.metadata;
+  const { sampleRate: maybeSampleRate } = txn.metadata;
   if (maybeSampleRate != null) {
     dsc.sample_rate = `${maybeSampleRate}`;
   }
 
   // We don't want to have a transaction name in the DSC if the source is "url" because URLs might contain PII
   const jsonSpan = spanToJSON(txn);
 
+  const source = (jsonSpan.data || {})[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE];
+
   // after JSON conversion, txn.name becomes jsonSpan.description
   if (source && source !== 'url') {
     dsc.transaction = jsonSpan.description;

packages/core/src/tracing/transaction.ts

@@ -10,6 +10,7 @@ import type {
   TransactionContext,
   TransactionEvent,
   TransactionMetadata,
+  TransactionSource,
 } from '@sentry/types';
 import { dropUndefinedKeys, logger } from '@sentry/utils';
 
@@ -68,6 +69,11 @@ export class Transaction extends SentrySpan implements TransactionInterface {
 
     this._trimEnd = transactionContext.trimEnd;
 
+    this._attributes = {
+      [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'custom',
+      ...this._attributes,
+    };
+
     // this is because transactions are also spans, and spans have a transaction pointer
     // TODO (v8): Replace this with another way to set the root span
     // eslint-disable-next-line deprecation/deprecation
@@ -110,17 +116,12 @@ export class Transaction extends SentrySpan implements TransactionInterface {
     // We merge attributes in for backwards compatibility
     return {
       // Defaults
-      // eslint-disable-next-line deprecation/deprecation
-      source: 'custom',
       spanMetadata: {},
 
       // Legacy metadata
       ...this._metadata,
 
       // From attributes
-      ...(this._attributes[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE] && {
-        source: this._attributes[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE] as TransactionMetadata['source'],
-      }),
       ...(this._attributes[SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE] && {
         sampleRate: this._attributes[SEMANTIC_ATTRIBUTE_SENTRY_SAMPLE_RATE] as TransactionMetadata['sampleRate'],
       }),
@@ -142,7 +143,7 @@ export class Transaction extends SentrySpan implements TransactionInterface {
    *
    * @deprecated Use `.updateName()` and `.setAttribute()` instead.
    */
-  public setName(name: string, source: TransactionMetadata['source'] = 'custom'): void {
+  public setName(name: string, source: TransactionSource = 'custom'): void {
     this._name = name;
     this.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, source);
   }
@@ -309,8 +310,8 @@ export class Transaction extends SentrySpan implements TransactionInterface {
 
     // eslint-disable-next-line deprecation/deprecation
     const { metadata } = this;
-    // eslint-disable-next-line deprecation/deprecation
-    const { source } = metadata;
+
+    const source = this._attributes['sentry.source'] as TransactionSource | undefined;
 
     const transaction: TransactionEvent = {
       contexts: {

packages/core/test/lib/tracing/dynamicSamplingContext.test.ts

@@ -75,7 +75,9 @@ describe('getDynamicSamplingContextFromSpan', () => {
       name: 'tx',
       metadata: {
         sampleRate: 0.56,
-        source: 'route',
+      },
+      attributes: {
+        [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'route',
       },
       sampled: true,
     });
@@ -98,9 +100,11 @@ describe('getDynamicSamplingContextFromSpan', () => {
       const transaction = new Transaction({
         name: 'tx',
         metadata: {
-          source: 'url',
           sampleRate: 0.56,
         },
+        attributes: {
+          [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url',
+        },
       });
 
       const dsc = getDynamicSamplingContextFromSpan(transaction);
@@ -110,11 +114,11 @@ describe('getDynamicSamplingContextFromSpan', () => {
     test.each([
       ['is included if transaction source is parameterized route/url', 'route'],
       ['is included if transaction source is a custom name', 'custom'],
-    ])('%s', (_: string, source) => {
+    ] as const)('%s', (_: string, source: TransactionSource) => {
       const transaction = startInactiveSpan({
         name: 'tx',
-        metadata: {
-          ...(source && { source: source as TransactionSource }),
+        attributes: {
+          [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: source,
         },
       });
 

packages/core/test/lib/tracing/trace.test.ts

@@ -266,6 +266,7 @@ describe('startSpan', () => {
         data: {
           'sentry.origin': 'auto.http.browser',
           'sentry.sample_rate': 0,
+          'sentry.source': 'custom',
         },
         origin: 'auto.http.browser',
         description: 'GET users/[id]',