fix: beforeSend overriding default release even if it was not set (#376)

* Update

* Update SentryBridgeTest.apple.kt

* Update CHANGELOG

* Update

* Update

* Podspec

* Fix syncing between kmp event and native event

* Revert open

* Formatting

* Remove print

* Update CHANGELOG

* Update

* Update

* Update

* Update

* Update

* Update

* Update

* Update CHANGELOG.md

* Update dist impl as well

* Update CHANGELOG

* Remove old dist

* Formatting

Author: buenaflor

CHANGELOG.md

@@ -6,6 +6,10 @@
 
 - Add `sendDefaultPii` option ([#377](https://github.com/getsentry/sentry-kotlin-multiplatform/pull/377))
 
+### Fixes
+
+- `beforeSend` overriding default release and dist even if it was not set explicitly ([#376](https://github.com/getsentry/sentry-kotlin-multiplatform/pull/376))
+
 ### Dependencies
 
 - Bump Java SDK from v8.8.0 to v8.14.0 ([#375](https://github.com/getsentry/sentry-kotlin-multiplatform/pull/375), [#382](https://github.com/getsentry/sentry-kotlin-multiplatform/pull/382), [#387](https://github.com/getsentry/sentry-kotlin-multiplatform/pull/387), [#402](https://github.com/getsentry/sentry-kotlin-multiplatform/pull/402))

sentry-kotlin-multiplatform/src/appleMain/kotlin/io/sentry/kotlin/multiplatform/extensions/SentryEventExtensions.apple.kt

@@ -5,16 +5,23 @@ import io.sentry.kotlin.multiplatform.CocoaSentryEvent
 import io.sentry.kotlin.multiplatform.SentryEvent
 
 internal fun CocoaSentryEvent.applyKmpEvent(kmpEvent: SentryEvent): CocoaSentryEvent {
+    // Native SDKs may have a default behaviour if no release/dist is set.
+    // Setting a release/dist (even if it's null) will remove this behaviour,
+    // so we have to check if the values differ first before setting.
+    if (releaseName != kmpEvent.release) {
+        releaseName = kmpEvent.release
+    }
+    if (dist != kmpEvent.dist) {
+        dist = kmpEvent.dist
+    }
     kmpEvent.level?.let { level = it.toCocoaSentryLevel() }
     kmpEvent.platform?.let { platform = it }
     message = kmpEvent.message?.toCocoaMessage()
     logger = kmpEvent.logger
     fingerprint = kmpEvent.fingerprint
-    releaseName = kmpEvent.release
     environment = kmpEvent.environment
     user = kmpEvent.user?.toCocoaUser()
     serverName = kmpEvent.serverName
-    dist = kmpEvent.dist
     breadcrumbs = kmpEvent.breadcrumbs.map { it.toCocoaBreadcrumb() }.toMutableList()
     tags = kmpEvent.tags.toMutableMap()
     eventId = SentryId(kmpEvent.eventId.toString())

sentry-kotlin-multiplatform/src/appleTest/kotlin/io/sentry/kotlin/multiplatform/ApplyKmpEventTest.kt

@@ -0,0 +1,80 @@
+package io.sentry.kotlin.multiplatform
+
+import io.sentry.kotlin.multiplatform.extensions.applyKmpEvent
+import kotlin.test.Test
+import kotlin.test.assertEquals
+
+class ApplyKmpEventTest {
+    @Test
+    fun `native release is not set if kmp release has same value`() {
+        val nativeEvent = FakeSentryEvent().apply {
+            releaseName = "1.0.0"
+        }
+        val kmpEvent = SentryEvent().apply {
+            release = "1.0.0"
+        }
+
+        nativeEvent.applyKmpEvent(kmpEvent)
+
+        assertEquals(1, nativeEvent.releaseSetCount)
+    }
+
+    @Test
+    fun `native dist is not set if kmp dist has same value`() {
+        val nativeEvent = FakeSentryEvent().apply {
+            dist = "randomDist"
+        }
+        val kmpEvent = SentryEvent().apply {
+            dist = "randomDist"
+        }
+
+        nativeEvent.applyKmpEvent(kmpEvent)
+
+        assertEquals(1, nativeEvent.distSetCount)
+    }
+
+    @Test
+    fun `native release is set if kmp release has different value`() {
+        val nativeEvent = FakeSentryEvent().apply {
+            releaseName = "1.0.0"
+        }
+        val kmpEvent = SentryEvent().apply {
+            release = "7.0.0"
+        }
+
+        nativeEvent.applyKmpEvent(kmpEvent)
+
+        assertEquals(2, nativeEvent.releaseSetCount)
+    }
+
+    @Test
+    fun `native dist is set if kmp dist has different value`() {
+        val nativeEvent = FakeSentryEvent().apply {
+            dist = "randomDist"
+        }
+        val kmpEvent = SentryEvent().apply {
+            dist = "differentDist"
+        }
+
+        nativeEvent.applyKmpEvent(kmpEvent)
+
+        assertEquals(2, nativeEvent.distSetCount)
+    }
+}
+
+// init with a SentryLevel as a workaround for:
+// Unable to call non-designated initializer as super constructor
+private class FakeSentryEvent : CocoaSentryEvent(Internal.Sentry.kSentryLevelFatal) {
+    var releaseSetCount = 0
+    var distSetCount = 0
+
+    override fun setReleaseName(releaseName: String?) {
+        super.setReleaseName(releaseName)
+        releaseSetCount += 1
+    }
+
+    override fun setDist(dist: String?) {
+        super.setDist(dist)
+        distSetCount += 1
+    }
+}

sentry-kotlin-multiplatform/src/commonJvmMain/kotlin/io/sentry/kotlin/multiplatform/extensions/SentryEventExtensions.jvm.kt

@@ -4,17 +4,25 @@ import io.sentry.kotlin.multiplatform.JvmSentryEvent
 import io.sentry.kotlin.multiplatform.JvmSentryId
 import io.sentry.kotlin.multiplatform.SentryEvent
 
+// TODO(buenaflor): properly test this once we introduce a mocking framework
 internal fun JvmSentryEvent.applyKmpEvent(kmpEvent: SentryEvent): JvmSentryEvent {
+    // Native SDKs may have a default behaviour if no release/dist is set.
+    // Setting a release/dist (even if it's null) will remove this behaviour,
+    // so we have to check if the values differ first before setting.
+    if (release != kmpEvent.release) {
+        release = kmpEvent.release
+    }
+    if (dist != kmpEvent.dist) {
+        dist = kmpEvent.dist
+    }
     level = kmpEvent.level?.toJvmSentryLevel()
     message = kmpEvent.message?.toJvmMessage()
     logger = kmpEvent.logger
     fingerprints = kmpEvent.fingerprint
-    release = kmpEvent.release
     environment = kmpEvent.environment
     platform = kmpEvent.platform
     user = kmpEvent.user?.toJvmUser()
     serverName = kmpEvent.serverName
-    dist = kmpEvent.dist
     breadcrumbs = kmpEvent.breadcrumbs?.map { it.toJvmBreadcrumb() }
     eventId = JvmSentryId(kmpEvent.eventId.toString())
     tags = kmpEvent.tags