feat(api): Feature variable APIs now return default variable value when featureEnabled property is false. (#276)

Author: mnoman09

.travis.yml

@@ -28,6 +28,7 @@ after_success:
   - ./gradlew coveralls uploadArchives --console plain
 after_failure:
   - cat /home/travis/build/optimizely/java-sdk/core-api/build/reports/findbugs/main.html
+  - cat /home/travis/build/optimizely/java-sdk/core-api/build/reports/findbugs/test.html
 
 # Integration tests need to run first to reset the PR build status to pending
 stages:

core-api/src/main/java/com/optimizely/ab/Optimizely.java

@@ -650,12 +650,19 @@ String getFeatureVariableValueForType(@Nonnull String featureKey,
         Map<String, ?> copiedAttributes = copyAttributes(attributes);
         FeatureDecision featureDecision = decisionService.getVariationForFeature(featureFlag, userId, copiedAttributes);
         if (featureDecision.variation != null) {
-            FeatureVariableUsageInstance featureVariableUsageInstance =
-                featureDecision.variation.getVariableIdToFeatureVariableUsageInstanceMap().get(variable.getId());
-            if (featureVariableUsageInstance != null) {
-                variableValue = featureVariableUsageInstance.getValue();
+            if (featureDecision.variation.getFeatureEnabled()) {
+                FeatureVariableUsageInstance featureVariableUsageInstance =
+                    featureDecision.variation.getVariableIdToFeatureVariableUsageInstanceMap().get(variable.getId());
+                if (featureVariableUsageInstance != null) {
+                    variableValue = featureVariableUsageInstance.getValue();
+                } else {
+                    variableValue = variable.getDefaultValue();
+                }
             } else {
-                variableValue = variable.getDefaultValue();
+                logger.info("Feature \"{}\" for variation \"{}\" was not enabled. " +
+                        "The default value is being returned.",
+                    featureKey, featureDecision.variation.getKey(), variableValue, variableKey
+                );
             }
         } else {
             logger.info("User \"{}\" was not bucketed into any variation for feature flag \"{}\". " +

core-api/src/test/java/com/optimizely/ab/OptimizelyTest.java

@@ -3348,19 +3348,18 @@ public void getFeatureVariableValueReturnsDefaultValueWhenFeatureIsAttachedToOne
 
     /**
      * Verify {@link Optimizely#getFeatureVariableValueForType(String, String, String, Map, FeatureVariable.VariableType)}
-     * returns the variable value of the variation the user is bucketed into
-     * if the variation is not null and the variable has a usage within the variation.
+     * is called when the variation is not null and feature enabled is false
+     * returns the default variable value
      *
      * @throws ConfigParseException
      */
     @Test
-    public void getFeatureVariableValueReturnsVariationValueWhenUserGetsBucketedToVariation() throws ConfigParseException {
+    public void getFeatureVariableValueReturnsDefaultValueWhenFeatureEnabledIsFalse() throws ConfigParseException {
         assumeTrue(datafileVersion >= Integer.parseInt(ProjectConfig.Version.V4.toString()));
 
         String validFeatureKey = FEATURE_MULTI_VARIATE_FEATURE_KEY;
         String validVariableKey = VARIABLE_FIRST_LETTER_KEY;
-        FeatureVariable variable = FEATURE_FLAG_MULTI_VARIATE_FEATURE.getVariableKeyToFeatureVariableMap().get(validVariableKey);
-        String expectedValue = VARIATION_MULTIVARIATE_EXPERIMENT_GRED.getVariableIdToFeatureVariableUsageInstanceMap().get(variable.getId()).getValue();
+        String expectedValue = VARIABLE_FIRST_LETTER_DEFAULT_VALUE;
         Experiment multivariateExperiment = validProjectConfig.getExperimentKeyMapping().get(EXPERIMENT_MULTIVARIATE_EXPERIMENT_KEY);
 
         Optimizely optimizely = Optimizely.builder(validDatafile, mockEventHandler)
@@ -3383,9 +3382,166 @@ public void getFeatureVariableValueReturnsVariationValueWhenUserGetsBucketedToVa
             FeatureVariable.VariableType.STRING
         );
 
+        logbackVerifier.expectMessage(
+            Level.INFO,
+            "Feature \"" + validFeatureKey + "\" for variation \"Gred\" was not enabled. " +
+                "The default value is being returned."
+        );
+
         assertEquals(expectedValue, value);
     }
 
+    /**
+     * Verify that the {@link Optimizely#getFeatureVariableString(String, String, String, Map)}
+     * is called when feature is in experiment and feature enabled is true
+     * returns variable value
+     */
+    @Test
+    public void getFeatureVariableUserInExperimentFeatureOn() throws Exception {
+        assumeTrue(datafileVersion >= Integer.parseInt(ProjectConfig.Version.V4.toString()));
+
+        final String validFeatureKey = FEATURE_MULTI_VARIATE_FEATURE_KEY;
+        String validVariableKey = VARIABLE_FIRST_LETTER_KEY;
+        String expectedValue = "F";
+
+        Optimizely optimizely = Optimizely.builder(validDatafile, mockEventHandler)
+            .withConfig(validProjectConfig)
+            .build();
+
+        assertEquals(optimizely.getFeatureVariableString(
+            validFeatureKey,
+            validVariableKey,
+            testUserId,
+            Collections.singletonMap(ATTRIBUTE_HOUSE_KEY, AUDIENCE_GRYFFINDOR_VALUE)),
+            expectedValue);
+    }
+
+    /**
+     * Verify that the {@link Optimizely#getFeatureVariableString(String, String, String, Map)}
+     * is called when feature is in experiment and feature enabled is false
+     * than default value will gets returned
+     */
+    @SuppressFBWarnings("NP_NONNULL_PARAM_VIOLATION")
+    @Test
+    public void getFeatureVariableWithListenerUserInExperimentFeatureOff() {
+        assumeTrue(datafileVersion >= Integer.parseInt(ProjectConfig.Version.V4.toString()));
+
+        final String validFeatureKey = FEATURE_MULTI_VARIATE_FEATURE_KEY;
+        String validVariableKey = VARIABLE_FIRST_LETTER_KEY;
+        String expectedValue = "H";
+        String userID = "Gred";
+
+        Optimizely optimizely = Optimizely.builder(validDatafile, mockEventHandler)
+            .withConfig(validProjectConfig)
+            .build();
+
+        assertEquals(optimizely.getFeatureVariableString(
+            validFeatureKey,
+            validVariableKey,
+            userID,
+            null),
+            expectedValue);
+     }
+
+    /**
+     * Verify that the {@link Optimizely#getFeatureVariableString(String, String, String, Map)}
+     * is called when feature is in rollout and feature enabled is true
+     * returns variable value
+     */
+    @Test
+    public void getFeatureVariableUserInRollOutFeatureOn() throws Exception {
+        assumeTrue(datafileVersion >= Integer.parseInt(ProjectConfig.Version.V4.toString()));
+
+        final String validFeatureKey = FEATURE_SINGLE_VARIABLE_STRING_KEY;
+        String validVariableKey = VARIABLE_STRING_VARIABLE_KEY;
+        String expectedValue = "lumos";
+
+        Optimizely optimizely = Optimizely.builder(validDatafile, mockEventHandler)
+            .withConfig(validProjectConfig)
+            .build();
+
+        assertEquals(optimizely.getFeatureVariableString(
+            validFeatureKey,
+            validVariableKey,
+            genericUserId,
+            Collections.singletonMap(ATTRIBUTE_HOUSE_KEY, AUDIENCE_GRYFFINDOR_VALUE)),
+            expectedValue);
+    }
+
+    /**
+     * Verify that the {@link Optimizely#getFeatureVariableBoolean(String, String, String, Map)}
+     * is called when feature is not in rollout and feature enabled is false
+     * returns default value
+     */
+    @Test
+    public void getFeatureVariableUserNotInRollOutFeatureOff() {
+        assumeTrue(datafileVersion >= Integer.parseInt(ProjectConfig.Version.V4.toString()));
+
+        final String validFeatureKey = FEATURE_SINGLE_VARIABLE_BOOLEAN_KEY;
+        String validVariableKey = VARIABLE_BOOLEAN_VARIABLE_KEY;
+        Boolean expectedValue = true;
+
+        Optimizely optimizely = Optimizely.builder(validDatafile, mockEventHandler)
+            .withConfig(validProjectConfig)
+            .build();
+
+        assertEquals(optimizely.getFeatureVariableBoolean(
+            validFeatureKey,
+            validVariableKey,
+            genericUserId,
+            Collections.singletonMap(ATTRIBUTE_HOUSE_KEY, AUDIENCE_GRYFFINDOR_VALUE)),
+            expectedValue);
+    }
+
+    /**
+     * Verify that the {@link Optimizely#getFeatureVariableInteger(String, String, String, Map)}
+     * is called when feature is in rollout and feature enabled is true
+     * return rollout variable value
+     */
+    @Test
+    public void getFeatureVariableIntegerUserInRollOutFeatureOn() {
+        assumeTrue(datafileVersion >= Integer.parseInt(ProjectConfig.Version.V4.toString()));
+
+        final String validFeatureKey = FEATURE_SINGLE_VARIABLE_INTEGER_KEY;
+        String validVariableKey = VARIABLE_INTEGER_VARIABLE_KEY;
+        int expectedValue = 7;
+
+        Optimizely optimizely = Optimizely.builder(validDatafile, mockEventHandler)
+            .withConfig(validProjectConfig)
+            .build();
+
+        assertEquals((long) optimizely.getFeatureVariableInteger(
+            validFeatureKey,
+            validVariableKey,
+            genericUserId,
+            Collections.singletonMap(ATTRIBUTE_HOUSE_KEY, AUDIENCE_GRYFFINDOR_VALUE)),
+            (long) expectedValue);
+    }
+
+    /**
+     * Verify that the {@link Optimizely#getFeatureVariableDouble(String, String, String, Map)}
+     * is called when feature is in experiment and feature enabled is true
+     * returns variable value
+     */
+    @Test
+    public void getFeatureVariableDoubleUserInExperimentFeatureOn() throws Exception {
+        assumeTrue(datafileVersion >= Integer.parseInt(ProjectConfig.Version.V4.toString()));
+
+        final String validFeatureKey = FEATURE_SINGLE_VARIABLE_DOUBLE_KEY;
+        String validVariableKey = VARIABLE_DOUBLE_VARIABLE_KEY;
+
+        Optimizely optimizely = Optimizely.builder(validDatafile, mockEventHandler)
+            .withConfig(validProjectConfig)
+            .build();
+
+        assertEquals(optimizely.getFeatureVariableDouble(
+            validFeatureKey,
+            validVariableKey,
+            genericUserId,
+            Collections.singletonMap(ATTRIBUTE_HOUSE_KEY, AUDIENCE_SLYTHERIN_VALUE)),
+            Math.PI, 2);
+    }
+
     /**
      * Verify {@link Optimizely#getFeatureVariableValueForType(String, String, String, Map, FeatureVariable.VariableType)}
      * returns the default value for the feature variable