18273: Increase default java sdk timeouts & make them configuable
authorPeter Amstutz <peter.amstutz@curii.com>
Thu, 14 Oct 2021 19:09:00 +0000 (15:09 -0400)
committerPeter Amstutz <peter.amstutz@curii.com>
Thu, 28 Oct 2021 14:57:08 +0000 (10:57 -0400)
Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <peter.amstutz@curii.com>

sdk/java-v2/src/main/java/org/arvados/client/api/client/BaseApiClient.java
sdk/java-v2/src/main/java/org/arvados/client/config/ConfigProvider.java
sdk/java-v2/src/main/java/org/arvados/client/config/ExternalConfigProvider.java
sdk/java-v2/src/main/java/org/arvados/client/config/FileConfigProvider.java
sdk/java-v2/src/main/resources/reference.conf

index a8d1a08cb09643262bf657498aefc53b727f168c..51f2f4a81b02c74c34198d22ae90203d0cb736a3 100644 (file)
@@ -23,6 +23,7 @@ import java.io.UnsupportedEncodingException;
 import java.net.URLDecoder;
 import java.nio.charset.StandardCharsets;
 import java.util.Objects;
+import java.util.concurrent.TimeUnit;
 
 abstract class BaseApiClient {
 
@@ -34,7 +35,12 @@ abstract class BaseApiClient {
 
     BaseApiClient(ConfigProvider config) {
         this.config = config;
-        this.client = OkHttpClientFactory.INSTANCE.create(config.isApiHostInsecure());
+        this.client = OkHttpClientFactory.INSTANCE.create(config.isApiHostInsecure())
+           .newBuilder()
+           .connectTimeout(config.getConnectTimeout(), TimeUnit.MILLISECONDS)
+           .readTimeout(config.getReadTimeout(), TimeUnit.MILLISECONDS)
+           .writeTimeout(config.getWriteTimeout(), TimeUnit.MILLISECONDS)
+           .build();
     }
 
     Request.Builder getRequestBuilder() {
index c9a4109313fd70767df4a5b87bb32f45f540fb86..116a46b3eb3ebba81d2a501aafc9c93042f43703 100644 (file)
@@ -26,6 +26,11 @@ public interface ConfigProvider {
 
     String getApiProtocol();
 
+    int getConnectTimeout();
+
+    int getReadTimeout();
+
+    int getWriteTimeout();
 
     //FILE UPLOAD
     int getFileSplitSize();
index 17e06966fa80daf9713c03e026093f03550bf75e..d592b23ac34e81f13f12f5250736e7de529fd112 100644 (file)
@@ -22,8 +22,35 @@ public class ExternalConfigProvider implements ConfigProvider {
     private File fileSplitDirectory;
     private int numberOfCopies;
     private int numberOfRetries;
+    private int connectTimeout;
+    private int readTimeout;
+    private int writeTimeout;
+
+    ExternalConfigProvider(boolean apiHostInsecure, String keepWebHost, int keepWebPort, String apiHost, int apiPort,
+                          String apiToken, String apiProtocol, int fileSplitSize, File fileSplitDirectory,
+                          int numberOfCopies, int numberOfRetries)
+    {
+        this.apiHostInsecure = apiHostInsecure;
+        this.keepWebHost = keepWebHost;
+        this.keepWebPort = keepWebPort;
+        this.apiHost = apiHost;
+        this.apiPort = apiPort;
+        this.apiToken = apiToken;
+        this.apiProtocol = apiProtocol;
+        this.fileSplitSize = fileSplitSize;
+        this.fileSplitDirectory = fileSplitDirectory;
+        this.numberOfCopies = numberOfCopies;
+        this.numberOfRetries = numberOfRetries;
+       this.connectTimeout = 60000;
+       this.readTimeout = 60000;
+       this.writeTimeout = 60000;
+    }
 
-    ExternalConfigProvider(boolean apiHostInsecure, String keepWebHost, int keepWebPort, String apiHost, int apiPort, String apiToken, String apiProtocol, int fileSplitSize, File fileSplitDirectory, int numberOfCopies, int numberOfRetries) {
+    ExternalConfigProvider(boolean apiHostInsecure, String keepWebHost, int keepWebPort, String apiHost, int apiPort,
+                          String apiToken, String apiProtocol, int fileSplitSize, File fileSplitDirectory,
+                          int numberOfCopies, int numberOfRetries,
+                          int connectTimeout, int readTimeout, int writeTimeout)
+    {
         this.apiHostInsecure = apiHostInsecure;
         this.keepWebHost = keepWebHost;
         this.keepWebPort = keepWebPort;
@@ -35,6 +62,9 @@ public class ExternalConfigProvider implements ConfigProvider {
         this.fileSplitDirectory = fileSplitDirectory;
         this.numberOfCopies = numberOfCopies;
         this.numberOfRetries = numberOfRetries;
+       this.connectTimeout = connectTimeout;
+       this.readTimeout = readTimeout;
+       this.writeTimeout = writeTimeout;
     }
 
     public static ExternalConfigProviderBuilder builder() {
@@ -102,6 +132,18 @@ public class ExternalConfigProvider implements ConfigProvider {
         return this.numberOfRetries;
     }
 
+    public int getConnectTimeout() {
+        return this.connectTimeout;
+    }
+
+    public int getReadTimeout() {
+        return this.readTimeout;
+    }
+
+    public int getWriteTimeout() {
+        return this.writeTimeout;
+    }
+
     public static class ExternalConfigProviderBuilder {
         private boolean apiHostInsecure;
         private String keepWebHost;
index 589c3346b22ad904512ada67df03a15be5b1119c..99c1af810863eb3c14dfe521fadf524f200da041 100644 (file)
@@ -104,4 +104,19 @@ public class FileConfigProvider implements ConfigProvider {
     public String getIntegrationTestProjectUuid() {
         return this.getString("integration-tests.project-uuid");
     }
+
+    @Override
+    public int getConnectTimeout() {
+        return this.getInt("connectTimeout");
+    }
+
+    @Override
+    public int getReadTimeout() {
+        return this.getInt("readTimeout");
+    }
+
+    @Override
+    public int getWriteTimeout() {
+        return this.getInt("writeTimeout");
+    }
 }
index 3ff2bb0a987888d8d5600985776da6fec86db2c9..8933e2bc6011e3342d4065a3ce9d3bfd0fe78710 100644 (file)
@@ -1,3 +1,7 @@
+# Copyright (C) The Arvados Authors. All rights reserved.
+#
+# SPDX-License-Identifier: AGPL-3.0 OR Apache-2.0
+#
 # Arvados client default configuration
 #
 # Remarks:
@@ -20,4 +24,7 @@ arvados {
     temp-dir = /tmp/file-split
     copies = 2
     retries = 0
+    connectTimeout = 60000
+    readTimeout = 60000
+    writeTimeout = 60000
 }