fix(react): Add React Router Descendant Routes support.#14304

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

Merged
chargome merged 13 commits into from
Dec 12, 2024
Merged

fix(react): Add React Router Descendant Routes support. #14304

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
0324eb7
fix(react): Add React Router Descendant Routes support.
onurtemizkan Nov 14, 2024
86a3e65
Add an E2E test.
onurtemizkan Nov 22, 2024
0521399
Alternative implementation.
onurtemizkan Nov 22, 2024
e20f219
Switch back to the original implementation.
onurtemizkan Nov 28, 2024
0ebdf39
Lint
onurtemizkan Nov 28, 2024
23b8c36
Update e2e tests.
onurtemizkan Nov 28, 2024
a39c8ff
Switch to `useRef` in `wrapUseRoutes`.
onurtemizkan Nov 28, 2024
d9f9962
Reimplement descendant routes handling
onurtemizkan Dec 3, 2024
37fafae
Optimize
onurtemizkan Dec 4, 2024
ac005f8
Cleanup
onurtemizkan Dec 4, 2024
4ec53c8
Update `useRoutes` tests.
onurtemizkan Dec 4, 2024
89751f0
Update e2e tests.
onurtemizkan Dec 4, 2024
6184b27
Review updates
onurtemizkan Dec 11, 2024
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-6-descendant-routes/.gitignore
View file
Open in desktop
Original file line numberDiff line numberDiff 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-6-descendant-routes/.npmrc
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
@sentry:registry=http://127.0.0.1:4873
@sentry-internal:registry=http://127.0.0.1:4873
55 changes: 55 additions & 0 deletions dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
{
"name": "react-router-6-descendant-routes",
"version": "0.1.0",
"private": true,
"dependencies": {
"@sentry/react": "latest || *",
"@types/react": "18.0.0",
"@types/react-dom": "18.0.0",
"express": "4.19.2",
"react": "18.2.0",
"react-dom": "18.2.0",
"react-router-dom": "^6.28.0",
"react-scripts": "5.0.1",
"typescript": "4.9.5"
},
"scripts": {
"build": "react-scripts build",
"start": "run-p start:client start:server",
"start:client": "node server/app.js",
"start:server": "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 typescript@3.8 && 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.44.1",
"@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 ...ckages/e2e-tests/test-applications/react-router-6-descendant-routes/playwright.config.mjs
View file
Open in desktop
Original file line numberDiff line numberDiff 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-6-descendant-routes/public/index.html
View file
Open in desktop
Original file line numberDiff line numberDiff 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>
47 changes: 47 additions & 0 deletions dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/server/app.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
const express = require('express');

const app = express();
const PORT = 8080;

const wait = time => {
return new Promise(resolve => {
setTimeout(() => {
resolve();
}, time);
});
};

async function sseHandler(request, response, timeout = false) {
response.headers = {
'Content-Type': 'text/event-stream',
Connection: 'keep-alive',
'Cache-Control': 'no-cache',
'Access-Control-Allow-Origin': '*',
};

response.setHeader('Cache-Control', 'no-cache');
response.setHeader('Content-Type', 'text/event-stream');
response.setHeader('Access-Control-Allow-Origin', '*');
response.setHeader('Connection', 'keep-alive');

response.flushHeaders();

await wait(2000);

for (let index = 0; index < 10; index++) {
response.write(`data: ${new Date().toISOString()}\n\n`);
if (timeout) {
await wait(10000);
}
}

response.end();
}

app.get('/sse', (req, res) => sseHandler(req, res));

app.get('/sse-timeout', (req, res) => sseHandler(req, res, true));

app.listen(PORT, () => {
console.log(`SSE service listening at http://localhost:${PORT}`);
});
5 changes: 5 additions & 0 deletions dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/src/globals.d.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
interface Window {
recordedTransactions?: string[];
capturedExceptionId?: string;
sentryReplayId?: string;
}
73 changes: 73 additions & 0 deletions dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/src/index.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
import * as Sentry from '@sentry/react';
import React from 'react';
import ReactDOM from 'react-dom/client';
import {
BrowserRouter,
Route,
Routes,
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.reactRouterV6BrowserTracingIntegration({
useEffect: React.useEffect,
useLocation,
useNavigationType,
createRoutesFromChildren,
matchRoutes,
trackFetchStreamPerformance: true,
}),
replay,
],
// 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 SentryRoutes = Sentry.withSentryReactRouterV6Routing(Routes);

const DetailsRoutes = () => (
<SentryRoutes>
<Route path=":detailId" element={<div id="details">Details</div>} />
</SentryRoutes>
);

const ViewsRoutes = () => (
<SentryRoutes>
<Route index element={<div id="views">Views</div>} />
<Route path="views/:viewId/*" element={<DetailsRoutes />} />
</SentryRoutes>
);

const ProjectsRoutes = () => (
<SentryRoutes>
<Route path="projects/:projectId/*" element={<ViewsRoutes />}></Route>
<Route path="*" element={<div>No Match Page</div>} />
</SentryRoutes>
);

const root = ReactDOM.createRoot(document.getElementById('root') as HTMLElement);
root.render(
<BrowserRouter>
<SentryRoutes>
<Route path="/" element={<Index />} />
<Route path="/*" element={<ProjectsRoutes />}></Route>
</SentryRoutes>
</BrowserRouter>,
);
15 changes: 15 additions & 0 deletions ...packages/e2e-tests/test-applications/react-router-6-descendant-routes/src/pages/Index.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
// biome-ignore lint/nursery/noUnusedImports: Need React import for JSX
import * as React from 'react';
import { Link } from 'react-router-dom';

const Index = () => {
return (
<>
<Link to="/projects/123/views/456/789" id="navigation">
navigate
</Link>
</>
);
};

export default Index;
1 change: 1 addition & 0 deletions ...kages/e2e-tests/test-applications/react-router-6-descendant-routes/src/react-app-env.d.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
/// <reference types="react-scripts" />
6 changes: 6 additions & 0 deletions ...ckages/e2e-tests/test-applications/react-router-6-descendant-routes/start-event-proxy.mjs
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
import { startEventProxyServer } from '@sentry-internal/test-utils';

startEventProxyServer({
port: 3031,
proxyServerName: 'react-router-6-descendant-routes',
});
67 changes: 67 additions & 0 deletions ...s/e2e-tests/test-applications/react-router-6-descendant-routes/tests/transactions.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';

test('sends a pageload transaction with a parameterized URL', async ({ page }) => {
const transactionPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
});

await page.goto(`/projects/123/views/234/567`);

const rootSpan = await transactionPromise;

expect(rootSpan).toMatchObject({
contexts: {
trace: {
op: 'pageload',
origin: 'auto.pageload.react.reactrouter_v6',
},
},
transaction: '/projects/:projectId/views/:viewId/:detailId',
transaction_info: {
source: 'route',
},
});
});

test('sends a navigation transaction with a parameterized URL', async ({ page }) => {
const pageloadTxnPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
});

const navigationTxnPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'navigation';
});

await page.goto(`/`);
const pageloadTxn = await pageloadTxnPromise;

expect(pageloadTxn).toMatchObject({
contexts: {
trace: {
op: 'pageload',
origin: 'auto.pageload.react.reactrouter_v6',
},
},
transaction: '/',
transaction_info: {
source: 'route',
},
});

const linkElement = page.locator('id=navigation');

const [_, navigationTxn] = await Promise.all([linkElement.click(), navigationTxnPromise]);
expect(navigationTxn).toMatchObject({
contexts: {
trace: {
op: 'navigation',
origin: 'auto.navigation.react.reactrouter_v6',
},
},
transaction: '/projects/:projectId/views/:viewId/:detailId',
transaction_info: {
source: 'route',
},
});
});
20 changes: 20 additions & 0 deletions dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/tsconfig.json
View file
Open in desktop
Original file line numberDiff line numberDiff 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"]
}
3 changes: 1 addition & 2 deletions packages/react/package.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -67,8 +67,7 @@
"react-router-3": "npm:react-router@3.2.0",
"react-router-4": "npm:react-router@4.1.0",
"react-router-5": "npm:react-router@5.0.0",
"react-router-6": "npm:react-router@6.3.0",
"react-router-6.4": "npm:react-router@6.4.2",
"react-router-6": "npm:react-router@6.28.0",
"redux": "^4.0.5"
},
"scripts": {
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
fix(react): Add React Router Descendant Routes support.#14304

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

 Merged

chargome
merged 13 commits into

from

Dec 12, 2024
 Merged


fix(react): Add React Router Descendant Routes support.
#14304
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


13 commits


Select commit
Hold shift + click to select a range
0324eb7

fix(react): Add React Router Descendant Routes support.


onurtemizkan Nov 14, 2024
86a3e65

Add an E2E test.


onurtemizkan Nov 22, 2024
0521399

Alternative implementation.


onurtemizkan Nov 22, 2024
e20f219

Switch back to the original implementation.


onurtemizkan Nov 28, 2024
0ebdf39

Lint


onurtemizkan Nov 28, 2024
23b8c36

Update e2e tests.


onurtemizkan Nov 28, 2024
a39c8ff

Switch to `useRef` in `wrapUseRoutes`.


onurtemizkan Nov 28, 2024
d9f9962

Reimplement descendant routes handling


onurtemizkan Dec 3, 2024
37fafae

Optimize


onurtemizkan Dec 4, 2024
ac005f8

Cleanup


onurtemizkan Dec 4, 2024
4ec53c8

Update `useRoutes` tests.


onurtemizkan Dec 4, 2024
89751f0

Update e2e tests.


onurtemizkan Dec 4, 2024
6184b27

Review updates


onurtemizkan Dec 11, 2024

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-6-descendant-routes/.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff 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-6-descendant-routes/.npmrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
@sentry:registry=http://127.0.0.1:4873
@sentry-internal:registry=http://127.0.0.1:4873

55 changes: 55 additions & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
{
 "name": "react-router-6-descendant-routes",
 "version": "0.1.0",
 "private": true,
 "dependencies": {
 "@sentry/react": "latest || *",
 "@types/react": "18.0.0",
 "@types/react-dom": "18.0.0",
 "express": "4.19.2",
 "react": "18.2.0",
 "react-dom": "18.2.0",
 "react-router-dom": "^6.28.0",
 "react-scripts": "5.0.1",
 "typescript": "4.9.5"
 },
 "scripts": {
 "build": "react-scripts build",
 "start": "run-p start:client start:server",
 "start:client": "node server/app.js",
 "start:server": "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 typescript@3.8 && 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.44.1",
 "@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
...ckages/e2e-tests/test-applications/react-router-6-descendant-routes/playwright.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff 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-6-descendant-routes/public/index.html

View file


Open in desktop

Original file line numberDiff line numberDiff 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>

47 changes: 47 additions & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/server/app.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
const express = require('express');

const app = express();
const PORT = 8080;

const wait = time => {
 return new Promise(resolve => {
 setTimeout(() => {
 resolve();
 }, time);
 });
};

async function sseHandler(request, response, timeout = false) {
 response.headers = {
 'Content-Type': 'text/event-stream',
 Connection: 'keep-alive',
 'Cache-Control': 'no-cache',
 'Access-Control-Allow-Origin': '*',
 };

 response.setHeader('Cache-Control', 'no-cache');
 response.setHeader('Content-Type', 'text/event-stream');
 response.setHeader('Access-Control-Allow-Origin', '*');
 response.setHeader('Connection', 'keep-alive');

 response.flushHeaders();

 await wait(2000);

 for (let index = 0; index < 10; index++) {
 response.write(`data: ${new Date().toISOString()}\n\n`);
 if (timeout) {
 await wait(10000);
 }
 }

 response.end();
}

app.get('/sse', (req, res) => sseHandler(req, res));

app.get('/sse-timeout', (req, res) => sseHandler(req, res, true));

app.listen(PORT, () => {
 console.log(`SSE service listening at http://localhost:${PORT}`);
});

5 changes: 5 additions & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/src/globals.d.ts

View file


Open in desktop

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

73 changes: 73 additions & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/src/index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
import * as Sentry from '@sentry/react';
import React from 'react';
import ReactDOM from 'react-dom/client';
import {
 BrowserRouter,
 Route,
 Routes,
 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.reactRouterV6BrowserTracingIntegration({
 useEffect: React.useEffect,
 useLocation,
 useNavigationType,
 createRoutesFromChildren,
 matchRoutes,
 trackFetchStreamPerformance: true,
 }),
 replay,
 ],
 // 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 SentryRoutes = Sentry.withSentryReactRouterV6Routing(Routes);

const DetailsRoutes = () => (
 <SentryRoutes>
 <Route path=":detailId" element={<div id="details">Details</div>} />
 </SentryRoutes>
);

const ViewsRoutes = () => (
 <SentryRoutes>
 <Route index element={<div id="views">Views</div>} />
 <Route path="views/:viewId/*" element={<DetailsRoutes />} />
 </SentryRoutes>
);

const ProjectsRoutes = () => (
 <SentryRoutes>
 <Route path="projects/:projectId/*" element={<ViewsRoutes />}></Route>
 <Route path="*" element={<div>No Match Page</div>} />
 </SentryRoutes>
);

const root = ReactDOM.createRoot(document.getElementById('root') as HTMLElement);
root.render(
 <BrowserRouter>
 <SentryRoutes>
 <Route path="/" element={<Index />} />
 <Route path="/*" element={<ProjectsRoutes />}></Route>
 </SentryRoutes>
 </BrowserRouter>,
);

15 changes: 15 additions & 0 deletions
...packages/e2e-tests/test-applications/react-router-6-descendant-routes/src/pages/Index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
// biome-ignore lint/nursery/noUnusedImports: Need React import for JSX
import * as React from 'react';
import { Link } from 'react-router-dom';

const Index = () => {
 return (
 <>
 <Link to="/projects/123/views/456/789" id="navigation">
 navigate
 </Link>
 </>
 );
};

export default Index;

1 change: 1 addition & 0 deletions
...kages/e2e-tests/test-applications/react-router-6-descendant-routes/src/react-app-env.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
/// <reference types="react-scripts" />

6 changes: 6 additions & 0 deletions
...ckages/e2e-tests/test-applications/react-router-6-descendant-routes/start-event-proxy.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
import { startEventProxyServer } from '@sentry-internal/test-utils';

startEventProxyServer({
 port: 3031,
 proxyServerName: 'react-router-6-descendant-routes',
});

67 changes: 67 additions & 0 deletions
...s/e2e-tests/test-applications/react-router-6-descendant-routes/tests/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';

test('sends a pageload transaction with a parameterized URL', async ({ page }) => {
 const transactionPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
 });

 await page.goto(`/projects/123/views/234/567`);

 const rootSpan = await transactionPromise;

 expect(rootSpan).toMatchObject({
 contexts: {
 trace: {
 op: 'pageload',
 origin: 'auto.pageload.react.reactrouter_v6',
 },
 },
 transaction: '/projects/:projectId/views/:viewId/:detailId',
 transaction_info: {
 source: 'route',
 },
 });
});

test('sends a navigation transaction with a parameterized URL', async ({ page }) => {
 const pageloadTxnPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
 });

 const navigationTxnPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'navigation';
 });

 await page.goto(`/`);
 const pageloadTxn = await pageloadTxnPromise;

 expect(pageloadTxn).toMatchObject({
 contexts: {
 trace: {
 op: 'pageload',
 origin: 'auto.pageload.react.reactrouter_v6',
 },
 },
 transaction: '/',
 transaction_info: {
 source: 'route',
 },
 });

 const linkElement = page.locator('id=navigation');

 const [_, navigationTxn] = await Promise.all([linkElement.click(), navigationTxnPromise]);
 expect(navigationTxn).toMatchObject({
 contexts: {
 trace: {
 op: 'navigation',
 origin: 'auto.navigation.react.reactrouter_v6',
 },
 },
 transaction: '/projects/:projectId/views/:viewId/:detailId',
 transaction_info: {
 source: 'route',
 },
 });
});

20 changes: 20 additions & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/tsconfig.json

View file


Open in desktop

Original file line numberDiff line numberDiff 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"]
}

3 changes: 1 addition & 2 deletions
packages/react/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,8 +67,7 @@
 "react-router-3": "npm:react-router@3.2.0",
 "react-router-4": "npm:react-router@4.1.0",
 "react-router-5": "npm:react-router@5.0.0",
 "react-router-6": "npm:react-router@6.3.0",
 "react-router-6.4": "npm:react-router@6.4.2",
 "react-router-6": "npm:react-router@6.28.0",
 "redux": "^4.0.5"
 },
 "scripts": {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(react): Add React Router Descendant Routes support.#14304

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

 Merged

chargome
merged 13 commits into

from

Dec 12, 2024
 Merged


fix(react): Add React Router Descendant Routes support.
#14304
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


13 commits


Select commit
Hold shift + click to select a range
0324eb7

fix(react): Add React Router Descendant Routes support.


onurtemizkan Nov 14, 2024
86a3e65

Add an E2E test.


onurtemizkan Nov 22, 2024
0521399

Alternative implementation.


onurtemizkan Nov 22, 2024
e20f219

Switch back to the original implementation.


onurtemizkan Nov 28, 2024
0ebdf39

Lint


onurtemizkan Nov 28, 2024
23b8c36

Update e2e tests.


onurtemizkan Nov 28, 2024
a39c8ff

Switch to `useRef` in `wrapUseRoutes`.


onurtemizkan Nov 28, 2024
d9f9962

Reimplement descendant routes handling


onurtemizkan Dec 3, 2024
37fafae

Optimize


onurtemizkan Dec 4, 2024
ac005f8

Cleanup


onurtemizkan Dec 4, 2024
4ec53c8

Update `useRoutes` tests.


onurtemizkan Dec 4, 2024
89751f0

Update e2e tests.


onurtemizkan Dec 4, 2024
6184b27

Review updates


onurtemizkan Dec 11, 2024

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-6-descendant-routes/.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff 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-6-descendant-routes/.npmrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
@sentry:registry=http://127.0.0.1:4873
@sentry-internal:registry=http://127.0.0.1:4873

55 changes: 55 additions & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
{
 "name": "react-router-6-descendant-routes",
 "version": "0.1.0",
 "private": true,
 "dependencies": {
 "@sentry/react": "latest || *",
 "@types/react": "18.0.0",
 "@types/react-dom": "18.0.0",
 "express": "4.19.2",
 "react": "18.2.0",
 "react-dom": "18.2.0",
 "react-router-dom": "^6.28.0",
 "react-scripts": "5.0.1",
 "typescript": "4.9.5"
 },
 "scripts": {
 "build": "react-scripts build",
 "start": "run-p start:client start:server",
 "start:client": "node server/app.js",
 "start:server": "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 typescript@3.8 && 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.44.1",
 "@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
...ckages/e2e-tests/test-applications/react-router-6-descendant-routes/playwright.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff 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-6-descendant-routes/public/index.html

View file


Open in desktop

Original file line numberDiff line numberDiff 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>

47 changes: 47 additions & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/server/app.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
const express = require('express');

const app = express();
const PORT = 8080;

const wait = time => {
 return new Promise(resolve => {
 setTimeout(() => {
 resolve();
 }, time);
 });
};

async function sseHandler(request, response, timeout = false) {
 response.headers = {
 'Content-Type': 'text/event-stream',
 Connection: 'keep-alive',
 'Cache-Control': 'no-cache',
 'Access-Control-Allow-Origin': '*',
 };

 response.setHeader('Cache-Control', 'no-cache');
 response.setHeader('Content-Type', 'text/event-stream');
 response.setHeader('Access-Control-Allow-Origin', '*');
 response.setHeader('Connection', 'keep-alive');

 response.flushHeaders();

 await wait(2000);

 for (let index = 0; index < 10; index++) {
 response.write(`data: ${new Date().toISOString()}\n\n`);
 if (timeout) {
 await wait(10000);
 }
 }

 response.end();
}

app.get('/sse', (req, res) => sseHandler(req, res));

app.get('/sse-timeout', (req, res) => sseHandler(req, res, true));

app.listen(PORT, () => {
 console.log(`SSE service listening at http://localhost:${PORT}`);
});

5 changes: 5 additions & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/src/globals.d.ts

View file


Open in desktop

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

73 changes: 73 additions & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/src/index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
import * as Sentry from '@sentry/react';
import React from 'react';
import ReactDOM from 'react-dom/client';
import {
 BrowserRouter,
 Route,
 Routes,
 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.reactRouterV6BrowserTracingIntegration({
 useEffect: React.useEffect,
 useLocation,
 useNavigationType,
 createRoutesFromChildren,
 matchRoutes,
 trackFetchStreamPerformance: true,
 }),
 replay,
 ],
 // 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 SentryRoutes = Sentry.withSentryReactRouterV6Routing(Routes);

const DetailsRoutes = () => (
 <SentryRoutes>
 <Route path=":detailId" element={<div id="details">Details</div>} />
 </SentryRoutes>
);

const ViewsRoutes = () => (
 <SentryRoutes>
 <Route index element={<div id="views">Views</div>} />
 <Route path="views/:viewId/*" element={<DetailsRoutes />} />
 </SentryRoutes>
);

const ProjectsRoutes = () => (
 <SentryRoutes>
 <Route path="projects/:projectId/*" element={<ViewsRoutes />}></Route>
 <Route path="*" element={<div>No Match Page</div>} />
 </SentryRoutes>
);

const root = ReactDOM.createRoot(document.getElementById('root') as HTMLElement);
root.render(
 <BrowserRouter>
 <SentryRoutes>
 <Route path="/" element={<Index />} />
 <Route path="/*" element={<ProjectsRoutes />}></Route>
 </SentryRoutes>
 </BrowserRouter>,
);

15 changes: 15 additions & 0 deletions
...packages/e2e-tests/test-applications/react-router-6-descendant-routes/src/pages/Index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
// biome-ignore lint/nursery/noUnusedImports: Need React import for JSX
import * as React from 'react';
import { Link } from 'react-router-dom';

const Index = () => {
 return (
 <>
 <Link to="/projects/123/views/456/789" id="navigation">
 navigate
 </Link>
 </>
 );
};

export default Index;

1 change: 1 addition & 0 deletions
...kages/e2e-tests/test-applications/react-router-6-descendant-routes/src/react-app-env.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
/// <reference types="react-scripts" />

6 changes: 6 additions & 0 deletions
...ckages/e2e-tests/test-applications/react-router-6-descendant-routes/start-event-proxy.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
import { startEventProxyServer } from '@sentry-internal/test-utils';

startEventProxyServer({
 port: 3031,
 proxyServerName: 'react-router-6-descendant-routes',
});

67 changes: 67 additions & 0 deletions
...s/e2e-tests/test-applications/react-router-6-descendant-routes/tests/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';

test('sends a pageload transaction with a parameterized URL', async ({ page }) => {
 const transactionPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
 });

 await page.goto(`/projects/123/views/234/567`);

 const rootSpan = await transactionPromise;

 expect(rootSpan).toMatchObject({
 contexts: {
 trace: {
 op: 'pageload',
 origin: 'auto.pageload.react.reactrouter_v6',
 },
 },
 transaction: '/projects/:projectId/views/:viewId/:detailId',
 transaction_info: {
 source: 'route',
 },
 });
});

test('sends a navigation transaction with a parameterized URL', async ({ page }) => {
 const pageloadTxnPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
 });

 const navigationTxnPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'navigation';
 });

 await page.goto(`/`);
 const pageloadTxn = await pageloadTxnPromise;

 expect(pageloadTxn).toMatchObject({
 contexts: {
 trace: {
 op: 'pageload',
 origin: 'auto.pageload.react.reactrouter_v6',
 },
 },
 transaction: '/',
 transaction_info: {
 source: 'route',
 },
 });

 const linkElement = page.locator('id=navigation');

 const [_, navigationTxn] = await Promise.all([linkElement.click(), navigationTxnPromise]);
 expect(navigationTxn).toMatchObject({
 contexts: {
 trace: {
 op: 'navigation',
 origin: 'auto.navigation.react.reactrouter_v6',
 },
 },
 transaction: '/projects/:projectId/views/:viewId/:detailId',
 transaction_info: {
 source: 'route',
 },
 });
});

20 changes: 20 additions & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/tsconfig.json

View file


Open in desktop

Original file line numberDiff line numberDiff 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"]
}

3 changes: 1 addition & 2 deletions
packages/react/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,8 +67,7 @@
 "react-router-3": "npm:react-router@3.2.0",
 "react-router-4": "npm:react-router@4.1.0",
 "react-router-5": "npm:react-router@5.0.0",
 "react-router-6": "npm:react-router@6.3.0",
 "react-router-6.4": "npm:react-router@6.4.2",
 "react-router-6": "npm:react-router@6.28.0",
 "redux": "^4.0.5"
 },
 "scripts": {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(react): Add React Router Descendant Routes support.#14304

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

 Merged

chargome
merged 13 commits into

from

Dec 12, 2024
 Merged


fix(react): Add React Router Descendant Routes support.
#14304
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


13 commits


Select commit
Hold shift + click to select a range
0324eb7

fix(react): Add React Router Descendant Routes support.


onurtemizkan Nov 14, 2024
86a3e65

Add an E2E test.


onurtemizkan Nov 22, 2024
0521399

Alternative implementation.


onurtemizkan Nov 22, 2024
e20f219

Switch back to the original implementation.


onurtemizkan Nov 28, 2024
0ebdf39

Lint


onurtemizkan Nov 28, 2024
23b8c36

Update e2e tests.


onurtemizkan Nov 28, 2024
a39c8ff

Switch to `useRef` in `wrapUseRoutes`.


onurtemizkan Nov 28, 2024
d9f9962

Reimplement descendant routes handling


onurtemizkan Dec 3, 2024
37fafae

Optimize


onurtemizkan Dec 4, 2024
ac005f8

Cleanup


onurtemizkan Dec 4, 2024
4ec53c8

Update `useRoutes` tests.


onurtemizkan Dec 4, 2024
89751f0

Update e2e tests.


onurtemizkan Dec 4, 2024
6184b27

Review updates


onurtemizkan Dec 11, 2024

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-6-descendant-routes/.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff 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-6-descendant-routes/.npmrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
@sentry:registry=http://127.0.0.1:4873
@sentry-internal:registry=http://127.0.0.1:4873

55 changes: 55 additions & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
{
 "name": "react-router-6-descendant-routes",
 "version": "0.1.0",
 "private": true,
 "dependencies": {
 "@sentry/react": "latest || *",
 "@types/react": "18.0.0",
 "@types/react-dom": "18.0.0",
 "express": "4.19.2",
 "react": "18.2.0",
 "react-dom": "18.2.0",
 "react-router-dom": "^6.28.0",
 "react-scripts": "5.0.1",
 "typescript": "4.9.5"
 },
 "scripts": {
 "build": "react-scripts build",
 "start": "run-p start:client start:server",
 "start:client": "node server/app.js",
 "start:server": "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 typescript@3.8 && 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.44.1",
 "@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
...ckages/e2e-tests/test-applications/react-router-6-descendant-routes/playwright.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff 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-6-descendant-routes/public/index.html

View file


Open in desktop

Original file line numberDiff line numberDiff 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>

47 changes: 47 additions & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/server/app.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
const express = require('express');

const app = express();
const PORT = 8080;

const wait = time => {
 return new Promise(resolve => {
 setTimeout(() => {
 resolve();
 }, time);
 });
};

async function sseHandler(request, response, timeout = false) {
 response.headers = {
 'Content-Type': 'text/event-stream',
 Connection: 'keep-alive',
 'Cache-Control': 'no-cache',
 'Access-Control-Allow-Origin': '*',
 };

 response.setHeader('Cache-Control', 'no-cache');
 response.setHeader('Content-Type', 'text/event-stream');
 response.setHeader('Access-Control-Allow-Origin', '*');
 response.setHeader('Connection', 'keep-alive');

 response.flushHeaders();

 await wait(2000);

 for (let index = 0; index < 10; index++) {
 response.write(`data: ${new Date().toISOString()}\n\n`);
 if (timeout) {
 await wait(10000);
 }
 }

 response.end();
}

app.get('/sse', (req, res) => sseHandler(req, res));

app.get('/sse-timeout', (req, res) => sseHandler(req, res, true));

app.listen(PORT, () => {
 console.log(`SSE service listening at http://localhost:${PORT}`);
});

5 changes: 5 additions & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/src/globals.d.ts

View file


Open in desktop

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

73 changes: 73 additions & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/src/index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
import * as Sentry from '@sentry/react';
import React from 'react';
import ReactDOM from 'react-dom/client';
import {
 BrowserRouter,
 Route,
 Routes,
 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.reactRouterV6BrowserTracingIntegration({
 useEffect: React.useEffect,
 useLocation,
 useNavigationType,
 createRoutesFromChildren,
 matchRoutes,
 trackFetchStreamPerformance: true,
 }),
 replay,
 ],
 // 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 SentryRoutes = Sentry.withSentryReactRouterV6Routing(Routes);

const DetailsRoutes = () => (
 <SentryRoutes>
 <Route path=":detailId" element={<div id="details">Details</div>} />
 </SentryRoutes>
);

const ViewsRoutes = () => (
 <SentryRoutes>
 <Route index element={<div id="views">Views</div>} />
 <Route path="views/:viewId/*" element={<DetailsRoutes />} />
 </SentryRoutes>
);

const ProjectsRoutes = () => (
 <SentryRoutes>
 <Route path="projects/:projectId/*" element={<ViewsRoutes />}></Route>
 <Route path="*" element={<div>No Match Page</div>} />
 </SentryRoutes>
);

const root = ReactDOM.createRoot(document.getElementById('root') as HTMLElement);
root.render(
 <BrowserRouter>
 <SentryRoutes>
 <Route path="/" element={<Index />} />
 <Route path="/*" element={<ProjectsRoutes />}></Route>
 </SentryRoutes>
 </BrowserRouter>,
);

15 changes: 15 additions & 0 deletions
...packages/e2e-tests/test-applications/react-router-6-descendant-routes/src/pages/Index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
// biome-ignore lint/nursery/noUnusedImports: Need React import for JSX
import * as React from 'react';
import { Link } from 'react-router-dom';

const Index = () => {
 return (
 <>
 <Link to="/projects/123/views/456/789" id="navigation">
 navigate
 </Link>
 </>
 );
};

export default Index;

1 change: 1 addition & 0 deletions
...kages/e2e-tests/test-applications/react-router-6-descendant-routes/src/react-app-env.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
/// <reference types="react-scripts" />

6 changes: 6 additions & 0 deletions
...ckages/e2e-tests/test-applications/react-router-6-descendant-routes/start-event-proxy.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
import { startEventProxyServer } from '@sentry-internal/test-utils';

startEventProxyServer({
 port: 3031,
 proxyServerName: 'react-router-6-descendant-routes',
});

67 changes: 67 additions & 0 deletions
...s/e2e-tests/test-applications/react-router-6-descendant-routes/tests/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';

test('sends a pageload transaction with a parameterized URL', async ({ page }) => {
 const transactionPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
 });

 await page.goto(`/projects/123/views/234/567`);

 const rootSpan = await transactionPromise;

 expect(rootSpan).toMatchObject({
 contexts: {
 trace: {
 op: 'pageload',
 origin: 'auto.pageload.react.reactrouter_v6',
 },
 },
 transaction: '/projects/:projectId/views/:viewId/:detailId',
 transaction_info: {
 source: 'route',
 },
 });
});

test('sends a navigation transaction with a parameterized URL', async ({ page }) => {
 const pageloadTxnPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
 });

 const navigationTxnPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'navigation';
 });

 await page.goto(`/`);
 const pageloadTxn = await pageloadTxnPromise;

 expect(pageloadTxn).toMatchObject({
 contexts: {
 trace: {
 op: 'pageload',
 origin: 'auto.pageload.react.reactrouter_v6',
 },
 },
 transaction: '/',
 transaction_info: {
 source: 'route',
 },
 });

 const linkElement = page.locator('id=navigation');

 const [_, navigationTxn] = await Promise.all([linkElement.click(), navigationTxnPromise]);
 expect(navigationTxn).toMatchObject({
 contexts: {
 trace: {
 op: 'navigation',
 origin: 'auto.navigation.react.reactrouter_v6',
 },
 },
 transaction: '/projects/:projectId/views/:viewId/:detailId',
 transaction_info: {
 source: 'route',
 },
 });
});

20 changes: 20 additions & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/tsconfig.json

View file


Open in desktop

Original file line numberDiff line numberDiff 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"]
}

3 changes: 1 addition & 2 deletions
packages/react/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,8 +67,7 @@
 "react-router-3": "npm:react-router@3.2.0",
 "react-router-4": "npm:react-router@4.1.0",
 "react-router-5": "npm:react-router@5.0.0",
 "react-router-6": "npm:react-router@6.3.0",
 "react-router-6.4": "npm:react-router@6.4.2",
 "react-router-6": "npm:react-router@6.28.0",
 "redux": "^4.0.5"
 },
 "scripts": {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
fix(react): Add React Router Descendant Routes support.#14304

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

 Merged

chargome
merged 13 commits into

from

Dec 12, 2024
 Merged


fix(react): Add React Router Descendant Routes support.
#14304
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


13 commits


Select commit
Hold shift + click to select a range
0324eb7

fix(react): Add React Router Descendant Routes support.


onurtemizkan Nov 14, 2024
86a3e65

Add an E2E test.


onurtemizkan Nov 22, 2024
0521399

Alternative implementation.


onurtemizkan Nov 22, 2024
e20f219

Switch back to the original implementation.


onurtemizkan Nov 28, 2024
0ebdf39

Lint


onurtemizkan Nov 28, 2024
23b8c36

Update e2e tests.


onurtemizkan Nov 28, 2024
a39c8ff

Switch to `useRef` in `wrapUseRoutes`.


onurtemizkan Nov 28, 2024
d9f9962

Reimplement descendant routes handling


onurtemizkan Dec 3, 2024
37fafae

Optimize


onurtemizkan Dec 4, 2024
ac005f8

Cleanup


onurtemizkan Dec 4, 2024
4ec53c8

Update `useRoutes` tests.


onurtemizkan Dec 4, 2024
89751f0

Update e2e tests.


onurtemizkan Dec 4, 2024
6184b27

Review updates


onurtemizkan Dec 11, 2024

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-6-descendant-routes/.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff 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-6-descendant-routes/.npmrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
@sentry:registry=http://127.0.0.1:4873
@sentry-internal:registry=http://127.0.0.1:4873

55 changes: 55 additions & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
{
 "name": "react-router-6-descendant-routes",
 "version": "0.1.0",
 "private": true,
 "dependencies": {
 "@sentry/react": "latest || *",
 "@types/react": "18.0.0",
 "@types/react-dom": "18.0.0",
 "express": "4.19.2",
 "react": "18.2.0",
 "react-dom": "18.2.0",
 "react-router-dom": "^6.28.0",
 "react-scripts": "5.0.1",
 "typescript": "4.9.5"
 },
 "scripts": {
 "build": "react-scripts build",
 "start": "run-p start:client start:server",
 "start:client": "node server/app.js",
 "start:server": "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 typescript@3.8 && 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.44.1",
 "@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
...ckages/e2e-tests/test-applications/react-router-6-descendant-routes/playwright.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff 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-6-descendant-routes/public/index.html

View file


Open in desktop

Original file line numberDiff line numberDiff 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>

47 changes: 47 additions & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/server/app.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
const express = require('express');

const app = express();
const PORT = 8080;

const wait = time => {
 return new Promise(resolve => {
 setTimeout(() => {
 resolve();
 }, time);
 });
};

async function sseHandler(request, response, timeout = false) {
 response.headers = {
 'Content-Type': 'text/event-stream',
 Connection: 'keep-alive',
 'Cache-Control': 'no-cache',
 'Access-Control-Allow-Origin': '*',
 };

 response.setHeader('Cache-Control', 'no-cache');
 response.setHeader('Content-Type', 'text/event-stream');
 response.setHeader('Access-Control-Allow-Origin', '*');
 response.setHeader('Connection', 'keep-alive');

 response.flushHeaders();

 await wait(2000);

 for (let index = 0; index < 10; index++) {
 response.write(`data: ${new Date().toISOString()}\n\n`);
 if (timeout) {
 await wait(10000);
 }
 }

 response.end();
}

app.get('/sse', (req, res) => sseHandler(req, res));

app.get('/sse-timeout', (req, res) => sseHandler(req, res, true));

app.listen(PORT, () => {
 console.log(`SSE service listening at http://localhost:${PORT}`);
});

5 changes: 5 additions & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/src/globals.d.ts

View file


Open in desktop

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

73 changes: 73 additions & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/src/index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
import * as Sentry from '@sentry/react';
import React from 'react';
import ReactDOM from 'react-dom/client';
import {
 BrowserRouter,
 Route,
 Routes,
 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.reactRouterV6BrowserTracingIntegration({
 useEffect: React.useEffect,
 useLocation,
 useNavigationType,
 createRoutesFromChildren,
 matchRoutes,
 trackFetchStreamPerformance: true,
 }),
 replay,
 ],
 // 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 SentryRoutes = Sentry.withSentryReactRouterV6Routing(Routes);

const DetailsRoutes = () => (
 <SentryRoutes>
 <Route path=":detailId" element={<div id="details">Details</div>} />
 </SentryRoutes>
);

const ViewsRoutes = () => (
 <SentryRoutes>
 <Route index element={<div id="views">Views</div>} />
 <Route path="views/:viewId/*" element={<DetailsRoutes />} />
 </SentryRoutes>
);

const ProjectsRoutes = () => (
 <SentryRoutes>
 <Route path="projects/:projectId/*" element={<ViewsRoutes />}></Route>
 <Route path="*" element={<div>No Match Page</div>} />
 </SentryRoutes>
);

const root = ReactDOM.createRoot(document.getElementById('root') as HTMLElement);
root.render(
 <BrowserRouter>
 <SentryRoutes>
 <Route path="/" element={<Index />} />
 <Route path="/*" element={<ProjectsRoutes />}></Route>
 </SentryRoutes>
 </BrowserRouter>,
);

15 changes: 15 additions & 0 deletions
...packages/e2e-tests/test-applications/react-router-6-descendant-routes/src/pages/Index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
// biome-ignore lint/nursery/noUnusedImports: Need React import for JSX
import * as React from 'react';
import { Link } from 'react-router-dom';

const Index = () => {
 return (
 <>
 <Link to="/projects/123/views/456/789" id="navigation">
 navigate
 </Link>
 </>
 );
};

export default Index;

1 change: 1 addition & 0 deletions
...kages/e2e-tests/test-applications/react-router-6-descendant-routes/src/react-app-env.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
/// <reference types="react-scripts" />

6 changes: 6 additions & 0 deletions
...ckages/e2e-tests/test-applications/react-router-6-descendant-routes/start-event-proxy.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
import { startEventProxyServer } from '@sentry-internal/test-utils';

startEventProxyServer({
 port: 3031,
 proxyServerName: 'react-router-6-descendant-routes',
});

67 changes: 67 additions & 0 deletions
...s/e2e-tests/test-applications/react-router-6-descendant-routes/tests/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';

test('sends a pageload transaction with a parameterized URL', async ({ page }) => {
 const transactionPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
 });

 await page.goto(`/projects/123/views/234/567`);

 const rootSpan = await transactionPromise;

 expect(rootSpan).toMatchObject({
 contexts: {
 trace: {
 op: 'pageload',
 origin: 'auto.pageload.react.reactrouter_v6',
 },
 },
 transaction: '/projects/:projectId/views/:viewId/:detailId',
 transaction_info: {
 source: 'route',
 },
 });
});

test('sends a navigation transaction with a parameterized URL', async ({ page }) => {
 const pageloadTxnPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
 });

 const navigationTxnPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'navigation';
 });

 await page.goto(`/`);
 const pageloadTxn = await pageloadTxnPromise;

 expect(pageloadTxn).toMatchObject({
 contexts: {
 trace: {
 op: 'pageload',
 origin: 'auto.pageload.react.reactrouter_v6',
 },
 },
 transaction: '/',
 transaction_info: {
 source: 'route',
 },
 });

 const linkElement = page.locator('id=navigation');

 const [_, navigationTxn] = await Promise.all([linkElement.click(), navigationTxnPromise]);
 expect(navigationTxn).toMatchObject({
 contexts: {
 trace: {
 op: 'navigation',
 origin: 'auto.navigation.react.reactrouter_v6',
 },
 },
 transaction: '/projects/:projectId/views/:viewId/:detailId',
 transaction_info: {
 source: 'route',
 },
 });
});

20 changes: 20 additions & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/tsconfig.json

View file


Open in desktop

Original file line numberDiff line numberDiff 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"]
}

3 changes: 1 addition & 2 deletions
packages/react/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,8 +67,7 @@
 "react-router-3": "npm:react-router@3.2.0",
 "react-router-4": "npm:react-router@4.1.0",
 "react-router-5": "npm:react-router@5.0.0",
 "react-router-6": "npm:react-router@6.3.0",
 "react-router-6.4": "npm:react-router@6.4.2",
 "react-router-6": "npm:react-router@6.28.0",
 "redux": "^4.0.5"
 },
 "scripts": {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(react): Add React Router Descendant Routes support.#14304

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

 Merged

chargome
merged 13 commits into

from

Dec 12, 2024
 Merged


fix(react): Add React Router Descendant Routes support.
#14304
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


13 commits


Select commit
Hold shift + click to select a range
0324eb7

fix(react): Add React Router Descendant Routes support.


onurtemizkan Nov 14, 2024
86a3e65

Add an E2E test.


onurtemizkan Nov 22, 2024
0521399

Alternative implementation.


onurtemizkan Nov 22, 2024
e20f219

Switch back to the original implementation.


onurtemizkan Nov 28, 2024
0ebdf39

Lint


onurtemizkan Nov 28, 2024
23b8c36

Update e2e tests.


onurtemizkan Nov 28, 2024
a39c8ff

Switch to `useRef` in `wrapUseRoutes`.


onurtemizkan Nov 28, 2024
d9f9962

Reimplement descendant routes handling


onurtemizkan Dec 3, 2024
37fafae

Optimize


onurtemizkan Dec 4, 2024
ac005f8

Cleanup


onurtemizkan Dec 4, 2024
4ec53c8

Update `useRoutes` tests.


onurtemizkan Dec 4, 2024
89751f0

Update e2e tests.


onurtemizkan Dec 4, 2024
6184b27

Review updates


onurtemizkan Dec 11, 2024

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-6-descendant-routes/.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff 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-6-descendant-routes/.npmrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
@sentry:registry=http://127.0.0.1:4873
@sentry-internal:registry=http://127.0.0.1:4873

55 changes: 55 additions & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
{
 "name": "react-router-6-descendant-routes",
 "version": "0.1.0",
 "private": true,
 "dependencies": {
 "@sentry/react": "latest || *",
 "@types/react": "18.0.0",
 "@types/react-dom": "18.0.0",
 "express": "4.19.2",
 "react": "18.2.0",
 "react-dom": "18.2.0",
 "react-router-dom": "^6.28.0",
 "react-scripts": "5.0.1",
 "typescript": "4.9.5"
 },
 "scripts": {
 "build": "react-scripts build",
 "start": "run-p start:client start:server",
 "start:client": "node server/app.js",
 "start:server": "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 typescript@3.8 && 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.44.1",
 "@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
...ckages/e2e-tests/test-applications/react-router-6-descendant-routes/playwright.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff 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-6-descendant-routes/public/index.html

View file


Open in desktop

Original file line numberDiff line numberDiff 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>

47 changes: 47 additions & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/server/app.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
const express = require('express');

const app = express();
const PORT = 8080;

const wait = time => {
 return new Promise(resolve => {
 setTimeout(() => {
 resolve();
 }, time);
 });
};

async function sseHandler(request, response, timeout = false) {
 response.headers = {
 'Content-Type': 'text/event-stream',
 Connection: 'keep-alive',
 'Cache-Control': 'no-cache',
 'Access-Control-Allow-Origin': '*',
 };

 response.setHeader('Cache-Control', 'no-cache');
 response.setHeader('Content-Type', 'text/event-stream');
 response.setHeader('Access-Control-Allow-Origin', '*');
 response.setHeader('Connection', 'keep-alive');

 response.flushHeaders();

 await wait(2000);

 for (let index = 0; index < 10; index++) {
 response.write(`data: ${new Date().toISOString()}\n\n`);
 if (timeout) {
 await wait(10000);
 }
 }

 response.end();
}

app.get('/sse', (req, res) => sseHandler(req, res));

app.get('/sse-timeout', (req, res) => sseHandler(req, res, true));

app.listen(PORT, () => {
 console.log(`SSE service listening at http://localhost:${PORT}`);
});

5 changes: 5 additions & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/src/globals.d.ts

View file


Open in desktop

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

73 changes: 73 additions & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/src/index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
import * as Sentry from '@sentry/react';
import React from 'react';
import ReactDOM from 'react-dom/client';
import {
 BrowserRouter,
 Route,
 Routes,
 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.reactRouterV6BrowserTracingIntegration({
 useEffect: React.useEffect,
 useLocation,
 useNavigationType,
 createRoutesFromChildren,
 matchRoutes,
 trackFetchStreamPerformance: true,
 }),
 replay,
 ],
 // 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 SentryRoutes = Sentry.withSentryReactRouterV6Routing(Routes);

const DetailsRoutes = () => (
 <SentryRoutes>
 <Route path=":detailId" element={<div id="details">Details</div>} />
 </SentryRoutes>
);

const ViewsRoutes = () => (
 <SentryRoutes>
 <Route index element={<div id="views">Views</div>} />
 <Route path="views/:viewId/*" element={<DetailsRoutes />} />
 </SentryRoutes>
);

const ProjectsRoutes = () => (
 <SentryRoutes>
 <Route path="projects/:projectId/*" element={<ViewsRoutes />}></Route>
 <Route path="*" element={<div>No Match Page</div>} />
 </SentryRoutes>
);

const root = ReactDOM.createRoot(document.getElementById('root') as HTMLElement);
root.render(
 <BrowserRouter>
 <SentryRoutes>
 <Route path="/" element={<Index />} />
 <Route path="/*" element={<ProjectsRoutes />}></Route>
 </SentryRoutes>
 </BrowserRouter>,
);

15 changes: 15 additions & 0 deletions
...packages/e2e-tests/test-applications/react-router-6-descendant-routes/src/pages/Index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
// biome-ignore lint/nursery/noUnusedImports: Need React import for JSX
import * as React from 'react';
import { Link } from 'react-router-dom';

const Index = () => {
 return (
 <>
 <Link to="/projects/123/views/456/789" id="navigation">
 navigate
 </Link>
 </>
 );
};

export default Index;

1 change: 1 addition & 0 deletions
...kages/e2e-tests/test-applications/react-router-6-descendant-routes/src/react-app-env.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
/// <reference types="react-scripts" />

6 changes: 6 additions & 0 deletions
...ckages/e2e-tests/test-applications/react-router-6-descendant-routes/start-event-proxy.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
import { startEventProxyServer } from '@sentry-internal/test-utils';

startEventProxyServer({
 port: 3031,
 proxyServerName: 'react-router-6-descendant-routes',
});

67 changes: 67 additions & 0 deletions
...s/e2e-tests/test-applications/react-router-6-descendant-routes/tests/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';

test('sends a pageload transaction with a parameterized URL', async ({ page }) => {
 const transactionPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
 });

 await page.goto(`/projects/123/views/234/567`);

 const rootSpan = await transactionPromise;

 expect(rootSpan).toMatchObject({
 contexts: {
 trace: {
 op: 'pageload',
 origin: 'auto.pageload.react.reactrouter_v6',
 },
 },
 transaction: '/projects/:projectId/views/:viewId/:detailId',
 transaction_info: {
 source: 'route',
 },
 });
});

test('sends a navigation transaction with a parameterized URL', async ({ page }) => {
 const pageloadTxnPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
 });

 const navigationTxnPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'navigation';
 });

 await page.goto(`/`);
 const pageloadTxn = await pageloadTxnPromise;

 expect(pageloadTxn).toMatchObject({
 contexts: {
 trace: {
 op: 'pageload',
 origin: 'auto.pageload.react.reactrouter_v6',
 },
 },
 transaction: '/',
 transaction_info: {
 source: 'route',
 },
 });

 const linkElement = page.locator('id=navigation');

 const [_, navigationTxn] = await Promise.all([linkElement.click(), navigationTxnPromise]);
 expect(navigationTxn).toMatchObject({
 contexts: {
 trace: {
 op: 'navigation',
 origin: 'auto.navigation.react.reactrouter_v6',
 },
 },
 transaction: '/projects/:projectId/views/:viewId/:detailId',
 transaction_info: {
 source: 'route',
 },
 });
});

20 changes: 20 additions & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/tsconfig.json

View file


Open in desktop

Original file line numberDiff line numberDiff 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"]
}

3 changes: 1 addition & 2 deletions
packages/react/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,8 +67,7 @@
 "react-router-3": "npm:react-router@3.2.0",
 "react-router-4": "npm:react-router@4.1.0",
 "react-router-5": "npm:react-router@5.0.0",
 "react-router-6": "npm:react-router@6.3.0",
 "react-router-6.4": "npm:react-router@6.4.2",
 "react-router-6": "npm:react-router@6.28.0",
 "redux": "^4.0.5"
 },
 "scripts": {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(react): Add React Router Descendant Routes support.#14304

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

 Merged

chargome
merged 13 commits into

from

Dec 12, 2024
 Merged


fix(react): Add React Router Descendant Routes support.
#14304
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


13 commits


Select commit
Hold shift + click to select a range
0324eb7

fix(react): Add React Router Descendant Routes support.


onurtemizkan Nov 14, 2024
86a3e65

Add an E2E test.


onurtemizkan Nov 22, 2024
0521399

Alternative implementation.


onurtemizkan Nov 22, 2024
e20f219

Switch back to the original implementation.


onurtemizkan Nov 28, 2024
0ebdf39

Lint


onurtemizkan Nov 28, 2024
23b8c36

Update e2e tests.


onurtemizkan Nov 28, 2024
a39c8ff

Switch to `useRef` in `wrapUseRoutes`.


onurtemizkan Nov 28, 2024
d9f9962

Reimplement descendant routes handling


onurtemizkan Dec 3, 2024
37fafae

Optimize


onurtemizkan Dec 4, 2024
ac005f8

Cleanup


onurtemizkan Dec 4, 2024
4ec53c8

Update `useRoutes` tests.


onurtemizkan Dec 4, 2024
89751f0

Update e2e tests.


onurtemizkan Dec 4, 2024
6184b27

Review updates


onurtemizkan Dec 11, 2024

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-6-descendant-routes/.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff 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-6-descendant-routes/.npmrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
@sentry:registry=http://127.0.0.1:4873
@sentry-internal:registry=http://127.0.0.1:4873

55 changes: 55 additions & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
{
 "name": "react-router-6-descendant-routes",
 "version": "0.1.0",
 "private": true,
 "dependencies": {
 "@sentry/react": "latest || *",
 "@types/react": "18.0.0",
 "@types/react-dom": "18.0.0",
 "express": "4.19.2",
 "react": "18.2.0",
 "react-dom": "18.2.0",
 "react-router-dom": "^6.28.0",
 "react-scripts": "5.0.1",
 "typescript": "4.9.5"
 },
 "scripts": {
 "build": "react-scripts build",
 "start": "run-p start:client start:server",
 "start:client": "node server/app.js",
 "start:server": "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 typescript@3.8 && 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.44.1",
 "@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
...ckages/e2e-tests/test-applications/react-router-6-descendant-routes/playwright.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff 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-6-descendant-routes/public/index.html

View file


Open in desktop

Original file line numberDiff line numberDiff 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>

47 changes: 47 additions & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/server/app.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
const express = require('express');

const app = express();
const PORT = 8080;

const wait = time => {
 return new Promise(resolve => {
 setTimeout(() => {
 resolve();
 }, time);
 });
};

async function sseHandler(request, response, timeout = false) {
 response.headers = {
 'Content-Type': 'text/event-stream',
 Connection: 'keep-alive',
 'Cache-Control': 'no-cache',
 'Access-Control-Allow-Origin': '*',
 };

 response.setHeader('Cache-Control', 'no-cache');
 response.setHeader('Content-Type', 'text/event-stream');
 response.setHeader('Access-Control-Allow-Origin', '*');
 response.setHeader('Connection', 'keep-alive');

 response.flushHeaders();

 await wait(2000);

 for (let index = 0; index < 10; index++) {
 response.write(`data: ${new Date().toISOString()}\n\n`);
 if (timeout) {
 await wait(10000);
 }
 }

 response.end();
}

app.get('/sse', (req, res) => sseHandler(req, res));

app.get('/sse-timeout', (req, res) => sseHandler(req, res, true));

app.listen(PORT, () => {
 console.log(`SSE service listening at http://localhost:${PORT}`);
});

5 changes: 5 additions & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/src/globals.d.ts

View file


Open in desktop

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

73 changes: 73 additions & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/src/index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
import * as Sentry from '@sentry/react';
import React from 'react';
import ReactDOM from 'react-dom/client';
import {
 BrowserRouter,
 Route,
 Routes,
 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.reactRouterV6BrowserTracingIntegration({
 useEffect: React.useEffect,
 useLocation,
 useNavigationType,
 createRoutesFromChildren,
 matchRoutes,
 trackFetchStreamPerformance: true,
 }),
 replay,
 ],
 // 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 SentryRoutes = Sentry.withSentryReactRouterV6Routing(Routes);

const DetailsRoutes = () => (
 <SentryRoutes>
 <Route path=":detailId" element={<div id="details">Details</div>} />
 </SentryRoutes>
);

const ViewsRoutes = () => (
 <SentryRoutes>
 <Route index element={<div id="views">Views</div>} />
 <Route path="views/:viewId/*" element={<DetailsRoutes />} />
 </SentryRoutes>
);

const ProjectsRoutes = () => (
 <SentryRoutes>
 <Route path="projects/:projectId/*" element={<ViewsRoutes />}></Route>
 <Route path="*" element={<div>No Match Page</div>} />
 </SentryRoutes>
);

const root = ReactDOM.createRoot(document.getElementById('root') as HTMLElement);
root.render(
 <BrowserRouter>
 <SentryRoutes>
 <Route path="/" element={<Index />} />
 <Route path="/*" element={<ProjectsRoutes />}></Route>
 </SentryRoutes>
 </BrowserRouter>,
);

15 changes: 15 additions & 0 deletions
...packages/e2e-tests/test-applications/react-router-6-descendant-routes/src/pages/Index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
// biome-ignore lint/nursery/noUnusedImports: Need React import for JSX
import * as React from 'react';
import { Link } from 'react-router-dom';

const Index = () => {
 return (
 <>
 <Link to="/projects/123/views/456/789" id="navigation">
 navigate
 </Link>
 </>
 );
};

export default Index;

1 change: 1 addition & 0 deletions
...kages/e2e-tests/test-applications/react-router-6-descendant-routes/src/react-app-env.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
/// <reference types="react-scripts" />

6 changes: 6 additions & 0 deletions
...ckages/e2e-tests/test-applications/react-router-6-descendant-routes/start-event-proxy.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
import { startEventProxyServer } from '@sentry-internal/test-utils';

startEventProxyServer({
 port: 3031,
 proxyServerName: 'react-router-6-descendant-routes',
});

67 changes: 67 additions & 0 deletions
...s/e2e-tests/test-applications/react-router-6-descendant-routes/tests/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';

test('sends a pageload transaction with a parameterized URL', async ({ page }) => {
 const transactionPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
 });

 await page.goto(`/projects/123/views/234/567`);

 const rootSpan = await transactionPromise;

 expect(rootSpan).toMatchObject({
 contexts: {
 trace: {
 op: 'pageload',
 origin: 'auto.pageload.react.reactrouter_v6',
 },
 },
 transaction: '/projects/:projectId/views/:viewId/:detailId',
 transaction_info: {
 source: 'route',
 },
 });
});

test('sends a navigation transaction with a parameterized URL', async ({ page }) => {
 const pageloadTxnPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
 });

 const navigationTxnPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'navigation';
 });

 await page.goto(`/`);
 const pageloadTxn = await pageloadTxnPromise;

 expect(pageloadTxn).toMatchObject({
 contexts: {
 trace: {
 op: 'pageload',
 origin: 'auto.pageload.react.reactrouter_v6',
 },
 },
 transaction: '/',
 transaction_info: {
 source: 'route',
 },
 });

 const linkElement = page.locator('id=navigation');

 const [_, navigationTxn] = await Promise.all([linkElement.click(), navigationTxnPromise]);
 expect(navigationTxn).toMatchObject({
 contexts: {
 trace: {
 op: 'navigation',
 origin: 'auto.navigation.react.reactrouter_v6',
 },
 },
 transaction: '/projects/:projectId/views/:viewId/:detailId',
 transaction_info: {
 source: 'route',
 },
 });
});

20 changes: 20 additions & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/tsconfig.json

View file


Open in desktop

Original file line numberDiff line numberDiff 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"]
}

3 changes: 1 addition & 2 deletions
packages/react/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,8 +67,7 @@
 "react-router-3": "npm:react-router@3.2.0",
 "react-router-4": "npm:react-router@4.1.0",
 "react-router-5": "npm:react-router@5.0.0",
 "react-router-6": "npm:react-router@6.3.0",
 "react-router-6.4": "npm:react-router@6.4.2",
 "react-router-6": "npm:react-router@6.28.0",
 "redux": "^4.0.5"
 },
 "scripts": {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
fix(react): Add React Router Descendant Routes support.#14304

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

 Merged

chargome
merged 13 commits into

from

Dec 12, 2024
 Merged


fix(react): Add React Router Descendant Routes support.
#14304
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


13 commits


Select commit
Hold shift + click to select a range
0324eb7

fix(react): Add React Router Descendant Routes support.


onurtemizkan Nov 14, 2024
86a3e65

Add an E2E test.


onurtemizkan Nov 22, 2024
0521399

Alternative implementation.


onurtemizkan Nov 22, 2024
e20f219

Switch back to the original implementation.


onurtemizkan Nov 28, 2024
0ebdf39

Lint


onurtemizkan Nov 28, 2024
23b8c36

Update e2e tests.


onurtemizkan Nov 28, 2024
a39c8ff

Switch to `useRef` in `wrapUseRoutes`.


onurtemizkan Nov 28, 2024
d9f9962

Reimplement descendant routes handling


onurtemizkan Dec 3, 2024
37fafae

Optimize


onurtemizkan Dec 4, 2024
ac005f8

Cleanup


onurtemizkan Dec 4, 2024
4ec53c8

Update `useRoutes` tests.


onurtemizkan Dec 4, 2024
89751f0

Update e2e tests.


onurtemizkan Dec 4, 2024
6184b27

Review updates


onurtemizkan Dec 11, 2024

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-6-descendant-routes/.gitignore

View file


Open in desktop

Original file line numberDiff line numberDiff 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-6-descendant-routes/.npmrc

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
@sentry:registry=http://127.0.0.1:4873
@sentry-internal:registry=http://127.0.0.1:4873

55 changes: 55 additions & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
{
 "name": "react-router-6-descendant-routes",
 "version": "0.1.0",
 "private": true,
 "dependencies": {
 "@sentry/react": "latest || *",
 "@types/react": "18.0.0",
 "@types/react-dom": "18.0.0",
 "express": "4.19.2",
 "react": "18.2.0",
 "react-dom": "18.2.0",
 "react-router-dom": "^6.28.0",
 "react-scripts": "5.0.1",
 "typescript": "4.9.5"
 },
 "scripts": {
 "build": "react-scripts build",
 "start": "run-p start:client start:server",
 "start:client": "node server/app.js",
 "start:server": "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 typescript@3.8 && 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.44.1",
 "@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
...ckages/e2e-tests/test-applications/react-router-6-descendant-routes/playwright.config.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff 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-6-descendant-routes/public/index.html

View file


Open in desktop

Original file line numberDiff line numberDiff 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>

47 changes: 47 additions & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/server/app.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
const express = require('express');

const app = express();
const PORT = 8080;

const wait = time => {
 return new Promise(resolve => {
 setTimeout(() => {
 resolve();
 }, time);
 });
};

async function sseHandler(request, response, timeout = false) {
 response.headers = {
 'Content-Type': 'text/event-stream',
 Connection: 'keep-alive',
 'Cache-Control': 'no-cache',
 'Access-Control-Allow-Origin': '*',
 };

 response.setHeader('Cache-Control', 'no-cache');
 response.setHeader('Content-Type', 'text/event-stream');
 response.setHeader('Access-Control-Allow-Origin', '*');
 response.setHeader('Connection', 'keep-alive');

 response.flushHeaders();

 await wait(2000);

 for (let index = 0; index < 10; index++) {
 response.write(`data: ${new Date().toISOString()}\n\n`);
 if (timeout) {
 await wait(10000);
 }
 }

 response.end();
}

app.get('/sse', (req, res) => sseHandler(req, res));

app.get('/sse-timeout', (req, res) => sseHandler(req, res, true));

app.listen(PORT, () => {
 console.log(`SSE service listening at http://localhost:${PORT}`);
});

5 changes: 5 additions & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/src/globals.d.ts

View file


Open in desktop

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

73 changes: 73 additions & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/src/index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
import * as Sentry from '@sentry/react';
import React from 'react';
import ReactDOM from 'react-dom/client';
import {
 BrowserRouter,
 Route,
 Routes,
 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.reactRouterV6BrowserTracingIntegration({
 useEffect: React.useEffect,
 useLocation,
 useNavigationType,
 createRoutesFromChildren,
 matchRoutes,
 trackFetchStreamPerformance: true,
 }),
 replay,
 ],
 // 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 SentryRoutes = Sentry.withSentryReactRouterV6Routing(Routes);

const DetailsRoutes = () => (
 <SentryRoutes>
 <Route path=":detailId" element={<div id="details">Details</div>} />
 </SentryRoutes>
);

const ViewsRoutes = () => (
 <SentryRoutes>
 <Route index element={<div id="views">Views</div>} />
 <Route path="views/:viewId/*" element={<DetailsRoutes />} />
 </SentryRoutes>
);

const ProjectsRoutes = () => (
 <SentryRoutes>
 <Route path="projects/:projectId/*" element={<ViewsRoutes />}></Route>
 <Route path="*" element={<div>No Match Page</div>} />
 </SentryRoutes>
);

const root = ReactDOM.createRoot(document.getElementById('root') as HTMLElement);
root.render(
 <BrowserRouter>
 <SentryRoutes>
 <Route path="/" element={<Index />} />
 <Route path="/*" element={<ProjectsRoutes />}></Route>
 </SentryRoutes>
 </BrowserRouter>,
);

15 changes: 15 additions & 0 deletions
...packages/e2e-tests/test-applications/react-router-6-descendant-routes/src/pages/Index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
// biome-ignore lint/nursery/noUnusedImports: Need React import for JSX
import * as React from 'react';
import { Link } from 'react-router-dom';

const Index = () => {
 return (
 <>
 <Link to="/projects/123/views/456/789" id="navigation">
 navigate
 </Link>
 </>
 );
};

export default Index;

1 change: 1 addition & 0 deletions
...kages/e2e-tests/test-applications/react-router-6-descendant-routes/src/react-app-env.d.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
/// <reference types="react-scripts" />

6 changes: 6 additions & 0 deletions
...ckages/e2e-tests/test-applications/react-router-6-descendant-routes/start-event-proxy.mjs

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
import { startEventProxyServer } from '@sentry-internal/test-utils';

startEventProxyServer({
 port: 3031,
 proxyServerName: 'react-router-6-descendant-routes',
});

67 changes: 67 additions & 0 deletions
...s/e2e-tests/test-applications/react-router-6-descendant-routes/tests/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';

test('sends a pageload transaction with a parameterized URL', async ({ page }) => {
 const transactionPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
 });

 await page.goto(`/projects/123/views/234/567`);

 const rootSpan = await transactionPromise;

 expect(rootSpan).toMatchObject({
 contexts: {
 trace: {
 op: 'pageload',
 origin: 'auto.pageload.react.reactrouter_v6',
 },
 },
 transaction: '/projects/:projectId/views/:viewId/:detailId',
 transaction_info: {
 source: 'route',
 },
 });
});

test('sends a navigation transaction with a parameterized URL', async ({ page }) => {
 const pageloadTxnPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
 });

 const navigationTxnPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'navigation';
 });

 await page.goto(`/`);
 const pageloadTxn = await pageloadTxnPromise;

 expect(pageloadTxn).toMatchObject({
 contexts: {
 trace: {
 op: 'pageload',
 origin: 'auto.pageload.react.reactrouter_v6',
 },
 },
 transaction: '/',
 transaction_info: {
 source: 'route',
 },
 });

 const linkElement = page.locator('id=navigation');

 const [_, navigationTxn] = await Promise.all([linkElement.click(), navigationTxnPromise]);
 expect(navigationTxn).toMatchObject({
 contexts: {
 trace: {
 op: 'navigation',
 origin: 'auto.navigation.react.reactrouter_v6',
 },
 },
 transaction: '/projects/:projectId/views/:viewId/:detailId',
 transaction_info: {
 source: 'route',
 },
 });
});

20 changes: 20 additions & 0 deletions
dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/tsconfig.json

View file


Open in desktop

Original file line numberDiff line numberDiff 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"]
}

3 changes: 1 addition & 2 deletions
packages/react/package.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -67,8 +67,7 @@
 "react-router-3": "npm:react-router@3.2.0",
 "react-router-4": "npm:react-router@4.1.0",
 "react-router-5": "npm:react-router@5.0.0",
 "react-router-6": "npm:react-router@6.3.0",
 "react-router-6.4": "npm:react-router@6.4.2",
 "react-router-6": "npm:react-router@6.28.0",
 "redux": "^4.0.5"
 },
 "scripts": {
Expand Down
Loading