fix(react): Use Set as the allRoutes container.#14878

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
chargome merged 3 commits into from
Jan 2, 2025
Merged

fix(react): Use Set as the allRoutes container. #14878

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b925c14
fix(react): Use `Set` as the `allRoutes` container.
onurtemizkan Dec 31, 2024
eb8c9da
Apply suggestions from code review
onurtemizkan Jan 2, 2025
6255033
Fix formatting.
onurtemizkan Jan 2, 2025
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
18 changes: 15 additions & 3 deletions dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/src/index.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import React from 'react';
import ReactDOM from 'react-dom/client';
import {
BrowserRouter,
Outlet,
Route,
Routes,
createRoutesFromChildren,
Expand DownExpand Up@@ -48,17 +49,28 @@ const DetailsRoutes = () => (
</SentryRoutes>
);

const DetailsRoutesAlternative = () => (
<SentryRoutes>
<Route path=":detailId" element={<div id="details">Details</div>} />
</SentryRoutes>
);

const ViewsRoutes = () => (
<SentryRoutes>
<Route index element={<div id="views">Views</div>} />
<Route path="views/:viewId/*" element={<DetailsRoutes />} />
<Route path="old-views/:viewId/*" element={<DetailsRoutesAlternative />} />
</SentryRoutes>
);

const ProjectsRoutes = () => (
<SentryRoutes>
<Route path="projects/:projectId/*" element={<ViewsRoutes />}></Route>
<Route path="*" element={<div>No Match Page</div>} />
<Route path="projects" element={<Outlet />}>
<Route index element={<div>Project Page Root</div>} />
<Route path="*" element={<Outlet />}>
<Route path=":projectId/*" element={<ViewsRoutes />} />
</Route>
</Route>
</SentryRoutes>
);

Expand All@@ -67,7 +79,7 @@ root.render(
<BrowserRouter>
<SentryRoutes>
<Route path="/" element={<Index />} />
<Route path="/*" element={<ProjectsRoutes />}></Route>
<Route path="/*" element={<ProjectsRoutes />} />
</SentryRoutes>
</BrowserRouter>,
);
3 changes: 3 additions & 0 deletions ...packages/e2e-tests/test-applications/react-router-6-descendant-routes/src/pages/Index.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,9 @@ const Index = () => {
<Link to="/projects/123/views/456/789" id="navigation">
navigate
</Link>
<Link to="/projects/123/old-views/345/654" id="old-navigation">
navigate old
</Link>
</>
);
};
Expand Down
71 changes: 71 additions & 0 deletions ...s/e2e-tests/test-applications/react-router-6-descendant-routes/tests/transactions.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ test('sends a pageload transaction with a parameterized URL', async ({ page }) =

const rootSpan = await transactionPromise;

expect((await page.innerHTML('#root')).includes('Details')).toBe(true);
expect(rootSpan).toMatchObject({
contexts: {
trace: {
Expand All@@ -24,6 +25,30 @@ test('sends a pageload transaction with a parameterized URL', async ({ page }) =
});
});

test('sends a pageload transaction with a parameterized URL - alternative route', async ({ page }) => {
const transactionPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
});

await page.goto(`/projects/234/old-views/234/567`);

const rootSpan = await transactionPromise;

expect((await page.innerHTML('#root')).includes('Details')).toBe(true);
expect(rootSpan).toMatchObject({
contexts: {
trace: {
op: 'pageload',
origin: 'auto.pageload.react.reactrouter_v6',
},
},
transaction: '/projects/:projectId/old-views/:viewId/:detailId',
transaction_info: {
source: 'route',
},
});
});

test('sends a navigation transaction with a parameterized URL', async ({ page }) => {
const pageloadTxnPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
Expand DownExpand Up@@ -52,6 +77,8 @@ test('sends a navigation transaction with a parameterized URL', async ({ page })
const linkElement = page.locator('id=navigation');

const [_, navigationTxn] = await Promise.all([linkElement.click(), navigationTxnPromise]);

expect((await page.innerHTML('#root')).includes('Details')).toBe(true);
expect(navigationTxn).toMatchObject({
contexts: {
trace: {
Expand All@@ -65,3 +92,47 @@ test('sends a navigation transaction with a parameterized URL', async ({ page })
},
});
});

test('sends a navigation transaction with a parameterized URL - alternative route', async ({ page }) => {
const pageloadTxnPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
});

const navigationTxnPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'navigation';
});

await page.goto(`/`);
const pageloadTxn = await pageloadTxnPromise;

expect(pageloadTxn).toMatchObject({
contexts: {
trace: {
op: 'pageload',
origin: 'auto.pageload.react.reactrouter_v6',
},
},
transaction: '/',
transaction_info: {
source: 'route',
},
});

const linkElement = page.locator('id=old-navigation');

const [_, navigationTxn] = await Promise.all([linkElement.click(), navigationTxnPromise]);

expect((await page.innerHTML('#root')).includes('Details')).toBe(true);
expect(navigationTxn).toMatchObject({
contexts: {
trace: {
op: 'navigation',
origin: 'auto.navigation.react.reactrouter_v6',
},
},
transaction: '/projects/:projectId/old-views/:viewId/:detailId',
transaction_info: {
source: 'route',
},
});
});
49 changes: 34 additions & 15 deletions packages/react/src/reactrouterv6-compat-utils.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -179,7 +179,7 @@ export function createV6CompatibleWrapUseRoutes(origUseRoutes: UseRoutes, versio
return origUseRoutes;
}

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

const SentryRoutes: React.FC<{
children?: React.ReactNode;
Expand All@@ -206,18 +206,29 @@ export function createV6CompatibleWrapUseRoutes(origUseRoutes: UseRoutes, versio

if (isMountRenderPass.current) {
routes.forEach(route => {
allRoutes.push(...getChildRoutesRecursively(route));
const extractedChildRoutes = getChildRoutesRecursively(route);

extractedChildRoutes.forEach(r => {
allRoutes.add(r);
});
});

updatePageloadTransaction(getActiveRootSpan(), normalizedLocation, routes, undefined, undefined, allRoutes);
updatePageloadTransaction(
getActiveRootSpan(),
normalizedLocation,
routes,
undefined,
undefined,
Array.from(allRoutes),
);
isMountRenderPass.current = false;
} else {
handleNavigation({
location: normalizedLocation,
routes,
navigationType,
version,
allRoutes,
allRoutes: Array.from(allRoutes),
});
}
}, [navigationType, stableLocationParam]);
Expand DownExpand Up@@ -342,14 +353,18 @@ function locationIsInsideDescendantRoute(location: Location, routes: RouteObject
return false;
}

function getChildRoutesRecursively(route: RouteObject, allRoutes: RouteObject[] = []): RouteObject[] {
if (route.children && !route.index) {
route.children.forEach(child => {
allRoutes.push(...getChildRoutesRecursively(child, allRoutes));
});
}
function getChildRoutesRecursively(route: RouteObject, allRoutes: Set<RouteObject> = new Set()): Set<RouteObject> {
if (!allRoutes.has(route)) {
allRoutes.add(route);

allRoutes.push(route);
if (route.children && !route.index) {
route.children.forEach(child => {
const childRoutes = getChildRoutesRecursively(child, allRoutes);

childRoutes.forEach(r => allRoutes.add(r));
});
}
}

return allRoutes;
}
Expand DownExpand Up@@ -510,7 +525,7 @@ export function createV6CompatibleWithSentryReactRouterRouting<P extends Record<
return Routes;
}

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

const SentryRoutes: React.FC<P> = (props: P) => {
const isMountRenderPass = React.useRef(true);
Expand All@@ -524,18 +539,22 @@ export function createV6CompatibleWithSentryReactRouterRouting<P extends Record<

if (isMountRenderPass.current) {
routes.forEach(route => {
allRoutes.push(...getChildRoutesRecursively(route));
const extractedChildRoutes = getChildRoutesRecursively(route);

extractedChildRoutes.forEach(r => {
allRoutes.add(r);
});
});

updatePageloadTransaction(getActiveRootSpan(), location, routes, undefined, undefined, allRoutes);
updatePageloadTransaction(getActiveRootSpan(), location, routes, undefined, undefined, Array.from(allRoutes));
isMountRenderPass.current = false;
} else {
handleNavigation({
location,
routes,
navigationType,
version,
allRoutes,
allRoutes: Array.from(allRoutes),
});
}
},
Expand Down
Loading
, '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): Use Set as the allRoutes container.#14878

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

chargome
merged 3 commits into

from

Jan 2, 2025
 Merged


fix(react): Use Set as the allRoutes container.
#14878
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
b925c14

fix(react): Use `Set` as the `allRoutes` container.


onurtemizkan Dec 31, 2024
eb8c9da

Apply suggestions from code review


onurtemizkan Jan 2, 2025
6255033

Fix formatting.


onurtemizkan Jan 2, 2025

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


18 changes: 15 additions & 3 deletions
dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/src/index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import React from 'react';
import ReactDOM from 'react-dom/client';
import {
 BrowserRouter,
 Outlet,
 Route,
 Routes,
 createRoutesFromChildren,
Expand DownExpand Up@@ -48,17 +49,28 @@ const DetailsRoutes = () => (
 </SentryRoutes>
);

const DetailsRoutesAlternative = () => (
 <SentryRoutes>
 <Route path=":detailId" element={<div id="details">Details</div>} />
 </SentryRoutes>
);

const ViewsRoutes = () => (
 <SentryRoutes>
 <Route index element={<div id="views">Views</div>} />
 <Route path="views/:viewId/*" element={<DetailsRoutes />} />
 <Route path="old-views/:viewId/*" element={<DetailsRoutesAlternative />} />
 </SentryRoutes>
);

const ProjectsRoutes = () => (
 <SentryRoutes>
 <Route path="projects/:projectId/*" element={<ViewsRoutes />}></Route>
 <Route path="*" element={<div>No Match Page</div>} />
 <Route path="projects" element={<Outlet />}>
 <Route index element={<div>Project Page Root</div>} />
 <Route path="*" element={<Outlet />}>
 <Route path=":projectId/*" element={<ViewsRoutes />} />
 </Route>
 </Route>
 </SentryRoutes>
);

Expand All@@ -67,7 +79,7 @@ root.render(
 <BrowserRouter>
 <SentryRoutes>
 <Route path="/" element={<Index />} />
 <Route path="/*" element={<ProjectsRoutes />}></Route>
 <Route path="/*" element={<ProjectsRoutes />} />
 </SentryRoutes>
 </BrowserRouter>,
);

3 changes: 3 additions & 0 deletions
...packages/e2e-tests/test-applications/react-router-6-descendant-routes/src/pages/Index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,9 @@ const Index = () => {
 <Link to="/projects/123/views/456/789" id="navigation">
 navigate
 </Link>
 <Link to="/projects/123/old-views/345/654" id="old-navigation">
 navigate old
 </Link>
 </>
 );
};
Expand Down

71 changes: 71 additions & 0 deletions
...s/e2e-tests/test-applications/react-router-6-descendant-routes/tests/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ test('sends a pageload transaction with a parameterized URL', async ({ page }) =

 const rootSpan = await transactionPromise;

 expect((await page.innerHTML('#root')).includes('Details')).toBe(true);
 expect(rootSpan).toMatchObject({
 contexts: {
 trace: {
Expand All@@ -24,6 +25,30 @@ test('sends a pageload transaction with a parameterized URL', async ({ page }) =
 });
});

test('sends a pageload transaction with a parameterized URL - alternative route', async ({ page }) => {
 const transactionPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
 });

 await page.goto(`/projects/234/old-views/234/567`);

 const rootSpan = await transactionPromise;

 expect((await page.innerHTML('#root')).includes('Details')).toBe(true);
 expect(rootSpan).toMatchObject({
 contexts: {
 trace: {
 op: 'pageload',
 origin: 'auto.pageload.react.reactrouter_v6',
 },
 },
 transaction: '/projects/:projectId/old-views/:viewId/:detailId',
 transaction_info: {
 source: 'route',
 },
 });
});

test('sends a navigation transaction with a parameterized URL', async ({ page }) => {
 const pageloadTxnPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
Expand DownExpand Up@@ -52,6 +77,8 @@ test('sends a navigation transaction with a parameterized URL', async ({ page })
 const linkElement = page.locator('id=navigation');

 const [_, navigationTxn] = await Promise.all([linkElement.click(), navigationTxnPromise]);

 expect((await page.innerHTML('#root')).includes('Details')).toBe(true);
 expect(navigationTxn).toMatchObject({
 contexts: {
 trace: {
Expand All@@ -65,3 +92,47 @@ test('sends a navigation transaction with a parameterized URL', async ({ page })
 },
 });
});

test('sends a navigation transaction with a parameterized URL - alternative route', async ({ page }) => {
 const pageloadTxnPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
 });

 const navigationTxnPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'navigation';
 });

 await page.goto(`/`);
 const pageloadTxn = await pageloadTxnPromise;

 expect(pageloadTxn).toMatchObject({
 contexts: {
 trace: {
 op: 'pageload',
 origin: 'auto.pageload.react.reactrouter_v6',
 },
 },
 transaction: '/',
 transaction_info: {
 source: 'route',
 },
 });

 const linkElement = page.locator('id=old-navigation');

 const [_, navigationTxn] = await Promise.all([linkElement.click(), navigationTxnPromise]);

 expect((await page.innerHTML('#root')).includes('Details')).toBe(true);
 expect(navigationTxn).toMatchObject({
 contexts: {
 trace: {
 op: 'navigation',
 origin: 'auto.navigation.react.reactrouter_v6',
 },
 },
 transaction: '/projects/:projectId/old-views/:viewId/:detailId',
 transaction_info: {
 source: 'route',
 },
 });
});

49 changes: 34 additions & 15 deletions
packages/react/src/reactrouterv6-compat-utils.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -179,7 +179,7 @@ export function createV6CompatibleWrapUseRoutes(origUseRoutes: UseRoutes, versio
 return origUseRoutes;
 }

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

 const SentryRoutes: React.FC<{
 children?: React.ReactNode;
Expand All@@ -206,18 +206,29 @@ export function createV6CompatibleWrapUseRoutes(origUseRoutes: UseRoutes, versio

 if (isMountRenderPass.current) {
 routes.forEach(route => {
 allRoutes.push(...getChildRoutesRecursively(route));
 const extractedChildRoutes = getChildRoutesRecursively(route);

 extractedChildRoutes.forEach(r => {
 allRoutes.add(r);
 });
 });

 updatePageloadTransaction(getActiveRootSpan(), normalizedLocation, routes, undefined, undefined, allRoutes);
 updatePageloadTransaction(
 getActiveRootSpan(),
 normalizedLocation,
 routes,
 undefined,
 undefined,
 Array.from(allRoutes),
 );
 isMountRenderPass.current = false;
 } else {
 handleNavigation({
 location: normalizedLocation,
 routes,
 navigationType,
 version,
 allRoutes,
 allRoutes: Array.from(allRoutes),
 });
 }
 }, [navigationType, stableLocationParam]);
Expand DownExpand Up@@ -342,14 +353,18 @@ function locationIsInsideDescendantRoute(location: Location, routes: RouteObject
 return false;
}

function getChildRoutesRecursively(route: RouteObject, allRoutes: RouteObject[] = []): RouteObject[] {
 if (route.children && !route.index) {
 route.children.forEach(child => {
 allRoutes.push(...getChildRoutesRecursively(child, allRoutes));
 });
 }
function getChildRoutesRecursively(route: RouteObject, allRoutes: Set<RouteObject> = new Set()): Set<RouteObject> {
 if (!allRoutes.has(route)) {
 allRoutes.add(route);

 allRoutes.push(route);
 if (route.children && !route.index) {
 route.children.forEach(child => {
 const childRoutes = getChildRoutesRecursively(child, allRoutes);

 childRoutes.forEach(r => allRoutes.add(r));
 });
 }
 }

 return allRoutes;
}
Expand DownExpand Up@@ -510,7 +525,7 @@ export function createV6CompatibleWithSentryReactRouterRouting<P extends Record<
 return Routes;
 }

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

 const SentryRoutes: React.FC<P> = (props: P) => {
 const isMountRenderPass = React.useRef(true);
Expand All@@ -524,18 +539,22 @@ export function createV6CompatibleWithSentryReactRouterRouting<P extends Record<

 if (isMountRenderPass.current) {
 routes.forEach(route => {
 allRoutes.push(...getChildRoutesRecursively(route));
 const extractedChildRoutes = getChildRoutesRecursively(route);

 extractedChildRoutes.forEach(r => {
 allRoutes.add(r);
 });
 });

 updatePageloadTransaction(getActiveRootSpan(), location, routes, undefined, undefined, allRoutes);
 updatePageloadTransaction(getActiveRootSpan(), location, routes, undefined, undefined, Array.from(allRoutes));
 isMountRenderPass.current = false;
 } else {
 handleNavigation({
 location,
 routes,
 navigationType,
 version,
 allRoutes,
 allRoutes: Array.from(allRoutes),
 });
 }
 },
Expand Down
Loading

, '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): Use Set as the allRoutes container.#14878

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

chargome
merged 3 commits into

from

Jan 2, 2025
 Merged


fix(react): Use Set as the allRoutes container.
#14878
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
b925c14

fix(react): Use `Set` as the `allRoutes` container.


onurtemizkan Dec 31, 2024
eb8c9da

Apply suggestions from code review


onurtemizkan Jan 2, 2025
6255033

Fix formatting.


onurtemizkan Jan 2, 2025

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


18 changes: 15 additions & 3 deletions
dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/src/index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import React from 'react';
import ReactDOM from 'react-dom/client';
import {
 BrowserRouter,
 Outlet,
 Route,
 Routes,
 createRoutesFromChildren,
Expand DownExpand Up@@ -48,17 +49,28 @@ const DetailsRoutes = () => (
 </SentryRoutes>
);

const DetailsRoutesAlternative = () => (
 <SentryRoutes>
 <Route path=":detailId" element={<div id="details">Details</div>} />
 </SentryRoutes>
);

const ViewsRoutes = () => (
 <SentryRoutes>
 <Route index element={<div id="views">Views</div>} />
 <Route path="views/:viewId/*" element={<DetailsRoutes />} />
 <Route path="old-views/:viewId/*" element={<DetailsRoutesAlternative />} />
 </SentryRoutes>
);

const ProjectsRoutes = () => (
 <SentryRoutes>
 <Route path="projects/:projectId/*" element={<ViewsRoutes />}></Route>
 <Route path="*" element={<div>No Match Page</div>} />
 <Route path="projects" element={<Outlet />}>
 <Route index element={<div>Project Page Root</div>} />
 <Route path="*" element={<Outlet />}>
 <Route path=":projectId/*" element={<ViewsRoutes />} />
 </Route>
 </Route>
 </SentryRoutes>
);

Expand All@@ -67,7 +79,7 @@ root.render(
 <BrowserRouter>
 <SentryRoutes>
 <Route path="/" element={<Index />} />
 <Route path="/*" element={<ProjectsRoutes />}></Route>
 <Route path="/*" element={<ProjectsRoutes />} />
 </SentryRoutes>
 </BrowserRouter>,
);

3 changes: 3 additions & 0 deletions
...packages/e2e-tests/test-applications/react-router-6-descendant-routes/src/pages/Index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,9 @@ const Index = () => {
 <Link to="/projects/123/views/456/789" id="navigation">
 navigate
 </Link>
 <Link to="/projects/123/old-views/345/654" id="old-navigation">
 navigate old
 </Link>
 </>
 );
};
Expand Down

71 changes: 71 additions & 0 deletions
...s/e2e-tests/test-applications/react-router-6-descendant-routes/tests/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ test('sends a pageload transaction with a parameterized URL', async ({ page }) =

 const rootSpan = await transactionPromise;

 expect((await page.innerHTML('#root')).includes('Details')).toBe(true);
 expect(rootSpan).toMatchObject({
 contexts: {
 trace: {
Expand All@@ -24,6 +25,30 @@ test('sends a pageload transaction with a parameterized URL', async ({ page }) =
 });
});

test('sends a pageload transaction with a parameterized URL - alternative route', async ({ page }) => {
 const transactionPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
 });

 await page.goto(`/projects/234/old-views/234/567`);

 const rootSpan = await transactionPromise;

 expect((await page.innerHTML('#root')).includes('Details')).toBe(true);
 expect(rootSpan).toMatchObject({
 contexts: {
 trace: {
 op: 'pageload',
 origin: 'auto.pageload.react.reactrouter_v6',
 },
 },
 transaction: '/projects/:projectId/old-views/:viewId/:detailId',
 transaction_info: {
 source: 'route',
 },
 });
});

test('sends a navigation transaction with a parameterized URL', async ({ page }) => {
 const pageloadTxnPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
Expand DownExpand Up@@ -52,6 +77,8 @@ test('sends a navigation transaction with a parameterized URL', async ({ page })
 const linkElement = page.locator('id=navigation');

 const [_, navigationTxn] = await Promise.all([linkElement.click(), navigationTxnPromise]);

 expect((await page.innerHTML('#root')).includes('Details')).toBe(true);
 expect(navigationTxn).toMatchObject({
 contexts: {
 trace: {
Expand All@@ -65,3 +92,47 @@ test('sends a navigation transaction with a parameterized URL', async ({ page })
 },
 });
});

test('sends a navigation transaction with a parameterized URL - alternative route', async ({ page }) => {
 const pageloadTxnPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
 });

 const navigationTxnPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'navigation';
 });

 await page.goto(`/`);
 const pageloadTxn = await pageloadTxnPromise;

 expect(pageloadTxn).toMatchObject({
 contexts: {
 trace: {
 op: 'pageload',
 origin: 'auto.pageload.react.reactrouter_v6',
 },
 },
 transaction: '/',
 transaction_info: {
 source: 'route',
 },
 });

 const linkElement = page.locator('id=old-navigation');

 const [_, navigationTxn] = await Promise.all([linkElement.click(), navigationTxnPromise]);

 expect((await page.innerHTML('#root')).includes('Details')).toBe(true);
 expect(navigationTxn).toMatchObject({
 contexts: {
 trace: {
 op: 'navigation',
 origin: 'auto.navigation.react.reactrouter_v6',
 },
 },
 transaction: '/projects/:projectId/old-views/:viewId/:detailId',
 transaction_info: {
 source: 'route',
 },
 });
});

49 changes: 34 additions & 15 deletions
packages/react/src/reactrouterv6-compat-utils.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -179,7 +179,7 @@ export function createV6CompatibleWrapUseRoutes(origUseRoutes: UseRoutes, versio
 return origUseRoutes;
 }

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

 const SentryRoutes: React.FC<{
 children?: React.ReactNode;
Expand All@@ -206,18 +206,29 @@ export function createV6CompatibleWrapUseRoutes(origUseRoutes: UseRoutes, versio

 if (isMountRenderPass.current) {
 routes.forEach(route => {
 allRoutes.push(...getChildRoutesRecursively(route));
 const extractedChildRoutes = getChildRoutesRecursively(route);

 extractedChildRoutes.forEach(r => {
 allRoutes.add(r);
 });
 });

 updatePageloadTransaction(getActiveRootSpan(), normalizedLocation, routes, undefined, undefined, allRoutes);
 updatePageloadTransaction(
 getActiveRootSpan(),
 normalizedLocation,
 routes,
 undefined,
 undefined,
 Array.from(allRoutes),
 );
 isMountRenderPass.current = false;
 } else {
 handleNavigation({
 location: normalizedLocation,
 routes,
 navigationType,
 version,
 allRoutes,
 allRoutes: Array.from(allRoutes),
 });
 }
 }, [navigationType, stableLocationParam]);
Expand DownExpand Up@@ -342,14 +353,18 @@ function locationIsInsideDescendantRoute(location: Location, routes: RouteObject
 return false;
}

function getChildRoutesRecursively(route: RouteObject, allRoutes: RouteObject[] = []): RouteObject[] {
 if (route.children && !route.index) {
 route.children.forEach(child => {
 allRoutes.push(...getChildRoutesRecursively(child, allRoutes));
 });
 }
function getChildRoutesRecursively(route: RouteObject, allRoutes: Set<RouteObject> = new Set()): Set<RouteObject> {
 if (!allRoutes.has(route)) {
 allRoutes.add(route);

 allRoutes.push(route);
 if (route.children && !route.index) {
 route.children.forEach(child => {
 const childRoutes = getChildRoutesRecursively(child, allRoutes);

 childRoutes.forEach(r => allRoutes.add(r));
 });
 }
 }

 return allRoutes;
}
Expand DownExpand Up@@ -510,7 +525,7 @@ export function createV6CompatibleWithSentryReactRouterRouting<P extends Record<
 return Routes;
 }

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

 const SentryRoutes: React.FC<P> = (props: P) => {
 const isMountRenderPass = React.useRef(true);
Expand All@@ -524,18 +539,22 @@ export function createV6CompatibleWithSentryReactRouterRouting<P extends Record<

 if (isMountRenderPass.current) {
 routes.forEach(route => {
 allRoutes.push(...getChildRoutesRecursively(route));
 const extractedChildRoutes = getChildRoutesRecursively(route);

 extractedChildRoutes.forEach(r => {
 allRoutes.add(r);
 });
 });

 updatePageloadTransaction(getActiveRootSpan(), location, routes, undefined, undefined, allRoutes);
 updatePageloadTransaction(getActiveRootSpan(), location, routes, undefined, undefined, Array.from(allRoutes));
 isMountRenderPass.current = false;
 } else {
 handleNavigation({
 location,
 routes,
 navigationType,
 version,
 allRoutes,
 allRoutes: Array.from(allRoutes),
 });
 }
 },
Expand Down
Loading

, '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): Use Set as the allRoutes container.#14878

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

chargome
merged 3 commits into

from

Jan 2, 2025
 Merged


fix(react): Use Set as the allRoutes container.
#14878
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
b925c14

fix(react): Use `Set` as the `allRoutes` container.


onurtemizkan Dec 31, 2024
eb8c9da

Apply suggestions from code review


onurtemizkan Jan 2, 2025
6255033

Fix formatting.


onurtemizkan Jan 2, 2025

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


18 changes: 15 additions & 3 deletions
dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/src/index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import React from 'react';
import ReactDOM from 'react-dom/client';
import {
 BrowserRouter,
 Outlet,
 Route,
 Routes,
 createRoutesFromChildren,
Expand DownExpand Up@@ -48,17 +49,28 @@ const DetailsRoutes = () => (
 </SentryRoutes>
);

const DetailsRoutesAlternative = () => (
 <SentryRoutes>
 <Route path=":detailId" element={<div id="details">Details</div>} />
 </SentryRoutes>
);

const ViewsRoutes = () => (
 <SentryRoutes>
 <Route index element={<div id="views">Views</div>} />
 <Route path="views/:viewId/*" element={<DetailsRoutes />} />
 <Route path="old-views/:viewId/*" element={<DetailsRoutesAlternative />} />
 </SentryRoutes>
);

const ProjectsRoutes = () => (
 <SentryRoutes>
 <Route path="projects/:projectId/*" element={<ViewsRoutes />}></Route>
 <Route path="*" element={<div>No Match Page</div>} />
 <Route path="projects" element={<Outlet />}>
 <Route index element={<div>Project Page Root</div>} />
 <Route path="*" element={<Outlet />}>
 <Route path=":projectId/*" element={<ViewsRoutes />} />
 </Route>
 </Route>
 </SentryRoutes>
);

Expand All@@ -67,7 +79,7 @@ root.render(
 <BrowserRouter>
 <SentryRoutes>
 <Route path="/" element={<Index />} />
 <Route path="/*" element={<ProjectsRoutes />}></Route>
 <Route path="/*" element={<ProjectsRoutes />} />
 </SentryRoutes>
 </BrowserRouter>,
);

3 changes: 3 additions & 0 deletions
...packages/e2e-tests/test-applications/react-router-6-descendant-routes/src/pages/Index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,9 @@ const Index = () => {
 <Link to="/projects/123/views/456/789" id="navigation">
 navigate
 </Link>
 <Link to="/projects/123/old-views/345/654" id="old-navigation">
 navigate old
 </Link>
 </>
 );
};
Expand Down

71 changes: 71 additions & 0 deletions
...s/e2e-tests/test-applications/react-router-6-descendant-routes/tests/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ test('sends a pageload transaction with a parameterized URL', async ({ page }) =

 const rootSpan = await transactionPromise;

 expect((await page.innerHTML('#root')).includes('Details')).toBe(true);
 expect(rootSpan).toMatchObject({
 contexts: {
 trace: {
Expand All@@ -24,6 +25,30 @@ test('sends a pageload transaction with a parameterized URL', async ({ page }) =
 });
});

test('sends a pageload transaction with a parameterized URL - alternative route', async ({ page }) => {
 const transactionPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
 });

 await page.goto(`/projects/234/old-views/234/567`);

 const rootSpan = await transactionPromise;

 expect((await page.innerHTML('#root')).includes('Details')).toBe(true);
 expect(rootSpan).toMatchObject({
 contexts: {
 trace: {
 op: 'pageload',
 origin: 'auto.pageload.react.reactrouter_v6',
 },
 },
 transaction: '/projects/:projectId/old-views/:viewId/:detailId',
 transaction_info: {
 source: 'route',
 },
 });
});

test('sends a navigation transaction with a parameterized URL', async ({ page }) => {
 const pageloadTxnPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
Expand DownExpand Up@@ -52,6 +77,8 @@ test('sends a navigation transaction with a parameterized URL', async ({ page })
 const linkElement = page.locator('id=navigation');

 const [_, navigationTxn] = await Promise.all([linkElement.click(), navigationTxnPromise]);

 expect((await page.innerHTML('#root')).includes('Details')).toBe(true);
 expect(navigationTxn).toMatchObject({
 contexts: {
 trace: {
Expand All@@ -65,3 +92,47 @@ test('sends a navigation transaction with a parameterized URL', async ({ page })
 },
 });
});

test('sends a navigation transaction with a parameterized URL - alternative route', async ({ page }) => {
 const pageloadTxnPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
 });

 const navigationTxnPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'navigation';
 });

 await page.goto(`/`);
 const pageloadTxn = await pageloadTxnPromise;

 expect(pageloadTxn).toMatchObject({
 contexts: {
 trace: {
 op: 'pageload',
 origin: 'auto.pageload.react.reactrouter_v6',
 },
 },
 transaction: '/',
 transaction_info: {
 source: 'route',
 },
 });

 const linkElement = page.locator('id=old-navigation');

 const [_, navigationTxn] = await Promise.all([linkElement.click(), navigationTxnPromise]);

 expect((await page.innerHTML('#root')).includes('Details')).toBe(true);
 expect(navigationTxn).toMatchObject({
 contexts: {
 trace: {
 op: 'navigation',
 origin: 'auto.navigation.react.reactrouter_v6',
 },
 },
 transaction: '/projects/:projectId/old-views/:viewId/:detailId',
 transaction_info: {
 source: 'route',
 },
 });
});

49 changes: 34 additions & 15 deletions
packages/react/src/reactrouterv6-compat-utils.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -179,7 +179,7 @@ export function createV6CompatibleWrapUseRoutes(origUseRoutes: UseRoutes, versio
 return origUseRoutes;
 }

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

 const SentryRoutes: React.FC<{
 children?: React.ReactNode;
Expand All@@ -206,18 +206,29 @@ export function createV6CompatibleWrapUseRoutes(origUseRoutes: UseRoutes, versio

 if (isMountRenderPass.current) {
 routes.forEach(route => {
 allRoutes.push(...getChildRoutesRecursively(route));
 const extractedChildRoutes = getChildRoutesRecursively(route);

 extractedChildRoutes.forEach(r => {
 allRoutes.add(r);
 });
 });

 updatePageloadTransaction(getActiveRootSpan(), normalizedLocation, routes, undefined, undefined, allRoutes);
 updatePageloadTransaction(
 getActiveRootSpan(),
 normalizedLocation,
 routes,
 undefined,
 undefined,
 Array.from(allRoutes),
 );
 isMountRenderPass.current = false;
 } else {
 handleNavigation({
 location: normalizedLocation,
 routes,
 navigationType,
 version,
 allRoutes,
 allRoutes: Array.from(allRoutes),
 });
 }
 }, [navigationType, stableLocationParam]);
Expand DownExpand Up@@ -342,14 +353,18 @@ function locationIsInsideDescendantRoute(location: Location, routes: RouteObject
 return false;
}

function getChildRoutesRecursively(route: RouteObject, allRoutes: RouteObject[] = []): RouteObject[] {
 if (route.children && !route.index) {
 route.children.forEach(child => {
 allRoutes.push(...getChildRoutesRecursively(child, allRoutes));
 });
 }
function getChildRoutesRecursively(route: RouteObject, allRoutes: Set<RouteObject> = new Set()): Set<RouteObject> {
 if (!allRoutes.has(route)) {
 allRoutes.add(route);

 allRoutes.push(route);
 if (route.children && !route.index) {
 route.children.forEach(child => {
 const childRoutes = getChildRoutesRecursively(child, allRoutes);

 childRoutes.forEach(r => allRoutes.add(r));
 });
 }
 }

 return allRoutes;
}
Expand DownExpand Up@@ -510,7 +525,7 @@ export function createV6CompatibleWithSentryReactRouterRouting<P extends Record<
 return Routes;
 }

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

 const SentryRoutes: React.FC<P> = (props: P) => {
 const isMountRenderPass = React.useRef(true);
Expand All@@ -524,18 +539,22 @@ export function createV6CompatibleWithSentryReactRouterRouting<P extends Record<

 if (isMountRenderPass.current) {
 routes.forEach(route => {
 allRoutes.push(...getChildRoutesRecursively(route));
 const extractedChildRoutes = getChildRoutesRecursively(route);

 extractedChildRoutes.forEach(r => {
 allRoutes.add(r);
 });
 });

 updatePageloadTransaction(getActiveRootSpan(), location, routes, undefined, undefined, allRoutes);
 updatePageloadTransaction(getActiveRootSpan(), location, routes, undefined, undefined, Array.from(allRoutes));
 isMountRenderPass.current = false;
 } else {
 handleNavigation({
 location,
 routes,
 navigationType,
 version,
 allRoutes,
 allRoutes: Array.from(allRoutes),
 });
 }
 },
Expand Down
Loading

, '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): Use Set as the allRoutes container.#14878

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

chargome
merged 3 commits into

from

Jan 2, 2025
 Merged


fix(react): Use Set as the allRoutes container.
#14878
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
b925c14

fix(react): Use `Set` as the `allRoutes` container.


onurtemizkan Dec 31, 2024
eb8c9da

Apply suggestions from code review


onurtemizkan Jan 2, 2025
6255033

Fix formatting.


onurtemizkan Jan 2, 2025

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


18 changes: 15 additions & 3 deletions
dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/src/index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import React from 'react';
import ReactDOM from 'react-dom/client';
import {
 BrowserRouter,
 Outlet,
 Route,
 Routes,
 createRoutesFromChildren,
Expand DownExpand Up@@ -48,17 +49,28 @@ const DetailsRoutes = () => (
 </SentryRoutes>
);

const DetailsRoutesAlternative = () => (
 <SentryRoutes>
 <Route path=":detailId" element={<div id="details">Details</div>} />
 </SentryRoutes>
);

const ViewsRoutes = () => (
 <SentryRoutes>
 <Route index element={<div id="views">Views</div>} />
 <Route path="views/:viewId/*" element={<DetailsRoutes />} />
 <Route path="old-views/:viewId/*" element={<DetailsRoutesAlternative />} />
 </SentryRoutes>
);

const ProjectsRoutes = () => (
 <SentryRoutes>
 <Route path="projects/:projectId/*" element={<ViewsRoutes />}></Route>
 <Route path="*" element={<div>No Match Page</div>} />
 <Route path="projects" element={<Outlet />}>
 <Route index element={<div>Project Page Root</div>} />
 <Route path="*" element={<Outlet />}>
 <Route path=":projectId/*" element={<ViewsRoutes />} />
 </Route>
 </Route>
 </SentryRoutes>
);

Expand All@@ -67,7 +79,7 @@ root.render(
 <BrowserRouter>
 <SentryRoutes>
 <Route path="/" element={<Index />} />
 <Route path="/*" element={<ProjectsRoutes />}></Route>
 <Route path="/*" element={<ProjectsRoutes />} />
 </SentryRoutes>
 </BrowserRouter>,
);

3 changes: 3 additions & 0 deletions
...packages/e2e-tests/test-applications/react-router-6-descendant-routes/src/pages/Index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,9 @@ const Index = () => {
 <Link to="/projects/123/views/456/789" id="navigation">
 navigate
 </Link>
 <Link to="/projects/123/old-views/345/654" id="old-navigation">
 navigate old
 </Link>
 </>
 );
};
Expand Down

71 changes: 71 additions & 0 deletions
...s/e2e-tests/test-applications/react-router-6-descendant-routes/tests/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ test('sends a pageload transaction with a parameterized URL', async ({ page }) =

 const rootSpan = await transactionPromise;

 expect((await page.innerHTML('#root')).includes('Details')).toBe(true);
 expect(rootSpan).toMatchObject({
 contexts: {
 trace: {
Expand All@@ -24,6 +25,30 @@ test('sends a pageload transaction with a parameterized URL', async ({ page }) =
 });
});

test('sends a pageload transaction with a parameterized URL - alternative route', async ({ page }) => {
 const transactionPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
 });

 await page.goto(`/projects/234/old-views/234/567`);

 const rootSpan = await transactionPromise;

 expect((await page.innerHTML('#root')).includes('Details')).toBe(true);
 expect(rootSpan).toMatchObject({
 contexts: {
 trace: {
 op: 'pageload',
 origin: 'auto.pageload.react.reactrouter_v6',
 },
 },
 transaction: '/projects/:projectId/old-views/:viewId/:detailId',
 transaction_info: {
 source: 'route',
 },
 });
});

test('sends a navigation transaction with a parameterized URL', async ({ page }) => {
 const pageloadTxnPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
Expand DownExpand Up@@ -52,6 +77,8 @@ test('sends a navigation transaction with a parameterized URL', async ({ page })
 const linkElement = page.locator('id=navigation');

 const [_, navigationTxn] = await Promise.all([linkElement.click(), navigationTxnPromise]);

 expect((await page.innerHTML('#root')).includes('Details')).toBe(true);
 expect(navigationTxn).toMatchObject({
 contexts: {
 trace: {
Expand All@@ -65,3 +92,47 @@ test('sends a navigation transaction with a parameterized URL', async ({ page })
 },
 });
});

test('sends a navigation transaction with a parameterized URL - alternative route', async ({ page }) => {
 const pageloadTxnPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
 });

 const navigationTxnPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'navigation';
 });

 await page.goto(`/`);
 const pageloadTxn = await pageloadTxnPromise;

 expect(pageloadTxn).toMatchObject({
 contexts: {
 trace: {
 op: 'pageload',
 origin: 'auto.pageload.react.reactrouter_v6',
 },
 },
 transaction: '/',
 transaction_info: {
 source: 'route',
 },
 });

 const linkElement = page.locator('id=old-navigation');

 const [_, navigationTxn] = await Promise.all([linkElement.click(), navigationTxnPromise]);

 expect((await page.innerHTML('#root')).includes('Details')).toBe(true);
 expect(navigationTxn).toMatchObject({
 contexts: {
 trace: {
 op: 'navigation',
 origin: 'auto.navigation.react.reactrouter_v6',
 },
 },
 transaction: '/projects/:projectId/old-views/:viewId/:detailId',
 transaction_info: {
 source: 'route',
 },
 });
});

49 changes: 34 additions & 15 deletions
packages/react/src/reactrouterv6-compat-utils.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -179,7 +179,7 @@ export function createV6CompatibleWrapUseRoutes(origUseRoutes: UseRoutes, versio
 return origUseRoutes;
 }

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

 const SentryRoutes: React.FC<{
 children?: React.ReactNode;
Expand All@@ -206,18 +206,29 @@ export function createV6CompatibleWrapUseRoutes(origUseRoutes: UseRoutes, versio

 if (isMountRenderPass.current) {
 routes.forEach(route => {
 allRoutes.push(...getChildRoutesRecursively(route));
 const extractedChildRoutes = getChildRoutesRecursively(route);

 extractedChildRoutes.forEach(r => {
 allRoutes.add(r);
 });
 });

 updatePageloadTransaction(getActiveRootSpan(), normalizedLocation, routes, undefined, undefined, allRoutes);
 updatePageloadTransaction(
 getActiveRootSpan(),
 normalizedLocation,
 routes,
 undefined,
 undefined,
 Array.from(allRoutes),
 );
 isMountRenderPass.current = false;
 } else {
 handleNavigation({
 location: normalizedLocation,
 routes,
 navigationType,
 version,
 allRoutes,
 allRoutes: Array.from(allRoutes),
 });
 }
 }, [navigationType, stableLocationParam]);
Expand DownExpand Up@@ -342,14 +353,18 @@ function locationIsInsideDescendantRoute(location: Location, routes: RouteObject
 return false;
}

function getChildRoutesRecursively(route: RouteObject, allRoutes: RouteObject[] = []): RouteObject[] {
 if (route.children && !route.index) {
 route.children.forEach(child => {
 allRoutes.push(...getChildRoutesRecursively(child, allRoutes));
 });
 }
function getChildRoutesRecursively(route: RouteObject, allRoutes: Set<RouteObject> = new Set()): Set<RouteObject> {
 if (!allRoutes.has(route)) {
 allRoutes.add(route);

 allRoutes.push(route);
 if (route.children && !route.index) {
 route.children.forEach(child => {
 const childRoutes = getChildRoutesRecursively(child, allRoutes);

 childRoutes.forEach(r => allRoutes.add(r));
 });
 }
 }

 return allRoutes;
}
Expand DownExpand Up@@ -510,7 +525,7 @@ export function createV6CompatibleWithSentryReactRouterRouting<P extends Record<
 return Routes;
 }

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

 const SentryRoutes: React.FC<P> = (props: P) => {
 const isMountRenderPass = React.useRef(true);
Expand All@@ -524,18 +539,22 @@ export function createV6CompatibleWithSentryReactRouterRouting<P extends Record<

 if (isMountRenderPass.current) {
 routes.forEach(route => {
 allRoutes.push(...getChildRoutesRecursively(route));
 const extractedChildRoutes = getChildRoutesRecursively(route);

 extractedChildRoutes.forEach(r => {
 allRoutes.add(r);
 });
 });

 updatePageloadTransaction(getActiveRootSpan(), location, routes, undefined, undefined, allRoutes);
 updatePageloadTransaction(getActiveRootSpan(), location, routes, undefined, undefined, Array.from(allRoutes));
 isMountRenderPass.current = false;
 } else {
 handleNavigation({
 location,
 routes,
 navigationType,
 version,
 allRoutes,
 allRoutes: Array.from(allRoutes),
 });
 }
 },
Expand Down
Loading

, '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): Use Set as the allRoutes container.#14878

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

chargome
merged 3 commits into

from

Jan 2, 2025
 Merged


fix(react): Use Set as the allRoutes container.
#14878
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
b925c14

fix(react): Use `Set` as the `allRoutes` container.


onurtemizkan Dec 31, 2024
eb8c9da

Apply suggestions from code review


onurtemizkan Jan 2, 2025
6255033

Fix formatting.


onurtemizkan Jan 2, 2025

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


18 changes: 15 additions & 3 deletions
dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/src/index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import React from 'react';
import ReactDOM from 'react-dom/client';
import {
 BrowserRouter,
 Outlet,
 Route,
 Routes,
 createRoutesFromChildren,
Expand DownExpand Up@@ -48,17 +49,28 @@ const DetailsRoutes = () => (
 </SentryRoutes>
);

const DetailsRoutesAlternative = () => (
 <SentryRoutes>
 <Route path=":detailId" element={<div id="details">Details</div>} />
 </SentryRoutes>
);

const ViewsRoutes = () => (
 <SentryRoutes>
 <Route index element={<div id="views">Views</div>} />
 <Route path="views/:viewId/*" element={<DetailsRoutes />} />
 <Route path="old-views/:viewId/*" element={<DetailsRoutesAlternative />} />
 </SentryRoutes>
);

const ProjectsRoutes = () => (
 <SentryRoutes>
 <Route path="projects/:projectId/*" element={<ViewsRoutes />}></Route>
 <Route path="*" element={<div>No Match Page</div>} />
 <Route path="projects" element={<Outlet />}>
 <Route index element={<div>Project Page Root</div>} />
 <Route path="*" element={<Outlet />}>
 <Route path=":projectId/*" element={<ViewsRoutes />} />
 </Route>
 </Route>
 </SentryRoutes>
);

Expand All@@ -67,7 +79,7 @@ root.render(
 <BrowserRouter>
 <SentryRoutes>
 <Route path="/" element={<Index />} />
 <Route path="/*" element={<ProjectsRoutes />}></Route>
 <Route path="/*" element={<ProjectsRoutes />} />
 </SentryRoutes>
 </BrowserRouter>,
);

3 changes: 3 additions & 0 deletions
...packages/e2e-tests/test-applications/react-router-6-descendant-routes/src/pages/Index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,9 @@ const Index = () => {
 <Link to="/projects/123/views/456/789" id="navigation">
 navigate
 </Link>
 <Link to="/projects/123/old-views/345/654" id="old-navigation">
 navigate old
 </Link>
 </>
 );
};
Expand Down

71 changes: 71 additions & 0 deletions
...s/e2e-tests/test-applications/react-router-6-descendant-routes/tests/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ test('sends a pageload transaction with a parameterized URL', async ({ page }) =

 const rootSpan = await transactionPromise;

 expect((await page.innerHTML('#root')).includes('Details')).toBe(true);
 expect(rootSpan).toMatchObject({
 contexts: {
 trace: {
Expand All@@ -24,6 +25,30 @@ test('sends a pageload transaction with a parameterized URL', async ({ page }) =
 });
});

test('sends a pageload transaction with a parameterized URL - alternative route', async ({ page }) => {
 const transactionPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
 });

 await page.goto(`/projects/234/old-views/234/567`);

 const rootSpan = await transactionPromise;

 expect((await page.innerHTML('#root')).includes('Details')).toBe(true);
 expect(rootSpan).toMatchObject({
 contexts: {
 trace: {
 op: 'pageload',
 origin: 'auto.pageload.react.reactrouter_v6',
 },
 },
 transaction: '/projects/:projectId/old-views/:viewId/:detailId',
 transaction_info: {
 source: 'route',
 },
 });
});

test('sends a navigation transaction with a parameterized URL', async ({ page }) => {
 const pageloadTxnPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
Expand DownExpand Up@@ -52,6 +77,8 @@ test('sends a navigation transaction with a parameterized URL', async ({ page })
 const linkElement = page.locator('id=navigation');

 const [_, navigationTxn] = await Promise.all([linkElement.click(), navigationTxnPromise]);

 expect((await page.innerHTML('#root')).includes('Details')).toBe(true);
 expect(navigationTxn).toMatchObject({
 contexts: {
 trace: {
Expand All@@ -65,3 +92,47 @@ test('sends a navigation transaction with a parameterized URL', async ({ page })
 },
 });
});

test('sends a navigation transaction with a parameterized URL - alternative route', async ({ page }) => {
 const pageloadTxnPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
 });

 const navigationTxnPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'navigation';
 });

 await page.goto(`/`);
 const pageloadTxn = await pageloadTxnPromise;

 expect(pageloadTxn).toMatchObject({
 contexts: {
 trace: {
 op: 'pageload',
 origin: 'auto.pageload.react.reactrouter_v6',
 },
 },
 transaction: '/',
 transaction_info: {
 source: 'route',
 },
 });

 const linkElement = page.locator('id=old-navigation');

 const [_, navigationTxn] = await Promise.all([linkElement.click(), navigationTxnPromise]);

 expect((await page.innerHTML('#root')).includes('Details')).toBe(true);
 expect(navigationTxn).toMatchObject({
 contexts: {
 trace: {
 op: 'navigation',
 origin: 'auto.navigation.react.reactrouter_v6',
 },
 },
 transaction: '/projects/:projectId/old-views/:viewId/:detailId',
 transaction_info: {
 source: 'route',
 },
 });
});

49 changes: 34 additions & 15 deletions
packages/react/src/reactrouterv6-compat-utils.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -179,7 +179,7 @@ export function createV6CompatibleWrapUseRoutes(origUseRoutes: UseRoutes, versio
 return origUseRoutes;
 }

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

 const SentryRoutes: React.FC<{
 children?: React.ReactNode;
Expand All@@ -206,18 +206,29 @@ export function createV6CompatibleWrapUseRoutes(origUseRoutes: UseRoutes, versio

 if (isMountRenderPass.current) {
 routes.forEach(route => {
 allRoutes.push(...getChildRoutesRecursively(route));
 const extractedChildRoutes = getChildRoutesRecursively(route);

 extractedChildRoutes.forEach(r => {
 allRoutes.add(r);
 });
 });

 updatePageloadTransaction(getActiveRootSpan(), normalizedLocation, routes, undefined, undefined, allRoutes);
 updatePageloadTransaction(
 getActiveRootSpan(),
 normalizedLocation,
 routes,
 undefined,
 undefined,
 Array.from(allRoutes),
 );
 isMountRenderPass.current = false;
 } else {
 handleNavigation({
 location: normalizedLocation,
 routes,
 navigationType,
 version,
 allRoutes,
 allRoutes: Array.from(allRoutes),
 });
 }
 }, [navigationType, stableLocationParam]);
Expand DownExpand Up@@ -342,14 +353,18 @@ function locationIsInsideDescendantRoute(location: Location, routes: RouteObject
 return false;
}

function getChildRoutesRecursively(route: RouteObject, allRoutes: RouteObject[] = []): RouteObject[] {
 if (route.children && !route.index) {
 route.children.forEach(child => {
 allRoutes.push(...getChildRoutesRecursively(child, allRoutes));
 });
 }
function getChildRoutesRecursively(route: RouteObject, allRoutes: Set<RouteObject> = new Set()): Set<RouteObject> {
 if (!allRoutes.has(route)) {
 allRoutes.add(route);

 allRoutes.push(route);
 if (route.children && !route.index) {
 route.children.forEach(child => {
 const childRoutes = getChildRoutesRecursively(child, allRoutes);

 childRoutes.forEach(r => allRoutes.add(r));
 });
 }
 }

 return allRoutes;
}
Expand DownExpand Up@@ -510,7 +525,7 @@ export function createV6CompatibleWithSentryReactRouterRouting<P extends Record<
 return Routes;
 }

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

 const SentryRoutes: React.FC<P> = (props: P) => {
 const isMountRenderPass = React.useRef(true);
Expand All@@ -524,18 +539,22 @@ export function createV6CompatibleWithSentryReactRouterRouting<P extends Record<

 if (isMountRenderPass.current) {
 routes.forEach(route => {
 allRoutes.push(...getChildRoutesRecursively(route));
 const extractedChildRoutes = getChildRoutesRecursively(route);

 extractedChildRoutes.forEach(r => {
 allRoutes.add(r);
 });
 });

 updatePageloadTransaction(getActiveRootSpan(), location, routes, undefined, undefined, allRoutes);
 updatePageloadTransaction(getActiveRootSpan(), location, routes, undefined, undefined, Array.from(allRoutes));
 isMountRenderPass.current = false;
 } else {
 handleNavigation({
 location,
 routes,
 navigationType,
 version,
 allRoutes,
 allRoutes: Array.from(allRoutes),
 });
 }
 },
Expand Down
Loading

, '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): Use Set as the allRoutes container.#14878

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

chargome
merged 3 commits into

from

Jan 2, 2025
 Merged


fix(react): Use Set as the allRoutes container.
#14878
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
b925c14

fix(react): Use `Set` as the `allRoutes` container.


onurtemizkan Dec 31, 2024
eb8c9da

Apply suggestions from code review


onurtemizkan Jan 2, 2025
6255033

Fix formatting.


onurtemizkan Jan 2, 2025

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


18 changes: 15 additions & 3 deletions
dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/src/index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import React from 'react';
import ReactDOM from 'react-dom/client';
import {
 BrowserRouter,
 Outlet,
 Route,
 Routes,
 createRoutesFromChildren,
Expand DownExpand Up@@ -48,17 +49,28 @@ const DetailsRoutes = () => (
 </SentryRoutes>
);

const DetailsRoutesAlternative = () => (
 <SentryRoutes>
 <Route path=":detailId" element={<div id="details">Details</div>} />
 </SentryRoutes>
);

const ViewsRoutes = () => (
 <SentryRoutes>
 <Route index element={<div id="views">Views</div>} />
 <Route path="views/:viewId/*" element={<DetailsRoutes />} />
 <Route path="old-views/:viewId/*" element={<DetailsRoutesAlternative />} />
 </SentryRoutes>
);

const ProjectsRoutes = () => (
 <SentryRoutes>
 <Route path="projects/:projectId/*" element={<ViewsRoutes />}></Route>
 <Route path="*" element={<div>No Match Page</div>} />
 <Route path="projects" element={<Outlet />}>
 <Route index element={<div>Project Page Root</div>} />
 <Route path="*" element={<Outlet />}>
 <Route path=":projectId/*" element={<ViewsRoutes />} />
 </Route>
 </Route>
 </SentryRoutes>
);

Expand All@@ -67,7 +79,7 @@ root.render(
 <BrowserRouter>
 <SentryRoutes>
 <Route path="/" element={<Index />} />
 <Route path="/*" element={<ProjectsRoutes />}></Route>
 <Route path="/*" element={<ProjectsRoutes />} />
 </SentryRoutes>
 </BrowserRouter>,
);

3 changes: 3 additions & 0 deletions
...packages/e2e-tests/test-applications/react-router-6-descendant-routes/src/pages/Index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,9 @@ const Index = () => {
 <Link to="/projects/123/views/456/789" id="navigation">
 navigate
 </Link>
 <Link to="/projects/123/old-views/345/654" id="old-navigation">
 navigate old
 </Link>
 </>
 );
};
Expand Down

71 changes: 71 additions & 0 deletions
...s/e2e-tests/test-applications/react-router-6-descendant-routes/tests/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ test('sends a pageload transaction with a parameterized URL', async ({ page }) =

 const rootSpan = await transactionPromise;

 expect((await page.innerHTML('#root')).includes('Details')).toBe(true);
 expect(rootSpan).toMatchObject({
 contexts: {
 trace: {
Expand All@@ -24,6 +25,30 @@ test('sends a pageload transaction with a parameterized URL', async ({ page }) =
 });
});

test('sends a pageload transaction with a parameterized URL - alternative route', async ({ page }) => {
 const transactionPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
 });

 await page.goto(`/projects/234/old-views/234/567`);

 const rootSpan = await transactionPromise;

 expect((await page.innerHTML('#root')).includes('Details')).toBe(true);
 expect(rootSpan).toMatchObject({
 contexts: {
 trace: {
 op: 'pageload',
 origin: 'auto.pageload.react.reactrouter_v6',
 },
 },
 transaction: '/projects/:projectId/old-views/:viewId/:detailId',
 transaction_info: {
 source: 'route',
 },
 });
});

test('sends a navigation transaction with a parameterized URL', async ({ page }) => {
 const pageloadTxnPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
Expand DownExpand Up@@ -52,6 +77,8 @@ test('sends a navigation transaction with a parameterized URL', async ({ page })
 const linkElement = page.locator('id=navigation');

 const [_, navigationTxn] = await Promise.all([linkElement.click(), navigationTxnPromise]);

 expect((await page.innerHTML('#root')).includes('Details')).toBe(true);
 expect(navigationTxn).toMatchObject({
 contexts: {
 trace: {
Expand All@@ -65,3 +92,47 @@ test('sends a navigation transaction with a parameterized URL', async ({ page })
 },
 });
});

test('sends a navigation transaction with a parameterized URL - alternative route', async ({ page }) => {
 const pageloadTxnPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
 });

 const navigationTxnPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'navigation';
 });

 await page.goto(`/`);
 const pageloadTxn = await pageloadTxnPromise;

 expect(pageloadTxn).toMatchObject({
 contexts: {
 trace: {
 op: 'pageload',
 origin: 'auto.pageload.react.reactrouter_v6',
 },
 },
 transaction: '/',
 transaction_info: {
 source: 'route',
 },
 });

 const linkElement = page.locator('id=old-navigation');

 const [_, navigationTxn] = await Promise.all([linkElement.click(), navigationTxnPromise]);

 expect((await page.innerHTML('#root')).includes('Details')).toBe(true);
 expect(navigationTxn).toMatchObject({
 contexts: {
 trace: {
 op: 'navigation',
 origin: 'auto.navigation.react.reactrouter_v6',
 },
 },
 transaction: '/projects/:projectId/old-views/:viewId/:detailId',
 transaction_info: {
 source: 'route',
 },
 });
});

49 changes: 34 additions & 15 deletions
packages/react/src/reactrouterv6-compat-utils.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -179,7 +179,7 @@ export function createV6CompatibleWrapUseRoutes(origUseRoutes: UseRoutes, versio
 return origUseRoutes;
 }

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

 const SentryRoutes: React.FC<{
 children?: React.ReactNode;
Expand All@@ -206,18 +206,29 @@ export function createV6CompatibleWrapUseRoutes(origUseRoutes: UseRoutes, versio

 if (isMountRenderPass.current) {
 routes.forEach(route => {
 allRoutes.push(...getChildRoutesRecursively(route));
 const extractedChildRoutes = getChildRoutesRecursively(route);

 extractedChildRoutes.forEach(r => {
 allRoutes.add(r);
 });
 });

 updatePageloadTransaction(getActiveRootSpan(), normalizedLocation, routes, undefined, undefined, allRoutes);
 updatePageloadTransaction(
 getActiveRootSpan(),
 normalizedLocation,
 routes,
 undefined,
 undefined,
 Array.from(allRoutes),
 );
 isMountRenderPass.current = false;
 } else {
 handleNavigation({
 location: normalizedLocation,
 routes,
 navigationType,
 version,
 allRoutes,
 allRoutes: Array.from(allRoutes),
 });
 }
 }, [navigationType, stableLocationParam]);
Expand DownExpand Up@@ -342,14 +353,18 @@ function locationIsInsideDescendantRoute(location: Location, routes: RouteObject
 return false;
}

function getChildRoutesRecursively(route: RouteObject, allRoutes: RouteObject[] = []): RouteObject[] {
 if (route.children && !route.index) {
 route.children.forEach(child => {
 allRoutes.push(...getChildRoutesRecursively(child, allRoutes));
 });
 }
function getChildRoutesRecursively(route: RouteObject, allRoutes: Set<RouteObject> = new Set()): Set<RouteObject> {
 if (!allRoutes.has(route)) {
 allRoutes.add(route);

 allRoutes.push(route);
 if (route.children && !route.index) {
 route.children.forEach(child => {
 const childRoutes = getChildRoutesRecursively(child, allRoutes);

 childRoutes.forEach(r => allRoutes.add(r));
 });
 }
 }

 return allRoutes;
}
Expand DownExpand Up@@ -510,7 +525,7 @@ export function createV6CompatibleWithSentryReactRouterRouting<P extends Record<
 return Routes;
 }

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

 const SentryRoutes: React.FC<P> = (props: P) => {
 const isMountRenderPass = React.useRef(true);
Expand All@@ -524,18 +539,22 @@ export function createV6CompatibleWithSentryReactRouterRouting<P extends Record<

 if (isMountRenderPass.current) {
 routes.forEach(route => {
 allRoutes.push(...getChildRoutesRecursively(route));
 const extractedChildRoutes = getChildRoutesRecursively(route);

 extractedChildRoutes.forEach(r => {
 allRoutes.add(r);
 });
 });

 updatePageloadTransaction(getActiveRootSpan(), location, routes, undefined, undefined, allRoutes);
 updatePageloadTransaction(getActiveRootSpan(), location, routes, undefined, undefined, Array.from(allRoutes));
 isMountRenderPass.current = false;
 } else {
 handleNavigation({
 location,
 routes,
 navigationType,
 version,
 allRoutes,
 allRoutes: Array.from(allRoutes),
 });
 }
 },
Expand Down
Loading

, '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): Use Set as the allRoutes container.#14878

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

chargome
merged 3 commits into

from

Jan 2, 2025
 Merged


fix(react): Use Set as the allRoutes container.
#14878
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
b925c14

fix(react): Use `Set` as the `allRoutes` container.


onurtemizkan Dec 31, 2024
eb8c9da

Apply suggestions from code review


onurtemizkan Jan 2, 2025
6255033

Fix formatting.


onurtemizkan Jan 2, 2025

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


18 changes: 15 additions & 3 deletions
dev-packages/e2e-tests/test-applications/react-router-6-descendant-routes/src/index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@ import React from 'react';
import ReactDOM from 'react-dom/client';
import {
 BrowserRouter,
 Outlet,
 Route,
 Routes,
 createRoutesFromChildren,
Expand DownExpand Up@@ -48,17 +49,28 @@ const DetailsRoutes = () => (
 </SentryRoutes>
);

const DetailsRoutesAlternative = () => (
 <SentryRoutes>
 <Route path=":detailId" element={<div id="details">Details</div>} />
 </SentryRoutes>
);

const ViewsRoutes = () => (
 <SentryRoutes>
 <Route index element={<div id="views">Views</div>} />
 <Route path="views/:viewId/*" element={<DetailsRoutes />} />
 <Route path="old-views/:viewId/*" element={<DetailsRoutesAlternative />} />
 </SentryRoutes>
);

const ProjectsRoutes = () => (
 <SentryRoutes>
 <Route path="projects/:projectId/*" element={<ViewsRoutes />}></Route>
 <Route path="*" element={<div>No Match Page</div>} />
 <Route path="projects" element={<Outlet />}>
 <Route index element={<div>Project Page Root</div>} />
 <Route path="*" element={<Outlet />}>
 <Route path=":projectId/*" element={<ViewsRoutes />} />
 </Route>
 </Route>
 </SentryRoutes>
);

Expand All@@ -67,7 +79,7 @@ root.render(
 <BrowserRouter>
 <SentryRoutes>
 <Route path="/" element={<Index />} />
 <Route path="/*" element={<ProjectsRoutes />}></Route>
 <Route path="/*" element={<ProjectsRoutes />} />
 </SentryRoutes>
 </BrowserRouter>,
);

3 changes: 3 additions & 0 deletions
...packages/e2e-tests/test-applications/react-router-6-descendant-routes/src/pages/Index.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,9 @@ const Index = () => {
 <Link to="/projects/123/views/456/789" id="navigation">
 navigate
 </Link>
 <Link to="/projects/123/old-views/345/654" id="old-navigation">
 navigate old
 </Link>
 </>
 );
};
Expand Down

71 changes: 71 additions & 0 deletions
...s/e2e-tests/test-applications/react-router-6-descendant-routes/tests/transactions.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,7 @@ test('sends a pageload transaction with a parameterized URL', async ({ page }) =

 const rootSpan = await transactionPromise;

 expect((await page.innerHTML('#root')).includes('Details')).toBe(true);
 expect(rootSpan).toMatchObject({
 contexts: {
 trace: {
Expand All@@ -24,6 +25,30 @@ test('sends a pageload transaction with a parameterized URL', async ({ page }) =
 });
});

test('sends a pageload transaction with a parameterized URL - alternative route', async ({ page }) => {
 const transactionPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
 });

 await page.goto(`/projects/234/old-views/234/567`);

 const rootSpan = await transactionPromise;

 expect((await page.innerHTML('#root')).includes('Details')).toBe(true);
 expect(rootSpan).toMatchObject({
 contexts: {
 trace: {
 op: 'pageload',
 origin: 'auto.pageload.react.reactrouter_v6',
 },
 },
 transaction: '/projects/:projectId/old-views/:viewId/:detailId',
 transaction_info: {
 source: 'route',
 },
 });
});

test('sends a navigation transaction with a parameterized URL', async ({ page }) => {
 const pageloadTxnPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
Expand DownExpand Up@@ -52,6 +77,8 @@ test('sends a navigation transaction with a parameterized URL', async ({ page })
 const linkElement = page.locator('id=navigation');

 const [_, navigationTxn] = await Promise.all([linkElement.click(), navigationTxnPromise]);

 expect((await page.innerHTML('#root')).includes('Details')).toBe(true);
 expect(navigationTxn).toMatchObject({
 contexts: {
 trace: {
Expand All@@ -65,3 +92,47 @@ test('sends a navigation transaction with a parameterized URL', async ({ page })
 },
 });
});

test('sends a navigation transaction with a parameterized URL - alternative route', async ({ page }) => {
 const pageloadTxnPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'pageload';
 });

 const navigationTxnPromise = waitForTransaction('react-router-6-descendant-routes', async transactionEvent => {
 return !!transactionEvent?.transaction && transactionEvent.contexts?.trace?.op === 'navigation';
 });

 await page.goto(`/`);
 const pageloadTxn = await pageloadTxnPromise;

 expect(pageloadTxn).toMatchObject({
 contexts: {
 trace: {
 op: 'pageload',
 origin: 'auto.pageload.react.reactrouter_v6',
 },
 },
 transaction: '/',
 transaction_info: {
 source: 'route',
 },
 });

 const linkElement = page.locator('id=old-navigation');

 const [_, navigationTxn] = await Promise.all([linkElement.click(), navigationTxnPromise]);

 expect((await page.innerHTML('#root')).includes('Details')).toBe(true);
 expect(navigationTxn).toMatchObject({
 contexts: {
 trace: {
 op: 'navigation',
 origin: 'auto.navigation.react.reactrouter_v6',
 },
 },
 transaction: '/projects/:projectId/old-views/:viewId/:detailId',
 transaction_info: {
 source: 'route',
 },
 });
});

49 changes: 34 additions & 15 deletions
packages/react/src/reactrouterv6-compat-utils.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -179,7 +179,7 @@ export function createV6CompatibleWrapUseRoutes(origUseRoutes: UseRoutes, versio
 return origUseRoutes;
 }

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

 const SentryRoutes: React.FC<{
 children?: React.ReactNode;
Expand All@@ -206,18 +206,29 @@ export function createV6CompatibleWrapUseRoutes(origUseRoutes: UseRoutes, versio

 if (isMountRenderPass.current) {
 routes.forEach(route => {
 allRoutes.push(...getChildRoutesRecursively(route));
 const extractedChildRoutes = getChildRoutesRecursively(route);

 extractedChildRoutes.forEach(r => {
 allRoutes.add(r);
 });
 });

 updatePageloadTransaction(getActiveRootSpan(), normalizedLocation, routes, undefined, undefined, allRoutes);
 updatePageloadTransaction(
 getActiveRootSpan(),
 normalizedLocation,
 routes,
 undefined,
 undefined,
 Array.from(allRoutes),
 );
 isMountRenderPass.current = false;
 } else {
 handleNavigation({
 location: normalizedLocation,
 routes,
 navigationType,
 version,
 allRoutes,
 allRoutes: Array.from(allRoutes),
 });
 }
 }, [navigationType, stableLocationParam]);
Expand DownExpand Up@@ -342,14 +353,18 @@ function locationIsInsideDescendantRoute(location: Location, routes: RouteObject
 return false;
}

function getChildRoutesRecursively(route: RouteObject, allRoutes: RouteObject[] = []): RouteObject[] {
 if (route.children && !route.index) {
 route.children.forEach(child => {
 allRoutes.push(...getChildRoutesRecursively(child, allRoutes));
 });
 }
function getChildRoutesRecursively(route: RouteObject, allRoutes: Set<RouteObject> = new Set()): Set<RouteObject> {
 if (!allRoutes.has(route)) {
 allRoutes.add(route);

 allRoutes.push(route);
 if (route.children && !route.index) {
 route.children.forEach(child => {
 const childRoutes = getChildRoutesRecursively(child, allRoutes);

 childRoutes.forEach(r => allRoutes.add(r));
 });
 }
 }

 return allRoutes;
}
Expand DownExpand Up@@ -510,7 +525,7 @@ export function createV6CompatibleWithSentryReactRouterRouting<P extends Record<
 return Routes;
 }

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

 const SentryRoutes: React.FC<P> = (props: P) => {
 const isMountRenderPass = React.useRef(true);
Expand All@@ -524,18 +539,22 @@ export function createV6CompatibleWithSentryReactRouterRouting<P extends Record<

 if (isMountRenderPass.current) {
 routes.forEach(route => {
 allRoutes.push(...getChildRoutesRecursively(route));
 const extractedChildRoutes = getChildRoutesRecursively(route);

 extractedChildRoutes.forEach(r => {
 allRoutes.add(r);
 });
 });

 updatePageloadTransaction(getActiveRootSpan(), location, routes, undefined, undefined, allRoutes);
 updatePageloadTransaction(getActiveRootSpan(), location, routes, undefined, undefined, Array.from(allRoutes));
 isMountRenderPass.current = false;
 } else {
 handleNavigation({
 location,
 routes,
 navigationType,
 version,
 allRoutes,
 allRoutes: Array.from(allRoutes),
 });
 }
 },
Expand Down
Loading