-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
fix(react): Add support for React Router sub-routes from handle
#17277
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.
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
Merged
Merged
Changes from 8 commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
0febe4f
fix(react): Add support for React Router sub-routes from `handle`
onurtemizkan 0c5f0bc
Make the implementation more readable.
onurtemizkan 244a953
Remove updates on other test apps.
onurtemizkan d8216c1
Simplify
onurtemizkan 06e535e
Add support for parameterized `pageload` transactions
onurtemizkan e968adf
Prevent duplicate children in `addResolvedRoutesToParent`
onurtemizkan 2e0a521
Only run async handler checks when it's enabled on the integration
onurtemizkan 739e50a
Add JSDocs for `stripBasename` and `enableAsyncRouteHandlers`
onurtemizkan 8815203
Remove replay from e2e test app
onurtemizkan 1bb1630
Remove unnecessary escape
onurtemizkan File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
29 changes: 29 additions & 0 deletions
29
dev-packages/e2e-tests/test-applications/react-router-7-lazy-routes/.gitignore
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
2
dev-packages/e2e-tests/test-applications/react-router-7-lazy-routes/.npmrc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
53
dev-packages/e2e-tests/test-applications/react-router-7-lazy-routes/package.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
7
dev-packages/e2e-tests/test-applications/react-router-7-lazy-routes/playwright.config.mjs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
24
dev-packages/e2e-tests/test-applications/react-router-7-lazy-routes/public/index.html
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
5
dev-packages/e2e-tests/test-applications/react-router-7-lazy-routes/src/globals.d.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
interface Window { | ||
recordedTransactions?: string[]; | ||
capturedExceptionId?: string; | ||
sentryReplayId?: string; | ||
} |
80 changes: 80 additions & 0 deletions
80
dev-packages/e2e-tests/test-applications/react-router-7-lazy-routes/src/index.tsx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,80 @@ | ||
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'; | ||
|
||
const replay = Sentry.replayIntegration(); | ||
|
||
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, | ||
}), | ||
replay, | ||
cursor[bot] marked this conversation as resolved.
Show resolved
Hide resolved
|
||
], | ||
// We recommend adjusting this value in production, or using tracesSampler | ||
// for finer control | ||
tracesSampleRate: 1.0, | ||
release: 'e2e-test', | ||
|
||
// Always capture replays, so we can test this properly | ||
replaysSessionSampleRate: 1.0, | ||
replaysOnErrorSampleRate: 0.0, | ||
|
||
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: '/static', | ||
element: <>Hello World</>, | ||
}, | ||
{ | ||
path: '*', | ||
element: <Navigate to="/\" replace />, | ||
cursor[bot] marked this conversation as resolved.
Show resolved
Hide resolved
|
||
}, | ||
], | ||
{ | ||
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} />); |
14 changes: 14 additions & 0 deletions
14
dev-packages/e2e-tests/test-applications/react-router-7-lazy-routes/src/pages/Index.tsx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
import * as React from 'react'; | ||
import { Link } from 'react-router-dom'; | ||
|
||
const Index = () => { | ||
return ( | ||
<> | ||
<Link to="/lazy/inner/123/456/789" id="navigation"> | ||
navigate | ||
</Link> | ||
</> | ||
); | ||
}; | ||
|
||
export default Index; |
37 changes: 37 additions & 0 deletions
37
...ages/e2e-tests/test-applications/react-router-7-lazy-routes/src/pages/InnerLazyRoutes.tsx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
import React from 'react'; | ||
|
||
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 | ||
</div>, | ||
}, | ||
], | ||
}, | ||
], | ||
}, | ||
], | ||
}, | ||
]; |
1 change: 1 addition & 0 deletions
1
dev-packages/e2e-tests/test-applications/react-router-7-lazy-routes/src/react-app-env.d.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
/// <reference types="react-scripts" /> |
6 changes: 6 additions & 0 deletions
6
dev-packages/e2e-tests/test-applications/react-router-7-lazy-routes/start-event-proxy.mjs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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', | ||
}); |
56 changes: 56 additions & 0 deletions
56
...ackages/e2e-tests/test-applications/react-router-7-lazy-routes/tests/transactions.test.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
import { expect, test } from '@playwright/test'; | ||
import { waitForTransaction } from '@sentry-internal/test-utils'; | ||
|
||
|
||
test('Creates a pageload transaction with parameterized route', async ({ page }) => { | ||
const transactionPromise = waitForTransaction('react-router-7-lazy-routes', async transactionEvent => { | ||
return ( | ||
!!transactionEvent?.transaction && | ||
transactionEvent.contexts?.trace?.op === 'pageload' && | ||
transactionEvent.transaction === '/lazy/inner/:id/:anotherId/:someAnotherId' | ||
); | ||
}); | ||
|
||
await page.goto('/lazy/inner/1/2/3'); | ||
const event = await transactionPromise; | ||
|
||
|
||
const lazyRouteContent = page.locator('id=innermost-lazy-route'); | ||
|
||
await expect(lazyRouteContent).toBeVisible(); | ||
|
||
// Validate the transaction event | ||
expect(event.transaction).toBe('/lazy/inner/:id/:anotherId/:someAnotherId'); | ||
expect(event.type).toBe('transaction'); | ||
expect(event.contexts?.trace?.op).toBe('pageload'); | ||
}); | ||
|
||
test('Creates a navigation transaction inside a lazy route', async ({ page }) => { | ||
const transactionPromise = waitForTransaction('react-router-7-lazy-routes', async transactionEvent => { | ||
return ( | ||
!!transactionEvent?.transaction && | ||
transactionEvent.contexts?.trace?.op === 'navigation' && | ||
transactionEvent.transaction === '/lazy/inner/:id/:anotherId/:someAnotherId' | ||
); | ||
}); | ||
|
||
await page.goto('/'); | ||
|
||
// Check if the navigation link exists | ||
const navigationLink = page.locator('id=navigation'); | ||
await expect(navigationLink).toBeVisible(); | ||
|
||
// Click the navigation link to navigate to the lazy route | ||
await navigationLink.click(); | ||
const event = await transactionPromise; | ||
|
||
// Check if the lazy route content is rendered | ||
const lazyRouteContent = page.locator('id=innermost-lazy-route'); | ||
|
||
await expect(lazyRouteContent).toBeVisible(); | ||
|
||
// Validate the transaction event | ||
expect(event.transaction).toBe('/lazy/inner/:id/:anotherId/:someAnotherId'); | ||
expect(event.type).toBe('transaction'); | ||
expect(event.contexts?.trace?.op).toBe('navigation'); | ||
}); |
20 changes: 20 additions & 0 deletions
20
dev-packages/e2e-tests/test-applications/react-router-7-lazy-routes/tsconfig.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
{ | ||
"compilerOptions": { | ||
"target": "es2018", | ||
"lib": ["dom", "dom.iterable", "esnext"], | ||
"allowJs": true, | ||
"skipLibCheck": true, | ||
"esModuleInterop": true, | ||
"allowSyntheticDefaultImports": true, | ||
"strict": true, | ||
"forceConsistentCasingInFileNames": true, | ||
"noFallthroughCasesInSwitch": true, | ||
"module": "esnext", | ||
"moduleResolution": "node", | ||
"resolveJsonModule": true, | ||
"isolatedModules": true, | ||
"noEmit": true, | ||
"jsx": "react" | ||
}, | ||
"include": ["src", "tests"] | ||
} |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.