ref: Remove deprecated properties from startSpan options

mydea · mydea · commit 0a5ed80aa4ed · 2024-03-12T14:51:04.000Z
So the public API for this is now fully aligned!
diff --git a/packages/core/test/lib/tracing/trace.test.ts b/packages/core/test/lib/tracing/trace.test.ts
@@ -9,7 +9,6 @@ import {
   getMainCarrier,
   setAsyncContextStrategy,
   setCurrentClient,
-  spanIsSampled,
   spanToJSON,
   withScope,
 } from '../../../src';
@@ -100,33 +99,6 @@ describe('startSpan', () => {
       expect(spanToJSON(_span!).status).toEqual(isError ? 'internal_error' : undefined);
     });
 
-    it('allows traceparent information to be overriden', async () => {
-      let _span: Span | undefined = undefined;
-      client.on('spanEnd', span => {
-        _span = span;
-      });
-      try {
-        await startSpan(
-          {
-            name: 'GET users/[id]',
-            parentSampled: true,
-            traceId: '12345678901234567890123456789012',
-            parentSpanId: '1234567890123456',
-          },
-          () => {
-            return callback();
-          },
-        );
-      } catch (e) {
-        //
-      }
-      expect(_span).toBeDefined();
-
-      expect(spanIsSampled(_span!)).toEqual(true);
-      expect(spanToJSON(_span!).trace_id).toEqual('12345678901234567890123456789012');
-      expect(spanToJSON(_span!).parent_span_id).toEqual('1234567890123456');
-    });
-
     it('allows for transaction to be mutated', async () => {
       let _span: Span | undefined = undefined;
       client.on('spanEnd', span => {
@@ -152,7 +124,7 @@ describe('startSpan', () => {
         }
       });
       try {
-        await startSpan({ name: 'GET users/[id]', parentSampled: true }, () => {
+        await startSpan({ name: 'GET users/[id]' }, () => {
           return startSpan({ name: 'SELECT * from users' }, () => {
             return callback();
           });
@@ -178,7 +150,7 @@ describe('startSpan', () => {
         }
       });
       try {
-        await startSpan({ name: 'GET users/[id]', parentSampled: true }, () => {
+        await startSpan({ name: 'GET users/[id]' }, () => {
           return startSpan({ name: 'SELECT * from users' }, childSpan => {
             if (childSpan) {
               childSpan.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_OP, 'db.query');
@@ -451,12 +423,9 @@ describe('startSpan', () => {
     setCurrentClient(client);
     client.init();
 
-    startSpan(
-      { name: 'outer', attributes: { test1: 'aa', test2: 'aa' }, data: { test1: 'bb', test3: 'bb' } },
-      outerSpan => {
-        expect(outerSpan).toBeDefined();
-      },
-    );
+    startSpan({ name: 'outer', attributes: { test1: 'aa', test2: 'aa', test3: 'bb' } }, outerSpan => {
+      expect(outerSpan).toBeDefined();
+    });
 
     expect(tracesSampler).toBeCalledTimes(1);
     expect(tracesSampler).toHaveBeenLastCalledWith({
diff --git a/packages/nextjs/src/common/utils/edgeWrapperUtils.ts b/packages/nextjs/src/common/utils/edgeWrapperUtils.ts
@@ -5,6 +5,7 @@ import {
   addTracingExtensions,
   captureException,
   continueTrace,
+  getIsolationScope,
   handleCallbackErrors,
   setHttpStatus,
   startSpan,
@@ -39,6 +40,9 @@ export function withEdgeWrapping<H extends EdgeRouteHandler>(
         baggage,
       },
       () => {
+        getIsolationScope().setSDKProcessingMetadata({
+          request: req instanceof Request ? winterCGRequestToRequestData(req) : undefined,
+        });
         return startSpan(
           {
             name: options.spanDescription,
@@ -47,9 +51,6 @@ export function withEdgeWrapping<H extends EdgeRouteHandler>(
               [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'route',
               [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.function.nextjs.withEdgeWrapping',
             },
-            metadata: {
-              request: req instanceof Request ? winterCGRequestToRequestData(req) : undefined,
-            },
           },
           async span => {
             const handlerResult = await handleCallbackErrors(
diff --git a/packages/nextjs/src/common/wrapApiHandlerWithSentry.ts b/packages/nextjs/src/common/wrapApiHandlerWithSentry.ts
@@ -91,9 +91,6 @@ export function wrapApiHandlerWithSentry(apiHandler: NextApiHandler, parameteriz
                   [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'route',
                   [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.nextjs',
                 },
-                metadata: {
-                  request: req,
-                },
               },
               async span => {
                 // eslint-disable-next-line @typescript-eslint/unbound-method
diff --git a/packages/nextjs/src/common/wrapGenerationFunctionWithSentry.ts b/packages/nextjs/src/common/wrapGenerationFunctionWithSentry.ts
@@ -68,7 +68,6 @@ export function wrapGenerationFunctionWithSentry<F extends (...args: any[]) => a
           {
             op: 'function.nextjs',
             name: `${componentType}.${generationFunctionIdentifier} (${componentRoute})`,
-            data,
             attributes: {
               [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'route',
               [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.function.nextjs',
diff --git a/packages/nextjs/test/config/withSentry.test.ts b/packages/nextjs/test/config/withSentry.test.ts
@@ -47,12 +47,13 @@ describe('withSentry', () => {
             [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'route',
             [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.nextjs',
           },
-          metadata: {
-            request: expect.objectContaining({ url: 'http://dogs.are.great' }),
-          },
         },
         expect.any(Function),
       );
+
+      expect(SentryCore.getIsolationScope().getScopeData().sdkProcessingMetadata).toEqual({
+        request: expect.objectContaining({ url: 'http://dogs.are.great' }),
+      });
     });
   });
 });
diff --git a/packages/nextjs/test/edge/edgeWrapperUtils.test.ts b/packages/nextjs/test/edge/edgeWrapperUtils.test.ts
@@ -82,9 +82,6 @@ describe('withEdgeWrapping', () => {
     expect(startSpanSpy).toHaveBeenCalledTimes(1);
     expect(startSpanSpy).toHaveBeenCalledWith(
       expect.objectContaining({
-        metadata: {
-          request: { headers: {} },
-        },
         attributes: {
           [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'route',
           [coreSdk.SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.function.nextjs.withEdgeWrapping',
@@ -94,6 +91,10 @@ describe('withEdgeWrapping', () => {
       }),
       expect.any(Function),
     );
+
+    expect(coreSdk.getIsolationScope().getScopeData().sdkProcessingMetadata).toEqual({
+      request: { headers: {} },
+    });
   });
 
   it("should return a function that doesn't crash when req isn't passed", async () => {
diff --git a/packages/nextjs/test/edge/withSentryAPI.test.ts b/packages/nextjs/test/edge/withSentryAPI.test.ts
@@ -53,9 +53,6 @@ describe('wrapApiHandlerWithSentry', () => {
     expect(startSpanSpy).toHaveBeenCalledTimes(1);
     expect(startSpanSpy).toHaveBeenCalledWith(
       expect.objectContaining({
-        metadata: {
-          request: { headers: {}, method: 'POST', url: 'https://sentry.io/' },
-        },
         attributes: {
           [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'route',
           [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.function.nextjs.withEdgeWrapping',
@@ -65,6 +62,10 @@ describe('wrapApiHandlerWithSentry', () => {
       }),
       expect.any(Function),
     );
+
+    expect(coreSdk.getIsolationScope().getScopeData().sdkProcessingMetadata).toEqual({
+      request: { headers: {}, method: 'POST', url: 'https://sentry.io/' },
+    });
   });
 
   it('should return a function that calls trace without throwing when no request is passed', async () => {
@@ -77,7 +78,6 @@ describe('wrapApiHandlerWithSentry', () => {
     expect(startSpanSpy).toHaveBeenCalledTimes(1);
     expect(startSpanSpy).toHaveBeenCalledWith(
       expect.objectContaining({
-        metadata: {},
         attributes: {
           [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'route',
           [coreSdk.SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.function.nextjs.withEdgeWrapping',
@@ -87,5 +87,7 @@ describe('wrapApiHandlerWithSentry', () => {
       }),
       expect.any(Function),
     );
+
+    expect(coreSdk.getIsolationScope().getScopeData().sdkProcessingMetadata).toEqual({});
   });
 });
diff --git a/packages/node-experimental/test/integration/transactions.test.ts b/packages/node-experimental/test/integration/transactions.test.ts
@@ -179,26 +179,36 @@ describe('Integration | Transactions', () => {
     Sentry.addBreadcrumb({ message: 'test breadcrumb 1', timestamp: 123456 });
 
     Sentry.withIsolationScope(() => {
-      Sentry.startSpan({ op: 'test op', name: 'test name', source: 'task', origin: 'auto.test' }, span => {
-        Sentry.addBreadcrumb({ message: 'test breadcrumb 2', timestamp: 123456 });
+      Sentry.startSpan(
+        {
+          op: 'test op',
+          name: 'test name',
+          origin: 'auto.test',
+          attributes: {
+            [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'task',
+          },
+        },
+        span => {
+          Sentry.addBreadcrumb({ message: 'test breadcrumb 2', timestamp: 123456 });
 
-        span.setAttributes({
-          'test.outer': 'test value',
-        });
+          span.setAttributes({
+            'test.outer': 'test value',
+          });
 
-        const subSpan = Sentry.startInactiveSpan({ name: 'inner span 1' });
-        subSpan.end();
+          const subSpan = Sentry.startInactiveSpan({ name: 'inner span 1' });
+          subSpan.end();
 
-        Sentry.setTag('test.tag', 'test value');
+          Sentry.setTag('test.tag', 'test value');
 
-        Sentry.startSpan({ name: 'inner span 2' }, innerSpan => {
-          Sentry.addBreadcrumb({ message: 'test breadcrumb 3', timestamp: 123456 });
+          Sentry.startSpan({ name: 'inner span 2' }, innerSpan => {
+            Sentry.addBreadcrumb({ message: 'test breadcrumb 3', timestamp: 123456 });
 
-          innerSpan.setAttributes({
-            'test.inner': 'test value',
+            innerSpan.setAttributes({
+              'test.inner': 'test value',
+            });
           });
-        });
-      });
+        },
+      );
     });
 
     Sentry.withIsolationScope(() => {
diff --git a/packages/node/src/handlers.ts b/packages/node/src/handlers.ts
@@ -73,13 +73,6 @@ export function tracingHandler(): (
         attributes: {
           [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: source,
         },
-        metadata: {
-          // The request should already have been stored in `scope.sdkProcessingMetadata` (which will become
-          // `event.sdkProcessingMetadata` the same way the metadata here will) by `sentryRequestMiddleware`, but on the
-          // off chance someone is using `sentryTracingMiddleware` without `sentryRequestMiddleware`, it doesn't hurt to
-          // be sure
-          request: req,
-        },
       }) as Transaction;
     });
 
diff --git a/packages/node/test/handlers.test.ts b/packages/node/test/handlers.test.ts
@@ -1,7 +1,6 @@
 import * as http from 'http';
 import * as sentryCore from '@sentry/core';
 import {
-  Hub,
   SEMANTIC_ATTRIBUTE_SENTRY_OP,
   Transaction,
   getClient,
@@ -469,24 +468,6 @@ describe('tracingHandler', () => {
       done();
     });
   });
-
-  it('stores request in transaction metadata', () => {
-    const options = getDefaultNodeClientOptions({ tracesSampleRate: 1.0 });
-    // eslint-disable-next-line deprecation/deprecation
-    const hub = new Hub(new NodeClient(options));
-
-    jest.spyOn(sentryCore, 'getCurrentHub').mockReturnValue(hub);
-    // eslint-disable-next-line deprecation/deprecation
-    jest.spyOn(sentryCore, 'getCurrentScope').mockImplementation(() => hub.getScope());
-
-    sentryTracingMiddleware(req, res, next);
-
-    // eslint-disable-next-line deprecation/deprecation
-    const transaction = getCurrentScope().getTransaction();
-
-    // eslint-disable-next-line deprecation/deprecation
-    expect(transaction?.metadata.request).toEqual(req);
-  });
 });
 
 describe('errorHandler()', () => {
diff --git a/packages/opentelemetry/src/trace.ts b/packages/opentelemetry/src/trace.ts
@@ -7,7 +7,6 @@ import {
   SDK_VERSION,
   SEMANTIC_ATTRIBUTE_SENTRY_OP,
   SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
-  SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
   getClient,
   getCurrentScope,
   getRootSpan,
@@ -143,7 +142,7 @@ function getTracer(): Tracer {
 
 function _applySentryAttributesToSpan(span: Span, options: OpenTelemetrySpanContext): void {
   // eslint-disable-next-line deprecation/deprecation
-  const { origin, op, source } = options;
+  const { origin, op } = options;
 
   if (origin) {
     span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, origin);
@@ -152,10 +151,6 @@ function _applySentryAttributesToSpan(span: Span, options: OpenTelemetrySpanCont
   if (op) {
     span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_OP, op);
   }
-
-  if (source) {
-    span.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, source);
-  }
 }
 
 function getSpanContext(options: OpenTelemetrySpanContext): SpanOptions {
diff --git a/packages/opentelemetry/test/integration/transactions.test.ts b/packages/opentelemetry/test/integration/transactions.test.ts
diff --git a/packages/opentelemetry/test/trace.test.ts b/packages/opentelemetry/test/trace.test.ts
diff --git a/packages/tracing-internal/src/browser/browserTracingIntegration.ts b/packages/tracing-internal/src/browser/browserTracingIntegration.ts
diff --git a/packages/tracing-internal/src/browser/metrics/index.ts b/packages/tracing-internal/src/browser/metrics/index.ts
diff --git a/packages/types/src/startSpanOptions.ts b/packages/types/src/startSpanOptions.ts

Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,6 @@ export function wrapGenerationFunctionWithSentry<F extends (...args: any[]) => a`
`68`	`68`	`{`
`69`	`69`	`op: 'function.nextjs',`
`70`	`70`	name: `${componentType}.${generationFunctionIdentifier} (${componentRoute})`,
`71`		`- data,`
`72`	`71`	`attributes: {`
`73`	`72`	`[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'route',`
`74`	`73`	`[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.function.nextjs',`