Add convenient method for accessing event's throwable. (#1202)

Fixes #1201

Author: maciejwalkowiak

CHANGELOG.md

@@ -16,6 +16,7 @@
 * Enhancement: Enable Kotlin map-like access on CustomSamplingContext (#1192)
 * Enhancement: Auto register custom ITransportFactory in Spring integration (#1194)
 * Enhancement: Improve Kotlin property access in Performance API (#1193)
+* Enhancement: Add convenient method for accessing event's throwable (1202)
 
 # 4.0.0-alpha.3
 

sentry/api/sentry.api

@@ -544,6 +544,7 @@ public abstract class io/sentry/SentryBaseEvent {
 	public fun getContexts ()Lio/sentry/protocol/Contexts;
 	public fun getEnvironment ()Ljava/lang/String;
 	public fun getEventId ()Lio/sentry/protocol/SentryId;
+	public fun getOriginThrowable ()Ljava/lang/Throwable;
 	public fun getRelease ()Ljava/lang/String;
 	public fun getRequest ()Lio/sentry/protocol/Request;
 	public fun getSdk ()Lio/sentry/protocol/SdkVersion;

sentry/src/main/java/io/sentry/DuplicateEventDetectionEventProcessor.java

@@ -1,6 +1,5 @@
 package io.sentry;
 
-import io.sentry.exception.ExceptionMechanismException;
 import io.sentry.util.Objects;
 import java.util.ArrayList;
 import java.util.List;
@@ -20,34 +19,19 @@ public DuplicateEventDetectionEventProcessor(final @NotNull SentryOptions option
 
   @Override
   public SentryEvent process(final @NotNull SentryEvent event, final @Nullable Object hint) {
-    final Throwable throwable = event.getThrowable();
+    final Throwable throwable = event.getOriginThrowable();
     if (throwable != null) {
-      if (throwable instanceof ExceptionMechanismException) {
-        final ExceptionMechanismException ex = (ExceptionMechanismException) throwable;
-        if (capturedObjects.containsKey(ex.getThrowable())) {
-          options
-              .getLogger()
-              .log(
-                  SentryLevel.DEBUG,
-                  "Duplicate Exception detected. Event %s will be discarded.",
-                  event.getEventId());
-          return null;
-        } else {
-          capturedObjects.put(ex.getThrowable(), null);
-        }
+      if (capturedObjects.containsKey(throwable)
+          || containsAnyKey(capturedObjects, allCauses(throwable))) {
+        options
+            .getLogger()
+            .log(
+                SentryLevel.DEBUG,
+                "Duplicate Exception detected. Event %s will be discarded.",
+                event.getEventId());
+        return null;
       } else {
-        if (capturedObjects.containsKey(throwable)
-            || containsAnyKey(capturedObjects, allCauses(throwable))) {
-          options
-              .getLogger()
-              .log(
-                  SentryLevel.DEBUG,
-                  "Duplicate Exception detected. Event %s will be discarded.",
-                  event.getEventId());
-          return null;
-        } else {
-          capturedObjects.put(throwable, null);
-        }
+        capturedObjects.put(throwable, null);
       }
     }
     return event;

sentry/src/main/java/io/sentry/SentryBaseEvent.java

@@ -1,5 +1,6 @@
 package io.sentry;
 
+import io.sentry.exception.ExceptionMechanismException;
 import io.sentry.protocol.Contexts;
 import io.sentry.protocol.Request;
 import io.sentry.protocol.SdkVersion;
@@ -106,6 +107,21 @@ public void setRequest(final @Nullable Request request) {
     return throwable;
   }
 
+  /**
+   * Returns the captured Throwable or null. If a throwable is wrapped in {@link
+   * ExceptionMechanismException}, returns unwrapped throwable.
+   *
+   * @return the Throwable or null
+   */
+  public @Nullable Throwable getOriginThrowable() {
+    final Throwable ex = throwable;
+    if (ex instanceof ExceptionMechanismException) {
+      return ((ExceptionMechanismException) ex).getThrowable();
+    } else {
+      return ex;
+    }
+  }
+
   /**
    * Sets the Throwable
    *

sentry/src/test/java/io/sentry/SentryEventTest.kt

@@ -67,9 +67,26 @@ class SentryEventTest {
         assertFalse(event.isCrashed)
     }
 
+    @Test
     fun `adds breadcrumb with string as a parameter`() {
         val event = SentryEvent()
         event.addBreadcrumb("breadcrumb")
         assertEquals(1, event.breadcrumbs.filter { it.message == "breadcrumb" }.size)
     }
+
+    @Test
+    fun `when throwable is a ExceptionMechanismException, getOriginThrowable unwraps original throwable`() {
+        val event = SentryEvent()
+        val ex = RuntimeException()
+        event.throwable = ExceptionMechanismException(null, ex, null)
+        assertEquals(ex, event.originThrowable)
+    }
+
+    @Test
+    fun `when throwable is not a ExceptionMechanismException, getOriginThrowable returns throwable`() {
+        val event = SentryEvent()
+        val ex = RuntimeException()
+        event.throwable = ex
+        assertEquals(ex, event.originThrowable)
+    }
 }