ref: move SentryCrash singleton to SentryDependencyContainer (#3247)

armcknight · philipphofmann · commit 067ac52a70e2 · 2023-11-08T08:34:55.000+01:00
diff --git a/SentryTestUtils/ClearTestState.swift b/SentryTestUtils/ClearTestState.swift
@@ -48,5 +48,7 @@ class TestCleanup: NSObject {
         PrivateSentrySDKOnly.onAppStartMeasurementAvailable = nil
         SentrySDK.setAppStartMeasurement(nil)
         #endif // os(iOS) || os(tvOS) || targetEnvironment(macCatalyst)
+
+        sentrycrash_scopesync_reset()
     }
 }
diff --git a/SentryTestUtils/SentryTestUtils-ObjC-BridgingHeader.h b/SentryTestUtils/SentryTestUtils-ObjC-BridgingHeader.h
@@ -42,6 +42,7 @@
 #import "SentryReachability.h"
 #import "SentrySDK+Private.h"
 #import "SentrySDK+Tests.h"
+#import "SentryScopeSyncC.h"
 #import "SentrySession.h"
 #import "SentrySwizzleWrapper.h"
 #import "SentrySystemWrapper.h"
diff --git a/Sources/Sentry/SentryCrashExceptionApplication.m b/Sources/Sentry/SentryCrashExceptionApplication.m
@@ -1,5 +1,6 @@
 #import "SentryCrashExceptionApplication.h"
 #import "SentryCrash.h"
+#import "SentryDependencyContainer.h"
 #import "SentrySDK.h"
 
 @implementation SentryCrashExceptionApplication
@@ -10,8 +11,9 @@ - (void)reportException:(NSException *)exception
 {
     [[NSUserDefaults standardUserDefaults]
         registerDefaults:@{ @"NSApplicationCrashOnExceptions" : @YES }];
-    if (nil != SentryCrash.sharedInstance.uncaughtExceptionHandler && nil != exception) {
-        SentryCrash.sharedInstance.uncaughtExceptionHandler(exception);
+    SentryCrash *crash = SentryDependencyContainer.sharedInstance.crashReporter;
+    if (nil != crash.uncaughtExceptionHandler && nil != exception) {
+        crash.uncaughtExceptionHandler(exception);
     }
     [super reportException:exception];
 }
diff --git a/Sources/Sentry/SentryCrashIntegration.m b/Sources/Sentry/SentryCrashIntegration.m
@@ -185,7 +185,7 @@ - (void)configureScope
         userInfo[@"release"] = self.options.releaseName;
         userInfo[@"dist"] = self.options.dist;
 
-        [SentryCrash.sharedInstance setUserInfo:userInfo];
+        [SentryDependencyContainer.sharedInstance.crashReporter setUserInfo:userInfo];
 
         [outerScope addObserver:self.scopeObserver];
     }];
diff --git a/Sources/Sentry/SentryCrashWrapper.m b/Sources/Sentry/SentryCrashWrapper.m
@@ -7,6 +7,7 @@
 #import <SentryCrashCachedData.h>
 #import <SentryCrashDebug.h>
 #import <SentryCrashMonitor_System.h>
+#import <SentryDependencyContainer.h>
 #include <mach/mach.h>
 
 NS_ASSUME_NONNULL_BEGIN
@@ -23,7 +24,7 @@ + (instancetype)sharedInstance
 
 - (BOOL)crashedLastLaunch
 {
-    return SentryCrash.sharedInstance.crashedLastLaunch;
+    return SentryDependencyContainer.sharedInstance.crashReporter.crashedLastLaunch;
 }
 
 - (NSTimeInterval)durationFromCrashStateInitToLastCrash
@@ -33,7 +34,7 @@ - (NSTimeInterval)durationFromCrashStateInitToLastCrash
 
 - (NSTimeInterval)activeDurationSinceLastCrash
 {
-    return SentryCrash.sharedInstance.activeDurationSinceLastCrash;
+    return SentryDependencyContainer.sharedInstance.crashReporter.activeDurationSinceLastCrash;
 }
 
 - (BOOL)isBeingTraced
@@ -55,7 +56,8 @@ - (NSDictionary *)systemInfo
 {
     static NSDictionary *sharedInfo = nil;
     static dispatch_once_t onceToken;
-    dispatch_once(&onceToken, ^{ sharedInfo = SentryCrash.sharedInstance.systemInfo; });
+    dispatch_once(&onceToken,
+        ^{ sharedInfo = SentryDependencyContainer.sharedInstance.crashReporter.systemInfo; });
     return sharedInfo;
 }
 
diff --git a/Sources/Sentry/SentryDependencyContainer.m b/Sources/Sentry/SentryDependencyContainer.m
@@ -15,6 +15,7 @@
 #import "SentryUIDeviceWrapper.h"
 #import <SentryAppStateManager.h>
 #import <SentryClient+Private.h>
+#import <SentryCrash.h>
 #import <SentryCrashWrapper.h>
 #import <SentryDebugImageProvider.h>
 #import <SentryDependencyContainer.h>
@@ -121,6 +122,18 @@ - (SentryCrashWrapper *)crashWrapper
     return _crashWrapper;
 }
 
+- (SentryCrash *)crashReporter
+{
+    if (_crashReporter == nil) {
+        @synchronized(sentryDependencyContainerLock) {
+            if (_crashReporter == nil) {
+                _crashReporter = [[SentryCrash alloc] init];
+            }
+        }
+    }
+    return _crashReporter;
+}
+
 - (SentrySysctl *)sysctlWrapper
 {
     if (_sysctlWrapper == nil) {
diff --git a/Sources/Sentry/SentrySDK.m b/Sources/Sentry/SentrySDK.m
@@ -338,7 +338,7 @@ + (void)setUser:(SentryUser *_Nullable)user
 
 + (BOOL)crashedLastRun
 {
-    return SentryCrash.sharedInstance.crashedLastLaunch;
+    return SentryDependencyContainer.sharedInstance.crashReporter.crashedLastLaunch;
 }
 
 + (void)startSession
diff --git a/Sources/Sentry/include/HybridPublic/SentryDependencyContainer.h b/Sources/Sentry/include/HybridPublic/SentryDependencyContainer.h
@@ -3,6 +3,7 @@
 @class SentryANRTracker;
 @class SentryAppStateManager;
 @class SentryBinaryImageCache;
+@class SentryCrash;
 @class SentryCrashWrapper;
 @class SentryCurrentDateProvider;
 @class SentryDebugImageProvider;
@@ -54,6 +55,7 @@ SENTRY_NO_INIT
 @property (nonatomic, strong) SentryFileManager *fileManager;
 @property (nonatomic, strong) SentryAppStateManager *appStateManager;
 @property (nonatomic, strong) SentryCrashWrapper *crashWrapper;
+@property (nonatomic, strong) SentryCrash *crashReporter;
 @property (nonatomic, strong) SentryThreadWrapper *threadWrapper;
 @property (nonatomic, strong) id<SentryRandom> random;
 @property (nonatomic, strong) SentrySwizzleWrapper *swizzleWrapper;
diff --git a/Sources/SentryCrash/Installations/SentryCrashInstallation.m b/Sources/SentryCrash/Installations/SentryCrashInstallation.m
@@ -33,6 +33,7 @@
 #import "SentryCrashJSONCodecObjC.h"
 #import "SentryCrashLogger.h"
 #import "SentryCrashReportFilterBasic.h"
+#import "SentryDependencyContainer.h"
 #import <objc/runtime.h>
 
 /** Max number of properties that can be defined for writing to the report */
@@ -175,7 +176,7 @@ - (id)initWithRequiredProperties:(NSArray *)requiredProperties
 
 - (void)dealloc
 {
-    SentryCrash *handler = [SentryCrash sharedInstance];
+    SentryCrash *handler = SentryDependencyContainer.sharedInstance.crashReporter;
     @synchronized(handler) {
         if (g_crashHandlerData == self.crashHandlerData) {
             g_crashHandlerData = NULL;
@@ -260,7 +261,7 @@ - (void)setOnCrash:(SentryCrashReportWriteCallback)onCrash
 
 - (void)install
 {
-    SentryCrash *handler = [SentryCrash sharedInstance];
+    SentryCrash *handler = SentryDependencyContainer.sharedInstance.crashReporter;
     @synchronized(handler) {
         g_crashHandlerData = self.crashHandlerData;
         handler.onCrash = crashCallback;
@@ -270,7 +271,7 @@ - (void)install
 
 - (void)uninstall
 {
-    SentryCrash *handler = [SentryCrash sharedInstance];
+    SentryCrash *handler = SentryDependencyContainer.sharedInstance.crashReporter;
     @synchronized(handler) {
         if (g_crashHandlerData == self.crashHandlerData) {
             g_crashHandlerData = NULL;
@@ -302,7 +303,7 @@ - (void)sendAllReportsWithCompletion:(SentryCrashReportFilterCompletion)onComple
 
     sink = [SentryCrashReportFilterPipeline filterWithFilters:self.prependedFilters, sink, nil];
 
-    SentryCrash *handler = [SentryCrash sharedInstance];
+    SentryCrash *handler = SentryDependencyContainer.sharedInstance.crashReporter;
     handler.sink = sink;
     [handler sendAllReportsWithCompletion:onCompletion];
 }
diff --git a/Sources/SentryCrash/Recording/Monitors/SentryCrashMonitor_MachException.c b/Sources/SentryCrash/Recording/Monitors/SentryCrashMonitor_MachException.c
@@ -51,9 +51,9 @@
 
 #    ifdef __LP64__
 #        define MACH_ERROR_CODE_MASK 0xFFFFFFFFFFFFFFFF
-#    else
+#    else // !__LP64__
 #        define MACH_ERROR_CODE_MASK 0xFFFFFFFF
-#    endif
+#    endif // __LP64__
 
 // ============================================================================
 #    pragma mark - Types -
@@ -267,7 +267,7 @@ sentrycrashcm_hasReservedThreads(void)
     return g_primaryMachThread != 0 && g_secondaryMachThread != 0;
 }
 
-#else
+#else // !SentryCrashCRASH_HAS_MACH
 bool
 sentrycrashcm_isReservedThread(thread_t thread)
 {
@@ -280,7 +280,7 @@ sentrycrashcm_hasReservedThreads(void)
     return false;
 }
 
-#endif
+#endif // SentryCrashCRASH_HAS_MACH
 
 #if SentryCrashCRASH_HAS_MACH
 
@@ -560,7 +560,7 @@ addContextualInfoToEvent(struct SentryCrash_MonitorContext *eventContext)
     }
 }
 
-#endif
+#endif // SentryCrashCRASH_HAS_MACH
 
 SentryCrashMonitorAPI *
 sentrycrashcm_machexception_getAPI(void)
@@ -570,7 +570,7 @@ sentrycrashcm_machexception_getAPI(void)
         .setEnabled = setEnabled,
         .isEnabled = isEnabled,
         .addContextualInfoToEvent = addContextualInfoToEvent
-#endif
+#endif // SentryCrashCRASH_HAS_MACH
     };
     return &api;
 }
diff --git a/Sources/SentryCrash/Recording/Monitors/SentryCrashMonitor_NSException.m b/Sources/SentryCrash/Recording/Monitors/SentryCrashMonitor_NSException.m
@@ -31,6 +31,7 @@
 #include "SentryCrashMonitorContext.h"
 #import "SentryCrashStackCursor_Backtrace.h"
 #include "SentryCrashThread.h"
+#import "SentryDependencyContainer.h"
 
 // #define SentryCrashLogger_LocalLevel TRACE
 #import "SentryCrashLogger.h"
@@ -128,7 +129,8 @@
 
             SentryCrashLOG_DEBUG(@"Setting new handler.");
             NSSetUncaughtExceptionHandler(&handleUncaughtException);
-            SentryCrash.sharedInstance.uncaughtExceptionHandler = &handleUncaughtException;
+            SentryDependencyContainer.sharedInstance.crashReporter.uncaughtExceptionHandler
+                = &handleUncaughtException;
         } else {
             SentryCrashLOG_DEBUG(@"Restoring original handler.");
             NSSetUncaughtExceptionHandler(g_previousUncaughtExceptionHandler);
diff --git a/Sources/SentryCrash/Recording/SentryCrash.h b/Sources/SentryCrash/Recording/SentryCrash.h
@@ -182,10 +182,6 @@ static NSString *const SENTRYCRASH_REPORT_ATTACHMENTS_ITEM = @"attachments";
 
 #pragma mark - API -
 
-/** Get the singleton instance of the crash reporter.
- */
-+ (SentryCrash *)sharedInstance;
-
 /** Install the crash reporter.
  * The reporter will record crashes, but will not send any crash reports unless
  * sink is set.
diff --git a/Sources/SentryCrash/Recording/SentryCrash.m b/Sources/SentryCrash/Recording/SentryCrash.m
@@ -89,15 +89,6 @@ @implementation SentryCrash
 #pragma mark - Lifecycle -
 // ============================================================================
 
-+ (instancetype)sharedInstance
-{
-    static SentryCrash *sharedInstance = nil;
-    static dispatch_once_t onceToken;
-
-    dispatch_once(&onceToken, ^{ sharedInstance = [[SentryCrash alloc] init]; });
-    return sharedInstance;
-}
-
 - (id)init
 {
     return [self initWithBasePath:[self getBasePath]];
diff --git a/Tests/SentryTests/Integrations/SentryCrash/SentryCrashIntegrationTests.swift b/Tests/SentryTests/Integrations/SentryCrash/SentryCrashIntegrationTests.swift
@@ -69,7 +69,7 @@ class SentryCrashIntegrationTests: NotificationCenterTestCase {
     }
     
     // Test for GH-581
-    func testReleaseNamePassedToSentryCrash() {
+    func testReleaseNamePassedToSentryCrash() throws {
         let releaseName = "1.0.0"
         let dist = "14G60"
         // The start of the SDK installs all integrations
@@ -80,20 +80,18 @@ class SentryCrashIntegrationTests: NotificationCenterTestCase {
         }
         
         // To test this properly we need SentryCrash and SentryCrashIntegration installed and registered on the current hub of the SDK.
-        
-        let instance = SentryCrash.sharedInstance()
-        let userInfo = (instance?.userInfo ?? ["": ""]) as Dictionary
+
+        let userInfo = try XCTUnwrap(SentryDependencyContainer.sharedInstance().crashReporter.userInfo)
         assertUserInfoField(userInfo: userInfo, key: "release", expected: releaseName)
         assertUserInfoField(userInfo: userInfo, key: "dist", expected: dist)
     }
     
-    func testContext_IsPassedToSentryCrash() {
+    func testContext_IsPassedToSentryCrash() throws {
         SentrySDK.start { options in
             options.dsn = SentryCrashIntegrationTests.dsnAsString
         }
         
-        let instance = SentryCrash.sharedInstance()
-        let userInfo = (instance?.userInfo ?? ["": ""]) as Dictionary
+        let userInfo = try XCTUnwrap(SentryDependencyContainer.sharedInstance().crashReporter.userInfo)
         let context = userInfo["context"] as? [String: Any]
         
         assertContext(context: context)
diff --git a/Tests/SentryTests/Integrations/SentryCrash/SentryCrashReportTests.swift b/Tests/SentryTests/Integrations/SentryCrash/SentryCrashReportTests.swift
@@ -78,7 +78,7 @@ class SentryCrashReportTests: XCTestCase {
      * UserInfo is picked up by the crash report when writing a new report.
      */
     private func serializeToCrashReport(scope: Scope) {
-        SentryCrash.sharedInstance().userInfo = scope.serialize()
+        SentryDependencyContainer.sharedInstance().crashReporter.userInfo = scope.serialize()
     }
     
     private func deleteTestDir() {
diff --git a/Tests/SentryTests/Integrations/SentryCrash/SentryCrashScopeObserverTests.swift b/Tests/SentryTests/Integrations/SentryCrash/SentryCrashScopeObserverTests.swift
@@ -1,3 +1,4 @@
+import SentryTestUtils
 import XCTest
 
 class SentryCrashScopeObserverTests: XCTestCase {
@@ -17,16 +18,9 @@ class SentryCrashScopeObserverTests: XCTestCase {
     
     private let fixture = Fixture()
     
-    override func setUp() {
-        super.setUp()
-        sentrycrash_scopesync_reset()
-        SentryCrash.sharedInstance().userInfo = nil
-    }
-    
     override func tearDown() {
         super.tearDown()
-        sentrycrash_scopesync_reset()
-        SentryCrash.sharedInstance().userInfo = nil
+        clearTestState()
     }
 
     func testUser() {
diff --git a/Tests/SentryTests/SentryCrash/SentryCrashInstallationReporterTests.swift b/Tests/SentryTests/SentryCrash/SentryCrashInstallationReporterTests.swift
@@ -21,6 +21,7 @@ class SentryCrashInstallationReporterTests: XCTestCase {
         super.tearDown()
         sentrycrash_deleteAllReports()
         clearTestState()
+        sut.uninstall()
     }
     
     func testReportIsSentAndDeleted() throws {
diff --git a/Tests/SentryTests/SentryCrash/SentryCrashInstallationTests.m b/Tests/SentryTests/SentryCrash/SentryCrashInstallationTests.m
diff --git a/Tests/SentryTests/SentrySDKTests.swift b/Tests/SentryTests/SentrySDKTests.swift

Original file line number	Diff line number	Diff line change
`@@ -48,5 +48,7 @@ class TestCleanup: NSObject {`
`48`	`48`	`PrivateSentrySDKOnly.onAppStartMeasurementAvailable = nil`
`49`	`49`	`SentrySDK.setAppStartMeasurement(nil)`
`50`	`50`	`#endif // os(iOS) \|\| os(tvOS) \|\| targetEnvironment(macCatalyst)`
	`51`	`+`
	`52`	`+ sentrycrash_scopesync_reset()`
`51`	`53`	`}`
`52`	`54`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`#import "SentryCrashExceptionApplication.h"`
`2`	`2`	`#import "SentryCrash.h"`
	`3`	`+#import "SentryDependencyContainer.h"`
`3`	`4`	`#import "SentrySDK.h"`
`4`	`5`
`5`	`6`	`@implementation SentryCrashExceptionApplication`
`@@ -10,8 +11,9 @@ - (void)reportException:(NSException *)exception`
`10`	`11`	`{`
`11`	`12`	`[[NSUserDefaults standardUserDefaults]`
`12`	`13`	`registerDefaults:@{ @"NSApplicationCrashOnExceptions" : @YES }];`
`13`		`- if (nil != SentryCrash.sharedInstance.uncaughtExceptionHandler && nil != exception) {`
`14`		`- SentryCrash.sharedInstance.uncaughtExceptionHandler(exception);`
	`14`	`+ SentryCrash *crash = SentryDependencyContainer.sharedInstance.crashReporter;`
	`15`	`+ if (nil != crash.uncaughtExceptionHandler && nil != exception) {`
	`16`	`+ crash.uncaughtExceptionHandler(exception);`
`15`	`17`	`}`
`16`	`18`	`[super reportException:exception];`
`17`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,7 @@`
`7`	`7`	`#import <SentryCrashCachedData.h>`
`8`	`8`	`#import <SentryCrashDebug.h>`
`9`	`9`	`#import <SentryCrashMonitor_System.h>`
	`10`	`+#import <SentryDependencyContainer.h>`
`10`	`11`	`#include <mach/mach.h>`
`11`	`12`
`12`	`13`	`NS_ASSUME_NONNULL_BEGIN`
`@@ -23,7 +24,7 @@ + (instancetype)sharedInstance`
`23`	`24`
`24`	`25`	`- (BOOL)crashedLastLaunch`
`25`	`26`	`{`
`26`		`- return SentryCrash.sharedInstance.crashedLastLaunch;`
	`27`	`+ return SentryDependencyContainer.sharedInstance.crashReporter.crashedLastLaunch;`
`27`	`28`	`}`
`28`	`29`
`29`	`30`	`- (NSTimeInterval)durationFromCrashStateInitToLastCrash`
`@@ -33,7 +34,7 @@ - (NSTimeInterval)durationFromCrashStateInitToLastCrash`
`33`	`34`
`34`	`35`	`- (NSTimeInterval)activeDurationSinceLastCrash`
`35`	`36`	`{`
`36`		`- return SentryCrash.sharedInstance.activeDurationSinceLastCrash;`
	`37`	`+ return SentryDependencyContainer.sharedInstance.crashReporter.activeDurationSinceLastCrash;`
`37`	`38`	`}`
`38`	`39`
`39`	`40`	`- (BOOL)isBeingTraced`
`@@ -55,7 +56,8 @@ - (NSDictionary *)systemInfo`
`55`	`56`	`{`
`56`	`57`	`static NSDictionary *sharedInfo = nil;`
`57`	`58`	`static dispatch_once_t onceToken;`
`58`		`- dispatch_once(&onceToken, ^{ sharedInfo = SentryCrash.sharedInstance.systemInfo; });`
	`59`	`+ dispatch_once(&onceToken,`
	`60`	`+ ^{ sharedInfo = SentryDependencyContainer.sharedInstance.crashReporter.systemInfo; });`
`59`	`61`	`return sharedInfo;`
`60`	`62`	`}`
`61`	`63`
Original file line number	Diff line number	Diff line change
`@@ -338,7 +338,7 @@ + (void)setUser:(SentryUser *_Nullable)user`
`338`	`338`
`339`	`339`	`+ (BOOL)crashedLastRun`
`340`	`340`	`{`
`341`		`- return SentryCrash.sharedInstance.crashedLastLaunch;`
	`341`	`+ return SentryDependencyContainer.sharedInstance.crashReporter.crashedLastLaunch;`
`342`	`342`	`}`
`343`	`343`
`344`	`344`	`+ (void)startSession`