Add Sentry.isEnabled() to common code (#273)

* add function * fix imports * update changelog * Format code * update * update api --------- Co-authored-by: Sentry Github Bot <[email protected]>
getsentry · Oct 7, 2024 · 27c2e03 · 27c2e03
1 parent 7715854
commit 27c2e03
Show file tree

Hide file tree

Showing 8 changed files with 40 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## Unreleased
+
+### Features
+
+- Add `Sentry.isEnabled()` API to common code ([#273](https://github.com/getsentry/sentry-kotlin-multiplatform/pull/273))
+
 ## 0.9.0
 
 ### Improvements

diff --git a/sentry-kotlin-multiplatform/api/android/sentry-kotlin-multiplatform.api b/sentry-kotlin-multiplatform/api/android/sentry-kotlin-multiplatform.api
@@ -86,6 +86,7 @@ public final class io/sentry/kotlin/multiplatform/Sentry {
 	public final fun init (Lkotlin/jvm/functions/Function1;)V
 	public final fun initWithPlatformOptions (Lkotlin/jvm/functions/Function1;)V
 	public final fun isCrashedLastRun ()Z
+	public final fun isEnabled ()Z
 	public final fun setUser (Lio/sentry/kotlin/multiplatform/protocol/User;)V
 }
 

diff --git a/sentry-kotlin-multiplatform/api/jvm/sentry-kotlin-multiplatform.api b/sentry-kotlin-multiplatform/api/jvm/sentry-kotlin-multiplatform.api
@@ -83,6 +83,7 @@ public final class io/sentry/kotlin/multiplatform/Sentry {
 	public final fun init (Lkotlin/jvm/functions/Function1;)V
 	public final fun initWithPlatformOptions (Lkotlin/jvm/functions/Function1;)V
 	public final fun isCrashedLastRun ()Z
+	public final fun isEnabled ()Z
 	public final fun setUser (Lio/sentry/kotlin/multiplatform/protocol/User;)V
 }
 

diff --git a/...n-multiplatform/src/appleMain/kotlin/io/sentry/kotlin/multiplatform/SentryBridge.apple.kt b/...n-multiplatform/src/appleMain/kotlin/io/sentry/kotlin/multiplatform/SentryBridge.apple.kt
@@ -108,6 +108,10 @@ internal actual class SentryBridge actual constructor(private val sentryInstance
         return SentrySDK.crashedLastRun()
     }
 
+    actual fun isEnabled(): Boolean {
+        return SentrySDK.isEnabled()
+    }
+
     actual fun close() {
         SentrySDK.close()
     }

diff --git a/...latform/src/commonJvmMain/kotlin/io/sentry/kotlin/multiplatform/SentryBridge.commonJvm.kt b/...latform/src/commonJvmMain/kotlin/io/sentry/kotlin/multiplatform/SentryBridge.commonJvm.kt
@@ -71,6 +71,10 @@ internal actual class SentryBridge actual constructor(private val sentryInstance
         return Sentry.isCrashedLastRun() ?: false
     }
 
+    actual fun isEnabled(): Boolean {
+        return Sentry.isEnabled()
+    }
+
     actual fun close() {
         Sentry.close()
     }

diff --git a/...kotlin-multiplatform/src/commonMain/kotlin/io/sentry/kotlin/multiplatform/SentryBridge.kt b/...kotlin-multiplatform/src/commonMain/kotlin/io/sentry/kotlin/multiplatform/SentryBridge.kt
@@ -30,5 +30,7 @@ internal expect class SentryBridge(sentryInstance: SentryInstance = SentryPlatfo
 
     fun isCrashedLastRun(): Boolean
 
+    fun isEnabled(): Boolean
+
     fun close()
 }
diff --git a/...ry-kotlin-multiplatform/src/commonMain/kotlin/io/sentry/kotlin/multiplatform/SentryKMP.kt b/...ry-kotlin-multiplatform/src/commonMain/kotlin/io/sentry/kotlin/multiplatform/SentryKMP.kt
@@ -154,6 +154,13 @@ public object Sentry {
         throw RuntimeException("Uncaught Exception from Kotlin Multiplatform.")
     }
 
+    /**
+     * Checks if the SDK is enabled.
+     */
+    public fun isEnabled(): Boolean {
+        return bridge.isEnabled()
+    }
+
     /**
      * Closes the SDK.
      */

diff --git a/...ltiplatform/src/commonTest/kotlin/io/sentry/kotlin/multiplatform/SentryIntegrationTest.kt b/...ltiplatform/src/commonTest/kotlin/io/sentry/kotlin/multiplatform/SentryIntegrationTest.kt
@@ -7,6 +7,7 @@ import kotlinx.coroutines.test.runTest
 import kotlin.test.AfterTest
 import kotlin.test.Test
 import kotlin.test.assertEquals
+import kotlin.test.assertFalse
 import kotlin.test.assertNotEquals
 import kotlin.test.assertNotNull
 import kotlin.test.assertTrue
@@ -225,6 +226,20 @@ class SentryIntegrationTest : BaseSentryTest() {
         assertEquals(expectedUsername, actualUsername)
     }
 
+    @Test
+    fun `isEnabled returns true when SDK is enabled`() {
+        sentryInit {
+            it.dsn = fakeDsn
+        }
+
+        assertTrue(Sentry.isEnabled())
+    }
+
+    @Test
+    fun `isEnabled returns false when SDK is disabled`() {
+        assertFalse(Sentry.isEnabled())
+    }
+
     @Test
     fun `global scope sets context correctly with different data types`() = runTest {
         val stringKey = "stringKey"