Move replay options out of experimental

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Unreleased
 
+### Feature
+
+- Move replay options out of experimental ([#367](https://github.com/getsentry/sentry-kotlin-multiplatform/pull/367))
+  - You can now access the replay options via `options.sessionReplay`
+
 ### Fixes
 
 - Do not throw if exec operation fails ([#360](https://github.com/getsentry/sentry-kotlin-multiplatform/pull/360))
@@ -43,8 +48,8 @@
 ```kotlin
 Sentry.init { options ->
   // Adjust these values for production
-  options.experimental.sessionReplay.onErrorSampleRate = 1.0
-  options.experimental.sessionReplay.sessionSampleRate = 1.0
+  options.sessionReplay.onErrorSampleRate = 1.0
+  options.sessionReplay.sessionSampleRate = 1.0
 }
 ```
 - Add `Sentry.isEnabled()` API to common code ([#273](https://github.com/getsentry/sentry-kotlin-multiplatform/pull/273))

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

@@ -185,6 +185,7 @@ public class io/sentry/kotlin/multiplatform/SentryOptions {
 	public final fun getRelease ()Ljava/lang/String;
 	public final fun getSampleRate ()Ljava/lang/Double;
 	public final fun getSdk ()Lio/sentry/kotlin/multiplatform/protocol/SdkVersion;
+	public final fun getSessionReplay ()Lio/sentry/kotlin/multiplatform/SentryReplayOptions;
 	public final fun getSessionTrackingIntervalMillis ()J
 	public final fun getTracesSampleRate ()Ljava/lang/Double;
 	public final fun isAnrEnabled ()Z
@@ -213,14 +214,13 @@ public class io/sentry/kotlin/multiplatform/SentryOptions {
 	public final fun setRelease (Ljava/lang/String;)V
 	public final fun setSampleRate (Ljava/lang/Double;)V
 	public final fun setSdk (Lio/sentry/kotlin/multiplatform/protocol/SdkVersion;)V
+	public final fun setSessionReplay (Lio/sentry/kotlin/multiplatform/SentryReplayOptions;)V
 	public final fun setSessionTrackingIntervalMillis (J)V
 	public final fun setTracesSampleRate (Ljava/lang/Double;)V
 }
 
 public final class io/sentry/kotlin/multiplatform/SentryOptions$ExperimentalOptions {
 	public fun <init> ()V
-	public final fun getSessionReplay ()Lio/sentry/kotlin/multiplatform/SentryReplayOptions;
-	public final fun setSessionReplay (Lio/sentry/kotlin/multiplatform/SentryReplayOptions;)V
 }
 
 public final class io/sentry/kotlin/multiplatform/SentryReplayOptions {

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

@@ -182,6 +182,7 @@ public class io/sentry/kotlin/multiplatform/SentryOptions {
 	public final fun getRelease ()Ljava/lang/String;
 	public final fun getSampleRate ()Ljava/lang/Double;
 	public final fun getSdk ()Lio/sentry/kotlin/multiplatform/protocol/SdkVersion;
+	public final fun getSessionReplay ()Lio/sentry/kotlin/multiplatform/SentryReplayOptions;
 	public final fun getSessionTrackingIntervalMillis ()J
 	public final fun getTracesSampleRate ()Ljava/lang/Double;
 	public final fun isAnrEnabled ()Z
@@ -210,14 +211,13 @@ public class io/sentry/kotlin/multiplatform/SentryOptions {
 	public final fun setRelease (Ljava/lang/String;)V
 	public final fun setSampleRate (Ljava/lang/Double;)V
 	public final fun setSdk (Lio/sentry/kotlin/multiplatform/protocol/SdkVersion;)V
+	public final fun setSessionReplay (Lio/sentry/kotlin/multiplatform/SentryReplayOptions;)V
 	public final fun setSessionTrackingIntervalMillis (J)V
 	public final fun setTracesSampleRate (Ljava/lang/Double;)V
 }
 
 public final class io/sentry/kotlin/multiplatform/SentryOptions$ExperimentalOptions {
 	public fun <init> ()V
-	public final fun getSessionReplay ()Lio/sentry/kotlin/multiplatform/SentryReplayOptions;
-	public final fun setSessionReplay (Lio/sentry/kotlin/multiplatform/SentryReplayOptions;)V
 }
 
 public final class io/sentry/kotlin/multiplatform/SentryReplayOptions {

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

@@ -22,15 +22,15 @@ internal fun SentryOptions.toAndroidSentryOptionsCallback(): (SentryAndroidOptio
 
     // Replay options
     androidOptions.sessionReplay.maskAllText =
-        kmpOptions.experimental.sessionReplay.maskAllText
+        kmpOptions.sessionReplay.maskAllText
     androidOptions.sessionReplay.maskAllImages =
-        kmpOptions.experimental.sessionReplay.maskAllImages
+        kmpOptions.sessionReplay.maskAllImages
     androidOptions.sessionReplay.sessionSampleRate =
-        kmpOptions.experimental.sessionReplay.sessionSampleRate
+        kmpOptions.sessionReplay.sessionSampleRate
     androidOptions.sessionReplay.onErrorSampleRate =
-        kmpOptions.experimental.sessionReplay.onErrorSampleRate
+        kmpOptions.sessionReplay.onErrorSampleRate
     androidOptions.sessionReplay.quality =
-        kmpOptions.experimental.sessionReplay.quality.toAndroidSentryQuality()
+        kmpOptions.sessionReplay.quality.toAndroidSentryQuality()
 
     // 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

sentry-kotlin-multiplatform/src/androidUnitTest/kotlin/io/sentry/kotlin/multiplatform/PlatformOptions.android.kt

@@ -88,7 +88,7 @@ actual fun PlatformOptions.assertPlatformSpecificOptions(kmpOptions: SentryOptio
     assertEquals(androidOptions.isAnrEnabled, kmpOptions.isAnrEnabled)
     assertEquals(androidOptions.anrTimeoutIntervalMillis, kmpOptions.anrTimeoutIntervalMillis)
 
-    val kmpReplayOptions = kmpOptions.experimental.sessionReplay
+    val kmpReplayOptions = kmpOptions.sessionReplay
     assertViewClassMasking(
         kmpReplayOptions.maskAllText,
         androidOptions.sessionReplay.maskViewClasses,

sentry-kotlin-multiplatform/src/commonMain/kotlin/io/sentry/kotlin/multiplatform/SentryOptions.kt

@@ -185,6 +185,12 @@ public open class SentryOptions {
      */
     public var enableWatchdogTerminationTracking: Boolean = true
 
+    /**
+     * The options for session replay.
+     * Currently available for **Android** and **iOS**.
+     */
+    public var sessionReplay: SentryReplayOptions = SentryReplayOptions()
+
     /**
      * Experimental options for new features, these options are going to be promoted to SentryOptions
      * before GA.
@@ -200,11 +206,5 @@ public open class SentryOptions {
      *
      * Beware that experimental options can change at any time.
      */
-    public class ExperimentalOptions {
-        /**
-         * Experimental feature. The options for session replay.
-         * Currently available for **Android** and **iOS**.
-         */
-        public var sessionReplay: SentryReplayOptions = SentryReplayOptions()
-    }
+    public class ExperimentalOptions
 }

sentry-kotlin-multiplatform/src/commonTest/kotlin/io/sentry/kotlin/multiplatform/SentryOptionsTest.kt

@@ -127,11 +127,11 @@ class SentryOptionsTest : BaseSentryTest() {
         assertEquals(2000L, options.appHangTimeoutIntervalMillis)
         assertTrue(options.isAnrEnabled)
         assertEquals(5000L, options.anrTimeoutIntervalMillis)
-        assertNull(options.experimental.sessionReplay.onErrorSampleRate)
-        assertNull(options.experimental.sessionReplay.sessionSampleRate)
-        assertTrue(options.experimental.sessionReplay.maskAllText)
-        assertTrue(options.experimental.sessionReplay.maskAllImages)
-        assertEquals(SentryReplayOptions.Quality.MEDIUM, options.experimental.sessionReplay.quality)
+        assertNull(options.sessionReplay.onErrorSampleRate)
+        assertNull(options.sessionReplay.sessionSampleRate)
+        assertTrue(options.sessionReplay.maskAllText)
+        assertTrue(options.sessionReplay.maskAllImages)
+        assertEquals(SentryReplayOptions.Quality.MEDIUM, options.sessionReplay.quality)
         assertTrue(options.enableWatchdogTerminationTracking)
     }
 
@@ -158,11 +158,11 @@ class SentryOptionsTest : BaseSentryTest() {
             isAnrEnabled = false
             anrTimeoutIntervalMillis = 1000L
             enableWatchdogTerminationTracking = false
-            experimental.sessionReplay.onErrorSampleRate = 0.5
-            experimental.sessionReplay.sessionSampleRate = 0.5
-            experimental.sessionReplay.maskAllText = false
-            experimental.sessionReplay.maskAllImages = false
-            experimental.sessionReplay.quality = SentryReplayOptions.Quality.LOW
+            sessionReplay.onErrorSampleRate = 0.5
+            sessionReplay.sessionSampleRate = 0.5
+            sessionReplay.maskAllText = false
+            sessionReplay.maskAllImages = false
+            sessionReplay.quality = SentryReplayOptions.Quality.LOW
         }
 
         val platformOptions = createPlatformOptions()

sentry-kotlin-multiplatform/src/iosMain/kotlin/io/sentry/kotlin/multiplatform/extensions/SentryOptionsExtensions.ios.kt

@@ -20,13 +20,13 @@ internal fun SentryOptions.toIosOptionsConfiguration(): (CocoaSentryOptions?) ->
             dictionary = mapOf(
                 // Setting the onErrorSampleRate like this, using setOnErrorSampleRate
                 // crashes on compose multiplatform for some unknown reason
-                "errorSampleRate" to kmpOptions.experimental.sessionReplay.onErrorSampleRate?.toFloat()
+                "errorSampleRate" to kmpOptions.sessionReplay.onErrorSampleRate?.toFloat()
             )
         ).apply {
-            setMaskAllText(kmpOptions.experimental.sessionReplay.maskAllText)
-            setMaskAllImages(kmpOptions.experimental.sessionReplay.maskAllImages)
-            kmpOptions.experimental.sessionReplay.sessionSampleRate?.let { setSessionSampleRate(it.toFloat()) }
-            setQuality(kmpOptions.experimental.sessionReplay.quality.ordinal.toLong())
+            setMaskAllText(kmpOptions.sessionReplay.maskAllText)
+            setMaskAllImages(kmpOptions.sessionReplay.maskAllImages)
+            kmpOptions.sessionReplay.sessionSampleRate?.let { setSessionSampleRate(it.toFloat()) }
+            setQuality(kmpOptions.sessionReplay.quality.ordinal.toLong())
         }
         cocoaOptions.setSessionReplay(replayOptions)
     } ?: run {

sentry-kotlin-multiplatform/src/iosTest/kotlin/io/sentry/kotlin/multiplatform/PlatformOptions.ios.kt

@@ -40,9 +40,9 @@ actual fun ApplePlatformOptions.assertApplePlatformSpecificOptions(options: Sent
     assertEquals(attachViewHierarchy, options.attachViewHierarchy)
     assertEquals(enableAppHangTracking, options.enableAppHangTracking)
     assertEquals(appHangTimeoutIntervalMillis, options.appHangTimeoutIntervalMillis)
-    assertEquals(sessionReplay.maskAllText(), options.experimental.sessionReplay.maskAllText)
-    assertEquals(sessionReplay.maskAllImages(), options.experimental.sessionReplay.maskAllImages)
-    assertEquals(sessionReplay.onErrorSampleRate().toDouble(), options.experimental.sessionReplay.onErrorSampleRate)
-    assertEquals(sessionReplay.sessionSampleRate().toDouble(), options.experimental.sessionReplay.sessionSampleRate)
-    assertEquals(sessionReplay.quality(), options.experimental.sessionReplay.quality.ordinal.toLong())
+    assertEquals(sessionReplay.maskAllText(), options.sessionReplay.maskAllText)
+    assertEquals(sessionReplay.maskAllImages(), options.sessionReplay.maskAllImages)
+    assertEquals(sessionReplay.onErrorSampleRate().toDouble(), options.sessionReplay.onErrorSampleRate)
+    assertEquals(sessionReplay.sessionSampleRate().toDouble(), options.sessionReplay.sessionSampleRate)
+    assertEquals(sessionReplay.quality(), options.sessionReplay.quality.ordinal.toLong())
 }

sentry-samples/kmp-app-cocoapods/shared/src/commonMain/kotlin/sample.kmp.app/SentrySetup.kt

@@ -46,8 +46,8 @@ private fun optionsConfiguration(): OptionsConfiguration {
         it.debug = true
         it.failedRequestStatusCodes = listOf(HttpStatusCodeRange(400, 599))
         it.failedRequestTargets = listOf("httpbin.org")
-        it.experimental.sessionReplay.onErrorSampleRate = 1.0
-        it.experimental.sessionReplay.sessionSampleRate = 1.0
+        it.sessionReplay.onErrorSampleRate = 1.0
+        it.sessionReplay.sessionSampleRate = 1.0
         it.beforeBreadcrumb = { breadcrumb ->
             breadcrumb.message = "Add message before every breadcrumb"
             breadcrumb