fix: deprecate default parameters (#142)

Author: gastonfournier

unleashandroidsdk/src/main/java/io/getunleash/android/DefaultUnleash.kt

@@ -227,6 +227,21 @@ class DefaultUnleash(
         }
     }
 
+    override fun isEnabled(toggleName: String): Boolean {
+        val toggle = cache.get(toggleName)
+        val enabled = toggle?.enabled ?: false
+        val impressionData = unleashConfig.forceImpressionData || toggle?.impressionData ?: false
+        if (impressionData) {
+            emit(ImpressionEvent(toggleName, enabled, unleashContextState.value))
+        }
+        metrics.count(toggleName, enabled)
+        return enabled
+    }
+
+    @Deprecated(
+        "Use isEnabled(toggleName: String) instead. See https://github.com/Unleash/unleash-android-sdk/issues/141",
+        replaceWith = ReplaceWith("isEnabled(toggleName)")
+    )
     override fun isEnabled(toggleName: String, defaultValue: Boolean): Boolean {
         val toggle = cache.get(toggleName)
         val enabled = toggle?.enabled ?: defaultValue
@@ -238,6 +253,22 @@ class DefaultUnleash(
         return enabled
     }
 
+    override fun getVariant(toggleName: String): Variant {
+        val toggle = cache.get(toggleName)
+        val enabled = isEnabled(toggleName)
+        val variant = if (enabled) (toggle?.variant ?: disabledVariant) else disabledVariant
+        val impressionData = toggle?.impressionData ?: unleashConfig.forceImpressionData
+        if (impressionData) {
+            emit(ImpressionEvent(toggleName, enabled, unleashContextState.value, variant.name))
+        }
+        metrics.countVariant(toggleName, variant)
+        return variant
+    }
+
+    @Deprecated(
+        "Use getVariant(toggleName: String) instead. See https://github.com/Unleash/unleash-android-sdk/issues/141",
+        replaceWith = ReplaceWith("getVariant(toggleName)")
+    )
     override fun getVariant(toggleName: String, defaultValue: Variant): Variant {
         val toggle = cache.get(toggleName)
         val enabled = isEnabled(toggleName)

unleashandroidsdk/src/main/java/io/getunleash/android/Unleash.kt

@@ -12,14 +12,30 @@ val disabledVariant = Variant("disabled")
 interface Unleash: Closeable {
     /**
      * Check if a toggle is enabled or disabled
+     * @deprecated use [isEnabled(toggleName: String)] instead. Using default values can lead to unexpected behavior.
+     * @see https://github.com/Unleash/unleash-android-sdk/issues/141
      */
-    fun isEnabled(toggleName: String, defaultValue: Boolean = false): Boolean
+    @Deprecated("Use isEnabled(toggleName: String) instead. See https://github.com/Unleash/unleash-android-sdk/issues/141", ReplaceWith("isEnabled(toggleName)"))
+    fun isEnabled(toggleName: String, defaultValue: Boolean): Boolean
+
+    /**
+     * Check if a toggle is enabled or disabled
+     */
+    fun isEnabled(toggleName: String): Boolean
 
     /**
      * Get the variant for a toggle
+     * @deprecated use [getVariant(toggleName: String)] instead. Using default values can lead to unexpected behavior.
+     * @see https://github.com/Unleash/unleash-android-sdk/issues/141
      */
+    @Deprecated("Use getVariant(toggleName: String) instead. See https://github.com/Unleash/unleash-android-sdk/issues/141", ReplaceWith("getVariant(toggleName)"))
     fun getVariant(toggleName: String, defaultValue: Variant = disabledVariant): Variant
 
+    /**
+     * Get the variant for a toggle
+     */
+    fun getVariant(toggleName: String): Variant
+
     /**
      * Set context and trigger a fetch of the latest toggles immediately and block until the fetch is complete or failed.
      */