Merge branch 'main' into antonis/rn-0.83.1

Author: antonis

CHANGELOG.md

@@ -6,6 +6,26 @@
 > make sure you follow our [migration guide](https://docs.sentry.io/platforms/react-native/migration/) first.
 <!-- prettier-ignore-end -->
 
+## Unreleased
+
+### Features
+
+- Expose iOS options to ignore views from subtree traversal in version 8 ([#5663](https://github.com/getsentry/sentry-react-native/pull/5663))
+  - 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'],
+      }),
+    ],
+  });
+  ```
+
 ## 8.0.0
 
 ### Upgrading from 7.x to 8.0

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://abc@def.ingest.sentry.io/1234567",
+            "replaysOnErrorSampleRate": 0.75,
+            "mobileReplayOptions": [ "includedViewClasses": ["UILabel", "UIView", "UITextView"] ]
+        ] as NSDictionary).mutableCopy() as! NSMutableDictionary
+
+        RNSentryReplay.updateOptions(optionsDict)
+
+        let actualOptions = try! PrivateSentrySDKOnly.options(with: 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://abc@def.ingest.sentry.io/1234567",
+            "replaysOnErrorSampleRate": 0.75,
+            "mobileReplayOptions": [ "excludedViewClasses": ["UICollectionView", "UITableView", "UIScrollView"] ]
+        ] as NSDictionary).mutableCopy() as! NSMutableDictionary
+
+        RNSentryReplay.updateOptions(optionsDict)
+
+        let actualOptions = try! PrivateSentrySDKOnly.options(with: 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://abc@def.ingest.sentry.io/1234567",
+            "replaysOnErrorSampleRate": 0.75,
+            "mobileReplayOptions": [
+                "includedViewClasses": ["UILabel", "UIView"],
+                "excludedViewClasses": ["UICollectionView"]
+            ]
+        ] as NSDictionary).mutableCopy() as! NSMutableDictionary
+
+        RNSentryReplay.updateOptions(optionsDict)
+
+        let actualOptions = try! PrivateSentrySDKOnly.options(with: 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.
    *

performance-tests/Gemfile.lock

@@ -46,7 +46,7 @@ GEM
     dotenv (2.8.1)
     emoji_regex (3.2.3)
     excon (0.112.0)
-    faraday (1.10.4)
+    faraday (1.10.5)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)
@@ -65,7 +65,7 @@ GEM
     faraday-em_synchrony (1.0.1)
     faraday-excon (1.1.0)
     faraday-httpclient (1.0.1)
-    faraday-multipart (1.1.1)
+    faraday-multipart (1.2.0)
       multipart-post (~> 2.0)
     faraday-net_http (1.0.2)
     faraday-net_http_persistent (1.2.0)

samples/react-native/Gemfile.lock

@@ -97,7 +97,7 @@ GEM
     ethon (0.16.0)
       ffi (>= 1.15.0)
     excon (0.109.0)
-    faraday (1.10.4)
+    faraday (1.10.5)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)
@@ -113,11 +113,11 @@ GEM
       faraday (>= 0.8.0)
       http-cookie (~> 1.0.0)
     faraday-em_http (1.0.0)
-    faraday-em_synchrony (1.0.0)
+    faraday-em_synchrony (1.0.1)
     faraday-excon (1.1.0)
     faraday-httpclient (1.0.1)
-    faraday-multipart (1.0.4)
-      multipart-post (~> 2)
+    faraday-multipart (1.2.0)
+      multipart-post (~> 2.0)
     faraday-net_http (1.0.2)
     faraday-net_http_persistent (1.2.0)
     faraday-patron (1.0.0)