Skip to content

fix(tracing): Don't finish React Router 6 pageload transactions early #6599

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

fix(tracing): Don't finish React Router 6 pageload transactions early #6599

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 9 additions & 15 deletions packages/react/src/reactrouterv6.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,17 +131,8 @@ function handleNavigation(
location: Location,
routes: RouteObject[],
navigationType: Action,
isBaseLocation: boolean,
matches?: AgnosticDataRouteMatch,
): void {
if (isBaseLocation) {
if (activeTransaction) {
activeTransaction.finish();
}

return;
}

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

if (_startTransactionOnLocationChange && (navigationType === 'PUSH' || navigationType === 'POP') && branches) {
Expand Down Expand Up @@ -179,12 +170,12 @@ export function withSentryReactRouterV6Routing<P extends Record<string, any>, R
return Routes;
}

let isBaseLocation: boolean = false;
let routes: RouteObject[];

const SentryRoutes: React.FC<P> = (props: P) => {
const location = _useLocation();
const navigationType = _useNavigationType();
let isBaseLocation: boolean = false;

_useEffect(() => {
// Performance concern:
Expand All @@ -197,7 +188,9 @@ export function withSentryReactRouterV6Routing<P extends Record<string, any>, R
}, [props.children]);

_useEffect(() => {
handleNavigation(location, routes, navigationType, isBaseLocation);
if (!isBaseLocation) {
handleNavigation(location, routes, navigationType);
}
}, [props.children, location, navigationType, isBaseLocation]);

isBaseLocation = false;
Expand All @@ -224,8 +217,6 @@ export function wrapUseRoutes(origUseRoutes: UseRoutes): UseRoutes {
return origUseRoutes;
}

let isBaseLocation: boolean = false;

// eslint-disable-next-line react/display-name
return (routes: RouteObject[], location?: Partial<Location> | string): React.ReactElement | null => {
const SentryRoutes: React.FC<unknown> = (props: unknown) => {
Expand All @@ -234,6 +225,7 @@ export function wrapUseRoutes(origUseRoutes: UseRoutes): UseRoutes {
const locationArgObject = typeof location === 'string' ? { pathname: location } : location;
const locationObject = (locationArgObject as Location) || _useLocation();
const navigationType = _useNavigationType();
let isBaseLocation: boolean = false;

_useEffect(() => {
isBaseLocation = true;
Expand All @@ -242,7 +234,9 @@ export function wrapUseRoutes(origUseRoutes: UseRoutes): UseRoutes {
}, [props]);

_useEffect(() => {
handleNavigation(locationObject, routes, navigationType, isBaseLocation);
if (!isBaseLocation) {
handleNavigation(locationObject, routes, navigationType);
}
}, [props, locationObject, navigationType, isBaseLocation]);

isBaseLocation = false;
Expand Down Expand Up @@ -275,7 +269,7 @@ export function wrapCreateBrowserRouter(createRouterFunction: CreateRouterFuncti
(state.historyAction === 'PUSH' || state.historyAction === 'POP') &&
activeTransaction
) {
handleNavigation(location, routes, state.historyAction, false);
handleNavigation(location, routes, state.historyAction);
}
});

Expand Down