Merge branch 'main' into noop-provider

Author: nicklasl

.release-please-manifest.json

@@ -1 +1 @@
-{".":"0.2.3"}
+{".":"0.3.0"}

CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## [0.3.0](https://github.com/open-feature/kotlin-sdk/compare/v0.2.3...v0.3.0) (2024-04-08)
+
+
+### ⚠ BREAKING CHANGES
+
+* remove kotlinx.serialization dependency
+
+### 🔄 Refactoring
+
+* remove kotlinx.serialization dependency ([3145d6c](https://github.com/open-feature/kotlin-sdk/commit/3145d6c41359598e8565a19d576863df82de6f16))
+
 ## [0.2.3](https://github.com/open-feature/kotlin-sdk/compare/v0.2.2...v0.2.3) (2024-02-02)
 
 

README.md

@@ -16,8 +16,8 @@
     <img alt="Specification" src="https://img.shields.io/static/v1?label=specification&message=v0.6.0&color=yellow&style=for-the-badge" />
   </a>
   <!-- x-release-please-start-version -->
-  <a href="https://github.com/open-feature/kotlin-sdk/releases/tag/v0.2.3">
-    <img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v0.2.3&color=blue&style=for-the-badge" />
+  <a href="https://github.com/open-feature/kotlin-sdk/releases/tag/v0.3.0">
+    <img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v0.3.0&color=blue&style=for-the-badge" />
   </a>
   <!-- x-release-please-end -->
   <br/>
@@ -48,7 +48,7 @@ Installation via Maven Central is preferred, using the following dependency:
 <!-- x-release-please-start-version -->
 ```kotlin
 dependencies {
-    api("dev.openfeature:android-sdk:0.2.3")
+    api("dev.openfeature:android-sdk:0.3.0")
 }
 ```
 

android/build.gradle.kts

@@ -5,7 +5,6 @@ plugins {
     id("maven-publish")
     id("signing")
     id("org.jlleitschuh.gradle.ktlint")
-    kotlin("plugin.serialization") version "1.8.10"
 }
 
 val releaseVersion = project.extra["version"].toString()
@@ -98,7 +97,6 @@ publishing {
 
 dependencies {
     implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.7.3")
-    implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.6.2")
     testImplementation("junit:junit:4.13.2")
     testImplementation("org.mockito.kotlin:mockito-kotlin:5.1.0")
     testImplementation("org.jetbrains.kotlinx:kotlinx-coroutines-test:1.7.3")

android/src/main/java/dev/openfeature/sdk/FlagEvaluationDetails.kt

@@ -4,12 +4,13 @@ import dev.openfeature.sdk.exceptions.ErrorCode
 
 data class FlagEvaluationDetails<T>(
     val flagKey: String,
-    override val value: T,
-    override val variant: String? = null,
-    override val reason: String? = null,
-    override val errorCode: ErrorCode? = null,
-    override val errorMessage: String? = null
-) : BaseEvaluation<T> {
+    val value: T,
+    val variant: String? = null,
+    val reason: String? = null,
+    val errorCode: ErrorCode? = null,
+    val errorMessage: String? = null,
+    val metadata: EvaluationMetadata = EvaluationMetadata.EMPTY
+) {
     companion object
 }
 
@@ -18,11 +19,12 @@ fun <T> FlagEvaluationDetails.Companion.from(
     flagKey: String
 ): FlagEvaluationDetails<T> {
     return FlagEvaluationDetails(
-        flagKey,
-        providerEval.value,
-        providerEval.variant,
-        providerEval.reason,
-        providerEval.errorCode,
-        providerEval.errorMessage
+        flagKey = flagKey,
+        value = providerEval.value,
+        variant = providerEval.variant,
+        reason = providerEval.reason,
+        errorCode = providerEval.errorCode,
+        errorMessage = providerEval.errorMessage,
+        metadata = providerEval.metadata
     )
 }

android/src/main/java/dev/openfeature/sdk/FlagEvaluationMetadata.kt

@@ -0,0 +1,61 @@
+package dev.openfeature.sdk
+
+class EvaluationMetadata internal constructor(private val values: Map<String, Any>) {
+
+    fun getString(key: String): String? = values[key] as? String
+
+    fun getBoolean(key: String): Boolean? = values[key] as? Boolean
+
+    fun getInt(key: String): Int? = values[key] as? Int
+
+    fun getDouble(key: String): Double? = values[key] as? Double
+
+    companion object {
+        fun builder(): Builder {
+            return Builder()
+        }
+
+        val EMPTY = EvaluationMetadata(emptyMap())
+    }
+
+    override fun equals(other: Any?): Boolean {
+        if (this === other) return true
+        if (javaClass != other?.javaClass) return false
+
+        other as EvaluationMetadata
+
+        return values == other.values
+    }
+
+    override fun hashCode(): Int {
+        return values.hashCode()
+    }
+}
+
+class Builder {
+    private val values: MutableMap<String, Any> = mutableMapOf()
+
+    fun putString(key: String, value: String): Builder {
+        values[key] = value
+        return this
+    }
+
+    fun putInt(key: String, value: Int): Builder {
+        values[key] = value
+        return this
+    }
+
+    fun putDouble(key: String, value: Double): Builder {
+        values[key] = value
+        return this
+    }
+
+    fun putBoolean(key: String, value: Boolean): Builder {
+        values[key] = value
+        return this
+    }
+
+    fun build(): EvaluationMetadata {
+        return EvaluationMetadata(values.toMap())
+    }
+}

android/src/main/java/dev/openfeature/sdk/ProviderEvaluation.kt

@@ -7,5 +7,6 @@ data class ProviderEvaluation<T>(
     val variant: String? = null,
     val reason: String? = null,
     val errorCode: ErrorCode? = null,
-    val errorMessage: String? = null
+    val errorMessage: String? = null,
+    val metadata: EvaluationMetadata = EvaluationMetadata.EMPTY
 )

android/src/main/java/dev/openfeature/sdk/Value.kt

@@ -1,21 +1,5 @@
 package dev.openfeature.sdk
 
-import android.annotation.SuppressLint
-import dev.openfeature.sdk.exceptions.OpenFeatureError
-import kotlinx.serialization.KSerializer
-import kotlinx.serialization.Serializable
-import kotlinx.serialization.descriptors.PrimitiveKind
-import kotlinx.serialization.descriptors.PrimitiveSerialDescriptor
-import kotlinx.serialization.encoding.Decoder
-import kotlinx.serialization.encoding.Encoder
-import kotlinx.serialization.json.JsonContentPolymorphicSerializer
-import kotlinx.serialization.json.JsonElement
-import kotlinx.serialization.json.jsonObject
-import java.text.SimpleDateFormat
-import java.util.Date
-import java.util.TimeZone
-
-@Serializable(with = ValueSerializer::class)
 sealed interface Value {
 
     fun asString(): kotlin.String? = if (this is String) string else null
@@ -27,28 +11,20 @@ sealed interface Value {
     fun asStructure(): Map<kotlin.String, Value>? = if (this is Structure) structure else null
     fun isNull(): kotlin.Boolean = this is Null
 
-    @Serializable
     data class String(val string: kotlin.String) : Value
 
-    @Serializable
     data class Boolean(val boolean: kotlin.Boolean) : Value
 
-    @Serializable
     data class Integer(val integer: Int) : Value
 
-    @Serializable
     data class Double(val double: kotlin.Double) : Value
 
-    @Serializable
-    data class Date(@Serializable(DateSerializer::class) val date: java.util.Date) : Value
+    data class Date(val date: java.util.Date) : Value
 
-    @Serializable
     data class Structure(val structure: Map<kotlin.String, Value>) : Value
 
-    @Serializable
     data class List(val list: kotlin.collections.List<Value>) : Value
 
-    @Serializable
     object Null : Value {
         override fun equals(other: Any?): kotlin.Boolean {
             return other is Null
@@ -58,37 +34,4 @@ sealed interface Value {
             return javaClass.hashCode()
         }
     }
-}
-
-object ValueSerializer : JsonContentPolymorphicSerializer<Value>(Value::class) {
-    override fun selectDeserializer(element: JsonElement) = when (element.jsonObject.keys) {
-        emptySet<String>() -> Value.Null.serializer()
-        setOf("string") -> Value.String.serializer()
-        setOf("boolean") -> Value.Boolean.serializer()
-        setOf("integer") -> Value.Integer.serializer()
-        setOf("double") -> Value.Double.serializer()
-        setOf("date") -> Value.Date.serializer()
-        setOf("list") -> Value.List.serializer()
-        setOf("structure") -> Value.Structure.serializer()
-        else -> throw OpenFeatureError.ParseError("couldn't find deserialization key for Value")
-    }
-}
-
-@SuppressLint("SimpleDateFormat")
-object DateSerializer : KSerializer<Date> {
-    private val dateFormatter =
-        SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSS'Z'").apply { timeZone = TimeZone.getTimeZone("UTC") }
-    private val fallbackDateFormatter =
-        SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'").apply { timeZone = TimeZone.getTimeZone("UTC") }
-    override val descriptor = PrimitiveSerialDescriptor("Instant", PrimitiveKind.STRING)
-    override fun serialize(encoder: Encoder, value: Date) = encoder.encodeString(dateFormatter.format(value))
-    override fun deserialize(decoder: Decoder): Date = with(decoder.decodeString()) {
-        try {
-            dateFormatter.parse(this)
-                ?: throw IllegalArgumentException("unable to parse $this")
-        } catch (e: Exception) {
-            fallbackDateFormatter.parse(this)
-                ?: throw IllegalArgumentException("unable to parse $this")
-        }
-    }
 }

android/src/test/java/dev/openfeature/sdk/EvaluationMetadataTest.kt

@@ -0,0 +1,35 @@
+package dev.openfeature.sdk
+
+import org.junit.Assert
+import org.junit.Test
+
+class EvaluationMetadataTest {
+
+    private val metadata = EvaluationMetadata.builder()
+        .putString("key1", "value1")
+        .putInt("key2", 42)
+        .putBoolean("key3", true)
+        .putDouble("key4", 2.71828)
+        .build()
+
+    @Test
+    fun testAddAndGet() {
+        Assert.assertEquals("value1", metadata.getString("key1"))
+        Assert.assertEquals(42, metadata.getInt("key2"))
+        Assert.assertEquals(true, metadata.getBoolean("key3"))
+        Assert.assertEquals(2.71828, metadata.getDouble("key4"))
+    }
+
+    @Test
+    fun testGetNonExistentKey() {
+        Assert.assertNull(metadata.getString("key5"))
+    }
+
+    @Test
+    fun testInvalidType() {
+        Assert.assertNull(metadata.getString("key2"))
+        Assert.assertNull(metadata.getInt("key3"))
+        Assert.assertNull(metadata.getBoolean("key4"))
+        Assert.assertNull(metadata.getDouble("key1"))
+    }
+}

android/src/test/java/dev/openfeature/sdk/FlagEvaluationsTests.kt

@@ -76,7 +76,8 @@ class FlagEvaluationsTests {
         Assert.assertEquals(booleanDetails, client.getBooleanDetails(key, false))
         Assert.assertEquals(booleanDetails, client.getBooleanDetails(key, false, FlagEvaluationOptions()))
 
-        val stringDetails = FlagEvaluationDetails(key, "tset")
+        // in DoSomethingProvider, the string evaluation is special since it contains some metadata values
+        val stringDetails = FlagEvaluationDetails(key, "tset", metadata = DoSomethingProvider.evaluationMetadata)
         Assert.assertEquals(stringDetails, client.getStringDetails(key, "test"))
         Assert.assertEquals(stringDetails, client.getStringDetails(key, "test", FlagEvaluationOptions()))
 
@@ -93,6 +94,18 @@ class FlagEvaluationsTests {
         Assert.assertEquals(objectDetails, client.getObjectDetails(key, Value.Structure(mapOf()), FlagEvaluationOptions()))
     }
 
+    @Test
+    fun testMetadataFlagEvaluation() = runTest {
+        OpenFeatureAPI.setProvider(DoSomethingProvider())
+        val client = OpenFeatureAPI.getClient()
+        val key = "key"
+
+        val details = client.getStringDetails(key, "default")
+        val metadata: EvaluationMetadata = details.metadata
+        Assert.assertEquals("value1", metadata.getString("key1"))
+        Assert.assertEquals(42, metadata.getInt("key2"))
+    }
+
     @Test
     fun testHooksAreFired() = runTest {
         OpenFeatureAPI.setProvider(NoOpProvider())