ref: json serialization error reporting

Sources/Sentry/Public/SentryError.h

@@ -15,6 +15,10 @@ typedef NS_ENUM(NSInteger, SentryError) {
 };
 
 SENTRY_EXTERN NSError *_Nullable NSErrorFromSentryError(SentryError error, NSString *description);
+SENTRY_EXTERN NSError *_Nullable NSErrorFromSentryErrorWithUnderlyingError(
+    SentryError error, NSString *description, NSError *underlyingError);
+SENTRY_EXTERN NSError *_Nullable NSErrorFromSentryErrorWithException(
+    SentryError error, NSString *description, NSException *exception);
 
 SENTRY_EXTERN NSString *const SentryErrorDomain;
 

Sources/Sentry/SentryError.m

@@ -4,11 +4,30 @@
 
 NSString *const SentryErrorDomain = @"SentryErrorDomain";
 
-NSError *_Nullable NSErrorFromSentryError(SentryError error, NSString *description)
+NSError *_Nullable _SentryError(SentryError error, NSDictionary *userInfo)
 {
-    NSMutableDictionary *userInfo = [NSMutableDictionary new];
-    [userInfo setValue:description forKey:NSLocalizedDescriptionKey];
     return [NSError errorWithDomain:SentryErrorDomain code:error userInfo:userInfo];
 }
 
+NSError *_Nullable NSErrorFromSentryErrorWithUnderlyingError(
+    SentryError error, NSString *description, NSError *underlyingError)
+{
+    return _SentryError(error,
+        @ { NSLocalizedDescriptionKey : description, NSUnderlyingErrorKey : underlyingError });
+}
+
+NSError *_Nullable NSErrorFromSentryErrorWithException(
+    SentryError error, NSString *description, NSException *exception)
+{
+    return _SentryError(error, @ {
+        NSLocalizedDescriptionKey :
+            [NSString stringWithFormat:@"%@ (%@)", description, exception.reason],
+    });
+}
+
+NSError *_Nullable NSErrorFromSentryError(SentryError error, NSString *description)
+{
+    return _SentryError(error, @ { NSLocalizedDescriptionKey : description });
+}
+
 NS_ASSUME_NONNULL_END

Sources/Sentry/SentrySerialization.m

@@ -17,16 +17,33 @@ @implementation SentrySerialization
 + (NSData *_Nullable)dataWithJSONObject:(NSDictionary *)dictionary
                                   error:(NSError *_Nullable *_Nullable)error
 {
+// We'll do this whether we're handling an exception or library error
+#define SENTRY_HANDLE_ERROR(__sentry_error)                                                        \
+    SENTRY_LOG_ERROR(@"Invalid JSON: %@", __sentry_error);                                         \
+    *error = __sentry_error;                                                                       \
+    return nil;
+
     NSData *data = nil;
-    if ([NSJSONSerialization isValidJSONObject:dictionary] != NO) {
+
+#if defined(DEBUG) || defined(TEST) || defined(TESTCI)
+    @try {
+#else
+    if ([NSJSONSerialization isValidJSONObject:dictionary]) {
+#endif
         data = [NSJSONSerialization dataWithJSONObject:dictionary options:0 error:error];
-    } else {
-        SENTRY_LOG_ERROR(@"Invalid JSON.");
+#if defined(DEBUG) || defined(TEST) || defined(TESTCI)
+    } @catch (NSException *exception) {
         if (error) {
-            *error = NSErrorFromSentryError(
-                kSentryErrorJsonConversionError, @"Event cannot be converted to JSON");
+            SENTRY_HANDLE_ERROR(NSErrorFromSentryErrorWithException(
+                kSentryErrorJsonConversionError, @"Event cannot be converted to JSON", exception));
         }
     }
+#else
+    } else if (error) {
+        SENTRY_HANDLE_ERROR(NSErrorFromSentryErrorWithUnderlyingError(
+            kSentryErrorJsonConversionError, @"Event cannot be converted to JSON", *error));
+    }
+#endif
 
     return data;
 }