[WIP] feat(nextjs): Add URL to tags of server component and layout issues

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

@@ -0,0 +1,125 @@
+import { getSanitizedUrlStringFromUrlObject, parseStringToURLObject } from '@sentry/core';
+
+type ComponentRouteParams = Record<string, string> | undefined;
+type HeadersDict = Record<string, string> | undefined;
+
+const HeaderKeys = {
+  FORWARDED_PROTO: 'x-forwarded-proto',
+  FORWARDED_HOST: 'x-forwarded-host',
+  HOST: 'host',
+  REFERER: 'referer',
+} as const;
+
+/**
+ * Replaces route parameters in a path template with their values
+ * @param path - The path template containing parameters in [paramName] format
+ * @param params - Optional route parameters to replace in the template
+ * @returns The path with parameters replaced
+ */
+function substituteRouteParams(path: string, params?: ComponentRouteParams): string {
+  if (!params || typeof params !== 'object') return path;
+
+  let resultPath = path;
+  for (const [key, value] of Object.entries(params)) {
+    const paramPattern = /\[([^\]]+)\]/g;
+    resultPath = resultPath.replace(paramPattern, (match, paramName) => {
+      return paramName === key ? encodeURIComponent(value) : match;
+    });
+  }
+  return resultPath;
+}
+
+/**
+ * Normalizes a path by removing route groups and multiple slashes
+ * @param path - The path to normalize
+ * @returns The normalized path
+ */
+function sanitizeRoutePath(path: string): string {
+  const normalizedPath = path
+    .replace(/\([^)]+\)/g, '') // Remove route groups
+    .replace(/\/{2,}/g, '/') // Normalize multiple slashes
+    .replace(/\/$/, ''); // Remove trailing slash
+
+  return normalizedPath || '/'; // Ensure root path is '/'
+}
+
+/**
+ * Constructs a full URL from the component route, parameters, and headers.
+ *
+ * @param componentRoute - The route template to construct the URL from
+ * @param params - Optional route parameters to replace in the template
+ * @param headersDict - Optional headers containing protocol and host information
+ * @param pathname - Optional pathname coming from parent span "http.target"
+ * @returns A sanitized URL string
+ */
+export function buildUrlFromComponentRoute(
+  componentRoute: string,
+  params?: ComponentRouteParams,
+  headersDict?: HeadersDict,
+  pathname?: string,
+): string {
+  const parameterisedPath = substituteRouteParams(componentRoute, params);
+  // pathname has precedence over the parameterised path if it exists
+  // spans like generateMetadata and Server Component rendering, are normally direct children of the root http.server span
+  const path = pathname ?? sanitizeRoutePath(parameterisedPath);
+
+  const protocol = headersDict?.[HeaderKeys.FORWARDED_PROTO];
+  const host = headersDict?.[HeaderKeys.FORWARDED_HOST] || headersDict?.[HeaderKeys.HOST];
+
+  if (!protocol || !host) {
+    return path;
+  }
+
+  const fullUrl = `${protocol}://${host}${path}`;
+
+  const urlObject = parseStringToURLObject(fullUrl);
+  if (!urlObject) {
+    return path;
+  }
+
+  return getSanitizedUrlStringFromUrlObject(urlObject);
+}
+
+/**
+ * Returns a sanitized URL string from the referer header if it exists and is valid.
+ *
+ * @param headersDict - Optional headers containing the referer
+ * @returns A sanitized URL string or undefined if referer is missing/invalid
+ */
+export function extractSanitizedUrlFromRefererHeader(headersDict?: HeadersDict): string | undefined {
+  const referer = headersDict?.[HeaderKeys.REFERER];
+  if (!referer) {
+    return undefined;
+  }
+
+  try {
+    const refererUrl = new URL(referer);
+    return getSanitizedUrlStringFromUrlObject(refererUrl);
+  } catch (error) {
+    return undefined;
+  }
+}
+
+/**
+ * Returns a sanitized URL string using the referer header if available,
+ * otherwise constructs the URL from the component route, params, and headers.
+ *
+ * @param componentRoute - The route template to construct the URL from
+ * @param params - Optional route parameters to replace in the template
+ * @param headersDict - Optional headers containing protocol, host, and referer
+ * @param pathname - Optional pathname coming from root span "http.target"
+ * @returns A sanitized URL string
+ */
+export function getSanitizedRequestUrl(
+  componentRoute: string,
+  params?: ComponentRouteParams,
+  headersDict?: HeadersDict,
+  pathname?: string,
+): string {
+  const refererUrl = extractSanitizedUrlFromRefererHeader(headersDict);
+  if (refererUrl) {
+    return refererUrl;
+  }
+
+  return buildUrlFromComponentRoute(componentRoute, params, headersDict, pathname);
+}

packages/nextjs/src/common/wrapGenerationFunctionWithSentry.ts

@@ -13,6 +13,7 @@ import {
   setCapturedScopesOnSpan,
   SPAN_STATUS_ERROR,
   SPAN_STATUS_OK,
+  spanToJSON,
   startSpanManual,
   winterCGHeadersToDict,
   withIsolationScope,
@@ -22,7 +23,7 @@ import type { GenerationFunctionContext } from '../common/types';
 import { isNotFoundNavigationError, isRedirectNavigationError } from './nextNavigationErrorUtils';
 import { TRANSACTION_ATTR_SENTRY_TRACE_BACKFILL } from './span-attributes-with-logic-attached';
 import { commonObjectToIsolationScope, commonObjectToPropagationContext } from './utils/tracingUtils';
-
+import { getSanitizedRequestUrl } from './utils/urls';
 /**
  * Wraps a generation function (e.g. generateMetadata) with Sentry error and performance instrumentation.
  */
@@ -44,32 +45,45 @@ export function wrapGenerationFunctionWithSentry<F extends (...args: any[]) => a
       }
 
       const isolationScope = commonObjectToIsolationScope(headers);
+      let pathname = undefined as string | undefined;
 
       const activeSpan = getActiveSpan();
       if (activeSpan) {
         const rootSpan = getRootSpan(activeSpan);
         const { scope } = getCapturedScopesOnSpan(rootSpan);
         setCapturedScopesOnSpan(rootSpan, scope ?? new Scope(), isolationScope);
+
+        const spanData = spanToJSON(rootSpan);
+
+        if (spanData.data && 'http.target' in spanData.data) {
+          pathname = spanData.data['http.target'] as string;
+        }
       }
 
+      const headersDict = headers ? winterCGHeadersToDict(headers) : undefined;
+
       let data: Record<string, unknown> | undefined = undefined;
       if (getClient()?.getOptions().sendDefaultPii) {
         const props: unknown = args[0];
         const params = props && typeof props === 'object' && 'params' in props ? props.params : undefined;
         const searchParams =
           props && typeof props === 'object' && 'searchParams' in props ? props.searchParams : undefined;
-        data = { params, searchParams };
+        data = { params, searchParams } as Record<string, unknown>;
       }
 
-      const headersDict = headers ? winterCGHeadersToDict(headers) : undefined;
-
       return withIsolationScope(isolationScope, () => {
         return withScope(scope => {
           scope.setTransactionName(`${componentType}.${generationFunctionIdentifier} (${componentRoute})`);
 
           isolationScope.setSDKProcessingMetadata({
             normalizedRequest: {
               headers: headersDict,
+              url: getSanitizedRequestUrl(
+                componentRoute,
+                data?.params as Record<string, string> | undefined,
+                headersDict,
+                pathname,
+              ),
             } satisfies RequestEventData,
           });
 

packages/nextjs/src/common/wrapServerComponentWithSentry.ts

@@ -3,6 +3,7 @@ import {
   captureException,
   getActiveSpan,
   getCapturedScopesOnSpan,
+  getClient,
   getRootSpan,
   handleCallbackErrors,
   propagationContextFromHeaders,
@@ -12,6 +13,7 @@ import {
   setCapturedScopesOnSpan,
   SPAN_STATUS_ERROR,
   SPAN_STATUS_OK,
+  spanToJSON,
   startSpanManual,
   vercelWaitUntil,
   winterCGHeadersToDict,
@@ -23,6 +25,7 @@ import type { ServerComponentContext } from '../common/types';
 import { TRANSACTION_ATTR_SENTRY_TRACE_BACKFILL } from './span-attributes-with-logic-attached';
 import { flushSafelyWithTimeout } from './utils/responseEnd';
 import { commonObjectToIsolationScope, commonObjectToPropagationContext } from './utils/tracingUtils';
+import { getSanitizedRequestUrl } from './utils/urls';
 
 /**
  * Wraps an `app` directory server component with Sentry error instrumentation.
@@ -41,18 +44,36 @@ export function wrapServerComponentWithSentry<F extends (...args: any[]) => any>
       const requestTraceId = getActiveSpan()?.spanContext().traceId;
       const isolationScope = commonObjectToIsolationScope(context.headers);
 
+      let pathname = undefined as string | undefined;
       const activeSpan = getActiveSpan();
       if (activeSpan) {
         const rootSpan = getRootSpan(activeSpan);
         const { scope } = getCapturedScopesOnSpan(rootSpan);
         setCapturedScopesOnSpan(rootSpan, scope ?? new Scope(), isolationScope);
+
+        const spanData = spanToJSON(rootSpan);
+
+        if (spanData.data && 'http.target' in spanData.data) {
+          pathname = spanData.data['http.target']?.toString();
+        }
       }
 
       const headersDict = context.headers ? winterCGHeadersToDict(context.headers) : undefined;
 
+      let params: Record<string, string> | undefined = undefined;
+
+      if (getClient()?.getOptions().sendDefaultPii) {
+        const props: unknown = args[0];
+        params =
+          props && typeof props === 'object' && 'params' in props
+            ? (props.params as Record<string, string>)
+            : undefined;
+      }
+
       isolationScope.setSDKProcessingMetadata({
         normalizedRequest: {
           headers: headersDict,
+          url: getSanitizedRequestUrl(componentRoute, params, headersDict, pathname),
         } satisfies RequestEventData,
       });