ref: Convert SentryCrash to swift (#6438)

noahsmartin · web-flow · commit ed67bc2e69fb · 2025-10-16T16:32:56.000-04:00
diff --git a/Sentry.xcodeproj/project.pbxproj b/Sentry.xcodeproj/project.pbxproj
@@ -1116,6 +1116,7 @@
 		FAB007362E9EF8D3001C806A /* SentryUIViewControllerPerformanceTracker.swift in Sources */ = {isa = PBXBuildFile; fileRef = FAB007302E9EF8CB001C806A /* SentryUIViewControllerPerformanceTracker.swift */; };
 		FAB007432E9F47E8001C806A /* SessionTracker.swift in Sources */ = {isa = PBXBuildFile; fileRef = FAB007422E9F47E4001C806A /* SessionTracker.swift */; };
 		FAB007522E9FE2FF001C806A /* SentrySwizzleWrapper.swift in Sources */ = {isa = PBXBuildFile; fileRef = FAB0074C2E9FE2FA001C806A /* SentrySwizzleWrapper.swift */; };
+		FAB007812EA01B98001C806A /* SentryCrashSwift.swift in Sources */ = {isa = PBXBuildFile; fileRef = FAB0077B2EA01B95001C806A /* SentryCrashSwift.swift */; };
 		FAB359982E05D7E90083D5E3 /* SentryEventSwiftHelper.h in Headers */ = {isa = PBXBuildFile; fileRef = FAB359972E05D7E90083D5E3 /* SentryEventSwiftHelper.h */; };
 		FAB3599A2E05D8080083D5E3 /* SentryEventSwiftHelper.m in Sources */ = {isa = PBXBuildFile; fileRef = FAB359992E05D8080083D5E3 /* SentryEventSwiftHelper.m */; };
 		FAB7BBA92E2577A6007301E1 /* SentryModels+Serializable.h in Headers */ = {isa = PBXBuildFile; fileRef = FAB7BBA82E2577A2007301E1 /* SentryModels+Serializable.h */; };
@@ -2480,6 +2481,7 @@
 		FAB007302E9EF8CB001C806A /* SentryUIViewControllerPerformanceTracker.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentryUIViewControllerPerformanceTracker.swift; sourceTree = "<group>"; };
 		FAB007422E9F47E4001C806A /* SessionTracker.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SessionTracker.swift; sourceTree = "<group>"; };
 		FAB0074C2E9FE2FA001C806A /* SentrySwizzleWrapper.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentrySwizzleWrapper.swift; sourceTree = "<group>"; };
+		FAB0077B2EA01B95001C806A /* SentryCrashSwift.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SentryCrashSwift.swift; sourceTree = "<group>"; };
 		FAB359972E05D7E90083D5E3 /* SentryEventSwiftHelper.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; name = SentryEventSwiftHelper.h; path = include/SentryEventSwiftHelper.h; sourceTree = "<group>"; };
 		FAB359992E05D8080083D5E3 /* SentryEventSwiftHelper.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = SentryEventSwiftHelper.m; sourceTree = "<group>"; };
 		FAB7BBA82E2577A2007301E1 /* SentryModels+Serializable.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; name = "SentryModels+Serializable.h"; path = "include/SentryModels+Serializable.h"; sourceTree = "<group>"; };
@@ -4825,6 +4827,7 @@
 		F4FE9E062E6248BB0014FED5 /* SentryCrash */ = {
 			isa = PBXGroup;
 			children = (
+				FAB0077B2EA01B95001C806A /* SentryCrashSwift.swift */,
 				FA8AFCE72E8434A0007A0E18 /* SentryThreadInspector.swift */,
 				FAE579C62E7DE14400B710F9 /* SentryFrameRemover.swift */,
 				F4FE9E072E6248E40014FED5 /* SentryCrashWrapper.swift */,
@@ -5773,6 +5776,7 @@
 				844EDC77294144DB00C86F34 /* SentrySystemWrapper.mm in Sources */,
 				D451ED5F2D92ECDE00C9BEA8 /* SentryReplayFrame.swift in Sources */,
 				FAE579CC2E7DE14900B710F9 /* SentryFrameRemover.swift in Sources */,
+				FAB007812EA01B98001C806A /* SentryCrashSwift.swift in Sources */,
 				D49480D72DC23FE300A3B6E9 /* SentrySessionReplayDelegate.swift in Sources */,
 				FA67DCC12DDBD4C800896B02 /* SentrySDKLog+Configure.swift in Sources */,
 				6281C5722D3E4F12009D0978 /* DecodeArbitraryData.swift in Sources */,
diff --git a/Sources/Sentry/SentryCrashExceptionApplicationHelper.m b/Sources/Sentry/SentryCrashExceptionApplicationHelper.m
@@ -8,12 +8,13 @@
 #    import "SentryDependencyContainer.h"
 #    import "SentrySDK+Private.h"
 #    import "SentrySDKInternal.h"
+#    import "SentrySwift.h"
 
 @implementation SentryCrashExceptionApplicationHelper
 
 + (void)reportException:(NSException *)exception
 {
-    SentryCrash *crash = SentryDependencyContainer.sharedInstance.crashReporter;
+    SentryCrashSwift *crash = SentryDependencyContainer.sharedInstance.crashReporter;
     if (nil != crash.uncaughtExceptionHandler && nil != exception) {
         crash.uncaughtExceptionHandler(exception);
     }
diff --git a/Sources/Sentry/SentryCrashInstallationReporter.m b/Sources/Sentry/SentryCrashInstallationReporter.m
@@ -4,6 +4,10 @@
 #import "SentryCrashReportSink.h"
 #import "SentryDefines.h"
 #import "SentryLogC.h"
+#import "SentrySwift.h"
+
+@interface SentryCrashReportSink () <SentryCrashReportFilter>
+@end
 
 NS_ASSUME_NONNULL_BEGIN
 
diff --git a/Sources/Sentry/SentryDependencyContainer.m b/Sources/Sentry/SentryDependencyContainer.m
@@ -9,7 +9,6 @@
 #import "SentrySDK+Private.h"
 #import "SentrySwift.h"
 #import "SentrySystemWrapper.h"
-#import <SentryCrash.h>
 #import <SentryDebugImageProvider+HybridSDKs.h>
 #import <SentryDefaultAppStateManager.h>
 #import <SentryDefaultUIViewControllerPerformanceTracker.h>
@@ -242,10 +241,10 @@ - (SentryFileIOTracker *)fileIOTracker
     return SentryDependencies.fileIOTracker;
 }
 
-- (SentryCrash *)crashReporter SENTRY_THREAD_SANITIZER_DOUBLE_CHECKED_LOCK
+- (SentryCrashSwift *)crashReporter SENTRY_THREAD_SANITIZER_DOUBLE_CHECKED_LOCK
 {
     SENTRY_LAZY_INIT(_crashReporter,
-        [[SentryCrash alloc] initWithBasePath:SentrySDKInternal.options.cacheDirectoryPath]);
+        [[SentryCrashSwift alloc] initWith:SentrySDKInternal.options.cacheDirectoryPath]);
 }
 
 - (id<SentryANRTracker>)getANRTracker:(NSTimeInterval)timeout
diff --git a/Sources/Sentry/SentryDependencyContainerSwiftHelper.m b/Sources/Sentry/SentryDependencyContainerSwiftHelper.m
@@ -32,9 +32,19 @@ + (SentryHub *)currentHub
     return SentrySDKInternal.currentHub;
 }
 
-+ (SentryCrash *)crashReporter
++ (nullable NSDictionary *)systemInfo
 {
-    return SentryDependencyContainer.sharedInstance.crashReporter;
+    return SentryDependencyContainer.sharedInstance.crashReporter.systemInfo;
+}
+
++ (BOOL)crashedLastLaunch
+{
+    return SentryDependencyContainer.sharedInstance.crashReporter.crashedLastLaunch;
+}
+
++ (NSTimeInterval)activeDurationSinceLastCrash
+{
+    return SentryDependencyContainer.sharedInstance.crashReporter.activeDurationSinceLastCrash;
 }
 
 + (nullable NSDate *)readTimestampLastInForeground
diff --git a/Sources/Sentry/SentryUncaughtNSExceptions.m b/Sources/Sentry/SentryUncaughtNSExceptions.m
@@ -4,6 +4,7 @@
 
 #    import "SentryCrash.h"
 #    import "SentryDependencyContainer.h"
+#    import "SentrySwift.h"
 #    import "SentrySwizzle.h"
 #    import "SentryUncaughtNSExceptions.h"
 #    import <AppKit/NSApplication.h>
@@ -34,7 +35,7 @@ + (void)swizzleNSApplicationReportException
 
 + (void)capture:(nullable NSException *)exception
 {
-    SentryCrash *crash = SentryDependencyContainer.sharedInstance.crashReporter;
+    SentryCrashSwift *crash = SentryDependencyContainer.sharedInstance.crashReporter;
 
     if (crash.uncaughtExceptionHandler == nil) {
         return;
diff --git a/Sources/Sentry/include/HybridPublic/SentryDependencyContainer.h b/Sources/Sentry/include/HybridPublic/SentryDependencyContainer.h
@@ -5,7 +5,7 @@
 #endif
 
 @class SentryBinaryImageCache;
-@class SentryCrash;
+@class SentryCrashSwift;
 @class SentryCrashWrapper;
 @class SentryDebugImageProvider;
 @class SentryDispatchFactory;
@@ -107,7 +107,7 @@ SENTRY_NO_INIT
 @property (nonatomic, strong) id<SentryAppStateManager> appStateManager;
 @property (nonatomic, strong, readonly) SentryThreadInspector *threadInspector;
 @property (nonatomic, strong, readonly) SentryFileIOTracker *fileIOTracker;
-@property (nonatomic, strong) SentryCrash *crashReporter;
+@property (nonatomic, strong) SentryCrashSwift *crashReporter;
 @property (nonatomic, strong) SentryScopePersistentStore *scopePersistentStore;
 @property (nonatomic, strong) SentryDebugImageProvider *debugImageProvider;
 
diff --git a/Sources/Sentry/include/SentryCrashReportFilter.h b/Sources/Sentry/include/SentryCrashReportFilter.h
@@ -27,6 +27,8 @@
 
 #import <Foundation/Foundation.h>
 
+NS_ASSUME_NONNULL_BEGIN
+
 /** Callback for filter operations.
  *
  * @param filteredReports The filtered reports (may be incomplete if "completed"
@@ -37,7 +39,7 @@
  * @param error Non-nil if an error occurred.
  */
 typedef void (^SentryCrashReportFilterCompletion)(
-    NSArray *filteredReports, BOOL completed, NSError *error);
+    NSArray *_Nullable filteredReports, BOOL completed, NSError *_Nullable error);
 
 /**
  * A filter receives a set of reports, possibly transforms them, and then
@@ -63,10 +65,12 @@ typedef void (^SentryCrashReportFilterCompletion)(
  * @param error The parameter to send as "error".
  */
 static inline void
-sentrycrash_callCompletion(SentryCrashReportFilterCompletion onCompletion, NSArray *filteredReports,
-    BOOL completed, NSError *error)
+sentrycrash_callCompletion(SentryCrashReportFilterCompletion onCompletion,
+    NSArray *_Nullable filteredReports, BOOL completed, NSError *_Nullable error)
 {
     if (onCompletion) {
         onCompletion(filteredReports, completed, error);
     }
 }
+
+NS_ASSUME_NONNULL_END
diff --git a/Sources/Sentry/include/SentryCrashReportWriter.h b/Sources/Sentry/include/SentryCrashReportWriter.h
@@ -224,6 +224,8 @@ typedef struct SentryCrashReportWriter {
 
 typedef void (*SentryCrashReportWriteCallback)(const SentryCrashReportWriter *writer);
 
+void sentry_crashCallback(const SentryCrashReportWriter *writer);
+
 #ifdef __cplusplus
 }
 #endif
diff --git a/Sources/Sentry/include/SentryDependencyContainerSwiftHelper.h b/Sources/Sentry/include/SentryDependencyContainerSwiftHelper.h
@@ -29,7 +29,9 @@ NS_ASSUME_NONNULL_BEGIN
 + (void)dispatchSyncOnMainQueue:(void (^)(void))block;
 + (id<SentryObjCRuntimeWrapper>)objcRuntimeWrapper;
 + (SentryHub *)currentHub;
-+ (SentryCrash *)crashReporter;
++ (nullable NSDictionary *)systemInfo;
++ (BOOL)crashedLastLaunch;
++ (NSTimeInterval)activeDurationSinceLastCrash;
 + (nullable NSDate *)readTimestampLastInForeground;
 + (void)deleteTimestampLastInForeground;
 + (void)storeTimestampLastInForeground:(NSDate *)timestamp;
diff --git a/Sources/SentryCrash/Installations/SentryCrashInstallation+Private.h b/Sources/SentryCrash/Installations/SentryCrashInstallation+Private.h
@@ -27,6 +27,8 @@
 
 #import "SentryCrashInstallation.h"
 
+@protocol SentryCrashReportFilter;
+
 typedef struct {
     const char *key;
     const char *value;
diff --git a/Sources/SentryCrash/Installations/SentryCrashInstallation.m b/Sources/SentryCrash/Installations/SentryCrashInstallation.m
@@ -33,15 +33,16 @@
 #import "SentryCrashNSErrorUtil.h"
 #import "SentryCrashReportFilterBasic.h"
 #import "SentryDependencyContainer.h"
+#import "SentrySwift.h"
 #import <objc/runtime.h>
 
 /** Max number of properties that can be defined for writing to the report */
 #define kMaxProperties 500
 
 static CrashHandlerData *g_crashHandlerData;
 
-static void
-crashCallback(const SentryCrashReportWriter *writer)
+void
+sentry_crashCallback(const SentryCrashReportWriter *writer)
 {
     for (int i = 0; i < g_crashHandlerData->reportFieldsCount; i++) {
         ReportField *field = g_crashHandlerData->reportFields[i];
@@ -93,11 +94,11 @@ - (id)initWithRequiredProperties:(NSArray *)requiredProperties
 
 - (void)dealloc
 {
-    SentryCrash *handler = SentryDependencyContainer.sharedInstance.crashReporter;
+    SentryCrashSwift *handler = SentryDependencyContainer.sharedInstance.crashReporter;
     @synchronized(handler) {
         if (g_crashHandlerData == self.crashHandlerData) {
             g_crashHandlerData = NULL;
-            handler.onCrash = NULL;
+            [handler removeOnCrash];
         }
     }
 }
@@ -162,22 +163,22 @@ - (NSArray *)makeKeyPaths:(NSArray *)keyPaths
 
 - (void)install:(NSString *)customCacheDirectory
 {
-    SentryCrash *handler = SentryDependencyContainer.sharedInstance.crashReporter;
+    SentryCrashSwift *handler = SentryDependencyContainer.sharedInstance.crashReporter;
     @synchronized(handler) {
         handler.basePath = customCacheDirectory;
         g_crashHandlerData = self.crashHandlerData;
-        handler.onCrash = crashCallback;
+        [handler setupOnCrash];
         [handler install];
     }
 }
 
 - (void)uninstall
 {
-    SentryCrash *handler = SentryDependencyContainer.sharedInstance.crashReporter;
+    SentryCrashSwift *handler = SentryDependencyContainer.sharedInstance.crashReporter;
     @synchronized(handler) {
         if (g_crashHandlerData == self.crashHandlerData) {
             g_crashHandlerData = NULL;
-            handler.onCrash = NULL;
+            [handler removeOnCrash];
         }
         [handler uninstall];
     }
@@ -204,8 +205,12 @@ - (void)sendAllReportsWithCompletion:(SentryCrashReportFilterCompletion)onComple
 
     sink = [SentryCrashReportFilterPipeline filterWithFilters:sink, nil];
 
-    SentryCrash *handler = SentryDependencyContainer.sharedInstance.crashReporter;
-    handler.sink = sink;
+    SentryCrashSwift *handler = SentryDependencyContainer.sharedInstance.crashReporter;
+    handler.sink =
+        [[SentryCrashReportFilterSwift alloc] initWithFilterReports:^(NSArray *_Nonnull array,
+            void (^_Nonnull completion)(NSArray *_Nullable, BOOL, NSError *_Nullable)) {
+            [sink filterReports:array onCompletion:completion];
+        }];
     [handler sendAllReportsWithCompletion:onCompletion];
 }
 
diff --git a/Sources/SentryCrash/Recording/Monitors/SentryCrashMonitor_NSException.m b/Sources/SentryCrash/Recording/Monitors/SentryCrashMonitor_NSException.m
@@ -32,6 +32,7 @@
 #import "SentryCrashStackCursor_Backtrace.h"
 #include "SentryCrashThread.h"
 #import "SentryDependencyContainer.h"
+#import "SentrySwift.h"
 
 #import "SentryLogC.h"
 
diff --git a/Sources/Swift/SentryCrash/SentryCrashSwift.swift b/Sources/Swift/SentryCrash/SentryCrashSwift.swift
@@ -0,0 +1,97 @@
+@_implementationOnly import _SentryPrivate
+
+// This provides the public API for passing what is essentially a `SentryCrashReportFilter` to Swift.
+@_spi(Private) @objc public final class SentryCrashReportFilterSwift: NSObject {
+    
+    fileprivate let filter: ([Any], @escaping ([Any]?, Bool, Error?) -> Void) -> Void
+
+    @objc public init(filterReports filter: @escaping ([Any], @escaping ([Any]?, Bool, Error?) -> Void) -> Void) {
+        self.filter = filter
+    }
+}
+
+// This class converts from the Swift type `SentryCrashReportFilterSwift` to the ObjC protocol `SentryCrashReportFilter`.
+private final class CrashReportFilterBridge: NSObject, SentryCrashReportFilter {
+    private let filter: SentryCrashReportFilterSwift
+    init(filter: SentryCrashReportFilterSwift) {
+        self.filter = filter
+    }
+
+    func filterReports(_ reports: [Any], onCompletion: @escaping SentryCrashReportFilterCompletion) {
+        filter.filter(reports, onCompletion)
+    }
+    
+}
+
+@_spi(Private) @objc public final class SentryCrashSwift: NSObject {
+    
+    private let sentryCrash: SentryCrash
+    
+    @objc public init(with basePath: String?) {
+        sentryCrash = SentryCrash(basePath: basePath)
+    }
+    
+    @objc public var crashedLastLaunch: Bool {
+        sentryCrash.crashedLastLaunch
+    }
+    
+    @objc public var activeDurationSinceLastCrash: TimeInterval {
+        sentryCrash.activeDurationSinceLastCrash
+    }
+    
+    @objc public func setSink(_ newValue: SentryCrashReportFilterSwift?) {
+        if let newValue {
+          sentryCrash.sink = CrashReportFilterBridge(filter: newValue)
+        } else {
+          sentryCrash.sink = nil
+        }
+    }
+    
+    @objc public func setupOnCrash() {
+        sentryCrash.onCrash = sentry_crashCallback
+    }
+    
+    @objc public func removeOnCrash() {
+        sentryCrash.onCrash = nil
+    }
+    
+    @objc public var uncaughtExceptionHandler: (@convention(c) (NSException) -> Void)? {
+        get { sentryCrash.uncaughtExceptionHandler }
+        set { sentryCrash.uncaughtExceptionHandler = newValue }
+    }
+    
+    @objc public var basePath: String {
+        get { sentryCrash.basePath }
+        set { sentryCrash.basePath = newValue }
+    }
+    
+    @objc public func install() {
+        sentryCrash.install()
+    }
+    
+    @objc public func uninstall() {
+        sentryCrash.uninstall()
+    }
+    
+    @objc public var systemInfo: [AnyHashable: Any]? {
+        sentryCrash.systemInfo
+    }
+    
+    @objc public var userInfo: [AnyHashable: Any] {
+        get { sentryCrash.userInfo }
+        set { sentryCrash.userInfo = newValue }
+    }
+    
+    @objc public func sendAllReports(completion: @escaping ([Any]?, Bool, (any Error)?) -> Void) {
+        sentryCrash.sendAllReports(completion: completion)
+    }
+
+    // Only visible for testing
+    @objc public var monitoring: UInt32 {
+        sentryCrash.monitoring.rawValue
+    }
+
+    @objc public func hasOnCrash() -> Bool {
+        sentryCrash.onCrash != nil
+    }
+}
diff --git a/Sources/Swift/SentryCrash/SentryCrashWrapper.swift b/Sources/Swift/SentryCrash/SentryCrashWrapper.swift
diff --git a/Tests/SentryTests/Integrations/SentryCrash/SentryCrashReportTests.swift b/Tests/SentryTests/Integrations/SentryCrash/SentryCrashReportTests.swift
diff --git a/Tests/SentryTests/Integrations/SentryCrash/SentryUncaughtNSExceptionsTests.swift b/Tests/SentryTests/Integrations/SentryCrash/SentryUncaughtNSExceptionsTests.swift
diff --git a/Tests/SentryTests/SentryCrash/SentryCrashInstallationTests.swift b/Tests/SentryTests/SentryCrash/SentryCrashInstallationTests.swift
diff --git a/Tests/SentryTests/SentryCrashExceptionApplicationTests.swift b/Tests/SentryTests/SentryCrashExceptionApplicationTests.swift

Original file line number	Diff line number	Diff line change
`@@ -8,12 +8,13 @@`
`8`	`8`	`# import "SentryDependencyContainer.h"`
`9`	`9`	`# import "SentrySDK+Private.h"`
`10`	`10`	`# import "SentrySDKInternal.h"`
	`11`	`+# import "SentrySwift.h"`
`11`	`12`
`12`	`13`	`@implementation SentryCrashExceptionApplicationHelper`
`13`	`14`
`14`	`15`	`+ (void)reportException:(NSException *)exception`
`15`	`16`	`{`
`16`		`- SentryCrash *crash = SentryDependencyContainer.sharedInstance.crashReporter;`
	`17`	`+ SentryCrashSwift *crash = SentryDependencyContainer.sharedInstance.crashReporter;`
`17`	`18`	`if (nil != crash.uncaughtExceptionHandler && nil != exception) {`
`18`	`19`	`crash.uncaughtExceptionHandler(exception);`
`19`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,6 @@`
`9`	`9`	`#import "SentrySDK+Private.h"`
`10`	`10`	`#import "SentrySwift.h"`
`11`	`11`	`#import "SentrySystemWrapper.h"`
`12`		`-#import <SentryCrash.h>`
`13`	`12`	`#import <SentryDebugImageProvider+HybridSDKs.h>`
`14`	`13`	`#import <SentryDefaultAppStateManager.h>`
`15`	`14`	`#import <SentryDefaultUIViewControllerPerformanceTracker.h>`
`@@ -242,10 +241,10 @@ - (SentryFileIOTracker *)fileIOTracker`
`242`	`241`	`return SentryDependencies.fileIOTracker;`
`243`	`242`	`}`
`244`	`243`
`245`		`-- (SentryCrash *)crashReporter SENTRY_THREAD_SANITIZER_DOUBLE_CHECKED_LOCK`
	`244`	`+- (SentryCrashSwift *)crashReporter SENTRY_THREAD_SANITIZER_DOUBLE_CHECKED_LOCK`
`246`	`245`	`{`
`247`	`246`	`SENTRY_LAZY_INIT(_crashReporter,`
`248`		`- [[SentryCrash alloc] initWithBasePath:SentrySDKInternal.options.cacheDirectoryPath]);`
	`247`	`+ [[SentryCrashSwift alloc] initWith:SentrySDKInternal.options.cacheDirectoryPath]);`
`249`	`248`	`}`
`250`	`249`
`251`	`250`	`- (id<SentryANRTracker>)getANRTracker:(NSTimeInterval)timeout`
Original file line number	Diff line number	Diff line change
`@@ -224,6 +224,8 @@ typedef struct SentryCrashReportWriter {`
`224`	`224`
`225`	`225`	`typedef void (SentryCrashReportWriteCallback)(const SentryCrashReportWriter writer);`
`226`	`226`
	`227`	`+void sentry_crashCallback(const SentryCrashReportWriter *writer);`
	`228`	`+`
`227`	`229`	`#ifdef __cplusplus`
`228`	`230`	`}`
`229`	`231`	`#endif`