Release 2.13.0

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 
 All notable changes to the LaunchDarkly Android SDK will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org).
+
+## [2.13.0] - 2020-08-07
+### Added
+- Allow specifying additional headers to be included on HTTP requests to LaunchDarkly services using `LDConfig.Builder.setAdditionalHeaders`. This feature is to enable certain proxy configurations, and is not needed for normal use.
+
 ## [2.12.0] - 2020-05-29
 ### Added
 - Added a new configuration option, `maxCachedUsers` to LDConfig. This option allows configuration of the limit to how many users have their flag values cached locally in the device's SharedPreferences. 

example/build.gradle

@@ -46,7 +46,7 @@ dependencies {
     implementation 'com.android.support:appcompat-v7:26.1.0'
     implementation project(path: ':launchdarkly-android-client-sdk')
     // Comment the previous line and uncomment this one to depend on the published artifact:
-    //implementation 'com.launchdarkly:launchdarkly-android-client-sdk:2.12.0'
+    //implementation 'com.launchdarkly:launchdarkly-android-client-sdk:2.13.0'
 
     implementation 'com.jakewharton.timber:timber:4.7.1'
 

launchdarkly-android-client-sdk/build.gradle

@@ -7,7 +7,7 @@ apply plugin: 'io.codearte.nexus-staging'
 
 allprojects {
     group = 'com.launchdarkly'
-    version = '2.12.0'
+    version = '2.13.0'
     sourceCompatibility = 1.7
     targetCompatibility = 1.7
 }

launchdarkly-android-client-sdk/src/androidTest/java/com/launchdarkly/android/DiagnosticEventProcessorTest.java

@@ -0,0 +1,125 @@
+package com.launchdarkly.android;
+
+import android.net.Uri;
+import android.support.test.rule.ActivityTestRule;
+import android.support.test.runner.AndroidJUnit4;
+
+import com.launchdarkly.android.test.TestActivity;
+
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+import java.io.IOException;
+import java.util.HashMap;
+
+import okhttp3.OkHttpClient;
+import okhttp3.mockwebserver.MockResponse;
+import okhttp3.mockwebserver.MockWebServer;
+import okhttp3.mockwebserver.RecordedRequest;
+
+import static junit.framework.Assert.assertEquals;
+
+@RunWith(AndroidJUnit4.class)
+public class DiagnosticEventProcessorTest {
+
+    @Rule
+    public final ActivityTestRule<TestActivity> activityTestRule =
+            new ActivityTestRule<>(TestActivity.class, false, true);
+
+    private MockWebServer mockEventsServer;
+
+    @Before
+    public void before() throws IOException {
+        NetworkTestController.setup(activityTestRule.getActivity());
+        mockEventsServer = new MockWebServer();
+        mockEventsServer.start();
+    }
+
+    @After
+    public void after() throws InterruptedException, IOException {
+        NetworkTestController.enableNetwork();
+        mockEventsServer.close();
+    }
+
+    @Test
+    public void defaultDiagnosticRequest() throws InterruptedException {
+        // Setup in background to prevent initial diagnostic event
+        ForegroundTestController.setup(false);
+        OkHttpClient okHttpClient = new OkHttpClient.Builder().build();
+        LDConfig ldConfig = new LDConfig.Builder()
+                .setMobileKey("test-mobile-key")
+                .setEventsUri(Uri.parse(mockEventsServer.url("/mobile").toString()))
+                .build();
+        DiagnosticStore diagnosticStore = new DiagnosticStore(activityTestRule.getActivity().getApplication(), "test-mobile-key");
+        DiagnosticEventProcessor diagnosticEventProcessor = new DiagnosticEventProcessor(ldConfig, "default", diagnosticStore, okHttpClient);
+
+        DiagnosticEvent testEvent = new DiagnosticEvent("test-kind", System.currentTimeMillis(), diagnosticStore.getDiagnosticId());
+
+        mockEventsServer.enqueue(new MockResponse());
+        diagnosticEventProcessor.sendDiagnosticEventSync(testEvent);
+        RecordedRequest r = mockEventsServer.takeRequest();
+        assertEquals("POST", r.getMethod());
+        assertEquals("/mobile/events/diagnostic", r.getPath());
+        assertEquals("api_key test-mobile-key", r.getHeader("Authorization"));
+        assertEquals("AndroidClient/" + BuildConfig.VERSION_NAME, r.getHeader("User-Agent"));
+        assertEquals("application/json; charset=utf-8", r.getHeader("Content-Type"));
+        assertEquals(GsonCache.getGson().toJson(testEvent), r.getBody().readUtf8());
+    }
+
+    @Test
+    public void defaultDiagnosticRequestIncludingWrapper() throws InterruptedException {
+        // Setup in background to prevent initial diagnostic event
+        ForegroundTestController.setup(false);
+        OkHttpClient okHttpClient = new OkHttpClient.Builder().build();
+        LDConfig ldConfig = new LDConfig.Builder()
+                .setMobileKey("test-mobile-key")
+                .setEventsUri(Uri.parse(mockEventsServer.url("/mobile").toString()))
+                .setWrapperName("ReactNative")
+                .setWrapperVersion("1.0.0")
+                .build();
+        DiagnosticStore diagnosticStore = new DiagnosticStore(activityTestRule.getActivity().getApplication(), "test-mobile-key");
+        DiagnosticEventProcessor diagnosticEventProcessor = new DiagnosticEventProcessor(ldConfig, "default", diagnosticStore, okHttpClient);
+
+        DiagnosticEvent testEvent = new DiagnosticEvent("test-kind", System.currentTimeMillis(), diagnosticStore.getDiagnosticId());
+
+        mockEventsServer.enqueue(new MockResponse());
+        diagnosticEventProcessor.sendDiagnosticEventSync(testEvent);
+        RecordedRequest r = mockEventsServer.takeRequest();
+        assertEquals("POST", r.getMethod());
+        assertEquals("/mobile/events/diagnostic", r.getPath());
+        assertEquals("ReactNative/1.0.0", r.getHeader("X-LaunchDarkly-Wrapper"));
+        assertEquals(GsonCache.getGson().toJson(testEvent), r.getBody().readUtf8());
+    }
+
+    @Test
+    public void defaultDiagnosticRequestIncludingAdditionalHeaders() throws InterruptedException {
+        // Setup in background to prevent initial diagnostic event
+        ForegroundTestController.setup(false);
+        OkHttpClient okHttpClient = new OkHttpClient.Builder().build();
+
+        HashMap<String, String> additionalHeaders = new HashMap<>();
+        additionalHeaders.put("Proxy-Authorization", "token");
+        additionalHeaders.put("Authorization", "foo");
+        LDConfig ldConfig = new LDConfig.Builder()
+                .setMobileKey("test-mobile-key")
+                .setEventsUri(Uri.parse(mockEventsServer.url("/mobile").toString()))
+                .setAdditionalHeaders(additionalHeaders)
+                .build();
+        DiagnosticStore diagnosticStore = new DiagnosticStore(activityTestRule.getActivity().getApplication(), "test-mobile-key");
+        DiagnosticEventProcessor diagnosticEventProcessor = new DiagnosticEventProcessor(ldConfig, "default", diagnosticStore, okHttpClient);
+
+        DiagnosticEvent testEvent = new DiagnosticEvent("test-kind", System.currentTimeMillis(), diagnosticStore.getDiagnosticId());
+
+        mockEventsServer.enqueue(new MockResponse());
+        diagnosticEventProcessor.sendDiagnosticEventSync(testEvent);
+        RecordedRequest r = mockEventsServer.takeRequest();
+        assertEquals("POST", r.getMethod());
+        assertEquals("/mobile/events/diagnostic", r.getPath());
+        assertEquals("token", r.getHeader("Proxy-Authorization"));
+        assertEquals("foo", r.getHeader("Authorization"));
+        assertEquals(GsonCache.getGson().toJson(testEvent), r.getBody().readUtf8());
+    }
+}

launchdarkly-android-client-sdk/src/androidTest/java/com/launchdarkly/android/LDClientTest.java

@@ -15,6 +15,7 @@
 import org.junit.runner.RunWith;
 
 import java.io.IOException;
+import java.util.HashMap;
 import java.util.UUID;
 import java.util.concurrent.ExecutionException;
 import java.util.concurrent.Future;
@@ -478,6 +479,27 @@ public void variationFlagTrackReasonGeneratesEventWithReason() throws IOExceptio
         }
     }
 
+    @Test
+    public void additionalHeadersIncludedInEventsRequest() throws IOException, InterruptedException {
+        try (MockWebServer mockEventsServer = new MockWebServer()) {
+            mockEventsServer.start();
+            // Enqueue a successful empty response
+            mockEventsServer.enqueue(new MockResponse());
+
+            HashMap<String, String> additionalHeaders = new HashMap<>();
+            additionalHeaders.put("Proxy-Authorization", "token");
+            additionalHeaders.put("Authorization", "foo");
+            LDConfig ldConfig = baseConfigBuilder(mockEventsServer).setAdditionalHeaders(additionalHeaders).build();
+            try (LDClient client = LDClient.init(application, ldConfig, ldUser, 0)) {
+                client.blockingFlush();
+            }
+
+            RecordedRequest r = mockEventsServer.takeRequest();
+            assertEquals("token", r.getHeader("Proxy-Authorization"));
+            assertEquals("foo", r.getHeader("Authorization"));
+        }
+    }
+
     private Event[] getEventsFromLastRequest(MockWebServer server, int expectedCount) throws InterruptedException {
         RecordedRequest r = server.takeRequest();
         assertEquals("POST", r.getMethod());

launchdarkly-android-client-sdk/src/androidTest/java/com/launchdarkly/android/LDConfigTest.java

@@ -6,8 +6,11 @@
 import org.junit.Test;
 import org.junit.runner.RunWith;
 
+import java.util.HashMap;
 import java.util.HashSet;
 
+import okhttp3.Request;
+
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertFalse;
 import static org.junit.Assert.assertNull;
@@ -45,6 +48,7 @@ public void testBuilderDefaults() {
 
         assertNull(config.getWrapperName());
         assertNull(config.getWrapperVersion());
+        assertNull(config.getAdditionalHeaders());
     }
 
 
@@ -234,4 +238,41 @@ public void testBuilderMaxCachedUsers() {
         config = new LDConfig.Builder().setMaxCachedUsers(-1).build();
         assertEquals(-1, config.getMaxCachedUsers());
     }
+
+    @Test
+    public void canSetAdditionalHeaders() {
+        HashMap<String, String> additionalHeaders = new HashMap<>();
+        additionalHeaders.put("Proxy-Authorization", "token");
+        additionalHeaders.put("Authorization", "foo");
+        LDConfig config = new LDConfig.Builder().setAdditionalHeaders(additionalHeaders).build();
+        assertEquals(2, config.getAdditionalHeaders().size());
+        assertEquals("token", config.getAdditionalHeaders().get("Proxy-Authorization"));
+        assertEquals("foo", config.getAdditionalHeaders().get("Authorization"));
+    }
+
+    @Test
+    public void buildRequestWithAdditionalHeadersNull() {
+        LDConfig config = new LDConfig.Builder().build();
+        Request.Builder requestBuilder = new Request.Builder()
+                .url("http://example.com")
+                .header("Authorization", "test-key");
+        Request request = config.buildRequestWithAdditionalHeaders(requestBuilder);
+        assertEquals(1, request.headers().size());
+        assertEquals("test-key", request.header("Authorization"));
+    }
+
+    @Test
+    public void buildRequestWithAdditionalHeaders() {
+        HashMap<String, String> additionalHeaders = new HashMap<>();
+        additionalHeaders.put("Proxy-Authorization", "token");
+        additionalHeaders.put("Authorization", "foo");
+        LDConfig config = new LDConfig.Builder().setAdditionalHeaders(additionalHeaders).build();
+        Request.Builder requestBuilder = new Request.Builder()
+                .url("http://example.com")
+                .header("Authorization", "test-key");
+        Request request = config.buildRequestWithAdditionalHeaders(requestBuilder);
+        assertEquals(2, request.headers().size());
+        assertEquals("token", request.header("Proxy-Authorization"));
+        assertEquals("foo", request.header("Authorization"));
+    }
 }

launchdarkly-android-client-sdk/src/main/java/com/launchdarkly/android/DefaultEventProcessor.java

@@ -152,13 +152,14 @@ private void postEvents(List<Event> events) {
                     } catch (InterruptedException e) {}
                 }
 
-                Request request = config.getRequestBuilderFor(environmentName)
+                Request.Builder requestBuilder = config.getRequestBuilderFor(environmentName)
                         .url(url)
                         .post(RequestBody.create(JSON, content))
                         .addHeader("Content-Type", "application/json")
                         .addHeader("X-LaunchDarkly-Event-Schema", "3")
-                        .addHeader("X-LaunchDarkly-Payload-ID", eventPayloadId)
-                        .build();
+                        .addHeader("X-LaunchDarkly-Payload-ID", eventPayloadId);
+
+                Request request = config.buildRequestWithAdditionalHeaders(requestBuilder);
 
                 Response response = null;
                 try {

launchdarkly-android-client-sdk/src/main/java/com/launchdarkly/android/DiagnosticEventProcessor.java

@@ -101,12 +101,14 @@ public void run() {
         });
     }
 
-    private void sendDiagnosticEventSync(DiagnosticEvent diagnosticEvent) {
+    void sendDiagnosticEventSync(DiagnosticEvent diagnosticEvent) {
         String content = GsonCache.getGson().toJson(diagnosticEvent);
         Request.Builder requestBuilder = config.getRequestBuilderFor(environment)
                 .url(config.getEventsUri().toString() + "/events/diagnostic")
-                .addHeader("Content-Type", "application/json");
-        Request request = requestBuilder.post(RequestBody.create(JSON, content)).build();
+                .addHeader("Content-Type", "application/json")
+                .post(RequestBody.create(JSON, content));
+
+        Request request = config.buildRequestWithAdditionalHeaders(requestBuilder);
         Timber.d("Posting diagnostic event to %s with body %s", request.url(), content);
 
         Response response = null;

launchdarkly-android-client-sdk/src/main/java/com/launchdarkly/android/HttpFeatureFlagFetcher.java

@@ -123,9 +123,9 @@ private Request getDefaultRequest(LDUser user) {
             uri += "?withReasons=true";
         }
         Timber.d("Attempting to fetch Feature flags using uri: %s", uri);
-        return config.getRequestBuilderFor(environmentName) // default GET verb
-                .url(uri)
-                .build();
+        Request.Builder requestBuilder = config.getRequestBuilderFor(environmentName) // default GET verb
+                .url(uri);
+        return config.buildRequestWithAdditionalHeaders(requestBuilder);
     }
 
     private Request getReportRequest(LDUser user) {
@@ -136,9 +136,9 @@ private Request getReportRequest(LDUser user) {
         Timber.d("Attempting to report user using uri: %s", reportUri);
         String userJson = GSON.toJson(user);
         RequestBody reportBody = RequestBody.create(MediaType.parse("application/json;charset=UTF-8"), userJson);
-        return config.getRequestBuilderFor(environmentName)
+        Request.Builder requestBuilder = config.getRequestBuilderFor(environmentName)
                 .method("REPORT", reportBody) // custom REPORT verb
-                .url(reportUri)
-                .build();
+                .url(reportUri);
+        return config.buildRequestWithAdditionalHeaders(requestBuilder);
     }
 }