-
-
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
Open
onurtemizkan
wants to merge
4
commits into
master
Choose a base branch
from
onur/react-router-lazy-routes-manifest
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+94
−2
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
fc58840
Document lazyRouteManifest option for React Router v6 and v7
onurtemizkan 3d9bb0e
Merge branch 'master' into onur/react-router-lazy-routes-manifest
onurtemizkan 657d0ad
Address review feedback
onurtemizkan 99343d0
Move paragraph above code snippet
onurtemizkan 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
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
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 |
|---|---|---|
|
|
@@ -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. | ||
|
|
||
| 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. | ||
|
|
||
| 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, | ||
| }); | ||
| ``` | ||
|
|
||
| ## 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).\ | ||
|
|
||
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.
Let's add the explanation here: