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

Author: logaretm

packages/remix/src/client/sdk.ts

@@ -1,6 +1,6 @@
 import type { Client } from '@sentry/core';
 import { applySdkMetadata } from '@sentry/core';
-import { init as reactInit, setRouteProvider } from '@sentry/react';
+import { init as reactInit } from '@sentry/react';
 import type { RemixOptions } from '../utils/remixOptions';
 import { createRemixRouteProvider } from './routeProvider';
 
@@ -11,18 +11,14 @@ import { createRemixRouteProvider } from './routeProvider';
  */
 export function init(options: RemixOptions): Client | undefined {
   const opts = {
+    // The manifest is injected at build time, so route parameterization works from `init` on, even with
+    // tracing disabled.
+    routeProvider: createRemixRouteProvider(),
     ...options,
     environment: options.environment || process.env.NODE_ENV,
   };
 
   applySdkMetadata(opts, 'remix', ['remix', 'react']);
 
-  const client = reactInit(opts);
-
-  // Registered here rather than from the tracing integration so route parameterization does not
-  // depend on tracing: the manifest is injected at build time, so anything that needs a route name
-  // (bfcache metrics, web vitals) can resolve one even with tracing disabled.
-  setRouteProvider(createRemixRouteProvider(), client);
-
-  return client;
+  return reactInit(opts);
 }

packages/remix/test/index.client.test.ts

@@ -43,6 +43,17 @@ describe('Client init()', () => {
     );
   });
 
+  it('passes the Remix route provider unless the user passed one', () => {
+    init({});
+    expect(reactInit).toHaveBeenLastCalledWith(
+      expect.objectContaining({ routeProvider: expect.objectContaining({ resolveRoute: expect.any(Function) }) }),
+    );
+
+    const routeProvider = { resolveRoute: () => '/custom', resolveCurrentRoute: () => '/custom' };
+    init({ routeProvider });
+    expect(reactInit).toHaveBeenLastCalledWith(expect.objectContaining({ routeProvider }));
+  });
+
   it('returns client from init', () => {
     expect(init({})).not.toBeUndefined();
   });