Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,12 @@ const router = sentryCreateBrowserRouter(
lazyChildren: () => import('./pages/AnotherLazyRoutes').then(module => module.anotherNestedRoutes),
},
},
{
path: '/long-running',
handle: {
lazyChildren: () => import('./pages/LongRunningLazyRoutes').then(module => module.longRunningNestedRoutes),
},
},
{
path: '/static',
element: <>Hello World</>,
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,10 @@ const Index = () => {
<Link to="/another-lazy/sub/555/666" id="navigation-to-another-deep">
Navigate to Another Deep Lazy Route
</Link>
<br />
<Link to="/long-running/slow/12345" id="navigation-to-long-running">
Navigate to Long Running Lazy Route
</Link>
</>
);
};
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
import React, { useEffect, useState } from 'react';
import { Link, useParams } from 'react-router-dom';

// Component that simulates a long-running component load
// This is used to test the POP guard during long-running pageloads
const SlowLoadingComponent = () => {
const { id } = useParams<{ id: string }>();
const [data, setData] = useState<string | null>(null);
const [isLoading, setIsLoading] = useState(true);

useEffect(() => {
// Simulate a component that takes time to initialize
// This extends the pageload duration to create a window where POP events might occur
setTimeout(() => {
setData(`Data loaded for ID: ${id}`);
setIsLoading(false);
}, 1000);
}, [id]);

if (isLoading) {
return <div id="loading-indicator">Loading...</div>;
}

return (
<div id="slow-loading-content">
<div>{data}</div>
<Link to="/" id="navigate-home">
Go Home
</Link>
</div>
);
};

export const longRunningNestedRoutes = [
{
path: 'slow',
children: [
{
path: ':id',
element: <SlowLoadingComponent />,
loader: async () => {
// Simulate slow data fetching in the loader
await new Promise(resolve => setTimeout(resolve, 2000));
return null;
},
},
],
},
];
Original file line numberDiff line numberDiff line change
Expand Up@@ -294,3 +294,86 @@ test('Does not send any duplicate navigation transaction names browsing between
'/lazy/inner/:id/:anotherId',
]);
});

test('Does not create premature navigation transaction during long-running lazy route pageload', async ({ page }) => {
const navigationPromise = waitForTransaction('react-router-7-lazy-routes', async transactionEvent => {
return (
!!transactionEvent?.transaction &&
transactionEvent.contexts?.trace?.op === 'navigation' &&
transactionEvent.transaction.includes('long-running')
);
});

const pageloadPromise = waitForTransaction('react-router-7-lazy-routes', async transactionEvent => {
return (
!!transactionEvent?.transaction &&
transactionEvent.contexts?.trace?.op === 'pageload' &&
transactionEvent.transaction === '/long-running/slow/:id'
);
});

await page.goto('/long-running/slow/12345');

const pageloadEvent = await pageloadPromise;

expect(pageloadEvent.transaction).toBe('/long-running/slow/:id');
expect(pageloadEvent.contexts?.trace?.op).toBe('pageload');

const slowLoadingContent = page.locator('id=slow-loading-content');
await expect(slowLoadingContent).toBeVisible({ timeout: 5000 });

const result = await Promise.race([
navigationPromise.then(() => 'navigation'),
new Promise<'timeout'>(resolve => setTimeout(() => resolve('timeout'), 2000)),
]);

// Should timeout, meaning no unwanted navigation transaction was created
expect(result).toBe('timeout');
});

test('Allows legitimate POP navigation (back/forward) after pageload completes', async ({ page }) => {
await page.goto('/');

const navigationToLongRunning = page.locator('id=navigation-to-long-running');
await expect(navigationToLongRunning).toBeVisible();

const firstNavigationPromise = waitForTransaction('react-router-7-lazy-routes', async transactionEvent => {
return (
!!transactionEvent?.transaction &&
transactionEvent.contexts?.trace?.op === 'navigation' &&
transactionEvent.transaction === '/long-running/slow/:id'
);
});

await navigationToLongRunning.click();

const slowLoadingContent = page.locator('id=slow-loading-content');
await expect(slowLoadingContent).toBeVisible({ timeout: 5000 });

const firstNavigationEvent = await firstNavigationPromise;

expect(firstNavigationEvent.transaction).toBe('/long-running/slow/:id');
expect(firstNavigationEvent.contexts?.trace?.op).toBe('navigation');

// Now navigate back using browser back button (POP event)
// This should create a navigation transaction since pageload is complete
const backNavigationPromise = waitForTransaction('react-router-7-lazy-routes', async transactionEvent => {
return (
!!transactionEvent?.transaction &&
transactionEvent.contexts?.trace?.op === 'navigation' &&
transactionEvent.transaction === '/'
);
});

await page.goBack();

// Verify we're back at home
const homeLink = page.locator('id=navigation');
await expect(homeLink).toBeVisible();

const backNavigationEvent = await backNavigationPromise;

// Validate that the back navigation (POP) was properly tracked
expect(backNavigationEvent.transaction).toBe('/');
expect(backNavigationEvent.contexts?.trace?.op).toBe('navigation');
});
134 changes: 106 additions & 28 deletions packages/react/src/reactrouter-compat-utils/instrumentation.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -241,6 +241,12 @@ export function createV6CompatibleWrapCreateBrowserRouter<

const activeRootSpan = getActiveRootSpan();

// Track whether we've completed the initial pageload to properly distinguish
// between POPs that occur during pageload vs. legitimate back/forward navigation.
let isInitialPageloadComplete = false;
let hasSeenPageloadSpan = !!activeRootSpan && spanToJSON(activeRootSpan).op === 'pageload';
let hasSeenPopAfterPageload = false;

// The initial load ends when `createBrowserRouter` is called.
// This is the earliest convenient time to update the transaction name.
// Callbacks to `router.subscribe` are not called for the initial load.
Expand All@@ -255,20 +261,31 @@ export function createV6CompatibleWrapCreateBrowserRouter<
}

router.subscribe((state: RouterState) => {
if (state.historyAction === 'PUSH' || state.historyAction === 'POP') {
// 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 {
// Track pageload completion to distinguish POPs during pageload from legitimate back/forward navigation
if (!isInitialPageloadComplete) {
const currentRootSpan = getActiveRootSpan();
const isCurrentlyInPageload = currentRootSpan && spanToJSON(currentRootSpan).op === 'pageload';

if (isCurrentlyInPageload) {
hasSeenPageloadSpan = true;
} else if (hasSeenPageloadSpan) {
// Pageload span was active but is now gone - pageload has completed
if (state.historyAction === 'POP' && !hasSeenPopAfterPageload) {
// Pageload ended: ignore the first POP after pageload
hasSeenPopAfterPageload = true;
} else {
// Pageload ended: either non-POP action or subsequent POP
isInitialPageloadComplete = true;
}
}
// If we haven't seen a pageload span yet, keep waiting (don't mark as complete)
}
Comment thread
cursor[bot] marked this conversation as resolved.
Comment thread
cursor[bot] marked this conversation as resolved.

const shouldHandleNavigation =
state.historyAction === 'PUSH' || (state.historyAction === 'POP' && isInitialPageloadComplete);

if (shouldHandleNavigation) {
const navigationHandler = (): void => {
handleNavigation({
location: state.location,
routes,
Expand All@@ -277,6 +294,13 @@ export function createV6CompatibleWrapCreateBrowserRouter<
basename,
allRoutes: Array.from(allRoutes),
});
};

// Wait for the next render if loading an unsettled route
if (state.navigation.state !== 'idle') {
requestAnimationFrame(navigationHandler);
} else {
navigationHandler();
}
}
});
Expand DownExpand Up@@ -327,7 +351,6 @@ export function createV6CompatibleWrapCreateMemoryRouter<
const router = createRouterFunction(routes, wrappedOpts);
const basename = opts?.basename;

const activeRootSpan = getActiveRootSpan();
let initialEntry = undefined;

const initialEntries = opts?.initialEntries;
Expand All@@ -348,21 +371,68 @@ export function createV6CompatibleWrapCreateMemoryRouter<
: initialEntry
: router.state.location;

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

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

// Track whether we've completed the initial pageload to properly distinguish
// between POPs that occur during pageload vs. legitimate back/forward navigation.
let isInitialPageloadComplete = false;
let hasSeenPageloadSpan = !!memoryActiveRootSpan && spanToJSON(memoryActiveRootSpan).op === 'pageload';
let hasSeenPopAfterPageload = false;

router.subscribe((state: RouterState) => {
// Track pageload completion to distinguish POPs during pageload from legitimate back/forward navigation
if (!isInitialPageloadComplete) {
const currentRootSpan = getActiveRootSpan();
const isCurrentlyInPageload = currentRootSpan && spanToJSON(currentRootSpan).op === 'pageload';

if (isCurrentlyInPageload) {
hasSeenPageloadSpan = true;
} else if (hasSeenPageloadSpan) {
// Pageload span was active but is now gone - pageload has completed
if (state.historyAction === 'POP' && !hasSeenPopAfterPageload) {
// Pageload ended: ignore the first POP after pageload
hasSeenPopAfterPageload = true;
} else {
// Pageload ended: either non-POP action or subsequent POP
isInitialPageloadComplete = true;
}
}
// If we haven't seen a pageload span yet, keep waiting (don't mark as complete)
}

const location = state.location;
if (state.historyAction === 'PUSH' || state.historyAction === 'POP') {
handleNavigation({
location,
routes,
navigationType: state.historyAction,
version,
basename,
allRoutes: Array.from(allRoutes),
});

const shouldHandleNavigation =
state.historyAction === 'PUSH' || (state.historyAction === 'POP' && isInitialPageloadComplete);

if (shouldHandleNavigation) {
Comment thread
cursor[bot] marked this conversation as resolved.
const navigationHandler = (): void => {
handleNavigation({
location,
routes,
navigationType: state.historyAction,
version,
basename,
allRoutes: Array.from(allRoutes),
});
};

// Wait for the next render if loading an unsettled route
if (state.navigation.state !== 'idle') {
requestAnimationFrame(navigationHandler);
} else {
navigationHandler();
}
}
});

Expand DownExpand Up@@ -532,8 +602,16 @@ function wrapPatchRoutesOnNavigation(
// Update navigation span after routes are patched
const activeRootSpan = getActiveRootSpan();
if (activeRootSpan && (spanToJSON(activeRootSpan) as { op?: string }).op === 'navigation') {
// For memory routers, we should not access window.location; use targetPath only
const pathname = isMemoryRouter ? targetPath : targetPath || WINDOW.location?.pathname;
// Determine pathname based on router type
let pathname: string | undefined;
if (isMemoryRouter) {
// For memory routers, only use targetPath
pathname = targetPath;
} else {
// For browser routers, use targetPath or fall back to window.location
pathname = targetPath || WINDOW.location?.pathname;
}

if (pathname) {
updateNavigationSpan(
activeRootSpan,
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,12 @@ const router = sentryCreateBrowserRouter(
lazyChildren: () => import('./pages/AnotherLazyRoutes').then(module => module.anotherNestedRoutes),
},
},
{
path: '/long-running',
handle: {
lazyChildren: () => import('./pages/LongRunningLazyRoutes').then(module => module.longRunningNestedRoutes),
},
},
{
path: '/static',
element: <>Hello World</>,
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,10 @@ const Index = () => {
<Link to="/another-lazy/sub/555/666" id="navigation-to-another-deep">
Navigate to Another Deep Lazy Route
</Link>
<br />
<Link to="/long-running/slow/12345" id="navigation-to-long-running">
Navigate to Long Running Lazy Route
</Link>
</>
);
};
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
import React, { useEffect, useState } from 'react';
import { Link, useParams } from 'react-router-dom';

// Component that simulates a long-running component load
// This is used to test the POP guard during long-running pageloads
const SlowLoadingComponent = () => {
const { id } = useParams<{ id: string }>();
const [data, setData] = useState<string | null>(null);
const [isLoading, setIsLoading] = useState(true);

useEffect(() => {
// Simulate a component that takes time to initialize
// This extends the pageload duration to create a window where POP events might occur
setTimeout(() => {
setData(`Data loaded for ID: ${id}`);
setIsLoading(false);
}, 1000);
}, [id]);

if (isLoading) {
return <div id="loading-indicator">Loading...</div>;
}

return (
<div id="slow-loading-content">
<div>{data}</div>
<Link to="/" id="navigate-home">
Go Home
</Link>
</div>
);
};

export const longRunningNestedRoutes = [
{
path: 'slow',
children: [
{
path: ':id',
element: <SlowLoadingComponent />,
loader: async () => {
// Simulate slow data fetching in the loader
await new Promise(resolve => setTimeout(resolve, 2000));
return null;
},
},
],
},
];
Original file line numberDiff line numberDiff line change
Expand Up@@ -294,3 +294,86 @@ test('Does not send any duplicate navigation transaction names browsing between
'/lazy/inner/:id/:anotherId',
]);
});

test('Does not create premature navigation transaction during long-running lazy route pageload', async ({ page }) => {
const navigationPromise = waitForTransaction('react-router-7-lazy-routes', async transactionEvent => {
return (
!!transactionEvent?.transaction &&
transactionEvent.contexts?.trace?.op === 'navigation' &&
transactionEvent.transaction.includes('long-running')
);
});

const pageloadPromise = waitForTransaction('react-router-7-lazy-routes', async transactionEvent => {
return (
!!transactionEvent?.transaction &&
transactionEvent.contexts?.trace?.op === 'pageload' &&
transactionEvent.transaction === '/long-running/slow/:id'
);
});

await page.goto('/long-running/slow/12345');

const pageloadEvent = await pageloadPromise;

expect(pageloadEvent.transaction).toBe('/long-running/slow/:id');
expect(pageloadEvent.contexts?.trace?.op).toBe('pageload');

const slowLoadingContent = page.locator('id=slow-loading-content');
await expect(slowLoadingContent).toBeVisible({ timeout: 5000 });

const result = await Promise.race([
navigationPromise.then(() => 'navigation'),
new Promise<'timeout'>(resolve => setTimeout(() => resolve('timeout'), 2000)),
]);

// Should timeout, meaning no unwanted navigation transaction was created
expect(result).toBe('timeout');
});

test('Allows legitimate POP navigation (back/forward) after pageload completes', async ({ page }) => {
await page.goto('/');

const navigationToLongRunning = page.locator('id=navigation-to-long-running');
await expect(navigationToLongRunning).toBeVisible();

const firstNavigationPromise = waitForTransaction('react-router-7-lazy-routes', async transactionEvent => {
return (
!!transactionEvent?.transaction &&
transactionEvent.contexts?.trace?.op === 'navigation' &&
transactionEvent.transaction === '/long-running/slow/:id'
);
});

await navigationToLongRunning.click();

const slowLoadingContent = page.locator('id=slow-loading-content');
await expect(slowLoadingContent).toBeVisible({ timeout: 5000 });

const firstNavigationEvent = await firstNavigationPromise;

expect(firstNavigationEvent.transaction).toBe('/long-running/slow/:id');
expect(firstNavigationEvent.contexts?.trace?.op).toBe('navigation');

// Now navigate back using browser back button (POP event)
// This should create a navigation transaction since pageload is complete
const backNavigationPromise = waitForTransaction('react-router-7-lazy-routes', async transactionEvent => {
return (
!!transactionEvent?.transaction &&
transactionEvent.contexts?.trace?.op === 'navigation' &&
transactionEvent.transaction === '/'
);
});

await page.goBack();

// Verify we're back at home
const homeLink = page.locator('id=navigation');
await expect(homeLink).toBeVisible();

const backNavigationEvent = await backNavigationPromise;

// Validate that the back navigation (POP) was properly tracked
expect(backNavigationEvent.transaction).toBe('/');
expect(backNavigationEvent.contexts?.trace?.op).toBe('navigation');
});
134 changes: 106 additions & 28 deletions packages/react/src/reactrouter-compat-utils/instrumentation.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -241,6 +241,12 @@ export function createV6CompatibleWrapCreateBrowserRouter<

const activeRootSpan = getActiveRootSpan();

// Track whether we've completed the initial pageload to properly distinguish
// between POPs that occur during pageload vs. legitimate back/forward navigation.
let isInitialPageloadComplete = false;
let hasSeenPageloadSpan = !!activeRootSpan && spanToJSON(activeRootSpan).op === 'pageload';
let hasSeenPopAfterPageload = false;

// The initial load ends when `createBrowserRouter` is called.
// This is the earliest convenient time to update the transaction name.
// Callbacks to `router.subscribe` are not called for the initial load.
Expand All@@ -255,20 +261,31 @@ export function createV6CompatibleWrapCreateBrowserRouter<
}

router.subscribe((state: RouterState) => {
if (state.historyAction === 'PUSH' || state.historyAction === 'POP') {
// 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 {
// Track pageload completion to distinguish POPs during pageload from legitimate back/forward navigation
if (!isInitialPageloadComplete) {
const currentRootSpan = getActiveRootSpan();
const isCurrentlyInPageload = currentRootSpan && spanToJSON(currentRootSpan).op === 'pageload';

if (isCurrentlyInPageload) {
hasSeenPageloadSpan = true;
} else if (hasSeenPageloadSpan) {
// Pageload span was active but is now gone - pageload has completed
if (state.historyAction === 'POP' && !hasSeenPopAfterPageload) {
// Pageload ended: ignore the first POP after pageload
hasSeenPopAfterPageload = true;
} else {
// Pageload ended: either non-POP action or subsequent POP
isInitialPageloadComplete = true;
}
}
// If we haven't seen a pageload span yet, keep waiting (don't mark as complete)
}
Comment thread
cursor[bot] marked this conversation as resolved.
Comment thread
cursor[bot] marked this conversation as resolved.

const shouldHandleNavigation =
state.historyAction === 'PUSH' || (state.historyAction === 'POP' && isInitialPageloadComplete);

if (shouldHandleNavigation) {
const navigationHandler = (): void => {
handleNavigation({
location: state.location,
routes,
Expand All@@ -277,6 +294,13 @@ export function createV6CompatibleWrapCreateBrowserRouter<
basename,
allRoutes: Array.from(allRoutes),
});
};

// Wait for the next render if loading an unsettled route
if (state.navigation.state !== 'idle') {
requestAnimationFrame(navigationHandler);
} else {
navigationHandler();
}
}
});
Expand DownExpand Up@@ -327,7 +351,6 @@ export function createV6CompatibleWrapCreateMemoryRouter<
const router = createRouterFunction(routes, wrappedOpts);
const basename = opts?.basename;

const activeRootSpan = getActiveRootSpan();
let initialEntry = undefined;

const initialEntries = opts?.initialEntries;
Expand All@@ -348,21 +371,68 @@ export function createV6CompatibleWrapCreateMemoryRouter<
: initialEntry
: router.state.location;

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

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

// Track whether we've completed the initial pageload to properly distinguish
// between POPs that occur during pageload vs. legitimate back/forward navigation.
let isInitialPageloadComplete = false;
let hasSeenPageloadSpan = !!memoryActiveRootSpan && spanToJSON(memoryActiveRootSpan).op === 'pageload';
let hasSeenPopAfterPageload = false;

router.subscribe((state: RouterState) => {
// Track pageload completion to distinguish POPs during pageload from legitimate back/forward navigation
if (!isInitialPageloadComplete) {
const currentRootSpan = getActiveRootSpan();
const isCurrentlyInPageload = currentRootSpan && spanToJSON(currentRootSpan).op === 'pageload';

if (isCurrentlyInPageload) {
hasSeenPageloadSpan = true;
} else if (hasSeenPageloadSpan) {
// Pageload span was active but is now gone - pageload has completed
if (state.historyAction === 'POP' && !hasSeenPopAfterPageload) {
// Pageload ended: ignore the first POP after pageload
hasSeenPopAfterPageload = true;
} else {
// Pageload ended: either non-POP action or subsequent POP
isInitialPageloadComplete = true;
}
}
// If we haven't seen a pageload span yet, keep waiting (don't mark as complete)
}

const location = state.location;
if (state.historyAction === 'PUSH' || state.historyAction === 'POP') {
handleNavigation({
location,
routes,
navigationType: state.historyAction,
version,
basename,
allRoutes: Array.from(allRoutes),
});

const shouldHandleNavigation =
state.historyAction === 'PUSH' || (state.historyAction === 'POP' && isInitialPageloadComplete);

if (shouldHandleNavigation) {
Comment thread
cursor[bot] marked this conversation as resolved.
const navigationHandler = (): void => {
handleNavigation({
location,
routes,
navigationType: state.historyAction,
version,
basename,
allRoutes: Array.from(allRoutes),
});
};

// Wait for the next render if loading an unsettled route
if (state.navigation.state !== 'idle') {
requestAnimationFrame(navigationHandler);
} else {
navigationHandler();
}
}
});

Expand DownExpand Up@@ -532,8 +602,16 @@ function wrapPatchRoutesOnNavigation(
// Update navigation span after routes are patched
const activeRootSpan = getActiveRootSpan();
if (activeRootSpan && (spanToJSON(activeRootSpan) as { op?: string }).op === 'navigation') {
// For memory routers, we should not access window.location; use targetPath only
const pathname = isMemoryRouter ? targetPath : targetPath || WINDOW.location?.pathname;
// Determine pathname based on router type
let pathname: string | undefined;
if (isMemoryRouter) {
// For memory routers, only use targetPath
pathname = targetPath;
} else {
// For browser routers, use targetPath or fall back to window.location
pathname = targetPath || WINDOW.location?.pathname;
}

if (pathname) {
updateNavigationSpan(
activeRootSpan,
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,12 @@ const router = sentryCreateBrowserRouter(
lazyChildren: () => import('./pages/AnotherLazyRoutes').then(module => module.anotherNestedRoutes),
},
},
{
path: '/long-running',
handle: {
lazyChildren: () => import('./pages/LongRunningLazyRoutes').then(module => module.longRunningNestedRoutes),
},
},
{
path: '/static',
element: <>Hello World</>,
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,10 @@ const Index = () => {
<Link to="/another-lazy/sub/555/666" id="navigation-to-another-deep">
Navigate to Another Deep Lazy Route
</Link>
<br />
<Link to="/long-running/slow/12345" id="navigation-to-long-running">
Navigate to Long Running Lazy Route
</Link>
</>
);
};
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
import React, { useEffect, useState } from 'react';
import { Link, useParams } from 'react-router-dom';

// Component that simulates a long-running component load
// This is used to test the POP guard during long-running pageloads
const SlowLoadingComponent = () => {
const { id } = useParams<{ id: string }>();
const [data, setData] = useState<string | null>(null);
const [isLoading, setIsLoading] = useState(true);

useEffect(() => {
// Simulate a component that takes time to initialize
// This extends the pageload duration to create a window where POP events might occur
setTimeout(() => {
setData(`Data loaded for ID: ${id}`);
setIsLoading(false);
}, 1000);
}, [id]);

if (isLoading) {
return <div id="loading-indicator">Loading...</div>;
}

return (
<div id="slow-loading-content">
<div>{data}</div>
<Link to="/" id="navigate-home">
Go Home
</Link>
</div>
);
};

export const longRunningNestedRoutes = [
{
path: 'slow',
children: [
{
path: ':id',
element: <SlowLoadingComponent />,
loader: async () => {
// Simulate slow data fetching in the loader
await new Promise(resolve => setTimeout(resolve, 2000));
return null;
},
},
],
},
];
Original file line numberDiff line numberDiff line change
Expand Up@@ -294,3 +294,86 @@ test('Does not send any duplicate navigation transaction names browsing between
'/lazy/inner/:id/:anotherId',
]);
});

test('Does not create premature navigation transaction during long-running lazy route pageload', async ({ page }) => {
const navigationPromise = waitForTransaction('react-router-7-lazy-routes', async transactionEvent => {
return (
!!transactionEvent?.transaction &&
transactionEvent.contexts?.trace?.op === 'navigation' &&
transactionEvent.transaction.includes('long-running')
);
});

const pageloadPromise = waitForTransaction('react-router-7-lazy-routes', async transactionEvent => {
return (
!!transactionEvent?.transaction &&
transactionEvent.contexts?.trace?.op === 'pageload' &&
transactionEvent.transaction === '/long-running/slow/:id'
);
});

await page.goto('/long-running/slow/12345');

const pageloadEvent = await pageloadPromise;

expect(pageloadEvent.transaction).toBe('/long-running/slow/:id');
expect(pageloadEvent.contexts?.trace?.op).toBe('pageload');

const slowLoadingContent = page.locator('id=slow-loading-content');
await expect(slowLoadingContent).toBeVisible({ timeout: 5000 });

const result = await Promise.race([
navigationPromise.then(() => 'navigation'),
new Promise<'timeout'>(resolve => setTimeout(() => resolve('timeout'), 2000)),
]);

// Should timeout, meaning no unwanted navigation transaction was created
expect(result).toBe('timeout');
});

test('Allows legitimate POP navigation (back/forward) after pageload completes', async ({ page }) => {
await page.goto('/');

const navigationToLongRunning = page.locator('id=navigation-to-long-running');
await expect(navigationToLongRunning).toBeVisible();

const firstNavigationPromise = waitForTransaction('react-router-7-lazy-routes', async transactionEvent => {
return (
!!transactionEvent?.transaction &&
transactionEvent.contexts?.trace?.op === 'navigation' &&
transactionEvent.transaction === '/long-running/slow/:id'
);
});

await navigationToLongRunning.click();

const slowLoadingContent = page.locator('id=slow-loading-content');
await expect(slowLoadingContent).toBeVisible({ timeout: 5000 });

const firstNavigationEvent = await firstNavigationPromise;

expect(firstNavigationEvent.transaction).toBe('/long-running/slow/:id');
expect(firstNavigationEvent.contexts?.trace?.op).toBe('navigation');

// Now navigate back using browser back button (POP event)
// This should create a navigation transaction since pageload is complete
const backNavigationPromise = waitForTransaction('react-router-7-lazy-routes', async transactionEvent => {
return (
!!transactionEvent?.transaction &&
transactionEvent.contexts?.trace?.op === 'navigation' &&
transactionEvent.transaction === '/'
);
});

await page.goBack();

// Verify we're back at home
const homeLink = page.locator('id=navigation');
await expect(homeLink).toBeVisible();

const backNavigationEvent = await backNavigationPromise;

// Validate that the back navigation (POP) was properly tracked
expect(backNavigationEvent.transaction).toBe('/');
expect(backNavigationEvent.contexts?.trace?.op).toBe('navigation');
});
134 changes: 106 additions & 28 deletions packages/react/src/reactrouter-compat-utils/instrumentation.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -241,6 +241,12 @@ export function createV6CompatibleWrapCreateBrowserRouter<

const activeRootSpan = getActiveRootSpan();

// Track whether we've completed the initial pageload to properly distinguish
// between POPs that occur during pageload vs. legitimate back/forward navigation.
let isInitialPageloadComplete = false;
let hasSeenPageloadSpan = !!activeRootSpan && spanToJSON(activeRootSpan).op === 'pageload';
let hasSeenPopAfterPageload = false;

// The initial load ends when `createBrowserRouter` is called.
// This is the earliest convenient time to update the transaction name.
// Callbacks to `router.subscribe` are not called for the initial load.
Expand All@@ -255,20 +261,31 @@ export function createV6CompatibleWrapCreateBrowserRouter<
}

router.subscribe((state: RouterState) => {
if (state.historyAction === 'PUSH' || state.historyAction === 'POP') {
// 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 {
// Track pageload completion to distinguish POPs during pageload from legitimate back/forward navigation
if (!isInitialPageloadComplete) {
const currentRootSpan = getActiveRootSpan();
const isCurrentlyInPageload = currentRootSpan && spanToJSON(currentRootSpan).op === 'pageload';

if (isCurrentlyInPageload) {
hasSeenPageloadSpan = true;
} else if (hasSeenPageloadSpan) {
// Pageload span was active but is now gone - pageload has completed
if (state.historyAction === 'POP' && !hasSeenPopAfterPageload) {
// Pageload ended: ignore the first POP after pageload
hasSeenPopAfterPageload = true;
} else {
// Pageload ended: either non-POP action or subsequent POP
isInitialPageloadComplete = true;
}
}
// If we haven't seen a pageload span yet, keep waiting (don't mark as complete)
}
Comment thread
cursor[bot] marked this conversation as resolved.
Comment thread
cursor[bot] marked this conversation as resolved.

const shouldHandleNavigation =
state.historyAction === 'PUSH' || (state.historyAction === 'POP' && isInitialPageloadComplete);

if (shouldHandleNavigation) {
const navigationHandler = (): void => {
handleNavigation({
location: state.location,
routes,
Expand All@@ -277,6 +294,13 @@ export function createV6CompatibleWrapCreateBrowserRouter<
basename,
allRoutes: Array.from(allRoutes),
});
};

// Wait for the next render if loading an unsettled route
if (state.navigation.state !== 'idle') {
requestAnimationFrame(navigationHandler);
} else {
navigationHandler();
}
}
});
Expand DownExpand Up@@ -327,7 +351,6 @@ export function createV6CompatibleWrapCreateMemoryRouter<
const router = createRouterFunction(routes, wrappedOpts);
const basename = opts?.basename;

const activeRootSpan = getActiveRootSpan();
let initialEntry = undefined;

const initialEntries = opts?.initialEntries;
Expand All@@ -348,21 +371,68 @@ export function createV6CompatibleWrapCreateMemoryRouter<
: initialEntry
: router.state.location;

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

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

// Track whether we've completed the initial pageload to properly distinguish
// between POPs that occur during pageload vs. legitimate back/forward navigation.
let isInitialPageloadComplete = false;
let hasSeenPageloadSpan = !!memoryActiveRootSpan && spanToJSON(memoryActiveRootSpan).op === 'pageload';
let hasSeenPopAfterPageload = false;

router.subscribe((state: RouterState) => {
// Track pageload completion to distinguish POPs during pageload from legitimate back/forward navigation
if (!isInitialPageloadComplete) {
const currentRootSpan = getActiveRootSpan();
const isCurrentlyInPageload = currentRootSpan && spanToJSON(currentRootSpan).op === 'pageload';

if (isCurrentlyInPageload) {
hasSeenPageloadSpan = true;
} else if (hasSeenPageloadSpan) {
// Pageload span was active but is now gone - pageload has completed
if (state.historyAction === 'POP' && !hasSeenPopAfterPageload) {
// Pageload ended: ignore the first POP after pageload
hasSeenPopAfterPageload = true;
} else {
// Pageload ended: either non-POP action or subsequent POP
isInitialPageloadComplete = true;
}
}
// If we haven't seen a pageload span yet, keep waiting (don't mark as complete)
}

const location = state.location;
if (state.historyAction === 'PUSH' || state.historyAction === 'POP') {
handleNavigation({
location,
routes,
navigationType: state.historyAction,
version,
basename,
allRoutes: Array.from(allRoutes),
});

const shouldHandleNavigation =
state.historyAction === 'PUSH' || (state.historyAction === 'POP' && isInitialPageloadComplete);

if (shouldHandleNavigation) {
Comment thread
cursor[bot] marked this conversation as resolved.
const navigationHandler = (): void => {
handleNavigation({
location,
routes,
navigationType: state.historyAction,
version,
basename,
allRoutes: Array.from(allRoutes),
});
};

// Wait for the next render if loading an unsettled route
if (state.navigation.state !== 'idle') {
requestAnimationFrame(navigationHandler);
} else {
navigationHandler();
}
}
});

Expand DownExpand Up@@ -532,8 +602,16 @@ function wrapPatchRoutesOnNavigation(
// Update navigation span after routes are patched
const activeRootSpan = getActiveRootSpan();
if (activeRootSpan && (spanToJSON(activeRootSpan) as { op?: string }).op === 'navigation') {
// For memory routers, we should not access window.location; use targetPath only
const pathname = isMemoryRouter ? targetPath : targetPath || WINDOW.location?.pathname;
// Determine pathname based on router type
let pathname: string | undefined;
if (isMemoryRouter) {
// For memory routers, only use targetPath
pathname = targetPath;
} else {
// For browser routers, use targetPath or fall back to window.location
pathname = targetPath || WINDOW.location?.pathname;
}

if (pathname) {
updateNavigationSpan(
activeRootSpan,
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,12 @@ const router = sentryCreateBrowserRouter(
lazyChildren: () => import('./pages/AnotherLazyRoutes').then(module => module.anotherNestedRoutes),
},
},
{
path: '/long-running',
handle: {
lazyChildren: () => import('./pages/LongRunningLazyRoutes').then(module => module.longRunningNestedRoutes),
},
},
{
path: '/static',
element: <>Hello World</>,
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,10 @@ const Index = () => {
<Link to="/another-lazy/sub/555/666" id="navigation-to-another-deep">
Navigate to Another Deep Lazy Route
</Link>
<br />
<Link to="/long-running/slow/12345" id="navigation-to-long-running">
Navigate to Long Running Lazy Route
</Link>
</>
);
};
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
import React, { useEffect, useState } from 'react';
import { Link, useParams } from 'react-router-dom';

// Component that simulates a long-running component load
// This is used to test the POP guard during long-running pageloads
const SlowLoadingComponent = () => {
const { id } = useParams<{ id: string }>();
const [data, setData] = useState<string | null>(null);
const [isLoading, setIsLoading] = useState(true);

useEffect(() => {
// Simulate a component that takes time to initialize
// This extends the pageload duration to create a window where POP events might occur
setTimeout(() => {
setData(`Data loaded for ID: ${id}`);
setIsLoading(false);
}, 1000);
}, [id]);

if (isLoading) {
return <div id="loading-indicator">Loading...</div>;
}

return (
<div id="slow-loading-content">
<div>{data}</div>
<Link to="/" id="navigate-home">
Go Home
</Link>
</div>
);
};

export const longRunningNestedRoutes = [
{
path: 'slow',
children: [
{
path: ':id',
element: <SlowLoadingComponent />,
loader: async () => {
// Simulate slow data fetching in the loader
await new Promise(resolve => setTimeout(resolve, 2000));
return null;
},
},
],
},
];
Original file line numberDiff line numberDiff line change
Expand Up@@ -294,3 +294,86 @@ test('Does not send any duplicate navigation transaction names browsing between
'/lazy/inner/:id/:anotherId',
]);
});

test('Does not create premature navigation transaction during long-running lazy route pageload', async ({ page }) => {
const navigationPromise = waitForTransaction('react-router-7-lazy-routes', async transactionEvent => {
return (
!!transactionEvent?.transaction &&
transactionEvent.contexts?.trace?.op === 'navigation' &&
transactionEvent.transaction.includes('long-running')
);
});

const pageloadPromise = waitForTransaction('react-router-7-lazy-routes', async transactionEvent => {
return (
!!transactionEvent?.transaction &&
transactionEvent.contexts?.trace?.op === 'pageload' &&
transactionEvent.transaction === '/long-running/slow/:id'
);
});

await page.goto('/long-running/slow/12345');

const pageloadEvent = await pageloadPromise;

expect(pageloadEvent.transaction).toBe('/long-running/slow/:id');
expect(pageloadEvent.contexts?.trace?.op).toBe('pageload');

const slowLoadingContent = page.locator('id=slow-loading-content');
await expect(slowLoadingContent).toBeVisible({ timeout: 5000 });

const result = await Promise.race([
navigationPromise.then(() => 'navigation'),
new Promise<'timeout'>(resolve => setTimeout(() => resolve('timeout'), 2000)),
]);

// Should timeout, meaning no unwanted navigation transaction was created
expect(result).toBe('timeout');
});

test('Allows legitimate POP navigation (back/forward) after pageload completes', async ({ page }) => {
await page.goto('/');

const navigationToLongRunning = page.locator('id=navigation-to-long-running');
await expect(navigationToLongRunning).toBeVisible();

const firstNavigationPromise = waitForTransaction('react-router-7-lazy-routes', async transactionEvent => {
return (
!!transactionEvent?.transaction &&
transactionEvent.contexts?.trace?.op === 'navigation' &&
transactionEvent.transaction === '/long-running/slow/:id'
);
});

await navigationToLongRunning.click();

const slowLoadingContent = page.locator('id=slow-loading-content');
await expect(slowLoadingContent).toBeVisible({ timeout: 5000 });

const firstNavigationEvent = await firstNavigationPromise;

expect(firstNavigationEvent.transaction).toBe('/long-running/slow/:id');
expect(firstNavigationEvent.contexts?.trace?.op).toBe('navigation');

// Now navigate back using browser back button (POP event)
// This should create a navigation transaction since pageload is complete
const backNavigationPromise = waitForTransaction('react-router-7-lazy-routes', async transactionEvent => {
return (
!!transactionEvent?.transaction &&
transactionEvent.contexts?.trace?.op === 'navigation' &&
transactionEvent.transaction === '/'
);
});

await page.goBack();

// Verify we're back at home
const homeLink = page.locator('id=navigation');
await expect(homeLink).toBeVisible();

const backNavigationEvent = await backNavigationPromise;

// Validate that the back navigation (POP) was properly tracked
expect(backNavigationEvent.transaction).toBe('/');
expect(backNavigationEvent.contexts?.trace?.op).toBe('navigation');
});
134 changes: 106 additions & 28 deletions packages/react/src/reactrouter-compat-utils/instrumentation.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -241,6 +241,12 @@ export function createV6CompatibleWrapCreateBrowserRouter<

const activeRootSpan = getActiveRootSpan();

// Track whether we've completed the initial pageload to properly distinguish
// between POPs that occur during pageload vs. legitimate back/forward navigation.
let isInitialPageloadComplete = false;
let hasSeenPageloadSpan = !!activeRootSpan && spanToJSON(activeRootSpan).op === 'pageload';
let hasSeenPopAfterPageload = false;

// The initial load ends when `createBrowserRouter` is called.
// This is the earliest convenient time to update the transaction name.
// Callbacks to `router.subscribe` are not called for the initial load.
Expand All@@ -255,20 +261,31 @@ export function createV6CompatibleWrapCreateBrowserRouter<
}

router.subscribe((state: RouterState) => {
if (state.historyAction === 'PUSH' || state.historyAction === 'POP') {
// 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 {
// Track pageload completion to distinguish POPs during pageload from legitimate back/forward navigation
if (!isInitialPageloadComplete) {
const currentRootSpan = getActiveRootSpan();
const isCurrentlyInPageload = currentRootSpan && spanToJSON(currentRootSpan).op === 'pageload';

if (isCurrentlyInPageload) {
hasSeenPageloadSpan = true;
} else if (hasSeenPageloadSpan) {
// Pageload span was active but is now gone - pageload has completed
if (state.historyAction === 'POP' && !hasSeenPopAfterPageload) {
// Pageload ended: ignore the first POP after pageload
hasSeenPopAfterPageload = true;
} else {
// Pageload ended: either non-POP action or subsequent POP
isInitialPageloadComplete = true;
}
}
// If we haven't seen a pageload span yet, keep waiting (don't mark as complete)
}
Comment thread
cursor[bot] marked this conversation as resolved.
Comment thread
cursor[bot] marked this conversation as resolved.

const shouldHandleNavigation =
state.historyAction === 'PUSH' || (state.historyAction === 'POP' && isInitialPageloadComplete);

if (shouldHandleNavigation) {
const navigationHandler = (): void => {
handleNavigation({
location: state.location,
routes,
Expand All@@ -277,6 +294,13 @@ export function createV6CompatibleWrapCreateBrowserRouter<
basename,
allRoutes: Array.from(allRoutes),
});
};

// Wait for the next render if loading an unsettled route
if (state.navigation.state !== 'idle') {
requestAnimationFrame(navigationHandler);
} else {
navigationHandler();
}
}
});
Expand DownExpand Up@@ -327,7 +351,6 @@ export function createV6CompatibleWrapCreateMemoryRouter<
const router = createRouterFunction(routes, wrappedOpts);
const basename = opts?.basename;

const activeRootSpan = getActiveRootSpan();
let initialEntry = undefined;

const initialEntries = opts?.initialEntries;
Expand All@@ -348,21 +371,68 @@ export function createV6CompatibleWrapCreateMemoryRouter<
: initialEntry
: router.state.location;

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

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

// Track whether we've completed the initial pageload to properly distinguish
// between POPs that occur during pageload vs. legitimate back/forward navigation.
let isInitialPageloadComplete = false;
let hasSeenPageloadSpan = !!memoryActiveRootSpan && spanToJSON(memoryActiveRootSpan).op === 'pageload';
let hasSeenPopAfterPageload = false;

router.subscribe((state: RouterState) => {
// Track pageload completion to distinguish POPs during pageload from legitimate back/forward navigation
if (!isInitialPageloadComplete) {
const currentRootSpan = getActiveRootSpan();
const isCurrentlyInPageload = currentRootSpan && spanToJSON(currentRootSpan).op === 'pageload';

if (isCurrentlyInPageload) {
hasSeenPageloadSpan = true;
} else if (hasSeenPageloadSpan) {
// Pageload span was active but is now gone - pageload has completed
if (state.historyAction === 'POP' && !hasSeenPopAfterPageload) {
// Pageload ended: ignore the first POP after pageload
hasSeenPopAfterPageload = true;
} else {
// Pageload ended: either non-POP action or subsequent POP
isInitialPageloadComplete = true;
}
}
// If we haven't seen a pageload span yet, keep waiting (don't mark as complete)
}

const location = state.location;
if (state.historyAction === 'PUSH' || state.historyAction === 'POP') {
handleNavigation({
location,
routes,
navigationType: state.historyAction,
version,
basename,
allRoutes: Array.from(allRoutes),
});

const shouldHandleNavigation =
state.historyAction === 'PUSH' || (state.historyAction === 'POP' && isInitialPageloadComplete);

if (shouldHandleNavigation) {
Comment thread
cursor[bot] marked this conversation as resolved.
const navigationHandler = (): void => {
handleNavigation({
location,
routes,
navigationType: state.historyAction,
version,
basename,
allRoutes: Array.from(allRoutes),
});
};

// Wait for the next render if loading an unsettled route
if (state.navigation.state !== 'idle') {
requestAnimationFrame(navigationHandler);
} else {
navigationHandler();
}
}
});

Expand DownExpand Up@@ -532,8 +602,16 @@ function wrapPatchRoutesOnNavigation(
// Update navigation span after routes are patched
const activeRootSpan = getActiveRootSpan();
if (activeRootSpan && (spanToJSON(activeRootSpan) as { op?: string }).op === 'navigation') {
// For memory routers, we should not access window.location; use targetPath only
const pathname = isMemoryRouter ? targetPath : targetPath || WINDOW.location?.pathname;
// Determine pathname based on router type
let pathname: string | undefined;
if (isMemoryRouter) {
// For memory routers, only use targetPath
pathname = targetPath;
} else {
// For browser routers, use targetPath or fall back to window.location
pathname = targetPath || WINDOW.location?.pathname;
}

if (pathname) {
updateNavigationSpan(
activeRootSpan,
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,12 @@ const router = sentryCreateBrowserRouter(
lazyChildren: () => import('./pages/AnotherLazyRoutes').then(module => module.anotherNestedRoutes),
},
},
{
path: '/long-running',
handle: {
lazyChildren: () => import('./pages/LongRunningLazyRoutes').then(module => module.longRunningNestedRoutes),
},
},
{
path: '/static',
element: <>Hello World</>,
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,10 @@ const Index = () => {
<Link to="/another-lazy/sub/555/666" id="navigation-to-another-deep">
Navigate to Another Deep Lazy Route
</Link>
<br />
<Link to="/long-running/slow/12345" id="navigation-to-long-running">
Navigate to Long Running Lazy Route
</Link>
</>
);
};
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
import React, { useEffect, useState } from 'react';
import { Link, useParams } from 'react-router-dom';

// Component that simulates a long-running component load
// This is used to test the POP guard during long-running pageloads
const SlowLoadingComponent = () => {
const { id } = useParams<{ id: string }>();
const [data, setData] = useState<string | null>(null);
const [isLoading, setIsLoading] = useState(true);

useEffect(() => {
// Simulate a component that takes time to initialize
// This extends the pageload duration to create a window where POP events might occur
setTimeout(() => {
setData(`Data loaded for ID: ${id}`);
setIsLoading(false);
}, 1000);
}, [id]);

if (isLoading) {
return <div id="loading-indicator">Loading...</div>;
}

return (
<div id="slow-loading-content">
<div>{data}</div>
<Link to="/" id="navigate-home">
Go Home
</Link>
</div>
);
};

export const longRunningNestedRoutes = [
{
path: 'slow',
children: [
{
path: ':id',
element: <SlowLoadingComponent />,
loader: async () => {
// Simulate slow data fetching in the loader
await new Promise(resolve => setTimeout(resolve, 2000));
return null;
},
},
],
},
];
Original file line numberDiff line numberDiff line change
Expand Up@@ -294,3 +294,86 @@ test('Does not send any duplicate navigation transaction names browsing between
'/lazy/inner/:id/:anotherId',
]);
});

test('Does not create premature navigation transaction during long-running lazy route pageload', async ({ page }) => {
const navigationPromise = waitForTransaction('react-router-7-lazy-routes', async transactionEvent => {
return (
!!transactionEvent?.transaction &&
transactionEvent.contexts?.trace?.op === 'navigation' &&
transactionEvent.transaction.includes('long-running')
);
});

const pageloadPromise = waitForTransaction('react-router-7-lazy-routes', async transactionEvent => {
return (
!!transactionEvent?.transaction &&
transactionEvent.contexts?.trace?.op === 'pageload' &&
transactionEvent.transaction === '/long-running/slow/:id'
);
});

await page.goto('/long-running/slow/12345');

const pageloadEvent = await pageloadPromise;

expect(pageloadEvent.transaction).toBe('/long-running/slow/:id');
expect(pageloadEvent.contexts?.trace?.op).toBe('pageload');

const slowLoadingContent = page.locator('id=slow-loading-content');
await expect(slowLoadingContent).toBeVisible({ timeout: 5000 });

const result = await Promise.race([
navigationPromise.then(() => 'navigation'),
new Promise<'timeout'>(resolve => setTimeout(() => resolve('timeout'), 2000)),
]);

// Should timeout, meaning no unwanted navigation transaction was created
expect(result).toBe('timeout');
});

test('Allows legitimate POP navigation (back/forward) after pageload completes', async ({ page }) => {
await page.goto('/');

const navigationToLongRunning = page.locator('id=navigation-to-long-running');
await expect(navigationToLongRunning).toBeVisible();

const firstNavigationPromise = waitForTransaction('react-router-7-lazy-routes', async transactionEvent => {
return (
!!transactionEvent?.transaction &&
transactionEvent.contexts?.trace?.op === 'navigation' &&
transactionEvent.transaction === '/long-running/slow/:id'
);
});

await navigationToLongRunning.click();

const slowLoadingContent = page.locator('id=slow-loading-content');
await expect(slowLoadingContent).toBeVisible({ timeout: 5000 });

const firstNavigationEvent = await firstNavigationPromise;

expect(firstNavigationEvent.transaction).toBe('/long-running/slow/:id');
expect(firstNavigationEvent.contexts?.trace?.op).toBe('navigation');

// Now navigate back using browser back button (POP event)
// This should create a navigation transaction since pageload is complete
const backNavigationPromise = waitForTransaction('react-router-7-lazy-routes', async transactionEvent => {
return (
!!transactionEvent?.transaction &&
transactionEvent.contexts?.trace?.op === 'navigation' &&
transactionEvent.transaction === '/'
);
});

await page.goBack();

// Verify we're back at home
const homeLink = page.locator('id=navigation');
await expect(homeLink).toBeVisible();

const backNavigationEvent = await backNavigationPromise;

// Validate that the back navigation (POP) was properly tracked
expect(backNavigationEvent.transaction).toBe('/');
expect(backNavigationEvent.contexts?.trace?.op).toBe('navigation');
});
134 changes: 106 additions & 28 deletions packages/react/src/reactrouter-compat-utils/instrumentation.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -241,6 +241,12 @@ export function createV6CompatibleWrapCreateBrowserRouter<

const activeRootSpan = getActiveRootSpan();

// Track whether we've completed the initial pageload to properly distinguish
// between POPs that occur during pageload vs. legitimate back/forward navigation.
let isInitialPageloadComplete = false;
let hasSeenPageloadSpan = !!activeRootSpan && spanToJSON(activeRootSpan).op === 'pageload';
let hasSeenPopAfterPageload = false;

// The initial load ends when `createBrowserRouter` is called.
// This is the earliest convenient time to update the transaction name.
// Callbacks to `router.subscribe` are not called for the initial load.
Expand All@@ -255,20 +261,31 @@ export function createV6CompatibleWrapCreateBrowserRouter<
}

router.subscribe((state: RouterState) => {
if (state.historyAction === 'PUSH' || state.historyAction === 'POP') {
// 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 {
// Track pageload completion to distinguish POPs during pageload from legitimate back/forward navigation
if (!isInitialPageloadComplete) {
const currentRootSpan = getActiveRootSpan();
const isCurrentlyInPageload = currentRootSpan && spanToJSON(currentRootSpan).op === 'pageload';

if (isCurrentlyInPageload) {
hasSeenPageloadSpan = true;
} else if (hasSeenPageloadSpan) {
// Pageload span was active but is now gone - pageload has completed
if (state.historyAction === 'POP' && !hasSeenPopAfterPageload) {
// Pageload ended: ignore the first POP after pageload
hasSeenPopAfterPageload = true;
} else {
// Pageload ended: either non-POP action or subsequent POP
isInitialPageloadComplete = true;
}
}
// If we haven't seen a pageload span yet, keep waiting (don't mark as complete)
}
Comment thread
cursor[bot] marked this conversation as resolved.
Comment thread
cursor[bot] marked this conversation as resolved.

const shouldHandleNavigation =
state.historyAction === 'PUSH' || (state.historyAction === 'POP' && isInitialPageloadComplete);

if (shouldHandleNavigation) {
const navigationHandler = (): void => {
handleNavigation({
location: state.location,
routes,
Expand All@@ -277,6 +294,13 @@ export function createV6CompatibleWrapCreateBrowserRouter<
basename,
allRoutes: Array.from(allRoutes),
});
};

// Wait for the next render if loading an unsettled route
if (state.navigation.state !== 'idle') {
requestAnimationFrame(navigationHandler);
} else {
navigationHandler();
}
}
});
Expand DownExpand Up@@ -327,7 +351,6 @@ export function createV6CompatibleWrapCreateMemoryRouter<
const router = createRouterFunction(routes, wrappedOpts);
const basename = opts?.basename;

const activeRootSpan = getActiveRootSpan();
let initialEntry = undefined;

const initialEntries = opts?.initialEntries;
Expand All@@ -348,21 +371,68 @@ export function createV6CompatibleWrapCreateMemoryRouter<
: initialEntry
: router.state.location;

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

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

// Track whether we've completed the initial pageload to properly distinguish
// between POPs that occur during pageload vs. legitimate back/forward navigation.
let isInitialPageloadComplete = false;
let hasSeenPageloadSpan = !!memoryActiveRootSpan && spanToJSON(memoryActiveRootSpan).op === 'pageload';
let hasSeenPopAfterPageload = false;

router.subscribe((state: RouterState) => {
// Track pageload completion to distinguish POPs during pageload from legitimate back/forward navigation
if (!isInitialPageloadComplete) {
const currentRootSpan = getActiveRootSpan();
const isCurrentlyInPageload = currentRootSpan && spanToJSON(currentRootSpan).op === 'pageload';

if (isCurrentlyInPageload) {
hasSeenPageloadSpan = true;
} else if (hasSeenPageloadSpan) {
// Pageload span was active but is now gone - pageload has completed
if (state.historyAction === 'POP' && !hasSeenPopAfterPageload) {
// Pageload ended: ignore the first POP after pageload
hasSeenPopAfterPageload = true;
} else {
// Pageload ended: either non-POP action or subsequent POP
isInitialPageloadComplete = true;
}
}
// If we haven't seen a pageload span yet, keep waiting (don't mark as complete)
}

const location = state.location;
if (state.historyAction === 'PUSH' || state.historyAction === 'POP') {
handleNavigation({
location,
routes,
navigationType: state.historyAction,
version,
basename,
allRoutes: Array.from(allRoutes),
});

const shouldHandleNavigation =
state.historyAction === 'PUSH' || (state.historyAction === 'POP' && isInitialPageloadComplete);

if (shouldHandleNavigation) {
Comment thread
cursor[bot] marked this conversation as resolved.
const navigationHandler = (): void => {
handleNavigation({
location,
routes,
navigationType: state.historyAction,
version,
basename,
allRoutes: Array.from(allRoutes),
});
};

// Wait for the next render if loading an unsettled route
if (state.navigation.state !== 'idle') {
requestAnimationFrame(navigationHandler);
} else {
navigationHandler();
}
}
});

Expand DownExpand Up@@ -532,8 +602,16 @@ function wrapPatchRoutesOnNavigation(
// Update navigation span after routes are patched
const activeRootSpan = getActiveRootSpan();
if (activeRootSpan && (spanToJSON(activeRootSpan) as { op?: string }).op === 'navigation') {
// For memory routers, we should not access window.location; use targetPath only
const pathname = isMemoryRouter ? targetPath : targetPath || WINDOW.location?.pathname;
// Determine pathname based on router type
let pathname: string | undefined;
if (isMemoryRouter) {
// For memory routers, only use targetPath
pathname = targetPath;
} else {
// For browser routers, use targetPath or fall back to window.location
pathname = targetPath || WINDOW.location?.pathname;
}

if (pathname) {
updateNavigationSpan(
activeRootSpan,
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,12 @@ const router = sentryCreateBrowserRouter(
lazyChildren: () => import('./pages/AnotherLazyRoutes').then(module => module.anotherNestedRoutes),
},
},
{
path: '/long-running',
handle: {
lazyChildren: () => import('./pages/LongRunningLazyRoutes').then(module => module.longRunningNestedRoutes),
},
},
{
path: '/static',
element: <>Hello World</>,
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,10 @@ const Index = () => {
<Link to="/another-lazy/sub/555/666" id="navigation-to-another-deep">
Navigate to Another Deep Lazy Route
</Link>
<br />
<Link to="/long-running/slow/12345" id="navigation-to-long-running">
Navigate to Long Running Lazy Route
</Link>
</>
);
};
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
import React, { useEffect, useState } from 'react';
import { Link, useParams } from 'react-router-dom';

// Component that simulates a long-running component load
// This is used to test the POP guard during long-running pageloads
const SlowLoadingComponent = () => {
const { id } = useParams<{ id: string }>();
const [data, setData] = useState<string | null>(null);
const [isLoading, setIsLoading] = useState(true);

useEffect(() => {
// Simulate a component that takes time to initialize
// This extends the pageload duration to create a window where POP events might occur
setTimeout(() => {
setData(`Data loaded for ID: ${id}`);
setIsLoading(false);
}, 1000);
}, [id]);

if (isLoading) {
return <div id="loading-indicator">Loading...</div>;
}

return (
<div id="slow-loading-content">
<div>{data}</div>
<Link to="/" id="navigate-home">
Go Home
</Link>
</div>
);
};

export const longRunningNestedRoutes = [
{
path: 'slow',
children: [
{
path: ':id',
element: <SlowLoadingComponent />,
loader: async () => {
// Simulate slow data fetching in the loader
await new Promise(resolve => setTimeout(resolve, 2000));
return null;
},
},
],
},
];
Original file line numberDiff line numberDiff line change
Expand Up@@ -294,3 +294,86 @@ test('Does not send any duplicate navigation transaction names browsing between
'/lazy/inner/:id/:anotherId',
]);
});

test('Does not create premature navigation transaction during long-running lazy route pageload', async ({ page }) => {
const navigationPromise = waitForTransaction('react-router-7-lazy-routes', async transactionEvent => {
return (
!!transactionEvent?.transaction &&
transactionEvent.contexts?.trace?.op === 'navigation' &&
transactionEvent.transaction.includes('long-running')
);
});

const pageloadPromise = waitForTransaction('react-router-7-lazy-routes', async transactionEvent => {
return (
!!transactionEvent?.transaction &&
transactionEvent.contexts?.trace?.op === 'pageload' &&
transactionEvent.transaction === '/long-running/slow/:id'
);
});

await page.goto('/long-running/slow/12345');

const pageloadEvent = await pageloadPromise;

expect(pageloadEvent.transaction).toBe('/long-running/slow/:id');
expect(pageloadEvent.contexts?.trace?.op).toBe('pageload');

const slowLoadingContent = page.locator('id=slow-loading-content');
await expect(slowLoadingContent).toBeVisible({ timeout: 5000 });

const result = await Promise.race([
navigationPromise.then(() => 'navigation'),
new Promise<'timeout'>(resolve => setTimeout(() => resolve('timeout'), 2000)),
]);

// Should timeout, meaning no unwanted navigation transaction was created
expect(result).toBe('timeout');
});

test('Allows legitimate POP navigation (back/forward) after pageload completes', async ({ page }) => {
await page.goto('/');

const navigationToLongRunning = page.locator('id=navigation-to-long-running');
await expect(navigationToLongRunning).toBeVisible();

const firstNavigationPromise = waitForTransaction('react-router-7-lazy-routes', async transactionEvent => {
return (
!!transactionEvent?.transaction &&
transactionEvent.contexts?.trace?.op === 'navigation' &&
transactionEvent.transaction === '/long-running/slow/:id'
);
});

await navigationToLongRunning.click();

const slowLoadingContent = page.locator('id=slow-loading-content');
await expect(slowLoadingContent).toBeVisible({ timeout: 5000 });

const firstNavigationEvent = await firstNavigationPromise;

expect(firstNavigationEvent.transaction).toBe('/long-running/slow/:id');
expect(firstNavigationEvent.contexts?.trace?.op).toBe('navigation');

// Now navigate back using browser back button (POP event)
// This should create a navigation transaction since pageload is complete
const backNavigationPromise = waitForTransaction('react-router-7-lazy-routes', async transactionEvent => {
return (
!!transactionEvent?.transaction &&
transactionEvent.contexts?.trace?.op === 'navigation' &&
transactionEvent.transaction === '/'
);
});

await page.goBack();

// Verify we're back at home
const homeLink = page.locator('id=navigation');
await expect(homeLink).toBeVisible();

const backNavigationEvent = await backNavigationPromise;

// Validate that the back navigation (POP) was properly tracked
expect(backNavigationEvent.transaction).toBe('/');
expect(backNavigationEvent.contexts?.trace?.op).toBe('navigation');
});
134 changes: 106 additions & 28 deletions packages/react/src/reactrouter-compat-utils/instrumentation.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -241,6 +241,12 @@ export function createV6CompatibleWrapCreateBrowserRouter<

const activeRootSpan = getActiveRootSpan();

// Track whether we've completed the initial pageload to properly distinguish
// between POPs that occur during pageload vs. legitimate back/forward navigation.
let isInitialPageloadComplete = false;
let hasSeenPageloadSpan = !!activeRootSpan && spanToJSON(activeRootSpan).op === 'pageload';
let hasSeenPopAfterPageload = false;

// The initial load ends when `createBrowserRouter` is called.
// This is the earliest convenient time to update the transaction name.
// Callbacks to `router.subscribe` are not called for the initial load.
Expand All@@ -255,20 +261,31 @@ export function createV6CompatibleWrapCreateBrowserRouter<
}

router.subscribe((state: RouterState) => {
if (state.historyAction === 'PUSH' || state.historyAction === 'POP') {
// 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 {
// Track pageload completion to distinguish POPs during pageload from legitimate back/forward navigation
if (!isInitialPageloadComplete) {
const currentRootSpan = getActiveRootSpan();
const isCurrentlyInPageload = currentRootSpan && spanToJSON(currentRootSpan).op === 'pageload';

if (isCurrentlyInPageload) {
hasSeenPageloadSpan = true;
} else if (hasSeenPageloadSpan) {
// Pageload span was active but is now gone - pageload has completed
if (state.historyAction === 'POP' && !hasSeenPopAfterPageload) {
// Pageload ended: ignore the first POP after pageload
hasSeenPopAfterPageload = true;
} else {
// Pageload ended: either non-POP action or subsequent POP
isInitialPageloadComplete = true;
}
}
// If we haven't seen a pageload span yet, keep waiting (don't mark as complete)
}
Comment thread
cursor[bot] marked this conversation as resolved.
Comment thread
cursor[bot] marked this conversation as resolved.

const shouldHandleNavigation =
state.historyAction === 'PUSH' || (state.historyAction === 'POP' && isInitialPageloadComplete);

if (shouldHandleNavigation) {
const navigationHandler = (): void => {
handleNavigation({
location: state.location,
routes,
Expand All@@ -277,6 +294,13 @@ export function createV6CompatibleWrapCreateBrowserRouter<
basename,
allRoutes: Array.from(allRoutes),
});
};

// Wait for the next render if loading an unsettled route
if (state.navigation.state !== 'idle') {
requestAnimationFrame(navigationHandler);
} else {
navigationHandler();
}
}
});
Expand DownExpand Up@@ -327,7 +351,6 @@ export function createV6CompatibleWrapCreateMemoryRouter<
const router = createRouterFunction(routes, wrappedOpts);
const basename = opts?.basename;

const activeRootSpan = getActiveRootSpan();
let initialEntry = undefined;

const initialEntries = opts?.initialEntries;
Expand All@@ -348,21 +371,68 @@ export function createV6CompatibleWrapCreateMemoryRouter<
: initialEntry
: router.state.location;

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

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

// Track whether we've completed the initial pageload to properly distinguish
// between POPs that occur during pageload vs. legitimate back/forward navigation.
let isInitialPageloadComplete = false;
let hasSeenPageloadSpan = !!memoryActiveRootSpan && spanToJSON(memoryActiveRootSpan).op === 'pageload';
let hasSeenPopAfterPageload = false;

router.subscribe((state: RouterState) => {
// Track pageload completion to distinguish POPs during pageload from legitimate back/forward navigation
if (!isInitialPageloadComplete) {
const currentRootSpan = getActiveRootSpan();
const isCurrentlyInPageload = currentRootSpan && spanToJSON(currentRootSpan).op === 'pageload';

if (isCurrentlyInPageload) {
hasSeenPageloadSpan = true;
} else if (hasSeenPageloadSpan) {
// Pageload span was active but is now gone - pageload has completed
if (state.historyAction === 'POP' && !hasSeenPopAfterPageload) {
// Pageload ended: ignore the first POP after pageload
hasSeenPopAfterPageload = true;
} else {
// Pageload ended: either non-POP action or subsequent POP
isInitialPageloadComplete = true;
}
}
// If we haven't seen a pageload span yet, keep waiting (don't mark as complete)
}

const location = state.location;
if (state.historyAction === 'PUSH' || state.historyAction === 'POP') {
handleNavigation({
location,
routes,
navigationType: state.historyAction,
version,
basename,
allRoutes: Array.from(allRoutes),
});

const shouldHandleNavigation =
state.historyAction === 'PUSH' || (state.historyAction === 'POP' && isInitialPageloadComplete);

if (shouldHandleNavigation) {
Comment thread
cursor[bot] marked this conversation as resolved.
const navigationHandler = (): void => {
handleNavigation({
location,
routes,
navigationType: state.historyAction,
version,
basename,
allRoutes: Array.from(allRoutes),
});
};

// Wait for the next render if loading an unsettled route
if (state.navigation.state !== 'idle') {
requestAnimationFrame(navigationHandler);
} else {
navigationHandler();
}
}
});

Expand DownExpand Up@@ -532,8 +602,16 @@ function wrapPatchRoutesOnNavigation(
// Update navigation span after routes are patched
const activeRootSpan = getActiveRootSpan();
if (activeRootSpan && (spanToJSON(activeRootSpan) as { op?: string }).op === 'navigation') {
// For memory routers, we should not access window.location; use targetPath only
const pathname = isMemoryRouter ? targetPath : targetPath || WINDOW.location?.pathname;
// Determine pathname based on router type
let pathname: string | undefined;
if (isMemoryRouter) {
// For memory routers, only use targetPath
pathname = targetPath;
} else {
// For browser routers, use targetPath or fall back to window.location
pathname = targetPath || WINDOW.location?.pathname;
}

if (pathname) {
updateNavigationSpan(
activeRootSpan,
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,12 @@ const router = sentryCreateBrowserRouter(
lazyChildren: () => import('./pages/AnotherLazyRoutes').then(module => module.anotherNestedRoutes),
},
},
{
path: '/long-running',
handle: {
lazyChildren: () => import('./pages/LongRunningLazyRoutes').then(module => module.longRunningNestedRoutes),
},
},
{
path: '/static',
element: <>Hello World</>,
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,10 @@ const Index = () => {
<Link to="/another-lazy/sub/555/666" id="navigation-to-another-deep">
Navigate to Another Deep Lazy Route
</Link>
<br />
<Link to="/long-running/slow/12345" id="navigation-to-long-running">
Navigate to Long Running Lazy Route
</Link>
</>
);
};
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
import React, { useEffect, useState } from 'react';
import { Link, useParams } from 'react-router-dom';

// Component that simulates a long-running component load
// This is used to test the POP guard during long-running pageloads
const SlowLoadingComponent = () => {
const { id } = useParams<{ id: string }>();
const [data, setData] = useState<string | null>(null);
const [isLoading, setIsLoading] = useState(true);

useEffect(() => {
// Simulate a component that takes time to initialize
// This extends the pageload duration to create a window where POP events might occur
setTimeout(() => {
setData(`Data loaded for ID: ${id}`);
setIsLoading(false);
}, 1000);
}, [id]);

if (isLoading) {
return <div id="loading-indicator">Loading...</div>;
}

return (
<div id="slow-loading-content">
<div>{data}</div>
<Link to="/" id="navigate-home">
Go Home
</Link>
</div>
);
};

export const longRunningNestedRoutes = [
{
path: 'slow',
children: [
{
path: ':id',
element: <SlowLoadingComponent />,
loader: async () => {
// Simulate slow data fetching in the loader
await new Promise(resolve => setTimeout(resolve, 2000));
return null;
},
},
],
},
];
Original file line numberDiff line numberDiff line change
Expand Up@@ -294,3 +294,86 @@ test('Does not send any duplicate navigation transaction names browsing between
'/lazy/inner/:id/:anotherId',
]);
});

test('Does not create premature navigation transaction during long-running lazy route pageload', async ({ page }) => {
const navigationPromise = waitForTransaction('react-router-7-lazy-routes', async transactionEvent => {
return (
!!transactionEvent?.transaction &&
transactionEvent.contexts?.trace?.op === 'navigation' &&
transactionEvent.transaction.includes('long-running')
);
});

const pageloadPromise = waitForTransaction('react-router-7-lazy-routes', async transactionEvent => {
return (
!!transactionEvent?.transaction &&
transactionEvent.contexts?.trace?.op === 'pageload' &&
transactionEvent.transaction === '/long-running/slow/:id'
);
});

await page.goto('/long-running/slow/12345');

const pageloadEvent = await pageloadPromise;

expect(pageloadEvent.transaction).toBe('/long-running/slow/:id');
expect(pageloadEvent.contexts?.trace?.op).toBe('pageload');

const slowLoadingContent = page.locator('id=slow-loading-content');
await expect(slowLoadingContent).toBeVisible({ timeout: 5000 });

const result = await Promise.race([
navigationPromise.then(() => 'navigation'),
new Promise<'timeout'>(resolve => setTimeout(() => resolve('timeout'), 2000)),
]);

// Should timeout, meaning no unwanted navigation transaction was created
expect(result).toBe('timeout');
});

test('Allows legitimate POP navigation (back/forward) after pageload completes', async ({ page }) => {
await page.goto('/');

const navigationToLongRunning = page.locator('id=navigation-to-long-running');
await expect(navigationToLongRunning).toBeVisible();

const firstNavigationPromise = waitForTransaction('react-router-7-lazy-routes', async transactionEvent => {
return (
!!transactionEvent?.transaction &&
transactionEvent.contexts?.trace?.op === 'navigation' &&
transactionEvent.transaction === '/long-running/slow/:id'
);
});

await navigationToLongRunning.click();

const slowLoadingContent = page.locator('id=slow-loading-content');
await expect(slowLoadingContent).toBeVisible({ timeout: 5000 });

const firstNavigationEvent = await firstNavigationPromise;

expect(firstNavigationEvent.transaction).toBe('/long-running/slow/:id');
expect(firstNavigationEvent.contexts?.trace?.op).toBe('navigation');

// Now navigate back using browser back button (POP event)
// This should create a navigation transaction since pageload is complete
const backNavigationPromise = waitForTransaction('react-router-7-lazy-routes', async transactionEvent => {
return (
!!transactionEvent?.transaction &&
transactionEvent.contexts?.trace?.op === 'navigation' &&
transactionEvent.transaction === '/'
);
});

await page.goBack();

// Verify we're back at home
const homeLink = page.locator('id=navigation');
await expect(homeLink).toBeVisible();

const backNavigationEvent = await backNavigationPromise;

// Validate that the back navigation (POP) was properly tracked
expect(backNavigationEvent.transaction).toBe('/');
expect(backNavigationEvent.contexts?.trace?.op).toBe('navigation');
});
134 changes: 106 additions & 28 deletions packages/react/src/reactrouter-compat-utils/instrumentation.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -241,6 +241,12 @@ export function createV6CompatibleWrapCreateBrowserRouter<

const activeRootSpan = getActiveRootSpan();

// Track whether we've completed the initial pageload to properly distinguish
// between POPs that occur during pageload vs. legitimate back/forward navigation.
let isInitialPageloadComplete = false;
let hasSeenPageloadSpan = !!activeRootSpan && spanToJSON(activeRootSpan).op === 'pageload';
let hasSeenPopAfterPageload = false;

// The initial load ends when `createBrowserRouter` is called.
// This is the earliest convenient time to update the transaction name.
// Callbacks to `router.subscribe` are not called for the initial load.
Expand All@@ -255,20 +261,31 @@ export function createV6CompatibleWrapCreateBrowserRouter<
}

router.subscribe((state: RouterState) => {
if (state.historyAction === 'PUSH' || state.historyAction === 'POP') {
// 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 {
// Track pageload completion to distinguish POPs during pageload from legitimate back/forward navigation
if (!isInitialPageloadComplete) {
const currentRootSpan = getActiveRootSpan();
const isCurrentlyInPageload = currentRootSpan && spanToJSON(currentRootSpan).op === 'pageload';

if (isCurrentlyInPageload) {
hasSeenPageloadSpan = true;
} else if (hasSeenPageloadSpan) {
// Pageload span was active but is now gone - pageload has completed
if (state.historyAction === 'POP' && !hasSeenPopAfterPageload) {
// Pageload ended: ignore the first POP after pageload
hasSeenPopAfterPageload = true;
} else {
// Pageload ended: either non-POP action or subsequent POP
isInitialPageloadComplete = true;
}
}
// If we haven't seen a pageload span yet, keep waiting (don't mark as complete)
}
Comment thread
cursor[bot] marked this conversation as resolved.
Comment thread
cursor[bot] marked this conversation as resolved.

const shouldHandleNavigation =
state.historyAction === 'PUSH' || (state.historyAction === 'POP' && isInitialPageloadComplete);

if (shouldHandleNavigation) {
const navigationHandler = (): void => {
handleNavigation({
location: state.location,
routes,
Expand All@@ -277,6 +294,13 @@ export function createV6CompatibleWrapCreateBrowserRouter<
basename,
allRoutes: Array.from(allRoutes),
});
};

// Wait for the next render if loading an unsettled route
if (state.navigation.state !== 'idle') {
requestAnimationFrame(navigationHandler);
} else {
navigationHandler();
}
}
});
Expand DownExpand Up@@ -327,7 +351,6 @@ export function createV6CompatibleWrapCreateMemoryRouter<
const router = createRouterFunction(routes, wrappedOpts);
const basename = opts?.basename;

const activeRootSpan = getActiveRootSpan();
let initialEntry = undefined;

const initialEntries = opts?.initialEntries;
Expand All@@ -348,21 +371,68 @@ export function createV6CompatibleWrapCreateMemoryRouter<
: initialEntry
: router.state.location;

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

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

// Track whether we've completed the initial pageload to properly distinguish
// between POPs that occur during pageload vs. legitimate back/forward navigation.
let isInitialPageloadComplete = false;
let hasSeenPageloadSpan = !!memoryActiveRootSpan && spanToJSON(memoryActiveRootSpan).op === 'pageload';
let hasSeenPopAfterPageload = false;

router.subscribe((state: RouterState) => {
// Track pageload completion to distinguish POPs during pageload from legitimate back/forward navigation
if (!isInitialPageloadComplete) {
const currentRootSpan = getActiveRootSpan();
const isCurrentlyInPageload = currentRootSpan && spanToJSON(currentRootSpan).op === 'pageload';

if (isCurrentlyInPageload) {
hasSeenPageloadSpan = true;
} else if (hasSeenPageloadSpan) {
// Pageload span was active but is now gone - pageload has completed
if (state.historyAction === 'POP' && !hasSeenPopAfterPageload) {
// Pageload ended: ignore the first POP after pageload
hasSeenPopAfterPageload = true;
} else {
// Pageload ended: either non-POP action or subsequent POP
isInitialPageloadComplete = true;
}
}
// If we haven't seen a pageload span yet, keep waiting (don't mark as complete)
}

const location = state.location;
if (state.historyAction === 'PUSH' || state.historyAction === 'POP') {
handleNavigation({
location,
routes,
navigationType: state.historyAction,
version,
basename,
allRoutes: Array.from(allRoutes),
});

const shouldHandleNavigation =
state.historyAction === 'PUSH' || (state.historyAction === 'POP' && isInitialPageloadComplete);

if (shouldHandleNavigation) {
Comment thread
cursor[bot] marked this conversation as resolved.
const navigationHandler = (): void => {
handleNavigation({
location,
routes,
navigationType: state.historyAction,
version,
basename,
allRoutes: Array.from(allRoutes),
});
};

// Wait for the next render if loading an unsettled route
if (state.navigation.state !== 'idle') {
requestAnimationFrame(navigationHandler);
} else {
navigationHandler();
}
}
});

Expand DownExpand Up@@ -532,8 +602,16 @@ function wrapPatchRoutesOnNavigation(
// Update navigation span after routes are patched
const activeRootSpan = getActiveRootSpan();
if (activeRootSpan && (spanToJSON(activeRootSpan) as { op?: string }).op === 'navigation') {
// For memory routers, we should not access window.location; use targetPath only
const pathname = isMemoryRouter ? targetPath : targetPath || WINDOW.location?.pathname;
// Determine pathname based on router type
let pathname: string | undefined;
if (isMemoryRouter) {
// For memory routers, only use targetPath
pathname = targetPath;
} else {
// For browser routers, use targetPath or fall back to window.location
pathname = targetPath || WINDOW.location?.pathname;
}

if (pathname) {
updateNavigationSpan(
activeRootSpan,
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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line numberDiff line numberDiff line change
Expand Up@@ -55,6 +55,12 @@ const router = sentryCreateBrowserRouter(
lazyChildren: () => import('./pages/AnotherLazyRoutes').then(module => module.anotherNestedRoutes),
},
},
{
path: '/long-running',
handle: {
lazyChildren: () => import('./pages/LongRunningLazyRoutes').then(module => module.longRunningNestedRoutes),
},
},
{
path: '/static',
element: <>Hello World</>,
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,10 @@ const Index = () => {
<Link to="/another-lazy/sub/555/666" id="navigation-to-another-deep">
Navigate to Another Deep Lazy Route
</Link>
<br />
<Link to="/long-running/slow/12345" id="navigation-to-long-running">
Navigate to Long Running Lazy Route
</Link>
</>
);
};
Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
import React, { useEffect, useState } from 'react';
import { Link, useParams } from 'react-router-dom';

// Component that simulates a long-running component load
// This is used to test the POP guard during long-running pageloads
const SlowLoadingComponent = () => {
const { id } = useParams<{ id: string }>();
const [data, setData] = useState<string | null>(null);
const [isLoading, setIsLoading] = useState(true);

useEffect(() => {
// Simulate a component that takes time to initialize
// This extends the pageload duration to create a window where POP events might occur
setTimeout(() => {
setData(`Data loaded for ID: ${id}`);
setIsLoading(false);
}, 1000);
}, [id]);

if (isLoading) {
return <div id="loading-indicator">Loading...</div>;
}

return (
<div id="slow-loading-content">
<div>{data}</div>
<Link to="/" id="navigate-home">
Go Home
</Link>
</div>
);
};

export const longRunningNestedRoutes = [
{
path: 'slow',
children: [
{
path: ':id',
element: <SlowLoadingComponent />,
loader: async () => {
// Simulate slow data fetching in the loader
await new Promise(resolve => setTimeout(resolve, 2000));
return null;
},
},
],
},
];
Original file line numberDiff line numberDiff line change
Expand Up@@ -294,3 +294,86 @@ test('Does not send any duplicate navigation transaction names browsing between
'/lazy/inner/:id/:anotherId',
]);
});

test('Does not create premature navigation transaction during long-running lazy route pageload', async ({ page }) => {
const navigationPromise = waitForTransaction('react-router-7-lazy-routes', async transactionEvent => {
return (
!!transactionEvent?.transaction &&
transactionEvent.contexts?.trace?.op === 'navigation' &&
transactionEvent.transaction.includes('long-running')
);
});

const pageloadPromise = waitForTransaction('react-router-7-lazy-routes', async transactionEvent => {
return (
!!transactionEvent?.transaction &&
transactionEvent.contexts?.trace?.op === 'pageload' &&
transactionEvent.transaction === '/long-running/slow/:id'
);
});

await page.goto('/long-running/slow/12345');

const pageloadEvent = await pageloadPromise;

expect(pageloadEvent.transaction).toBe('/long-running/slow/:id');
expect(pageloadEvent.contexts?.trace?.op).toBe('pageload');

const slowLoadingContent = page.locator('id=slow-loading-content');
await expect(slowLoadingContent).toBeVisible({ timeout: 5000 });

const result = await Promise.race([
navigationPromise.then(() => 'navigation'),
new Promise<'timeout'>(resolve => setTimeout(() => resolve('timeout'), 2000)),
]);

// Should timeout, meaning no unwanted navigation transaction was created
expect(result).toBe('timeout');
});

test('Allows legitimate POP navigation (back/forward) after pageload completes', async ({ page }) => {
await page.goto('/');

const navigationToLongRunning = page.locator('id=navigation-to-long-running');
await expect(navigationToLongRunning).toBeVisible();

const firstNavigationPromise = waitForTransaction('react-router-7-lazy-routes', async transactionEvent => {
return (
!!transactionEvent?.transaction &&
transactionEvent.contexts?.trace?.op === 'navigation' &&
transactionEvent.transaction === '/long-running/slow/:id'
);
});

await navigationToLongRunning.click();

const slowLoadingContent = page.locator('id=slow-loading-content');
await expect(slowLoadingContent).toBeVisible({ timeout: 5000 });

const firstNavigationEvent = await firstNavigationPromise;

expect(firstNavigationEvent.transaction).toBe('/long-running/slow/:id');
expect(firstNavigationEvent.contexts?.trace?.op).toBe('navigation');

// Now navigate back using browser back button (POP event)
// This should create a navigation transaction since pageload is complete
const backNavigationPromise = waitForTransaction('react-router-7-lazy-routes', async transactionEvent => {
return (
!!transactionEvent?.transaction &&
transactionEvent.contexts?.trace?.op === 'navigation' &&
transactionEvent.transaction === '/'
);
});

await page.goBack();

// Verify we're back at home
const homeLink = page.locator('id=navigation');
await expect(homeLink).toBeVisible();

const backNavigationEvent = await backNavigationPromise;

// Validate that the back navigation (POP) was properly tracked
expect(backNavigationEvent.transaction).toBe('/');
expect(backNavigationEvent.contexts?.trace?.op).toBe('navigation');
});
134 changes: 106 additions & 28 deletions packages/react/src/reactrouter-compat-utils/instrumentation.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -241,6 +241,12 @@ export function createV6CompatibleWrapCreateBrowserRouter<

const activeRootSpan = getActiveRootSpan();

// Track whether we've completed the initial pageload to properly distinguish
// between POPs that occur during pageload vs. legitimate back/forward navigation.
let isInitialPageloadComplete = false;
let hasSeenPageloadSpan = !!activeRootSpan && spanToJSON(activeRootSpan).op === 'pageload';
let hasSeenPopAfterPageload = false;

// The initial load ends when `createBrowserRouter` is called.
// This is the earliest convenient time to update the transaction name.
// Callbacks to `router.subscribe` are not called for the initial load.
Expand All@@ -255,20 +261,31 @@ export function createV6CompatibleWrapCreateBrowserRouter<
}

router.subscribe((state: RouterState) => {
if (state.historyAction === 'PUSH' || state.historyAction === 'POP') {
// 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 {
// Track pageload completion to distinguish POPs during pageload from legitimate back/forward navigation
if (!isInitialPageloadComplete) {
const currentRootSpan = getActiveRootSpan();
const isCurrentlyInPageload = currentRootSpan && spanToJSON(currentRootSpan).op === 'pageload';

if (isCurrentlyInPageload) {
hasSeenPageloadSpan = true;
} else if (hasSeenPageloadSpan) {
// Pageload span was active but is now gone - pageload has completed
if (state.historyAction === 'POP' && !hasSeenPopAfterPageload) {
// Pageload ended: ignore the first POP after pageload
hasSeenPopAfterPageload = true;
} else {
// Pageload ended: either non-POP action or subsequent POP
isInitialPageloadComplete = true;
}
}
// If we haven't seen a pageload span yet, keep waiting (don't mark as complete)
}
Comment thread
cursor[bot] marked this conversation as resolved.
Comment thread
cursor[bot] marked this conversation as resolved.

const shouldHandleNavigation =
state.historyAction === 'PUSH' || (state.historyAction === 'POP' && isInitialPageloadComplete);

if (shouldHandleNavigation) {
const navigationHandler = (): void => {
handleNavigation({
location: state.location,
routes,
Expand All@@ -277,6 +294,13 @@ export function createV6CompatibleWrapCreateBrowserRouter<
basename,
allRoutes: Array.from(allRoutes),
});
};

// Wait for the next render if loading an unsettled route
if (state.navigation.state !== 'idle') {
requestAnimationFrame(navigationHandler);
} else {
navigationHandler();
}
}
});
Expand DownExpand Up@@ -327,7 +351,6 @@ export function createV6CompatibleWrapCreateMemoryRouter<
const router = createRouterFunction(routes, wrappedOpts);
const basename = opts?.basename;

const activeRootSpan = getActiveRootSpan();
let initialEntry = undefined;

const initialEntries = opts?.initialEntries;
Expand All@@ -348,21 +371,68 @@ export function createV6CompatibleWrapCreateMemoryRouter<
: initialEntry
: router.state.location;

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

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

// Track whether we've completed the initial pageload to properly distinguish
// between POPs that occur during pageload vs. legitimate back/forward navigation.
let isInitialPageloadComplete = false;
let hasSeenPageloadSpan = !!memoryActiveRootSpan && spanToJSON(memoryActiveRootSpan).op === 'pageload';
let hasSeenPopAfterPageload = false;

router.subscribe((state: RouterState) => {
// Track pageload completion to distinguish POPs during pageload from legitimate back/forward navigation
if (!isInitialPageloadComplete) {
const currentRootSpan = getActiveRootSpan();
const isCurrentlyInPageload = currentRootSpan && spanToJSON(currentRootSpan).op === 'pageload';

if (isCurrentlyInPageload) {
hasSeenPageloadSpan = true;
} else if (hasSeenPageloadSpan) {
// Pageload span was active but is now gone - pageload has completed
if (state.historyAction === 'POP' && !hasSeenPopAfterPageload) {
// Pageload ended: ignore the first POP after pageload
hasSeenPopAfterPageload = true;
} else {
// Pageload ended: either non-POP action or subsequent POP
isInitialPageloadComplete = true;
}
}
// If we haven't seen a pageload span yet, keep waiting (don't mark as complete)
}

const location = state.location;
if (state.historyAction === 'PUSH' || state.historyAction === 'POP') {
handleNavigation({
location,
routes,
navigationType: state.historyAction,
version,
basename,
allRoutes: Array.from(allRoutes),
});

const shouldHandleNavigation =
state.historyAction === 'PUSH' || (state.historyAction === 'POP' && isInitialPageloadComplete);

if (shouldHandleNavigation) {
Comment thread
cursor[bot] marked this conversation as resolved.
const navigationHandler = (): void => {
handleNavigation({
location,
routes,
navigationType: state.historyAction,
version,
basename,
allRoutes: Array.from(allRoutes),
});
};

// Wait for the next render if loading an unsettled route
if (state.navigation.state !== 'idle') {
requestAnimationFrame(navigationHandler);
} else {
navigationHandler();
}
}
});

Expand DownExpand Up@@ -532,8 +602,16 @@ function wrapPatchRoutesOnNavigation(
// Update navigation span after routes are patched
const activeRootSpan = getActiveRootSpan();
if (activeRootSpan && (spanToJSON(activeRootSpan) as { op?: string }).op === 'navigation') {
// For memory routers, we should not access window.location; use targetPath only
const pathname = isMemoryRouter ? targetPath : targetPath || WINDOW.location?.pathname;
// Determine pathname based on router type
let pathname: string | undefined;
if (isMemoryRouter) {
// For memory routers, only use targetPath
pathname = targetPath;
} else {
// For browser routers, use targetPath or fall back to window.location
pathname = targetPath || WINDOW.location?.pathname;
}

if (pathname) {
updateNavigationSpan(
activeRootSpan,
Expand Down