fix(nuxt): Parametrize routes on the server-side

s1gr1d · s1gr1d · commit 3537d54635e4 · 2025-07-07T15:40:39.000+02:00
diff --git a/dev-packages/e2e-tests/test-applications/nuxt-3-dynamic-import/tests/tracing.test.ts b/dev-packages/e2e-tests/test-applications/nuxt-3-dynamic-import/tests/tracing.test.ts
@@ -10,7 +10,7 @@ test.describe('distributed tracing', () => {
     });
 
     const serverTxnEventPromise = waitForTransaction('nuxt-3-dynamic-import', txnEvent => {
-      return txnEvent.transaction.includes('GET /test-param/');
+      return txnEvent.transaction?.includes('GET /test-param/') || false;
     });
 
     const [_, clientTxnEvent, serverTxnEvent] = await Promise.all([
@@ -47,8 +47,8 @@ test.describe('distributed tracing', () => {
     });
 
     expect(serverTxnEvent).toMatchObject({
-      transaction: `GET /test-param/${PARAM}`, // todo: parametrize (nitro)
-      transaction_info: { source: 'url' },
+      transaction: `GET /test-param/:param`,
+      transaction_info: { source: 'route' },
       type: 'transaction',
       contexts: {
         trace: {
diff --git a/dev-packages/e2e-tests/test-applications/nuxt-3-min/tests/tracing.test.ts b/dev-packages/e2e-tests/test-applications/nuxt-3-min/tests/tracing.test.ts
@@ -47,8 +47,8 @@ test.describe('distributed tracing', () => {
     });
 
     expect(serverTxnEvent).toMatchObject({
-      transaction: `GET /test-param/${PARAM}`, // todo: parametrize (nitro)
-      transaction_info: { source: 'url' },
+      transaction: `GET /test-param/:param`,
+      transaction_info: { source: 'route' },
       type: 'transaction',
       contexts: {
         trace: {
diff --git a/dev-packages/e2e-tests/test-applications/nuxt-3/tests/tracing.test.ts b/dev-packages/e2e-tests/test-applications/nuxt-3/tests/tracing.test.ts
@@ -23,7 +23,7 @@ test.describe('distributed tracing', () => {
     const baggageMetaTagContent = await page.locator('meta[name="baggage"]').getAttribute('content');
 
     expect(baggageMetaTagContent).toContain(`sentry-trace_id=${serverTxnEvent.contexts?.trace?.trace_id}`);
-    expect(baggageMetaTagContent).toContain(`sentry-transaction=GET%20%2Ftest-param%2F${PARAM}`); // URL-encoded for 'GET /test-param/s0me-param'
+    expect(baggageMetaTagContent).toContain(`sentry-transaction=GET%20%2Ftest-param%2F%3Aparam`); // URL-encoded for 'GET /test-param/:param'
     expect(baggageMetaTagContent).toContain('sentry-sampled=true');
     expect(baggageMetaTagContent).toContain('sentry-sample_rate=1');
 
@@ -47,8 +47,8 @@ test.describe('distributed tracing', () => {
     });
 
     expect(serverTxnEvent).toMatchObject({
-      transaction: `GET /test-param/${PARAM}`, // todo: parametrize (nitro)
-      transaction_info: { source: 'url' },
+      transaction: `GET /test-param/:param`,
+      transaction_info: { source: 'route' },
       type: 'transaction',
       contexts: {
         trace: {
diff --git a/dev-packages/e2e-tests/test-applications/nuxt-4/tests/tracing.test.ts b/dev-packages/e2e-tests/test-applications/nuxt-4/tests/tracing.test.ts
@@ -23,7 +23,7 @@ test.describe('distributed tracing', () => {
     const baggageMetaTagContent = await page.locator('meta[name="baggage"]').getAttribute('content');
 
     expect(baggageMetaTagContent).toContain(`sentry-trace_id=${serverTxnEvent.contexts?.trace?.trace_id}`);
-    expect(baggageMetaTagContent).toContain(`sentry-transaction=GET%20%2Ftest-param%2F${PARAM}`); // URL-encoded for 'GET /test-param/s0me-param'
+    expect(baggageMetaTagContent).toContain(`sentry-transaction=GET%20%2Ftest-param%2F%3Aparam`); // URL-encoded for 'GET /test-param/:param'
     expect(baggageMetaTagContent).toContain('sentry-sampled=true');
     expect(baggageMetaTagContent).toContain('sentry-sample_rate=1');
 
@@ -47,8 +47,8 @@ test.describe('distributed tracing', () => {
     });
 
     expect(serverTxnEvent).toMatchObject({
-      transaction: `GET /test-param/${PARAM}`, // todo: parametrize (nitro)
-      transaction_info: { source: 'url' },
+      transaction: `GET /test-param/:param`,
+      transaction_info: { source: 'route' },
       type: 'transaction',
       contexts: {
         trace: {
diff --git a/packages/nuxt/src/runtime/hooks/updateRouteBeforeResponse.ts b/packages/nuxt/src/runtime/hooks/updateRouteBeforeResponse.ts
@@ -0,0 +1,39 @@
+import { getActiveSpan, getCurrentScope, getRootSpan, logger, SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '@sentry/core';
+import type { H3Event } from 'h3';
+
+/**
+ * Update the root span (transaction) name for routes with parameters based on the matched route.
+ */
+export function updateRouteBeforeResponse(event: H3Event): void {
+  if (event.context.matchedRoute) {
+    const matchedRoute = event.context.matchedRoute;
+    const matchedRoutePath = matchedRoute.path;
+    const params = event.context?.params || null;
+    const method = event._method || 'GET';
+
+    // If the matched route path is defined and differs from the event's path, it indicates a parametrized route
+    // Example: If the matched route is "/users/:id" and the event's path is "/users/123",
+    if (matchedRoutePath && matchedRoutePath !== event._path) {
+      const parametrizedTransactionName = `${method.toUpperCase()} ${matchedRoutePath}`;
+      getCurrentScope().setTransactionName(parametrizedTransactionName);
+
+      const activeSpan = getActiveSpan(); // In development mode, getActiveSpan() is always undefined
+      if (activeSpan) {
+        const rootSpan = getRootSpan(activeSpan);
+        if (rootSpan) {
+          rootSpan.updateName(parametrizedTransactionName);
+          rootSpan.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, 'route');
+          rootSpan.setAttribute('http.route', matchedRoutePath);
+
+          if (params && typeof params === 'object') {
+            Object.entries(params).forEach(([key, value]) => {
+              rootSpan.setAttribute(`params.${key}`, String(value));
+            });
+          }
+
+          logger.log(`Updated transaction name for parametrized route: ${parametrizedTransactionName}`);
+        }
+      }
+    }
+  }
+}
diff --git a/packages/nuxt/src/runtime/plugins/sentry-cloudflare.server.ts b/packages/nuxt/src/runtime/plugins/sentry-cloudflare.server.ts
@@ -6,6 +6,7 @@ import type { H3Event } from 'h3';
 import type { NitroApp, NitroAppPlugin } from 'nitropack';
 import type { NuxtRenderHTMLContext } from 'nuxt/app';
 import { sentryCaptureErrorHook } from '../hooks/captureErrorHook';
+import { updateRouteBeforeResponse } from '../hooks/updateRouteBeforeResponse';
 import { addSentryTracingMetaTags } from '../utils';
 
 interface CfEventType {
@@ -139,6 +140,8 @@ export const sentryCloudflareNitroPlugin =
       },
     });
 
+    nitroApp.hooks.hook('beforeResponse', updateRouteBeforeResponse);
+
     // @ts-expect-error - 'render:html' is a valid hook name in the Nuxt context
     nitroApp.hooks.hook('render:html', (html: NuxtRenderHTMLContext, { event }: { event: H3Event }) => {
       const storedTraceData = event?.context?.cf ? traceDataMap.get(event.context.cf) : undefined;
diff --git a/packages/nuxt/src/runtime/plugins/sentry.server.ts b/packages/nuxt/src/runtime/plugins/sentry.server.ts
@@ -5,11 +5,14 @@ import { type EventHandler } from 'h3';
 import { defineNitroPlugin } from 'nitropack/runtime';
 import type { NuxtRenderHTMLContext } from 'nuxt/app';
 import { sentryCaptureErrorHook } from '../hooks/captureErrorHook';
+import { updateRouteBeforeResponse } from '../hooks/updateRouteBeforeResponse';
 import { addSentryTracingMetaTags, flushIfServerless } from '../utils';
 
 export default defineNitroPlugin(nitroApp => {
   nitroApp.h3App.handler = patchEventHandler(nitroApp.h3App.handler);
 
+  nitroApp.hooks.hook('beforeResponse', updateRouteBeforeResponse);
+
   nitroApp.hooks.hook('error', sentryCaptureErrorHook);
 
   // @ts-expect-error - 'render:html' is a valid hook name in the Nuxt context
