fix: parameterization backfill

Author: logaretm

dev-packages/e2e-tests/test-applications/nextjs-13/tests/server/pages-router-api-endpoints.test.ts

@@ -8,7 +8,7 @@ test('Should report an error event for errors thrown in pages router api routes'
 
   const transactionEventPromise = waitForTransaction('nextjs-13', transactionEvent => {
     return (
-      transactionEvent.transaction === 'GET /api/foo/failure-api-route' &&
+      transactionEvent.transaction === 'GET /api/[param]/failure-api-route' &&
       transactionEvent.contexts?.trace?.op === 'http.server'
     );
   });

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

@@ -1,5 +1,14 @@
-import { captureException, debug, getIsolationScope, httpRequestToRequestData, objectify } from '@sentry/core';
+import {
+  captureException,
+  debug,
+  getActiveSpan,
+  getIsolationScope,
+  getRootSpan,
+  httpRequestToRequestData,
+  objectify,
+} from '@sentry/core';
 import type { NextApiRequest } from 'next';
+import { TRANSACTION_ATTR_SENTRY_ROUTE_BACKFILL } from '../span-attributes-with-logic-attached';
 import type { AugmentedNextApiResponse, NextApiHandler } from '../types';
 import { flushSafelyWithTimeout } from '../utils/responseEnd';
 
@@ -53,6 +62,14 @@ export function wrapApiHandlerWithSentry(apiHandler: NextApiHandler, parameteriz
           normalizedRequest: httpRequestToRequestData(req),
         });
 
+        // Set the route backfill attribute on the root span so that the transaction name
+        // gets updated to use the parameterized route during event processing
+        const activeSpan = getActiveSpan();
+        if (activeSpan) {
+          const rootSpan = getRootSpan(activeSpan);
+          rootSpan.setAttribute(TRANSACTION_ATTR_SENTRY_ROUTE_BACKFILL, parameterizedRoute);
+        }
+
         return await wrappingTarget.apply(thisArg, args);
       } catch (e) {
         // In case we have a primitive, wrap it in the equivalent wrapper class (string -> String, etc.) so that we can

packages/nextjs/src/server/index.ts

@@ -368,6 +368,7 @@ export function init(options: NodeOptions): NodeClient | undefined {
       // backfill transaction name for pages that would otherwise contain unparameterized routes
       if (event.contexts.trace.data[TRANSACTION_ATTR_SENTRY_ROUTE_BACKFILL] && event.transaction !== 'GET /_app') {
         event.transaction = `${method} ${event.contexts.trace.data[TRANSACTION_ATTR_SENTRY_ROUTE_BACKFILL]}`;
+        event.contexts.trace.data[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE] = 'route';
       }
 
       const middlewareMatch =