Skip to content

feat(react-router): Export wrappers for server loaders and actions #16481

New issue

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

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

Already on GitHub? # to your account

Merged
merged 3 commits into from
Jun 5, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
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
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
html,
body {
@media (prefers-color-scheme: dark) {
color-scheme: dark;
}
}
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',
tunnel: `http://localhost:3031/`, // proxy server
integrations: [Sentry.reactRouterTracingIntegration()],
tracesSampleRate: 1.0,
tracePropagationTargets: [/^\//],
});

startTransition(() => {
hydrateRoot(
document,
<StrictMode>
<HydratedRouter />
</StrictMode>,
);
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
import { createReadableStreamFromReadable } from '@react-router/node';
import * as Sentry from '@sentry/react-router';
import { renderToPipeableStream } from 'react-dom/server';
import { ServerRouter } from 'react-router';
import { type HandleErrorFunction } from 'react-router';

const ABORT_DELAY = 5_000;

const handleRequest = Sentry.createSentryHandleRequest({
streamTimeout: ABORT_DELAY,
ServerRouter,
renderToPipeableStream,
createReadableStreamFromReadable,
});

export default handleRequest;

export const handleError: HandleErrorFunction = (error, { request }) => {
// React Router may abort some interrupted requests, don't log those
if (!request.signal.aborted) {
Sentry.captureException(error);

// make sure to still log the error so you can see it
console.error(error);
}
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
import * as Sentry from '@sentry/react-router';
import { Links, Meta, Outlet, Scripts, ScrollRestoration, isRouteErrorResponse } from 'react-router';
import type { Route } from './+types/root';
import stylesheet from './app.css?url';

export const links: Route.LinksFunction = () => [
{ rel: 'preconnect', href: 'https://fonts.googleapis.com' },
{
rel: 'preconnect',
href: 'https://fonts.gstatic.com',
crossOrigin: 'anonymous',
},
{
rel: 'stylesheet',
href: 'https://fonts.googleapis.com/css2?family=Inter:ital,opsz,wght@0,14..32,100..900;1,14..32,100..900&display=swap',
},
{ rel: 'stylesheet', href: stylesheet },
];

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);
if (import.meta.env.DEV) {
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>
);
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
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('server-loader', 'routes/errors/server-loader.tsx'),
route('client-action', 'routes/errors/client-action.tsx'),
route('server-action', 'routes/errors/server-action.tsx'),
]),
...prefix('performance', [
index('routes/performance/index.tsx'),
route('ssr', 'routes/performance/ssr.tsx'),
route('with/:param', 'routes/performance/dynamic-param.tsx'),
route('static', 'routes/performance/static.tsx'),
route('server-loader', 'routes/performance/server-loader.tsx'),
route('server-action', 'routes/performance/server-action.tsx'),
]),
] satisfies RouteConfig;
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>
);
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
import type { Route } from './+types/server-loader';

export function clientLoader() {
throw new Error('¡Madre mía del client loader!');
return { data: 'sad' };
}

export default function ClientLoaderErrorPage({ loaderData }: Route.ComponentProps) {
const { data } = loaderData;
return (
<div>
<h1>Client Loader Error Page</h1>
<div>{data}</div>
</div>
);
}
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>
);
}
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>
);
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import { Form } from 'react-router';

export function action() {
throw new Error('Madonna mia! Che casino nella Server Action!');
}

export default function ServerActionErrorPage() {
return (
<div>
<h1>Server Error Action Page</h1>
<Form method="post">
<button id="submit" type="submit">
Submit
</button>
</Form>
</div>
);
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
import type { Route } from './+types/server-loader';

export function loader() {
throw new Error('¡Madre mía del server!');
return { data: 'sad' };
}

export default function ServerLoaderErrorPage({ loaderData }: Route.ComponentProps) {
const { data } = loaderData;
return (
<div>
<h1>Server Error Page</h1>
<div>{data}</div>
</div>
);
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import type { Route } from './+types/home';

export function meta({}: Route.MetaArgs) {
return [{ title: 'New React Router App' }, { name: 'description', content: 'Welcome to React Router!' }];
}

export default function Home() {
return <div>home</div>;
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
import type { Route } from './+types/dynamic-param';

export async function loader() {
await new Promise(resolve => setTimeout(resolve, 500));
return { data: 'burritos' };
}

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>
);
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import { Link } from 'react-router';

export default function PerformancePage() {
return (
<div>
<h1>Performance Page</h1>
<nav>
<Link to="/performance/ssr">SSR Page</Link>
<Link to="/performance/with/sentry">With Param Page</Link>
<Link to="/performance/server-loader">Server Loader</Link>
</nav>
</div>
);
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
import { Form } from 'react-router';
import type { Route } from './+types/server-action';
import * as Sentry from '@sentry/react-router';

export const action = Sentry.wrapServerAction({}, async ({ request }: Route.ActionArgs) => {
let formData = await request.formData();
let name = formData.get('name');
await new Promise(resolve => setTimeout(resolve, 1000));
return {
greeting: `Hola ${name}`,
};
});

export default function Project({ actionData }: Route.ComponentProps) {
return (
<div>
<h1>Server action page</h1>
<Form method="post">
<input type="text" name="name" />
<button type="submit">Submit</button>
</Form>
{actionData ? <p>{actionData.greeting}</p> : null}
</div>
);
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
import type { Route } from './+types/server-loader';
import * as Sentry from '@sentry/react-router';

export const loader = Sentry.wrapServerLoader({}, async ({}: Route.LoaderArgs) => {
await new Promise(resolve => setTimeout(resolve, 500));
return { data: 'burritos' };
});

export default function ServerLoaderPage({ loaderData }: Route.ComponentProps) {
const { data } = loaderData;
return (
<div>
<h1>Server Loader Page</h1>
<div>{data}</div>
</div>
);
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
export default function SsrPage() {
return (
<div>
<h1>SSR Page</h1>
</div>
);
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
export default function StaticPage() {
return <h1>Static Page</h1>;
}
Loading
Loading