feat: override native options (#221)

* Add native options

* Update

* Update

* Update

* Format

* Update

* Update

* Format code

* Update

* Update

* Update changelog

* Format code

* update

* Update api

* Update

* Format code

* Update

* Update

* Update comments

* Fix detekt

* Update

* Add review

* Update

* Fix test

* Update samples

* Update

* Update

* Format code

* Update

---------

Co-authored-by: Sentry Github Bot <[email protected]>

Author: buenaflor

CHANGELOG.md

@@ -2,6 +2,44 @@
 
 ## Unreleased
 
+### Features
+
+- Allow initializing the KMP SDK with native options ([#221](https://github.com/getsentry/sentry-kotlin-multiplatform/pull/221))
+  - This allows you to initialize the SDK with platform-specific options that may not be available in the common code of the KMP SDK yet.
+
+Usage:
+```kotlin
+// build.gradle.kts
+kotlin {
+    sourceSets {
+        all {
+          languageSettings.optIn("kotlinx.cinterop.ExperimentalForeignApi")
+        }
+    }
+}
+
+// commonMain
+fun init() {
+  Sentry.initWithPlatformOptions(createPlatformOptions())
+}
+
+expect fun platformOptionsConfiguration(): PlatformOptionsConfiguration
+
+// iOS
+actual fun createPlatformOptions(): PlatformOptionsConfiguration = { 
+    dsn = "your_dsn"
+    release = "1.0.0"
+    // ...
+}
+
+// Android
+actual fun createPlatformOptions(): PlatformOptionsConfiguration = {
+  dsn = "your_dsn"
+  release = "1.0.0"
+  // ...
+}
+```
+
 ### Dependencies
 
 - Bump Java SDK from v7.8.0 to v7.9.0 ([#219](https://github.com/getsentry/sentry-kotlin-multiplatform/pull/219))

scripts/build-apple.sh

@@ -11,6 +11,7 @@ PROJECT_NAME="$1"
           "iosX64Test" \
           "watchosX64Test" \
           "tvosX64Test" \
+          "iosSimulatorArm64Test" \
           "publishKotlinMultiplatformPublicationToMavenLocal" \
           "publishIosArm64PublicationToMavenLocal" \
           "publishIosSimulatorArm64PublicationToMavenLocal" \

sentry-kotlin-multiplatform/api/android/sentry-kotlin-multiplatform.api

@@ -84,6 +84,7 @@ public final class io/sentry/kotlin/multiplatform/Sentry {
 	public final fun crash ()V
 	public final fun init (Landroid/content/Context;Lkotlin/jvm/functions/Function1;)V
 	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 setUser (Lio/sentry/kotlin/multiplatform/protocol/User;)V
 }

sentry-kotlin-multiplatform/api/jvm/sentry-kotlin-multiplatform.api

@@ -81,6 +81,7 @@ public final class io/sentry/kotlin/multiplatform/Sentry {
 	public final fun crash ()V
 	public final fun init (Lio/sentry/kotlin/multiplatform/Context;Lkotlin/jvm/functions/Function1;)V
 	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 setUser (Lio/sentry/kotlin/multiplatform/protocol/User;)V
 }

sentry-kotlin-multiplatform/build.gradle.kts

@@ -1,4 +1,5 @@
 import com.codingfeline.buildkonfig.compiler.FieldSpec.Type.STRING
+import org.jetbrains.kotlin.gradle.ExperimentalKotlinGradlePluginApi
 import org.jetbrains.kotlin.gradle.plugin.mpp.KotlinNativeTarget
 import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 
@@ -64,6 +65,11 @@ kotlin {
     macosArm64()
 
     sourceSets {
+        @OptIn(ExperimentalKotlinGradlePluginApi::class)
+        compilerOptions {
+            freeCompilerArgs.add("-Xexpect-actual-classes")
+        }
+
         all {
             languageSettings.apply {
                 optIn("kotlinx.cinterop.ExperimentalForeignApi")
@@ -87,7 +93,7 @@ kotlin {
         }
 
         androidMain.dependencies {
-            implementation(Config.Libs.sentryAndroid)
+            api(Config.Libs.sentryAndroid)
         }
 
         // androidUnitTest.dependencies doesn't exist
@@ -102,7 +108,7 @@ kotlin {
         val commonJvmMain by creating {
             dependsOn(commonMain.get())
             dependencies {
-                implementation(Config.Libs.sentryJava)
+                api(Config.Libs.sentryJava)
             }
         }
 

sentry-kotlin-multiplatform/sentry_kotlin_multiplatform.podspec

@@ -50,4 +50,4 @@ Pod::Spec.new do |spec|
         }
     ]
 
-end
+end

sentry-kotlin-multiplatform/src/androidMain/kotlin/io/sentry/kotlin/multiplatform/SentryInit.android.kt renamed to sentry-kotlin-multiplatform/src/androidMain/kotlin/io/sentry/kotlin/multiplatform/Context.android.kt

@@ -6,27 +6,12 @@ import android.content.Context
 import android.database.Cursor
 import android.net.Uri
 import io.sentry.android.core.SentryAndroid
-import io.sentry.kotlin.multiplatform.extensions.toAndroidSentryOptionsCallback
 
-internal actual fun initSentry(configuration: OptionsConfiguration) {
-    val options = SentryOptions()
-    configuration.invoke(options)
-
-    val context = applicationContext ?: run {
-        // TODO: add logging later
-        return
-    }
-
-    SentryAndroid.init(context) { sentryOptions ->
-        options.toAndroidSentryOptionsCallback().invoke(sentryOptions)
-    }
-}
+public actual typealias Context = Context
 
 internal var applicationContext: Context? = null
     private set
 
-public actual typealias Context = Context
-
 /**
  * A ContentProvider that does NOT store or provide any data for read or write operations.
  *

sentry-kotlin-multiplatform/src/androidMain/kotlin/io/sentry/kotlin/multiplatform/SentryPlatformInstance.android.kt

@@ -0,0 +1,14 @@
+package io.sentry.kotlin.multiplatform
+
+import io.sentry.android.core.SentryAndroid
+
+internal actual class SentryPlatformInstance : SentryInstance {
+    override fun init(configuration: PlatformOptionsConfiguration) {
+        val context = applicationContext ?: run {
+            // TODO: add logging later
+            return
+        }
+
+        SentryAndroid.init(context, configuration)
+    }
+}

sentry-kotlin-multiplatform/src/androidMain/kotlin/io/sentry/kotlin/multiplatform/SentryPlatformOptions.android.kt

@@ -0,0 +1,20 @@
+package io.sentry.kotlin.multiplatform
+
+import io.sentry.kotlin.multiplatform.extensions.toAndroidSentryOptionsCallback
+
+public actual typealias SentryPlatformOptions = io.sentry.android.core.SentryAndroidOptions
+
+internal actual fun SentryPlatformOptions.prepareForInit() {
+    sdkVersion?.name = BuildKonfig.SENTRY_KMP_ANDROID_SDK_NAME
+    sdkVersion?.version = BuildKonfig.VERSION_NAME
+    if (sdkVersion?.packageSet?.none { it.name == BuildKonfig.SENTRY_ANDROID_PACKAGE_NAME } == true) {
+        sdkVersion?.addPackage(BuildKonfig.SENTRY_ANDROID_PACKAGE_NAME, BuildKonfig.SENTRY_ANDROID_VERSION)
+    }
+}
+
+internal actual fun SentryOptions.toPlatformOptionsConfiguration(): PlatformOptionsConfiguration =
+    toAndroidSentryOptionsCallback()
+
+internal actual fun SentryPlatformOptions.prepareForInitBridge() {
+    prepareForInit()
+}

sentry-kotlin-multiplatform/src/androidMain/kotlin/io/sentry/kotlin/multiplatform/extensions/SentryOptionsExtensions.android.kt

@@ -1,7 +1,6 @@
 package io.sentry.kotlin.multiplatform.extensions
 
 import io.sentry.android.core.SentryAndroidOptions
-import io.sentry.kotlin.multiplatform.BuildKonfig
 import io.sentry.kotlin.multiplatform.SentryOptions
 import kotlin.collections.forEach as kForEach
 
@@ -15,16 +14,9 @@ internal fun SentryOptions.toAndroidSentryOptionsCallback(): (SentryAndroidOptio
     it.isAnrEnabled = this.isAnrEnabled
     it.anrTimeoutIntervalMillis = this.anrTimeoutIntervalMillis
 
-    it.sdkVersion?.name = this.sdk?.name ?: BuildKonfig.SENTRY_KMP_ANDROID_SDK_NAME
-    it.sdkVersion?.version = this.sdk?.version ?: BuildKonfig.VERSION_NAME
-
     // kForEach solves an issue with linter where it thinks forEach is the Java version
     // see here: https://stackoverflow.com/questions/44751469/kotlin-extension-functions-suddenly-require-api-level-24/68897591#68897591
     this.sdk?.packages?.kForEach { sdkPackage ->
         it.sdkVersion?.addPackage(sdkPackage.name, sdkPackage.version)
     }
-
-    if (it.sdkVersion?.packages?.none { it.name == BuildKonfig.SENTRY_ANDROID_PACKAGE_NAME } == true) {
-        it.sdkVersion?.addPackage(BuildKonfig.SENTRY_ANDROID_PACKAGE_NAME, BuildKonfig.SENTRY_ANDROID_VERSION)
-    }
 }