feat: Expose screenshot masking options for error screenshots

CHANGELOG.md

@@ -6,6 +6,12 @@
 > make sure you follow our [migration guide](https://docs.sentry.io/platforms/react-native/migration/) first.
 <!-- prettier-ignore-end -->
 
+## Unreleased
+
+### Features
+
+- Expose screenshot masking options (`screenshot.maskAllText`, `screenshot.maskAllImages`) for error screenshots ([#6007](https://github.com/getsentry/sentry-react-native/pull/6007))
+
 ## 8.8.0
 
 ### Features

packages/core/RNSentryCocoaTester/RNSentryCocoaTesterTests/RNSentryStartTests.swift

@@ -197,6 +197,34 @@ final class RNSentryStartTests: XCTestCase {
         }
     }
 
+    func testScreenshotMaskingOptions() throws {
+        try startFromRN(options: [
+            "dsn": "https://abcd@efgh.ingest.sentry.io/123456",
+            "attachScreenshot": true,
+            "screenshot": [
+                "maskAllText": false,
+                "maskAllImages": true,
+            ]
+        ])
+
+        let actualOptions = PrivateSentrySDKOnly.options
+        XCTAssertTrue(actualOptions.attachScreenshot)
+        XCTAssertFalse(actualOptions.screenshot.maskAllText)
+        XCTAssertTrue(actualOptions.screenshot.maskAllImages)
+    }
+
+    func testScreenshotMaskingOptionsDefaults() throws {
+        try startFromRN(options: [
+            "dsn": "https://abcd@efgh.ingest.sentry.io/123456",
+            "attachScreenshot": true,
+        ])
+
+        let actualOptions = PrivateSentrySDKOnly.options
+        XCTAssertTrue(actualOptions.attachScreenshot)
+        XCTAssertTrue(actualOptions.screenshot.maskAllText)
+        XCTAssertTrue(actualOptions.screenshot.maskAllImages)
+    }
+
     func startFromRN(options: [String: Any]) throws {
         var error: NSError?
         RNSentryStart.start(options: options, error: &error)

packages/core/android/src/main/java/io/sentry/react/RNSentryStart.java

@@ -136,6 +136,17 @@ static void getSentryAndroidOptions(
     if (rnOptions.hasKey("attachScreenshot")) {
       options.setAttachScreenshot(rnOptions.getBoolean("attachScreenshot"));
     }
+    if (rnOptions.hasKey("screenshot")) {
+      @Nullable final ReadableMap screenshotOptions = rnOptions.getMap("screenshot");
+      if (screenshotOptions != null) {
+        if (screenshotOptions.hasKey("maskAllText")) {
+          options.getScreenshot().setMaskAllText(screenshotOptions.getBoolean("maskAllText"));
+        }
+        if (screenshotOptions.hasKey("maskAllImages")) {
+          options.getScreenshot().setMaskAllImages(screenshotOptions.getBoolean("maskAllImages"));
+        }
+      }
+    }
     if (rnOptions.hasKey("attachViewHierarchy")) {
       options.setAttachViewHierarchy(rnOptions.getBoolean("attachViewHierarchy"));
     }

packages/core/ios/RNSentryStart.m

@@ -55,6 +55,14 @@ + (SentryOptions *_Nullable)createOptionsWithDictionary:(NSDictionary *_Nonnull)
         return nil;
     }
 
+#if SENTRY_TARGET_REPLAY_SUPPORTED
+    NSDictionary *screenshotDict = mutableOptions[@"screenshot"];
+    if ([screenshotDict isKindOfClass:[NSDictionary class]]) {
+        sentryOptions.screenshot =
+            [[SentryViewScreenshotOptions alloc] initWithDictionary:screenshotDict];
+    }
+#endif
+
     // Exclude Dev Server and Sentry Dsn request from Breadcrumbs
     NSString *dsn = [self getURLFromDSN:[mutableOptions valueForKey:@"dsn"]];
     // TODO: For Auto Init from JS dev server is resolved automatically, for init from options file

packages/core/src/js/options.ts

@@ -194,6 +194,25 @@ export interface BaseReactNativeOptions {
    */
   attachScreenshot?: boolean;
 
+  /**
+   * Options for configuring screenshot masking on error screenshots.
+   * When `attachScreenshot` is enabled, these options control what gets masked in the screenshot.
+   */
+  screenshot?: {
+    /**
+     * Mask all text content in error screenshots.
+     *
+     * @default true
+     */
+    maskAllText?: boolean;
+    /**
+     * Mask all images in error screenshots.
+     *
+     * @default true
+     */
+    maskAllImages?: boolean;
+  };
+
   /**
    * When enabled Sentry includes the current view hierarchy in the error attachments.
    *

packages/core/test/wrapper.test.ts

@@ -414,6 +414,28 @@ describe('Tests Native Wrapper', () => {
       expect(initParameter.strictTraceContinuation).toBe(true);
     });
 
+    test('passes screenshot options to native SDK', async () => {
+      await NATIVE.initNativeSdk({
+        dsn: 'test',
+        enableNative: true,
+        autoInitializeNativeSdk: true,
+        screenshot: {
+          maskAllText: false,
+          maskAllImages: true,
+        },
+        devServerUrl: undefined,
+        defaultSidecarUrl: undefined,
+        mobileReplayOptions: undefined,
+      });
+
+      expect(RNSentry.initNativeSdk).toHaveBeenCalled();
+      const initParameter = (RNSentry.initNativeSdk as jest.MockedFunction<any>).mock.calls[0][0];
+      expect(initParameter.screenshot).toEqual({
+        maskAllText: false,
+        maskAllImages: true,
+      });
+    });
+
     test('passes orgId option to native SDK', async () => {
       await NATIVE.initNativeSdk({
         dsn: 'test',

samples/react-native/src/App.tsx

@@ -152,6 +152,11 @@ Sentry.init({
   attachStacktrace: true,
   // Attach screenshots to events.
   attachScreenshot: true,
+  // Screenshot masking options.
+  screenshot: {
+    maskAllText: true,
+    maskAllImages: true,
+  },
   // Attach view hierarchy to events.
   attachViewHierarchy: true,
   // Enables capture failed requests in JS and native.