provider evaluation de/serialization support

Signed-off-by: Kavindu Dodanduwa <[email protected]>

Author: Kavindu-Dodan

pom.xml

@@ -63,6 +63,18 @@
       <version>2.0.7</version>
     </dependency>
 
+    <dependency>
+      <groupId>com.fasterxml.jackson.core</groupId>
+      <artifactId>jackson-annotations</artifactId>
+      <version>2.15.2</version>
+    </dependency>
+
+    <dependency>
+      <groupId>com.fasterxml.jackson.core</groupId>
+      <artifactId>jackson-databind</artifactId>
+      <version>2.15.2</version>
+    </dependency>
+
     <!-- test -->
     <dependency>
       <groupId>org.mockito</groupId>
@@ -152,6 +164,13 @@
       <version>4.2.0</version>
       <scope>test</scope>
     </dependency>
+
+    <dependency>
+      <groupId>com.fasterxml.jackson.core</groupId>
+      <artifactId>jackson-core</artifactId>
+      <version>2.15.2</version>
+      <scope>test</scope>
+    </dependency>
   </dependencies>
 
   <dependencyManagement>

src/main/java/dev/openfeature/sdk/ImmutableMetadata.java

@@ -1,5 +1,7 @@
 package dev.openfeature.sdk;
 
+import com.fasterxml.jackson.annotation.JsonGetter;
+import com.fasterxml.jackson.annotation.JsonProperty;
 import lombok.extern.slf4j.Slf4j;
 
 import java.util.HashMap;
@@ -13,10 +15,17 @@
 public class ImmutableMetadata {
     private final Map<String, Object> metadata;
 
-    private ImmutableMetadata(Map<String, Object> metadata) {
+    private ImmutableMetadata(@JsonProperty("metadata") Map<String, Object> metadata) {
         this.metadata = metadata;
     }
 
+    // This is required for serialization support
+    @SuppressWarnings({"PMD.UnusedPrivateMethod"})
+    @JsonGetter("metadata")
+    private Map<String, Object> getMetadata() {
+        return this.metadata;
+    }
+
     /**
      * Retrieve a {@link String} value for the given key. A {@code null} value is returned if the key does not exist
      * or if the value is of a different type.

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

@@ -2,11 +2,14 @@
 
 import lombok.Builder;
 import lombok.Data;
+import lombok.extern.jackson.Jacksonized;
 
 import javax.annotation.Nullable;
 
 @SuppressWarnings("checkstyle:MissingJavadocType")
-@Data @Builder
+@Data
+@Builder
+@Jacksonized
 public class ProviderEvaluation<T> implements BaseEvaluation<T> {
     T value;
     @Nullable String variant;

src/test/java/dev/openfeature/sdk/FlagMetadataTest.java renamed to src/test/java/dev/openfeature/sdk/ImmutableMetadataTest.java

@@ -1,11 +1,13 @@
 package dev.openfeature.sdk;
 
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
 import org.junit.jupiter.api.DisplayName;
 import org.junit.jupiter.api.Test;
 
 import static org.assertj.core.api.Assertions.assertThat;
 
-class FlagMetadataTest {
+class ImmutableMetadataTest {
 
     @Test
     @DisplayName("Test metadata payload construction and retrieval")
@@ -61,4 +63,39 @@ public void notfound_error_validation() {
         // then
         assertThat(flagMetadata.getBoolean("string")).isNull();
     }
+
+    @Test
+    @DisplayName("Make sure class is se/deserializable")
+    public void test_serialize_deserialization() throws JsonProcessingException {
+        // given
+        ImmutableMetadata original = ImmutableMetadata.builder()
+                .addString("string", "string")
+                .addInteger("integer", 1)
+                .addLong("long", Long.MAX_VALUE)
+                .addFloat("float", Float.MAX_VALUE)
+                .addDouble("double", Double.MAX_VALUE)
+                .addBoolean("boolean", Boolean.FALSE)
+                .build();
+
+
+        final ObjectMapper mapper = new ObjectMapper();
+
+        // when
+        final String json = mapper.writeValueAsString(original);
+        final ImmutableMetadata converted = mapper.readValue(json, ImmutableMetadata.class);
+
+        // then
+        assertThat(json).isEqualTo("{\"metadata\":{\"boolean\":false,\"string\":\"string\"," +
+                "\"double\":1.7976931348623157E308,\"integer\":1,\"float\":3.4028235E38,\"long\":9223372036854775807}}");
+
+        assertThat(converted.getValue("string", String.class)).isEqualTo(original.getString("string"));
+        assertThat(converted.getValue("integer", Integer.class)).isEqualTo(original.getInteger("integer"));
+        assertThat(converted.getValue("boolean", Boolean.class)).isEqualTo(original.getBoolean("boolean"));
+        assertThat(converted.getValue("long", Long.class)).isEqualTo(original.getValue("long", Long.class));
+        assertThat(converted.getValue("double", Number.class)).isEqualTo(original.getValue("double", Number.class));
+
+        // float get converted to double, hence representation comparison
+        assertThat(converted.getValue("float", Double.class).toString())
+                .isEqualTo(original.getValue("float", Float.class).toString());
+    }
 }

src/test/java/dev/openfeature/sdk/ProviderEvaluationTest.java

@@ -0,0 +1,46 @@
+package dev.openfeature.sdk;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Test;
+
+import java.io.IOException;
+import java.io.Reader;
+import java.io.StringReader;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+class ProviderEvaluationTest {
+
+    @Test
+    @DisplayName("Provider evaluation must support JSON se/deserialization")
+    public void test_serialization_deserialization() throws IOException {
+        // given
+        final ProviderEvaluation<String> original = ProviderEvaluation.<String>builder()
+                .reason(Reason.STATIC.toString())
+                .variant("Default")
+                .value("StringValue")
+                .flagMetadata(ImmutableMetadata.builder()
+                        .addString("key", "value")
+                        .addInteger("integer", 10)
+                        .build()
+                )
+                .build();
+
+
+        // when
+        final String json = new ObjectMapper().writer().writeValueAsString(original);
+        final ObjectMapper objectMapper = new ObjectMapper();
+        final Reader reader = new StringReader(json);
+        final ProviderEvaluation converted = objectMapper.readValue(reader, ProviderEvaluation.class);
+
+        // then
+        assertThat(converted.getReason()).isEqualTo(original.getReason());
+        assertThat(converted.getVariant()).isEqualTo(original.getVariant());
+        assertThat(converted.getValue()).isEqualTo(original.getValue());
+        assertThat(converted.getFlagMetadata().getString("key"))
+                .isEqualTo(original.getFlagMetadata().getString("key"));
+        assertThat(converted.getFlagMetadata().getInteger("integer"))
+                .isEqualTo(original.getFlagMetadata().getInteger("integer"));
+    }
+}