Release version 2.3.0 (#37)

* Support for enhanced feature streams, facilitating reduced SDK initialization times.

Author: arun251

CHANGELOG.md

@@ -3,6 +3,10 @@
 
 All notable changes to the LaunchDarkly Android SDK will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org).
 
+## [2.3.0] - 2018-03-21
+### Added
+- Support for enhanced feature streams, facilitating reduced SDK initialization times.
+
 ## [2.2.1] - 2018-03-11
 ### Changed
 - The minimum polling interval is now 5 minutes, and the default event publishing interval is 30 seconds.

README.md

@@ -8,7 +8,7 @@ Check out the included example app, or follow things here:
 1. Declare this dependency:
 
 	```
-	compile 'com.launchdarkly:launchdarkly-android-client:2.2.1'
+	compile 'com.launchdarkly:launchdarkly-android-client:2.3.0'
 	```  
 1. In your application configure and initialize the client:
 

build.gradle

@@ -4,7 +4,7 @@ buildscript {
     repositories {
         jcenter()
         mavenCentral()
-        maven { url 'https://maven.google.com'}
+        google()
     }
     dependencies {
         classpath 'com.android.tools.build:gradle:3.0.1'
@@ -22,7 +22,7 @@ allprojects {
     repositories {
         jcenter()
         mavenCentral()
-        maven { url 'https://maven.google.com'}
+        google()
     }
 }
 
@@ -40,4 +40,4 @@ subprojects {
             project.android.dexOptions.preDexLibraries = rootProject.ext.preDexLibs
         }
     }
-}
+}

example/build.gradle

@@ -6,6 +6,7 @@ repositories {
     mavenLocal()
     // Before LaunchDarkly release artifacts get synced to Maven Central they are here along with snapshots:
     maven { url "https://oss.sonatype.org/content/groups/public/" }
+    google()
     mavenCentral()
 }
 

gradle/wrapper/gradle-wrapper.properties

@@ -1,4 +1,4 @@
-#Mon Jan 08 12:00:13 PST 2018
+#Thu Jan 11 09:20:17 PST 2018
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME

launchdarkly-android-client/build.gradle

@@ -2,13 +2,12 @@ apply plugin: 'com.android.library'
 apply plugin: 'com.github.dcendents.android-maven'
 apply plugin: 'signing'
 apply plugin: 'org.ajoberstar.github-pages'
-// make sure this line comes *after* you apply the Android plugin
 apply plugin: 'com.getkeepsafe.dexcount'
 apply plugin: 'io.codearte.nexus-staging'
 
 allprojects {
     group = 'com.launchdarkly'
-    version = '2.2.1'
+    version = '2.3.0'
     sourceCompatibility = 1.7
     targetCompatibility = 1.7
 }
@@ -59,7 +58,7 @@ android {
 ext {
     supportVersion = "26.0.1"
     okhttpVersion = "3.6.0"
-    eventsourceVersion = "1.5.3"
+    eventsourceVersion = "1.7.0"
     gsonVersion = "2.8.2"
     testRunnerVersion = "0.5"
 }
@@ -72,6 +71,7 @@ dependencies {
     implementation "com.google.code.gson:gson:$gsonVersion"
     implementation "com.launchdarkly:okhttp-eventsource:$eventsourceVersion"
     implementation "com.squareup.okhttp3:okhttp:$okhttpVersion"
+    implementation 'com.jakewharton.timber:timber:4.6.0'
 
     androidTestImplementation "com.android.support:appcompat-v7:$supportVersion"
     androidTestImplementation "com.android.support:support-annotations:$supportVersion"
@@ -92,13 +92,15 @@ repositories {
     // Before LaunchDarkly release artifacts get synced to Maven Central they are here along with snapshots:
     maven { url "https://oss.sonatype.org/content/groups/public/" }
     mavenCentral()
+    google()
 }
 
 buildscript {
     repositories {
         jcenter()
         mavenCentral()
         mavenLocal()
+        google()
     }
     dependencies {
         classpath 'org.ajoberstar:gradle-git:1.5.0-rc.1'

launchdarkly-android-client/src/androidTest/java/com/launchdarkly/android/UserManagerTest.java

@@ -26,8 +26,8 @@
 
 import static com.google.common.util.concurrent.Futures.immediateFailedFuture;
 import static junit.framework.Assert.assertEquals;
-import static junit.framework.Assert.assertNotNull;
 import static junit.framework.Assert.assertFalse;
+import static junit.framework.Assert.assertNotNull;
 import static junit.framework.Assert.assertTrue;
 import static org.easymock.EasyMock.expect;
 import static org.easymock.EasyMock.reset;
@@ -42,6 +42,7 @@ public class UserManagerTest extends EasyMockSupport {
     @Rule
     public EasyMockRule easyMockRule = new EasyMockRule(this);
 
+    @SuppressWarnings("unused")
     @Mock
     private FeatureFlagFetcher fetcher;
 
@@ -60,18 +61,17 @@ public void TestFailedFetchThrowsException() throws InterruptedException {
     @Test
     public void TestBasicRetrieval() throws ExecutionException, InterruptedException {
         String expectedStringFlagValue = "string1";
-        boolean expectedBoolFlagValue = true;
 
         JsonObject jsonObject = new JsonObject();
-        jsonObject.addProperty("boolFlag1", expectedBoolFlagValue);
+        jsonObject.addProperty("boolFlag1", true);
         jsonObject.addProperty("stringFlag1", expectedStringFlagValue);
 
         Future<Void> future = setUser("userKey", jsonObject);
         future.get();
 
         SharedPreferences sharedPrefs = userManager.getCurrentUserSharedPrefs();
         assertEquals(2, sharedPrefs.getAll().size());
-        assertEquals(expectedBoolFlagValue, sharedPrefs.getBoolean("boolFlag1", false));
+        assertEquals(true, sharedPrefs.getBoolean("boolFlag1", false));
         assertEquals(expectedStringFlagValue, sharedPrefs.getString("stringFlag1", ""));
     }
 
@@ -151,6 +151,216 @@ public void onFeatureFlagChange(String flagKey) {
         assertTrue(listeners.isEmpty());
     }
 
+    @Test
+    public void TestDeleteFlag() throws ExecutionException, InterruptedException {
+        userManager.clearVersionSharedPreferences();
+
+        String expectedStringFlagValue = "string1";
+
+        JsonObject jsonObject = new JsonObject();
+        jsonObject.addProperty("boolFlag1", true);
+        jsonObject.addProperty("stringFlag1", expectedStringFlagValue);
+
+        Future<Void> future = setUser("userKey", jsonObject);
+        future.get();
+
+        SharedPreferences sharedPrefs = userManager.getCurrentUserSharedPrefs();
+        assertEquals(2, sharedPrefs.getAll().size());
+        assertEquals(true, sharedPrefs.getBoolean("boolFlag1", false));
+        assertEquals(expectedStringFlagValue, sharedPrefs.getString("stringFlag1", ""));
+
+        userManager.deleteCurrentUserFlag("{\"key\":\"stringFlag1\",\"version\":16}").get();
+        assertEquals("", sharedPrefs.getString("stringFlag1", ""));
+        assertEquals(true, sharedPrefs.getBoolean("boolFlag1", false));
+
+        userManager.deleteCurrentUserFlag("{\"key\":\"nonExistentFlag\",\"version\":16,\"value\":false}").get();
+    }
+
+    @Test
+    public void TestDeleteForInvalidResponse() throws ExecutionException, InterruptedException {
+        String expectedStringFlagValue = "string1";
+
+        JsonObject jsonObject = new JsonObject();
+        jsonObject.addProperty("boolFlag1", true);
+        jsonObject.addProperty("stringFlag1", expectedStringFlagValue);
+
+        Future<Void> future = setUser("userKey", jsonObject);
+        future.get();
+
+        userManager.deleteCurrentUserFlag("{}").get();
+
+        //noinspection ConstantConditions
+        userManager.deleteCurrentUserFlag(null).get();
+
+        userManager.deleteCurrentUserFlag("abcd").get();
+    }
+
+    @Test
+    public void TestDeleteWithVersion() throws ExecutionException, InterruptedException {
+        userManager.clearVersionSharedPreferences();
+
+        Future<Void> future = setUser("userKey", new JsonObject());
+        future.get();
+
+        String json = "{\n" +
+                "  \"stringFlag1\": {\n" +
+                "    \"key\": \"\",\n" +
+                "    \"version\": 125,\n" +
+                "    \"value\": \"string1\"\n" +
+                "  }\n" +
+                " }";
+
+        userManager.putCurrentUserFlags(json).get();
+
+        userManager.deleteCurrentUserFlag("{\"key\":\"stringFlag1\",\"version\":16}").get();
+        SharedPreferences sharedPrefs = userManager.getCurrentUserSharedPrefs();
+        assertEquals("string1", sharedPrefs.getString("stringFlag1", ""));
+
+        userManager.deleteCurrentUserFlag("{\"key\":\"stringFlag1\",\"version\":127}").get();
+        assertEquals("", sharedPrefs.getString("stringFlag1", ""));
+
+        userManager.deleteCurrentUserFlag("{\"key\":\"nonExistent\",\"version\":1}").get();
+    }
+
+    @Test
+    public void TestPatchForAddAndReplaceFlags() throws ExecutionException, InterruptedException {
+        userManager.clearVersionSharedPreferences();
+
+        JsonObject jsonObject = new JsonObject();
+        jsonObject.addProperty("boolFlag1", true);
+        jsonObject.addProperty("stringFlag1", "string1");
+        jsonObject.addProperty("floatFlag1", 3.0f);
+
+        Future<Void> future = setUser("userKey", jsonObject);
+        future.get();
+
+        userManager.patchCurrentUserFlags("{\"key\":\"new-flag\",\"version\":16,\"value\":false}").get();
+
+        SharedPreferences sharedPrefs = userManager.getCurrentUserSharedPrefs();
+        assertEquals(false, sharedPrefs.getBoolean("new-flag", true));
+
+
+        userManager.patchCurrentUserFlags("{\"key\":\"stringFlag1\",\"version\":16,\"value\":\"string2\"}").get();
+        assertEquals("string2", sharedPrefs.getString("stringFlag1", ""));
+
+        userManager.patchCurrentUserFlags("{\"key\":\"boolFlag1\",\"version\":16,\"value\":false}").get();
+        assertEquals(false, sharedPrefs.getBoolean("boolFlag1", false));
+
+        assertEquals(3.0f, sharedPrefs.getFloat("floatFlag1", Float.MIN_VALUE));
+
+        userManager.patchCurrentUserFlags("{\"key\":\"floatFlag2\",\"version\":16,\"value\":8.0}").get();
+        assertEquals(8.0f, sharedPrefs.getFloat("floatFlag2", Float.MIN_VALUE));
+    }
+
+    @Test
+    public void TestPatchWithVersion() throws ExecutionException, InterruptedException {
+        userManager.clearVersionSharedPreferences();
+
+        Future<Void> future = setUser("userKey", new JsonObject());
+        future.get();
+
+        String json = "{\n" +
+                "  \"stringFlag1\": {\n" +
+                "    \"key\": \"\",\n" +
+                "    \"version\": 125,\n" +
+                "    \"value\": \"string1\"\n" +
+                "  }\n" +
+                " }";
+
+        userManager.putCurrentUserFlags(json).get();
+
+
+        userManager.patchCurrentUserFlags("{\"key\":\"stringFlag1\",\"version\":16,\"value\":\"string2\"}").get();
+        SharedPreferences sharedPrefs = userManager.getCurrentUserSharedPrefs();
+        assertEquals("string1", sharedPrefs.getString("stringFlag1", ""));
+
+        userManager.patchCurrentUserFlags("{\"key\":\"stringFlag1\",\"version\":126,\"value\":\"string2\"}").get();
+        assertEquals("string2", sharedPrefs.getString("stringFlag1", ""));
+
+        userManager.patchCurrentUserFlags("{\"key\":\"stringFlag20\",\"version\":1,\"value\":\"stringValue\"}").get();
+        assertEquals("stringValue", sharedPrefs.getString("stringFlag20", ""));
+    }
+
+    @Test
+    public void TestPatchForInvalidResponse() throws ExecutionException, InterruptedException {
+        String expectedStringFlagValue = "string1";
+
+        JsonObject jsonObject = new JsonObject();
+        jsonObject.addProperty("boolFlag1", true);
+        jsonObject.addProperty("stringFlag1", expectedStringFlagValue);
+
+        Future<Void> future = setUser("userKey", jsonObject);
+        future.get();
+
+        userManager.patchCurrentUserFlags("{}").get();
+
+        //noinspection ConstantConditions
+        userManager.patchCurrentUserFlags(null).get();
+
+        userManager.patchCurrentUserFlags("abcd").get();
+    }
+
+    @Test
+    public void TestPutForReplaceFlags() throws ExecutionException, InterruptedException {
+
+        JsonObject jsonObject = new JsonObject();
+        jsonObject.addProperty("stringFlag1", "string1");
+        jsonObject.addProperty("boolFlag1", true);
+        jsonObject.addProperty("floatFlag1", 3.0f);
+
+        Future<Void> future = setUser("userKey", jsonObject);
+        future.get();
+
+        String json = "{\n" +
+                "  \"stringFlag1\": {\n" +
+                "    \"key\": \"\",\n" +
+                "    \"version\": 125,\n" +
+                "    \"value\": \"string2\"\n" +
+                "  },\n" +
+                "  \"boolFlag1\": {\n" +
+                "    \"key\": \"\",\n" +
+                "    \"version\": 2,\n" +
+                "    \"value\": false\n" +
+                "  },\n" +
+                "  \"floatFlag2\": {\n" +
+                "    \"key\": \"\",\n" +
+                "    \"version\": 3,\n" +
+                "    \"value\": 8.0\n" +
+                "  }\n" +
+                " }";
+
+        userManager.putCurrentUserFlags(json).get();
+
+        SharedPreferences sharedPrefs = userManager.getCurrentUserSharedPrefs();
+
+        assertEquals("string2", sharedPrefs.getString("stringFlag1", ""));
+        assertEquals(false, sharedPrefs.getBoolean("boolFlag1", false));
+
+        // Should have value Float.MIN_VALUE instead of 3.0f which was deleted by PUT.
+        assertEquals(Float.MIN_VALUE, sharedPrefs.getFloat("floatFlag1", Float.MIN_VALUE));
+
+        assertEquals(8.0f, sharedPrefs.getFloat("floatFlag2", 1.0f));
+    }
+
+    @Test
+    public void TestPutForInvalidResponse() throws ExecutionException, InterruptedException {
+        String expectedStringFlagValue = "string1";
+
+        JsonObject jsonObject = new JsonObject();
+        jsonObject.addProperty("boolFlag1", true);
+        jsonObject.addProperty("stringFlag1", expectedStringFlagValue);
+
+        Future<Void> future = setUser("userKey", jsonObject);
+        future.get();
+
+        userManager.putCurrentUserFlags("{}").get();
+
+        //noinspection ConstantConditions
+        userManager.putCurrentUserFlags(null).get();
+
+        userManager.putCurrentUserFlags("abcd").get();
+    }
+
     private Future<Void> setUser(String userKey, JsonObject flags) {
         LDUser user = new LDUser.Builder(userKey).build();
         ListenableFuture<JsonObject> jsonObjectFuture = Futures.immediateFuture(flags);
@@ -184,4 +394,5 @@ private void assertFlagValue(String flagKey, Object expectedValue) {
         SharedPreferences sharedPrefs = userManager.getCurrentUserSharedPrefs();
         assertEquals(expectedValue, sharedPrefs.getAll().get(flagKey));
     }
-}
+
+}