Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add getFeatureVariableJSON and getAllFeatureVariables apis #337

Merged
merged 7 commits into from
Jul 10, 2020
Merged

feat: add getFeatureVariableJSON and getAllFeatureVariables apis #337

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
583135e
Added getFeatureVariable json and getAllFeatureVariables support
mnoman09 Jul 2, 2020
5a46be2
Added getAllFeatureVariables unit tests
mnoman09 Jul 2, 2020
514d3c3
nit fix
mnoman09 Jul 2, 2020
e7d8815
added getvalue test
mnoman09 Jul 2, 2020
06ace03
getValue null test
mnoman09 Jul 2, 2020
c11bd68
- Add mavenLocal() to supported repositories for local development
mnoman09 Jul 7, 2020
09576f8
updated java sdk release version
mnoman09 Jul 8, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
253 changes: 252 additions & 1 deletion android-sdk/src/androidTest/java/com/optimizely/ab/android/sdk/OptimizelyClientTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/****************************************************************************
* Copyright 2017-2019, Optimizely, Inc. and contributors *
* Copyright 2017-2020, Optimizely, Inc. and contributors *
* *
* Licensed under the Apache License, Version 2.0 (the "License"); *
* you may not use this file except in compliance with the License. *
Expand All @@ -19,13 +19,17 @@
import android.content.Context;
import android.support.test.InstrumentationRegistry;

import com.google.gson.Gson;
import com.google.gson.JsonElement;
import com.google.gson.JsonParser;
import com.optimizely.ab.Optimizely;
import com.optimizely.ab.android.event_handler.DefaultEventHandler;
import com.optimizely.ab.bucketing.Bucketer;
import com.optimizely.ab.bucketing.DecisionService;
import com.optimizely.ab.config.Experiment;
import com.optimizely.ab.config.ProjectConfig;
import com.optimizely.ab.config.Variation;
import com.optimizely.ab.config.parser.JsonParseException;
import com.optimizely.ab.event.EventHandler;
import com.optimizely.ab.event.LogEvent;
import com.optimizely.ab.internal.ReservedEventKey;
Expand All @@ -37,6 +41,7 @@
import com.optimizely.ab.notification.TrackNotification;
import com.optimizely.ab.notification.TrackNotificationListener;
import com.optimizely.ab.optimizelyconfig.OptimizelyConfig;
import com.optimizely.ab.optimizelyjson.OptimizelyJSON;

import org.junit.Assert;
import org.junit.Test;
Expand Down Expand Up @@ -105,6 +110,7 @@ public static Collection<Object[]> data() throws IOException {
private final static String INTEGER_VARIABLE_KEY = "integer_variable";
private final static String STRING_FEATURE_KEY = "multi_variate_feature";
private final static String STRING_VARIABLE_KEY = "first_letter";
private final static String JSON_VARIABLE_KEY = "json_patched";
private static final String GENERIC_USER_ID = "userId";
private String testProjectId = "7595190003";
private int datafileVersion;
Expand Down Expand Up @@ -1764,6 +1770,239 @@ public void testBadGetFeatureVariableString() {
);
}

/*
* FeatureVariableJSON
* Scenario#1 Without attributes in which user
* was not bucketed into any variation for feature flag will return default value which is
* '{"k1":"v1","k2":3.5,"k3":true,"k4":{"kk1":"vv1","kk2":false}}' in config
*/
@Test
public void testGetFeatureVariableJSONWithoutAttr() {
assumeTrue(datafileVersion == Integer.parseInt(ProjectConfig.Version.V4.toString()));

OptimizelyClient optimizelyClient = new OptimizelyClient(
optimizely,
logger
);
String defaultValueOfStringVar = "{\"k1\":\"v1\",\"k2\":3.5,\"k3\":true,\"k4\":{\"kk1\":\"vv1\",\"kk2\":false}}";

OptimizelyJSON json = optimizelyClient.getFeatureVariableJSON(
STRING_FEATURE_KEY,
JSON_VARIABLE_KEY,
GENERIC_USER_ID
);

assertTrue(compareJsonStrings(json.toString(), defaultValueOfStringVar));
}

//FeatureVariableJSON Scenario#2 with attributes
@Test
public void testGetFeatureVariableJsonWithAttr() {
assumeTrue(datafileVersion == Integer.parseInt(ProjectConfig.Version.V4.toString()));

OptimizelyClient optimizelyClient = new OptimizelyClient(
optimizely,
logger);


String defaultValueOfStringVar = "{\"k1\":\"s1\",\"k2\":103.5,\"k3\":false,\"k4\":{\"kk1\":\"ss1\",\"kk2\":true}}";

OptimizelyJSON json = optimizelyClient.getFeatureVariableJSON(
STRING_FEATURE_KEY,
JSON_VARIABLE_KEY,
GENERIC_USER_ID,
Collections.singletonMap("house", "Gryffindor")
);

assertTrue(compareJsonStrings(json.toString(), defaultValueOfStringVar));
verifyZeroInteractions(logger);
}

//FeatureVariableJSON Scenario#3 if feature not found
@Test
public void testGetFeatureVariableJsonInvalidFeatureKey() {
assumeTrue(datafileVersion == Integer.parseInt(ProjectConfig.Version.V4.toString()));

OptimizelyClient optimizelyClient = new OptimizelyClient(
optimizely,
logger);

assertNull(optimizelyClient.getFeatureVariableJSON(
"invalidFeatureKey",
"invalidVariableKey",
GENERIC_USER_ID
));
}

//FeatureVariableJSON Scenario#4 if variable not found
@Test
public void testGetFeatureVariableJsonInvalidVariableKey() {
assumeTrue(datafileVersion == Integer.parseInt(ProjectConfig.Version.V4.toString()));

OptimizelyClient optimizelyClient = new OptimizelyClient(
optimizely,
logger
);

//Scenario#4 if variable not found
assertNull(optimizelyClient.getFeatureVariableJSON(
STRING_FEATURE_KEY,
"invalidVariableKey",
GENERIC_USER_ID
));
}

@Test
public void testBadGetFeatureVariableJson() {
OptimizelyClient optimizelyClient = new OptimizelyClient(null, logger);

//Scenario#1 without attributes
assertNull(optimizelyClient.getFeatureVariableJSON(
STRING_FEATURE_KEY,
JSON_VARIABLE_KEY,
GENERIC_USER_ID
));

verify(logger).warn("Optimizely is not initialized, could not get feature {} variable {} JSON for user {}.",
STRING_FEATURE_KEY,
JSON_VARIABLE_KEY,
GENERIC_USER_ID
);

//Scenario#2 with attributes
assertNull(optimizelyClient.getFeatureVariableJSON(
STRING_FEATURE_KEY,
JSON_VARIABLE_KEY,
GENERIC_USER_ID,
Collections.EMPTY_MAP
));

verify(logger).warn("Optimizely is not initialized, could not get feature {} variable {} JSON for user {} with attributes.",
STRING_FEATURE_KEY,
JSON_VARIABLE_KEY,
GENERIC_USER_ID
);
}

/*
* getAllFeatureVariables
* Scenario#1 Without attributes in which user
* was not bucketed into any variation for feature flag will return default value which is
* '{"first_letter":"H","json_patched":{"k1":"v1","k2":3.5,"k3":true,"k4":{"kk1":"vv1","kk2":false}},"rest_of_name":"arry"}' in config
*/
@Test
public void testGetAllFeatureVariablesWithoutAttr() {
assumeTrue(datafileVersion == Integer.parseInt(ProjectConfig.Version.V4.toString()));

OptimizelyClient optimizelyClient = new OptimizelyClient(
optimizely,
logger
);
String defaultValueOfStringVar = "{\"first_letter\":\"H\",\"json_patched\":{\"k1\":\"v1\",\"k2\":3.5,\"k3\":true,\"k4\":{\"kk1\":\"vv1\",\"kk2\":false}},\"rest_of_name\":\"arry\"}";

OptimizelyJSON json = optimizelyClient.getAllFeatureVariables(
STRING_FEATURE_KEY,
GENERIC_USER_ID
);

assertTrue(compareJsonStrings(json.toString(), defaultValueOfStringVar));
}

//GetAllFeatureVariables Scenario#2 with attributes
@Test
public void testGetAllFeatureVariablesWithAttr() {
assumeTrue(datafileVersion == Integer.parseInt(ProjectConfig.Version.V4.toString()));

OptimizelyClient optimizelyClient = new OptimizelyClient(
optimizely,
logger);


String defaultValueOfStringVar = "{\"first_letter\":\"F\",\"json_patched\":{\"k1\":\"s1\",\"k2\":103.5,\"k3\":false,\"k4\":{\"kk1\":\"ss1\",\"kk2\":true}},\"rest_of_name\":\"eorge\"}";

OptimizelyJSON json = optimizelyClient.getAllFeatureVariables(
STRING_FEATURE_KEY,
GENERIC_USER_ID,
Collections.singletonMap("house", "Gryffindor")
);

assertTrue(compareJsonStrings(json.toString(), defaultValueOfStringVar));
verifyZeroInteractions(logger);
}

//GetAllFeatureVariables Scenario#3 if feature not found
@Test
public void testGetAllFeatureVariablesInvalidFeatureKey() {
assumeTrue(datafileVersion == Integer.parseInt(ProjectConfig.Version.V4.toString()));

OptimizelyClient optimizelyClient = new OptimizelyClient(
optimizely,
logger);

assertNull(optimizelyClient.getAllFeatureVariables(
"invalidFeatureKey",
GENERIC_USER_ID
));
}

@Test
public void testBadGetAllFeatureVariables() {
OptimizelyClient optimizelyClient = new OptimizelyClient(null, logger);

//Scenario#1 without attributes
assertNull(optimizelyClient.getAllFeatureVariables(
STRING_FEATURE_KEY,
GENERIC_USER_ID
));

verify(logger).warn("Optimizely is not initialized, could not get feature {} all feature variables for user {}.",
STRING_FEATURE_KEY,
GENERIC_USER_ID
);

//Scenario#2 with attributes
assertNull(optimizelyClient.getAllFeatureVariables(
STRING_FEATURE_KEY,
GENERIC_USER_ID,
Collections.EMPTY_MAP
));

verify(logger).warn("Optimizely is not initialized, could not get feature {} all feature variables for user {} with attributes.",
STRING_FEATURE_KEY,
GENERIC_USER_ID
);
}

// Accessibility testing of OptimizelyJSON.getValue
@Test
public void testGetValueOfOptimizelyJson() {
assumeTrue(datafileVersion == Integer.parseInt(ProjectConfig.Version.V4.toString()));

Map<String, Object> expectedMap = new HashMap<>();
expectedMap.put("kk1", "vv1");
expectedMap.put("kk2", false);

OptimizelyClient optimizelyClient = new OptimizelyClient(
optimizely,
logger
);

OptimizelyJSON optimizelyJSON = optimizelyClient.getAllFeatureVariables(
STRING_FEATURE_KEY,
GENERIC_USER_ID
);

try {
assertEquals(optimizelyJSON.getValue("first_letter", String.class), "H");
assertEquals(optimizelyJSON.getValue("json_patched.k4", Map.class), expectedMap);

// When given jsonKey does not exist
assertNull(optimizelyJSON.getValue("json_patched.k5", String.class));
} catch (JsonParseException e) {
e.printStackTrace();
}
}

@Test
public void testGetOptimizelyConfig() {
assumeTrue(datafileVersion == Integer.parseInt(ProjectConfig.Version.V4.toString()));
Expand Down Expand Up @@ -1860,4 +2099,16 @@ public void handle(DecisionNotification decisionNotification) {
assertTrue(optimizelyClient.getNotificationCenter().removeNotificationListener(notificationId));
assertFalse(optimizelyClient.getNotificationCenter().removeNotificationListener(notificationId2));
}

private boolean compareJsonStrings(String str1, String str2) {
JsonParser parser = new JsonParser();

JsonElement j1 = parser.parse(str1);
JsonElement j2 = parser.parse(str2);
return j1.equals(j2);
}

private Map parseJsonString(String str) {
return new Gson().fromJson(str, Map.class);
}
}
15 changes: 12 additions & 3 deletions android-sdk/src/debug/res/raw/validprojectconfigv4
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,10 +169,13 @@
}, {
"id": "4111654444",
"value": "3.14"
}, {
}, {
"id": "593964691",
"value": "2"
}]
}, {
"id": "4111661000",
"value": "{\"k1\":\"s1\",\"k2\":103.5,\"k3\":false,\"k4\":{\"kk1\":\"ss1\",\"kk2\":true}}"
}]
}, {
"id": "4204375027",
"key": "Gred",
Expand Down Expand Up @@ -477,7 +480,13 @@
"key": "rest_of_name",
"type": "string",
"defaultValue": "arry"
}]
}, {
"id": "4111661000",
"key": "json_patched",
"type": "string",
"subType": "json",
"defaultValue": "{\"k1\":\"v1\",\"k2\":3.5,\"k3\":true,\"k4\":{\"kk1\":\"vv1\",\"kk2\":false}}"
}]
}, {
"id": "3263342226",
"key": "mutex_group_feature",
Expand Down
Loading