fix(react): Add support for React Router sub-routes from handle

Author: onurtemizkan

dev-packages/e2e-tests/test-applications/react-router-6/tests/lazy.test.ts

@@ -0,0 +1,37 @@
+import { expect, test } from '@playwright/test';
+import { waitForTransaction } from '@sentry-internal/test-utils';
+
+test('should capture pageload transaction for lazy route', async ({ page }) => {
+  const transactionPromise = waitForTransaction('react-router-6', async transactionEvent => {
+    return (
+      !!transactionEvent?.transaction &&
+      transactionEvent.contexts?.trace?.op === 'pageload' &&
+      transactionEvent.transaction === '/lazy/inner-lazy/inner'
+    );
+  });
+
+  // Navigate to a lazy-loaded route - try just /lazy first
+  await page.goto('/lazy');
+
+  // Debug: Check what's actually rendered on the page
+  const pageContent = await page.content();
+  console.log('Page content for /lazy:', pageContent);
+
+  // Check if any content is rendered - use a more general selector
+  await page.waitForLoadState('networkidle');
+  const bodyContent = await page.locator('body').innerHTML();
+  console.log('Body content:', bodyContent);
+
+  // Try to navigate to the full nested path
+  await page.goto('/lazy/inner-lazy/inner');
+  await page.waitForLoadState('networkidle');
+
+  const nestedPageContent = await page.content();
+  console.log('Nested page content:', nestedPageContent);
+
+  const event = await transactionPromise;
+
+  expect(event.transaction).toBe('/lazy/inner-lazy');
+  expect(event.type).toBe('transaction');
+  expect(event.contexts?.trace?.op).toBe('pageload');
+});

dev-packages/e2e-tests/test-applications/react-router-7-cross-usage/src/index.tsx

@@ -77,6 +77,19 @@ const ViewsRoutes = () =>
     },
   ]);
 
+const LazyRoutes = () =>
+  sentryUseRoutes([
+    {
+      path: 'inner-lazy',
+      handle: {
+        lazyChildren: async () =>
+          import('./pages/InnerLazyRoutes').then(
+            (module) => module.someMoreNestedRoutes,
+          ),
+      },
+    }
+  ]);
+
 const ProjectsRoutes = () => (
   <SentryRoutes>
     <Route path="projects" element={<Outlet />}>
@@ -85,6 +98,7 @@ const ProjectsRoutes = () => (
         <Route path=":projectId/*" element={<ViewsRoutes />} />
       </Route>
     </Route>
+    <Route path="/lazy/*" element={<LazyRoutes />} />
   </SentryRoutes>
 );
 

dev-packages/e2e-tests/test-applications/react-router-7-cross-usage/src/pages/InnerLazyRoutes.tsx

@@ -0,0 +1,37 @@
+import React from 'react';
+
+export const someMoreNestedRoutes = [
+  {
+    path: 'level-1',
+    children: [
+      {
+        index: true,
+        element: <>Level 1</>,
+      },
+      {
+        path: ':id',
+        children: [
+          {
+            index: true,
+            element: <>Level 1 ID</>,
+          },
+          {
+            path: ':anotherId',
+            children: [
+              {
+                index: true,
+                element: <>Level 1 ID Another ID</>,
+              },
+              {
+                path: ':someAnotherId',
+                element: <div id="innermost-lazy-route">
+                  Level 1 ID Another ID Some Another ID
+                </div>,
+              },
+            ],
+          },
+        ],
+      },
+    ],
+  },
+];

dev-packages/e2e-tests/test-applications/react-router-7-cross-usage/tests/transactions.test.ts

@@ -136,3 +136,26 @@ test('sends a navigation transaction with a parameterized URL - alternative rout
     },
   });
 });
+
+test('sends a pageload transaction for lazy route', async ({ page }) => {
+  const transactionPromise = waitForTransaction('react-router-7-cross-usage', async transactionEvent => {
+    console.debug('Lazy route transaction event', transactionEvent);
+    return (
+      !!transactionEvent?.transaction &&
+      transactionEvent.contexts?.trace?.op === 'pageload' &&
+      transactionEvent.transaction === '/lazy/inner-lazy/inner-inner-lazy'
+    );
+  });
+
+  // Try to navigate to the full nested path
+  await page.goto('/lazy/level-1/123/456/789');
+
+  console.debug('Navigated to lazy route');
+  console.debug('ROOT', await page.innerHTML('#root'));
+
+  const event = await transactionPromise;
+
+  expect(event.transaction).toBe('/lazy/inner-lazy/inner-inner-lazy');
+  expect(event.type).toBe('transaction');
+  expect(event.contexts?.trace?.op).toBe('pageload');
+});

dev-packages/e2e-tests/test-applications/react-router-7-lazy-routes/.gitignore

@@ -0,0 +1,29 @@
+# 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

dev-packages/e2e-tests/test-applications/react-router-7-lazy-routes/.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-lazy-routes/package.json

@@ -0,0 +1,53 @@
+{
+  "name": "react-router-7-cross-usage",
+  "version": "0.1.0",
+  "private": true,
+  "dependencies": {
+    "@sentry/react": "latest || *",
+    "@types/react": "18.0.0",
+    "@types/react-dom": "18.0.0",
+    "express": "4.20.0",
+    "react": "18.2.0",
+    "react-dom": "18.2.0",
+    "react-router-dom": "7.6.0",
+    "react-scripts": "5.0.1",
+    "typescript": "~5.0.0"
+  },
+  "scripts": {
+    "build": "react-scripts build",
+    "start": "serve -s build",
+    "test": "playwright test",
+    "clean": "npx rimraf node_modules pnpm-lock.yaml",
+    "test:build": "pnpm install && npx playwright install && pnpm build",
+    "test:build-ts3.8": "pnpm install && pnpm add [email protected] && npx playwright install && pnpm build",
+    "test:build-canary": "pnpm install && pnpm add react@canary react-dom@canary && npx playwright install && pnpm build",
+    "test:assert": "pnpm test"
+  },
+  "eslintConfig": {
+    "extends": [
+      "react-app",
+      "react-app/jest"
+    ]
+  },
+  "browserslist": {
+    "production": [
+      ">0.2%",
+      "not dead",
+      "not op_mini all"
+    ],
+    "development": [
+      "last 1 chrome version",
+      "last 1 firefox version",
+      "last 1 safari version"
+    ]
+  },
+  "devDependencies": {
+    "@playwright/test": "~1.53.2",
+    "@sentry-internal/test-utils": "link:../../../test-utils",
+    "serve": "14.0.1",
+    "npm-run-all2": "^6.2.0"
+  },
+  "volta": {
+    "extends": "../../package.json"
+  }
+}

dev-packages/e2e-tests/test-applications/react-router-7-lazy-routes/playwright.config.mjs

@@ -0,0 +1,7 @@
+import { getPlaywrightConfig } from '@sentry-internal/test-utils';
+
+const config = getPlaywrightConfig({
+  startCommand: `pnpm start`,
+});
+
+export default config;

dev-packages/e2e-tests/test-applications/react-router-7-lazy-routes/public/index.html

@@ -0,0 +1,24 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="theme-color" content="#000000" />
+    <meta name="description" content="Web site created using create-react-app" />
+    <title>React App</title>
+  </head>
+  <body>
+    <noscript>You need to enable JavaScript to run this app.</noscript>
+    <div id="root"></div>
+    <!--
+      This HTML file is a template.
+      If you open it directly in the browser, you will see an empty page.
+
+      You can add webfonts, meta tags, or analytics to this file.
+      The build step will place the bundled scripts into the <body> tag.
+
+      To begin the development, run `npm start` or `yarn start`.
+      To create a production bundle, use `npm run build` or `yarn build`.
+    -->
+  </body>
+</html>

dev-packages/e2e-tests/test-applications/react-router-7-lazy-routes/src/globals.d.ts

@@ -0,0 +1,5 @@
+interface Window {
+  recordedTransactions?: string[];
+  capturedExceptionId?: string;
+  sentryReplayId?: string;
+}