DVC-7288 Add Variable Value method (#57)

chris-hoefgen · web-flow · commit 9929be6394b0 · 2023-05-11T08:39:19.000-07:00
* adding new method to the local and cloud clients

* Updating example apps to use new variableValue() method and fixing bugs

* Retrigger github actions
diff --git a/example-cloud/src/main/java/com/devcycle/example/java/sdk/app/controller/HelloWorld.java b/example-cloud/src/main/java/com/devcycle/example/java/sdk/app/controller/HelloWorld.java
@@ -36,28 +36,48 @@ public String homePage(Model model) {
         return "home";
     }
 
+
     @GetMapping("/cloud/activateFlag")
-    public String homePageActivatedFlag(Model model) {
-        Variable<String> updateHomePage = dvcCloud.variable(getUser(), "string-var", "default string");
+    public String homePageActivatedFlagValue(Model model) {
+        String variableKey = "string-var";
+        // if the variable "string-var" doesn't exist or is not applicable for the user, the default value will be returned
+        try {
+            String updateHomePageValue = dvcCloud.variableValue(getUser(), variableKey, "default string");
+            model.addAttribute("variableKey", variableKey);
+            model.addAttribute("variationValue", updateHomePageValue);
+        }catch (DVCException e){
+            System.out.println("DVCException: " + e.getMessage());
+        }
+        return "fragments/flagData :: value ";
+    }
 
-        String variationValue = updateHomePage.getValue();
+    @GetMapping("/cloud/activateFlagDetails")
+    public String homePageActivatedFlagDetails(Model model) {
+        String variableKey = "string-var";
+        try{
+            Variable<String> updateHomePageVariable = dvcCloud.variable(getUser(), variableKey, "default string");
 
-        // if the variable "activate-flag" doesn't exist isDefaulted will be true
-        model.addAttribute("isDefaultValue", updateHomePage.getIsDefaulted());
-        model.addAttribute("variationValue", variationValue);
-        return "fragments/flagData :: value ";
+            // if the variable "string-var" doesn't exist isDefaulted will be true
+            model.addAttribute("isDefaultValue", updateHomePageVariable.getIsDefaulted());
+            model.addAttribute("variableKey", variableKey);
+            model.addAttribute("variationValue", updateHomePageVariable.getValue());
+        }catch (DVCException e){
+            System.out.println("DVCException: " + e.getMessage());
+        }
+        return "fragments/flagDataDetails :: value ";
     }
 
     @GetMapping("/cloud/track")
     public String trackCloud(Model model) {
-        DVCResponse response = null;
+        String response = "";
         try {
-            response = dvcCloud.track(getUser(), Event.builder().type("java-cloud-custom").build());
+            dvcCloud.track(getUser(), Event.builder().type("java-cloud-custom").build());
+            response = "java-cloud-custom tracked!";
         } catch(DVCException e) {
-            System.out.println("Error tracking custom event: " + e.getMessage());
+            response = "Error tracking custom event: " + e.getMessage();
         }
         model.addAttribute("trackSuccessMessage", "Cloud custom event tracked!");
-        model.addAttribute("trackResponse", response.getMessage());
+        model.addAttribute("trackResponse", response);
         return "fragments/trackData :: value ";
     }
 
diff --git a/example-cloud/src/main/resources/application.properties b/example-cloud/src/main/resources/application.properties
@@ -6,4 +6,4 @@ spring.thymeleaf.suffix=.html
 spring.application.name=Default Flag
 spring.application.oops=Default Flag when variation could not be fetched
 
-devcycle.sdkKey=your SDK Key
+devcycle.sdkKey=Your DVC_SERVER_SDK_KEY here
diff --git a/example-cloud/src/main/resources/templates/fragments/flagData.html b/example-cloud/src/main/resources/templates/fragments/flagData.html
@@ -1,11 +1,11 @@
 <div th:fragment="value">
     <H2 class="display-5 fw-bold">DevCycle Flag</H2>
     <div>
-        <label>Using default value?</label>
-        <span th:text="${isDefaultValue}"></span>
+        <label>Key:</label>
+        <span th:text="${variableKey}"></span>
     </div>
     <div>
-        <label>Variation value:</label>
+        <label>Value:</label>
         <span th:text="${variationValue}"></span>
     </div>
 </div>
diff --git a/example-cloud/src/main/resources/templates/fragments/flagDataDetails.html b/example-cloud/src/main/resources/templates/fragments/flagDataDetails.html
@@ -0,0 +1,15 @@
+<div th:fragment="value">
+    <H2 class="display-5 fw-bold">DevCycle Flag</H2>
+    <div>
+        <label>Key:</label>
+        <span th:text="${variableKey}"></span>
+    </div>
+    <div>
+        <label>Using default value?</label>
+        <span th:text="${isDefaultValue}"></span>
+    </div>
+    <div>
+        <label>Variation value:</label>
+        <span th:text="${variationValue}"></span>
+    </div>
+</div>
diff --git a/example-cloud/src/main/resources/templates/home.html b/example-cloud/src/main/resources/templates/home.html
@@ -23,8 +23,11 @@ <h1 class="display-5 fw-bold">Example app for the DevCycle Java SDK using Cloud
                 <p class="lead mb-4">Simple Spring Boot example to show a default value before creating a feature,
                     fetching a variable, and tracking custom events via the DevCycle SDK</p>
                 <div class="gap-2 d-sm-flex justify-content-sm-center pb-2">
+                    <button type="button" class="btn btn-primary btn-lg px-4 gap-3" th:onclick="getValue()">
+                        Cloud - Get Value
+                    </button>
                     <button type="button" class="btn btn-primary btn-lg px-4 gap-3" th:onclick="getVariable()">
-                        Cloud - Get Variable
+                        Cloud - Get Variable Details
                     </button>
                     <button type="button" class="btn btn-primary btn-lg px-4 gap-3" th:onclick="trackCloud()">
                         Cloud - Track
@@ -43,7 +46,7 @@ <h1 class="display-5 fw-bold">Example app for the DevCycle Java SDK using Cloud
         integrity="sha384-MrcW6ZMFYlzcLA8Nl+NtUVF0sA7MsXsP1UyJoMp4YLEuNSfAP+JcXn/tWtIaxVXM"
         crossorigin="anonymous"></script>
     <script>
-        const getVariable = () => {
+        const getValue = () => {
             fetch('cloud/activateFlag').then(function (response) {
                 return response.text();
             }).then(function (html) {
@@ -53,6 +56,16 @@ <h1 class="display-5 fw-bold">Example app for the DevCycle Java SDK using Cloud
             });
         }
 
+        const getVariable = () => {
+            fetch('cloud/activateFlagDetails').then(function (response) {
+                return response.text();
+            }).then(function (html) {
+                document.getElementById("variablePlaceholder").innerHTML = html;
+            }).catch(function (err) {
+                console.warn('Something went wrong.', err);
+            });
+        }
+
         const trackCloud = () => {
             fetch('cloud/track').then(function (response) {
                 return response.text();
diff --git a/example-local/src/main/java/com/devcycle/example/java/sdk/app/controller/HelloWorld.java b/example-local/src/main/java/com/devcycle/example/java/sdk/app/controller/HelloWorld.java
@@ -41,15 +41,26 @@ public String homePage(Model model) {
     }
 
     @GetMapping("/local/activateFlag")
-    public String homePageActivatedFlag(Model model) {
-        Variable<String> updateHomePage = dvcClient.variable(getUser(), "string-var", "default string");
+    public String homePageActivatedFlagValue(Model model) {
+        String variableKey = "string-var";
+        // if the variable "string-var" doesn't exist or is not applicable for the user, the default value will be returned
+        String updateHomePage = dvcClient.variableValue(getUser(), variableKey, "default string");
+        model.addAttribute("variableKey", variableKey);
+        model.addAttribute("variationValue", updateHomePage);
+        return "fragments/flagData :: value ";
+    }
 
-        String variationValue = updateHomePage.getValue();
+    @GetMapping("/local/activateFlagDetails")
+    public String homePageActivatedFlagDetails(Model model) {
+        String variableKey = "string-var";
+        Variable<String> updateHomePageVariable = dvcClient.variable(getUser(), variableKey, "default string");
 
-        // if the variable "activate-flag" doesn't exist isDefaulted will be true
-        model.addAttribute("isDefaultValue", updateHomePage.getIsDefaulted());
-        model.addAttribute("variationValue", variationValue);
-        return "fragments/flagData :: value ";
+        // if the variable "string-var" doesn't exist isDefaulted will be true
+
+        model.addAttribute("isDefaultValue", updateHomePageVariable.getIsDefaulted());
+        model.addAttribute("variableKey", variableKey);
+        model.addAttribute("variationValue", updateHomePageVariable.getValue());
+        return "fragments/flagDataDetails :: value ";
     }
 
     @GetMapping("/local/track")
diff --git a/example-local/src/main/resources/application.properties b/example-local/src/main/resources/application.properties
@@ -6,4 +6,4 @@ spring.thymeleaf.suffix=.html
 spring.application.name=Default Flag
 spring.application.oops=Default Flag when variation could not be fetched
 
-devcycle.sdkKey=your SDK Key
+devcycle.sdkKey=Your DVC_SERVER_SDK_KEY here
diff --git a/example-local/src/main/resources/templates/fragments/flagData.html b/example-local/src/main/resources/templates/fragments/flagData.html
@@ -1,11 +1,11 @@
 <div th:fragment="value">
     <H2 class="display-5 fw-bold">DevCycle Flag</H2>
     <div>
-        <label>Using default value?</label>
-        <span th:text="${isDefaultValue}"></span>
+        <label>Key:</label>
+        <span th:text="${variableKey}"></span>
     </div>
     <div>
-        <label>Variation value:</label>
+        <label>Value:</label>
         <span th:text="${variationValue}"></span>
     </div>
 </div>
diff --git a/example-local/src/main/resources/templates/fragments/flagDataDetails.html b/example-local/src/main/resources/templates/fragments/flagDataDetails.html
@@ -0,0 +1,15 @@
+<div th:fragment="value">
+    <H2 class="display-5 fw-bold">DevCycle Flag</H2>
+    <div>
+        <label>Key:</label>
+        <span th:text="${variableKey}"></span>
+    </div>
+    <div>
+        <label>Using default value?</label>
+        <span th:text="${isDefaultValue}"></span>
+    </div>
+    <div>
+        <label>Variation value:</label>
+        <span th:text="${variationValue}"></span>
+    </div>
+</div>
diff --git a/example-local/src/main/resources/templates/home.html b/example-local/src/main/resources/templates/home.html
@@ -23,8 +23,11 @@ <h1 class="display-5 fw-bold">Example app for the DevCycle Java SDK using Local
                 <p class="lead mb-4">Simple Spring Boot example to show a default value before creating a feature,
                     fetching a variable, and tracking custom events via the DevCycle SDK</p>
                 <div class="gap-2 d-sm-flex justify-content-sm-center pb-2">
+                    <button type="button" class="btn btn-primary btn-lg px-4 gap-3" th:onclick="getValue()">
+                        Local - Get Value
+                    </button>
                     <button type="button" class="btn btn-primary btn-lg px-4 gap-3" th:onclick="getVariable()">
-                        Local - Get Variable
+                        Local - Get Variable Details
                     </button>
                     <button type="button" class="btn btn-primary btn-lg px-4 gap-3" th:onclick="trackLocal()">
                         Local - Track
@@ -43,7 +46,7 @@ <h1 class="display-5 fw-bold">Example app for the DevCycle Java SDK using Local
         integrity="sha384-MrcW6ZMFYlzcLA8Nl+NtUVF0sA7MsXsP1UyJoMp4YLEuNSfAP+JcXn/tWtIaxVXM"
         crossorigin="anonymous"></script>
     <script>
-        const getVariable = () => {
+        const getValue = () => {
             fetch('local/activateFlag').then(function (response) {
                 return response.text();
             }).then(function (html) {
@@ -53,6 +56,16 @@ <h1 class="display-5 fw-bold">Example app for the DevCycle Java SDK using Local
             });
         }
 
+        const getVariable = () => {
+            fetch('local/activateFlagDetails').then(function (response) {
+                return response.text();
+            }).then(function (html) {
+                document.getElementById("variablePlaceholder").innerHTML = html;
+            }).catch(function (err) {
+                console.warn('Something went wrong.', err);
+            });
+        }
+
         const trackLocal = () => {
             fetch('local/track').then(function (response) {
                 return response.text();
diff --git a/src/main/java/com/devcycle/sdk/server/cloud/api/DVCCloudClient.java b/src/main/java/com/devcycle/sdk/server/cloud/api/DVCCloudClient.java
@@ -46,13 +46,28 @@ public Map<String, Feature> allFeatures(User user) throws DVCException {
     return getResponse(response);
   }
 
+  /**
+   * Get variable value by key for user data
+   *
+   * @param user (required)
+   * @param key  Feature key (required)
+   * @param defaultValue Default value to use if the variable could not be fetched
+   *                     (required)
+   * @return Variable value
+   * @throws DVCException If there are any uses with the data provided
+   */
+  public <T> T variableValue(User user, String key, T defaultValue)  throws DVCException {
+    return variable(user, key, defaultValue).getValue();
+  }
+
   /**
    * Get variable by key for user data
    * 
    * @param user  (required)
    * @param key Variable key (required)
    * @param defaultValue Default value to use if the variable could not be fetched (required)
    * @return Variable
+   * @throws DVCException If there are any uses with the data provided
    */
   @SuppressWarnings("unchecked")
   public <T> Variable<T> variable(User user, String key, T defaultValue) throws DVCException {
diff --git a/src/main/java/com/devcycle/sdk/server/local/api/DVCLocalClient.java b/src/main/java/com/devcycle/sdk/server/local/api/DVCLocalClient.java
@@ -67,6 +67,19 @@ public Map<String, Feature> allFeatures(User user) {
     return bucketedUserConfig.features;
   }
 
+  /**
+   * Get variable value by key for user data
+   *
+   * @param user (required)
+   * @param key  Feature key (required)
+   * @param defaultValue Default value to use if the variable could not be fetched
+   *                     (required)
+   * @return Variable value
+   */
+  public <T> T variableValue(User user, String key, T defaultValue) {
+    return variable(user, key, defaultValue).getValue();
+  }
+
   /**
    * Get variable by key for user data
    * 
diff --git a/src/test/java/com/devcycle/sdk/server/cloud/DVCCloudClientTest.java b/src/test/java/com/devcycle/sdk/server/cloud/DVCCloudClientTest.java
@@ -91,6 +91,27 @@ public void getVariableByKeyTest() {
         }
     }
 
+    @Test
+    public void getVariableValueByKeyTest() {
+        User user = User.builder()
+                .userId("j_test")
+                .build();
+
+        String key = "show-quickstart";
+
+        when(apiInterface.getVariableByKey(user, key, dvcOptions.getEnableEdgeDB())).thenReturn(dvcApiMock.getVariableByKey(user, key, dvcOptions.getEnableEdgeDB()));
+
+        try {
+            boolean value = api.variableValue(user, key, true);
+
+            assertUserDefaultsCorrect(user);
+
+            Assert.assertFalse(value);
+        } catch (DVCException e) {
+            e.printStackTrace();
+        }
+    }
+
     @Test
     public void getVariablesTest() throws DVCException {
         User user = User.builder()
diff --git a/src/test/java/com/devcycle/sdk/server/local/DVCLocalClientTest.java b/src/test/java/com/devcycle/sdk/server/local/DVCLocalClientTest.java
@@ -52,6 +52,15 @@ public void variableTest() {
         Assert.assertEquals("variationOn", var.getValue());
     }
 
+    public void variableValueTest() {
+        User user = getUser();
+        user.setEmail("giveMeVariationOff@email.com");
+        Assert.assertEquals("variationOff", client.variableValue(user, "string-var", "default string"));
+
+        user.setEmail("giveMeVariationOn@email.com");
+        Assert.assertEquals("variationOn", client.variableValue(user, "string-var", "default string"));
+    }
+
     @Test
     public void allFeaturesTest() {
         User user = getUser();
