Skip to content

Commit af773b1

Browse files
chargomechargome
authored
feat(react): React Router v7 support (library) (#14513)
1 parent 11f3207 commit af773b1

22 files changed

+1018
-399
lines changed

‎dev-packages/e2e-tests/test-applications/react-router-7-spa/.gitignore

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
2+
3+
# dependencies
4+
/node_modules
5+
/.pnp
6+
.pnp.js
7+
8+
# testing
9+
/coverage
10+
11+
# production
12+
/build
13+
14+
# misc
15+
.DS_Store
16+
.env.local
17+
.env.development.local
18+
.env.test.local
19+
.env.production.local
20+
21+
npm-debug.log*
22+
yarn-debug.log*
23+
yarn-error.log*
24+
25+
/test-results/
26+
/playwright-report/
27+
/playwright/.cache/
28+
29+
!*.d.ts

‎dev-packages/e2e-tests/test-applications/react-router-7-spa/.npmrc

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

‎dev-packages/e2e-tests/test-applications/react-router-7-spa/index.html

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!doctype html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8" />
5+
<link rel="icon" type="image/svg+xml" href="/vite.svg" />
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7+
<title>Vite + React + TS</title>
8+
</head>
9+
<body>
10+
<div id="root"></div>
11+
<script type="module" src="/src/main.tsx"></script>
12+
</body>
13+
</html>

‎dev-packages/e2e-tests/test-applications/react-router-7-spa/package.json

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
{
2+
"name": "react-router-7-spa",
3+
"version": "0.1.0",
4+
"private": true,
5+
"dependencies": {
6+
"@sentry/react": "latest || *",
7+
"@types/react": "18.3.1",
8+
"@types/react-dom": "18.3.1",
9+
"react": "18.3.1",
10+
"react-dom": "18.3.1",
11+
"react-router": "^7.0.1"
12+
},
13+
"devDependencies": {
14+
"@playwright/test": "^1.44.1",
15+
"@sentry-internal/test-utils": "link:../../../test-utils",
16+
"vite": "^6.0.1",
17+
"@vitejs/plugin-react": "^4.3.4",
18+
"typescript": "4.9.5"
19+
},
20+
"scripts": {
21+
"build": "vite build",
22+
"dev": "vite",
23+
"preview": "vite preview",
24+
"test": "playwright test",
25+
"clean": "npx rimraf node_modules pnpm-lock.yaml",
26+
"test:build": "pnpm install && npx playwright install && pnpm build",
27+
"test:build-ts3.8": "pnpm install && pnpm add typescript@3.8 && npx playwright install && pnpm build",
28+
"test:build-canary": "pnpm install && pnpm add react@canary react-dom@canary && npx playwright install && pnpm build",
29+
"test:assert": "pnpm test"
30+
},
31+
"eslintConfig": {
32+
"extends": [
33+
"react-app",
34+
"react-app/jest"
35+
]
36+
},
37+
"browserslist": {
38+
"production": [
39+
">0.2%",
40+
"not dead",
41+
"not op_mini all"
42+
],
43+
"development": [
44+
"last 1 chrome version",
45+
"last 1 firefox version",
46+
"last 1 safari version"
47+
]
48+
},
49+
"volta": {
50+
"extends": "../../package.json"
51+
},
52+
"sentryTest": {
53+
"variants": [
54+
{
55+
"build-command": "test:build-ts3.8",
56+
"label": "react-router-7-spa (TS 3.8)"
57+
}
58+
]
59+
}
60+
}

‎dev-packages/e2e-tests/test-applications/react-router-7-spa/playwright.config.mjs

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
import { getPlaywrightConfig } from '@sentry-internal/test-utils';
2+
3+
const config = getPlaywrightConfig({
4+
startCommand: `pnpm preview --port 3030`,
5+
port: 3030,
6+
});
7+
8+
export default config;

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

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

‎dev-packages/e2e-tests/test-applications/react-router-7-spa/src/main.tsx

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
import * as Sentry from '@sentry/react';
2+
import React from 'react';
3+
import ReactDOM from 'react-dom/client';
4+
import {
5+
BrowserRouter,
6+
Route,
7+
Routes,
8+
createRoutesFromChildren,
9+
matchRoutes,
10+
useLocation,
11+
useNavigationType,
12+
} from 'react-router';
13+
import Index from './pages/Index';
14+
import SSE from './pages/SSE';
15+
import User from './pages/User';
16+
17+
const replay = Sentry.replayIntegration();
18+
19+
Sentry.init({
20+
environment: 'qa', // dynamic sampling bias to keep transactions
21+
dsn: import.meta.env.PUBLIC_E2E_TEST_DSN,
22+
integrations: [
23+
Sentry.reactRouterV7BrowserTracingIntegration({
24+
useEffect: React.useEffect,
25+
useLocation,
26+
useNavigationType,
27+
createRoutesFromChildren,
28+
matchRoutes,
29+
trackFetchStreamPerformance: true,
30+
}),
31+
replay,
32+
],
33+
// We recommend adjusting this value in production, or using tracesSampler
34+
// for finer control
35+
tracesSampleRate: 1.0,
36+
release: 'e2e-test',
37+
38+
// Always capture replays, so we can test this properly
39+
replaysSessionSampleRate: 1.0,
40+
replaysOnErrorSampleRate: 0.0,
41+
tunnel: 'http://localhost:3031',
42+
});
43+
44+
const SentryRoutes = Sentry.withSentryReactRouterV7Routing(Routes);
45+
46+
const root = ReactDOM.createRoot(document.getElementById('root') as HTMLElement);
47+
root.render(
48+
<BrowserRouter>
49+
<SentryRoutes>
50+
<Route path="/" element={<Index />} />
51+
<Route path="/user/:id" element={<User />} />
52+
<Route path="/sse" element={<SSE />} />
53+
</SentryRoutes>
54+
</BrowserRouter>,
55+
);

‎dev-packages/e2e-tests/test-applications/react-router-7-spa/src/pages/Index.tsx

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
// biome-ignore lint/nursery/noUnusedImports: Need React import for JSX
2+
import * as React from 'react';
3+
import { Link } from 'react-router';
4+
5+
const Index = () => {
6+
return (
7+
<>
8+
<input
9+
type="button"
10+
value="Capture Exception"
11+
id="exception-button"
12+
onClick={() => {
13+
throw new Error('I am an error!');
14+
}}
15+
/>
16+
<Link to="/user/5" id="navigation">
17+
navigate
18+
</Link>
19+
</>
20+
);
21+
};
22+
23+
export default Index;

‎dev-packages/e2e-tests/test-applications/react-router-7-spa/src/pages/SSE.tsx

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
import * as Sentry from '@sentry/react';
2+
// biome-ignore lint/nursery/noUnusedImports: Need React import for JSX
3+
import * as React from 'react';
4+
5+
const fetchSSE = async ({ timeout, abort = false }: { timeout: boolean; abort?: boolean }) => {
6+
Sentry.startSpanManual({ name: 'sse stream using fetch' }, async span => {
7+
const controller = new AbortController();
8+
9+
const res = await Sentry.startSpan({ name: 'sse fetch call' }, async () => {
10+
const endpoint = `http://localhost:8080/${timeout ? 'sse-timeout' : 'sse'}`;
11+
12+
const signal = controller.signal;
13+
return await fetch(endpoint, { signal });
14+
});
15+
16+
const stream = res.body;
17+
const reader = stream?.getReader();
18+
19+
const readChunk = async () => {
20+
if (abort) {
21+
controller.abort();
22+
}
23+
const readRes = await reader?.read();
24+
if (readRes?.done) {
25+
return;
26+
}
27+
28+
new TextDecoder().decode(readRes?.value);
29+
30+
await readChunk();
31+
};
32+
33+
try {
34+
await readChunk();
35+
} catch (error) {
36+
console.error('Could not fetch sse', error);
37+
}
38+
39+
span.end();
40+
});
41+
};
42+
43+
const SSE = () => {
44+
return (
45+
<>
46+
<button id="fetch-button" onClick={() => fetchSSE({ timeout: false })}>
47+
Fetch SSE
48+
</button>
49+
<button id="fetch-timeout-button" onClick={() => fetchSSE({ timeout: true })}>
50+
Fetch timeout SSE
51+
</button>
52+
<button id="fetch-sse-abort" onClick={() => fetchSSE({ timeout: false, abort: true })}>
53+
Fetch SSE with error
54+
</button>
55+
</>
56+
);
57+
};
58+
59+
export default SSE;

‎dev-packages/e2e-tests/test-applications/react-router-7-spa/src/pages/User.tsx

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
// biome-ignore lint/nursery/noUnusedImports: Need React import for JSX
2+
import * as React from 'react';
3+
4+
const User = () => {
5+
return <p>I am a blank page :)</p>;
6+
};
7+
8+
export default User;

‎dev-packages/e2e-tests/test-applications/react-router-7-spa/start-event-proxy.mjs

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
import { startEventProxyServer } from '@sentry-internal/test-utils';
2+
3+
startEventProxyServer({
4+
port: 3031,
5+
proxyServerName: 'react-router-7-spa',
6+
});

‎dev-packages/e2e-tests/test-applications/react-router-7-spa/tests/errors.test.ts

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
import { expect, test } from '@playwright/test';
2+
import { waitForError, waitForTransaction } from '@sentry-internal/test-utils';
3+
4+
test('Sends correct error event', async ({ page, baseURL }) => {
5+
const errorEventPromise = waitForError('react-router-7-spa', event => {
6+
return !event.type && event.exception?.values?.[0]?.value === 'I am an error!';
7+
});
8+
9+
await page.goto('/');
10+
11+
const exceptionButton = page.locator('id=exception-button');
12+
await exceptionButton.click();
13+
14+
const errorEvent = await errorEventPromise;
15+
16+
expect(errorEvent.exception?.values).toHaveLength(1);
17+
expect(errorEvent.exception?.values?.[0]?.value).toBe('I am an error!');
18+
19+
expect(errorEvent.request).toEqual({
20+
headers: expect.any(Object),
21+
url: 'http://localhost:3030/',
22+
});
23+
24+
expect(errorEvent.transaction).toEqual('/');
25+
26+
expect(errorEvent.contexts?.trace).toEqual({
27+
trace_id: expect.any(String),
28+
span_id: expect.any(String),
29+
});
30+
});
31+
32+
test('Sets correct transactionName', async ({ page }) => {
33+
const transactionPromise = waitForTransaction('react-router-7-spa', async transactionEvent => {
34+
return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
35+
});
36+
37+
const errorEventPromise = waitForError('react-router-7-spa', event => {
38+
return !event.type && event.exception?.values?.[0]?.value === 'I am an error!';
39+
});
40+
41+
await page.goto('/');
42+
const transactionEvent = await transactionPromise;
43+
44+
// Only capture error once transaction was sent
45+
const exceptionButton = page.locator('id=exception-button');
46+
await exceptionButton.click();
47+
48+
const errorEvent = await errorEventPromise;
49+
50+
expect(errorEvent.exception?.values).toHaveLength(1);
51+
expect(errorEvent.exception?.values?.[0]?.value).toBe('I am an error!');
52+
53+
expect(errorEvent.transaction).toEqual('/');
54+
55+
expect(errorEvent.contexts?.trace).toEqual({
56+
trace_id: transactionEvent.contexts?.trace?.trace_id,
57+
span_id: expect.not.stringContaining(transactionEvent.contexts?.trace?.span_id || ''),
58+
});
59+
});

0 commit comments

Comments
 (0)