feat(remix): Add parameterized transaction naming for routes

Author: onurtemizkan

dev-packages/e2e-tests/test-applications/create-remix-app-express-vite-dev/tests/client-transactions.test.ts

@@ -3,7 +3,7 @@ import { waitForTransaction } from '@sentry-internal/test-utils';
 
 test('Sends a pageload transaction to Sentry', async ({ page }) => {
   const transactionPromise = waitForTransaction('create-remix-app-express-vite-dev', transactionEvent => {
-    return transactionEvent.contexts?.trace?.op === 'pageload' && transactionEvent.transaction === 'routes/_index';
+    return transactionEvent.contexts?.trace?.op === 'pageload' && transactionEvent.transaction === '/';
   });
 
   await page.goto('/');
@@ -15,7 +15,7 @@ test('Sends a pageload transaction to Sentry', async ({ page }) => {
 
 test('Sends a navigation transaction to Sentry', async ({ page }) => {
   const transactionPromise = waitForTransaction('create-remix-app-express-vite-dev', transactionEvent => {
-    return transactionEvent.contexts?.trace?.op === 'navigation' && transactionEvent.transaction === 'routes/user.$id';
+    return transactionEvent.contexts?.trace?.op === 'navigation' && transactionEvent.transaction === '/user/:id';
   });
 
   await page.goto('/');
@@ -28,6 +28,22 @@ test('Sends a navigation transaction to Sentry', async ({ page }) => {
   expect(transactionEvent).toBeDefined();
 });
 
+test('Sends a navigation transaction with parameterized route to Sentry', async ({ page }) => {
+  const transactionPromise = waitForTransaction('create-remix-app-express-vite-dev', transactionEvent => {
+    return transactionEvent.contexts?.trace?.op === 'navigation';
+  });
+
+  await page.goto('/');
+
+  const linkElement = page.locator('id=navigation');
+  await linkElement.click();
+
+  const transactionEvent = await transactionPromise;
+
+  expect(transactionEvent).toBeDefined();
+  expect(transactionEvent.transaction).toBeTruthy();
+});
+
 test('Renders `sentry-trace` and `baggage` meta tags for the root route', async ({ page }) => {
   await page.goto('/');
 

dev-packages/e2e-tests/test-applications/create-remix-app-express-vite-dev/tests/server-transactions.test.ts

@@ -48,7 +48,7 @@ test('Sends two linked transactions (server & client) to Sentry', async ({ page
   const pageLoadParentSpanId = pageloadTransaction.contexts?.trace?.parent_span_id;
 
   expect(httpServerTransaction.transaction).toBe('GET http://localhost:3030/');
-  expect(pageloadTransaction.transaction).toBe('routes/_index');
+  expect(pageloadTransaction.transaction).toBe('/');
 
   expect(httpServerTraceId).toBeDefined();
   expect(httpServerSpanId).toBeDefined();

dev-packages/e2e-tests/test-applications/create-remix-app-express-vite-dev/vite.config.ts

@@ -1,14 +1,15 @@
+import { installGlobals } from '@remix-run/node';
 import { vitePlugin as remix } from '@remix-run/dev';
+import { sentryRemixVitePlugin } from '@sentry/remix';
 import { defineConfig } from 'vite';
 import tsconfigPaths from 'vite-tsconfig-paths';
 
-import { installGlobals } from '@remix-run/node';
-
 installGlobals();
 
 export default defineConfig({
   plugins: [
     remix(),
+    sentryRemixVitePlugin(),
     tsconfigPaths({
       // The dev server config errors are not relevant to this test app
       // https://github.com/aleclarson/vite-tsconfig-paths?tab=readme-ov-file#options

dev-packages/e2e-tests/test-applications/create-remix-app-express/tests/client-transactions.test.ts

@@ -3,7 +3,7 @@ import { waitForTransaction } from '@sentry-internal/test-utils';
 
 test('Sends a pageload transaction to Sentry', async ({ page }) => {
   const transactionPromise = waitForTransaction('create-remix-app-express', transactionEvent => {
-    return transactionEvent.contexts?.trace?.op === 'pageload' && transactionEvent.transaction === 'routes/_index';
+    return transactionEvent.contexts?.trace?.op === 'pageload' && transactionEvent.transaction === '/';
   });
 
   await page.goto('/');
@@ -15,7 +15,7 @@ test('Sends a pageload transaction to Sentry', async ({ page }) => {
 
 test('Sends a navigation transaction to Sentry', async ({ page }) => {
   const transactionPromise = waitForTransaction('create-remix-app-express', transactionEvent => {
-    return transactionEvent.contexts?.trace?.op === 'navigation' && transactionEvent.transaction === 'routes/user.$id';
+    return transactionEvent.contexts?.trace?.op === 'navigation' && transactionEvent.transaction === '/user/:id';
   });
 
   await page.goto('/');

dev-packages/e2e-tests/test-applications/create-remix-app-express/tests/server-transactions.test.ts

@@ -90,7 +90,7 @@ test('Propagates trace when ErrorBoundary is triggered', async ({ page }) => {
   const pageLoadParentSpanId = pageloadTransaction.contexts?.trace?.parent_span_id;
 
   expect(httpServerTransaction.transaction).toBe('GET client-error');
-  expect(pageloadTransaction.transaction).toBe('routes/client-error');
+  expect(pageloadTransaction.transaction).toBe('/client-error');
 
   expect(httpServerTraceId).toBeDefined();
   expect(httpServerSpanId).toBeDefined();
@@ -132,7 +132,7 @@ test('Sends two linked transactions (server & client) to Sentry', async ({ page
   const pageLoadParentSpanId = pageloadTransaction.contexts?.trace?.parent_span_id;
 
   expect(httpServerTransaction.transaction).toBe('GET http://localhost:3030/');
-  expect(pageloadTransaction.transaction).toBe('routes/_index');
+  expect(pageloadTransaction.transaction).toBe('/');
 
   expect(httpServerTraceId).toBeDefined();
   expect(httpServerSpanId).toBeDefined();

dev-packages/e2e-tests/test-applications/create-remix-app-express/vite.config.ts

@@ -1,14 +1,15 @@
+import { installGlobals } from '@remix-run/node';
 import { vitePlugin as remix } from '@remix-run/dev';
+import { sentryRemixVitePlugin } from '@sentry/remix';
 import { defineConfig } from 'vite';
 import tsconfigPaths from 'vite-tsconfig-paths';
 
-import { installGlobals } from '@remix-run/node';
-
 installGlobals();
 
 export default defineConfig({
   plugins: [
     remix(),
+    sentryRemixVitePlugin(),
     tsconfigPaths({
       // The dev server config errors are not relevant to this test app
       // https://github.com/aleclarson/vite-tsconfig-paths?tab=readme-ov-file#options

dev-packages/e2e-tests/test-applications/create-remix-app-v2-legacy/.eslintrc.js

@@ -0,0 +1,4 @@
+/** @type {import('eslint').Linter.Config} */
+module.exports = {
+  extends: ['@remix-run/eslint-config', '@remix-run/eslint-config/node'],
+};

dev-packages/e2e-tests/test-applications/create-remix-app-v2-legacy/.gitignore

@@ -0,0 +1,6 @@
+node_modules
+
+/.cache
+/build
+/public/build
+.env

dev-packages/e2e-tests/test-applications/create-remix-app-v2-legacy/.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/create-remix-app-v2-legacy/app/entry.client.tsx

@@ -0,0 +1,48 @@
+/**
+ * By default, Remix will handle hydrating your app on the client for you.
+ * You are free to delete this file if you'd like to, but if you ever want it revealed again, you can run `npx remix reveal` ✨
+ * For more information, see https://remix.run/file-conventions/entry.client
+ */
+
+// Extend the Window interface to include ENV
+declare global {
+  interface Window {
+    ENV: {
+      SENTRY_DSN: string;
+      [key: string]: unknown;
+    };
+  }
+}
+
+import { RemixBrowser, useLocation, useMatches } from '@remix-run/react';
+import * as Sentry from '@sentry/remix';
+import { StrictMode, startTransition, useEffect } from 'react';
+import { hydrateRoot } from 'react-dom/client';
+
+Sentry.init({
+  environment: 'qa', // dynamic sampling bias to keep transactions
+  dsn: window.ENV.SENTRY_DSN,
+  integrations: [
+    Sentry.browserTracingIntegration({
+      useEffect,
+      useLocation,
+      useMatches,
+    }),
+    Sentry.replayIntegration(),
+  ],
+  // Performance Monitoring
+  tracesSampleRate: 1.0, // Capture 100% of the transactions, reduce in production!
+  // Session Replay
+  replaysSessionSampleRate: 0.1, // This sets the sample rate at 10%. You may want to change it to 100% while in development and then sample at a lower rate in production.
+  replaysOnErrorSampleRate: 1.0, // If you're not already sampling the entire session, change the sample rate to 100% when sampling sessions where errors occur.
+  tunnel: 'http://localhost:3032/', // proxy server
+});
+
+startTransition(() => {
+  hydrateRoot(
+    document,
+    <StrictMode>
+      <RemixBrowser />
+    </StrictMode>,
+  );
+});