add route handler tests

Author: chargome

dev-packages/e2e-tests/test-applications/nextjs-15/app/route-handler/[xoxo]/edge/route.ts

@@ -0,0 +1,8 @@
+import { NextResponse } from 'next/server';
+
+export const runtime = 'edge';
+export const dynamic = 'force-dynamic';
+
+export async function GET() {
+  return NextResponse.json({ message: 'Hello Edge Route Handler' });
+}

dev-packages/e2e-tests/test-applications/nextjs-15/app/route-handler/[xoxo]/node/route.ts

@@ -0,0 +1,7 @@
+import { NextResponse } from 'next/server';
+
+export const dynamic = 'force-dynamic';
+
+export async function GET() {
+  return NextResponse.json({ message: 'Hello Node Route Handler' });
+}

dev-packages/e2e-tests/test-applications/nextjs-15/tests/route-handler.test.ts

@@ -0,0 +1,38 @@
+import test, { expect } from '@playwright/test';
+import { waitForTransaction } from '@sentry-internal/test-utils';
+
+test('Should create a transaction for node route handlers', async ({ request }) => {
+  const routehandlerTransactionPromise = waitForTransaction('nextjs-15', async transactionEvent => {
+    console.log(transactionEvent?.transaction);
+    return transactionEvent?.transaction === 'GET /route-handler/[xoxo]/node';
+  });
+
+  const response = await request.get('/route-handler/123/node', { headers: { 'x-charly': 'gomez' } });
+  expect(await response.json()).toStrictEqual({ message: 'Hello Node Route Handler' });
+
+  const routehandlerTransaction = await routehandlerTransactionPromise;
+
+  expect(routehandlerTransaction.contexts?.trace?.status).toBe('ok');
+  expect(routehandlerTransaction.contexts?.trace?.op).toBe('http.server');
+
+  // This is flaking on dev mode
+  if (process.env.TEST_ENV !== 'development' && process.env.TEST_ENV !== 'dev-turbopack') {
+    expect(routehandlerTransaction.contexts?.trace?.data?.['http.request.header.x_charly']).toBe('gomez');
+  }
+});
+
+test('Should create a transaction for edge route handlers', async ({ request }) => {
+  const routehandlerTransactionPromise = waitForTransaction('nextjs-15', async transactionEvent => {
+    return transactionEvent?.transaction === 'GET /route-handler/[xoxo]/edge';
+  });
+
+  const response = await request.get('/route-handler/123/edge', { headers: { 'x-charly': 'gomez' } });
+  expect(await response.json()).toStrictEqual({ message: 'Hello Edge Route Handler' });
+
+  const routehandlerTransaction = await routehandlerTransactionPromise;
+
+  expect(routehandlerTransaction.contexts?.trace?.status).toBe('ok');
+  expect(routehandlerTransaction.contexts?.trace?.op).toBe('http.server');
+  // todo: check if we can set request headers for edge on sdkProcessingMetadata
+  // expect(routehandlerTransaction.contexts?.trace?.data?.['http.request.header.x-charly']).toBe('gomez');
+});

packages/nextjs/src/server/index.ts

@@ -165,6 +165,7 @@ export function init(options: NodeOptions): NodeClient | undefined {
   client?.on('spanStart', span => {
     const spanAttributes = spanToJSON(span).data;
     const rootSpan = getRootSpan(span);
+    const isRootSpan = span === rootSpan;
 
     // What we do in this glorious piece of code, is hoist any information about parameterized routes from spans emitted
     // by Next.js via the `next.route` attribute, up to the transaction by setting the http.route attribute.
@@ -192,13 +193,13 @@ export function init(options: NodeOptions): NodeClient | undefined {
 
     // Add headers to the root span if the client options allow it
     const shouldSendDefaultPii = getClient()?.getOptions().sendDefaultPii ?? false;
-    if (shouldSendDefaultPii && rootSpan) {
-      const headers = getIsolationScope().getScopeData().sdkProcessingMetadata.normalizedRequest?.headers;
+    if (shouldSendDefaultPii && isRootSpan) {
+      const headers = getIsolationScope().getScopeData().sdkProcessingMetadata?.normalizedRequest?.headers;
       addHeadersAsAttributes(headers, rootSpan);
     }
 
     // We want to fork the isolation scope for incoming requests
-    if (spanAttributes?.['next.span_type'] === 'BaseServer.handleRequest' && span === getRootSpan(span)) {
+    if (spanAttributes?.['next.span_type'] === 'BaseServer.handleRequest' && isRootSpan) {
       const scopes = getCapturedScopesOnSpan(span);
 
       const isolationScope = (scopes.isolationScope || getIsolationScope()).clone();