Skip to content

On iOS default release version is cleared when no release is set on the Kotlin Multiplatform side. #337

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
jtomanik opened this issue Feb 17, 2025 · 2 comments · May be fixed by #376
Open

On iOS default release version is cleared when no release is set on the Kotlin Multiplatform side. #337

jtomanik opened this issue Feb 17, 2025 · 2 comments · May be fixed by #376
Labels
Bug Platform: KMP

Comments

@jtomanik
Copy link

Platform

Apple

Installed

Swift Package Manager

Version

8.42.0

Steps to Reproduce

  1. Do not set release property in SentryOptions in the shared code on Kotlin Multiplatform side
  2. Set properly CFBundleIdentifier, CFBundleShortVersionString, and CFBundleVersion in info.plist in the xcode project used with kotlin multi-platform
  3. Send any kind of event to Sentry (including a crash)
  4. When checking event / issue it has no associated release

Expected Result

According to the kotlin multiplatform SDK documentation:

release
Sets the release. Some SDKs will try to automatically configure a release out of the box

Then according to the iOS SDK documentation:

Setting a Release
If no release name is set, the SDK creates a default combined from CFBundleIdentifier, CFBundleShortVersionString, and CFBundleVersion, for example my.project.name@2.3.12+1234.

Which implies that when no release is set up on the Kotlin Multiplatform side that value will default to whatever platform's SDK behaviour.
In case of iOS that should be a value based on CFBundleIdentifier, CFBundleShortVersionString, and CFBundleVersion values.

Actual Result

Right now the release value transmitted to the sentry backend is null by default.

This is most likely caused by overriding the platform's default value here:

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

Line 13 in f22d5c9

releaseName = kmpEvent.release

without checking if there is any value in kmpEvent as it is done for some other fields:

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

Line 8 in f22d5c9

kmpEvent.level?.let { level = it.toCocoaSentryLevel() }

@jtomanik jtomanik added Platform: KMP Type: Bug Something isn't working labels Feb 17, 2025
@github-project-automation github-project-automation bot moved this to Needs Discussion in [DEPRECATED] Mobile SDKs Feb 17, 2025
@jtomanik
Copy link
Author

After further investigation, it turns out that this happens even earlier when you apply kmp Options to a cocoa options in CocoaSentryOptions.applyCocoaBaseOptions(kmpOptions: SentryOptions)

Specifically on this line:

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

Line 26 in f22d5c9

cocoaOptions.releaseName = kmpOptions.release

@romtsn
Copy link
Member

romtsn commented Feb 25, 2025

hi @jtomanik thanks for reporting the issue and sharing your findings, we'll make sure to have this fixed with the next version of the SDK 👍

@linear linear bot added the Bug label Apr 8, 2025
This was referenced Apr 16, 2025
Closed
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Bug Platform: KMP
Projects
[DEPRECATED] Mobile SDKs
Status: Needs Discussion
Milestone
No milestone
3 participants
@jtomanik @romtsn @stephanie-anderson