-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Document lazyRouteManifest option for React Router v6 and v7
#16397
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
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -151,6 +151,52 @@ ReactDOM.render( | |
|
|
||
| Now, Sentry should generate `pageload`/`navigation` transactions with parameterized transaction names (for example, `/teams/:teamid/user/:userid`), where applicable. This is only needed at the top level of your app, unlike React Router v4/v5, which required wrapping every `<Route />` you wanted parametrized. | ||
|
|
||
| ## Static Route Manifest | ||
|
|
||
| <AvailableSince version="10.39.0" /> | ||
|
|
||
| When using [`patchRoutesOnNavigation`](https://reactrouter.com/6.30.3/routers/create-browser-router#optspatchroutesonnavigation) to dynamically load route definitions, the full route hierarchy isn't available to Sentry until each route is navigated to. This can cause transactions to receive incomplete or wildcard names (for example, `/users/*` instead of `/users/:userId`). | ||
|
|
||
| To ensure accurate transaction names, you can provide a static list of route patterns via the `lazyRouteManifest` option. When provided, Sentry uses this manifest as the primary source for determining transaction names without needing to wait for route modules to load. | ||
|
|
||
| To use `lazyRouteManifest`, you need to set `enableAsyncRouteHandlers: true` in your `reactRouterV6BrowserTracingIntegration` configuration: | ||
|
|
||
| ```javascript {20-27} | ||
| import React from "react"; | ||
| import { | ||
| createRoutesFromChildren, | ||
| matchRoutes, | ||
| useLocation, | ||
| useNavigationType, | ||
| } from "react-router-dom"; | ||
|
|
||
| import * as Sentry from "@sentry/react"; | ||
|
|
||
| Sentry.init({ | ||
| dsn: "___PUBLIC_DSN___", | ||
| integrations: [ | ||
| Sentry.reactRouterV6BrowserTracingIntegration({ | ||
| useEffect: React.useEffect, | ||
| useLocation, | ||
| useNavigationType, | ||
| createRoutesFromChildren, | ||
| matchRoutes, | ||
| enableAsyncRouteHandlers: true, | ||
| lazyRouteManifest: [ | ||
| "/users", | ||
| "/users/:userId", | ||
| "/users/:userId/settings", | ||
| "/dashboard", | ||
| "/dashboard/analytics", | ||
| ], | ||
| }), | ||
| ], | ||
| tracesSampleRate: 1.0, | ||
| }); | ||
| ``` | ||
|
|
||
| Make sure to keep the `lazyRouteManifest` array in sync with your route definitions: if you add, remove, or change routes in your app, update this list accordingly. Any route that doesn't match a pattern in the manifest will fall back to the default behavior, which may result in incomplete transaction names until the route is visited. You can also include non-lazy routes in the manifest for convenience or consistency. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Duplicated documentation content across v6 and v7 filesLow Severity The "Static Route Manifest" section is nearly identical between Additional Locations (1) |
||
|
|
||
| ## Set Up a Custom Error Boundary | ||
|
|
||
| When using `react-router`, errors thrown inside route elements will only be re-thrown in **development mode** while using [`strict mode`](https://react.dev/reference/react/StrictMode).\ | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,8 +5,8 @@ sidebar_order: 10 | |
| --- | ||
|
|
||
| <Alert level="info" title="Looking for framework mode?"> | ||
| React Router v7 (framework mode) is currently in Beta, check out | ||
| the docs [here](/platforms/javascript/guides/react-router/). | ||
| React Router v7 (framework mode) is currently in Beta, check out the docs | ||
| [here](/platforms/javascript/guides/react-router/). | ||
| </Alert> | ||
| Apply the following setup steps based on your routing method and create a | ||
| [custom error boundary](#set-up-a-custom-error-boundary) to make sure Sentry | ||
|
|
@@ -155,6 +155,52 @@ ReactDOM.render( | |
|
|
||
| Now, Sentry should generate `pageload`/`navigation` transactions with parameterized transaction names (for example, `/teams/:teamid/user/:userid`), where applicable. This is only needed at the top level of your app, unlike React Router v4/v5, which required wrapping every `<Route />` you wanted parametrized. | ||
|
|
||
| ## Static Route Manifest | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Could it make sense to create an include for this?
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This would need to exclude the code snippet, I think it can stay like this for now. |
||
|
|
||
| <AvailableSince version="10.39.0" /> | ||
|
|
||
| When using [`patchRoutesOnNavigation`](https://reactrouter.com/api/data-routers/createBrowserRouter#optspatchroutesonnavigation) to dynamically load route definitions, the full route hierarchy isn't available to Sentry until each route is navigated to. This can cause transactions to receive incomplete or wildcard names (for example, `/users/*` instead of `/users/:userId`). | ||
|
|
||
| To ensure accurate transaction names, you can provide a static list of route patterns via the `lazyRouteManifest` option. When provided, Sentry uses this manifest as the primary source for determining transaction names without needing to wait for route modules to load. | ||
|
|
||
| To use `lazyRouteManifest`, you need to set `enableAsyncRouteHandlers: true` in your `reactRouterV7BrowserTracingIntegration` configuration: | ||
|
|
||
| ```javascript {20-27} | ||
| import React from "react"; | ||
| import { | ||
| createRoutesFromChildren, | ||
| matchRoutes, | ||
| useLocation, | ||
| useNavigationType, | ||
| } from "react-router"; | ||
|
|
||
| import * as Sentry from "@sentry/react"; | ||
|
|
||
| Sentry.init({ | ||
| dsn: "___PUBLIC_DSN___", | ||
| integrations: [ | ||
| Sentry.reactRouterV7BrowserTracingIntegration({ | ||
| useEffect: React.useEffect, | ||
| useLocation, | ||
| useNavigationType, | ||
| createRoutesFromChildren, | ||
| matchRoutes, | ||
| enableAsyncRouteHandlers: true, | ||
| lazyRouteManifest: [ | ||
| "/users", | ||
| "/users/:userId", | ||
| "/users/:userId/settings", | ||
| "/dashboard", | ||
| "/dashboard/analytics", | ||
| ], | ||
| }), | ||
| ], | ||
| tracesSampleRate: 1.0, | ||
| }); | ||
| ``` | ||
|
|
||
| Make sure to keep the `lazyRouteManifest` array in sync with your route definitions: if you add, remove, or change routes in your app, update this list accordingly. Any route that doesn't match a pattern in the manifest will fall back to the default behavior, which may result in incomplete transaction names until the route is visited. You can also include non-lazy routes in the manifest for convenience or consistency. | ||
|
|
||
| ## Set Up a Custom Error Boundary | ||
|
|
||
| When using `react-router`, errors thrown inside route elements will only be re-thrown in **development mode** while using [`strict mode`](https://react.dev/reference/react/StrictMode).\ | ||
|
|
||


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.
Let's add the explanation here: