ref(nextjs): Pass the route provider as the routeProvider option

Author: logaretm

packages/nextjs/src/client/index.ts

@@ -12,7 +12,7 @@ import { isRedirectNavigationError } from '../common/nextNavigationErrorUtils';
 import { browserTracingIntegration } from './browserTracingIntegration';
 import { nextjsClientStackFrameNormalizationIntegration } from './clientNormalizationIntegration';
 import { removeIsrSsgTraceMetaTags } from './routing/isrRoutingTracing';
-import { nextjsRouteProviderIntegration } from './routing/routeProvider';
+import { createNextRouteProvider } from './routing/routeProvider';
 import { applyTunnelRouteOption } from './tunnelRoute';
 
 export * from '@sentry/react';
@@ -66,6 +66,9 @@ export function init(options: BrowserOptions): Client | undefined {
     environment: options.environment || process.env.SENTRY_ENVIRONMENT || getClientVercelEnv() || process.env.NODE_ENV,
     defaultIntegrations: getDefaultIntegrations(options),
     release: process.env._sentryRelease || globalWithInjectedValues._sentryRelease,
+    // Both route manifests are injected at build time, so route parameterization works from `init` on,
+    // including for the pageload span and with tracing disabled.
+    routeProvider: createNextRouteProvider(),
     ...options,
   } satisfies BrowserOptions;
 
@@ -106,7 +109,6 @@ export function init(options: BrowserOptions): Client | undefined {
 
 function getDefaultIntegrations(options: BrowserOptions): Integration[] {
   const customDefaultIntegrations = getReactDefaultIntegrations(options);
-  customDefaultIntegrations.push(nextjsRouteProviderIntegration());
   // This evaluates to true unless __SENTRY_TRACING__ is text-replaced with "false",
   // in which case everything inside will get tree-shaken away
   if (typeof __SENTRY_TRACING__ === 'undefined' || __SENTRY_TRACING__) {

packages/nextjs/src/client/routing/routeProvider.ts

@@ -1,6 +1,5 @@
-import { defineIntegration } from '@sentry/core';
 import type { RouteProvider } from '@sentry/react';
-import { createUrlRouteProvider, setRouteProvider } from '@sentry/react';
+import { createUrlRouteProvider } from '@sentry/react';
 import { maybeParameterizeRoute, stripBasePath, stripTrailingSlash } from './parameterization';
 import { getNextRouteFromPathname } from './pagesRouterRoutingInstrumentation';
 
@@ -25,18 +24,3 @@ function resolveNextRoute(url: { pathname: string }): string | undefined {
 export function createNextRouteProvider(): RouteProvider {
   return createUrlRouteProvider(resolveNextRoute);
 }
-
-/**
- * Registers the Next.js route provider.
- *
- * An integration rather than part of `browserTracingIntegration` so route parameterization does not depend
- * on tracing: the route manifests are injected at build time, so anything that needs a route name (bfcache
- * metrics, web vitals) can resolve one even with tracing disabled. Registered in `setup` because the pageload
- * span is named in `browserTracingIntegration`'s `afterAllSetup`.
- */
-export const nextjsRouteProviderIntegration = defineIntegration(() => ({
-  name: 'NextjsRouteProvider',
-  setup(client) {
-    setRouteProvider(createNextRouteProvider(), client);
-  },
-}));

packages/nextjs/test/client/appRouterRoutingInstrumentation.test.ts

@@ -79,10 +79,8 @@ async function setup(traceLifecycle: 'stream' | 'static'): Promise<{
     stackParser: () => [],
     tracesSampleRate: 1,
     traceLifecycle,
-    integrations: [
-      routeProvider.nextjsRouteProviderIntegration(),
-      react.browserTracingIntegration({ instrumentPageLoad: false, instrumentNavigation: false }),
-    ],
+    routeProvider: routeProvider.createNextRouteProvider(),
+    integrations: [react.browserTracingIntegration({ instrumentPageLoad: false, instrumentNavigation: false })],
   });
   core.setCurrentClient(client);
   client.init();

packages/nextjs/test/clientSdk.test.ts

@@ -210,6 +210,14 @@ describe('Client init()', () => {
         delete globalWithManifest._sentryRouteManifest;
       });
 
+      it('keeps a route provider passed by the user', () => {
+        const routeProvider = { resolveRoute: () => '/custom', resolveCurrentRoute: () => '/custom' };
+
+        init({ dsn: TEST_DSN, routeProvider });
+
+        expect(reactInit).toHaveBeenCalledWith(expect.objectContaining({ routeProvider }));
+      });
+
       it("doesn't run Next.js router instrumentation for bot user agents", () => {
         Object.defineProperty(WINDOW, 'navigator', {
           value: {