Skip to content

fix(v8/react): Add support for React Router sub-routes from handle (#17277) #17433

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
onurtemizkan wants to merge 3 commits into
base: v8
Choose a base branch
from
Open

fix(v8/react): Add support for React Router sub-routes from handle (#17277) #17433

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
91044d1
fix(react): Add support for React Router sub-routes from `handle` (#1…
onurtemizkan Aug 8, 2025
156600c
Lint
onurtemizkan Aug 20, 2025
0e2892b
Apply multiple navigations fix
onurtemizkan Sep 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions dev-packages/e2e-tests/test-applications/react-router-7-lazy-routes/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
2 changes: 2 additions & 0 deletions dev-packages/e2e-tests/test-applications/react-router-7-lazy-routes/.npmrc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
@sentry:registry=http://127.0.0.1:4873
@sentry-internal:registry=http://127.0.0.1:4873
53 changes: 53 additions & 0 deletions dev-packages/e2e-tests/test-applications/react-router-7-lazy-routes/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
{
"name": "react-router-7-lazy-routes",
"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"
}
}
7 changes: 7 additions & 0 deletions dev-packages/e2e-tests/test-applications/react-router-7-lazy-routes/playwright.config.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import { getPlaywrightConfig } from '@sentry-internal/test-utils';

const config = getPlaywrightConfig({
startCommand: `pnpm start`,
});

export default config;
24 changes: 24 additions & 0 deletions dev-packages/e2e-tests/test-applications/react-router-7-lazy-routes/public/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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>
5 changes: 5 additions & 0 deletions dev-packages/e2e-tests/test-applications/react-router-7-lazy-routes/src/globals.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
interface Window {
recordedTransactions?: string[];
capturedExceptionId?: string;
sentryReplayId?: string;
}
79 changes: 79 additions & 0 deletions dev-packages/e2e-tests/test-applications/react-router-7-lazy-routes/src/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
import * as Sentry from '@sentry/react';
import React from 'react';
import ReactDOM from 'react-dom/client';
import {
Navigate,
PatchRoutesOnNavigationFunction,
RouterProvider,
createBrowserRouter,
createRoutesFromChildren,
matchRoutes,
useLocation,
useNavigationType,
} from 'react-router-dom';
import Index from './pages/Index';

Sentry.init({
environment: 'qa', // dynamic sampling bias to keep transactions
dsn: process.env.REACT_APP_E2E_TEST_DSN,
integrations: [
Sentry.reactRouterV7BrowserTracingIntegration({
useEffect: React.useEffect,
useLocation,
useNavigationType,
createRoutesFromChildren,
matchRoutes,
trackFetchStreamPerformance: true,
enableAsyncRouteHandlers: true,
}),
],
// We recommend adjusting this value in production, or using tracesSampler
// for finer control
tracesSampleRate: 1.0,
release: 'e2e-test',

tunnel: 'http://localhost:3031',
});

const sentryCreateBrowserRouter = Sentry.wrapCreateBrowserRouterV7(createBrowserRouter);

const router = sentryCreateBrowserRouter(
[
{
path: '/',
element: <Index />,
},
{
path: '/lazy',
handle: {
lazyChildren: () => import('./pages/InnerLazyRoutes').then(module => module.someMoreNestedRoutes),
},
},
{
path: '/another-lazy',
handle: {
lazyChildren: () => import('./pages/AnotherLazyRoutes').then(module => module.anotherNestedRoutes),
},
},
{
path: '/static',
element: <>Hello World</>,
},
{
path: '*',
element: <Navigate to="/" replace />,
},
],
{
async patchRoutesOnNavigation({ matches, patch }: Parameters<PatchRoutesOnNavigationFunction>[0]) {
const leafRoute = matches[matches.length - 1]?.route;
if (leafRoute?.id && leafRoute?.handle?.lazyChildren) {
const children = await leafRoute.handle.lazyChildren();
patch(leafRoute.id, children);
}
},
},
);

const root = ReactDOM.createRoot(document.getElementById('root') as HTMLElement);
root.render(<RouterProvider router={router} />);
42 changes: 42 additions & 0 deletions ...es/e2e-tests/test-applications/react-router-7-lazy-routes/src/pages/AnotherLazyRoutes.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
import { Link } from 'react-router-dom';

export const anotherNestedRoutes = [
{
path: 'sub',
children: [
{
index: true,
element: (
<div id="another-lazy-route">
Another Lazy Route
<Link to="/lazy/inner/999/888/777" id="navigate-to-inner">
Navigate to Inner Lazy Route
</Link>
</div>
),
},
{
path: ':id',
children: [
{
index: true,
element: <div id="another-lazy-route-with-id">Another Lazy Route with ID</div>,
},
{
path: ':subId',
element: (
<div id="another-lazy-route-deep">
Another Deep Lazy Route
<Link to="/lazy/inner/111/222/333" id="navigate-to-inner-from-deep">
Navigate to Inner from Deep
</Link>
</div>
),
},
],
},
],
},
];

export default null as unknown as void;
21 changes: 21 additions & 0 deletions dev-packages/e2e-tests/test-applications/react-router-7-lazy-routes/src/pages/Index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
import { Link } from 'react-router-dom';

const Index = () => {
return (
<>
<Link to="/lazy/inner/123/456/789" id="navigation">
navigate
</Link>
<br />
<Link to="/another-lazy/sub" id="navigation-to-another">
Navigate to Another Lazy Route
</Link>
<br />
<Link to="/another-lazy/sub/555/666" id="navigation-to-another-deep">
Navigate to Another Deep Lazy Route
</Link>
</>
);
};

export default Index;
43 changes: 43 additions & 0 deletions ...ages/e2e-tests/test-applications/react-router-7-lazy-routes/src/pages/InnerLazyRoutes.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
import { Link } from 'react-router-dom';

export const someMoreNestedRoutes = [
{
path: 'inner',
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">
Rendered
<br />
<Link to="/another-lazy/sub/888/999" id="navigate-to-another-from-inner">
Navigate to Another Lazy Route
</Link>
</div>
),
},
],
},
],
},
],
},
];
1 change: 1 addition & 0 deletions dev-packages/e2e-tests/test-applications/react-router-7-lazy-routes/src/react-app-env.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/// <reference types="react-scripts" />
6 changes: 6 additions & 0 deletions dev-packages/e2e-tests/test-applications/react-router-7-lazy-routes/start-event-proxy.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
import { startEventProxyServer } from '@sentry-internal/test-utils';

startEventProxyServer({
port: 3031,
proxyServerName: 'react-router-7-lazy-routes',
});
Loading
Loading