feat(core): Deprecate span.startChild() (#10091)

mydea · web-flow · commit 548d455738c4 · 2024-01-08T11:56:29.000+01:00
We still have quite a lot of these ourselves, but we can refactor them
over time during the v8 preparation.

But with this, I think we have the most important deprecations mostly
done!
diff --git a/MIGRATION.md b/MIGRATION.md
@@ -8,9 +8,9 @@ npx @sentry/migr8@latest
 
 This will let you select which updates to run, and automatically update your code. Make sure to still review all code changes!
 
-## Deprecate `startTransaction()`
+## Deprecate `startTransaction()` & `span.startChild()`
 
-In v8, the old performance API `startTransaction()` (as well as `hub.startTransaction()`) will be removed.
+In v8, the old performance API `startTransaction()` (and `hub.startTransaction()`), as well as `span.startChild()`, will be removed.
 Instead, use the new performance APIs:
 
 * `startSpan()`
diff --git a/dev-packages/e2e-tests/test-applications/create-next-app/pages/api/success.ts b/dev-packages/e2e-tests/test-applications/create-next-app/pages/api/success.ts
@@ -7,6 +7,7 @@ export default function handler(req: NextApiRequest, res: NextApiResponse) {
   const transaction = Sentry.startTransaction({ name: 'test-transaction', op: 'e2e-test' });
   Sentry.getCurrentHub().getScope().setSpan(transaction);
 
+  // eslint-disable-next-line deprecation/deprecation
   const span = transaction.startChild();
 
   span.end();
diff --git a/dev-packages/e2e-tests/test-applications/node-express-app/src/app.ts b/dev-packages/e2e-tests/test-applications/node-express-app/src/app.ts
@@ -38,6 +38,7 @@ app.get('/test-transaction', async function (req, res) {
   const transaction = Sentry.startTransaction({ name: 'test-transaction', op: 'e2e-test' });
   Sentry.getCurrentScope().setSpan(transaction);
 
+  // eslint-disable-next-line deprecation/deprecation
   const span = transaction.startChild();
 
   span.end();
diff --git a/dev-packages/node-integration-tests/suites/public-api/startTransaction/with-nested-spans/scenario.ts b/dev-packages/node-integration-tests/suites/public-api/startTransaction/with-nested-spans/scenario.ts
@@ -10,6 +10,7 @@ Sentry.init({
 
 // eslint-disable-next-line deprecation/deprecation
 const transaction = Sentry.startTransaction({ name: 'test_transaction_1' });
+// eslint-disable-next-line deprecation/deprecation
 const span_1 = transaction.startChild({
   op: 'span_1',
   data: {
@@ -23,16 +24,20 @@ for (let i = 0; i < 2000; i++);
 span_1.end();
 
 // span_2 doesn't finish
+// eslint-disable-next-line deprecation/deprecation
 transaction.startChild({ op: 'span_2' });
 for (let i = 0; i < 4000; i++);
 
+// eslint-disable-next-line deprecation/deprecation
 const span_3 = transaction.startChild({ op: 'span_3' });
 for (let i = 0; i < 4000; i++);
 
 // span_4 is the child of span_3 but doesn't finish.
+// eslint-disable-next-line deprecation/deprecation
 span_3.startChild({ op: 'span_4', data: { qux: 'quux' } });
 
 // span_5 is another child of span_3 but finishes.
+// eslint-disable-next-line deprecation/deprecation
 span_3.startChild({ op: 'span_5' }).end();
 
 // span_3 also finishes
diff --git a/packages/angular/src/tracing.ts b/packages/angular/src/tracing.ts
@@ -84,6 +84,7 @@ export class TraceService implements OnDestroy {
         if (this._routingSpan) {
           this._routingSpan.end();
         }
+        // eslint-disable-next-line deprecation/deprecation
         this._routingSpan = activeTransaction.startChild({
           description: `${navigationEvent.url}`,
           op: ANGULAR_ROUTING_OP,
@@ -183,6 +184,7 @@ export class TraceDirective implements OnInit, AfterViewInit {
 
     const activeTransaction = getActiveTransaction();
     if (activeTransaction) {
+      // eslint-disable-next-line deprecation/deprecation
       this._tracingSpan = activeTransaction.startChild({
         description: `<${this.componentName}>`,
         op: ANGULAR_INIT_OP,
@@ -225,6 +227,7 @@ export function TraceClassDecorator(): ClassDecorator {
     target.prototype.ngOnInit = function (...args: any[]): ReturnType<typeof originalOnInit> {
       const activeTransaction = getActiveTransaction();
       if (activeTransaction) {
+        // eslint-disable-next-line deprecation/deprecation
         tracingSpan = activeTransaction.startChild({
           description: `<${target.name}>`,
           op: ANGULAR_INIT_OP,
@@ -262,6 +265,7 @@ export function TraceMethodDecorator(): MethodDecorator {
       const now = timestampInSeconds();
       const activeTransaction = getActiveTransaction();
       if (activeTransaction) {
+        // eslint-disable-next-line deprecation/deprecation
         activeTransaction.startChild({
           description: `<${target.constructor.name}>`,
           endTimestamp: now,
diff --git a/packages/core/src/tracing/span.ts b/packages/core/src/tracing/span.ts
@@ -187,7 +187,10 @@ export class Span implements SpanInterface {
   }
 
   /**
-   * @inheritDoc
+   * Creates a new `Span` while setting the current `Span.id` as `parentSpanId`.
+   * Also the `sampled` decision will be inherited.
+   *
+   * @deprecated Use `startSpan()`, `startSpanManual()` or `startInactiveSpan()` instead.
    */
   public startChild(
     spanContext?: Pick<SpanContext, Exclude<keyof SpanContext, 'sampled' | 'traceId' | 'parentSpanId'>>,
diff --git a/packages/core/src/tracing/trace.ts b/packages/core/src/tracing/trace.ts
@@ -158,7 +158,8 @@ export function startInactiveSpan(context: StartSpanOptions): Span | undefined {
   const hub = getCurrentHub();
   const parentSpan = getActiveSpan();
   return parentSpan
-    ? parentSpan.startChild(ctx)
+    ? // eslint-disable-next-line deprecation/deprecation
+      parentSpan.startChild(ctx)
     : // eslint-disable-next-line deprecation/deprecation
       hub.startTransaction(ctx);
 }
@@ -240,7 +241,8 @@ function createChildSpanOrTransaction(
     return undefined;
   }
   return parentSpan
-    ? parentSpan.startChild(ctx)
+    ? // eslint-disable-next-line deprecation/deprecation
+      parentSpan.startChild(ctx)
     : // eslint-disable-next-line deprecation/deprecation
       hub.startTransaction(ctx);
 }
diff --git a/packages/ember/addon/index.ts b/packages/ember/addon/index.ts
@@ -88,6 +88,7 @@ export const instrumentRoutePerformance = <T extends RouteConstructor>(BaseRoute
       return result;
     }
     currentTransaction
+      // eslint-disable-next-line deprecation/deprecation
       .startChild({
         op,
         description,
diff --git a/packages/ember/addon/instance-initializers/sentry-performance.ts b/packages/ember/addon/instance-initializers/sentry-performance.ts
@@ -149,6 +149,7 @@ export function _instrumentEmberRouter(
         'routing.instrumentation': '@sentry/ember',
       },
     });
+    // eslint-disable-next-line deprecation/deprecation
     transitionSpan = activeTransaction?.startChild({
       op: 'ui.ember.transition',
       description: `route:${fromRoute} -> route:${toRoute}`,
@@ -212,6 +213,7 @@ function _instrumentEmberRunloop(config: EmberSentryConfig): void {
 
         if ((now - currentQueueStart) * 1000 >= minQueueDuration) {
           activeTransaction
+            // eslint-disable-next-line deprecation/deprecation
             ?.startChild({
               op: `ui.ember.runloop.${queue}`,
               origin: 'auto.ui.ember',
@@ -287,7 +289,7 @@ function processComponentRenderAfter(
 
   if (componentRenderDuration * 1000 >= minComponentDuration) {
     const activeTransaction = getActiveTransaction();
-
+    // eslint-disable-next-line deprecation/deprecation
     activeTransaction?.startChild({
       op,
       description: payload.containerKey || payload.object,
@@ -373,6 +375,7 @@ function _instrumentInitialLoad(config: EmberSentryConfig): void {
   const endTimestamp = startTimestamp + measure.duration / 1000;
 
   const transaction = getActiveTransaction();
+  // eslint-disable-next-line deprecation/deprecation
   const span = transaction?.startChild({
     op: 'ui.ember.init',
     origin: 'auto.ui.ember',
diff --git a/packages/nextjs/src/client/routing/pagesRouterRoutingInstrumentation.ts b/packages/nextjs/src/client/routing/pagesRouterRoutingInstrumentation.ts
@@ -186,6 +186,7 @@ export function pagesRouterInstrumentation(
         // We don't want to finish the navigation transaction on `routeChangeComplete`, since users might want to attach
         // spans to that transaction even after `routeChangeComplete` is fired (eg. HTTP requests in some useEffect
         // hooks). Instead, we'll simply let the navigation transaction finish itself (it's an `IdleTransaction`).
+        // eslint-disable-next-line deprecation/deprecation
         const nextRouteChangeSpan = navigationTransaction.startChild({
           op: 'ui.nextjs.route-change',
           origin: 'auto.ui.nextjs.pages_router_instrumentation',
diff --git a/packages/nextjs/src/common/utils/wrapperUtils.ts b/packages/nextjs/src/common/utils/wrapperUtils.ts
@@ -131,6 +131,7 @@ export function withTracedServerSideDataFetcher<F extends (...args: any[]) => Pr
           spanToContinue = previousSpan;
         }
 
+        // eslint-disable-next-line deprecation/deprecation
         dataFetcherSpan = spanToContinue.startChild({
           op: 'function.nextjs',
           description: `${options.dataFetchingMethodName} (${options.dataFetcherRouteName})`,
@@ -209,6 +210,7 @@ export async function callDataFetcherTraced<F extends (...args: any[]) => Promis
 
   // Capture the route, since pre-loading, revalidation, etc might mean that this span may happen during another
   // route's transaction
+  // eslint-disable-next-line deprecation/deprecation
   const span = transaction.startChild({
     op: 'function.nextjs',
     origin: 'auto.function.nextjs',
diff --git a/packages/node/src/integrations/http.ts b/packages/node/src/integrations/http.ts
@@ -251,7 +251,8 @@ function _createWrappedRequestMethodFactory(
       const data = getRequestSpanData(requestUrl, requestOptions);
 
       const requestSpan = shouldCreateSpan(rawRequestUrl)
-        ? parentSpan?.startChild({
+        ? // eslint-disable-next-line deprecation/deprecation
+          parentSpan?.startChild({
             op: 'http.client',
             origin: 'auto.http.node.http',
             description: `${data['http.method']} ${data.url}`,
diff --git a/packages/node/src/integrations/undici/index.ts b/packages/node/src/integrations/undici/index.ts
@@ -310,6 +310,7 @@ function createRequestSpan(
   if (url.hash) {
     data['http.fragment'] = url.hash;
   }
+  // eslint-disable-next-line deprecation/deprecation
   return activeSpan?.startChild({
     op: 'http.client',
     origin: 'auto.http.node.undici',
diff --git a/packages/node/test/handlers.test.ts b/packages/node/test/handlers.test.ts
@@ -424,6 +424,7 @@ describe('tracingHandler', () => {
   it('waits to finish transaction until all spans are finished, even though `transaction.end()` is registered on `res.finish` event first', done => {
     const transaction = new Transaction({ name: 'mockTransaction', sampled: true });
     transaction.initSpanRecorder();
+    // eslint-disable-next-line deprecation/deprecation
     const span = transaction.startChild({
       description: 'reallyCoolHandler',
       op: 'middleware',
diff --git a/packages/opentelemetry-node/src/spanprocessor.ts b/packages/opentelemetry-node/src/spanprocessor.ts
@@ -56,6 +56,7 @@ export class SentrySpanProcessor implements OtelSpanProcessor {
     const sentryParentSpan = otelParentSpanId && getSentrySpan(otelParentSpanId);
 
     if (sentryParentSpan) {
+      // eslint-disable-next-line deprecation/deprecation
       const sentryChildSpan = sentryParentSpan.startChild({
         description: otelSpan.name,
         instrumenter: 'otel',
diff --git a/packages/opentelemetry-node/test/propagator.test.ts b/packages/opentelemetry-node/test/propagator.test.ts
@@ -65,6 +65,7 @@ describe('SentryPropagator', () => {
         if (type === PerfType.Span) {
           // eslint-disable-next-line @typescript-eslint/no-unused-vars
           const { spanId, ...ctx } = transactionContext;
+          // eslint-disable-next-line deprecation/deprecation
           const span = transaction.startChild({ ...ctx, description: transaction.name });
           setSentrySpan(span.spanId, span);
         }
diff --git a/packages/opentelemetry/src/spanExporter.ts b/packages/opentelemetry/src/spanExporter.ts
@@ -204,6 +204,7 @@ function createAndFinishSpanForOtelSpan(node: SpanNode, sentryParentSpan: Sentry
   const { op, description, tags, data, origin } = getSpanData(span);
   const allData = { ...removeSentryAttributes(attributes), ...data };
 
+  // eslint-disable-next-line deprecation/deprecation
   const sentrySpan = sentryParentSpan.startChild({
     description,
     op,
diff --git a/packages/react/src/profiler.tsx b/packages/react/src/profiler.tsx
@@ -59,6 +59,7 @@ class Profiler extends React.Component<ProfilerProps> {
 
     const activeTransaction = getActiveTransaction();
     if (activeTransaction) {
+      // eslint-disable-next-line deprecation/deprecation
       this._mountSpan = activeTransaction.startChild({
         description: `<${name}>`,
         op: REACT_MOUNT_OP,
@@ -85,6 +86,7 @@ class Profiler extends React.Component<ProfilerProps> {
       const changedProps = Object.keys(updateProps).filter(k => updateProps[k] !== this.props.updateProps[k]);
       if (changedProps.length > 0) {
         const now = timestampInSeconds();
+        // eslint-disable-next-line deprecation/deprecation
         this._updateSpan = this._mountSpan.startChild({
           data: {
             changedProps,
@@ -116,6 +118,7 @@ class Profiler extends React.Component<ProfilerProps> {
     if (this._mountSpan && includeRender) {
       // If we were able to obtain the spanId of the mount activity, we should set the
       // next activity as a child to the component mount activity.
+      // eslint-disable-next-line deprecation/deprecation
       this._mountSpan.startChild({
         description: `<${name}>`,
         endTimestamp: timestampInSeconds(),
@@ -183,6 +186,7 @@ function useProfiler(
 
     const activeTransaction = getActiveTransaction();
     if (activeTransaction) {
+      // eslint-disable-next-line deprecation/deprecation
       return activeTransaction.startChild({
         description: `<${name}>`,
         op: REACT_MOUNT_OP,
@@ -201,6 +205,7 @@ function useProfiler(
 
     return (): void => {
       if (mountSpan && options.hasRenderSpan) {
+        // eslint-disable-next-line deprecation/deprecation
         mountSpan.startChild({
           description: `<${name}>`,
           endTimestamp: timestampInSeconds(),
diff --git a/packages/remix/src/utils/instrumentServer.ts b/packages/remix/src/utils/instrumentServer.ts
@@ -184,6 +184,7 @@ function makeWrappedDocumentRequestFunction(remixVersion?: number) {
       const activeTransaction = getActiveTransaction();
 
       try {
+        // eslint-disable-next-line deprecation/deprecation
         const span = activeTransaction?.startChild({
           op: 'function.remix.document_request',
           origin: 'auto.function.remix',
@@ -239,6 +240,7 @@ function makeWrappedDataFunction(
     const currentScope = getCurrentScope();
 
     try {
+      // eslint-disable-next-line deprecation/deprecation
       const span = activeTransaction?.startChild({
         op: `function.remix.${name}`,
         origin: 'auto.ui.remix',
diff --git a/packages/serverless/src/awsservices.ts b/packages/serverless/src/awsservices.ts
@@ -62,6 +62,7 @@ function wrapMakeRequest<TService extends AWSService, TResult>(
     const req = orig.call(this, operation, params);
     req.on('afterBuild', () => {
       if (transaction) {
+        // eslint-disable-next-line deprecation/deprecation
         span = transaction.startChild({
           description: describe(this, operation, params),
           op: 'http.client',
diff --git a/packages/serverless/src/google-cloud-grpc.ts b/packages/serverless/src/google-cloud-grpc.ts
@@ -111,6 +111,7 @@ function fillGrpcFunction(stub: Stub, serviceIdentifier: string, methodName: str
         const scope = getCurrentScope();
         const transaction = scope.getTransaction();
         if (transaction) {
+          // eslint-disable-next-line deprecation/deprecation
           span = transaction.startChild({
             description: `${callType} ${methodName}`,
             op: `grpc.${serviceIdentifier}`,
diff --git a/packages/serverless/src/google-cloud-http.ts b/packages/serverless/src/google-cloud-http.ts
@@ -56,6 +56,7 @@ function wrapRequestFunction(orig: RequestFunction): RequestFunction {
     const transaction = scope.getTransaction();
     if (transaction) {
       const httpMethod = reqOpts.method || 'GET';
+      // eslint-disable-next-line deprecation/deprecation
       span = transaction.startChild({
         description: `${httpMethod} ${reqOpts.uri}`,
         op: `http.client.${identifyService(this.apiEndpoint)}`,
diff --git a/packages/svelte/src/performance.ts b/packages/svelte/src/performance.ts
@@ -47,6 +47,7 @@ export function trackComponent(options?: TrackComponentOptions): void {
 }
 
 function recordInitSpan(transaction: Transaction, componentName: string): Span {
+  // eslint-disable-next-line deprecation/deprecation
   const initSpan = transaction.startChild({
     op: UI_SVELTE_INIT,
     description: componentName,
@@ -75,6 +76,7 @@ function recordUpdateSpans(componentName: string, initSpan?: Span): void {
     const parentSpan =
       initSpan && !initSpan.endTimestamp && initSpan.transaction === transaction ? initSpan : transaction;
 
+    // eslint-disable-next-line deprecation/deprecation
     updateSpan = parentSpan.startChild({
       op: UI_SVELTE_UPDATE,
       description: componentName,
diff --git a/packages/sveltekit/src/client/router.ts b/packages/sveltekit/src/client/router.ts
@@ -117,6 +117,7 @@ function instrumentNavigations(startTransactionFn: (context: TransactionContext)
         // If a routing span is still open from a previous navigation, we finish it.
         routingSpan.end();
       }
+      // eslint-disable-next-line deprecation/deprecation
       routingSpan = activeTransaction.startChild({
         op: 'ui.sveltekit.routing',
         description: 'SvelteKit Route Change',
diff --git a/packages/sveltekit/test/client/router.test.ts b/packages/sveltekit/test/client/router.test.ts
@@ -117,6 +117,7 @@ describe('sveltekitRoutingInstrumentation', () => {
       },
     });
 
+    // eslint-disable-next-line deprecation/deprecation
     expect(returnedTransaction?.startChild).toHaveBeenCalledWith({
       op: 'ui.sveltekit.routing',
       origin: 'auto.ui.sveltekit',
@@ -168,6 +169,7 @@ describe('sveltekitRoutingInstrumentation', () => {
         },
       });
 
+      // eslint-disable-next-line deprecation/deprecation
       expect(returnedTransaction?.startChild).toHaveBeenCalledWith({
         op: 'ui.sveltekit.routing',
         origin: 'auto.ui.sveltekit',
diff --git a/packages/tracing-internal/src/browser/metrics/index.ts b/packages/tracing-internal/src/browser/metrics/index.ts
@@ -76,6 +76,7 @@ export function startTrackingLongTasks(): void {
       const startTime = msToSec((browserPerformanceTimeOrigin as number) + entry.startTime);
       const duration = msToSec(entry.duration);
 
+      // eslint-disable-next-line deprecation/deprecation
       transaction.startChild({
         description: 'Main UI thread blocked',
         op: 'ui.long-task',
@@ -115,6 +116,7 @@ export function startTrackingInteractions(): void {
           span.data = { 'ui.component_name': componentName };
         }
 
+        // eslint-disable-next-line deprecation/deprecation
         transaction.startChild(span);
       }
     }
diff --git a/packages/tracing-internal/src/browser/metrics/utils.ts b/packages/tracing-internal/src/browser/metrics/utils.ts
@@ -18,6 +18,7 @@ export function _startChild(transaction: Transaction, { startTimestamp, ...ctx }
     transaction.startTimestamp = startTimestamp;
   }
 
+  // eslint-disable-next-line deprecation/deprecation
   return transaction.startChild({
     startTimestamp,
     ...ctx,
diff --git a/packages/tracing-internal/src/browser/request.ts b/packages/tracing-internal/src/browser/request.ts
@@ -275,7 +275,8 @@ export function xhrCallback(
 
   const span =
     shouldCreateSpanResult && parentSpan
-      ? parentSpan.startChild({
+      ? // eslint-disable-next-line deprecation/deprecation
+        parentSpan.startChild({
           data: {
             type: 'xhr',
             'http.method': sentryXhrData.method,
diff --git a/packages/tracing-internal/src/common/fetch.ts b/packages/tracing-internal/src/common/fetch.ts
@@ -79,7 +79,8 @@ export function instrumentFetchRequest(
 
   const span =
     shouldCreateSpanResult && parentSpan
-      ? parentSpan.startChild({
+      ? // eslint-disable-next-line deprecation/deprecation
+        parentSpan.startChild({
           data: {
             url,
             type: 'fetch',
diff --git a/packages/tracing-internal/src/node/integrations/apollo.ts b/packages/tracing-internal/src/node/integrations/apollo.ts
diff --git a/packages/tracing-internal/src/node/integrations/express.ts b/packages/tracing-internal/src/node/integrations/express.ts
diff --git a/packages/tracing-internal/src/node/integrations/graphql.ts b/packages/tracing-internal/src/node/integrations/graphql.ts
diff --git a/packages/tracing-internal/src/node/integrations/mongo.ts b/packages/tracing-internal/src/node/integrations/mongo.ts
diff --git a/packages/tracing-internal/src/node/integrations/mysql.ts b/packages/tracing-internal/src/node/integrations/mysql.ts
diff --git a/packages/tracing-internal/src/node/integrations/postgres.ts b/packages/tracing-internal/src/node/integrations/postgres.ts
diff --git a/packages/tracing-internal/test/browser/metrics/index.test.ts b/packages/tracing-internal/test/browser/metrics/index.test.ts
diff --git a/packages/tracing/test/idletransaction.test.ts b/packages/tracing/test/idletransaction.test.ts
diff --git a/packages/types/src/span.ts b/packages/types/src/span.ts
diff --git a/packages/vue/src/tracing.ts b/packages/vue/src/tracing.ts

Original file line number	Diff line number	Diff line change
`@@ -158,7 +158,8 @@ export function startInactiveSpan(context: StartSpanOptions): Span \| undefined {`
`158`	`158`	`const hub = getCurrentHub();`
`159`	`159`	`const parentSpan = getActiveSpan();`
`160`	`160`	`return parentSpan`
`161`		`- ? parentSpan.startChild(ctx)`
	`161`	`+ ? // eslint-disable-next-line deprecation/deprecation`
	`162`	`+ parentSpan.startChild(ctx)`
`162`	`163`	`: // eslint-disable-next-line deprecation/deprecation`
`163`	`164`	`hub.startTransaction(ctx);`
`164`	`165`	`}`
`@@ -240,7 +241,8 @@ function createChildSpanOrTransaction(`
`240`	`241`	`return undefined;`
`241`	`242`	`}`
`242`	`243`	`return parentSpan`
`243`		`- ? parentSpan.startChild(ctx)`
	`244`	`+ ? // eslint-disable-next-line deprecation/deprecation`
	`245`	`+ parentSpan.startChild(ctx)`
`244`	`246`	`: // eslint-disable-next-line deprecation/deprecation`
`245`	`247`	`hub.startTransaction(ctx);`
`246`	`248`	`}`
Original file line number	Diff line number	Diff line change
`@@ -88,6 +88,7 @@ export const instrumentRoutePerformance = <T extends RouteConstructor>(BaseRoute`
`88`	`88`	`return result;`
`89`	`89`	`}`
`90`	`90`	`currentTransaction`
	`91`	`+ // eslint-disable-next-line deprecation/deprecation`
`91`	`92`	`.startChild({`
`92`	`93`	`op,`
`93`	`94`	`description,`