ref: Rename OOM to Watchdog Terminations

CHANGELOG.md

@@ -50,6 +50,7 @@ This version adds a dependency on Swift.
     - Rename `SentryOptions.enableCoreDataTracking` to `enableCoreDataTracing`
 - SentrySDK.close calls flush, which is a blocking call (#2453)
 - Bump minimum Xcode version to 13 (#2483)
+- Rename `SentryOptions.enableOutOfMemoryTracking` to `SentryOptions.enableWatchdogTerminationsTracking` (#2499)
 
 ## 8.0.0-beta.4
 

Sentry.xcodeproj/xcshareddata/xcschemes/Sentry.xcscheme

@@ -74,7 +74,7 @@
                   Identifier = "SentryNetworkTrackerIntegrationTests/testGetRequest_SpanCreatedAndBaggageHeaderAdded_disabled()">
                </Test>
                <Test
-                  Identifier = "SentryOutOfMemoryIntegrationTests/testANRDetected_UpdatesAppStateToTrue_disabled()">
+                  Identifier = "SentryWatchdogTerminationsIntegrationTests/testANRDetected_UpdatesAppStateToTrue_disabled()">
                </Test>
                <Test
                   Identifier = "SentryProfilerSwiftTests/testProfileTimeoutTimer_disabled()">

Sources/Sentry/Public/SentryOptions.h

@@ -136,9 +136,9 @@ NS_SWIFT_NAME(Options)
 @property (nonatomic, assign) BOOL enableAutoSessionTracking;
 
 /**
- * Whether to enable out of memory tracking or not. Default is YES.
+ * Whether to enable Watchdog Terminations tracking or not. Default is YES.
  */
-@property (nonatomic, assign) BOOL enableOutOfMemoryTracking;
+@property (nonatomic, assign) BOOL enableWatchdogTerminationsTracking;
 
 /**
  * The interval to end a session if the App goes to the background.

Sources/Sentry/SentryBaseIntegration.m

@@ -43,9 +43,9 @@ - (BOOL)shouldBeEnabledWithOptions:(SentryOptions *)options
         return NO;
     }
 
-    if ((integrationOptions & kIntegrationOptionEnableOutOfMemoryTracking)
-        && !options.enableOutOfMemoryTracking) {
-        [self logWithOptionName:@"enableOutOfMemoryTracking"];
+    if ((integrationOptions & kIntegrationOptionEnableWatchdogTerminationsTracking)
+        && !options.enableWatchdogTerminationsTracking) {
+        [self logWithOptionName:@"enableWatchdogTerminationsTracking"];
         return NO;
     }
 

Sources/Sentry/SentryClient.m

@@ -30,7 +30,6 @@
 #import "SentryMeta.h"
 #import "SentryNSError.h"
 #import "SentryOptions+Private.h"
-#import "SentryOutOfMemoryTracker.h"
 #import "SentryPermissionsObserver.h"
 #import "SentrySDK+Private.h"
 #import "SentryScope+Private.h"
@@ -45,6 +44,7 @@
 #import "SentryUIDeviceWrapper.h"
 #import "SentryUser.h"
 #import "SentryUserFeedback.h"
+#import "SentryWatchdogTerminationsTracker.h"
 
 #if SENTRY_HAS_UIKIT
 #    import <UIKit/UIKit.h>
@@ -738,7 +738,7 @@ - (BOOL)isOOM:(SentryEvent *)event isCrashEvent:(BOOL)isCrashEvent
 
     SentryException *exception = event.exceptions[0];
     return exception.mechanism != nil &&
-        [exception.mechanism.type isEqualToString:SentryOutOfMemoryMechanismType];
+        [exception.mechanism.type isEqualToString:SentryWatchdogTerminationMechanismType];
 }
 
 - (void)applyPermissionsToEvent:(SentryEvent *)event

Sources/Sentry/SentryCrashIntegration.m

@@ -5,10 +5,10 @@
 #import "SentryEvent.h"
 #import "SentryHub.h"
 #import "SentryInAppLogic.h"
-#import "SentryOutOfMemoryLogic.h"
 #import "SentrySDK+Private.h"
 #import "SentryScope+Private.h"
 #import "SentrySessionCrashedHandler.h"
+#import "SentryWatchdogTerminationsLogic.h"
 #import <SentryAppStateManager.h>
 #import <SentryClient+Private.h>
 #import <SentryCrashScopeObserver.h>
@@ -70,13 +70,13 @@ - (BOOL)installWithOptions:(nonnull SentryOptions *)options
 
     SentryAppStateManager *appStateManager =
         [SentryDependencyContainer sharedInstance].appStateManager;
-    SentryOutOfMemoryLogic *logic =
-        [[SentryOutOfMemoryLogic alloc] initWithOptions:options
-                                           crashAdapter:self.crashAdapter
-                                        appStateManager:appStateManager];
+    SentryWatchdogTerminationsLogic *logic =
+        [[SentryWatchdogTerminationsLogic alloc] initWithOptions:options
+                                                    crashAdapter:self.crashAdapter
+                                                 appStateManager:appStateManager];
     self.crashedSessionHandler =
         [[SentrySessionCrashedHandler alloc] initWithCrashWrapper:self.crashAdapter
-                                                 outOfMemoryLogic:logic];
+                                        watchdogTerminationsLogic:logic];
 
     self.scopeObserver =
         [[SentryCrashScopeObserver alloc] initWithMaxBreadcrumbs:options.maxBreadcrumbs];

Sources/Sentry/SentryOptions.m

@@ -38,9 +38,9 @@ - (void)setMeasurement:(SentryMeasurementValue *)measurement
 #endif
             @"SentryFramesTrackingIntegration", @"SentryAutoBreadcrumbTrackingIntegration",
             @"SentryAutoSessionTrackingIntegration", @"SentryAppStartTrackingIntegration",
-            @"SentryOutOfMemoryTrackingIntegration", @"SentryPerformanceTrackingIntegration",
-            @"SentryNetworkTrackingIntegration", @"SentryFileIOTrackingIntegration",
-            @"SentryCoreDataTrackingIntegration"
+            @"SentryWatchdogTerminationsTrackingIntegration",
+            @"SentryPerformanceTrackingIntegration", @"SentryNetworkTrackingIntegration",
+            @"SentryFileIOTrackingIntegration", @"SentryCoreDataTrackingIntegration"
         ]
             .mutableCopy;
 
@@ -65,7 +65,7 @@ - (instancetype)init
         _defaultSampleRate = @1;
         self.sampleRate = _defaultSampleRate;
         self.enableAutoSessionTracking = YES;
-        self.enableOutOfMemoryTracking = YES;
+        self.enableWatchdogTerminationsTracking = YES;
         self.sessionTrackingIntervalMillis = [@30000 unsignedIntValue];
         self.attachStacktrace = YES;
         self.stitchAsyncCode = NO;

Sources/Sentry/SentrySessionCrashedHandler.m

@@ -4,32 +4,33 @@
 #import "SentryCurrentDate.h"
 #import "SentryFileManager.h"
 #import "SentryHub.h"
-#import "SentryOutOfMemoryLogic.h"
 #import "SentrySDK+Private.h"
+#import "SentryWatchdogTerminationsLogic.h"
 
 @interface
 SentrySessionCrashedHandler ()
 
 @property (nonatomic, strong) SentryCrashWrapper *crashWrapper;
-@property (nonatomic, strong) SentryOutOfMemoryLogic *outOfMemoryLogic;
+@property (nonatomic, strong) SentryWatchdogTerminationsLogic *watchdogTerminationsLogic;
 
 @end
 
 @implementation SentrySessionCrashedHandler
 
 - (instancetype)initWithCrashWrapper:(SentryCrashWrapper *)crashWrapper
-                    outOfMemoryLogic:(SentryOutOfMemoryLogic *)outOfMemoryLogic;
+           watchdogTerminationsLogic:(SentryWatchdogTerminationsLogic *)watchdogTerminationsLogic;
 {
     self = [self init];
     self.crashWrapper = crashWrapper;
-    self.outOfMemoryLogic = outOfMemoryLogic;
+    self.watchdogTerminationsLogic = watchdogTerminationsLogic;
 
     return self;
 }
 
 - (void)endCurrentSessionAsCrashedWhenCrashOrOOM
 {
-    if (self.crashWrapper.crashedLastLaunch || [self.outOfMemoryLogic isOOM]) {
+    if (self.crashWrapper.crashedLastLaunch ||
+        [self.watchdogTerminationsLogic isWatchdogTermination]) {
         SentryFileManager *fileManager = [[[SentrySDK currentHub] getClient] fileManager];
 
         if (nil == fileManager) {

Sources/Sentry/SentryOutOfMemoryLogic.m → Sources/Sentry/SentryWatchdogTerminationsLogic.m

@@ -3,23 +3,23 @@
 #import <SentryAppStateManager.h>
 #import <SentryCrashWrapper.h>
 #import <SentryOptions.h>
-#import <SentryOutOfMemoryLogic.h>
 #import <SentrySDK+Private.h>
+#import <SentryWatchdogTerminationsLogic.h>
 
 #if SENTRY_HAS_UIKIT
 #    import <UIKit/UIKit.h>
 #endif
 
 @interface
-SentryOutOfMemoryLogic ()
+SentryWatchdogTerminationsLogic ()
 
 @property (nonatomic, strong) SentryOptions *options;
 @property (nonatomic, strong) SentryCrashWrapper *crashAdapter;
 @property (nonatomic, strong) SentryAppStateManager *appStateManager;
 
 @end
 
-@implementation SentryOutOfMemoryLogic
+@implementation SentryWatchdogTerminationsLogic
 
 - (instancetype)initWithOptions:(SentryOptions *)options
                    crashAdapter:(SentryCrashWrapper *)crashAdapter
@@ -33,9 +33,9 @@ - (instancetype)initWithOptions:(SentryOptions *)options
     return self;
 }
 
-- (BOOL)isOOM
+- (BOOL)isWatchdogTermination
 {
-    if (!self.options.enableOutOfMemoryTracking) {
+    if (!self.options.enableWatchdogTerminationsTracking) {
         return NO;
     }
 
@@ -79,18 +79,19 @@ - (BOOL)isOOM
         return NO;
     }
 
-    // The app crashed on the previous run. No OOM.
+    // The app crashed on the previous run. No Watchdog Termination.
     if (self.crashAdapter.crashedLastLaunch) {
         return NO;
     }
 
-    // The SDK wasn't running, so *any* crash after the SDK got closed would be seen as OOM.
+    // The SDK wasn't running, so *any* crash after the SDK got closed would be seen as a Watchdog
+    // Termination.
     if (!previousAppState.isSDKRunning) {
         return NO;
     }
 
     // Was the app in foreground/active ?
-    // If the app was in background we can't reliably tell if it was an OOM or not.
+    // If the app was in background we can't reliably tell if it was a Watchdog Termination or not.
     if (!previousAppState.isActive) {
         return NO;
     }
@@ -99,16 +100,16 @@ - (BOOL)isOOM
         return NO;
     }
 
-    // When calling SentrySDK.start twice we would wrongly report an OOM. We can only
-    // report an OOM when the SDK is started the first time.
+    // When calling SentrySDK.start twice we would wrongly report a Watchdog Termination. We can
+    // only report a Watchdog Termination when the SDK is started the first time.
     if (SentrySDK.startInvocations != 1) {
         return NO;
     }
 
     return YES;
 #else
-    // We can only track OOMs for iOS, tvOS and macCatalyst. Therefore we return NO for other
-    // platforms.
+    // We can only track Watchdog Terminations for iOS, tvOS and macCatalyst. Therefore we return NO
+    // for other platforms.
     return NO;
 #endif
 }

Sources/Sentry/SentryOutOfMemoryScopeObserver.m → Sources/Sentry/SentryWatchdogTerminationsScopeObserver.m

@@ -1,10 +1,10 @@
-#import "SentryOutOfMemoryScopeObserver.h"
+#import "SentryWatchdogTerminationsScopeObserver.h"
 #import <SentryBreadcrumb.h>
 #import <SentryFileManager.h>
 #import <SentryLog.h>
 
 @interface
-SentryOutOfMemoryScopeObserver ()
+SentryWatchdogTerminationsScopeObserver ()
 
 @property (strong, nonatomic) SentryFileManager *fileManager;
 @property (strong, nonatomic) NSFileHandle *fileHandle;
@@ -14,7 +14,7 @@
 
 @end
 
-@implementation SentryOutOfMemoryScopeObserver
+@implementation SentryWatchdogTerminationsScopeObserver
 
 - (instancetype)initWithMaxBreadcrumbs:(NSInteger)maxBreadcrumbs
                            fileManager:(SentryFileManager *)fileManager

Sources/Sentry/SentryOutOfMemoryTracker.m → Sources/Sentry/SentryWatchdogTerminationsTracker.m

@@ -12,36 +12,36 @@
 #import <SentryMechanism.h>
 #import <SentryMessage.h>
 #import <SentryOptions.h>
-#import <SentryOutOfMemoryLogic.h>
-#import <SentryOutOfMemoryTracker.h>
 #import <SentrySDK+Private.h>
+#import <SentryWatchdogTerminationsLogic.h>
+#import <SentryWatchdogTerminationsTracker.h>
 
 #if SENTRY_HAS_UIKIT
 #    import <UIKit/UIKit.h>
 #endif
 
 @interface
-SentryOutOfMemoryTracker ()
+SentryWatchdogTerminationsTracker ()
 
 @property (nonatomic, strong) SentryOptions *options;
-@property (nonatomic, strong) SentryOutOfMemoryLogic *outOfMemoryLogic;
+@property (nonatomic, strong) SentryWatchdogTerminationsLogic *watchdogTerminationsLogic;
 @property (nonatomic, strong) SentryDispatchQueueWrapper *dispatchQueue;
 @property (nonatomic, strong) SentryAppStateManager *appStateManager;
 @property (nonatomic, strong) SentryFileManager *fileManager;
 
 @end
 
-@implementation SentryOutOfMemoryTracker
+@implementation SentryWatchdogTerminationsTracker
 
 - (instancetype)initWithOptions:(SentryOptions *)options
-               outOfMemoryLogic:(SentryOutOfMemoryLogic *)outOfMemoryLogic
+      watchdogTerminationsLogic:(SentryWatchdogTerminationsLogic *)watchdogTerminationsLogic
                 appStateManager:(SentryAppStateManager *)appStateManager
            dispatchQueueWrapper:(SentryDispatchQueueWrapper *)dispatchQueueWrapper
                     fileManager:(SentryFileManager *)fileManager
 {
     if (self = [super init]) {
         self.options = options;
-        self.outOfMemoryLogic = outOfMemoryLogic;
+        self.watchdogTerminationsLogic = watchdogTerminationsLogic;
         self.appStateManager = appStateManager;
         self.dispatchQueue = dispatchQueueWrapper;
         self.fileManager = fileManager;
@@ -55,7 +55,7 @@ - (void)start
     [self.appStateManager start];
 
     [self.dispatchQueue dispatchAsyncWithBlock:^{
-        if ([self.outOfMemoryLogic isOOM]) {
+        if ([self.watchdogTerminationsLogic isWatchdogTermination]) {
             SentryEvent *event = [[SentryEvent alloc] initWithLevel:kSentryLevelFatal];
             // Set to empty list so no breadcrumbs of the current scope are added
             event.breadcrumbs = @[];
@@ -76,10 +76,10 @@ - (void)start
             }
 
             SentryException *exception =
-                [[SentryException alloc] initWithValue:SentryOutOfMemoryExceptionValue
-                                                  type:SentryOutOfMemoryExceptionType];
+                [[SentryException alloc] initWithValue:SentryWatchdogTerminationExceptionValue
+                                                  type:SentryWatchdogTerminationExceptionType];
             SentryMechanism *mechanism =
-                [[SentryMechanism alloc] initWithType:SentryOutOfMemoryMechanismType];
+                [[SentryMechanism alloc] initWithType:SentryWatchdogTerminationMechanismType];
             mechanism.handled = @(NO);
             exception.mechanism = mechanism;
             event.exceptions = @[ exception ];
@@ -90,7 +90,8 @@ - (void)start
         }
     }];
 #else
-    SENTRY_LOG_INFO(@"NO UIKit -> SentryOutOfMemoryTracker will not track OOM.");
+    SENTRY_LOG_INFO(
+        @"NO UIKit -> SentryWatchdogTerminationsTracker will not track Watchdog Terminations.");
     return;
 #endif
 }