feat: Expose iOS options to ignore views from subtree traversal (#5545)

* feat: Expose iOS options to ignore views from subtree traversal

* Add example in the changelog

* Fix tests

Author: antonis

CHANGELOG.md

@@ -11,6 +11,21 @@
 ### Features
 
 - Experimental support of UI profiling on Android ([#5518](https://github.com/getsentry/sentry-react-native/pull/5518))
+- Expose iOS options to ignore views from subtree traversal ([#5545](https://github.com/getsentry/sentry-react-native/pull/5545))
+  - Use `includedViewClasses` to only traverse specific view classes, or `excludedViewClasses` to skip problematic view classes during session replay and screenshot capture
+  ```js
+  import * as Sentry from '@sentry/react-native';
+
+  Sentry.init({
+    replaysSessionSampleRate: 1.0,
+    integrations: [
+      Sentry.mobileReplayIntegration({
+        includedViewClasses: ['UILabel', 'UIView', 'MyCustomView'],
+        excludedViewClasses: ['WKWebView', 'UIWebView'],
+      }),
+    ],
+  });
+  ```
 
 ### Fixes
 

packages/core/RNSentryCocoaTester/RNSentryCocoaTesterTests/RNSentryReplayOptionsTests.swift

@@ -48,7 +48,7 @@ final class RNSentryReplayOptions: XCTestCase {
     }
 
     func assertAllDefaultReplayOptionsAreNotNil(replayOptions: [String: Any]) {
-        XCTAssertEqual(replayOptions.count, 9)
+        XCTAssertEqual(replayOptions.count, 11)
         XCTAssertNotNil(replayOptions["sessionSampleRate"])
         XCTAssertNotNil(replayOptions["errorSampleRate"])
         XCTAssertNotNil(replayOptions["maskAllImages"])
@@ -58,6 +58,8 @@ final class RNSentryReplayOptions: XCTestCase {
         XCTAssertNotNil(replayOptions["enableViewRendererV2"])
         XCTAssertNotNil(replayOptions["enableFastViewRendering"])
         XCTAssertNotNil(replayOptions["quality"])
+        XCTAssertNotNil(replayOptions["includedViewClasses"])
+        XCTAssertNotNil(replayOptions["excludedViewClasses"])
     }
 
     func testSessionSampleRate() {
@@ -318,4 +320,64 @@ final class RNSentryReplayOptions: XCTestCase {
 
         XCTAssertEqual(actualOptions.sessionReplay.quality, SentryReplayOptions.SentryReplayQuality.medium)
     }
+
+    func testIncludedViewClasses() {
+        let optionsDict = ([
+            "dsn": "https://[email protected]/1234567",
+            "replaysOnErrorSampleRate": 0.75,
+            "mobileReplayOptions": [ "includedViewClasses": ["UILabel", "UIView", "UITextView"] ]
+        ] as NSDictionary).mutableCopy() as! NSMutableDictionary
+
+        RNSentryReplay.updateOptions(optionsDict)
+
+        let actualOptions = try! SentryOptionsInternal.initWithDict(optionsDict as! [String: Any])
+
+        let includedViewClasses = actualOptions.sessionReplay.includedViewClasses
+        XCTAssertEqual(includedViewClasses.count, 3)
+        XCTAssertTrue(includedViewClasses.contains("UILabel"))
+        XCTAssertTrue(includedViewClasses.contains("UIView"))
+        XCTAssertTrue(includedViewClasses.contains("UITextView"))
+    }
+
+    func testExcludedViewClasses() {
+        let optionsDict = ([
+            "dsn": "https://[email protected]/1234567",
+            "replaysOnErrorSampleRate": 0.75,
+            "mobileReplayOptions": [ "excludedViewClasses": ["UICollectionView", "UITableView", "UIScrollView"] ]
+        ] as NSDictionary).mutableCopy() as! NSMutableDictionary
+
+        RNSentryReplay.updateOptions(optionsDict)
+
+        let actualOptions = try! SentryOptionsInternal.initWithDict(optionsDict as! [String: Any])
+
+        let excludedViewClasses = actualOptions.sessionReplay.excludedViewClasses
+        XCTAssertEqual(excludedViewClasses.count, 3)
+        XCTAssertTrue(excludedViewClasses.contains("UICollectionView"))
+        XCTAssertTrue(excludedViewClasses.contains("UITableView"))
+        XCTAssertTrue(excludedViewClasses.contains("UIScrollView"))
+    }
+
+    func testIncludedAndExcludedViewClasses() {
+        let optionsDict = ([
+            "dsn": "https://[email protected]/1234567",
+            "replaysOnErrorSampleRate": 0.75,
+            "mobileReplayOptions": [
+                "includedViewClasses": ["UILabel", "UIView"],
+                "excludedViewClasses": ["UICollectionView"]
+            ]
+        ] as NSDictionary).mutableCopy() as! NSMutableDictionary
+
+        RNSentryReplay.updateOptions(optionsDict)
+
+        let actualOptions = try! SentryOptionsInternal.initWithDict(optionsDict as! [String: Any])
+
+        let includedViewClasses = actualOptions.sessionReplay.includedViewClasses
+        XCTAssertEqual(includedViewClasses.count, 2)
+        XCTAssertTrue(includedViewClasses.contains("UILabel"))
+        XCTAssertTrue(includedViewClasses.contains("UIView"))
+
+        let excludedViewClasses = actualOptions.sessionReplay.excludedViewClasses
+        XCTAssertEqual(excludedViewClasses.count, 1)
+        XCTAssertTrue(excludedViewClasses.contains("UICollectionView"))
+    }
 }

packages/core/ios/RNSentryReplay.mm

@@ -27,6 +27,9 @@ + (BOOL)updateOptions:(NSMutableDictionary *)options
 
     NSString *qualityString = options[@"replaysSessionQuality"];
 
+    NSArray *includedViewClasses = replayOptions[@"includedViewClasses"];
+    NSArray *excludedViewClasses = replayOptions[@"excludedViewClasses"];
+
     [options setValue:@{
         @"sessionSampleRate" : sessionSampleRate ?: [NSNull null],
         @"errorSampleRate" : errorSampleRate ?: [NSNull null],
@@ -36,6 +39,8 @@ + (BOOL)updateOptions:(NSMutableDictionary *)options
         @"enableViewRendererV2" : replayOptions[@"enableViewRendererV2"] ?: [NSNull null],
         @"enableFastViewRendering" : replayOptions[@"enableFastViewRendering"] ?: [NSNull null],
         @"maskedViewClasses" : [RNSentryReplay getReplayRNRedactClasses:replayOptions],
+        @"includedViewClasses" : includedViewClasses ?: [NSNull null],
+        @"excludedViewClasses" : excludedViewClasses ?: [NSNull null],
         @"sdkInfo" :
             @ { @"name" : REACT_NATIVE_SDK_NAME, @"version" : REACT_NATIVE_SDK_PACKAGE_VERSION }
     }

packages/core/src/js/replay/mobilereplay.ts

@@ -81,6 +81,34 @@ export interface MobileReplayOptions {
    */
   enableFastViewRendering?: boolean;
 
+  /**
+   * Array of view class names to include in subtree traversal during session replay and screenshot capture on iOS.
+   *
+   * Only views that are instances of these classes (or subclasses) will be traversed.
+   * This helps prevent crashes when traversing problematic view hierarchies by allowing you to explicitly include only safe view classes.
+   *
+   * If both `includedViewClasses` and `excludedViewClasses` are set, `excludedViewClasses` takes precedence:
+   * views matching excluded classes won't be traversed even if they match an included class.
+   *
+   * @default undefined
+   * @platform ios
+   */
+  includedViewClasses?: string[];
+
+  /**
+   * Array of view class names to exclude from subtree traversal during session replay and screenshot capture on iOS.
+   *
+   * Views of these classes (or subclasses) will be skipped entirely, including all their children.
+   * This helps prevent crashes when traversing problematic view hierarchies by allowing you to explicitly exclude problematic view classes.
+   *
+   * If both `includedViewClasses` and `excludedViewClasses` are set, `excludedViewClasses` takes precedence:
+   * views matching excluded classes won't be traversed even if they match an included class.
+   *
+   * @default undefined
+   * @platform ios
+   */
+  excludedViewClasses?: string[];
+
   /**
    * Sets the screenshot strategy used by the Session Replay integration on Android.
    *