fix(react/v8): Support lazy-loaded routes and components#15281

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.

Sign up for GitHub

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
s1gr1d merged 1 commit into from
Feb 11, 2025
Merged

fix(react/v8): Support lazy-loaded routes and components #15281

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 10 additions & 1 deletion dev-packages/e2e-tests/test-applications/react-create-browser-router/src/index.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import * as Sentry from '@sentry/react';
import React from 'react';
import React, { lazy, Suspense } from 'react';
import ReactDOM from 'react-dom/client';
import {
RouterProvider,
Expand DownExpand Up@@ -42,13 +42,22 @@ Sentry.init({
});

const sentryCreateBrowserRouter = Sentry.wrapCreateBrowserRouterV6(createBrowserRouter);
const LazyLoadedUser = lazy(() => import('./pages/LazyLoadedUser'));

const router = sentryCreateBrowserRouter(
[
{
path: '/',
element: <Index />,
},
{
path: '/lazy-loaded-user/*',
element: (
<Suspense fallback={<div>Loading...</div>}>
<LazyLoadedUser />
</Suspense>
),
},
{
path: '/user/:id',
element: <User />,
Expand Down
3 changes: 3 additions & 0 deletions dev-packages/e2e-tests/test-applications/react-create-browser-router/src/pages/Index.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,9 @@ const Index = () => {
<Linkto="/user/5"id="navigation">
navigate
</Link>
<Linkto="/lazy-loaded-user/5/foo"id="lazy-navigation">
lazy navigate
</Link>
</>
);
};
Expand Down
14 changes: 14 additions & 0 deletions ...2e-tests/test-applications/react-create-browser-router/src/pages/LazyLoadedInnerRoute.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
import * as Sentry from '@sentry/react';
// biome-ignore lint/nursery/noUnusedImports: Need React import for JSX
import * as React from 'react';
import { Route, Routes } from 'react-router-dom';

const SentryRoutes = Sentry.withSentryReactRouterV6Routing(Routes);

const InnerRoute = () => (
<SentryRoutes>
<Route path=":innerId" element={<p id="content">I am a lazy loaded user</p>} />
</SentryRoutes>
);

export default InnerRoute;
23 changes: 23 additions & 0 deletions ...ages/e2e-tests/test-applications/react-create-browser-router/src/pages/LazyLoadedUser.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import * as Sentry from '@sentry/react';
import * as React from 'react';
import { Route, Routes } from 'react-router-dom';

const SentryRoutes = Sentry.withSentryReactRouterV6Routing(Routes);
const InnerRoute = React.lazy(() => import('./LazyLoadedInnerRoute'));

const LazyLoadedUser = () => {
return (
<SentryRoutes>
<Route
path=":id/*"
element={
<React.Suspense fallback={<p>Loading...</p>}>
<InnerRoute />
</React.Suspense>
}
/>
</SentryRoutes>
);
};

export default LazyLoadedUser;
102 changes: 102 additions & 0 deletions ...ckages/e2e-tests/test-applications/react-create-browser-router/tests/transactions.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -76,3 +76,105 @@ test('Captures a navigation transaction', async ({ page }) => {

expect(transactionEvent.spans).toEqual([]);
});

test('Captures a lazy pageload transaction', async ({ page }) => {
const transactionEventPromise = waitForTransaction('react-create-browser-router', event => {
return event.contexts?.trace?.op === 'pageload';
});

await page.goto('/lazy-loaded-user/5/foo');

const transactionEvent = await transactionEventPromise;
expect(transactionEvent.contexts?.trace).toEqual({
data: expect.objectContaining({
'sentry.idle_span_finish_reason': 'idleTimeout',
'sentry.op': 'pageload',
'sentry.origin': 'auto.pageload.react.reactrouter_v6',
'sentry.sample_rate': 1,
'sentry.source': 'route',
}),
op: 'pageload',
span_id: expect.stringMatching(/[a-f0-9]{16}/),
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
origin: 'auto.pageload.react.reactrouter_v6',
});

expect(transactionEvent).toEqual(
expect.objectContaining({
transaction: '/lazy-loaded-user/:id/:innerId',
type: 'transaction',
transaction_info: {
source: 'route',
},
}),
);

expect(await page.innerText('id=content')).toContain('I am a lazy loaded user');

expect(transactionEvent.spans).toEqual(
expect.arrayContaining([
// This one is the outer lazy route
expect.objectContaining({
op: 'resource.script',
origin: 'auto.resource.browser.metrics',
}),
// This one is the inner lazy route
expect.objectContaining({
op: 'resource.script',
origin: 'auto.resource.browser.metrics',
}),
]),
);
});

test('Captures a lazy navigation transaction', async ({ page }) => {
const transactionEventPromise = waitForTransaction('react-create-browser-router', event => {
return event.contexts?.trace?.op === 'navigation';
});

await page.goto('/');
const linkElement = page.locator('id=lazy-navigation');
await linkElement.click();

const transactionEvent = await transactionEventPromise;
expect(transactionEvent.contexts?.trace).toEqual({
data: expect.objectContaining({
'sentry.idle_span_finish_reason': 'idleTimeout',
'sentry.op': 'navigation',
'sentry.origin': 'auto.navigation.react.reactrouter_v6',
'sentry.sample_rate': 1,
'sentry.source': 'route',
}),
op: 'navigation',
span_id: expect.stringMatching(/[a-f0-9]{16}/),
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
origin: 'auto.navigation.react.reactrouter_v6',
});

expect(transactionEvent).toEqual(
expect.objectContaining({
transaction: '/lazy-loaded-user/:id/:innerId',
type: 'transaction',
transaction_info: {
source: 'route',
},
}),
);

expect(await page.innerText('id=content')).toContain('I am a lazy loaded user');

expect(transactionEvent.spans).toEqual(
expect.arrayContaining([
// This one is the outer lazy route
expect.objectContaining({
op: 'resource.script',
origin: 'auto.resource.browser.metrics',
}),
// This one is the inner lazy route
expect.objectContaining({
op: 'resource.script',
origin: 'auto.resource.browser.metrics',
}),
]),
);
});
62 changes: 45 additions & 17 deletions packages/react/src/reactrouterv6-compat-utils.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -62,6 +62,9 @@ export interface ReactRouterOptions {

type V6CompatibleVersion = '6' | '7';

// Keeping as a global variable for cross-usage in multiple functions
const allRoutes = new Set<RouteObject>();

/**
* Creates a wrapCreateBrowserRouter function that can be used with all React Router v6 compatible versions.
*/
Expand All@@ -82,6 +85,10 @@ export function createV6CompatibleWrapCreateBrowserRouter<
}

return function (routes: RouteObject[], opts?: Record<string, unknown> & { basename?: string }): TRouter {
routes.forEach(route => {
allRoutes.add(route);
});

const router = createRouterFunction(routes, opts);
const basename = opts && opts.basename;

Expand All@@ -91,19 +98,40 @@ export function createV6CompatibleWrapCreateBrowserRouter<
// This is the earliest convenient time to update the transaction name.
// Callbacks to `router.subscribe` are not called for the initial load.
if (router.state.historyAction === 'POP' && activeRootSpan) {
updatePageloadTransaction(activeRootSpan, router.state.location, routes, undefined, basename);
updatePageloadTransaction(
activeRootSpan,
router.state.location,
routes,
undefined,
basename,
Array.from(allRoutes),
);
}

router.subscribe((state: RouterState) => {
const location = state.location;
if (state.historyAction === 'PUSH' || state.historyAction === 'POP') {
handleNavigation({
location,
routes,
navigationType: state.historyAction,
version,
basename,
});
// Wait for the next render if loading an unsettled route
if (state.navigation.state !== 'idle') {
requestAnimationFrame(() => {
handleNavigation({
location: state.location,
routes,
navigationType: state.historyAction,
version,
basename,
allRoutes: Array.from(allRoutes),
});
});
} else {
handleNavigation({
location: state.location,
routes,
navigationType: state.historyAction,
version,
basename,
allRoutes: Array.from(allRoutes),
});
}
}
});

Expand DownExpand Up@@ -138,6 +166,10 @@ export function createV6CompatibleWrapCreateMemoryRouter<
initialIndex?: number;
},
): TRouter {
routes.forEach(route => {
allRoutes.add(route);
});

const router = createRouterFunction(routes, opts);
const basename = opts ? opts.basename : undefined;

Expand All@@ -163,7 +195,7 @@ export function createV6CompatibleWrapCreateMemoryRouter<
: router.state.location;

if (router.state.historyAction === 'POP' && activeRootSpan) {
updatePageloadTransaction(activeRootSpan, location, routes, undefined, basename);
updatePageloadTransaction(activeRootSpan, location, routes, undefined, basename, Array.from(allRoutes));
}

router.subscribe((state: RouterState) => {
Expand All@@ -175,6 +207,7 @@ export function createV6CompatibleWrapCreateMemoryRouter<
navigationType: state.historyAction,
version,
basename,
allRoutes: Array.from(allRoutes),
});
}
});
Expand DownExpand Up@@ -249,8 +282,6 @@ export function createV6CompatibleWrapUseRoutes(origUseRoutes: UseRoutes, versio
return origUseRoutes;
}

const allRoutes: Set<RouteObject> = new Set();

const SentryRoutes: React.FC<{
children?: React.ReactNode;
routes: RouteObject[];
Expand DownExpand Up@@ -322,7 +353,6 @@ export function handleNavigation(opts: {
allRoutes?: RouteObject[];
}): void {
const { location, routes, navigationType, version, matches, basename, allRoutes } = opts;

const branches = Array.isArray(matches) ? matches : _matchRoutes(routes, location, basename);

const client = getClient();
Expand DownExpand Up@@ -558,7 +588,7 @@ function updatePageloadTransaction(
): void {
const branches = Array.isArray(matches)
? matches
: (_matchRoutes(routes, location, basename) as unknown as RouteMatch[]);
: (_matchRoutes(allRoutes || routes, location, basename) as unknown as RouteMatch[]);

if (branches) {
let name,
Expand All@@ -574,7 +604,7 @@ function updatePageloadTransaction(
[name, source] = getNormalizedName(routes, location, branches, basename);
}

getCurrentScope().setTransactionName(name);
getCurrentScope().setTransactionName(name || '/');

if (activeRootSpan) {
activeRootSpan.updateName(name);
Expand All@@ -597,8 +627,6 @@ export function createV6CompatibleWithSentryReactRouterRouting<P extends Record<
return Routes;
}

const allRoutes: Set<RouteObject> = new Set();

const SentryRoutes: React.FC<P> = (props: P) => {
const isMountRenderPass = React.useRef(true);

Expand Down
11 changes: 8 additions & 3 deletions packages/react/src/types.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -182,10 +182,14 @@ export interface RouterInit {
hydrationData?: HydrationState;
}

export type NavigationState = {
state: 'idle' | 'loading' | 'submitting';
};

export type NavigationStates = {
Idle: any;
Loading: any;
Submitting: any;
Idle: NavigationState;
Loading: NavigationState;
Submitting: NavigationState;
};

export type Navigation = NavigationStates[keyof NavigationStates];
Expand All@@ -202,6 +206,7 @@ export declare enum HistoryAction {
export interface RouterState {
historyAction: Action | HistoryAction | any;
location: Location;
navigation: Navigation;
}
export interface Router<TState extends RouterState = RouterState> {
state: TState;
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
fix(react/v8): Support lazy-loaded routes and components#15281

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.

 Sign up for GitHub

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

s1gr1d
merged 1 commit into

from

Feb 11, 2025
 Merged


fix(react/v8): Support lazy-loaded routes and components
#15281
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


11 changes: 10 additions & 1 deletion
dev-packages/e2e-tests/test-applications/react-create-browser-router/src/index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import * as Sentry from '@sentry/react';
import React from 'react';
import React, { lazy, Suspense } from 'react';
import ReactDOM from 'react-dom/client';
import {
 RouterProvider,
Expand DownExpand Up@@ -42,13 +42,22 @@ Sentry.init({
});

const sentryCreateBrowserRouter = Sentry.wrapCreateBrowserRouterV6(createBrowserRouter);
const LazyLoadedUser = lazy(() => import('./pages/LazyLoadedUser'));

const router = sentryCreateBrowserRouter(
 [
 {
 path: '/',
 element: <Index />,
 },
 {
 path: '/lazy-loaded-user/*',
 element: (
 <Suspense fallback={<div>Loading...</div>}>
 <LazyLoadedUser />
 </Suspense>
 ),
 },
 {
 path: '/user/:id',
 element: <User />,
Expand Down

3 changes: 3 additions & 0 deletions
dev-packages/e2e-tests/test-applications/react-create-browser-router/src/pages/Index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,9 @@ const Index = () => {
<Linkto="/user/5"id="navigation">
 navigate
</Link>
<Linkto="/lazy-loaded-user/5/foo"id="lazy-navigation">
 lazy navigate
</Link>
</>
);
};
Expand Down

14 changes: 14 additions & 0 deletions
...2e-tests/test-applications/react-create-browser-router/src/pages/LazyLoadedInnerRoute.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
import * as Sentry from '@sentry/react';
// biome-ignore lint/nursery/noUnusedImports: Need React import for JSX
import * as React from 'react';
import { Route, Routes } from 'react-router-dom';

const SentryRoutes = Sentry.withSentryReactRouterV6Routing(Routes);

const InnerRoute = () => (
 <SentryRoutes>
 <Route path=":innerId" element={<p id="content">I am a lazy loaded user</p>} />
 </SentryRoutes>
);

export default InnerRoute;

23 changes: 23 additions & 0 deletions
...ages/e2e-tests/test-applications/react-create-browser-router/src/pages/LazyLoadedUser.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import * as Sentry from '@sentry/react';
import * as React from 'react';
import { Route, Routes } from 'react-router-dom';

const SentryRoutes = Sentry.withSentryReactRouterV6Routing(Routes);
const InnerRoute = React.lazy(() => import('./LazyLoadedInnerRoute'));

const LazyLoadedUser = () => {
 return (
 <SentryRoutes>
 <Route
 path=":id/*"
 element={
 <React.Suspense fallback={<p>Loading...</p>}>
 <InnerRoute />
 </React.Suspense>
 }
 />
 </SentryRoutes>
 );
};

export default LazyLoadedUser;

102 changes: 102 additions & 0 deletions
...ckages/e2e-tests/test-applications/react-create-browser-router/tests/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,3 +76,105 @@ test('Captures a navigation transaction', async ({ page }) => {

 expect(transactionEvent.spans).toEqual([]);
});

test('Captures a lazy pageload transaction', async ({ page }) => {
 const transactionEventPromise = waitForTransaction('react-create-browser-router', event => {
 return event.contexts?.trace?.op === 'pageload';
 });

 await page.goto('/lazy-loaded-user/5/foo');

 const transactionEvent = await transactionEventPromise;
 expect(transactionEvent.contexts?.trace).toEqual({
 data: expect.objectContaining({
 'sentry.idle_span_finish_reason': 'idleTimeout',
 'sentry.op': 'pageload',
 'sentry.origin': 'auto.pageload.react.reactrouter_v6',
 'sentry.sample_rate': 1,
 'sentry.source': 'route',
 }),
 op: 'pageload',
 span_id: expect.stringMatching(/[a-f0-9]{16}/),
 trace_id: expect.stringMatching(/[a-f0-9]{32}/),
 origin: 'auto.pageload.react.reactrouter_v6',
 });

 expect(transactionEvent).toEqual(
 expect.objectContaining({
 transaction: '/lazy-loaded-user/:id/:innerId',
 type: 'transaction',
 transaction_info: {
 source: 'route',
 },
 }),
 );

 expect(await page.innerText('id=content')).toContain('I am a lazy loaded user');

 expect(transactionEvent.spans).toEqual(
 expect.arrayContaining([
 // This one is the outer lazy route
 expect.objectContaining({
 op: 'resource.script',
 origin: 'auto.resource.browser.metrics',
 }),
 // This one is the inner lazy route
 expect.objectContaining({
 op: 'resource.script',
 origin: 'auto.resource.browser.metrics',
 }),
 ]),
 );
});

test('Captures a lazy navigation transaction', async ({ page }) => {
 const transactionEventPromise = waitForTransaction('react-create-browser-router', event => {
 return event.contexts?.trace?.op === 'navigation';
 });

 await page.goto('/');
 const linkElement = page.locator('id=lazy-navigation');
 await linkElement.click();

 const transactionEvent = await transactionEventPromise;
 expect(transactionEvent.contexts?.trace).toEqual({
 data: expect.objectContaining({
 'sentry.idle_span_finish_reason': 'idleTimeout',
 'sentry.op': 'navigation',
 'sentry.origin': 'auto.navigation.react.reactrouter_v6',
 'sentry.sample_rate': 1,
 'sentry.source': 'route',
 }),
 op: 'navigation',
 span_id: expect.stringMatching(/[a-f0-9]{16}/),
 trace_id: expect.stringMatching(/[a-f0-9]{32}/),
 origin: 'auto.navigation.react.reactrouter_v6',
 });

 expect(transactionEvent).toEqual(
 expect.objectContaining({
 transaction: '/lazy-loaded-user/:id/:innerId',
 type: 'transaction',
 transaction_info: {
 source: 'route',
 },
 }),
 );

 expect(await page.innerText('id=content')).toContain('I am a lazy loaded user');

 expect(transactionEvent.spans).toEqual(
 expect.arrayContaining([
 // This one is the outer lazy route
 expect.objectContaining({
 op: 'resource.script',
 origin: 'auto.resource.browser.metrics',
 }),
 // This one is the inner lazy route
 expect.objectContaining({
 op: 'resource.script',
 origin: 'auto.resource.browser.metrics',
 }),
 ]),
 );
});

62 changes: 45 additions & 17 deletions
packages/react/src/reactrouterv6-compat-utils.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,6 +62,9 @@ export interface ReactRouterOptions {

type V6CompatibleVersion = '6' | '7';

// Keeping as a global variable for cross-usage in multiple functions
const allRoutes = new Set<RouteObject>();

/**
 * Creates a wrapCreateBrowserRouter function that can be used with all React Router v6 compatible versions.
 */
Expand All@@ -82,6 +85,10 @@ export function createV6CompatibleWrapCreateBrowserRouter<
 }

 return function (routes: RouteObject[], opts?: Record<string, unknown> & { basename?: string }): TRouter {
 routes.forEach(route => {
 allRoutes.add(route);
 });

 const router = createRouterFunction(routes, opts);
 const basename = opts && opts.basename;

Expand All@@ -91,19 +98,40 @@ export function createV6CompatibleWrapCreateBrowserRouter<
 // This is the earliest convenient time to update the transaction name.
 // Callbacks to `router.subscribe` are not called for the initial load.
 if (router.state.historyAction === 'POP' && activeRootSpan) {
 updatePageloadTransaction(activeRootSpan, router.state.location, routes, undefined, basename);
 updatePageloadTransaction(
 activeRootSpan,
 router.state.location,
 routes,
 undefined,
 basename,
 Array.from(allRoutes),
 );
 }

 router.subscribe((state: RouterState) => {
 const location = state.location;
 if (state.historyAction === 'PUSH' || state.historyAction === 'POP') {
 handleNavigation({
 location,
 routes,
 navigationType: state.historyAction,
 version,
 basename,
 });
 // Wait for the next render if loading an unsettled route
 if (state.navigation.state !== 'idle') {
 requestAnimationFrame(() => {
 handleNavigation({
 location: state.location,
 routes,
 navigationType: state.historyAction,
 version,
 basename,
 allRoutes: Array.from(allRoutes),
 });
 });
 } else {
 handleNavigation({
 location: state.location,
 routes,
 navigationType: state.historyAction,
 version,
 basename,
 allRoutes: Array.from(allRoutes),
 });
 }
 }
 });

Expand DownExpand Up@@ -138,6 +166,10 @@ export function createV6CompatibleWrapCreateMemoryRouter<
 initialIndex?: number;
 },
 ): TRouter {
 routes.forEach(route => {
 allRoutes.add(route);
 });

 const router = createRouterFunction(routes, opts);
 const basename = opts ? opts.basename : undefined;

Expand All@@ -163,7 +195,7 @@ export function createV6CompatibleWrapCreateMemoryRouter<
 : router.state.location;

 if (router.state.historyAction === 'POP' && activeRootSpan) {
 updatePageloadTransaction(activeRootSpan, location, routes, undefined, basename);
 updatePageloadTransaction(activeRootSpan, location, routes, undefined, basename, Array.from(allRoutes));
 }

 router.subscribe((state: RouterState) => {
Expand All@@ -175,6 +207,7 @@ export function createV6CompatibleWrapCreateMemoryRouter<
 navigationType: state.historyAction,
 version,
 basename,
 allRoutes: Array.from(allRoutes),
 });
 }
 });
Expand DownExpand Up@@ -249,8 +282,6 @@ export function createV6CompatibleWrapUseRoutes(origUseRoutes: UseRoutes, versio
 return origUseRoutes;
 }

 const allRoutes: Set<RouteObject> = new Set();

 const SentryRoutes: React.FC<{
 children?: React.ReactNode;
 routes: RouteObject[];
Expand DownExpand Up@@ -322,7 +353,6 @@ export function handleNavigation(opts: {
 allRoutes?: RouteObject[];
}): void {
 const { location, routes, navigationType, version, matches, basename, allRoutes } = opts;

 const branches = Array.isArray(matches) ? matches : _matchRoutes(routes, location, basename);

 const client = getClient();
Expand DownExpand Up@@ -558,7 +588,7 @@ function updatePageloadTransaction(
): void {
 const branches = Array.isArray(matches)
 ? matches
 : (_matchRoutes(routes, location, basename) as unknown as RouteMatch[]);
 : (_matchRoutes(allRoutes || routes, location, basename) as unknown as RouteMatch[]);

 if (branches) {
 let name,
Expand All@@ -574,7 +604,7 @@ function updatePageloadTransaction(
 [name, source] = getNormalizedName(routes, location, branches, basename);
 }

 getCurrentScope().setTransactionName(name);
 getCurrentScope().setTransactionName(name || '/');

 if (activeRootSpan) {
 activeRootSpan.updateName(name);
Expand All@@ -597,8 +627,6 @@ export function createV6CompatibleWithSentryReactRouterRouting<P extends Record<
 return Routes;
 }

 const allRoutes: Set<RouteObject> = new Set();

 const SentryRoutes: React.FC<P> = (props: P) => {
 const isMountRenderPass = React.useRef(true);

Expand Down

11 changes: 8 additions & 3 deletions
packages/react/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -182,10 +182,14 @@ export interface RouterInit {
 hydrationData?: HydrationState;
}

export type NavigationState = {
 state: 'idle' | 'loading' | 'submitting';
};

export type NavigationStates = {
 Idle: any;
 Loading: any;
 Submitting: any;
 Idle: NavigationState;
 Loading: NavigationState;
 Submitting: NavigationState;
};

export type Navigation = NavigationStates[keyof NavigationStates];
Expand All@@ -202,6 +206,7 @@ export declare enum HistoryAction {
export interface RouterState {
 historyAction: Action | HistoryAction | any;
 location: Location;
 navigation: Navigation;
}
export interface Router<TState extends RouterState = RouterState> {
 state: TState;
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(react/v8): Support lazy-loaded routes and components#15281

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.

 Sign up for GitHub

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

s1gr1d
merged 1 commit into

from

Feb 11, 2025
 Merged


fix(react/v8): Support lazy-loaded routes and components
#15281
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


11 changes: 10 additions & 1 deletion
dev-packages/e2e-tests/test-applications/react-create-browser-router/src/index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import * as Sentry from '@sentry/react';
import React from 'react';
import React, { lazy, Suspense } from 'react';
import ReactDOM from 'react-dom/client';
import {
 RouterProvider,
Expand DownExpand Up@@ -42,13 +42,22 @@ Sentry.init({
});

const sentryCreateBrowserRouter = Sentry.wrapCreateBrowserRouterV6(createBrowserRouter);
const LazyLoadedUser = lazy(() => import('./pages/LazyLoadedUser'));

const router = sentryCreateBrowserRouter(
 [
 {
 path: '/',
 element: <Index />,
 },
 {
 path: '/lazy-loaded-user/*',
 element: (
 <Suspense fallback={<div>Loading...</div>}>
 <LazyLoadedUser />
 </Suspense>
 ),
 },
 {
 path: '/user/:id',
 element: <User />,
Expand Down

3 changes: 3 additions & 0 deletions
dev-packages/e2e-tests/test-applications/react-create-browser-router/src/pages/Index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,9 @@ const Index = () => {
<Linkto="/user/5"id="navigation">
 navigate
</Link>
<Linkto="/lazy-loaded-user/5/foo"id="lazy-navigation">
 lazy navigate
</Link>
</>
);
};
Expand Down

14 changes: 14 additions & 0 deletions
...2e-tests/test-applications/react-create-browser-router/src/pages/LazyLoadedInnerRoute.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
import * as Sentry from '@sentry/react';
// biome-ignore lint/nursery/noUnusedImports: Need React import for JSX
import * as React from 'react';
import { Route, Routes } from 'react-router-dom';

const SentryRoutes = Sentry.withSentryReactRouterV6Routing(Routes);

const InnerRoute = () => (
 <SentryRoutes>
 <Route path=":innerId" element={<p id="content">I am a lazy loaded user</p>} />
 </SentryRoutes>
);

export default InnerRoute;

23 changes: 23 additions & 0 deletions
...ages/e2e-tests/test-applications/react-create-browser-router/src/pages/LazyLoadedUser.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import * as Sentry from '@sentry/react';
import * as React from 'react';
import { Route, Routes } from 'react-router-dom';

const SentryRoutes = Sentry.withSentryReactRouterV6Routing(Routes);
const InnerRoute = React.lazy(() => import('./LazyLoadedInnerRoute'));

const LazyLoadedUser = () => {
 return (
 <SentryRoutes>
 <Route
 path=":id/*"
 element={
 <React.Suspense fallback={<p>Loading...</p>}>
 <InnerRoute />
 </React.Suspense>
 }
 />
 </SentryRoutes>
 );
};

export default LazyLoadedUser;

102 changes: 102 additions & 0 deletions
...ckages/e2e-tests/test-applications/react-create-browser-router/tests/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,3 +76,105 @@ test('Captures a navigation transaction', async ({ page }) => {

 expect(transactionEvent.spans).toEqual([]);
});

test('Captures a lazy pageload transaction', async ({ page }) => {
 const transactionEventPromise = waitForTransaction('react-create-browser-router', event => {
 return event.contexts?.trace?.op === 'pageload';
 });

 await page.goto('/lazy-loaded-user/5/foo');

 const transactionEvent = await transactionEventPromise;
 expect(transactionEvent.contexts?.trace).toEqual({
 data: expect.objectContaining({
 'sentry.idle_span_finish_reason': 'idleTimeout',
 'sentry.op': 'pageload',
 'sentry.origin': 'auto.pageload.react.reactrouter_v6',
 'sentry.sample_rate': 1,
 'sentry.source': 'route',
 }),
 op: 'pageload',
 span_id: expect.stringMatching(/[a-f0-9]{16}/),
 trace_id: expect.stringMatching(/[a-f0-9]{32}/),
 origin: 'auto.pageload.react.reactrouter_v6',
 });

 expect(transactionEvent).toEqual(
 expect.objectContaining({
 transaction: '/lazy-loaded-user/:id/:innerId',
 type: 'transaction',
 transaction_info: {
 source: 'route',
 },
 }),
 );

 expect(await page.innerText('id=content')).toContain('I am a lazy loaded user');

 expect(transactionEvent.spans).toEqual(
 expect.arrayContaining([
 // This one is the outer lazy route
 expect.objectContaining({
 op: 'resource.script',
 origin: 'auto.resource.browser.metrics',
 }),
 // This one is the inner lazy route
 expect.objectContaining({
 op: 'resource.script',
 origin: 'auto.resource.browser.metrics',
 }),
 ]),
 );
});

test('Captures a lazy navigation transaction', async ({ page }) => {
 const transactionEventPromise = waitForTransaction('react-create-browser-router', event => {
 return event.contexts?.trace?.op === 'navigation';
 });

 await page.goto('/');
 const linkElement = page.locator('id=lazy-navigation');
 await linkElement.click();

 const transactionEvent = await transactionEventPromise;
 expect(transactionEvent.contexts?.trace).toEqual({
 data: expect.objectContaining({
 'sentry.idle_span_finish_reason': 'idleTimeout',
 'sentry.op': 'navigation',
 'sentry.origin': 'auto.navigation.react.reactrouter_v6',
 'sentry.sample_rate': 1,
 'sentry.source': 'route',
 }),
 op: 'navigation',
 span_id: expect.stringMatching(/[a-f0-9]{16}/),
 trace_id: expect.stringMatching(/[a-f0-9]{32}/),
 origin: 'auto.navigation.react.reactrouter_v6',
 });

 expect(transactionEvent).toEqual(
 expect.objectContaining({
 transaction: '/lazy-loaded-user/:id/:innerId',
 type: 'transaction',
 transaction_info: {
 source: 'route',
 },
 }),
 );

 expect(await page.innerText('id=content')).toContain('I am a lazy loaded user');

 expect(transactionEvent.spans).toEqual(
 expect.arrayContaining([
 // This one is the outer lazy route
 expect.objectContaining({
 op: 'resource.script',
 origin: 'auto.resource.browser.metrics',
 }),
 // This one is the inner lazy route
 expect.objectContaining({
 op: 'resource.script',
 origin: 'auto.resource.browser.metrics',
 }),
 ]),
 );
});

62 changes: 45 additions & 17 deletions
packages/react/src/reactrouterv6-compat-utils.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,6 +62,9 @@ export interface ReactRouterOptions {

type V6CompatibleVersion = '6' | '7';

// Keeping as a global variable for cross-usage in multiple functions
const allRoutes = new Set<RouteObject>();

/**
 * Creates a wrapCreateBrowserRouter function that can be used with all React Router v6 compatible versions.
 */
Expand All@@ -82,6 +85,10 @@ export function createV6CompatibleWrapCreateBrowserRouter<
 }

 return function (routes: RouteObject[], opts?: Record<string, unknown> & { basename?: string }): TRouter {
 routes.forEach(route => {
 allRoutes.add(route);
 });

 const router = createRouterFunction(routes, opts);
 const basename = opts && opts.basename;

Expand All@@ -91,19 +98,40 @@ export function createV6CompatibleWrapCreateBrowserRouter<
 // This is the earliest convenient time to update the transaction name.
 // Callbacks to `router.subscribe` are not called for the initial load.
 if (router.state.historyAction === 'POP' && activeRootSpan) {
 updatePageloadTransaction(activeRootSpan, router.state.location, routes, undefined, basename);
 updatePageloadTransaction(
 activeRootSpan,
 router.state.location,
 routes,
 undefined,
 basename,
 Array.from(allRoutes),
 );
 }

 router.subscribe((state: RouterState) => {
 const location = state.location;
 if (state.historyAction === 'PUSH' || state.historyAction === 'POP') {
 handleNavigation({
 location,
 routes,
 navigationType: state.historyAction,
 version,
 basename,
 });
 // Wait for the next render if loading an unsettled route
 if (state.navigation.state !== 'idle') {
 requestAnimationFrame(() => {
 handleNavigation({
 location: state.location,
 routes,
 navigationType: state.historyAction,
 version,
 basename,
 allRoutes: Array.from(allRoutes),
 });
 });
 } else {
 handleNavigation({
 location: state.location,
 routes,
 navigationType: state.historyAction,
 version,
 basename,
 allRoutes: Array.from(allRoutes),
 });
 }
 }
 });

Expand DownExpand Up@@ -138,6 +166,10 @@ export function createV6CompatibleWrapCreateMemoryRouter<
 initialIndex?: number;
 },
 ): TRouter {
 routes.forEach(route => {
 allRoutes.add(route);
 });

 const router = createRouterFunction(routes, opts);
 const basename = opts ? opts.basename : undefined;

Expand All@@ -163,7 +195,7 @@ export function createV6CompatibleWrapCreateMemoryRouter<
 : router.state.location;

 if (router.state.historyAction === 'POP' && activeRootSpan) {
 updatePageloadTransaction(activeRootSpan, location, routes, undefined, basename);
 updatePageloadTransaction(activeRootSpan, location, routes, undefined, basename, Array.from(allRoutes));
 }

 router.subscribe((state: RouterState) => {
Expand All@@ -175,6 +207,7 @@ export function createV6CompatibleWrapCreateMemoryRouter<
 navigationType: state.historyAction,
 version,
 basename,
 allRoutes: Array.from(allRoutes),
 });
 }
 });
Expand DownExpand Up@@ -249,8 +282,6 @@ export function createV6CompatibleWrapUseRoutes(origUseRoutes: UseRoutes, versio
 return origUseRoutes;
 }

 const allRoutes: Set<RouteObject> = new Set();

 const SentryRoutes: React.FC<{
 children?: React.ReactNode;
 routes: RouteObject[];
Expand DownExpand Up@@ -322,7 +353,6 @@ export function handleNavigation(opts: {
 allRoutes?: RouteObject[];
}): void {
 const { location, routes, navigationType, version, matches, basename, allRoutes } = opts;

 const branches = Array.isArray(matches) ? matches : _matchRoutes(routes, location, basename);

 const client = getClient();
Expand DownExpand Up@@ -558,7 +588,7 @@ function updatePageloadTransaction(
): void {
 const branches = Array.isArray(matches)
 ? matches
 : (_matchRoutes(routes, location, basename) as unknown as RouteMatch[]);
 : (_matchRoutes(allRoutes || routes, location, basename) as unknown as RouteMatch[]);

 if (branches) {
 let name,
Expand All@@ -574,7 +604,7 @@ function updatePageloadTransaction(
 [name, source] = getNormalizedName(routes, location, branches, basename);
 }

 getCurrentScope().setTransactionName(name);
 getCurrentScope().setTransactionName(name || '/');

 if (activeRootSpan) {
 activeRootSpan.updateName(name);
Expand All@@ -597,8 +627,6 @@ export function createV6CompatibleWithSentryReactRouterRouting<P extends Record<
 return Routes;
 }

 const allRoutes: Set<RouteObject> = new Set();

 const SentryRoutes: React.FC<P> = (props: P) => {
 const isMountRenderPass = React.useRef(true);

Expand Down

11 changes: 8 additions & 3 deletions
packages/react/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -182,10 +182,14 @@ export interface RouterInit {
 hydrationData?: HydrationState;
}

export type NavigationState = {
 state: 'idle' | 'loading' | 'submitting';
};

export type NavigationStates = {
 Idle: any;
 Loading: any;
 Submitting: any;
 Idle: NavigationState;
 Loading: NavigationState;
 Submitting: NavigationState;
};

export type Navigation = NavigationStates[keyof NavigationStates];
Expand All@@ -202,6 +206,7 @@ export declare enum HistoryAction {
export interface RouterState {
 historyAction: Action | HistoryAction | any;
 location: Location;
 navigation: Navigation;
}
export interface Router<TState extends RouterState = RouterState> {
 state: TState;
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(react/v8): Support lazy-loaded routes and components#15281

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.

 Sign up for GitHub

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

s1gr1d
merged 1 commit into

from

Feb 11, 2025
 Merged


fix(react/v8): Support lazy-loaded routes and components
#15281
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


11 changes: 10 additions & 1 deletion
dev-packages/e2e-tests/test-applications/react-create-browser-router/src/index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import * as Sentry from '@sentry/react';
import React from 'react';
import React, { lazy, Suspense } from 'react';
import ReactDOM from 'react-dom/client';
import {
 RouterProvider,
Expand DownExpand Up@@ -42,13 +42,22 @@ Sentry.init({
});

const sentryCreateBrowserRouter = Sentry.wrapCreateBrowserRouterV6(createBrowserRouter);
const LazyLoadedUser = lazy(() => import('./pages/LazyLoadedUser'));

const router = sentryCreateBrowserRouter(
 [
 {
 path: '/',
 element: <Index />,
 },
 {
 path: '/lazy-loaded-user/*',
 element: (
 <Suspense fallback={<div>Loading...</div>}>
 <LazyLoadedUser />
 </Suspense>
 ),
 },
 {
 path: '/user/:id',
 element: <User />,
Expand Down

3 changes: 3 additions & 0 deletions
dev-packages/e2e-tests/test-applications/react-create-browser-router/src/pages/Index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,9 @@ const Index = () => {
<Linkto="/user/5"id="navigation">
 navigate
</Link>
<Linkto="/lazy-loaded-user/5/foo"id="lazy-navigation">
 lazy navigate
</Link>
</>
);
};
Expand Down

14 changes: 14 additions & 0 deletions
...2e-tests/test-applications/react-create-browser-router/src/pages/LazyLoadedInnerRoute.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
import * as Sentry from '@sentry/react';
// biome-ignore lint/nursery/noUnusedImports: Need React import for JSX
import * as React from 'react';
import { Route, Routes } from 'react-router-dom';

const SentryRoutes = Sentry.withSentryReactRouterV6Routing(Routes);

const InnerRoute = () => (
 <SentryRoutes>
 <Route path=":innerId" element={<p id="content">I am a lazy loaded user</p>} />
 </SentryRoutes>
);

export default InnerRoute;

23 changes: 23 additions & 0 deletions
...ages/e2e-tests/test-applications/react-create-browser-router/src/pages/LazyLoadedUser.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import * as Sentry from '@sentry/react';
import * as React from 'react';
import { Route, Routes } from 'react-router-dom';

const SentryRoutes = Sentry.withSentryReactRouterV6Routing(Routes);
const InnerRoute = React.lazy(() => import('./LazyLoadedInnerRoute'));

const LazyLoadedUser = () => {
 return (
 <SentryRoutes>
 <Route
 path=":id/*"
 element={
 <React.Suspense fallback={<p>Loading...</p>}>
 <InnerRoute />
 </React.Suspense>
 }
 />
 </SentryRoutes>
 );
};

export default LazyLoadedUser;

102 changes: 102 additions & 0 deletions
...ckages/e2e-tests/test-applications/react-create-browser-router/tests/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,3 +76,105 @@ test('Captures a navigation transaction', async ({ page }) => {

 expect(transactionEvent.spans).toEqual([]);
});

test('Captures a lazy pageload transaction', async ({ page }) => {
 const transactionEventPromise = waitForTransaction('react-create-browser-router', event => {
 return event.contexts?.trace?.op === 'pageload';
 });

 await page.goto('/lazy-loaded-user/5/foo');

 const transactionEvent = await transactionEventPromise;
 expect(transactionEvent.contexts?.trace).toEqual({
 data: expect.objectContaining({
 'sentry.idle_span_finish_reason': 'idleTimeout',
 'sentry.op': 'pageload',
 'sentry.origin': 'auto.pageload.react.reactrouter_v6',
 'sentry.sample_rate': 1,
 'sentry.source': 'route',
 }),
 op: 'pageload',
 span_id: expect.stringMatching(/[a-f0-9]{16}/),
 trace_id: expect.stringMatching(/[a-f0-9]{32}/),
 origin: 'auto.pageload.react.reactrouter_v6',
 });

 expect(transactionEvent).toEqual(
 expect.objectContaining({
 transaction: '/lazy-loaded-user/:id/:innerId',
 type: 'transaction',
 transaction_info: {
 source: 'route',
 },
 }),
 );

 expect(await page.innerText('id=content')).toContain('I am a lazy loaded user');

 expect(transactionEvent.spans).toEqual(
 expect.arrayContaining([
 // This one is the outer lazy route
 expect.objectContaining({
 op: 'resource.script',
 origin: 'auto.resource.browser.metrics',
 }),
 // This one is the inner lazy route
 expect.objectContaining({
 op: 'resource.script',
 origin: 'auto.resource.browser.metrics',
 }),
 ]),
 );
});

test('Captures a lazy navigation transaction', async ({ page }) => {
 const transactionEventPromise = waitForTransaction('react-create-browser-router', event => {
 return event.contexts?.trace?.op === 'navigation';
 });

 await page.goto('/');
 const linkElement = page.locator('id=lazy-navigation');
 await linkElement.click();

 const transactionEvent = await transactionEventPromise;
 expect(transactionEvent.contexts?.trace).toEqual({
 data: expect.objectContaining({
 'sentry.idle_span_finish_reason': 'idleTimeout',
 'sentry.op': 'navigation',
 'sentry.origin': 'auto.navigation.react.reactrouter_v6',
 'sentry.sample_rate': 1,
 'sentry.source': 'route',
 }),
 op: 'navigation',
 span_id: expect.stringMatching(/[a-f0-9]{16}/),
 trace_id: expect.stringMatching(/[a-f0-9]{32}/),
 origin: 'auto.navigation.react.reactrouter_v6',
 });

 expect(transactionEvent).toEqual(
 expect.objectContaining({
 transaction: '/lazy-loaded-user/:id/:innerId',
 type: 'transaction',
 transaction_info: {
 source: 'route',
 },
 }),
 );

 expect(await page.innerText('id=content')).toContain('I am a lazy loaded user');

 expect(transactionEvent.spans).toEqual(
 expect.arrayContaining([
 // This one is the outer lazy route
 expect.objectContaining({
 op: 'resource.script',
 origin: 'auto.resource.browser.metrics',
 }),
 // This one is the inner lazy route
 expect.objectContaining({
 op: 'resource.script',
 origin: 'auto.resource.browser.metrics',
 }),
 ]),
 );
});

62 changes: 45 additions & 17 deletions
packages/react/src/reactrouterv6-compat-utils.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,6 +62,9 @@ export interface ReactRouterOptions {

type V6CompatibleVersion = '6' | '7';

// Keeping as a global variable for cross-usage in multiple functions
const allRoutes = new Set<RouteObject>();

/**
 * Creates a wrapCreateBrowserRouter function that can be used with all React Router v6 compatible versions.
 */
Expand All@@ -82,6 +85,10 @@ export function createV6CompatibleWrapCreateBrowserRouter<
 }

 return function (routes: RouteObject[], opts?: Record<string, unknown> & { basename?: string }): TRouter {
 routes.forEach(route => {
 allRoutes.add(route);
 });

 const router = createRouterFunction(routes, opts);
 const basename = opts && opts.basename;

Expand All@@ -91,19 +98,40 @@ export function createV6CompatibleWrapCreateBrowserRouter<
 // This is the earliest convenient time to update the transaction name.
 // Callbacks to `router.subscribe` are not called for the initial load.
 if (router.state.historyAction === 'POP' && activeRootSpan) {
 updatePageloadTransaction(activeRootSpan, router.state.location, routes, undefined, basename);
 updatePageloadTransaction(
 activeRootSpan,
 router.state.location,
 routes,
 undefined,
 basename,
 Array.from(allRoutes),
 );
 }

 router.subscribe((state: RouterState) => {
 const location = state.location;
 if (state.historyAction === 'PUSH' || state.historyAction === 'POP') {
 handleNavigation({
 location,
 routes,
 navigationType: state.historyAction,
 version,
 basename,
 });
 // Wait for the next render if loading an unsettled route
 if (state.navigation.state !== 'idle') {
 requestAnimationFrame(() => {
 handleNavigation({
 location: state.location,
 routes,
 navigationType: state.historyAction,
 version,
 basename,
 allRoutes: Array.from(allRoutes),
 });
 });
 } else {
 handleNavigation({
 location: state.location,
 routes,
 navigationType: state.historyAction,
 version,
 basename,
 allRoutes: Array.from(allRoutes),
 });
 }
 }
 });

Expand DownExpand Up@@ -138,6 +166,10 @@ export function createV6CompatibleWrapCreateMemoryRouter<
 initialIndex?: number;
 },
 ): TRouter {
 routes.forEach(route => {
 allRoutes.add(route);
 });

 const router = createRouterFunction(routes, opts);
 const basename = opts ? opts.basename : undefined;

Expand All@@ -163,7 +195,7 @@ export function createV6CompatibleWrapCreateMemoryRouter<
 : router.state.location;

 if (router.state.historyAction === 'POP' && activeRootSpan) {
 updatePageloadTransaction(activeRootSpan, location, routes, undefined, basename);
 updatePageloadTransaction(activeRootSpan, location, routes, undefined, basename, Array.from(allRoutes));
 }

 router.subscribe((state: RouterState) => {
Expand All@@ -175,6 +207,7 @@ export function createV6CompatibleWrapCreateMemoryRouter<
 navigationType: state.historyAction,
 version,
 basename,
 allRoutes: Array.from(allRoutes),
 });
 }
 });
Expand DownExpand Up@@ -249,8 +282,6 @@ export function createV6CompatibleWrapUseRoutes(origUseRoutes: UseRoutes, versio
 return origUseRoutes;
 }

 const allRoutes: Set<RouteObject> = new Set();

 const SentryRoutes: React.FC<{
 children?: React.ReactNode;
 routes: RouteObject[];
Expand DownExpand Up@@ -322,7 +353,6 @@ export function handleNavigation(opts: {
 allRoutes?: RouteObject[];
}): void {
 const { location, routes, navigationType, version, matches, basename, allRoutes } = opts;

 const branches = Array.isArray(matches) ? matches : _matchRoutes(routes, location, basename);

 const client = getClient();
Expand DownExpand Up@@ -558,7 +588,7 @@ function updatePageloadTransaction(
): void {
 const branches = Array.isArray(matches)
 ? matches
 : (_matchRoutes(routes, location, basename) as unknown as RouteMatch[]);
 : (_matchRoutes(allRoutes || routes, location, basename) as unknown as RouteMatch[]);

 if (branches) {
 let name,
Expand All@@ -574,7 +604,7 @@ function updatePageloadTransaction(
 [name, source] = getNormalizedName(routes, location, branches, basename);
 }

 getCurrentScope().setTransactionName(name);
 getCurrentScope().setTransactionName(name || '/');

 if (activeRootSpan) {
 activeRootSpan.updateName(name);
Expand All@@ -597,8 +627,6 @@ export function createV6CompatibleWithSentryReactRouterRouting<P extends Record<
 return Routes;
 }

 const allRoutes: Set<RouteObject> = new Set();

 const SentryRoutes: React.FC<P> = (props: P) => {
 const isMountRenderPass = React.useRef(true);

Expand Down

11 changes: 8 additions & 3 deletions
packages/react/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -182,10 +182,14 @@ export interface RouterInit {
 hydrationData?: HydrationState;
}

export type NavigationState = {
 state: 'idle' | 'loading' | 'submitting';
};

export type NavigationStates = {
 Idle: any;
 Loading: any;
 Submitting: any;
 Idle: NavigationState;
 Loading: NavigationState;
 Submitting: NavigationState;
};

export type Navigation = NavigationStates[keyof NavigationStates];
Expand All@@ -202,6 +206,7 @@ export declare enum HistoryAction {
export interface RouterState {
 historyAction: Action | HistoryAction | any;
 location: Location;
 navigation: Navigation;
}
export interface Router<TState extends RouterState = RouterState> {
 state: TState;
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
fix(react/v8): Support lazy-loaded routes and components#15281

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.

 Sign up for GitHub

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

s1gr1d
merged 1 commit into

from

Feb 11, 2025
 Merged


fix(react/v8): Support lazy-loaded routes and components
#15281
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


11 changes: 10 additions & 1 deletion
dev-packages/e2e-tests/test-applications/react-create-browser-router/src/index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import * as Sentry from '@sentry/react';
import React from 'react';
import React, { lazy, Suspense } from 'react';
import ReactDOM from 'react-dom/client';
import {
 RouterProvider,
Expand DownExpand Up@@ -42,13 +42,22 @@ Sentry.init({
});

const sentryCreateBrowserRouter = Sentry.wrapCreateBrowserRouterV6(createBrowserRouter);
const LazyLoadedUser = lazy(() => import('./pages/LazyLoadedUser'));

const router = sentryCreateBrowserRouter(
 [
 {
 path: '/',
 element: <Index />,
 },
 {
 path: '/lazy-loaded-user/*',
 element: (
 <Suspense fallback={<div>Loading...</div>}>
 <LazyLoadedUser />
 </Suspense>
 ),
 },
 {
 path: '/user/:id',
 element: <User />,
Expand Down

3 changes: 3 additions & 0 deletions
dev-packages/e2e-tests/test-applications/react-create-browser-router/src/pages/Index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,9 @@ const Index = () => {
<Linkto="/user/5"id="navigation">
 navigate
</Link>
<Linkto="/lazy-loaded-user/5/foo"id="lazy-navigation">
 lazy navigate
</Link>
</>
);
};
Expand Down

14 changes: 14 additions & 0 deletions
...2e-tests/test-applications/react-create-browser-router/src/pages/LazyLoadedInnerRoute.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
import * as Sentry from '@sentry/react';
// biome-ignore lint/nursery/noUnusedImports: Need React import for JSX
import * as React from 'react';
import { Route, Routes } from 'react-router-dom';

const SentryRoutes = Sentry.withSentryReactRouterV6Routing(Routes);

const InnerRoute = () => (
 <SentryRoutes>
 <Route path=":innerId" element={<p id="content">I am a lazy loaded user</p>} />
 </SentryRoutes>
);

export default InnerRoute;

23 changes: 23 additions & 0 deletions
...ages/e2e-tests/test-applications/react-create-browser-router/src/pages/LazyLoadedUser.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import * as Sentry from '@sentry/react';
import * as React from 'react';
import { Route, Routes } from 'react-router-dom';

const SentryRoutes = Sentry.withSentryReactRouterV6Routing(Routes);
const InnerRoute = React.lazy(() => import('./LazyLoadedInnerRoute'));

const LazyLoadedUser = () => {
 return (
 <SentryRoutes>
 <Route
 path=":id/*"
 element={
 <React.Suspense fallback={<p>Loading...</p>}>
 <InnerRoute />
 </React.Suspense>
 }
 />
 </SentryRoutes>
 );
};

export default LazyLoadedUser;

102 changes: 102 additions & 0 deletions
...ckages/e2e-tests/test-applications/react-create-browser-router/tests/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,3 +76,105 @@ test('Captures a navigation transaction', async ({ page }) => {

 expect(transactionEvent.spans).toEqual([]);
});

test('Captures a lazy pageload transaction', async ({ page }) => {
 const transactionEventPromise = waitForTransaction('react-create-browser-router', event => {
 return event.contexts?.trace?.op === 'pageload';
 });

 await page.goto('/lazy-loaded-user/5/foo');

 const transactionEvent = await transactionEventPromise;
 expect(transactionEvent.contexts?.trace).toEqual({
 data: expect.objectContaining({
 'sentry.idle_span_finish_reason': 'idleTimeout',
 'sentry.op': 'pageload',
 'sentry.origin': 'auto.pageload.react.reactrouter_v6',
 'sentry.sample_rate': 1,
 'sentry.source': 'route',
 }),
 op: 'pageload',
 span_id: expect.stringMatching(/[a-f0-9]{16}/),
 trace_id: expect.stringMatching(/[a-f0-9]{32}/),
 origin: 'auto.pageload.react.reactrouter_v6',
 });

 expect(transactionEvent).toEqual(
 expect.objectContaining({
 transaction: '/lazy-loaded-user/:id/:innerId',
 type: 'transaction',
 transaction_info: {
 source: 'route',
 },
 }),
 );

 expect(await page.innerText('id=content')).toContain('I am a lazy loaded user');

 expect(transactionEvent.spans).toEqual(
 expect.arrayContaining([
 // This one is the outer lazy route
 expect.objectContaining({
 op: 'resource.script',
 origin: 'auto.resource.browser.metrics',
 }),
 // This one is the inner lazy route
 expect.objectContaining({
 op: 'resource.script',
 origin: 'auto.resource.browser.metrics',
 }),
 ]),
 );
});

test('Captures a lazy navigation transaction', async ({ page }) => {
 const transactionEventPromise = waitForTransaction('react-create-browser-router', event => {
 return event.contexts?.trace?.op === 'navigation';
 });

 await page.goto('/');
 const linkElement = page.locator('id=lazy-navigation');
 await linkElement.click();

 const transactionEvent = await transactionEventPromise;
 expect(transactionEvent.contexts?.trace).toEqual({
 data: expect.objectContaining({
 'sentry.idle_span_finish_reason': 'idleTimeout',
 'sentry.op': 'navigation',
 'sentry.origin': 'auto.navigation.react.reactrouter_v6',
 'sentry.sample_rate': 1,
 'sentry.source': 'route',
 }),
 op: 'navigation',
 span_id: expect.stringMatching(/[a-f0-9]{16}/),
 trace_id: expect.stringMatching(/[a-f0-9]{32}/),
 origin: 'auto.navigation.react.reactrouter_v6',
 });

 expect(transactionEvent).toEqual(
 expect.objectContaining({
 transaction: '/lazy-loaded-user/:id/:innerId',
 type: 'transaction',
 transaction_info: {
 source: 'route',
 },
 }),
 );

 expect(await page.innerText('id=content')).toContain('I am a lazy loaded user');

 expect(transactionEvent.spans).toEqual(
 expect.arrayContaining([
 // This one is the outer lazy route
 expect.objectContaining({
 op: 'resource.script',
 origin: 'auto.resource.browser.metrics',
 }),
 // This one is the inner lazy route
 expect.objectContaining({
 op: 'resource.script',
 origin: 'auto.resource.browser.metrics',
 }),
 ]),
 );
});

62 changes: 45 additions & 17 deletions
packages/react/src/reactrouterv6-compat-utils.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,6 +62,9 @@ export interface ReactRouterOptions {

type V6CompatibleVersion = '6' | '7';

// Keeping as a global variable for cross-usage in multiple functions
const allRoutes = new Set<RouteObject>();

/**
 * Creates a wrapCreateBrowserRouter function that can be used with all React Router v6 compatible versions.
 */
Expand All@@ -82,6 +85,10 @@ export function createV6CompatibleWrapCreateBrowserRouter<
 }

 return function (routes: RouteObject[], opts?: Record<string, unknown> & { basename?: string }): TRouter {
 routes.forEach(route => {
 allRoutes.add(route);
 });

 const router = createRouterFunction(routes, opts);
 const basename = opts && opts.basename;

Expand All@@ -91,19 +98,40 @@ export function createV6CompatibleWrapCreateBrowserRouter<
 // This is the earliest convenient time to update the transaction name.
 // Callbacks to `router.subscribe` are not called for the initial load.
 if (router.state.historyAction === 'POP' && activeRootSpan) {
 updatePageloadTransaction(activeRootSpan, router.state.location, routes, undefined, basename);
 updatePageloadTransaction(
 activeRootSpan,
 router.state.location,
 routes,
 undefined,
 basename,
 Array.from(allRoutes),
 );
 }

 router.subscribe((state: RouterState) => {
 const location = state.location;
 if (state.historyAction === 'PUSH' || state.historyAction === 'POP') {
 handleNavigation({
 location,
 routes,
 navigationType: state.historyAction,
 version,
 basename,
 });
 // Wait for the next render if loading an unsettled route
 if (state.navigation.state !== 'idle') {
 requestAnimationFrame(() => {
 handleNavigation({
 location: state.location,
 routes,
 navigationType: state.historyAction,
 version,
 basename,
 allRoutes: Array.from(allRoutes),
 });
 });
 } else {
 handleNavigation({
 location: state.location,
 routes,
 navigationType: state.historyAction,
 version,
 basename,
 allRoutes: Array.from(allRoutes),
 });
 }
 }
 });

Expand DownExpand Up@@ -138,6 +166,10 @@ export function createV6CompatibleWrapCreateMemoryRouter<
 initialIndex?: number;
 },
 ): TRouter {
 routes.forEach(route => {
 allRoutes.add(route);
 });

 const router = createRouterFunction(routes, opts);
 const basename = opts ? opts.basename : undefined;

Expand All@@ -163,7 +195,7 @@ export function createV6CompatibleWrapCreateMemoryRouter<
 : router.state.location;

 if (router.state.historyAction === 'POP' && activeRootSpan) {
 updatePageloadTransaction(activeRootSpan, location, routes, undefined, basename);
 updatePageloadTransaction(activeRootSpan, location, routes, undefined, basename, Array.from(allRoutes));
 }

 router.subscribe((state: RouterState) => {
Expand All@@ -175,6 +207,7 @@ export function createV6CompatibleWrapCreateMemoryRouter<
 navigationType: state.historyAction,
 version,
 basename,
 allRoutes: Array.from(allRoutes),
 });
 }
 });
Expand DownExpand Up@@ -249,8 +282,6 @@ export function createV6CompatibleWrapUseRoutes(origUseRoutes: UseRoutes, versio
 return origUseRoutes;
 }

 const allRoutes: Set<RouteObject> = new Set();

 const SentryRoutes: React.FC<{
 children?: React.ReactNode;
 routes: RouteObject[];
Expand DownExpand Up@@ -322,7 +353,6 @@ export function handleNavigation(opts: {
 allRoutes?: RouteObject[];
}): void {
 const { location, routes, navigationType, version, matches, basename, allRoutes } = opts;

 const branches = Array.isArray(matches) ? matches : _matchRoutes(routes, location, basename);

 const client = getClient();
Expand DownExpand Up@@ -558,7 +588,7 @@ function updatePageloadTransaction(
): void {
 const branches = Array.isArray(matches)
 ? matches
 : (_matchRoutes(routes, location, basename) as unknown as RouteMatch[]);
 : (_matchRoutes(allRoutes || routes, location, basename) as unknown as RouteMatch[]);

 if (branches) {
 let name,
Expand All@@ -574,7 +604,7 @@ function updatePageloadTransaction(
 [name, source] = getNormalizedName(routes, location, branches, basename);
 }

 getCurrentScope().setTransactionName(name);
 getCurrentScope().setTransactionName(name || '/');

 if (activeRootSpan) {
 activeRootSpan.updateName(name);
Expand All@@ -597,8 +627,6 @@ export function createV6CompatibleWithSentryReactRouterRouting<P extends Record<
 return Routes;
 }

 const allRoutes: Set<RouteObject> = new Set();

 const SentryRoutes: React.FC<P> = (props: P) => {
 const isMountRenderPass = React.useRef(true);

Expand Down

11 changes: 8 additions & 3 deletions
packages/react/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -182,10 +182,14 @@ export interface RouterInit {
 hydrationData?: HydrationState;
}

export type NavigationState = {
 state: 'idle' | 'loading' | 'submitting';
};

export type NavigationStates = {
 Idle: any;
 Loading: any;
 Submitting: any;
 Idle: NavigationState;
 Loading: NavigationState;
 Submitting: NavigationState;
};

export type Navigation = NavigationStates[keyof NavigationStates];
Expand All@@ -202,6 +206,7 @@ export declare enum HistoryAction {
export interface RouterState {
 historyAction: Action | HistoryAction | any;
 location: Location;
 navigation: Navigation;
}
export interface Router<TState extends RouterState = RouterState> {
 state: TState;
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(react/v8): Support lazy-loaded routes and components#15281

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.

 Sign up for GitHub

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

s1gr1d
merged 1 commit into

from

Feb 11, 2025
 Merged


fix(react/v8): Support lazy-loaded routes and components
#15281
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


11 changes: 10 additions & 1 deletion
dev-packages/e2e-tests/test-applications/react-create-browser-router/src/index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import * as Sentry from '@sentry/react';
import React from 'react';
import React, { lazy, Suspense } from 'react';
import ReactDOM from 'react-dom/client';
import {
 RouterProvider,
Expand DownExpand Up@@ -42,13 +42,22 @@ Sentry.init({
});

const sentryCreateBrowserRouter = Sentry.wrapCreateBrowserRouterV6(createBrowserRouter);
const LazyLoadedUser = lazy(() => import('./pages/LazyLoadedUser'));

const router = sentryCreateBrowserRouter(
 [
 {
 path: '/',
 element: <Index />,
 },
 {
 path: '/lazy-loaded-user/*',
 element: (
 <Suspense fallback={<div>Loading...</div>}>
 <LazyLoadedUser />
 </Suspense>
 ),
 },
 {
 path: '/user/:id',
 element: <User />,
Expand Down

3 changes: 3 additions & 0 deletions
dev-packages/e2e-tests/test-applications/react-create-browser-router/src/pages/Index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,9 @@ const Index = () => {
<Linkto="/user/5"id="navigation">
 navigate
</Link>
<Linkto="/lazy-loaded-user/5/foo"id="lazy-navigation">
 lazy navigate
</Link>
</>
);
};
Expand Down

14 changes: 14 additions & 0 deletions
...2e-tests/test-applications/react-create-browser-router/src/pages/LazyLoadedInnerRoute.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
import * as Sentry from '@sentry/react';
// biome-ignore lint/nursery/noUnusedImports: Need React import for JSX
import * as React from 'react';
import { Route, Routes } from 'react-router-dom';

const SentryRoutes = Sentry.withSentryReactRouterV6Routing(Routes);

const InnerRoute = () => (
 <SentryRoutes>
 <Route path=":innerId" element={<p id="content">I am a lazy loaded user</p>} />
 </SentryRoutes>
);

export default InnerRoute;

23 changes: 23 additions & 0 deletions
...ages/e2e-tests/test-applications/react-create-browser-router/src/pages/LazyLoadedUser.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import * as Sentry from '@sentry/react';
import * as React from 'react';
import { Route, Routes } from 'react-router-dom';

const SentryRoutes = Sentry.withSentryReactRouterV6Routing(Routes);
const InnerRoute = React.lazy(() => import('./LazyLoadedInnerRoute'));

const LazyLoadedUser = () => {
 return (
 <SentryRoutes>
 <Route
 path=":id/*"
 element={
 <React.Suspense fallback={<p>Loading...</p>}>
 <InnerRoute />
 </React.Suspense>
 }
 />
 </SentryRoutes>
 );
};

export default LazyLoadedUser;

102 changes: 102 additions & 0 deletions
...ckages/e2e-tests/test-applications/react-create-browser-router/tests/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,3 +76,105 @@ test('Captures a navigation transaction', async ({ page }) => {

 expect(transactionEvent.spans).toEqual([]);
});

test('Captures a lazy pageload transaction', async ({ page }) => {
 const transactionEventPromise = waitForTransaction('react-create-browser-router', event => {
 return event.contexts?.trace?.op === 'pageload';
 });

 await page.goto('/lazy-loaded-user/5/foo');

 const transactionEvent = await transactionEventPromise;
 expect(transactionEvent.contexts?.trace).toEqual({
 data: expect.objectContaining({
 'sentry.idle_span_finish_reason': 'idleTimeout',
 'sentry.op': 'pageload',
 'sentry.origin': 'auto.pageload.react.reactrouter_v6',
 'sentry.sample_rate': 1,
 'sentry.source': 'route',
 }),
 op: 'pageload',
 span_id: expect.stringMatching(/[a-f0-9]{16}/),
 trace_id: expect.stringMatching(/[a-f0-9]{32}/),
 origin: 'auto.pageload.react.reactrouter_v6',
 });

 expect(transactionEvent).toEqual(
 expect.objectContaining({
 transaction: '/lazy-loaded-user/:id/:innerId',
 type: 'transaction',
 transaction_info: {
 source: 'route',
 },
 }),
 );

 expect(await page.innerText('id=content')).toContain('I am a lazy loaded user');

 expect(transactionEvent.spans).toEqual(
 expect.arrayContaining([
 // This one is the outer lazy route
 expect.objectContaining({
 op: 'resource.script',
 origin: 'auto.resource.browser.metrics',
 }),
 // This one is the inner lazy route
 expect.objectContaining({
 op: 'resource.script',
 origin: 'auto.resource.browser.metrics',
 }),
 ]),
 );
});

test('Captures a lazy navigation transaction', async ({ page }) => {
 const transactionEventPromise = waitForTransaction('react-create-browser-router', event => {
 return event.contexts?.trace?.op === 'navigation';
 });

 await page.goto('/');
 const linkElement = page.locator('id=lazy-navigation');
 await linkElement.click();

 const transactionEvent = await transactionEventPromise;
 expect(transactionEvent.contexts?.trace).toEqual({
 data: expect.objectContaining({
 'sentry.idle_span_finish_reason': 'idleTimeout',
 'sentry.op': 'navigation',
 'sentry.origin': 'auto.navigation.react.reactrouter_v6',
 'sentry.sample_rate': 1,
 'sentry.source': 'route',
 }),
 op: 'navigation',
 span_id: expect.stringMatching(/[a-f0-9]{16}/),
 trace_id: expect.stringMatching(/[a-f0-9]{32}/),
 origin: 'auto.navigation.react.reactrouter_v6',
 });

 expect(transactionEvent).toEqual(
 expect.objectContaining({
 transaction: '/lazy-loaded-user/:id/:innerId',
 type: 'transaction',
 transaction_info: {
 source: 'route',
 },
 }),
 );

 expect(await page.innerText('id=content')).toContain('I am a lazy loaded user');

 expect(transactionEvent.spans).toEqual(
 expect.arrayContaining([
 // This one is the outer lazy route
 expect.objectContaining({
 op: 'resource.script',
 origin: 'auto.resource.browser.metrics',
 }),
 // This one is the inner lazy route
 expect.objectContaining({
 op: 'resource.script',
 origin: 'auto.resource.browser.metrics',
 }),
 ]),
 );
});

62 changes: 45 additions & 17 deletions
packages/react/src/reactrouterv6-compat-utils.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,6 +62,9 @@ export interface ReactRouterOptions {

type V6CompatibleVersion = '6' | '7';

// Keeping as a global variable for cross-usage in multiple functions
const allRoutes = new Set<RouteObject>();

/**
 * Creates a wrapCreateBrowserRouter function that can be used with all React Router v6 compatible versions.
 */
Expand All@@ -82,6 +85,10 @@ export function createV6CompatibleWrapCreateBrowserRouter<
 }

 return function (routes: RouteObject[], opts?: Record<string, unknown> & { basename?: string }): TRouter {
 routes.forEach(route => {
 allRoutes.add(route);
 });

 const router = createRouterFunction(routes, opts);
 const basename = opts && opts.basename;

Expand All@@ -91,19 +98,40 @@ export function createV6CompatibleWrapCreateBrowserRouter<
 // This is the earliest convenient time to update the transaction name.
 // Callbacks to `router.subscribe` are not called for the initial load.
 if (router.state.historyAction === 'POP' && activeRootSpan) {
 updatePageloadTransaction(activeRootSpan, router.state.location, routes, undefined, basename);
 updatePageloadTransaction(
 activeRootSpan,
 router.state.location,
 routes,
 undefined,
 basename,
 Array.from(allRoutes),
 );
 }

 router.subscribe((state: RouterState) => {
 const location = state.location;
 if (state.historyAction === 'PUSH' || state.historyAction === 'POP') {
 handleNavigation({
 location,
 routes,
 navigationType: state.historyAction,
 version,
 basename,
 });
 // Wait for the next render if loading an unsettled route
 if (state.navigation.state !== 'idle') {
 requestAnimationFrame(() => {
 handleNavigation({
 location: state.location,
 routes,
 navigationType: state.historyAction,
 version,
 basename,
 allRoutes: Array.from(allRoutes),
 });
 });
 } else {
 handleNavigation({
 location: state.location,
 routes,
 navigationType: state.historyAction,
 version,
 basename,
 allRoutes: Array.from(allRoutes),
 });
 }
 }
 });

Expand DownExpand Up@@ -138,6 +166,10 @@ export function createV6CompatibleWrapCreateMemoryRouter<
 initialIndex?: number;
 },
 ): TRouter {
 routes.forEach(route => {
 allRoutes.add(route);
 });

 const router = createRouterFunction(routes, opts);
 const basename = opts ? opts.basename : undefined;

Expand All@@ -163,7 +195,7 @@ export function createV6CompatibleWrapCreateMemoryRouter<
 : router.state.location;

 if (router.state.historyAction === 'POP' && activeRootSpan) {
 updatePageloadTransaction(activeRootSpan, location, routes, undefined, basename);
 updatePageloadTransaction(activeRootSpan, location, routes, undefined, basename, Array.from(allRoutes));
 }

 router.subscribe((state: RouterState) => {
Expand All@@ -175,6 +207,7 @@ export function createV6CompatibleWrapCreateMemoryRouter<
 navigationType: state.historyAction,
 version,
 basename,
 allRoutes: Array.from(allRoutes),
 });
 }
 });
Expand DownExpand Up@@ -249,8 +282,6 @@ export function createV6CompatibleWrapUseRoutes(origUseRoutes: UseRoutes, versio
 return origUseRoutes;
 }

 const allRoutes: Set<RouteObject> = new Set();

 const SentryRoutes: React.FC<{
 children?: React.ReactNode;
 routes: RouteObject[];
Expand DownExpand Up@@ -322,7 +353,6 @@ export function handleNavigation(opts: {
 allRoutes?: RouteObject[];
}): void {
 const { location, routes, navigationType, version, matches, basename, allRoutes } = opts;

 const branches = Array.isArray(matches) ? matches : _matchRoutes(routes, location, basename);

 const client = getClient();
Expand DownExpand Up@@ -558,7 +588,7 @@ function updatePageloadTransaction(
): void {
 const branches = Array.isArray(matches)
 ? matches
 : (_matchRoutes(routes, location, basename) as unknown as RouteMatch[]);
 : (_matchRoutes(allRoutes || routes, location, basename) as unknown as RouteMatch[]);

 if (branches) {
 let name,
Expand All@@ -574,7 +604,7 @@ function updatePageloadTransaction(
 [name, source] = getNormalizedName(routes, location, branches, basename);
 }

 getCurrentScope().setTransactionName(name);
 getCurrentScope().setTransactionName(name || '/');

 if (activeRootSpan) {
 activeRootSpan.updateName(name);
Expand All@@ -597,8 +627,6 @@ export function createV6CompatibleWithSentryReactRouterRouting<P extends Record<
 return Routes;
 }

 const allRoutes: Set<RouteObject> = new Set();

 const SentryRoutes: React.FC<P> = (props: P) => {
 const isMountRenderPass = React.useRef(true);

Expand Down

11 changes: 8 additions & 3 deletions
packages/react/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -182,10 +182,14 @@ export interface RouterInit {
 hydrationData?: HydrationState;
}

export type NavigationState = {
 state: 'idle' | 'loading' | 'submitting';
};

export type NavigationStates = {
 Idle: any;
 Loading: any;
 Submitting: any;
 Idle: NavigationState;
 Loading: NavigationState;
 Submitting: NavigationState;
};

export type Navigation = NavigationStates[keyof NavigationStates];
Expand All@@ -202,6 +206,7 @@ export declare enum HistoryAction {
export interface RouterState {
 historyAction: Action | HistoryAction | any;
 location: Location;
 navigation: Navigation;
}
export interface Router<TState extends RouterState = RouterState> {
 state: TState;
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
fix(react/v8): Support lazy-loaded routes and components#15281

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.

 Sign up for GitHub

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

s1gr1d
merged 1 commit into

from

Feb 11, 2025
 Merged


fix(react/v8): Support lazy-loaded routes and components
#15281
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


11 changes: 10 additions & 1 deletion
dev-packages/e2e-tests/test-applications/react-create-browser-router/src/index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import * as Sentry from '@sentry/react';
import React from 'react';
import React, { lazy, Suspense } from 'react';
import ReactDOM from 'react-dom/client';
import {
 RouterProvider,
Expand DownExpand Up@@ -42,13 +42,22 @@ Sentry.init({
});

const sentryCreateBrowserRouter = Sentry.wrapCreateBrowserRouterV6(createBrowserRouter);
const LazyLoadedUser = lazy(() => import('./pages/LazyLoadedUser'));

const router = sentryCreateBrowserRouter(
 [
 {
 path: '/',
 element: <Index />,
 },
 {
 path: '/lazy-loaded-user/*',
 element: (
 <Suspense fallback={<div>Loading...</div>}>
 <LazyLoadedUser />
 </Suspense>
 ),
 },
 {
 path: '/user/:id',
 element: <User />,
Expand Down

3 changes: 3 additions & 0 deletions
dev-packages/e2e-tests/test-applications/react-create-browser-router/src/pages/Index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,9 @@ const Index = () => {
<Linkto="/user/5"id="navigation">
 navigate
</Link>
<Linkto="/lazy-loaded-user/5/foo"id="lazy-navigation">
 lazy navigate
</Link>
</>
);
};
Expand Down

14 changes: 14 additions & 0 deletions
...2e-tests/test-applications/react-create-browser-router/src/pages/LazyLoadedInnerRoute.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
import * as Sentry from '@sentry/react';
// biome-ignore lint/nursery/noUnusedImports: Need React import for JSX
import * as React from 'react';
import { Route, Routes } from 'react-router-dom';

const SentryRoutes = Sentry.withSentryReactRouterV6Routing(Routes);

const InnerRoute = () => (
 <SentryRoutes>
 <Route path=":innerId" element={<p id="content">I am a lazy loaded user</p>} />
 </SentryRoutes>
);

export default InnerRoute;

23 changes: 23 additions & 0 deletions
...ages/e2e-tests/test-applications/react-create-browser-router/src/pages/LazyLoadedUser.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import * as Sentry from '@sentry/react';
import * as React from 'react';
import { Route, Routes } from 'react-router-dom';

const SentryRoutes = Sentry.withSentryReactRouterV6Routing(Routes);
const InnerRoute = React.lazy(() => import('./LazyLoadedInnerRoute'));

const LazyLoadedUser = () => {
 return (
 <SentryRoutes>
 <Route
 path=":id/*"
 element={
 <React.Suspense fallback={<p>Loading...</p>}>
 <InnerRoute />
 </React.Suspense>
 }
 />
 </SentryRoutes>
 );
};

export default LazyLoadedUser;

102 changes: 102 additions & 0 deletions
...ckages/e2e-tests/test-applications/react-create-browser-router/tests/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,3 +76,105 @@ test('Captures a navigation transaction', async ({ page }) => {

 expect(transactionEvent.spans).toEqual([]);
});

test('Captures a lazy pageload transaction', async ({ page }) => {
 const transactionEventPromise = waitForTransaction('react-create-browser-router', event => {
 return event.contexts?.trace?.op === 'pageload';
 });

 await page.goto('/lazy-loaded-user/5/foo');

 const transactionEvent = await transactionEventPromise;
 expect(transactionEvent.contexts?.trace).toEqual({
 data: expect.objectContaining({
 'sentry.idle_span_finish_reason': 'idleTimeout',
 'sentry.op': 'pageload',
 'sentry.origin': 'auto.pageload.react.reactrouter_v6',
 'sentry.sample_rate': 1,
 'sentry.source': 'route',
 }),
 op: 'pageload',
 span_id: expect.stringMatching(/[a-f0-9]{16}/),
 trace_id: expect.stringMatching(/[a-f0-9]{32}/),
 origin: 'auto.pageload.react.reactrouter_v6',
 });

 expect(transactionEvent).toEqual(
 expect.objectContaining({
 transaction: '/lazy-loaded-user/:id/:innerId',
 type: 'transaction',
 transaction_info: {
 source: 'route',
 },
 }),
 );

 expect(await page.innerText('id=content')).toContain('I am a lazy loaded user');

 expect(transactionEvent.spans).toEqual(
 expect.arrayContaining([
 // This one is the outer lazy route
 expect.objectContaining({
 op: 'resource.script',
 origin: 'auto.resource.browser.metrics',
 }),
 // This one is the inner lazy route
 expect.objectContaining({
 op: 'resource.script',
 origin: 'auto.resource.browser.metrics',
 }),
 ]),
 );
});

test('Captures a lazy navigation transaction', async ({ page }) => {
 const transactionEventPromise = waitForTransaction('react-create-browser-router', event => {
 return event.contexts?.trace?.op === 'navigation';
 });

 await page.goto('/');
 const linkElement = page.locator('id=lazy-navigation');
 await linkElement.click();

 const transactionEvent = await transactionEventPromise;
 expect(transactionEvent.contexts?.trace).toEqual({
 data: expect.objectContaining({
 'sentry.idle_span_finish_reason': 'idleTimeout',
 'sentry.op': 'navigation',
 'sentry.origin': 'auto.navigation.react.reactrouter_v6',
 'sentry.sample_rate': 1,
 'sentry.source': 'route',
 }),
 op: 'navigation',
 span_id: expect.stringMatching(/[a-f0-9]{16}/),
 trace_id: expect.stringMatching(/[a-f0-9]{32}/),
 origin: 'auto.navigation.react.reactrouter_v6',
 });

 expect(transactionEvent).toEqual(
 expect.objectContaining({
 transaction: '/lazy-loaded-user/:id/:innerId',
 type: 'transaction',
 transaction_info: {
 source: 'route',
 },
 }),
 );

 expect(await page.innerText('id=content')).toContain('I am a lazy loaded user');

 expect(transactionEvent.spans).toEqual(
 expect.arrayContaining([
 // This one is the outer lazy route
 expect.objectContaining({
 op: 'resource.script',
 origin: 'auto.resource.browser.metrics',
 }),
 // This one is the inner lazy route
 expect.objectContaining({
 op: 'resource.script',
 origin: 'auto.resource.browser.metrics',
 }),
 ]),
 );
});

62 changes: 45 additions & 17 deletions
packages/react/src/reactrouterv6-compat-utils.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,6 +62,9 @@ export interface ReactRouterOptions {

type V6CompatibleVersion = '6' | '7';

// Keeping as a global variable for cross-usage in multiple functions
const allRoutes = new Set<RouteObject>();

/**
 * Creates a wrapCreateBrowserRouter function that can be used with all React Router v6 compatible versions.
 */
Expand All@@ -82,6 +85,10 @@ export function createV6CompatibleWrapCreateBrowserRouter<
 }

 return function (routes: RouteObject[], opts?: Record<string, unknown> & { basename?: string }): TRouter {
 routes.forEach(route => {
 allRoutes.add(route);
 });

 const router = createRouterFunction(routes, opts);
 const basename = opts && opts.basename;

Expand All@@ -91,19 +98,40 @@ export function createV6CompatibleWrapCreateBrowserRouter<
 // This is the earliest convenient time to update the transaction name.
 // Callbacks to `router.subscribe` are not called for the initial load.
 if (router.state.historyAction === 'POP' && activeRootSpan) {
 updatePageloadTransaction(activeRootSpan, router.state.location, routes, undefined, basename);
 updatePageloadTransaction(
 activeRootSpan,
 router.state.location,
 routes,
 undefined,
 basename,
 Array.from(allRoutes),
 );
 }

 router.subscribe((state: RouterState) => {
 const location = state.location;
 if (state.historyAction === 'PUSH' || state.historyAction === 'POP') {
 handleNavigation({
 location,
 routes,
 navigationType: state.historyAction,
 version,
 basename,
 });
 // Wait for the next render if loading an unsettled route
 if (state.navigation.state !== 'idle') {
 requestAnimationFrame(() => {
 handleNavigation({
 location: state.location,
 routes,
 navigationType: state.historyAction,
 version,
 basename,
 allRoutes: Array.from(allRoutes),
 });
 });
 } else {
 handleNavigation({
 location: state.location,
 routes,
 navigationType: state.historyAction,
 version,
 basename,
 allRoutes: Array.from(allRoutes),
 });
 }
 }
 });

Expand DownExpand Up@@ -138,6 +166,10 @@ export function createV6CompatibleWrapCreateMemoryRouter<
 initialIndex?: number;
 },
 ): TRouter {
 routes.forEach(route => {
 allRoutes.add(route);
 });

 const router = createRouterFunction(routes, opts);
 const basename = opts ? opts.basename : undefined;

Expand All@@ -163,7 +195,7 @@ export function createV6CompatibleWrapCreateMemoryRouter<
 : router.state.location;

 if (router.state.historyAction === 'POP' && activeRootSpan) {
 updatePageloadTransaction(activeRootSpan, location, routes, undefined, basename);
 updatePageloadTransaction(activeRootSpan, location, routes, undefined, basename, Array.from(allRoutes));
 }

 router.subscribe((state: RouterState) => {
Expand All@@ -175,6 +207,7 @@ export function createV6CompatibleWrapCreateMemoryRouter<
 navigationType: state.historyAction,
 version,
 basename,
 allRoutes: Array.from(allRoutes),
 });
 }
 });
Expand DownExpand Up@@ -249,8 +282,6 @@ export function createV6CompatibleWrapUseRoutes(origUseRoutes: UseRoutes, versio
 return origUseRoutes;
 }

 const allRoutes: Set<RouteObject> = new Set();

 const SentryRoutes: React.FC<{
 children?: React.ReactNode;
 routes: RouteObject[];
Expand DownExpand Up@@ -322,7 +353,6 @@ export function handleNavigation(opts: {
 allRoutes?: RouteObject[];
}): void {
 const { location, routes, navigationType, version, matches, basename, allRoutes } = opts;

 const branches = Array.isArray(matches) ? matches : _matchRoutes(routes, location, basename);

 const client = getClient();
Expand DownExpand Up@@ -558,7 +588,7 @@ function updatePageloadTransaction(
): void {
 const branches = Array.isArray(matches)
 ? matches
 : (_matchRoutes(routes, location, basename) as unknown as RouteMatch[]);
 : (_matchRoutes(allRoutes || routes, location, basename) as unknown as RouteMatch[]);

 if (branches) {
 let name,
Expand All@@ -574,7 +604,7 @@ function updatePageloadTransaction(
 [name, source] = getNormalizedName(routes, location, branches, basename);
 }

 getCurrentScope().setTransactionName(name);
 getCurrentScope().setTransactionName(name || '/');

 if (activeRootSpan) {
 activeRootSpan.updateName(name);
Expand All@@ -597,8 +627,6 @@ export function createV6CompatibleWithSentryReactRouterRouting<P extends Record<
 return Routes;
 }

 const allRoutes: Set<RouteObject> = new Set();

 const SentryRoutes: React.FC<P> = (props: P) => {
 const isMountRenderPass = React.useRef(true);

Expand Down

11 changes: 8 additions & 3 deletions
packages/react/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -182,10 +182,14 @@ export interface RouterInit {
 hydrationData?: HydrationState;
}

export type NavigationState = {
 state: 'idle' | 'loading' | 'submitting';
};

export type NavigationStates = {
 Idle: any;
 Loading: any;
 Submitting: any;
 Idle: NavigationState;
 Loading: NavigationState;
 Submitting: NavigationState;
};

export type Navigation = NavigationStates[keyof NavigationStates];
Expand All@@ -202,6 +206,7 @@ export declare enum HistoryAction {
export interface RouterState {
 historyAction: Action | HistoryAction | any;
 location: Location;
 navigation: Navigation;
}
export interface Router<TState extends RouterState = RouterState> {
 state: TState;
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
fix(react/v8): Support lazy-loaded routes and components#15281

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.

 Sign up for GitHub

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

s1gr1d
merged 1 commit into

from

Feb 11, 2025
 Merged


fix(react/v8): Support lazy-loaded routes and components
#15281
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


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


11 changes: 10 additions & 1 deletion
dev-packages/e2e-tests/test-applications/react-create-browser-router/src/index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
import * as Sentry from '@sentry/react';
import React from 'react';
import React, { lazy, Suspense } from 'react';
import ReactDOM from 'react-dom/client';
import {
 RouterProvider,
Expand DownExpand Up@@ -42,13 +42,22 @@ Sentry.init({
});

const sentryCreateBrowserRouter = Sentry.wrapCreateBrowserRouterV6(createBrowserRouter);
const LazyLoadedUser = lazy(() => import('./pages/LazyLoadedUser'));

const router = sentryCreateBrowserRouter(
 [
 {
 path: '/',
 element: <Index />,
 },
 {
 path: '/lazy-loaded-user/*',
 element: (
 <Suspense fallback={<div>Loading...</div>}>
 <LazyLoadedUser />
 </Suspense>
 ),
 },
 {
 path: '/user/:id',
 element: <User />,
Expand Down

3 changes: 3 additions & 0 deletions
dev-packages/e2e-tests/test-applications/react-create-browser-router/src/pages/Index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,9 @@ const Index = () => {
<Linkto="/user/5"id="navigation">
 navigate
</Link>
<Linkto="/lazy-loaded-user/5/foo"id="lazy-navigation">
 lazy navigate
</Link>
</>
);
};
Expand Down

14 changes: 14 additions & 0 deletions
...2e-tests/test-applications/react-create-browser-router/src/pages/LazyLoadedInnerRoute.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
import * as Sentry from '@sentry/react';
// biome-ignore lint/nursery/noUnusedImports: Need React import for JSX
import * as React from 'react';
import { Route, Routes } from 'react-router-dom';

const SentryRoutes = Sentry.withSentryReactRouterV6Routing(Routes);

const InnerRoute = () => (
 <SentryRoutes>
 <Route path=":innerId" element={<p id="content">I am a lazy loaded user</p>} />
 </SentryRoutes>
);

export default InnerRoute;

23 changes: 23 additions & 0 deletions
...ages/e2e-tests/test-applications/react-create-browser-router/src/pages/LazyLoadedUser.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
import * as Sentry from '@sentry/react';
import * as React from 'react';
import { Route, Routes } from 'react-router-dom';

const SentryRoutes = Sentry.withSentryReactRouterV6Routing(Routes);
const InnerRoute = React.lazy(() => import('./LazyLoadedInnerRoute'));

const LazyLoadedUser = () => {
 return (
 <SentryRoutes>
 <Route
 path=":id/*"
 element={
 <React.Suspense fallback={<p>Loading...</p>}>
 <InnerRoute />
 </React.Suspense>
 }
 />
 </SentryRoutes>
 );
};

export default LazyLoadedUser;

102 changes: 102 additions & 0 deletions
...ckages/e2e-tests/test-applications/react-create-browser-router/tests/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -76,3 +76,105 @@ test('Captures a navigation transaction', async ({ page }) => {

 expect(transactionEvent.spans).toEqual([]);
});

test('Captures a lazy pageload transaction', async ({ page }) => {
 const transactionEventPromise = waitForTransaction('react-create-browser-router', event => {
 return event.contexts?.trace?.op === 'pageload';
 });

 await page.goto('/lazy-loaded-user/5/foo');

 const transactionEvent = await transactionEventPromise;
 expect(transactionEvent.contexts?.trace).toEqual({
 data: expect.objectContaining({
 'sentry.idle_span_finish_reason': 'idleTimeout',
 'sentry.op': 'pageload',
 'sentry.origin': 'auto.pageload.react.reactrouter_v6',
 'sentry.sample_rate': 1,
 'sentry.source': 'route',
 }),
 op: 'pageload',
 span_id: expect.stringMatching(/[a-f0-9]{16}/),
 trace_id: expect.stringMatching(/[a-f0-9]{32}/),
 origin: 'auto.pageload.react.reactrouter_v6',
 });

 expect(transactionEvent).toEqual(
 expect.objectContaining({
 transaction: '/lazy-loaded-user/:id/:innerId',
 type: 'transaction',
 transaction_info: {
 source: 'route',
 },
 }),
 );

 expect(await page.innerText('id=content')).toContain('I am a lazy loaded user');

 expect(transactionEvent.spans).toEqual(
 expect.arrayContaining([
 // This one is the outer lazy route
 expect.objectContaining({
 op: 'resource.script',
 origin: 'auto.resource.browser.metrics',
 }),
 // This one is the inner lazy route
 expect.objectContaining({
 op: 'resource.script',
 origin: 'auto.resource.browser.metrics',
 }),
 ]),
 );
});

test('Captures a lazy navigation transaction', async ({ page }) => {
 const transactionEventPromise = waitForTransaction('react-create-browser-router', event => {
 return event.contexts?.trace?.op === 'navigation';
 });

 await page.goto('/');
 const linkElement = page.locator('id=lazy-navigation');
 await linkElement.click();

 const transactionEvent = await transactionEventPromise;
 expect(transactionEvent.contexts?.trace).toEqual({
 data: expect.objectContaining({
 'sentry.idle_span_finish_reason': 'idleTimeout',
 'sentry.op': 'navigation',
 'sentry.origin': 'auto.navigation.react.reactrouter_v6',
 'sentry.sample_rate': 1,
 'sentry.source': 'route',
 }),
 op: 'navigation',
 span_id: expect.stringMatching(/[a-f0-9]{16}/),
 trace_id: expect.stringMatching(/[a-f0-9]{32}/),
 origin: 'auto.navigation.react.reactrouter_v6',
 });

 expect(transactionEvent).toEqual(
 expect.objectContaining({
 transaction: '/lazy-loaded-user/:id/:innerId',
 type: 'transaction',
 transaction_info: {
 source: 'route',
 },
 }),
 );

 expect(await page.innerText('id=content')).toContain('I am a lazy loaded user');

 expect(transactionEvent.spans).toEqual(
 expect.arrayContaining([
 // This one is the outer lazy route
 expect.objectContaining({
 op: 'resource.script',
 origin: 'auto.resource.browser.metrics',
 }),
 // This one is the inner lazy route
 expect.objectContaining({
 op: 'resource.script',
 origin: 'auto.resource.browser.metrics',
 }),
 ]),
 );
});

62 changes: 45 additions & 17 deletions
packages/react/src/reactrouterv6-compat-utils.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -62,6 +62,9 @@ export interface ReactRouterOptions {

type V6CompatibleVersion = '6' | '7';

// Keeping as a global variable for cross-usage in multiple functions
const allRoutes = new Set<RouteObject>();

/**
 * Creates a wrapCreateBrowserRouter function that can be used with all React Router v6 compatible versions.
 */
Expand All@@ -82,6 +85,10 @@ export function createV6CompatibleWrapCreateBrowserRouter<
 }

 return function (routes: RouteObject[], opts?: Record<string, unknown> & { basename?: string }): TRouter {
 routes.forEach(route => {
 allRoutes.add(route);
 });

 const router = createRouterFunction(routes, opts);
 const basename = opts && opts.basename;

Expand All@@ -91,19 +98,40 @@ export function createV6CompatibleWrapCreateBrowserRouter<
 // This is the earliest convenient time to update the transaction name.
 // Callbacks to `router.subscribe` are not called for the initial load.
 if (router.state.historyAction === 'POP' && activeRootSpan) {
 updatePageloadTransaction(activeRootSpan, router.state.location, routes, undefined, basename);
 updatePageloadTransaction(
 activeRootSpan,
 router.state.location,
 routes,
 undefined,
 basename,
 Array.from(allRoutes),
 );
 }

 router.subscribe((state: RouterState) => {
 const location = state.location;
 if (state.historyAction === 'PUSH' || state.historyAction === 'POP') {
 handleNavigation({
 location,
 routes,
 navigationType: state.historyAction,
 version,
 basename,
 });
 // Wait for the next render if loading an unsettled route
 if (state.navigation.state !== 'idle') {
 requestAnimationFrame(() => {
 handleNavigation({
 location: state.location,
 routes,
 navigationType: state.historyAction,
 version,
 basename,
 allRoutes: Array.from(allRoutes),
 });
 });
 } else {
 handleNavigation({
 location: state.location,
 routes,
 navigationType: state.historyAction,
 version,
 basename,
 allRoutes: Array.from(allRoutes),
 });
 }
 }
 });

Expand DownExpand Up@@ -138,6 +166,10 @@ export function createV6CompatibleWrapCreateMemoryRouter<
 initialIndex?: number;
 },
 ): TRouter {
 routes.forEach(route => {
 allRoutes.add(route);
 });

 const router = createRouterFunction(routes, opts);
 const basename = opts ? opts.basename : undefined;

Expand All@@ -163,7 +195,7 @@ export function createV6CompatibleWrapCreateMemoryRouter<
 : router.state.location;

 if (router.state.historyAction === 'POP' && activeRootSpan) {
 updatePageloadTransaction(activeRootSpan, location, routes, undefined, basename);
 updatePageloadTransaction(activeRootSpan, location, routes, undefined, basename, Array.from(allRoutes));
 }

 router.subscribe((state: RouterState) => {
Expand All@@ -175,6 +207,7 @@ export function createV6CompatibleWrapCreateMemoryRouter<
 navigationType: state.historyAction,
 version,
 basename,
 allRoutes: Array.from(allRoutes),
 });
 }
 });
Expand DownExpand Up@@ -249,8 +282,6 @@ export function createV6CompatibleWrapUseRoutes(origUseRoutes: UseRoutes, versio
 return origUseRoutes;
 }

 const allRoutes: Set<RouteObject> = new Set();

 const SentryRoutes: React.FC<{
 children?: React.ReactNode;
 routes: RouteObject[];
Expand DownExpand Up@@ -322,7 +353,6 @@ export function handleNavigation(opts: {
 allRoutes?: RouteObject[];
}): void {
 const { location, routes, navigationType, version, matches, basename, allRoutes } = opts;

 const branches = Array.isArray(matches) ? matches : _matchRoutes(routes, location, basename);

 const client = getClient();
Expand DownExpand Up@@ -558,7 +588,7 @@ function updatePageloadTransaction(
): void {
 const branches = Array.isArray(matches)
 ? matches
 : (_matchRoutes(routes, location, basename) as unknown as RouteMatch[]);
 : (_matchRoutes(allRoutes || routes, location, basename) as unknown as RouteMatch[]);

 if (branches) {
 let name,
Expand All@@ -574,7 +604,7 @@ function updatePageloadTransaction(
 [name, source] = getNormalizedName(routes, location, branches, basename);
 }

 getCurrentScope().setTransactionName(name);
 getCurrentScope().setTransactionName(name || '/');

 if (activeRootSpan) {
 activeRootSpan.updateName(name);
Expand All@@ -597,8 +627,6 @@ export function createV6CompatibleWithSentryReactRouterRouting<P extends Record<
 return Routes;
 }

 const allRoutes: Set<RouteObject> = new Set();

 const SentryRoutes: React.FC<P> = (props: P) => {
 const isMountRenderPass = React.useRef(true);

Expand Down

11 changes: 8 additions & 3 deletions
packages/react/src/types.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -182,10 +182,14 @@ export interface RouterInit {
 hydrationData?: HydrationState;
}

export type NavigationState = {
 state: 'idle' | 'loading' | 'submitting';
};

export type NavigationStates = {
 Idle: any;
 Loading: any;
 Submitting: any;
 Idle: NavigationState;
 Loading: NavigationState;
 Submitting: NavigationState;
};

export type Navigation = NavigationStates[keyof NavigationStates];
Expand All@@ -202,6 +206,7 @@ export declare enum HistoryAction {
export interface RouterState {
 historyAction: Action | HistoryAction | any;
 location: Location;
 navigation: Navigation;
}
export interface Router<TState extends RouterState = RouterState> {
 state: TState;
Expand Down