From 9f3f12963c96ce97b63c6ad436a0cc49c892a1b5 Mon Sep 17 00:00:00 2001
From: lcian <lorenzo.cian@sentry.io>
Date: Thu, 6 Mar 2025 12:20:29 +0100
Subject: [PATCH 1/6] Add CoroutineExceptionHandler

---
 buildSrc/src/main/java/Config.kt              |  2 ++
 .../api/sentry-kotlin-extensions.api          |  7 +++++
 .../kotlin/SentryCoroutineExceptionHandler.kt | 26 +++++++++++++++++++
 .../sentry-samples-android/build.gradle.kts   |  3 +++
 .../sentry/samples/android/CoroutinesUtil.kt  | 16 ++++++++++++
 .../sentry/samples/android/MainActivity.java  |  5 ++++
 .../src/main/res/layout/activity_main.xml     |  6 +++++
 .../src/main/res/values/strings.xml           |  1 +
 8 files changed, 66 insertions(+)
 create mode 100644 sentry-kotlin-extensions/src/main/java/io/sentry/kotlin/SentryCoroutineExceptionHandler.kt
 create mode 100644 sentry-samples/sentry-samples-android/src/main/java/io/sentry/samples/android/CoroutinesUtil.kt

diff --git a/buildSrc/src/main/java/Config.kt b/buildSrc/src/main/java/Config.kt
index 03b6849a6ba..30f3a5614a9 100644
--- a/buildSrc/src/main/java/Config.kt
+++ b/buildSrc/src/main/java/Config.kt
@@ -119,6 +119,8 @@ object Config {
 
         val coroutinesCore = "org.jetbrains.kotlinx:kotlinx-coroutines-core:1.6.1"
 
+        val coroutinesAndroid = "org.jetbrains.kotlinx:kotlinx-coroutines-android:1.6.1"
+
         val fragment = "androidx.fragment:fragment-ktx:1.3.5"
 
         val reactorCore = "io.projectreactor:reactor-core:3.5.3"
diff --git a/sentry-kotlin-extensions/api/sentry-kotlin-extensions.api b/sentry-kotlin-extensions/api/sentry-kotlin-extensions.api
index 0555383c1b1..e11ec192499 100644
--- a/sentry-kotlin-extensions/api/sentry-kotlin-extensions.api
+++ b/sentry-kotlin-extensions/api/sentry-kotlin-extensions.api
@@ -10,3 +10,10 @@ public final class io/sentry/kotlin/SentryContext : kotlin/coroutines/AbstractCo
 	public synthetic fun updateThreadContext (Lkotlin/coroutines/CoroutineContext;)Ljava/lang/Object;
 }
 
+public class io/sentry/kotlin/SentryCoroutineExceptionHandler : kotlin/coroutines/AbstractCoroutineContextElement, kotlinx/coroutines/CoroutineExceptionHandler {
+	public fun <init> ()V
+	public fun <init> (Lio/sentry/IScopes;)V
+	public synthetic fun <init> (Lio/sentry/IScopes;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
+	public fun handleException (Lkotlin/coroutines/CoroutineContext;Ljava/lang/Throwable;)V
+}
+
diff --git a/sentry-kotlin-extensions/src/main/java/io/sentry/kotlin/SentryCoroutineExceptionHandler.kt b/sentry-kotlin-extensions/src/main/java/io/sentry/kotlin/SentryCoroutineExceptionHandler.kt
new file mode 100644
index 00000000000..aca2d39f31e
--- /dev/null
+++ b/sentry-kotlin-extensions/src/main/java/io/sentry/kotlin/SentryCoroutineExceptionHandler.kt
@@ -0,0 +1,26 @@
+package io.sentry.kotlin
+
+import io.sentry.IScopes
+import io.sentry.ScopesAdapter
+import io.sentry.SentryEvent
+import io.sentry.exception.ExceptionMechanismException
+import io.sentry.protocol.Mechanism
+import kotlinx.coroutines.CoroutineExceptionHandler
+import org.jetbrains.annotations.ApiStatus
+import kotlin.coroutines.AbstractCoroutineContextElement
+import kotlin.coroutines.CoroutineContext
+
+@ApiStatus.Experimental
+public open class SentryCoroutineExceptionHandler(private val scopes: IScopes = ScopesAdapter.getInstance()) :
+    AbstractCoroutineContextElement(CoroutineExceptionHandler), CoroutineExceptionHandler {
+
+    override fun handleException(context: CoroutineContext, exception: Throwable) {
+        val mechanism = Mechanism().apply {
+            type = "CoroutineExceptionHandler"
+        }
+        // the current thread is not necessarily the one that threw the exception
+        val error = ExceptionMechanismException(mechanism, exception, Thread.currentThread())
+        val event = SentryEvent(error)
+        scopes.captureEvent(event)
+    }
+}
diff --git a/sentry-samples/sentry-samples-android/build.gradle.kts b/sentry-samples/sentry-samples-android/build.gradle.kts
index 04772af8aa0..8fae7e6393c 100644
--- a/sentry-samples/sentry-samples-android/build.gradle.kts
+++ b/sentry-samples/sentry-samples-android/build.gradle.kts
@@ -151,5 +151,8 @@ dependencies {
     implementation(Config.Libs.composeCoil)
     implementation(Config.Libs.sentryNativeNdk)
 
+    implementation(projects.sentryKotlinExtensions)
+    implementation(Config.Libs.coroutinesAndroid)
+
     debugImplementation(Config.Libs.leakCanary)
 }
diff --git a/sentry-samples/sentry-samples-android/src/main/java/io/sentry/samples/android/CoroutinesUtil.kt b/sentry-samples/sentry-samples-android/src/main/java/io/sentry/samples/android/CoroutinesUtil.kt
new file mode 100644
index 00000000000..6e43574819d
--- /dev/null
+++ b/sentry-samples/sentry-samples-android/src/main/java/io/sentry/samples/android/CoroutinesUtil.kt
@@ -0,0 +1,16 @@
+package io.sentry.samples.android
+
+import io.sentry.kotlin.SentryContext
+import io.sentry.kotlin.SentryCoroutineExceptionHandler
+import kotlinx.coroutines.GlobalScope
+import kotlinx.coroutines.launch
+import java.lang.RuntimeException
+
+object CoroutinesUtil {
+
+    fun throwInCoroutine() {
+        GlobalScope.launch(SentryContext() + SentryCoroutineExceptionHandler()) {
+            throw RuntimeException("Exception in coroutine")
+        }
+    }
+}
diff --git a/sentry-samples/sentry-samples-android/src/main/java/io/sentry/samples/android/MainActivity.java b/sentry-samples/sentry-samples-android/src/main/java/io/sentry/samples/android/MainActivity.java
index da52c72a68d..a8d72d66921 100644
--- a/sentry-samples/sentry-samples-android/src/main/java/io/sentry/samples/android/MainActivity.java
+++ b/sentry-samples/sentry-samples-android/src/main/java/io/sentry/samples/android/MainActivity.java
@@ -254,6 +254,11 @@ public void run() {
     binding.openFrameDataForSpans.setOnClickListener(
         view -> startActivity(new Intent(this, FrameDataForSpansActivity.class)));
 
+    binding.throwInCoroutine.setOnClickListener(
+        view -> {
+          CoroutinesUtil.INSTANCE.throwInCoroutine();
+        });
+
     setContentView(binding.getRoot());
   }
 
diff --git a/sentry-samples/sentry-samples-android/src/main/res/layout/activity_main.xml b/sentry-samples/sentry-samples-android/src/main/res/layout/activity_main.xml
index 6fb8d028637..56b95fa1097 100644
--- a/sentry-samples/sentry-samples-android/src/main/res/layout/activity_main.xml
+++ b/sentry-samples/sentry-samples-android/src/main/res/layout/activity_main.xml
@@ -142,6 +142,12 @@
       android:layout_height="wrap_content"
       android:text="@string/open_frame_data_for_spans"/>
 
+    <Button
+      android:id="@+id/throw_in_coroutine"
+      android:layout_width="wrap_content"
+      android:layout_height="wrap_content"
+      android:text="@string/throw_in_coroutine"/>
+
   </LinearLayout>
 
 </ScrollView>
diff --git a/sentry-samples/sentry-samples-android/src/main/res/values/strings.xml b/sentry-samples/sentry-samples-android/src/main/res/values/strings.xml
index 41c6f038824..d39c8d19531 100644
--- a/sentry-samples/sentry-samples-android/src/main/res/values/strings.xml
+++ b/sentry-samples/sentry-samples-android/src/main/res/values/strings.xml
@@ -25,6 +25,7 @@
   <string name="open_frame_data_for_spans">Open Frame Data for Spans Activity</string>
   <string name="open_metrics">Delightful Developer Metrics</string>
   <string name="test_timber_integration">Test Timber</string>
+  <string name="throw_in_coroutine">Throw exception in coroutine</string>
   <string name="back_main">Back to Main Activity</string>
   <string name="tap_me">text</string>
   <string name="lipsum">Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin nibh lorem, venenatis sed nulla vel, venenatis sodales augue. Mauris varius elit eu ligula volutpat, sed tincidunt orci porttitor. Donec et dignissim lacus, sed luctus ipsum. Praesent ornare luctus tortor sit amet ultricies. Cras iaculis et diam et vulputate. Cras ut iaculis mauris, non pellentesque diam. Nunc in laoreet diam, vitae accumsan eros. Morbi non nunc ac eros molestie placerat vitae id dolor. Quisque ornare aliquam ipsum, a dapibus tortor. In eu sodales tellus.

From ec61f307309c165710953de904e0181e3c7048b0 Mon Sep 17 00:00:00 2001
From: lcian <lorenzo.cian@sentry.io>
Date: Sat, 8 Mar 2025 18:42:30 +0100
Subject: [PATCH 2/6] tests

---
 buildSrc/src/main/java/Config.kt              |  1 +
 sentry-apollo-4/build.gradle.kts              |  2 +-
 sentry-kotlin-extensions/build.gradle.kts     |  1 +
 .../SentryCoroutineExceptionHandlerTest.kt    | 80 +++++++++++++++++++
 4 files changed, 83 insertions(+), 1 deletion(-)
 create mode 100644 sentry-kotlin-extensions/src/test/java/io/sentry/kotlin/SentryCoroutineExceptionHandlerTest.kt

diff --git a/buildSrc/src/main/java/Config.kt b/buildSrc/src/main/java/Config.kt
index 30f3a5614a9..147bb7c1adf 100644
--- a/buildSrc/src/main/java/Config.kt
+++ b/buildSrc/src/main/java/Config.kt
@@ -213,6 +213,7 @@ object Config {
         val msgpack = "org.msgpack:msgpack-core:0.9.8"
         val leakCanaryInstrumentation = "com.squareup.leakcanary:leakcanary-android-instrumentation:2.14"
         val composeUiTestJunit4 = "androidx.compose.ui:ui-test-junit4:1.6.8"
+        val coroutinesTest = "org.jetbrains.kotlinx:kotlinx-coroutines-test:1.6.1"
     }
 
     object QualityPlugins {
diff --git a/sentry-apollo-4/build.gradle.kts b/sentry-apollo-4/build.gradle.kts
index 6e8c292966b..e591c7ec0c6 100644
--- a/sentry-apollo-4/build.gradle.kts
+++ b/sentry-apollo-4/build.gradle.kts
@@ -41,7 +41,7 @@ dependencies {
     testImplementation(Config.TestLibs.mockitoInline)
     testImplementation(Config.TestLibs.mockWebserver)
     testImplementation(Config.Libs.apolloKotlin4)
-    testImplementation("org.jetbrains.kotlinx:kotlinx-coroutines-test:1.7.3")
+    testImplementation(Config.TestLibs.coroutinesTest)
     testImplementation("org.jetbrains.kotlin:kotlin-reflect:2.0.0")
 }
 
diff --git a/sentry-kotlin-extensions/build.gradle.kts b/sentry-kotlin-extensions/build.gradle.kts
index 9db72d89ca1..fae7c518990 100644
--- a/sentry-kotlin-extensions/build.gradle.kts
+++ b/sentry-kotlin-extensions/build.gradle.kts
@@ -30,6 +30,7 @@ dependencies {
     testImplementation(Config.TestLibs.kotlinTestJunit)
     testImplementation(Config.TestLibs.mockitoKotlin)
     testImplementation(Config.Libs.coroutinesCore)
+    testImplementation(Config.TestLibs.coroutinesTest)
 }
 
 configure<SourceSetContainer> {
diff --git a/sentry-kotlin-extensions/src/test/java/io/sentry/kotlin/SentryCoroutineExceptionHandlerTest.kt b/sentry-kotlin-extensions/src/test/java/io/sentry/kotlin/SentryCoroutineExceptionHandlerTest.kt
new file mode 100644
index 00000000000..1f21105dcf1
--- /dev/null
+++ b/sentry-kotlin-extensions/src/test/java/io/sentry/kotlin/SentryCoroutineExceptionHandlerTest.kt
@@ -0,0 +1,80 @@
+package io.sentry.kotlin
+
+import io.sentry.IScopes
+import kotlinx.coroutines.GlobalScope
+import kotlinx.coroutines.async
+import kotlinx.coroutines.launch
+import kotlinx.coroutines.test.runTest
+import org.mockito.kotlin.check
+import org.mockito.kotlin.mock
+import org.mockito.kotlin.verify
+import kotlin.test.Test
+import kotlin.test.assertSame
+import kotlin.test.assertTrue
+
+class SentryCoroutineExceptionHandlerTest {
+
+    class Fixture {
+        val scopes = mock<IScopes>()
+
+        fun getSut(): SentryCoroutineExceptionHandler {
+            return SentryCoroutineExceptionHandler(scopes)
+        }
+    }
+
+    @Test
+    fun `captures unhandled exception in launch coroutine`() = runTest {
+        val fixture = Fixture()
+        val handler = fixture.getSut()
+        val exception = RuntimeException("test")
+
+        GlobalScope.launch(handler) {
+            throw exception
+        }.join()
+
+        verify(fixture.scopes).captureEvent(
+            check {
+                assertSame(exception, it.throwable)
+            }
+        )
+    }
+
+    @Test
+    fun `captures unhandled exception in launch coroutine with child`() = runTest {
+        val fixture = Fixture()
+        val handler = fixture.getSut()
+        val exception = RuntimeException("test")
+
+        GlobalScope.launch(handler) {
+            launch {
+                throw exception
+            }.join()
+        }.join()
+
+        verify(fixture.scopes).captureEvent(
+            check {
+                assertSame(exception, it.throwable)
+            }
+        )
+    }
+
+    @Test
+    fun `captures unhandled exception in async coroutine`() = runTest {
+        val fixture = Fixture()
+        val handler = fixture.getSut()
+        val exception = RuntimeException("test")
+
+        val deferred = GlobalScope.async() {
+            throw exception
+        }
+        GlobalScope.launch(handler) {
+            deferred.await()
+        }.join()
+
+        verify(fixture.scopes).captureEvent(
+            check {
+                assertTrue { exception.toString().equals(it.throwable.toString()) } // stack trace will differ
+            }
+        )
+    }
+}

From 14fa1b2005dc7cecf79e373781f4a58143a81b2e Mon Sep 17 00:00:00 2001
From: lcian <lorenzo.cian@sentry.io>
Date: Mon, 17 Mar 2025 12:32:56 +0100
Subject: [PATCH 3/6] changelog

---
 CHANGELOG.md | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 2e81bd10e0c..c9eb444baf6 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -2,6 +2,11 @@
 
 ## Unreleased
 
+### Features
+
+- Add `CoroutineExceptionHandler` for reporting uncaught exceptions in coroutines to Sentry ([#4259](https://github.com/getsentry/sentry-java/pull/4259))
+  - This is now part of `sentry-kotlin-extensions` and can be used together with `SentryContext` when launching a coroutine
+
 ### Fixes
 
 - Reduce excessive CPU usage when serializing breadcrumbs to disk for ANRs ([#4181](https://github.com/getsentry/sentry-java/pull/4181))

From 01011bfb0d5d75b1e9c7b26234b6ec9fc63d4675 Mon Sep 17 00:00:00 2001
From: lcian <lorenzo.cian@sentry.io>
Date: Fri, 4 Apr 2025 14:53:31 +0200
Subject: [PATCH 4/6] improve

---
 .../java/io/sentry/kotlin/SentryCoroutineExceptionHandler.kt | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/sentry-kotlin-extensions/src/main/java/io/sentry/kotlin/SentryCoroutineExceptionHandler.kt b/sentry-kotlin-extensions/src/main/java/io/sentry/kotlin/SentryCoroutineExceptionHandler.kt
index aca2d39f31e..9fc4a23d2e1 100644
--- a/sentry-kotlin-extensions/src/main/java/io/sentry/kotlin/SentryCoroutineExceptionHandler.kt
+++ b/sentry-kotlin-extensions/src/main/java/io/sentry/kotlin/SentryCoroutineExceptionHandler.kt
@@ -3,6 +3,7 @@ package io.sentry.kotlin
 import io.sentry.IScopes
 import io.sentry.ScopesAdapter
 import io.sentry.SentryEvent
+import io.sentry.SentryLevel
 import io.sentry.exception.ExceptionMechanismException
 import io.sentry.protocol.Mechanism
 import kotlinx.coroutines.CoroutineExceptionHandler
@@ -10,6 +11,9 @@ import org.jetbrains.annotations.ApiStatus
 import kotlin.coroutines.AbstractCoroutineContextElement
 import kotlin.coroutines.CoroutineContext
 
+/**
+ * Captures exceptions thrown in coroutines (without rethrowing them) and reports them to Sentry as errors.
+ */
 @ApiStatus.Experimental
 public open class SentryCoroutineExceptionHandler(private val scopes: IScopes = ScopesAdapter.getInstance()) :
     AbstractCoroutineContextElement(CoroutineExceptionHandler), CoroutineExceptionHandler {
@@ -21,6 +25,7 @@ public open class SentryCoroutineExceptionHandler(private val scopes: IScopes =
         // the current thread is not necessarily the one that threw the exception
         val error = ExceptionMechanismException(mechanism, exception, Thread.currentThread())
         val event = SentryEvent(error)
+        event.level = SentryLevel.ERROR
         scopes.captureEvent(event)
     }
 }

From 60134a0222caaf7e9746c873b4ce6edfd3cac6a5 Mon Sep 17 00:00:00 2001
From: lcian <lorenzo.cian@sentry.io>
Date: Fri, 4 Apr 2025 14:54:28 +0200
Subject: [PATCH 5/6] improve

---
 CHANGELOG.md | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index c9eb444baf6..bb3f4e53ebc 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -6,6 +6,8 @@
 
 - Add `CoroutineExceptionHandler` for reporting uncaught exceptions in coroutines to Sentry ([#4259](https://github.com/getsentry/sentry-java/pull/4259))
   - This is now part of `sentry-kotlin-extensions` and can be used together with `SentryContext` when launching a coroutine
+  - Any exceptions thrown in a coroutine when using the handler will be captured (not rethrown!) and reported to Sentry
+  - It's also possible to extend `CoroutineExceptionHandler` to implement custom behavior in addition to the one we provide by default
 
 ### Fixes
 

From 51c4f603291cdde87a46a8503415755361af5b0a Mon Sep 17 00:00:00 2001
From: Lorenzo Cian <lorenzo.cian@sentry.io>
Date: Thu, 10 Apr 2025 10:04:58 +0200
Subject: [PATCH 6/6] Update CHANGELOG.md

---
 CHANGELOG.md | 1 -
 1 file changed, 1 deletion(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 773933e8c8d..ff1639bf7ed 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -18,7 +18,6 @@
 
 ### Features
 
-- Continuous Profiling - Out of Experimental ([#4310](https://github.com/getsentry/sentry-java/pull/4310))
 - UI Profiling GA
 
   Continuous Profiling is now GA, named UI Profiling. To enable it you can use one of the following options. More info can be found at https://docs.sentry.io/platforms/android/profiling/.