Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork 1.8k
fix(nextjs): Re-patch router if it is overriden by Next.js#15721
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Uh oh!
There was an error while loading. Please reload this page.
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading. Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading. Please reload this page.
Diff view
Diff view
There are no files selected for viewing
104 changes: 69 additions & 35 deletions
104 packages/nextjs/src/client/routing/appRouterRoutingInstrumentation.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -24,6 +24,10 @@ export function appRouterInstrumentPageLoad(client: Client): void { | ||
| }); | ||
| } | ||
| interface NavigationSpanRef { | ||
| current: Span | undefined; | ||
| } | ||
| interface NextRouter { | ||
| back: () => void; | ||
| forward: () => void; | ||
| @@ -57,14 +61,14 @@ const GLOBAL_OBJ_WITH_NEXT_ROUTER = GLOBAL_OBJ as typeof GLOBAL_OBJ & { | ||
| /** Instruments the Next.js app router for navigation. */ | ||
| export function appRouterInstrumentNavigation(client: Client): void { | ||
| let currentNavigationSpan: Span | undefined = undefined; | ||
| const currentNavigationSpanRef: NavigationSpanRef = { current: undefined }; | ||
lforst marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. | ||
| WINDOW.addEventListener('popstate', () => { | ||
| if (currentNavigationSpan?.isRecording()) { | ||
| currentNavigationSpan.updateName(WINDOW.location.pathname); | ||
| currentNavigationSpan.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, 'url'); | ||
| if (currentNavigationSpanRef.current?.isRecording()) { | ||
| currentNavigationSpanRef.current.updateName(WINDOW.location.pathname); | ||
| currentNavigationSpanRef.current.setAttribute(SEMANTIC_ATTRIBUTE_SENTRY_SOURCE, 'url'); | ||
| } else { | ||
| currentNavigationSpan = startBrowserTracingNavigationSpan(client, { | ||
| currentNavigationSpanRef.current = startBrowserTracingNavigationSpan(client, { | ||
| name: WINDOW.location.pathname, | ||
| attributes: { | ||
| [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation', | ||
| @@ -89,38 +93,22 @@ export function appRouterInstrumentNavigation(client: Client): void { | ||
| } else if (router) { | ||
| clearInterval(checkForRouterAvailabilityInterval); | ||
| routerPatched = true; | ||
| (['back', 'forward', 'push', 'replace'] as const).forEach(routerFunctionName => { | ||
| if (router?.[routerFunctionName]) { | ||
| // @ts-expect-error Weird type error related to not knowing how to associate return values with the individual functions - we can just ignore | ||
| router[routerFunctionName] = new Proxy(router[routerFunctionName], { | ||
| apply(target, thisArg, argArray) { | ||
| let transactionName = INCOMPLETE_APP_ROUTER_INSTRUMENTATION_TRANSACTION_NAME; | ||
| const transactionAttributes: Record<string, string> = { | ||
| [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation', | ||
| [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.navigation.nextjs.app_router_instrumentation', | ||
| [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url', | ||
| }; | ||
| if (routerFunctionName === 'push') { | ||
| transactionName = transactionNameifyRouterArgument(argArray[0]); | ||
| transactionAttributes[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE] = 'url'; | ||
| transactionAttributes['navigation.type'] = 'router.push'; | ||
| } else if (routerFunctionName === 'replace') { | ||
| transactionName = transactionNameifyRouterArgument(argArray[0]); | ||
| transactionAttributes[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE] = 'url'; | ||
| transactionAttributes['navigation.type'] = 'router.replace'; | ||
| } else if (routerFunctionName === 'back') { | ||
| transactionAttributes['navigation.type'] = 'router.back'; | ||
| } else if (routerFunctionName === 'forward') { | ||
| transactionAttributes['navigation.type'] = 'router.forward'; | ||
| } | ||
| currentNavigationSpan = startBrowserTracingNavigationSpan(client, { | ||
| name: transactionName, | ||
| attributes: transactionAttributes, | ||
| }); | ||
| patchRouter(client, router, currentNavigationSpanRef); | ||
| // If the router at any point gets overridden - patch again | ||
| (['nd', 'next'] as const).forEach(globalValueName => { | ||
| const globalValue = GLOBAL_OBJ_WITH_NEXT_ROUTER[globalValueName]; | ||
lforst marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. | ||
| if (globalValue) { | ||
| GLOBAL_OBJ_WITH_NEXT_ROUTER[globalValueName] = new Proxy(globalValue, { | ||
| set(target, p, newValue) { | ||
| if (p === 'router' && typeof newValue === 'object' && newValue !== null) { | ||
| patchRouter(client, newValue, currentNavigationSpanRef); | ||
| } | ||
| return target.apply(thisArg, argArray); | ||
| // @ts-expect-error we cannot possibly type this | ||
| target[p] = newValue; | ||
| return true; | ||
| }, | ||
| }); | ||
| } | ||
| @@ -137,3 +125,49 @@ function transactionNameifyRouterArgument(target: string): string { | ||
| return '/'; | ||
| } | ||
| } | ||
| const patchedRouters = new WeakSet<NextRouter>(); | ||
| function patchRouter(client: Client, router: NextRouter, currentNavigationSpanRef: NavigationSpanRef): void { | ||
| if (patchedRouters.has(router)) { | ||
| return; | ||
| } | ||
| patchedRouters.add(router); | ||
| (['back', 'forward', 'push', 'replace'] as const).forEach(routerFunctionName => { | ||
| if (router?.[routerFunctionName]) { | ||
| // @ts-expect-error Weird type error related to not knowing how to associate return values with the individual functions - we can just ignore | ||
lforst marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. | ||
| router[routerFunctionName] = new Proxy(router[routerFunctionName], { | ||
| apply(target, thisArg, argArray) { | ||
| let transactionName = INCOMPLETE_APP_ROUTER_INSTRUMENTATION_TRANSACTION_NAME; | ||
| const transactionAttributes: Record<string, string> = { | ||
| [SEMANTIC_ATTRIBUTE_SENTRY_OP]: 'navigation', | ||
| [SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.navigation.nextjs.app_router_instrumentation', | ||
| [SEMANTIC_ATTRIBUTE_SENTRY_SOURCE]: 'url', | ||
| }; | ||
| if (routerFunctionName === 'push') { | ||
| transactionName = transactionNameifyRouterArgument(argArray[0]); | ||
| transactionAttributes[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE] = 'url'; | ||
| transactionAttributes['navigation.type'] = 'router.push'; | ||
| } else if (routerFunctionName === 'replace') { | ||
| transactionName = transactionNameifyRouterArgument(argArray[0]); | ||
| transactionAttributes[SEMANTIC_ATTRIBUTE_SENTRY_SOURCE] = 'url'; | ||
| transactionAttributes['navigation.type'] = 'router.replace'; | ||
| } else if (routerFunctionName === 'back') { | ||
| transactionAttributes['navigation.type'] = 'router.back'; | ||
| } else if (routerFunctionName === 'forward') { | ||
| transactionAttributes['navigation.type'] = 'router.forward'; | ||
| } | ||
| currentNavigationSpanRef.current = startBrowserTracingNavigationSpan(client, { | ||
| name: transactionName, | ||
| attributes: transactionAttributes, | ||
lforst marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. | ||
| }); | ||
| return target.apply(thisArg, argArray); | ||
| }, | ||
| }); | ||
| } | ||
| }); | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.