feat(ios): Forward experimental enableWatchdogTerminationsV2 to sentry-cocoa (#7012)

* feat(ios): Forward experimental enableWatchdogTerminationsV2 to sentry-cocoa

On sentry-cocoa 9 the watchdog termination integration uses the frame-based ANR tracker (V2). A foreground app that does not render reads as an ongoing hang, so the integration skips a watchdog termination that happens during that time, even with enableAppHangTracking off.

sentry-cocoa 9.6.0 added experimental.enableWatchdogTerminationsV2, which switches the integration to a run loop observer, but React Native apps could not set it from JS. RNSentryStart now reads _experiments.enableWatchdogTerminationsV2 and sets it through RNSentryExperimentalOptions, the same way as enableUnhandledCPPExceptionsV2. The option is iOS only and defaults to false.

Closes #6992

* docs(changelog): Add PR link for enableWatchdogTerminationsV2

Replace the PR number placeholder in the changelog entry with #7012.

Author: alwx

CHANGELOG.md

@@ -8,6 +8,20 @@
 
 ## Unreleased
 
+### Features
+
+- Add the experimental `_experiments.enableWatchdogTerminationsV2` option on iOS ([#7012](https://github.com/getsentry/sentry-react-native/pull/7012))
+  - The default tracker reports a foreground app that does not render as an app hang, and the SDK does not report watchdog terminations (for example OOM kills) that happen during that time. The option uses a run loop observer instead.
+
+  ```js
+  Sentry.init({
+    dsn: '__DSN__',
+    _experiments: {
+      enableWatchdogTerminationsV2: true,
+    },
+  });
+  ```
+
 ### Dependencies
 
 - Bump Android SDK from v8.62.0 to v8.63.0 ([#6990](https://github.com/getsentry/sentry-react-native/pull/6990))

packages/core/RNSentryCocoaTester/RNSentryCocoaTesterTests/RNSentryTests.m

@@ -765,6 +765,60 @@ - (void)testStartCreateOptionsWithDictionaryEnableUnhandledCPPExceptionsV2Defaul
         @"enableUnhandledCPPExceptionsV2 should default to disabled");
 }
 
+- (void)testStartCreateOptionsWithDictionaryEnableWatchdogTerminationsV2Enabled
+{
+    NSError *error = nil;
+
+    NSDictionary *_Nonnull mockedReactNativeDictionary = @{
+        @"dsn" : @"https://abcd@efgh.ingest.sentry.io/123456",
+        @"_experiments" : @ {
+            @"enableWatchdogTerminationsV2" : @YES,
+        },
+    };
+    SentryOptions *actualOptions =
+        [RNSentryStart createOptionsWithDictionary:mockedReactNativeDictionary error:&error];
+
+    XCTAssertNotNil(actualOptions, @"Did not create sentry options");
+    XCTAssertNil(error, @"Should not pass no error");
+    XCTAssertTrue(actualOptions.experimental.enableWatchdogTerminationsV2,
+        @"enableWatchdogTerminationsV2 should be enabled");
+}
+
+- (void)testStartCreateOptionsWithDictionaryEnableWatchdogTerminationsV2Disabled
+{
+    NSError *error = nil;
+
+    NSDictionary *_Nonnull mockedReactNativeDictionary = @{
+        @"dsn" : @"https://abcd@efgh.ingest.sentry.io/123456",
+        @"_experiments" : @ {
+            @"enableWatchdogTerminationsV2" : @NO,
+        },
+    };
+    SentryOptions *actualOptions =
+        [RNSentryStart createOptionsWithDictionary:mockedReactNativeDictionary error:&error];
+
+    XCTAssertNotNil(actualOptions, @"Did not create sentry options");
+    XCTAssertNil(error, @"Should not pass no error");
+    XCTAssertFalse(actualOptions.experimental.enableWatchdogTerminationsV2,
+        @"enableWatchdogTerminationsV2 should be disabled");
+}
+
+- (void)testStartCreateOptionsWithDictionaryEnableWatchdogTerminationsV2Default
+{
+    NSError *error = nil;
+
+    NSDictionary *_Nonnull mockedReactNativeDictionary = @{
+        @"dsn" : @"https://abcd@efgh.ingest.sentry.io/123456",
+    };
+    SentryOptions *actualOptions =
+        [RNSentryStart createOptionsWithDictionary:mockedReactNativeDictionary error:&error];
+
+    XCTAssertNotNil(actualOptions, @"Did not create sentry options");
+    XCTAssertNil(error, @"Should not pass no error");
+    XCTAssertFalse(actualOptions.experimental.enableWatchdogTerminationsV2,
+        @"enableWatchdogTerminationsV2 should default to disabled");
+}
+
 - (void)testStartEventFromSentryCocoaReactNativeHasOriginAndEnvironmentTags
 {
     SentryEvent *testEvent = [[SentryEvent alloc] init];

packages/core/etc/sentry-react-native.api.md

@@ -200,6 +200,7 @@ export interface BaseReactNativeOptions {
         replaysSessionSampleRate?: number;
         replaysOnErrorSampleRate?: number;
         enableUnhandledCPPExceptionsV2?: boolean;
+        enableWatchdogTerminationsV2?: boolean;
         profilingOptions?: ProfilingOptions;
         androidProfilingOptions?: ProfilingOptions;
         enableStandaloneAppStartTracing?: boolean;

packages/core/ios/RNSentryExperimentalOptions.h

@@ -21,6 +21,13 @@ NS_ASSUME_NONNULL_BEGIN
  */
 + (BOOL)getEnableUnhandledCPPExceptionsV2:(SentryOptions *)sentryOptions;
 
+/**
+ * Sets the enableWatchdogTerminationsV2 experimental option on SentryOptions
+ * @param sentryOptions The SentryOptions instance to configure
+ * @param enabled Whether to enable watchdog terminations V2
+ */
++ (void)setEnableWatchdogTerminationsV2:(BOOL)enabled sentryOptions:(SentryOptions *)sentryOptions;
+
 /**
  * Sets the enableLogs experimental option on SentryOptions
  * @param sentryOptions The SentryOptions instance to configure

packages/core/ios/RNSentryExperimentalOptions.m

@@ -20,6 +20,14 @@ + (BOOL)getEnableUnhandledCPPExceptionsV2:(SentryOptions *)sentryOptions
     return sentryOptions.experimental.enableUnhandledCPPExceptionsV2;
 }
 
++ (void)setEnableWatchdogTerminationsV2:(BOOL)enabled sentryOptions:(SentryOptions *)sentryOptions
+{
+    if (sentryOptions == nil) {
+        return;
+    }
+    sentryOptions.experimental.enableWatchdogTerminationsV2 = enabled;
+}
+
 + (void)setEnableLogs:(BOOL)enabled sentryOptions:(SentryOptions *)sentryOptions
 {
     if (sentryOptions == nil) {

packages/core/ios/RNSentryStart.m

@@ -188,6 +188,11 @@ + (SentryOptions *_Nullable)createOptionsWithDictionary:(NSDictionary *_Nonnull)
         [RNSentryExperimentalOptions setEnableUnhandledCPPExceptionsV2:enableUnhandledCPPExceptions
                                                          sentryOptions:sentryOptions];
 
+        BOOL enableWatchdogTerminationsV2 =
+            [experiments[@"enableWatchdogTerminationsV2"] boolValue];
+        [RNSentryExperimentalOptions setEnableWatchdogTerminationsV2:enableWatchdogTerminationsV2
+                                                       sentryOptions:sentryOptions];
+
         // Configure iOS UI Profiling
         NSDictionary *profilingOptions = experiments[@"profilingOptions"];
         if (profilingOptions != nil && [profilingOptions isKindOfClass:[NSDictionary class]]) {

packages/core/src/js/options.ts

@@ -633,6 +633,16 @@ export interface BaseReactNativeOptions {
      */
     enableUnhandledCPPExceptionsV2?: boolean;
 
+    /**
+     * Experiment: Detects watchdog terminations (for example OOM kills) with a run loop observer instead of the frame-based ANR tracker.
+     *
+     * With the default tracker, a foreground app that does not render reads as an app hang, and the SDK does not report watchdog terminations that happen during that time.
+     *
+     * @default false
+     * @platform ios
+     */
+    enableWatchdogTerminationsV2?: boolean;
+
     /**
      * Configuration options for UI profiling.
      * It supports two modes: `manual` and `trace`.