withErrorBoundary create unnecessary rerenders

[OoDeLally]

Is there an existing issue for this?

• I have checked for existing issues https://github.com/getsentry/sentry-javascript/issues
• I have reviewed the documentation https://docs.sentry.io/
• I am using the latest SDK release https://github.com/getsentry/sentry-javascript/releases

How do you use Sentry?

Sentry Saas (sentry.io)

Which SDK are you using?

@sentry/react

SDK Version

8.55.0

Framework Version

8.55.0

Link to Sentry event

No response

Reproduction Example/SDK Setup

export const MyScreenWithFallback = Sentry.withErrorBoundary(MyScreen, {
  fallback: FatalErrorFallback,
});

Steps to Reproduce

1. Run this with dummy components

Expected Result

MyScreenWithFallback does not rerender when props are identical.

Actual Result

MyScreenWithFallback rerenders everytime.

Workaround

export const MyScreenWithFallback = React.memo(Sentry.withErrorBoundary(MyScreen, {
  fallback: FatalErrorFallback,
}));

Real solution

function withErrorBoundary(
  WrappedComponent,
  errorBoundaryOptions,
) {
  const componentDisplayName = WrappedComponent.displayName || WrappedComponent.name || UNKNOWN_COMPONENT;
  const Wrapped = React.memo(((props) => React.createElement(ErrorBoundary, { ...errorBoundaryOptions,}
      , React.createElement(WrappedComponent, { ...props,} )
    )
  ));

  Wrapped.displayName = `errorBoundary(${componentDisplayName})`;

  // Copy over static methods from Wrapped component to Profiler HOC
  // See: https://reactjs.org/docs/higher-order-components.html#static-methods-must-be-copied-over
  hoistNonReactStatics(Wrapped, WrappedComponent);
  return Wrapped;
}

[linear]

JS-779 withErrorBoundary create unnecessary rerenders

[chargome]

Hey @OoDeLally would you mind upgrading the SDK to the latest version and check if the issue persists?

[OoDeLally]

Hello, thanks for your answer.
Unfortunately, I am using @sentry/react-native which has a fixed dependency on @sentry/react@8.55.0.
However I had a look at @sentry/react@9.42.0's dist, and the code looks the same as in 8.55.0, so I assume the behavior would be the same.

[chargome]

@OoDeLally thanks for investigating – I'll have a look!