Extract dropping utility into separate function

Author: Luca Forstner

packages/nextjs/src/common/pages-router-instrumentation/wrapApiHandlerWithSentry.ts

@@ -3,8 +3,6 @@ import {
   SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
   captureException,
   continueTrace,
-  getActiveSpan,
-  getRootSpan,
   setHttpStatus,
   startSpanManual,
   withIsolationScope,
@@ -13,10 +11,9 @@ import { isString, logger, objectify } from '@sentry/utils';
 
 import { vercelWaitUntil } from '@sentry/utils';
 import type { NextApiRequest } from 'next';
-import { TRANSACTION_ATTR_SHOULD_DROP_TRANSACTION } from '../span-attributes-with-logic-attached';
 import type { AugmentedNextApiResponse, NextApiHandler } from '../types';
 import { flushSafelyWithTimeout } from '../utils/responseEnd';
-import { escapeNextjsTracing } from '../utils/tracingUtils';
+import { dropNextjsRootContext, escapeNextjsTracing } from '../utils/tracingUtils';
 
 export type AugmentedNextApiRequest = NextApiRequest & {
   __withSentry_applied__?: boolean;
@@ -31,21 +28,13 @@ export type AugmentedNextApiRequest = NextApiRequest & {
  * @returns The wrapped handler which will always return a Promise.
  */
 export function wrapApiHandlerWithSentry(apiHandler: NextApiHandler, parameterizedRoute: string): NextApiHandler {
-  // Since the API route handler spans emitted by Next.js are super buggy with completely wrong timestamps
-  // (fix pending at the time of writing this: https://github.com/vercel/next.js/pull/70908) we want to intentionally
-  // drop them. In the future, when Next.js' OTEL instrumentation is in a high-quality place we can potentially think
-  // about keeping them.
-  const nextJsOwnedSpan = getActiveSpan();
-  if (nextJsOwnedSpan) {
-    getRootSpan(nextJsOwnedSpan)?.setAttribute(TRANSACTION_ATTR_SHOULD_DROP_TRANSACTION, true);
-  }
-
   return new Proxy(apiHandler, {
     apply: (
       wrappingTarget,
       thisArg,
       args: [AugmentedNextApiRequest | undefined, AugmentedNextApiResponse | undefined],
     ) => {
+      dropNextjsRootContext();
       return escapeNextjsTracing(() => {
         const [req, res] = args;
 

packages/nextjs/src/common/pages-router-instrumentation/wrapApiHandlerWithSentryVercelCrons.ts

@@ -9,7 +9,7 @@ type EdgeRequest = {
 };
 
 /**
- * Wraps a function with Sentry crons instrumentation by automaticaly sending check-ins for the given Vercel crons config.
+ * Wraps a function with Sentry crons instrumentation by automatically sending check-ins for the given Vercel crons config.
  */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export function wrapApiHandlerWithSentryVercelCrons<F extends (...args: any[]) => any>(

packages/nextjs/src/common/pages-router-instrumentation/wrapPageComponentWithSentry.ts

@@ -1,7 +1,6 @@
-import { captureException, getActiveSpan, getCurrentScope, getRootSpan, withIsolationScope } from '@sentry/core';
+import { captureException, getCurrentScope, withIsolationScope } from '@sentry/core';
 import { extractTraceparentData } from '@sentry/utils';
-import { TRANSACTION_ATTR_SHOULD_DROP_TRANSACTION } from '../span-attributes-with-logic-attached';
-import { escapeNextjsTracing } from '../utils/tracingUtils';
+import { dropNextjsRootContext, escapeNextjsTracing } from '../utils/tracingUtils';
 
 interface FunctionComponent {
   (...args: unknown[]): unknown;
@@ -26,15 +25,7 @@ export function wrapPageComponentWithSentry(pageComponent: FunctionComponent | C
   if (isReactClassComponent(pageComponent)) {
     return class SentryWrappedPageComponent extends pageComponent {
       public render(...args: unknown[]): unknown {
-        // Since the spans emitted by Next.js are super buggy with completely wrong timestamps
-        // (fix pending at the time of writing this: https://github.com/vercel/next.js/pull/70908) we want to intentionally
-        // drop them. In the future, when Next.js' OTEL instrumentation is in a high-quality place we can potentially think
-        // about keeping them.
-        const nextJsOwnedSpan = getActiveSpan();
-        if (nextJsOwnedSpan) {
-          getRootSpan(nextJsOwnedSpan)?.setAttribute(TRANSACTION_ATTR_SHOULD_DROP_TRANSACTION, true);
-        }
-
+        dropNextjsRootContext();
         return escapeNextjsTracing(() => {
           return withIsolationScope(() => {
             const scope = getCurrentScope();
@@ -72,15 +63,7 @@ export function wrapPageComponentWithSentry(pageComponent: FunctionComponent | C
   } else if (typeof pageComponent === 'function') {
     return new Proxy(pageComponent, {
       apply(target, thisArg, argArray: [{ _sentryTraceData?: string } | undefined]) {
-        // Since the spans emitted by Next.js are super buggy with completely wrong timestamps
-        // (fix pending at the time of writing this: https://github.com/vercel/next.js/pull/70908) we want to intentionally
-        // drop them. In the future, when Next.js' OTEL instrumentation is in a high-quality place we can potentially think
-        // about keeping them.
-        const nextJsOwnedSpan = getActiveSpan();
-        if (nextJsOwnedSpan) {
-          getRootSpan(nextJsOwnedSpan)?.setAttribute(TRANSACTION_ATTR_SHOULD_DROP_TRANSACTION, true);
-        }
-
+        dropNextjsRootContext();
         return escapeNextjsTracing(() => {
           return withIsolationScope(() => {
             const scope = getCurrentScope();

packages/nextjs/src/common/utils/edgeWrapperUtils.ts

@@ -4,8 +4,6 @@ import {
   SPAN_STATUS_OK,
   captureException,
   continueTrace,
-  getActiveSpan,
-  getRootSpan,
   handleCallbackErrors,
   setHttpStatus,
   startSpan,
@@ -14,9 +12,8 @@ import {
 import { vercelWaitUntil, winterCGRequestToRequestData } from '@sentry/utils';
 
 import type { EdgeRouteHandler } from '../../edge/types';
-import { TRANSACTION_ATTR_SHOULD_DROP_TRANSACTION } from '../span-attributes-with-logic-attached';
 import { flushSafelyWithTimeout } from './responseEnd';
-import { commonObjectToIsolationScope, escapeNextjsTracing } from './tracingUtils';
+import { commonObjectToIsolationScope, dropNextjsRootContext, escapeNextjsTracing } from './tracingUtils';
 
 /**
  * Wraps a function on the edge runtime with error and performance monitoring.
@@ -26,15 +23,7 @@ export function withEdgeWrapping<H extends EdgeRouteHandler>(
   options: { spanDescription: string; spanOp: string; mechanismFunctionName: string },
 ): (...params: Parameters<H>) => Promise<ReturnType<H>> {
   return async function (this: unknown, ...args) {
-    // Since the spans emitted by Next.js are super buggy with completely wrong timestamps
-    // (fix pending at the time of writing this: https://github.com/vercel/next.js/pull/70908) we want to intentionally
-    // drop them. In the future, when Next.js' OTEL instrumentation is in a high-quality place we can potentially think
-    // about keeping them.
-    const nextJsOwnedSpan = getActiveSpan();
-    if (nextJsOwnedSpan) {
-      getRootSpan(nextJsOwnedSpan)?.setAttribute(TRANSACTION_ATTR_SHOULD_DROP_TRANSACTION, true);
-    }
-
+    dropNextjsRootContext();
     return escapeNextjsTracing(() => {
       const req: unknown = args[0];
       return withIsolationScope(commonObjectToIsolationScope(req), isolationScope => {

packages/nextjs/src/common/utils/tracingUtils.ts

@@ -1,7 +1,8 @@
-import { Scope, startNewTrace } from '@sentry/core';
+import { Scope, getActiveSpan, getRootSpan, spanToJSON, startNewTrace } from '@sentry/core';
 import type { PropagationContext } from '@sentry/types';
 import { GLOBAL_OBJ, logger } from '@sentry/utils';
 import { DEBUG_BUILD } from '../debug-build';
+import { TRANSACTION_ATTR_SHOULD_DROP_TRANSACTION } from '../span-attributes-with-logic-attached';
 
 const commonPropagationContextMap = new WeakMap<object, PropagationContext>();
 
@@ -92,3 +93,19 @@ export function escapeNextjsTracing<T>(cb: () => T): T {
     });
   }
 }
+
+/**
+ * Ideally this function never lands in the develop branch.
+ *
+ * Drops the entire span tree this function was called in, if it was a span tree created by Next.js.
+ */
+export function dropNextjsRootContext(): void {
+  const nextJsOwnedSpan = getActiveSpan();
+  if (nextJsOwnedSpan) {
+    const rootSpan = getRootSpan(nextJsOwnedSpan);
+    const rootSpanAttributes = spanToJSON(rootSpan).data;
+    if (rootSpanAttributes?.['next.span_type']) {
+      getRootSpan(nextJsOwnedSpan)?.setAttribute(TRANSACTION_ATTR_SHOULD_DROP_TRANSACTION, true);
+    }
+  }
+}

packages/nextjs/src/common/utils/wrapperUtils.ts

@@ -6,8 +6,6 @@ import {
   SPAN_STATUS_OK,
   captureException,
   continueTrace,
-  getActiveSpan,
-  getRootSpan,
   getTraceData,
   startInactiveSpan,
   startSpan,
@@ -18,9 +16,8 @@ import {
 import type { Span } from '@sentry/types';
 import { isString, vercelWaitUntil } from '@sentry/utils';
 
-import { TRANSACTION_ATTR_SHOULD_DROP_TRANSACTION } from '../span-attributes-with-logic-attached';
 import { autoEndSpanOnResponseEnd, flushSafelyWithTimeout } from './responseEnd';
-import { commonObjectToIsolationScope, escapeNextjsTracing } from './tracingUtils';
+import { commonObjectToIsolationScope, dropNextjsRootContext, escapeNextjsTracing } from './tracingUtils';
 
 declare module 'http' {
   interface IncomingMessage {
@@ -96,15 +93,7 @@ export function withTracedServerSideDataFetcher<F extends (...args: any[]) => Pr
     this: unknown,
     ...args: Parameters<F>
   ): Promise<{ data: ReturnType<F>; sentryTrace?: string; baggage?: string }> {
-    // Since the spans emitted by Next.js are super buggy with completely wrong timestamps
-    // (fix pending at the time of writing this: https://github.com/vercel/next.js/pull/70908) we want to intentionally
-    // drop them. In the future, when Next.js' OTEL instrumentation is in a high-quality place we can potentially think
-    // about keeping them.
-    const nextJsOwnedSpan = getActiveSpan();
-    if (nextJsOwnedSpan) {
-      getRootSpan(nextJsOwnedSpan)?.setAttribute(TRANSACTION_ATTR_SHOULD_DROP_TRANSACTION, true);
-    }
-
+    dropNextjsRootContext();
     return escapeNextjsTracing(() => {
       const isolationScope = commonObjectToIsolationScope(req);
       return withIsolationScope(isolationScope, () => {

packages/nextjs/src/common/withServerActionInstrumentation.ts

@@ -1,19 +1,20 @@
 import {
   SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
   SPAN_STATUS_ERROR,
-  getActiveSpan,
+  captureException,
+  continueTrace,
+  getClient,
   getIsolationScope,
-  getRootSpan,
+  handleCallbackErrors,
+  startSpan,
   withIsolationScope,
 } from '@sentry/core';
-import { captureException, continueTrace, getClient, handleCallbackErrors, startSpan } from '@sentry/core';
 import { logger, vercelWaitUntil } from '@sentry/utils';
 
 import { DEBUG_BUILD } from './debug-build';
 import { isNotFoundNavigationError, isRedirectNavigationError } from './nextNavigationErrorUtils';
-import { TRANSACTION_ATTR_SHOULD_DROP_TRANSACTION } from './span-attributes-with-logic-attached';
 import { flushSafelyWithTimeout } from './utils/responseEnd';
-import { escapeNextjsTracing } from './utils/tracingUtils';
+import { dropNextjsRootContext, escapeNextjsTracing } from './utils/tracingUtils';
 
 interface Options {
   formData?: FormData;
@@ -67,15 +68,7 @@ async function withServerActionInstrumentationImplementation<A extends (...args:
   options: Options,
   callback: A,
 ): Promise<ReturnType<A>> {
-  // Since the spans emitted by Next.js are super buggy with completely wrong timestamps
-  // (fix pending at the time of writing this: https://github.com/vercel/next.js/pull/70908) we want to intentionally
-  // drop them. In the future, when Next.js' OTEL instrumentation is in a high-quality place we can potentially think
-  // about keeping them.
-  const nextJsOwnedSpan = getActiveSpan();
-  if (nextJsOwnedSpan) {
-    getRootSpan(nextJsOwnedSpan)?.setAttribute(TRANSACTION_ATTR_SHOULD_DROP_TRANSACTION, true);
-  }
-
+  dropNextjsRootContext();
   return escapeNextjsTracing(() => {
     return withIsolationScope(async isolationScope => {
       const sendDefaultPii = getClient()?.getOptions().sendDefaultPii;