feat: adds support for allVariables calls to return eval reasons

Author: kaushalkapasi

src/main/java/com/devcycle/sdk/server/cloud/api/DevCycleCloudClient.java

@@ -166,7 +166,7 @@ public <T> Variable<T> variable(DevCycleUser user, String key, T defaultValue) {
                 if (exception.getMessage().equals("Variable type mismatch, returning default value")) {
                     variable.setEval(EvalReason.defaultReason(EvalReason.DefaultReasonDetailsEnum.VARIABLE_TYPE_MISMATCH));
                 } else {
-                    variable.setEval(EvalReason.defaultReason(EvalReason.DefaultReasonDetailsEnum.USER_NOT_TARGETED));
+                    variable.setEval(EvalReason.defaultReason(EvalReason.DefaultReasonDetailsEnum.ERROR));
                 }
             }
 

src/main/java/com/devcycle/sdk/server/common/model/BaseVariable.java

@@ -3,6 +3,7 @@
 import com.devcycle.sdk.server.common.model.Variable.TypeEnum;
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.fasterxml.jackson.annotation.JsonProperty;
+
 import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.AllArgsConstructor;
 import lombok.Builder;
@@ -27,4 +28,7 @@ public class BaseVariable {
 
     @Schema(required = true, description = "Variable value can be a string, number, boolean, or JSON")
     private Object value;
+
+    @Schema(description = "Evaluation reason")
+    private EvalReason eval;
 }

src/test/java/com/devcycle/sdk/server/cloud/DevCycleCloudClientTest.java

@@ -111,6 +111,34 @@ public void getVariableByKeyTest() {
         }
     }
 
+    @Test
+    public void getVariableTypeMismatchTest() {
+        DevCycleUser user = DevCycleUser.builder()
+                .userId("j_test")
+                .build();
+
+        String key = "type-mismatch";
+
+        when(apiInterface.getVariableByKey(user, key, dvcOptions.getEnableEdgeDB())).thenReturn(dvcApiMock.getVariableByKey(user, key, dvcOptions.getEnableEdgeDB()));
+
+        Variable<Boolean> variable;
+        try {
+            variable = api.variable(user, key, true);
+
+            assertUserDefaultsCorrect(user);
+
+            Assert.assertTrue(variable.getValue());
+            Assert.assertTrue(variable.getIsDefaulted());
+
+            EvalReason varEval = variable.getEval();
+            Assert.assertEquals("DEFAULT", varEval.getReason());
+            Assert.assertEquals("Variable Type Mismatch", varEval.getDetails());
+            Assert.assertNull(varEval.getTargetId());
+        } catch (IllegalArgumentException e) {
+            e.printStackTrace();
+        }
+    }
+
     @Test
     public void getVariableValueByKeyTest() {
         DevCycleUser user = DevCycleUser.builder()
@@ -145,6 +173,14 @@ public void getVariablesTest() throws DevCycleException {
         assertUserDefaultsCorrect(user);
 
         Assert.assertNotNull(variables);
+        Assert.assertEquals(4, variables.size());
+        BaseVariable testNumber = variables.get("test-number");
+        Assert.assertNotNull(testNumber);
+        Assert.assertEquals(100, (int) testNumber.getValue());
+        Assert.assertEquals(Variable.TypeEnum.NUMBER, testNumber.getType());
+        Assert.assertEquals("SPLIT", testNumber.getEval().getReason());
+        Assert.assertEquals("Random Distribution | User Id", testNumber.getEval().getDetails());
+        Assert.assertEquals("test_cloud_target_id", testNumber.getEval().getTargetId());
     }
 
     @Test

src/test/java/com/devcycle/sdk/server/common/api/DVCApiMock.java

@@ -1,11 +1,18 @@
 package com.devcycle.sdk.server.common.api;
 
-import com.devcycle.sdk.server.common.model.*;
+import java.util.Map;
+
+import com.devcycle.sdk.server.common.model.BaseVariable;
+import com.devcycle.sdk.server.common.model.DevCycleResponse;
+import com.devcycle.sdk.server.common.model.DevCycleUser;
+import com.devcycle.sdk.server.common.model.DevCycleUserAndEvents;
+import com.devcycle.sdk.server.common.model.Feature;
+import com.devcycle.sdk.server.common.model.ProjectConfig;
+import com.devcycle.sdk.server.common.model.Variable;
 import com.devcycle.sdk.server.helpers.TestResponse;
 import com.devcycle.sdk.server.local.model.EventsBatch;
-import retrofit2.Call;
 
-import java.util.Map;
+import retrofit2.Call;
 
 public class DVCApiMock implements IDevCycleApi {
 
@@ -16,7 +23,7 @@ public Call<Map<String, Feature>> getFeatures(DevCycleUser user, Boolean enabled
 
     @Override
     public Call<Variable> getVariableByKey(DevCycleUser user, String key, Boolean enabledEdgeDB) {
-        return TestResponse.getVariableByKey();
+        return TestResponse.getVariableByKey(key);
     }
 
     @Override

src/test/java/com/devcycle/sdk/server/helpers/TestResponse.java

@@ -57,37 +57,51 @@ public static Call<Map<String, BaseVariable>> getVariables() {
                 .key("test-false")
                 .value(false)
                 .type(Variable.TypeEnum.BOOLEAN)
+                .eval(new EvalReason("SPLIT", "Random Distribution | User Id", "test_cloud_target_id"))
                 .build());
         variables.put("test-true", BaseVariable.builder()
                 .id(UUID.randomUUID().toString())
                 .key("test-true")
                 .value(true)
                 .type(Variable.TypeEnum.BOOLEAN)
+                .eval(new EvalReason("SPLIT", "Random Distribution | User Id", "test_cloud_target_id"))
                 .build());
         variables.put("test-number", BaseVariable.builder()
                 .id(UUID.randomUUID().toString())
                 .key("test-number")
                 .value(100)
                 .type(Variable.TypeEnum.NUMBER)
+                .eval(new EvalReason("SPLIT", "Random Distribution | User Id", "test_cloud_target_id"))
                 .build());
         variables.put("test-json", BaseVariable.builder()
                 .id(UUID.randomUUID().toString())
                 .key("test-json")
                 .value("{'some':'json''}")
                 .type(Variable.TypeEnum.JSON)
+                .eval(new EvalReason("SPLIT", "Random Distribution | User Id", "test_cloud_target_id"))
                 .build());
 
         return Calls.response(variables);
     }
 
     @SuppressWarnings("unchecked")
-    public static <T> Call<Variable> getVariableByKey() {
-        Variable<T> variable = (Variable<T>) Variable.builder()
+    public static <T> Call<Variable> getVariableByKey(String key) {
+        Variable<T> variable = null;
+        if (key.equals("type-mismatch")) {
+            variable = (Variable<T>) Variable.builder()
+                .key("type-mismatch")
+                .value(100)
+                .type(Variable.TypeEnum.NUMBER)
+                .eval(new EvalReason("TARGETING_MATCH", "All Users", "test_cloud_target_id"))
+                .build();
+        } else {
+                variable = (Variable<T>) Variable.builder()
                 .key("test-false")
                 .value(false)
                 .type(Variable.TypeEnum.BOOLEAN)
                 .eval(new EvalReason("TARGETING_MATCH", "All Users", "test_cloud_target_id"))
                 .build();
+        }
 
         return Calls.response(variable);
     }