Improve iOS crash reports by adding scope data (#491)

* Update

* Update

* Update

* Update

* Update CHANGELOG.md

* Update CHANGELOG.md

Co-authored-by: Roman Zavarnitsyn <rom4ek93@gmail.com>

* set appendCausedBy to true by default when handling ios crashes

* Update CHANGELOG for iOS crash reports and SDK bump

* Update SentryDependencyContainer.h

---------

Co-authored-by: Roman Zavarnitsyn <rom4ek93@gmail.com>

Author: buenaflor

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## 0.22.0
 
+### Features
+
+- Improve iOS crash reports by adding scope data ([#491](https://github.com/getsentry/sentry-kotlin-multiplatform/pull/491))
+ - ⚠️ This change will most likely affect issue grouping as Sentry now properly symbolicates Kotlin iOS crashes
+
 ### Dependencies
 
 - Bump Java SDK from v8.25.0 to v8.27.1 ([#487](https://github.com/getsentry/sentry-kotlin-multiplatform/pull/487))

sentry-kotlin-multiplatform/src/appleMain/kotlin/io/sentry/kotlin/multiplatform/nsexception/SentryUnhandledExceptions.kt

@@ -16,6 +16,7 @@ package io.sentry.kotlin.multiplatform.nsexception
 
 import Internal.Sentry.NSExceptionKt_SentryCrashStackCursorFromNSException
 import Internal.Sentry.kSentryLevelFatal
+import kotlinx.cinterop.invoke
 import platform.Foundation.NSException
 import platform.Foundation.NSNumber
 
@@ -54,12 +55,22 @@ internal fun dropKotlinCrashEvent(event: CocoapodsSentryEvent?): CocoapodsSentry
  * @see wrapUnhandledExceptionHook
  */
 public fun setSentryUnhandledExceptionHook(): Unit = wrapUnhandledExceptionHook { throwable ->
-    val envelope = throwable.asSentryEnvelope()
-    // The envelope will be persisted, so we can safely terminate afterwards.
-    // https://github.com/getsentry/sentry-cocoa/blob/678172142ac1d10f5ed7978f69d16ab03e801057/Sources/Sentry/SentryClient.m#L409
-    InternalSentrySDK.storeEnvelope(envelope as objcnames.classes.SentryEnvelope)
-    CocoapodsSentrySDK.configureScope { scope ->
-        scope?.setTagValue(KOTLIN_CRASH_TAG, KOTLIN_CRASH_TAG)
+    val crashReporter = InternalSentryDependencyContainer.sharedInstance().crashReporter
+    val handler = crashReporter.uncaughtExceptionHandler
+
+    if (handler != null) {
+        // This will:
+        // 1. Write a crash report to disk with ALL synced scope data
+        // 2. Include tags, user, context, breadcrumbs, etc.
+        // 3. The crash will be sent on next app launch
+        handler.invoke(throwable.asNSException(appendCausedBy = true))
+    } else {
+        // Fallback to old approach if handler not available
+        val envelope = throwable.asSentryEnvelope()
+        InternalSentrySDK.storeEnvelope(envelope as objcnames.classes.SentryEnvelope)
+        CocoapodsSentrySDK.configureScope { scope ->
+            scope?.setTagValue(KOTLIN_CRASH_TAG, KOTLIN_CRASH_TAG)
+        }
     }
 }
 

sentry-kotlin-multiplatform/src/nativeInterop/cinterop/Sentry.Internal.def

@@ -2,4 +2,4 @@ language = Objective-C
 headers = SentryClient.h SentryEvent.h SentryDebugImageProvider.h SentryHub.h SentryScope.h \
           SentryCrashMonitor_NSException.h SentryCrashMonitor_NSException+NSExceptionKt.h \
           SentryCrashStackCursor.h SentryDependencyContainer.h SentryHook.h SentrySDKInternal.h \
-          SentryStacktraceBuilder.h SentryThreadInspector.h PrivateSentrySDKOnly.h \
+          SentryStacktraceBuilder.h SentryThreadInspector.h PrivateSentrySDKOnly.h SentryCrash.h \

sentry-kotlin-multiplatform/src/nativeInterop/cinterop/SentryInternal/SentryCrash.h

@@ -0,0 +1,8 @@
+// SentryCrash interface - expose the uncaughtExceptionHandler
+// Based on: https://github.com/getsentry/sentry-cocoa/blob/main/Sources/Sentry/include/SentryCrash.h
+
+@interface SentryCrash : NSObject
+
+@property (nonatomic, assign, nullable) NSUncaughtExceptionHandler *uncaughtExceptionHandler;
+
+@end

sentry-kotlin-multiplatform/src/nativeInterop/cinterop/SentryInternal/SentryDependencyContainer.h

@@ -18,11 +18,13 @@
 
 #import <Foundation/Foundation.h>
 #import <SentryDebugImageProvider.h>
+#import <SentryCrash.h>
 
 @interface SentryDependencyContainer : NSObject
 
 + (nonnull instancetype)sharedInstance;
 
 @property (nonatomic, strong, nonnull) SentryDebugImageProvider *debugImageProvider;
+@property (nonatomic, strong, nonnull) SentryCrash *crashReporter;
 
 @end