feat(react-router): Add support for React Router instrumentation API

Author: onurtemizkan

dev-packages/e2e-tests/test-applications/react-router-7-framework-instrumentation/.gitignore

@@ -0,0 +1,32 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+/test-results/
+/playwright-report/
+/playwright/.cache/
+
+!*.d.ts
+
+# react router
+.react-router

dev-packages/e2e-tests/test-applications/react-router-7-framework-instrumentation/.npmrc

@@ -0,0 +1,2 @@
+@sentry:registry=http://127.0.0.1:4873
+@sentry-internal:registry=http://127.0.0.1:4873

dev-packages/e2e-tests/test-applications/react-router-7-framework-instrumentation/app/app.css

@@ -0,0 +1,5 @@
+body {
+  font-family: system-ui, sans-serif;
+  margin: 0;
+  padding: 20px;
+}

dev-packages/e2e-tests/test-applications/react-router-7-framework-instrumentation/app/entry.client.tsx

@@ -0,0 +1,33 @@
+import * as Sentry from '@sentry/react-router';
+import { StrictMode, startTransition } from 'react';
+import { hydrateRoot } from 'react-dom/client';
+import { HydratedRouter } from 'react-router/dom';
+
+// Create the tracing integration with useInstrumentationAPI enabled
+// This must be set BEFORE Sentry.init() to prepare the instrumentation
+const tracing = Sentry.reactRouterTracingIntegration({ useInstrumentationAPI: true });
+
+Sentry.init({
+  environment: 'qa', // dynamic sampling bias to keep transactions
+  dsn: 'https://username@domain/123',
+  tunnel: `http://localhost:3031/`, // proxy server
+  integrations: [tracing],
+  tracesSampleRate: 1.0,
+  tracePropagationTargets: [/^\//],
+});
+
+// Get the client instrumentation from the Sentry integration
+// NOTE: As of React Router 7.x, HydratedRouter does NOT invoke these hooks in Framework Mode.
+// The client-side instrumentation is prepared for when React Router adds support.
+// Client-side navigation is currently handled by the legacy instrumentHydratedRouter() approach.
+const sentryClientInstrumentation = [tracing.clientInstrumentation];
+
+startTransition(() => {
+  hydrateRoot(
+    document,
+    <StrictMode>
+      {/* unstable_instrumentations is React Router 7.x's prop name (will become `instrumentations` in v8) */}
+      <HydratedRouter unstable_instrumentations={sentryClientInstrumentation} />
+    </StrictMode>,
+  );
+});

dev-packages/e2e-tests/test-applications/react-router-7-framework-instrumentation/app/entry.server.tsx

@@ -0,0 +1,22 @@
+import { createReadableStreamFromReadable } from '@react-router/node';
+import * as Sentry from '@sentry/react-router';
+import { renderToPipeableStream } from 'react-dom/server';
+import { ServerRouter } from 'react-router';
+import { type HandleErrorFunction } from 'react-router';
+
+const ABORT_DELAY = 5_000;
+
+const handleRequest = Sentry.createSentryHandleRequest({
+  streamTimeout: ABORT_DELAY,
+  ServerRouter,
+  renderToPipeableStream,
+  createReadableStreamFromReadable,
+});
+
+export default handleRequest;
+
+export const handleError: HandleErrorFunction = Sentry.createSentryHandleError({ logErrors: true });
+
+// Use Sentry's instrumentation API for server-side tracing
+// `unstable_instrumentations` is React Router 7.x's export name (will become `instrumentations` in v8)
+export const unstable_instrumentations = [Sentry.createSentryServerInstrumentation()];

dev-packages/e2e-tests/test-applications/react-router-7-framework-instrumentation/app/root.tsx

@@ -0,0 +1,69 @@
+import * as Sentry from '@sentry/react-router';
+import { Links, Meta, Outlet, Scripts, ScrollRestoration, isRouteErrorResponse } from 'react-router';
+import type { Route } from './+types/root';
+import stylesheet from './app.css?url';
+
+export const links: Route.LinksFunction = () => [
+  { rel: 'preconnect', href: 'https://fonts.googleapis.com' },
+  {
+    rel: 'preconnect',
+    href: 'https://fonts.gstatic.com',
+    crossOrigin: 'anonymous',
+  },
+  {
+    rel: 'stylesheet',
+    href: 'https://fonts.googleapis.com/css2?family=Inter:ital,opsz,wght@0,14..32,100..900;1,14..32,100..900&display=swap',
+  },
+  { rel: 'stylesheet', href: stylesheet },
+];
+
+export function Layout({ children }: { children: React.ReactNode }) {
+  return (
+    <html lang="en">
+      <head>
+        <meta charSet="utf-8" />
+        <meta name="viewport" content="width=device-width, initial-scale=1" />
+        <Meta />
+        <Links />
+      </head>
+      <body>
+        {children}
+        <ScrollRestoration />
+        <Scripts />
+      </body>
+    </html>
+  );
+}
+
+export default function App() {
+  return <Outlet />;
+}
+
+export function ErrorBoundary({ error }: Route.ErrorBoundaryProps) {
+  let message = 'Oops!';
+  let details = 'An unexpected error occurred.';
+  let stack: string | undefined;
+
+  if (isRouteErrorResponse(error)) {
+    message = error.status === 404 ? '404' : 'Error';
+    details = error.status === 404 ? 'The requested page could not be found.' : error.statusText || details;
+  } else if (error && error instanceof Error) {
+    Sentry.captureException(error);
+    if (import.meta.env.DEV) {
+      details = error.message;
+      stack = error.stack;
+    }
+  }
+
+  return (
+    <main className="pt-16 p-4 container mx-auto">
+      <h1>{message}</h1>
+      <p>{details}</p>
+      {stack && (
+        <pre className="w-full p-4 overflow-x-auto">
+          <code>{stack}</code>
+        </pre>
+      )}
+    </main>
+  );
+}

dev-packages/e2e-tests/test-applications/react-router-7-framework-instrumentation/app/routes.ts

@@ -0,0 +1,16 @@
+import { type RouteConfig, index, prefix, route } from '@react-router/dev/routes';
+
+export default [
+  index('routes/home.tsx'),
+  ...prefix('performance', [
+    index('routes/performance/index.tsx'),
+    route('ssr', 'routes/performance/ssr.tsx'),
+    route('with/:param', 'routes/performance/dynamic-param.tsx'),
+    route('static', 'routes/performance/static.tsx'),
+    route('server-loader', 'routes/performance/server-loader.tsx'),
+    route('server-action', 'routes/performance/server-action.tsx'),
+    route('with-middleware', 'routes/performance/with-middleware.tsx'),
+    route('error-loader', 'routes/performance/error-loader.tsx'),
+    route('lazy-route', 'routes/performance/lazy-route.tsx'),
+  ]),
+] satisfies RouteConfig;

dev-packages/e2e-tests/test-applications/react-router-7-framework-instrumentation/app/routes/home.tsx

@@ -0,0 +1,12 @@
+import type { Route } from './+types/home';
+
+export function meta({}: Route.MetaArgs) {
+  return [
+    { title: 'React Router Instrumentation API Test' },
+    { name: 'description', content: 'Testing React Router instrumentation API' },
+  ];
+}
+
+export default function Home() {
+  return <div>home</div>;
+}

dev-packages/e2e-tests/test-applications/react-router-7-framework-instrumentation/app/routes/performance/dynamic-param.tsx

@@ -0,0 +1,16 @@
+import type { Route } from './+types/dynamic-param';
+
+// Minimal loader to trigger Sentry's route instrumentation
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+export function loader() {
+  return null;
+}
+
+export default function DynamicParamPage({ params }: Route.ComponentProps) {
+  return (
+    <div>
+      <h1>Dynamic Param Page</h1>
+      <div>Param: {params.param}</div>
+    </div>
+  );
+}

dev-packages/e2e-tests/test-applications/react-router-7-framework-instrumentation/app/routes/performance/error-loader.tsx

@@ -0,0 +1,12 @@
+export function loader(): never {
+  throw new Error('Loader error for testing');
+}
+
+export default function ErrorLoaderPage() {
+  return (
+    <div>
+      <h1>Error Loader Page</h1>
+      <p>This should not render</p>
+    </div>
+  );
+}