Merge pull request #1 from justin-doordash/justinlennox/mergeRepos

Squash and merge commit

Author: justin-doordash

Sentry.xcodeproj/project.pbxproj

@@ -7,6 +7,8 @@
 	objects = {
 
 /* Begin PBXBuildFile section */
+		033082AA2AE0D6A1003D29A1 /* SentryBeforeCrashIntegration.h in Headers */ = {isa = PBXBuildFile; fileRef = 033082A92AE0D6A1003D29A1 /* SentryBeforeCrashIntegration.h */; };
+		033082AC2AE0D6B1003D29A1 /* SentryBeforeCrashIntegration.m in Sources */ = {isa = PBXBuildFile; fileRef = 033082AB2AE0D6B1003D29A1 /* SentryBeforeCrashIntegration.m */; };
 		0354A22B2A134D9C003C3A04 /* SentryProfilerState.h in Headers */ = {isa = PBXBuildFile; fileRef = 0354A22A2A134D9C003C3A04 /* SentryProfilerState.h */; };
 		03BCC38A27E1BF49003232C7 /* SentryTime.h in Headers */ = {isa = PBXBuildFile; fileRef = 03BCC38927E1BF49003232C7 /* SentryTime.h */; };
 		03BCC38C27E1C01A003232C7 /* SentryTime.mm in Sources */ = {isa = PBXBuildFile; fileRef = 03BCC38B27E1C01A003232C7 /* SentryTime.mm */; };
@@ -973,6 +975,8 @@
 /* End PBXCopyFilesBuildPhase section */
 
 /* Begin PBXFileReference section */
+		033082A92AE0D6A1003D29A1 /* SentryBeforeCrashIntegration.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = SentryBeforeCrashIntegration.h; path = include/SentryBeforeCrashIntegration.h; sourceTree = "<group>"; };
+		033082AB2AE0D6B1003D29A1 /* SentryBeforeCrashIntegration.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = SentryBeforeCrashIntegration.m; sourceTree = "<group>"; };
 		0354A22A2A134D9C003C3A04 /* SentryProfilerState.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = SentryProfilerState.h; path = Sources/Sentry/include/SentryProfilerState.h; sourceTree = SOURCE_ROOT; };
 		035E73C727D56757005EEB11 /* SentryBacktraceTests.mm */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.cpp.objcpp; path = SentryBacktraceTests.mm; sourceTree = "<group>"; };
 		035E73C927D57398005EEB11 /* SentryThreadHandleTests.mm */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.cpp.objcpp; path = SentryThreadHandleTests.mm; sourceTree = "<group>"; };
@@ -3092,6 +3096,8 @@
 				7BCFBD6E2681D0EE00BC27D8 /* SentryCrashScopeObserver.m */,
 				7B96571F26830C9100C66E25 /* SentryScopeSyncC.h */,
 				7B96572126830D2400C66E25 /* SentryScopeSyncC.c */,
+				033082A92AE0D6A1003D29A1 /* SentryBeforeCrashIntegration.h */,
+				033082AB2AE0D6B1003D29A1 /* SentryBeforeCrashIntegration.m */,
 				D84F833B2A1CC401005828E0 /* SentrySwiftAsyncIntegration.h */,
 				D84F833C2A1CC401005828E0 /* SentrySwiftAsyncIntegration.m */,
 			);
@@ -3906,6 +3912,7 @@
 				D8BBD32728FD9FC00011F850 /* SentrySwift.h in Headers */,
 				8E4E7C7425DAAB49006AB9E2 /* SentrySpanProtocol.h in Headers */,
 				8EC4CF4A25C38DAA0093DEE9 /* SentrySpanStatus.h in Headers */,
+				033082AA2AE0D6A1003D29A1 /* SentryBeforeCrashIntegration.h in Headers */,
 				8ECC673D25C23996000E2BF6 /* SentrySpanId.h in Headers */,
 				03F84D2227DD414C008FE43F /* SentryStackFrame.hpp in Headers */,
 				8ECC673E25C23996000E2BF6 /* SentrySpanContext.h in Headers */,
@@ -4706,6 +4713,7 @@
 				D8F016B32B9622D6007B9AFB /* SentryId.swift in Sources */,
 				D865893029D6ECA7000BE151 /* SentryCrashBinaryImageCache.c in Sources */,
 				7BC9A20428F4166D001E7C4C /* SentryMeasurementValue.m in Sources */,
+				033082AC2AE0D6B1003D29A1 /* SentryBeforeCrashIntegration.m in Sources */,
 				D859696B27BECD8F0036A46E /* SentryCoreDataTrackingIntegration.m in Sources */,
 				7BD86EC7264A641D005439DB /* SentrySysctl.m in Sources */,
 				84281C432A578E5600EE88F2 /* SentryProfilerState.mm in Sources */,

Sources/Sentry/Public/SentryDefines.h

@@ -99,6 +99,11 @@ typedef id<SentrySpan> _Nullable (^SentryBeforeSendSpanCallback)(id<SentrySpan>
  */
 typedef BOOL (^SentryBeforeCaptureScreenshotCallback)(SentryEvent *_Nonnull event);
 
+/**
+ * A callback to be notified right before the program terminated with a crash.
+ */
+typedef void (^SentryBeforeCrashCallback)(NSString *_Nonnull eventID);
+
 /**
  * A callback to be notified when the last program execution terminated with a crash.
  */

Sources/Sentry/Public/SentryEvent.h

@@ -16,6 +16,11 @@ NS_SWIFT_NAME(Event)
  */
 @property (nonatomic, strong) SentryId *eventId;
 
+/**
+ * The identifier of the Sentry report.
+ */
+@property (nonatomic, copy) NSString *reportId;
+
 /**
  * Message of the event.
  */

Sources/Sentry/Public/SentryOptions.h

@@ -92,6 +92,24 @@ NS_SWIFT_NAME(Options)
 
 #endif // !TARGET_OS_WATCH
 
+/**
+ * C Function to call before a crash to give the callee an opportunity to
+ * run a function before we crash. NULL = ignore.
+ *
+ * @warning Only call async-safe functions from this function! DO NOT call
+ * Objective-C methods!!!
+ * @note Default value is nil.
+ */
+@property (nullable, nonatomic, copy) SentryBeforeCrashCallback beforeCrash;
+
+
+/**
+ * When enabled, and when the beforeCrash handler is not null, this allows the callee
+ * an opportunity to run a function before we crash.
+ * @note Default value @c NO.
+ */
+@property (nonatomic, assign) BOOL enableBeforeCrashHandler;
+
 /**
  * How many breadcrumbs do you want to keep in memory?
  * @note Default is @c 100 .

Sources/Sentry/SentryBeforeCrashIntegration.m

@@ -0,0 +1,48 @@
+//
+//  SentryBeforeCrashIntegration.m
+//  Sentry
+//
+//  Created by Filip Busic on 10/16/23.
+//  Copyright © 2023 Sentry. All rights reserved.
+//
+
+#import "SentryBeforeCrashIntegration.h"
+#import "SentryCrashC.h"
+
+static void (^g_beforeCrashOptionsCallback)(NSString *) = nil;
+
+// Define a callback function
+void beforeCrashCallback(const char *eventID) {
+    if (g_beforeCrashOptionsCallback) {
+        g_beforeCrashOptionsCallback([NSString stringWithUTF8String:eventID]);
+    }
+}
+
+@implementation SentryBeforeCrashIntegration
+
+- (BOOL)installWithOptions:(nonnull SentryOptions *)options
+{
+    if (![super installWithOptions:options]) {
+        return NO;
+    }
+    
+    if (options.enableBeforeCrashHandler) {
+        g_beforeCrashOptionsCallback = options.beforeCrash;
+        sentrycrash_setBeforeCrashCallback(&beforeCrashCallback);
+    }
+    
+    return options.enableBeforeCrashHandler;
+}
+
+- (void)uninstall
+{
+    g_beforeCrashOptionsCallback = nil;
+    sentrycrash_setBeforeCrashCallback(nil);
+}
+
+- (SentryIntegrationOption)integrationOptions
+{
+    return kIntegrationOptionDebuggerNotAttached;
+}
+
+@end

Sources/Sentry/SentryCrashReportConverter.m

@@ -106,6 +106,7 @@ - (SentryEvent *_Nullable)convertReportToEvent
         } else {
             event.timestamp = sentry_fromIso8601String(self.report[@"report"][@"timestamp"]);
         }
+        event.reportId = self.report[@"report"][@"id"];
         event.threads = [self convertThreads];
         event.debugMeta = [self debugMetaForThreads:event.threads];
         event.exceptions = [self convertExceptions];

Sources/Sentry/SentryOptions.m

@@ -19,6 +19,7 @@
 #import "SentrySwift.h"
 #import "SentrySwiftAsyncIntegration.h"
 #import "SentryTracer.h"
+#import "SentryBeforeCrashIntegration.h"
 #import <objc/runtime.h>
 
 #if SENTRY_HAS_UIKIT
@@ -65,7 +66,8 @@ @implementation SentryOptions {
             NSStringFromClass([SentryCoreDataTrackingIntegration class]),
             NSStringFromClass([SentryFileIOTrackingIntegration class]),
             NSStringFromClass([SentryNetworkTrackingIntegration class]),
-            NSStringFromClass([SentrySwiftAsyncIntegration class])
+            NSStringFromClass([SentrySwiftAsyncIntegration class]),
+            NSStringFromClass([SentryBeforeCrashIntegration class])
         ]
             .mutableCopy;
 
@@ -87,6 +89,7 @@ - (instancetype)init
 #if !TARGET_OS_WATCH
         self.enableSigtermReporting = NO;
 #endif // !TARGET_OS_WATCH
+        self.enableBeforeCrashHandler = NO;
         self.diagnosticLevel = kSentryLevelDebug;
         self.debug = NO;
         self.maxBreadcrumbs = defaultMaxBreadcrumbs;
@@ -448,6 +451,14 @@ - (BOOL)validateOptions:(NSDictionary<NSString *, id> *)options
     if ([self isBlock:options[@"tracesSampler"]]) {
         self.tracesSampler = options[@"tracesSampler"];
     }
+    
+    [self setBool:options[@"enableBeforeCrashHandler"]
+            block:^(BOOL value) { self->_enableBeforeCrashHandler = value; }];
+    
+    if ([self isBlock:options[@"beforeCrash"]]) {
+        self.beforeCrash = options[@"beforeCrash"];
+    }
+
 #pragma clang diagnostic push
 #pragma clang diagnostic ignored "-Wdeprecated-declarations"
     if ([options[@"enableTracing"] isKindOfClass:NSNumber.self]) {

Sources/Sentry/include/SentryBeforeCrashIntegration.h

@@ -0,0 +1,11 @@
+#import "SentryBaseIntegration.h"
+#import "SentryIntegrationProtocol.h"
+#import <Foundation/Foundation.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface SentryBeforeCrashIntegration : SentryBaseIntegration <SentryIntegrationProtocol>
+
+@end
+
+NS_ASSUME_NONNULL_END

Sources/SentryCrash/Recording/SentryCrashC.c

@@ -57,6 +57,7 @@ static SentryCrashMonitorType g_monitoring = SentryCrashMonitorTypeProductionSaf
 static char g_lastCrashReportFilePath[SentryCrashFU_MAX_PATH_LENGTH];
 static void (*g_saveScreenShot)(const char *) = 0;
 static void (*g_saveViewHierarchy)(const char *) = 0;
+static void (*g_beforeCrashCallback)(const char *) = 0;
 
 // ============================================================================
 #pragma mark - Utility -
@@ -106,6 +107,10 @@ onCrash(struct SentryCrash_MonitorContext *monitorContext)
             }
         }
     }
+    
+    if (g_beforeCrashCallback) {
+        g_beforeCrashCallback(monitorContext->eventID);
+    }
 }
 
 // ============================================================================
@@ -193,6 +198,12 @@ sentrycrash_setSaveScreenshots(void (*callback)(const char *))
     g_saveScreenShot = callback;
 }
 
+void
+sentrycrash_setBeforeCrashCallback(void (*callback)(const char *))
+{
+    g_beforeCrashCallback = callback;
+}
+
 void
 sentrycrash_setSaveViewHierarchy(void (*callback)(const char *))
 {

Sources/SentryCrash/Recording/SentryCrashC.h

@@ -139,6 +139,11 @@ void sentrycrash_setSaveScreenshots(SaveAttachmentCallback callback);
  */
 void sentrycrash_setSaveViewHierarchy(SaveAttachmentCallback callback);
 
+/**
+ * Set the callback to be called at the end of a crash.
+ */
+void sentrycrash_setBeforeCrashCallback(void (*callback)(const char *eventID));
+
 /** Report a custom, user defined exception.
  * This can be useful when dealing with scripting languages.
  *