feat: Add error to SentryEvent (#944)

Add an initializer initWithError and property error to SentryEvent. This change gives our users the possibility to access the error in beforeSend.
getsentry · Feb 11, 2021 · 9e67662 · 9e67662
1 parent f9a2d4a
commit 9e67662
Show file tree

Hide file tree

Showing 6 changed files with 33 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,7 @@
 
 ## unreleased
 
+- feat: Add error to SentryEvent #944
 - fix: Mark SentryEvent.message as Nullable #943
 - fix: Stacktrace inApp marking on Simulators #942
 - feat: Group NSError by domain and code #941

diff --git a/Sources/Sentry/Public/SentryEvent.h b/Sources/Sentry/Public/SentryEvent.h
@@ -21,6 +21,13 @@ NS_SWIFT_NAME(Event)
  */
 @property (nonatomic, strong) SentryMessage *_Nullable message;
 
+/**
+ * The error of the event. This property adds convenience to access the error directly in
+ * beforeSend. This property is not serialized. Instead when preparing the event the SentryClient
+ * puts the error into exceptions.
+ */
+@property (nonatomic, copy) NSError *_Nullable error;
+
 /**
  * NSDate of when the event occured
  */
@@ -164,6 +171,15 @@ NS_SWIFT_NAME(Event)
  */
 - (instancetype)initWithLevel:(enum SentryLevel)level NS_DESIGNATED_INITIALIZER;
 
+/**
+ * Initializes a SentryEvent with an NSError and sets the level to SentryLevelError.
+ *
+ * @param error The error of the event.
+ *
+ * @return The initialized SentryEvent.
+ */
+- (instancetype)initWithError:(NSError *)error;
+
 @end
 
 NS_ASSUME_NONNULL_END
diff --git a/Sources/Sentry/SentryClient.m b/Sources/Sentry/SentryClient.m
@@ -167,7 +167,7 @@ - (SentryId *)captureError:(NSError *)error
 
 - (SentryEvent *)buildErrorEvent:(NSError *)error
 {
-    SentryEvent *event = [[SentryEvent alloc] initWithLevel:kSentryLevelError];
+    SentryEvent *event = [[SentryEvent alloc] initWithError:error];
     NSString *errorCodeAsString = [NSString stringWithFormat:@"%ld", (long)error.code];
     SentryException *sentryException = [[SentryException alloc] initWithValue:errorCodeAsString
                                                                          type:error.domain];

diff --git a/Sources/Sentry/SentryEvent.m b/Sources/Sentry/SentryEvent.m
@@ -33,6 +33,13 @@ - (instancetype)initWithLevel:(enum SentryLevel)level
     return self;
 }
 
+- (instancetype)initWithError:(NSError *)error
+{
+    self = [self initWithLevel:kSentryLevelError];
+    self.error = error;
+    return self;
+}
+
 - (NSDictionary<NSString *, id> *)serialize
 {
     if (nil == self.timestamp) {

diff --git a/Tests/SentryTests/Protocol/SentryEventTests.swift b/Tests/SentryTests/Protocol/SentryEventTests.swift
@@ -80,11 +80,17 @@ class SentryEventTests: XCTestCase {
         XCTAssertNil(actual["breadcrumbs"])
     }
 
+    func testInitWithError() {
+        let error = CocoaError(CocoaError.coderInvalidValue)
+        let event = Event(error: error)
+        XCTAssertEqual(error, event.error as? CocoaError)
+    }
+
     func testSerializeWithoutMessage() {
         let actual = Event().serialize()
         XCTAssertNil(actual["message"])
     }
-    
+
     func testMessageIsNil() {
         XCTAssertNil(Event().message)
     }

diff --git a/Tests/SentryTests/SentryClientTests.swift b/Tests/SentryTests/SentryClientTests.swift
@@ -790,6 +790,7 @@ class SentryClientTest: XCTestCase {
 
     private func assertValidErrorEvent(_ event: Event, _ error: NSError) {
         XCTAssertEqual(SentryLevel.error, event.level)
+        XCTAssertEqual(error, event.error as NSError?)
 
         guard let exceptions = event.exceptions else {
             XCTFail("Event should contain one exception"); return