Version 2.5.4 (#59)

arun251 · arun251 · commit 196a896eff77 · 2018-10-25T14:46:59.000-07:00
* Polling for flag updates might block the main thread
* Outbound HTTP requests now have an authentication scheme token in Authorization request headers
* Refactored map synchronization to avoid crashes in apps build with Gradle 3.3.0-alpha11
* Restored support for network connectivity detection in Android 7.0+ devices
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -0,0 +1,68 @@
+version: 2
+jobs:
+  build:
+    working_directory: ~/launchdarkly/android-client-private
+    docker:
+      - image: circleci/android:api-27-alpha
+    environment:
+      JVM_OPTS: -Xmx3200m
+      CIRCLE_ARTIFACTS: /tmp/circleci-artifacts
+      CIRCLE_TEST_REPORTS: /tmp/circleci-test-results
+
+    steps:
+      - checkout
+      - restore_cache:
+          keys:
+            # This branch if available
+              - v1-dep-{{ .Branch }}-
+            # Default branch if not
+              - v1-dep-master-
+                    # Any branch if there are none on the default branch - this should be unnecessary if you have your default branch configured correctly
+              - v1-dep-
+
+      - run:
+          name: Download Dependencies
+          command: ./gradlew androidDependencies
+      - run: sudo mkdir -p $CIRCLE_TEST_REPORTS
+      - run: sudo apt-get -y -qq install awscli
+      - run: sudo mkdir -p /usr/local/android-sdk-linux/licenses
+
+      - save_cache:
+              key: v1-dep-{{ .Branch }}-{{ epoch }}
+              paths:
+              # This is a broad list of cache paths to include many possible development environments
+              # You can probably delete some of these entries
+              - vendor/bundle
+              - ~/virtualenvs
+              - ~/.m2
+              - ~/.ivy2
+              - ~/.bundle
+              - ~/.go_workspace
+              - ~/.gradle
+              - ~/.cache/bower
+              # These cache paths were specified in the 1.0 config
+              - /usr/local/android-sdk-linux/platforms/android-26
+              - /usr/local/android-sdk-linux/build-tools/26.0.2
+              - /usr/local/android-sdk-linux/platforms/android-27
+              - /usr/local/android-sdk-linux/build-tools/27.0.3
+              - /usr/local/android-sdk-linux/extras/android/m2repository
+      - run: unset ANDROID_NDK_HOME
+
+      - run: ./gradlew :launchdarkly-android-client:assembleDebug --console=plain -PdisablePreDex
+      - run: ./gradlew :launchdarkly-android-client:test --console=plain -PdisablePreDex
+
+      - run: ./gradlew packageRelease --console=plain -PdisablePreDex
+      - run:
+          name: Run Tests
+          command: ./gradlew test
+
+      - run:
+          name: Save test results
+          command: |
+                mkdir -p ~/tests/test-results
+                find . -type f -regex ".*/build/test-results/.*xml" -exec cp {} ~/tests/test-results/ \;
+          when: always
+      - store_test_results:
+            path: ~/tests
+      - store_artifacts:
+            path: ~/tests
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,15 @@
 
 All notable changes to the LaunchDarkly Android SDK will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org).
 
+## [2.5.4] - 2018-10-25
+### Changed
+- Outbound HTTP requests now have an authentication scheme token in `Authorization` request headers
+
+### Fixed
+- Polling for flag updates might block the main thread
+- Refactored map synchronization to avoid crashes in apps build with Gradle 3.3.0-alpha11
+- Restored support for network connectivity detection in Android 7.0+ devices
+
 ## [2.5.3] - 2018-09-27
 ### Fixed
 - Restored support for initializing `LDClient` on non-main threads
diff --git a/README.md b/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.5.3'
+	compile 'com.launchdarkly:launchdarkly-android-client:2.5.4'
 	```  
 1. In your application configure and initialize the client:
 
diff --git a/build.gradle b/build.gradle
@@ -2,9 +2,9 @@
 
 buildscript {
     repositories {
-        jcenter()
         mavenCentral()
         google()
+        jcenter()
     }
     dependencies {
         classpath 'com.android.tools.build:gradle:3.0.1'
@@ -20,9 +20,9 @@ buildscript {
 
 allprojects {
     repositories {
-        jcenter()
         mavenCentral()
         google()
+        jcenter()
     }
 }
 
@@ -40,4 +40,4 @@ subprojects {
             project.android.dexOptions.preDexLibraries = rootProject.ext.preDexLibs
         }
     }
-}
+}
diff --git a/launchdarkly-android-client/build.gradle b/launchdarkly-android-client/build.gradle
@@ -7,7 +7,7 @@ apply plugin: 'io.codearte.nexus-staging'
 
 allprojects {
     group = 'com.launchdarkly'
-    version = '2.5.3'
+    version = '2.5.4'
     sourceCompatibility = 1.7
     targetCompatibility = 1.7
 }
@@ -96,10 +96,10 @@ repositories {
 
 buildscript {
     repositories {
-        jcenter()
         mavenCentral()
         mavenLocal()
         google()
+        jcenter()
     }
     dependencies {
         classpath 'org.ajoberstar:gradle-git:1.5.0-rc.1'
diff --git a/launchdarkly-android-client/src/main/java/com/launchdarkly/android/ConnectivityReceiver.java b/launchdarkly-android-client/src/main/java/com/launchdarkly/android/ConnectivityReceiver.java
@@ -10,6 +10,8 @@
 
 public class ConnectivityReceiver extends BroadcastReceiver {
 
+    static final String CONNECTIVITY_CHANGE = "android.net.conn.CONNECTIVITY_CHANGE";
+
     @Override
     public void onReceive(Context context, Intent intent) {
         if (isInternetConnected(context)) {
diff --git a/launchdarkly-android-client/src/main/java/com/launchdarkly/android/LDClient.java b/launchdarkly-android-client/src/main/java/com/launchdarkly/android/LDClient.java
@@ -2,7 +2,9 @@
 
 import android.app.Application;
 import android.content.Context;
+import android.content.IntentFilter;
 import android.content.SharedPreferences;
+import android.os.Build;
 import android.support.annotation.NonNull;
 
 import com.google.common.annotations.VisibleForTesting;
@@ -55,6 +57,7 @@ public class LDClient implements LDClientInterface, Closeable {
     private final UpdateProcessor updateProcessor;
     private final FeatureFlagFetcher fetcher;
     private final Throttler throttler;
+    private ConnectivityReceiver connectivityReceiver;
 
     private volatile boolean isOffline = false;
     private volatile boolean isAppForegrounded = true;
@@ -226,6 +229,12 @@ public void run() {
                 setOnlineStatus();
             }
         }, RETRY_TIME_MS, MAX_RETRY_TIME_MS);
+
+        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.N) {
+            connectivityReceiver = new ConnectivityReceiver();
+            IntentFilter filter = new IntentFilter(ConnectivityReceiver.CONNECTIVITY_CHANGE);
+            application.registerReceiver(connectivityReceiver, filter);
+        }
     }
 
     /**
@@ -518,6 +527,9 @@ public JsonElement jsonVariation(String flagKey, JsonElement fallback) {
     public void close() throws IOException {
         updateProcessor.stop();
         eventProcessor.close();
+        if (connectivityReceiver != null && application.get() != null) {
+            application.get().unregisterReceiver(connectivityReceiver);
+        }
     }
 
     /**
diff --git a/launchdarkly-android-client/src/main/java/com/launchdarkly/android/LDConfig.java b/launchdarkly-android-client/src/main/java/com/launchdarkly/android/LDConfig.java
@@ -17,6 +17,7 @@ public class LDConfig {
 
     static final String SHARED_PREFS_BASE_KEY = "LaunchDarkly-";
     static final String USER_AGENT_HEADER_VALUE = "AndroidClient/" + BuildConfig.VERSION_NAME;
+    static final String AUTH_SCHEME = "api_key ";
     static final MediaType JSON = MediaType.parse("application/json; charset=utf-8");
     static final Gson GSON = new GsonBuilder().excludeFieldsWithoutExposeAnnotation().create();
 
@@ -98,7 +99,7 @@ public LDConfig(String mobileKey,
 
     public Request.Builder getRequestBuilder() {
         return new Request.Builder()
-                .addHeader("Authorization", mobileKey)
+                .addHeader("Authorization", LDConfig.AUTH_SCHEME + mobileKey)
                 .addHeader("User-Agent", USER_AGENT_HEADER_VALUE);
     }
 
diff --git a/launchdarkly-android-client/src/main/java/com/launchdarkly/android/PollingUpdater.java b/launchdarkly-android-client/src/main/java/com/launchdarkly/android/PollingUpdater.java
@@ -31,14 +31,10 @@ public void onReceive(Context context, Intent intent) {
                     Timber.e("UserManager singleton was accessed before it was initialized! doing nothing");
                     return;
                 }
-                userManager.updateCurrentUser().get(15, TimeUnit.SECONDS);
+                userManager.updateCurrentUser();
             } else {
                 Timber.d("onReceive with no internet connection! Skipping fetch.");
             }
-        } catch (InterruptedException | ExecutionException e) {
-            Timber.e(e, "Exception caught when awaiting update");
-        } catch (TimeoutException e) {
-            Timber.e(e, "Feature Flag update timed out");
         } catch (LaunchDarklyException e) {
             Timber.e(e, "Exception when getting client");
         }
diff --git a/launchdarkly-android-client/src/main/java/com/launchdarkly/android/StreamUpdateProcessor.java b/launchdarkly-android-client/src/main/java/com/launchdarkly/android/StreamUpdateProcessor.java
@@ -58,7 +58,7 @@ public synchronized ListenableFuture<Void> start() {
             stop();
             Timber.d("Starting.");
             Headers headers = new Headers.Builder()
-                    .add("Authorization", config.getMobileKey())
+                    .add("Authorization", LDConfig.AUTH_SCHEME + config.getMobileKey())
                     .add("User-Agent", LDConfig.USER_AGENT_HEADER_VALUE)
                     .add("Accept", "text/event-stream")
                     .build();
diff --git a/launchdarkly-android-client/src/main/java/com/launchdarkly/android/UserLocalSharePreferences.java b/launchdarkly-android-client/src/main/java/com/launchdarkly/android/UserLocalSharePreferences.java
@@ -8,6 +8,7 @@
 
 import com.google.common.collect.HashMultimap;
 import com.google.common.collect.Multimap;
+import com.google.common.collect.Multimaps;
 
 import java.io.File;
 import java.util.Collection;
@@ -36,17 +37,17 @@ class UserLocalSharedPreferences {
 
     private final Application application;
     // Maintains references enabling (de)registration of listeners for realtime updates
-    private final Multimap<String, Pair<FeatureFlagChangeListener, SharedPreferences.OnSharedPreferenceChangeListener>> listeners = HashMultimap.create();
+    private final Multimap<String, Pair<FeatureFlagChangeListener, SharedPreferences.OnSharedPreferenceChangeListener>> listeners;
 
     // The current user- we'll always fetch this user from the response we get from the api
     private SharedPreferences currentUserSharedPrefs;
 
     UserLocalSharedPreferences(Application application) {
         this.application = application;
-
         this.usersSharedPrefs = application.getSharedPreferences(LDConfig.SHARED_PREFS_BASE_KEY + "users", Context.MODE_PRIVATE);
         this.activeUserSharedPrefs = loadSharedPrefsForActiveUser();
-
+        HashMultimap<String, Pair<FeatureFlagChangeListener, SharedPreferences.OnSharedPreferenceChangeListener>> multimap = HashMultimap.create();
+        listeners = Multimaps.synchronizedMultimap(multimap);
     }
 
     SharedPreferences getCurrentUserSharedPrefs() {
@@ -137,7 +138,9 @@ private SharedPreferences loadSharedPrefsForActiveUser() {
     }
 
     Collection<Pair<FeatureFlagChangeListener, SharedPreferences.OnSharedPreferenceChangeListener>> getListener(String key) {
-        return listeners.get(key);
+        synchronized (listeners) {
+            return listeners.get(key);
+        }
     }
 
     void registerListener(final String key, final FeatureFlagChangeListener listener) {
@@ -152,9 +155,9 @@ public void onSharedPreferenceChanged(SharedPreferences sharedPreferences, Strin
         };
         synchronized (listeners) {
             listeners.put(key, new Pair<>(listener, sharedPrefsListener));
+            Timber.d("Added listener. Total count: [" + listeners.size() + "]");
         }
         activeUserSharedPrefs.registerOnSharedPreferenceChangeListener(sharedPrefsListener);
-        Timber.d("Added listener. Total count: [" + listeners.size() + "]");
 
     }
 
diff --git a/scripts/release.sh b/scripts/release.sh
@@ -21,6 +21,7 @@ rm -f launchdarkly-android-client/build.gradle.bak
 sed -i.bak "s/com.launchdarkly:launchdarkly-android-client:[^']*/com.launchdarkly:launchdarkly-android-client:${VERSION}/" README.md
 rm -f README.md.bak
 
-./gradlew test sourcesJar javadocJar packageRelease uploadArchives closeAndReleaseRepository
+./gradlew test sourcesJar javadocJar packageRelease
+./gradlew uploadArchives closeAndReleaseRepository
 ./gradlew publishGhPages
 echo "Finished android-client release."

Original file line number	Diff line number	Diff line change
`@@ -2,9 +2,9 @@`
`2`	`2`
`3`	`3`	`buildscript {`
`4`	`4`	`repositories {`
`5`		`- jcenter()`
`6`	`5`	`mavenCentral()`
`7`	`6`	`google()`
	`7`	`+ jcenter()`
`8`	`8`	`}`
`9`	`9`	`dependencies {`
`10`	`10`	`classpath 'com.android.tools.build:gradle:3.0.1'`
`@@ -20,9 +20,9 @@ buildscript {`
`20`	`20`
`21`	`21`	`allprojects {`
`22`	`22`	`repositories {`
`23`		`- jcenter()`
`24`	`23`	`mavenCentral()`
`25`	`24`	`google()`
	`25`	`+ jcenter()`
`26`	`26`	`}`
`27`	`27`	`}`
`28`	`28`
`@@ -40,4 +40,4 @@ subprojects {`
`40`	`40`	`project.android.dexOptions.preDexLibraries = rootProject.ext.preDexLibs`
`41`	`41`	`}`
`42`	`42`	`}`
`43`		`-}`
	`43`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -31,14 +31,10 @@ public void onReceive(Context context, Intent intent) {`
`31`	`31`	`Timber.e("UserManager singleton was accessed before it was initialized! doing nothing");`
`32`	`32`	`return;`
`33`	`33`	`}`
`34`		`- userManager.updateCurrentUser().get(15, TimeUnit.SECONDS);`
	`34`	`+ userManager.updateCurrentUser();`
`35`	`35`	`} else {`
`36`	`36`	`Timber.d("onReceive with no internet connection! Skipping fetch.");`
`37`	`37`	`}`
`38`		`- } catch (InterruptedException \| ExecutionException e) {`
`39`		`- Timber.e(e, "Exception caught when awaiting update");`
`40`		`- } catch (TimeoutException e) {`
`41`		`- Timber.e(e, "Feature Flag update timed out");`
`42`	`38`	`} catch (LaunchDarklyException e) {`
`43`	`39`	`Timber.e(e, "Exception when getting client");`
`44`	`40`	`}`