Add options to disable or configure ErrorBoundary.

Author: onurtemizkan

packages/react/src/index.ts

@@ -2,7 +2,7 @@ export * from '@sentry/browser';
 
 export { init } from './sdk';
 export { Profiler, withProfiler, useProfiler } from './profiler';
-export type { FallbackRender } from './errorboundary';
+export type { ErrorBoundaryProps, FallbackRender } from './errorboundary';
 export { ErrorBoundary, withErrorBoundary } from './errorboundary';
 export { createReduxEnhancer } from './redux';
 export { reactRouterV3Instrumentation } from './reactrouterv3';

packages/remix/README.md

@@ -90,7 +90,12 @@ function App() {
   );
 }
 
-export default withSentryRouteTracing(App);
+export default withSentryRouteTracing(App, {
+  wrapWithErrorBoundary: false // default: true
+  errorBoundaryOptions: {
+    fallback: <p>An error has occurred</p>
+  } // optional
+});
 ```
 
 To set context information or send manual events, use the exported functions of `@sentry/remix`.

packages/remix/src/performance/client.tsx

@@ -1,3 +1,4 @@
+import type { ErrorBoundaryProps } from '@sentry/react';
 import { withErrorBoundary } from '@sentry/react';
 import { Transaction, TransactionContext } from '@sentry/types';
 import { getGlobalObject, logger } from '@sentry/utils';
@@ -81,14 +82,23 @@ export function remixRouterInstrumentation(useEffect: UseEffect, useLocation: Us
  * Wraps a remix `root` (see: https://remix.run/docs/en/v1/guides/migrating-react-router-app#creating-the-root-route)
  * To enable pageload/navigation tracing on every route.
  */
-export function withSentryRouteTracing<P extends Record<string, unknown>, R extends React.FC<P>>(OrigApp: R): R {
+export function withSentryRouteTracing<P extends Record<string, unknown>, R extends React.FC<P>>(
+  OrigApp: R,
+  options: {
+    wrapWithErrorBoundary?: boolean;
+    errorBoundaryOptions?: ErrorBoundaryProps;
+  } = {
+    wrapWithErrorBoundary: true,
+    errorBoundaryOptions: {},
+  },
+): R {
   // Early return when any of the required functions is not available.
   if (!_useEffect || !_useLocation || !_useMatches || !_customStartTransaction) {
     __DEBUG_BUILD__ && logger.warn('Remix SDK was unable to wrap your root because of one or more missing parameters.');
 
     // @ts-ignore Setting more specific React Component typing for `R` generic above
     // will break advanced type inference done by react router params
-    return withErrorBoundary(OrigApp);
+    return OrigApp;
     // Note: Error boundary doesn't depend on any of these functions, so we can return the wrapped component.
   }
 
@@ -135,7 +145,13 @@ export function withSentryRouteTracing<P extends Record<string, unknown>, R exte
     return <OrigApp {...props} />;
   };
 
+  if (options.wrapWithErrorBoundary) {
+    // @ts-ignore Setting more specific React Component typing for `R` generic above
+    // will break advanced type inference done by react router params
+    return withErrorBoundary(SentryRoot, options.errorBoundaryOptions);
+  }
+
   // @ts-ignore Setting more specific React Component typing for `R` generic above
   // will break advanced type inference done by react router params
-  return withErrorBoundary(SentryRoot);
+  return SentryRoot;
 }