-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
test(react-router): Add e2e tests for react router framework SPA mode #16390
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
e91b1a6
test(react-router): Add e2e tests for SPA mode
RulaKhaled 7fc21d8
Delete dev-packages/e2e-tests/test-applications/nextjs-13/yarn.lock
RulaKhaled c09b0e8
Lint the files
RulaKhaled 9bebe07
fix scripts
RulaKhaled 2a91850
fix tests
RulaKhaled efa962a
remove links
RulaKhaled File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
32 changes: 32 additions & 0 deletions
32
dev-packages/e2e-tests/test-applications/react-router-7-framework-spa/.gitignore
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| # 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 | ||
|
|
||
| # react router | ||
| .react-router |
2 changes: 2 additions & 0 deletions
2
dev-packages/e2e-tests/test-applications/react-router-7-framework-spa/.npmrc
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| @sentry:registry=http://127.0.0.1:4873 | ||
| @sentry-internal:registry=http://127.0.0.1:4873 |
15 changes: 15 additions & 0 deletions
15
dev-packages/e2e-tests/test-applications/react-router-7-framework-spa/app/app.css
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| @import 'tailwindcss'; | ||
|
|
||
| @theme { | ||
| --font-sans: 'Inter', ui-sans-serif, system-ui, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol', | ||
| 'Noto Color Emoji'; | ||
| } | ||
|
|
||
| html, | ||
| body { | ||
| @apply bg-white dark:bg-gray-950; | ||
|
|
||
| @media (prefers-color-scheme: dark) { | ||
| color-scheme: dark; | ||
| } | ||
| } |
23 changes: 23 additions & 0 deletions
23
dev-packages/e2e-tests/test-applications/react-router-7-framework-spa/app/entry.client.tsx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| import * as Sentry from '@sentry/react-router'; | ||
| import { StrictMode, startTransition } from 'react'; | ||
| import { hydrateRoot } from 'react-dom/client'; | ||
| import { HydratedRouter } from 'react-router/dom'; | ||
|
|
||
| Sentry.init({ | ||
| environment: 'qa', // dynamic sampling bias to keep transactions | ||
| // todo: get this from env | ||
| dsn: 'https://username@domain/123', | ||
| integrations: [Sentry.reactRouterTracingIntegration()], | ||
| tracesSampleRate: 1.0, | ||
| tunnel: `http://localhost:3031/`, // proxy server | ||
| tracePropagationTargets: [/^\//], | ||
| }); | ||
|
|
||
| startTransition(() => { | ||
| hydrateRoot( | ||
| document, | ||
| <StrictMode> | ||
| <HydratedRouter /> | ||
| </StrictMode>, | ||
| ); | ||
| }); |
65 changes: 65 additions & 0 deletions
65
dev-packages/e2e-tests/test-applications/react-router-7-framework-spa/app/root.tsx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| import { | ||
| isRouteErrorResponse, | ||
| Links, | ||
| Meta, | ||
| Outlet, | ||
| Scripts, | ||
| ScrollRestoration, | ||
| } from "react-router"; | ||
|
|
||
| import type { Route } from "./+types/root"; | ||
| import "./app.css"; | ||
| import * as Sentry from '@sentry/react-router'; | ||
|
|
||
| export function Layout({ children }: { children: React.ReactNode }) { | ||
| return ( | ||
| <html lang="en"> | ||
| <head> | ||
| <meta charSet="utf-8" /> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1" /> | ||
| <Meta /> | ||
| <Links /> | ||
| </head> | ||
| <body> | ||
| {children} | ||
| <ScrollRestoration /> | ||
| <Scripts /> | ||
| </body> | ||
| </html> | ||
| ); | ||
| } | ||
|
|
||
| export default function App() { | ||
| return <Outlet />; | ||
| } | ||
|
|
||
| export function ErrorBoundary({ error }: Route.ErrorBoundaryProps) { | ||
| let message = "Oops!"; | ||
| let details = "An unexpected error occurred."; | ||
| let stack: string | undefined; | ||
|
|
||
| if (isRouteErrorResponse(error)) { | ||
| message = error.status === 404 ? "404" : "Error"; | ||
| details = | ||
| error.status === 404 | ||
| ? "The requested page could not be found." | ||
| : error.statusText || details; | ||
| } else if (error && error instanceof Error) { | ||
| Sentry.captureException(error); | ||
|
|
||
| details = error.message; | ||
| stack = error.stack; | ||
| } | ||
|
|
||
| return ( | ||
| <main className="pt-16 p-4 container mx-auto"> | ||
| <h1>{message}</h1> | ||
| <p>{details}</p> | ||
| {stack && ( | ||
| <pre className="w-full p-4 overflow-x-auto"> | ||
| <code>{stack}</code> | ||
| </pre> | ||
| )} | ||
| </main> | ||
| ); | ||
| } |
15 changes: 15 additions & 0 deletions
15
dev-packages/e2e-tests/test-applications/react-router-7-framework-spa/app/routes.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| import { type RouteConfig, index, prefix, route } from '@react-router/dev/routes'; | ||
|
|
||
| export default [ | ||
| index('routes/home.tsx'), | ||
| ...prefix('errors', [ | ||
| route('client', 'routes/errors/client.tsx'), | ||
| route('client/:client-param', 'routes/errors/client-param.tsx'), | ||
| route('client-loader', 'routes/errors/client-loader.tsx'), | ||
| route('client-action', 'routes/errors/client-action.tsx'), | ||
| ]), | ||
| ...prefix('performance', [ | ||
| index('routes/performance/index.tsx'), | ||
| route('with/:param', 'routes/performance/dynamic-param.tsx'), | ||
| ]), | ||
| ] satisfies RouteConfig; |
18 changes: 18 additions & 0 deletions
18
...-tests/test-applications/react-router-7-framework-spa/app/routes/errors/client-action.tsx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| import { Form } from 'react-router'; | ||
|
|
||
| export function clientAction() { | ||
| throw new Error('Madonna mia! Che casino nella Client Action!'); | ||
| } | ||
|
|
||
| export default function ClientActionErrorPage() { | ||
| return ( | ||
| <div> | ||
| <h1>Client Error Action Page</h1> | ||
| <Form method="post"> | ||
| <button id="submit" type="submit"> | ||
| Submit | ||
| </button> | ||
| </Form> | ||
| </div> | ||
| ); | ||
| } |
15 changes: 15 additions & 0 deletions
15
...-tests/test-applications/react-router-7-framework-spa/app/routes/errors/client-loader.tsx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| import type { Route } from './+types/client-loader'; | ||
|
|
||
| export function clientLoader() { | ||
| throw new Error('¡Madre mía del client loader!'); | ||
| } | ||
|
|
||
| export default function ClientLoaderErrorPage({ loaderData }: Route.ComponentProps) { | ||
| const { data } = loaderData ?? { data: 'sad' }; | ||
| return ( | ||
| <div> | ||
| <h1>Client Loader Error Page</h1> | ||
| <div>{data}</div> | ||
| </div> | ||
| ); | ||
| } |
17 changes: 17 additions & 0 deletions
17
...e-tests/test-applications/react-router-7-framework-spa/app/routes/errors/client-param.tsx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| import type { Route } from './+types/client-param'; | ||
|
|
||
| export default function ClientErrorParamPage({ params }: Route.ComponentProps) { | ||
| return ( | ||
| <div> | ||
| <h1>Client Error Param Page</h1> | ||
| <button | ||
| id="throw-on-click" | ||
| onClick={() => { | ||
| throw new Error(`¡Madre mía de ${params['client-param']}!`); | ||
| }} | ||
| > | ||
| Throw Error | ||
| </button> | ||
| </div> | ||
| ); | ||
| } |
15 changes: 15 additions & 0 deletions
15
...ges/e2e-tests/test-applications/react-router-7-framework-spa/app/routes/errors/client.tsx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| export default function ClientErrorPage() { | ||
| return ( | ||
| <div> | ||
| <h1>Client Error Page</h1> | ||
| <button | ||
| id="throw-on-click" | ||
| onClick={() => { | ||
| throw new Error('¡Madre mía!'); | ||
| }} | ||
| > | ||
| Throw Error | ||
| </button> | ||
| </div> | ||
| ); | ||
| } | ||
34 changes: 34 additions & 0 deletions
34
dev-packages/e2e-tests/test-applications/react-router-7-framework-spa/app/routes/home.tsx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| import type { Route } from './+types/home'; | ||
| import { Link } from 'react-router'; | ||
|
|
||
| export function meta({}: Route.MetaArgs) { | ||
| return [{ title: 'New React Router App' }, { name: 'description', content: 'Welcome to React Router!' }]; | ||
| } | ||
|
|
||
| export default function Home() { | ||
| return ( | ||
| <div> | ||
| <h1>Hello,This is an SPA React Router app</h1> | ||
| <div> | ||
| <br /> | ||
| <br /> | ||
| <h2>Performance Pages, click pages to get redirected</h2> | ||
| <ul> | ||
| <li><Link to="/performance">Performance page</Link></li> | ||
| <li><Link to="/performance/static">Static Page</Link></li> | ||
| <li><Link to="/performance/dynamic-param/123">Dynamic Parameter Page</Link></li> | ||
| </ul> | ||
| </div> | ||
| <div> | ||
| <br /> | ||
| <h2>Error Pages, click button to trigger error</h2> | ||
| <ul> | ||
| <li><Link to="/errors/client">Client Error</Link></li> | ||
| <li><Link to="/errors/client-action">Client Action Error</Link></li> | ||
| <li><Link to="/errors/client-loader">Client Loader Error</Link></li> | ||
| <li><Link to="/errors/client-param/123">Client Parameter Error</Link></li> | ||
| </ul> | ||
| </div> | ||
| </div> | ||
| ); | ||
| } |
13 changes: 13 additions & 0 deletions
13
...s/test-applications/react-router-7-framework-spa/app/routes/performance/dynamic-param.tsx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| import type { Route } from './+types/dynamic-param'; | ||
|
|
||
|
|
||
| export default function DynamicParamPage({ params }: Route.ComponentProps) { | ||
| const { param } = params; | ||
|
|
||
| return ( | ||
| <div> | ||
| <h1>Dynamic Parameter Page</h1> | ||
| <p>The parameter value is: {param}</p> | ||
| </div> | ||
| ); | ||
| } |
12 changes: 12 additions & 0 deletions
12
...e2e-tests/test-applications/react-router-7-framework-spa/app/routes/performance/index.tsx
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| import { Link } from 'react-router'; | ||
|
|
||
| export default function PerformancePage() { | ||
| return ( | ||
| <div> | ||
| <h1>Performance Page</h1> | ||
| <nav> | ||
| <Link to="/performance/with/sentry">With Param Page</Link> | ||
| </nav> | ||
| </div> | ||
| ); | ||
| } |
56 changes: 56 additions & 0 deletions
56
dev-packages/e2e-tests/test-applications/react-router-7-framework-spa/package.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| { | ||
| "name": "react-router-7-framework-spa", | ||
| "private": true, | ||
| "version": "0.1.0", | ||
| "type": "module", | ||
| "scripts": { | ||
| "build": "react-router build", | ||
| "dev": "react-router dev", | ||
| "start": "vite preview", | ||
| "preview": "vite preview", | ||
| "typecheck": "react-router typegen && tsc", | ||
| "clean": "pnpx rimraf node_modules pnpm-lock.yaml", | ||
| "test:build": "pnpm install && pnpm build", | ||
| "test:ts": "pnpm typecheck", | ||
| "test:prod": "playwright test", | ||
| "test:dev": "TEST_ENV=development playwright test", | ||
| "test:assert": "pnpm test:ts &&pnpm test:prod" | ||
| }, | ||
| "dependencies": { | ||
| "@sentry/react-router": "latest || *", | ||
| "@react-router/node": "^7.5.3", | ||
| "@react-router/serve": "^7.5.3", | ||
| "isbot": "^5.1.27", | ||
| "react": "^18.3.1", | ||
| "react-dom": "^18.3.1", | ||
| "react-router": "^7.1.5" | ||
| }, | ||
| "devDependencies": { | ||
| "@playwright/test": "^1.52.0", | ||
| "@react-router/dev": "^7.5.3", | ||
| "@sentry-internal/test-utils": "link:../../../test-utils", | ||
| "@tailwindcss/vite": "^4.1.4", | ||
| "@types/node": "^20", | ||
| "@types/react": "^19.1.2", | ||
| "@types/react-dom": "^19.1.2", | ||
| "tailwindcss": "^4.1.4", | ||
| "typescript": "^5.8.3", | ||
| "vite": "^6.3.3", | ||
| "vite-tsconfig-paths": "^5.1.4" | ||
| }, | ||
| "browserslist": { | ||
| "production": [ | ||
| ">0.2%", | ||
| "not dead", | ||
| "not op_mini all" | ||
| ], | ||
| "development": [ | ||
| "last 1 chrome version", | ||
| "last 1 firefox version", | ||
| "last 1 safari version" | ||
| ] | ||
| }, | ||
| "volta": { | ||
| "extends": "../../package.json" | ||
| } | ||
| } |
8 changes: 8 additions & 0 deletions
8
dev-packages/e2e-tests/test-applications/react-router-7-framework-spa/playwright.config.mjs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| import { getPlaywrightConfig } from '@sentry-internal/test-utils'; | ||
|
|
||
| const config = getPlaywrightConfig({ | ||
| startCommand: 'pnpm start', | ||
| port: 4173, | ||
| }); | ||
|
|
||
| export default config; |
Binary file added
BIN
+14.7 KB
dev-packages/e2e-tests/test-applications/react-router-7-framework-spa/public/favicon.ico
Binary file not shown.
5 changes: 5 additions & 0 deletions
5
dev-packages/e2e-tests/test-applications/react-router-7-framework-spa/react-router.config.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| import type { Config } from "@react-router/dev/config"; | ||
|
|
||
| export default { | ||
| ssr: false, | ||
| } satisfies Config; |
6 changes: 6 additions & 0 deletions
6
dev-packages/e2e-tests/test-applications/react-router-7-framework-spa/start-event-proxy.mjs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| import { startEventProxyServer } from '@sentry-internal/test-utils'; | ||
|
|
||
| startEventProxyServer({ | ||
| port: 3031, | ||
| proxyServerName: 'react-router-7-framework-spa', | ||
| }); |
1 change: 1 addition & 0 deletions
1
dev-packages/e2e-tests/test-applications/react-router-7-framework-spa/tests/constants.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| export const APP_NAME = 'react-router-7-framework-spa'; |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice error messages 😂