Merge pull request #491 from cloudant/sync-session-renewal

Session renewal improvements

Author: ricellis

.travis.yml

@@ -2,7 +2,7 @@ language: java
 sudo: false
 
 jdk:
-  - oraclejdk8
+  - openjdk8
 
 services:
   - couchdb

CHANGES.md

@@ -1,6 +1,11 @@
 # Unreleased
-- [UPGRADED] Optional OkHttp dependency to version 3.12.2.
 - [FIXED] Create an array of strings for QueryBuilder.fields() when a single field is provided.
+- [IMPROVED] Return exceptions directly from IAM token request failures instead of logging and
+  deferring the request to the service with no credentials. The exception type is the same, but
+  the message and cause are more clear and a round trip is avoided.
+- [IMPROVED] Prevent multiple session renewal requests happening simultaneously because some auth
+  types apply limits to the number of requests that can be made.
+- [UPGRADED] Optional OkHttp dependency to version 3.12.5.
 
 # 2.17.0 (2019-05-23)
 - [NEW] Added `com.cloudant.client.api.model.DbInfo#getDocDelCountLong()` to return

cloudant-client/build.gradle

@@ -20,7 +20,7 @@ dependencies {
     testImplementation 'org.junit.jupiter:junit-jupiter-api:5.1.0'
     testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.1.0'
     testCompile group: 'org.hamcrest', name: 'hamcrest-library', version: '1.3'
-    testCompile group: 'com.squareup.okhttp3', name: 'mockwebserver', version: '3.12.2'
+    testCompile group: 'com.squareup.okhttp3', name: 'mockwebserver', version: '3.12.5'
     testCompile group: 'org.jmockit', name: 'jmockit', version: '1.34'
     testCompile group: 'org.littleshoot', name: 'littleproxy', version: '1.1.0'
 }

cloudant-client/src/main/java/com/cloudant/client/org/lightcouch/CouchDbClient.java

@@ -551,9 +551,10 @@ public HttpConnection execute(HttpConnection connection) {
             try {
                 connection = connection.execute();
             } catch (HttpConnectionInterceptorException e) {
-                CouchDbException exception = new CouchDbException(connection.getConnection()
-                        .getResponseMessage(), connection.getConnection().getResponseCode());
+                CouchDbException exception;
                 if (e.deserialize) {
+                    exception = new CouchDbException(connection.getConnection()
+                            .getResponseMessage(), connection.getConnection().getResponseCode());
                     try {
                         JsonObject errorResponse = new Gson().fromJson(e.error, JsonObject
                                 .class);
@@ -563,6 +564,7 @@ public HttpConnection execute(HttpConnection connection) {
                         exception.error = e.error;
                     }
                 } else {
+                    exception = new CouchDbException(e.getMessage(), e);
                     exception.error = e.error;
                     exception.reason = e.reason;
                 }

cloudant-client/src/test/java/com/cloudant/tests/CloudFoundryServiceTest.java

@@ -14,6 +14,7 @@
 
 package com.cloudant.tests;
 
+import static com.cloudant.http.internal.interceptors.IamCookieInterceptor.IAM_TOKEN_SERVER_URL_PROPERTY_KEY;
 import static com.cloudant.tests.util.MockWebServerResources.IAM_API_KEY;
 import static com.cloudant.tests.util.MockWebServerResources.IAM_TOKEN;
 import static com.cloudant.tests.util.MockWebServerResources.OK_IAM_COOKIE;
@@ -23,12 +24,11 @@
 import com.cloudant.client.api.ClientBuilder;
 import com.cloudant.client.api.CloudantClient;
 import com.cloudant.tests.extensions.MockWebServerExtension;
-import com.cloudant.tests.util.IamSystemPropertyMock;
 import com.cloudant.tests.util.MockWebServerResources;
 import com.google.gson.GsonBuilder;
 
+import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.Assertions;
-import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.RegisterExtension;
@@ -46,8 +46,6 @@
 
 public class CloudFoundryServiceTest {
 
-    public static IamSystemPropertyMock iamSystemPropertyMock;
-
     private static String TEST_HOST = "https://cloudant.example";
     private static String TEST_USER = "user";
     private static String TEST_PASSWORD = "pass";
@@ -63,25 +61,23 @@ public class CloudFoundryServiceTest {
     public MockWebServer server;
     public MockWebServer mockIamServer;
 
-    /**
-     * Before running this test class setup the property mock.
-     */
-    @BeforeAll
-    public static void setupIamSystemPropertyMock() {
-        iamSystemPropertyMock = new IamSystemPropertyMock();
-    }
-
     @BeforeEach
     public void beforeEach() {
         server = mockWebServerExt.get();
         server.useHttps(MockWebServerResources.getSSLSocketFactory(), false);
         mockServerHostPort = String.format("%s:%s/", server.getHostName(), server.getPort());
         //setup mock IAM server
         mockIamServer = mockIamServerExt.get();
-        iamSystemPropertyMock.setMockIamTokenEndpointUrl(mockIamServer.url(iamTokenEndpoint)
+        // Override the default IAM token server with our test mock server
+        System.setProperty(IAM_TOKEN_SERVER_URL_PROPERTY_KEY, mockIamServer.url(iamTokenEndpoint)
                 .toString());
     }
 
+    @AfterEach
+    public void clearIAMMock() {
+        System.clearProperty(IAM_TOKEN_SERVER_URL_PROPERTY_KEY);
+    }
+
     private static class VCAPGenerator {
 
         private Map<String, Object> vcap;