fix(callbacks): Fix configureScope is safe (#2510)

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## Unreleased
+
+### Fixes
+
+- Make `configureScope` callback safe [#2510](https://github.com/getsentry/sentry-react-native/pull/2510)
+
 ## 4.6.0
 
 ### Fixes

src/js/index.ts

@@ -17,7 +17,6 @@ export {
   captureException,
   captureEvent,
   captureMessage,
-  configureScope,
   getHubFromCarrier,
   getCurrentHub,
   Hub,
@@ -66,6 +65,7 @@ export {
   close,
   captureUserFeedback,
   withScope,
+  configureScope,
 } from './sdk';
 export { TouchEventBoundary, withTouchEventBoundary } from './touchevents';
 

src/js/sdk.tsx

@@ -262,3 +262,18 @@ export function withScope(callback: (scope: Scope) => void): ReturnType<Hub['wit
   };
   getCurrentHub().withScope(safeCallback);
 }
+
+/**
+ * Callback to set context information onto the scope.
+ * @param callback Callback function that receives Scope.
+ */
+ export function configureScope(callback: (scope: Scope) => void): ReturnType<Hub['configureScope']> {
+  const safeCallback = (scope: Scope): void => {
+    try {
+      callback(scope);
+    } catch (e) {
+      logger.error('Error while running configureScope callback', e);
+    }
+  };
+  getCurrentHub().configureScope(safeCallback);
+}

test/client.test.ts

@@ -13,7 +13,6 @@ import {
   envelopeItemPayload,
   envelopeItems,
   firstArg,
-  flushPromises,
   getMockSession,
   getMockUserFeedback,
   getSyncPromiseRejectOnFirstCall,

test/sdk.test.ts

@@ -5,6 +5,7 @@ interface MockedClient {
 }
 
 let mockedGetCurrentHubWithScope: jest.Mock;
+let mockedGetCurrentHubConfigureScope: jest.Mock;
 
 jest.mock('@sentry/react', () => {
   const actualModule = jest.requireActual('@sentry/react');
@@ -17,10 +18,12 @@ jest.mock('@sentry/react', () => {
     ...actualModule,
     getCurrentHub: jest.fn(() => {
       mockedGetCurrentHubWithScope = jest.fn();
+      mockedGetCurrentHubConfigureScope = jest.fn();
       return {
         getClient: jest.fn(() => mockClient),
         setTag: jest.fn(),
         withScope: mockedGetCurrentHubWithScope,
+        configureScope: mockedGetCurrentHubConfigureScope,
       };
     }),
     defaultIntegrations: [ { name: 'MockedDefaultReactIntegration', setupOnce: jest.fn() } ],
@@ -62,7 +65,7 @@ import { getCurrentHub } from '@sentry/react';
 import { Integration, Scope } from '@sentry/types';
 
 import { ReactNativeClientOptions } from '../src/js/options';
-import { flush, init, withScope } from '../src/js/sdk';
+import { configureScope,flush, init, withScope } from '../src/js/sdk';
 import { ReactNativeTracing, ReactNavigationInstrumentation } from '../src/js/tracing';
 import { firstArg, secondArg } from './testutils';
 
@@ -234,6 +237,19 @@ describe('Tests the SDK functionality', () => {
     });
   });
 
+  describe('configureScope', () => {
+    test('configureScope callback does not throw', () => {
+      const mockScopeCallback = jest.fn(() => { throw 'Test error' });
+
+      configureScope(mockScopeCallback);
+
+      expect(() => {
+        (mockedGetCurrentHubConfigureScope.mock.calls[0][firstArg] as (scope: Scope) => void)({} as any);
+      }).not.toThrow();
+      expect(mockScopeCallback).toBeCalledTimes(1);
+    });
+  });
+
   describe('integrations', () => {
     it('replaces default integrations', () => {
       const mockDefaultIntegration = getMockedIntegration();

test/testutils.ts

@@ -64,5 +64,3 @@ export const getSyncPromiseRejectOnFirstCall = <Y extends any[]>(reason: unknown
     }
   });
 };
-
-export const flushPromises = (): Promise<void> => new Promise(setImmediate);