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
feat(nextjs): Add client routing instrumentation for app router#9446
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
Show all changes
13 commits
Select commit
Hold shift + click to select a range
bc782ca
feat(nextjs): Add client routing instrumentation for app router
491d6a7
mvp
c4cae8e
Restructuring
45bdbb2
cleanup
2d81468
Fix tests
461e81f
Add e2e test
e6da6a4
Rename test file
ce3e2bf
Add unit tests
5c30fd1
Fix tests
5b44ede
test
678ac67
test
3870b17
Add origin
724ec23
ci
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
52 changes: 52 additions & 0 deletions
52 ...e-tests/test-applications/nextjs-app-dir/tests/client-app-routing-instrumentation.test.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 |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| import { test, expect } from '@playwright/test'; | ||
| import { waitForTransaction } from '../event-proxy-server'; | ||
| test('Creates a pageload transaction for app router routes', async ({ page }) => { | ||
| const randomRoute = String(Math.random()); | ||
| const clientPageloadTransactionPromise = waitForTransaction('nextjs-13-app-dir', transactionEvent => { | ||
| return ( | ||
| transactionEvent?.transaction === `/server-component/parameter/${randomRoute}` && | ||
| transactionEvent.contexts?.trace?.op === 'pageload' | ||
| ); | ||
| }); | ||
| await page.goto(`/server-component/parameter/${randomRoute}`); | ||
| expect(await clientPageloadTransactionPromise).toBeDefined(); | ||
| }); | ||
| test('Creates a navigation transaction for app router routes', async ({ page }) => { | ||
| const randomRoute = String(Math.random()); | ||
| const clientPageloadTransactionPromise = waitForTransaction('nextjs-13-app-dir', transactionEvent => { | ||
| return ( | ||
| transactionEvent?.transaction === `/server-component/parameter/${randomRoute}` && | ||
| transactionEvent.contexts?.trace?.op === 'pageload' | ||
| ); | ||
| }); | ||
| await page.goto(`/server-component/parameter/${randomRoute}`); | ||
| await clientPageloadTransactionPromise; | ||
| await page.getByText('Page (/server-component/parameter/[parameter])').isVisible(); | ||
| const clientNavigationTransactionPromise = waitForTransaction('nextjs-13-app-dir', transactionEvent => { | ||
| return ( | ||
| transactionEvent?.transaction === '/server-component/parameter/foo/bar/baz' && | ||
| transactionEvent.contexts?.trace?.op === 'navigation' | ||
| ); | ||
| }); | ||
| const servercomponentTransactionPromise = waitForTransaction('nextjs-13-app-dir', async transactionEvent => { | ||
| return ( | ||
| transactionEvent?.transaction === 'Page Server Component (/server-component/parameter/[...parameters])' && | ||
| (await clientNavigationTransactionPromise).contexts?.trace?.trace_id === | ||
| transactionEvent.contexts?.trace?.trace_id | ||
| ); | ||
| }); | ||
| await page.getByText('/server-component/parameter/foo/bar/baz').click(); | ||
| expect(await clientNavigationTransactionPromise).toBeDefined(); | ||
| expect(await servercomponentTransactionPromise).toBeDefined(); | ||
| }); |
30 changes: 0 additions & 30 deletions
30 packages/e2e-tests/test-applications/nextjs-app-dir/tests/trace.test.ts
This file was deleted.
Oops, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
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
113 changes: 113 additions & 0 deletions
113 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 |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| import { WINDOW } from '@sentry/react'; | ||
| import type { HandlerDataFetch, Primitive, Transaction, TransactionContext } from '@sentry/types'; | ||
| import { addInstrumentationHandler, browserPerformanceTimeOrigin } from '@sentry/utils'; | ||
| type StartTransactionCb = (context: TransactionContext) => Transaction | undefined; | ||
| const DEFAULT_TAGS = { | ||
| 'routing.instrumentation': 'next-app-router', | ||
| } as const; | ||
| /** | ||
| * Instruments the Next.js Clientside App Router. | ||
| */ | ||
| export function appRouterInstrumentation( | ||
| startTransactionCb: StartTransactionCb, | ||
| startTransactionOnPageLoad: boolean = true, | ||
| startTransactionOnLocationChange: boolean = true, | ||
| ): void { | ||
| // We keep track of the active transaction so we can finish it when we start a navigation transaction. | ||
| let activeTransaction: Transaction | undefined = undefined; | ||
| // We keep track of the previous location name so we can set the `from` field on navigation transactions. | ||
| // This is either a route or a pathname. | ||
| let prevLocationName = WINDOW.location.pathname; | ||
| if (startTransactionOnPageLoad) { | ||
| activeTransaction = startTransactionCb({ | ||
| name: prevLocationName, | ||
| op: 'pageload', | ||
| origin: 'auto.pageload.nextjs.app_router_instrumentation', | ||
| tags: DEFAULT_TAGS, | ||
| // pageload should always start at timeOrigin (and needs to be in s, not ms) | ||
| startTimestamp: browserPerformanceTimeOrigin ? browserPerformanceTimeOrigin / 1000 : undefined, | ||
| metadata: { source: 'url' }, | ||
| }); | ||
| } | ||
| if (startTransactionOnLocationChange) { | ||
| addInstrumentationHandler('fetch', (handlerData: HandlerDataFetch) => { | ||
| // The instrumentation handler is invoked twice - once for starting a request and once when the req finishes | ||
| // We can use the existence of the end-timestamp to filter out "finishing"-events. | ||
| if (handlerData.endTimestamp !== undefined) { | ||
| return; | ||
| } | ||
| // Only GET requests can be navigating RSC requests | ||
| if (handlerData.fetchData.method !== 'GET') { | ||
| return; | ||
| } | ||
| const parsedNavigatingRscFetchArgs = parseNavigatingRscFetchArgs(handlerData.args); | ||
| if (parsedNavigatingRscFetchArgs === null) { | ||
| return; | ||
| } | ||
| const transactionName = parsedNavigatingRscFetchArgs.targetPathname; | ||
| const tags: Record<string, Primitive> = { | ||
| ...DEFAULT_TAGS, | ||
| from: prevLocationName, | ||
| }; | ||
| prevLocationName = transactionName; | ||
| if (activeTransaction) { | ||
| activeTransaction.finish(); | ||
| } | ||
| startTransactionCb({ | ||
| name: transactionName, | ||
| op: 'navigation', | ||
lforst marked this conversation as resolved.
Uh oh!There was an error while loading. Please reload this page. | ||
| origin: 'auto.navigation.nextjs.app_router_instrumentation', | ||
| tags, | ||
| metadata: { source: 'url' }, | ||
| }); | ||
| }); | ||
| } | ||
| } | ||
| function parseNavigatingRscFetchArgs(fetchArgs: unknown[]): null | { | ||
| targetPathname: string; | ||
| } { | ||
| // Make sure the first arg is a URL object | ||
| if (!fetchArgs[0] || typeof fetchArgs[0] !== 'object' || (fetchArgs[0] as URL).searchParams === undefined) { | ||
| return null; | ||
| } | ||
| // Make sure the second argument is some kind of fetch config obj that contains headers | ||
| if (!fetchArgs[1] || typeof fetchArgs[1] !== 'object' || !('headers' in fetchArgs[1])) { | ||
| return null; | ||
| } | ||
| try { | ||
| const url = fetchArgs[0] as URL; | ||
| const headers = fetchArgs[1].headers as Record<string, string>; | ||
| // Not an RSC request | ||
| if (headers['RSC'] !== '1') { | ||
| return null; | ||
| } | ||
| // Prefetch requests are not navigating RSC requests | ||
| if (headers['Next-Router-Prefetch'] === '1') { | ||
| return null; | ||
| } | ||
| return { | ||
| targetPathname: url.pathname, | ||
| }; | ||
| } catch { | ||
| return null; | ||
| } | ||
| } | ||
23 changes: 23 additions & 0 deletions
23 packages/nextjs/src/client/routing/nextRoutingInstrumentation.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 |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| import { WINDOW } from '@sentry/react'; | ||
| import type { Transaction, TransactionContext } from '@sentry/types'; | ||
| import { appRouterInstrumentation } from './appRouterRoutingInstrumentation'; | ||
| import { pagesRouterInstrumentation } from './pagesRouterRoutingInstrumentation'; | ||
| type StartTransactionCb = (context: TransactionContext) => Transaction | undefined; | ||
| /** | ||
| * Instruments the Next.js Clientside Router. | ||
| */ | ||
| export function nextRouterInstrumentation( | ||
| startTransactionCb: StartTransactionCb, | ||
| startTransactionOnPageLoad: boolean = true, | ||
| startTransactionOnLocationChange: boolean = true, | ||
| ): void { | ||
| const isAppRouter = !WINDOW.document.getElementById('__NEXT_DATA__'); | ||
| if (isAppRouter) { | ||
| appRouterInstrumentation(startTransactionCb, startTransactionOnPageLoad, startTransactionOnLocationChange); | ||
| } else { | ||
| pagesRouterInstrumentation(startTransactionCb, startTransactionOnPageLoad, startTransactionOnLocationChange); | ||
| } | ||
| } |
19 changes: 14 additions & 5 deletions
19 packages/nextjs/src/client/performance.ts → ...ting/pagesRouterRoutingInstrumentation.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
Oops, something went wrong.
Uh oh!
There was an error while loading. Please reload this page.
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.