Changed connectTimeout's type to java.time.Duration (#1862)

Asapin · web-flow · commit e12e8d48960a · 2023-04-23T12:18:40.000+05:30
* Changed connectTimeout's type to java.time.Duration
diff --git a/client/src/main/java/org/asynchttpclient/AsyncHttpClientConfig.java b/client/src/main/java/org/asynchttpclient/AsyncHttpClientConfig.java
@@ -36,6 +36,7 @@
 import org.asynchttpclient.proxy.ProxyServerSelector;
 
 import java.io.IOException;
+import java.time.Duration;
 import java.util.List;
 import java.util.Map;
 import java.util.concurrent.ThreadFactory;
@@ -78,11 +79,11 @@ public interface AsyncHttpClientConfig {
 
 
     /**
-     * Return the maximum time in millisecond an {@link AsyncHttpClient} can wait when connecting to a remote host
+     * Return the maximum time an {@link AsyncHttpClient} can wait when connecting to a remote host
      *
-     * @return the maximum time in millisecond an {@link AsyncHttpClient} can wait when connecting to a remote host
+     * @return the maximum time an {@link AsyncHttpClient} can wait when connecting to a remote host
      */
-    int getConnectTimeout();
+    Duration getConnectTimeout();
 
     /**
      * Return the maximum time in millisecond an {@link AsyncHttpClient} can stay idle.
diff --git a/client/src/main/java/org/asynchttpclient/DefaultAsyncHttpClientConfig.java b/client/src/main/java/org/asynchttpclient/DefaultAsyncHttpClientConfig.java
@@ -35,6 +35,7 @@
 import org.asynchttpclient.proxy.ProxyServerSelector;
 import org.asynchttpclient.util.ProxyUtils;
 
+import java.time.Duration;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.LinkedList;
@@ -130,7 +131,7 @@ public class DefaultAsyncHttpClientConfig implements AsyncHttpClientConfig {
     private final int webSocketMaxFrameSize;
 
     // timeouts
-    private final int connectTimeout;
+    private final Duration connectTimeout;
     private final int requestTimeout;
     private final int readTimeout;
     private final int shutdownQuietPeriod;
@@ -215,7 +216,7 @@ private DefaultAsyncHttpClientConfig(// http
                                          boolean enablewebSocketCompression,
 
                                          // timeouts
-                                         int connectTimeout,
+                                         Duration connectTimeout,
                                          int requestTimeout,
                                          int readTimeout,
                                          int shutdownQuietPeriod,
@@ -472,7 +473,7 @@ public int getWebSocketMaxFrameSize() {
 
     // timeouts
     @Override
-    public int getConnectTimeout() {
+    public Duration getConnectTimeout() {
         return connectTimeout;
     }
 
@@ -795,7 +796,7 @@ public static class Builder {
         private int webSocketMaxFrameSize = defaultWebSocketMaxFrameSize();
 
         // timeouts
-        private int connectTimeout = defaultConnectTimeout();
+        private Duration connectTimeout = defaultConnectTimeout();
         private int requestTimeout = defaultRequestTimeout();
         private int readTimeout = defaultReadTimeout();
         private int shutdownQuietPeriod = defaultShutdownQuietPeriod();
@@ -1058,7 +1059,7 @@ public Builder setWebSocketMaxFrameSize(int webSocketMaxFrameSize) {
         }
 
         // timeouts
-        public Builder setConnectTimeout(int connectTimeout) {
+        public Builder setConnectTimeout(Duration connectTimeout) {
             this.connectTimeout = connectTimeout;
             return this;
         }
diff --git a/client/src/main/java/org/asynchttpclient/config/AsyncHttpClientConfigDefaults.java b/client/src/main/java/org/asynchttpclient/config/AsyncHttpClientConfigDefaults.java
@@ -17,6 +17,7 @@
 
 import java.io.IOException;
 import java.io.InputStream;
+import java.time.Duration;
 import java.util.Properties;
 
 public final class AsyncHttpClientConfigDefaults {
@@ -110,8 +111,8 @@ public static int defaultAcquireFreeChannelTimeout() {
         return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getInt(ASYNC_CLIENT_CONFIG_ROOT + ACQUIRE_FREE_CHANNEL_TIMEOUT);
     }
 
-    public static int defaultConnectTimeout() {
-        return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getInt(ASYNC_CLIENT_CONFIG_ROOT + CONNECTION_TIMEOUT_CONFIG);
+    public static Duration defaultConnectTimeout() {
+        return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getDuration(ASYNC_CLIENT_CONFIG_ROOT + CONNECTION_TIMEOUT_CONFIG);
     }
 
     public static int defaultPooledConnectionIdleTimeout() {
diff --git a/client/src/main/java/org/asynchttpclient/config/AsyncHttpClientConfigHelper.java b/client/src/main/java/org/asynchttpclient/config/AsyncHttpClientConfigHelper.java
@@ -17,6 +17,7 @@
 
 import java.io.IOException;
 import java.io.InputStream;
+import java.time.Duration;
 import java.util.Properties;
 import java.util.concurrent.ConcurrentHashMap;
 
@@ -110,5 +111,9 @@ public int getInt(String key) {
         public boolean getBoolean(String key) {
             return Boolean.parseBoolean(getString(key));
         }
+
+        public Duration getDuration(String key) {
+            return Duration.parse(getString(key));
+        }
     }
 }
diff --git a/client/src/main/java/org/asynchttpclient/netty/channel/ChannelManager.java b/client/src/main/java/org/asynchttpclient/netty/channel/ChannelManager.java
@@ -211,8 +211,10 @@ private static Bootstrap newBootstrap(ChannelFactory<? extends Channel> channelF
                 .option(ChannelOption.SO_KEEPALIVE, config.isSoKeepAlive())
                 .option(ChannelOption.AUTO_CLOSE, false);
 
-        if (config.getConnectTimeout() > 0) {
-            bootstrap.option(ChannelOption.CONNECT_TIMEOUT_MILLIS, config.getConnectTimeout());
+        long connectTimeout = config.getConnectTimeout().toMillis();
+        if (connectTimeout > 0) {
+            connectTimeout = Math.min(connectTimeout, Integer.MAX_VALUE);
+            bootstrap.option(ChannelOption.CONNECT_TIMEOUT_MILLIS, (int) connectTimeout);
         }
 
         if (config.getSoLinger() >= 0) {
diff --git a/client/src/main/resources/org/asynchttpclient/config/ahc-default.properties b/client/src/main/resources/org/asynchttpclient/config/ahc-default.properties
@@ -2,7 +2,7 @@ org.asynchttpclient.threadPoolName=AsyncHttpClient
 org.asynchttpclient.maxConnections=-1
 org.asynchttpclient.maxConnectionsPerHost=-1
 org.asynchttpclient.acquireFreeChannelTimeout=0
-org.asynchttpclient.connectTimeout=5000
+org.asynchttpclient.connectTimeout=PT5S
 org.asynchttpclient.pooledConnectionIdleTimeout=60000
 org.asynchttpclient.connectionPoolCleanerPeriod=100
 org.asynchttpclient.readTimeout=60000
diff --git a/client/src/test/java/org/asynchttpclient/AsyncHttpClientDefaultsTest.java b/client/src/test/java/org/asynchttpclient/AsyncHttpClientDefaultsTest.java
@@ -20,6 +20,7 @@
 import org.asynchttpclient.config.AsyncHttpClientConfigHelper;
 
 import java.lang.reflect.Method;
+import java.time.Duration;
 
 import static org.asynchttpclient.config.AsyncHttpClientConfigDefaults.ASYNC_CLIENT_CONFIG_ROOT;
 import static org.junit.jupiter.api.Assertions.assertEquals;
@@ -49,8 +50,8 @@ public void testDefaultMaxConnectionPerHost() {
 
     @RepeatedIfExceptionsTest(repeats = 5)
     public void testDefaultConnectTimeOut() {
-        assertEquals(AsyncHttpClientConfigDefaults.defaultConnectTimeout(), 5 * 1000);
-        testIntegerSystemProperty("connectTimeout", "defaultConnectTimeout", "100");
+        assertEquals(AsyncHttpClientConfigDefaults.defaultConnectTimeout(), Duration.ofSeconds(5));
+        testDurationSystemProperty("connectTimeout", "defaultConnectTimeout", "PT0.1S");
     }
 
     @RepeatedIfExceptionsTest(repeats = 5)
@@ -205,4 +206,21 @@ private static void testStringSystemProperty(String propertyName, String methodN
             System.clearProperty(ASYNC_CLIENT_CONFIG_ROOT + propertyName);
         }
     }
+
+    private static void testDurationSystemProperty(String propertyName, String methodName, String value) {
+        String previous = System.getProperty(ASYNC_CLIENT_CONFIG_ROOT + propertyName);
+        System.setProperty(ASYNC_CLIENT_CONFIG_ROOT + propertyName, value);
+        AsyncHttpClientConfigHelper.reloadProperties();
+        try {
+            Method method = AsyncHttpClientConfigDefaults.class.getMethod(methodName);
+            assertEquals(method.invoke(null), Duration.parse(value));
+        } catch (Exception e) {
+            fail("Couldn't find or execute method : " + methodName, e);
+        }
+        if (previous != null) {
+            System.setProperty(ASYNC_CLIENT_CONFIG_ROOT + propertyName, previous);
+        } else {
+            System.clearProperty(ASYNC_CLIENT_CONFIG_ROOT + propertyName);
+        }
+    }
 }
diff --git a/client/src/test/java/org/asynchttpclient/NoNullResponseTest.java b/client/src/test/java/org/asynchttpclient/NoNullResponseTest.java
@@ -18,6 +18,8 @@
 
 import org.junit.jupiter.api.RepeatedTest;
 
+import java.time.Duration;
+
 import static org.asynchttpclient.Dsl.asyncHttpClient;
 import static org.asynchttpclient.Dsl.config;
 import static org.junit.jupiter.api.Assertions.assertNotNull;
@@ -30,7 +32,7 @@ public void multipleSslRequestsWithDelayAndKeepAlive() throws Exception {
         AsyncHttpClientConfig config = config()
                 .setFollowRedirect(true)
                 .setKeepAlive(true)
-                .setConnectTimeout(10000)
+                .setConnectTimeout(Duration.ofSeconds(10))
                 .setPooledConnectionIdleTimeout(60000)
                 .setRequestTimeout(10000)
                 .setMaxConnectionsPerHost(-1)
diff --git a/client/src/test/java/org/asynchttpclient/RedirectConnectionUsageTest.java b/client/src/test/java/org/asynchttpclient/RedirectConnectionUsageTest.java
@@ -27,6 +27,7 @@
 
 import java.io.IOException;
 import java.io.OutputStream;
+import java.time.Duration;
 import java.util.Date;
 
 import static org.asynchttpclient.Dsl.asyncHttpClient;
@@ -74,7 +75,7 @@ public void testGetRedirectFinalUrl() throws Exception {
                 .setKeepAlive(true)
                 .setMaxConnectionsPerHost(1)
                 .setMaxConnections(1)
-                .setConnectTimeout(1000)
+                .setConnectTimeout(Duration.ofSeconds(1))
                 .setRequestTimeout(1000)
                 .setFollowRedirect(true)
                 .build();
diff --git a/client/src/test/java/org/asynchttpclient/channel/ConnectionPoolTest.java b/client/src/test/java/org/asynchttpclient/channel/ConnectionPoolTest.java
@@ -28,6 +28,7 @@
 import org.eclipse.jetty.server.ServerConnector;
 import org.junit.jupiter.api.function.ThrowingSupplier;
 
+import java.time.Duration;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
@@ -163,7 +164,7 @@ public void onThrowable(Throwable t) {
 
     @RepeatedIfExceptionsTest(repeats = 5)
     public void multipleMaxConnectionOpenTest() throws Exception {
-        try (AsyncHttpClient client = asyncHttpClient(config().setKeepAlive(true).setConnectTimeout(5000).setMaxConnections(1))) {
+        try (AsyncHttpClient client = asyncHttpClient(config().setKeepAlive(true).setConnectTimeout(Duration.ofSeconds(5)).setMaxConnections(1))) {
             String body = "hello there";
 
             // once
@@ -180,7 +181,7 @@ public void multipleMaxConnectionOpenTest() throws Exception {
 
     @RepeatedIfExceptionsTest(repeats = 5)
     public void multipleMaxConnectionOpenTestWithQuery() throws Exception {
-        try (AsyncHttpClient c = asyncHttpClient(config().setKeepAlive(true).setConnectTimeout(5000).setMaxConnections(1))) {
+        try (AsyncHttpClient c = asyncHttpClient(config().setKeepAlive(true).setConnectTimeout(Duration.ofSeconds(5)).setMaxConnections(1))) {
             String body = "hello there";
 
             // once
diff --git a/client/src/test/java/org/asynchttpclient/channel/MaxConnectionsInThreadsTest.java b/client/src/test/java/org/asynchttpclient/channel/MaxConnectionsInThreadsTest.java
@@ -36,6 +36,7 @@
 
 import java.io.IOException;
 import java.io.OutputStream;
+import java.time.Duration;
 import java.util.concurrent.CountDownLatch;
 import java.util.concurrent.atomic.AtomicInteger;
 
@@ -67,7 +68,7 @@ public void testMaxConnectionsWithinThreads() throws Exception {
         String[] urls = {getTargetUrl(), getTargetUrl()};
 
         AsyncHttpClientConfig config = config()
-                .setConnectTimeout(1000)
+                .setConnectTimeout(Duration.ofSeconds(1))
                 .setRequestTimeout(5000)
                 .setKeepAlive(true)
                 .setMaxConnections(1)
diff --git a/client/src/test/java/org/asynchttpclient/channel/MaxTotalConnectionTest.java b/client/src/test/java/org/asynchttpclient/channel/MaxTotalConnectionTest.java
@@ -24,6 +24,7 @@
 import org.asynchttpclient.Response;
 
 import java.io.IOException;
+import java.time.Duration;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.concurrent.CountDownLatch;
@@ -42,7 +43,7 @@ public void testMaxTotalConnectionsExceedingException() throws IOException {
         String[] urls = {"https://google.com", "https://github.com"};
 
         AsyncHttpClientConfig config = config()
-                .setConnectTimeout(1000)
+                .setConnectTimeout(Duration.ofSeconds(1))
                 .setRequestTimeout(5000)
                 .setKeepAlive(false)
                 .setMaxConnections(1)
@@ -82,7 +83,7 @@ public void testMaxTotalConnections() throws Exception {
         final AtomicReference<String> failedUrl = new AtomicReference<>();
 
         AsyncHttpClientConfig config = config()
-                .setConnectTimeout(1000)
+                .setConnectTimeout(Duration.ofSeconds(1))
                 .setRequestTimeout(5000)
                 .setKeepAlive(false)
                 .setMaxConnections(2)
diff --git a/client/src/test/java/org/asynchttpclient/netty/RetryNonBlockingIssueTest.java b/client/src/test/java/org/asynchttpclient/netty/RetryNonBlockingIssueTest.java
@@ -31,6 +31,7 @@
 import org.junit.jupiter.api.BeforeEach;
 
 import java.io.IOException;
+import java.time.Duration;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
@@ -79,7 +80,7 @@ public void testRetryNonBlocking() throws Exception {
         AsyncHttpClientConfig config = config()
                 .setKeepAlive(true)
                 .setMaxConnections(100)
-                .setConnectTimeout(60000)
+                .setConnectTimeout(Duration.ofMinutes(1))
                 .setRequestTimeout(30000)
                 .build();
 
@@ -107,7 +108,7 @@ public void testRetryNonBlockingAsyncConnect() throws Exception {
         AsyncHttpClientConfig config = config()
                 .setKeepAlive(true)
                 .setMaxConnections(100)
-                .setConnectTimeout(60000)
+                .setConnectTimeout(Duration.ofMinutes(1))
                 .setRequestTimeout(30000)
                 .build();
 
diff --git a/client/src/test/java/org/asynchttpclient/request/body/BodyChunkTest.java b/client/src/test/java/org/asynchttpclient/request/body/BodyChunkTest.java
@@ -24,6 +24,7 @@
 import org.asynchttpclient.request.body.generator.InputStreamBodyGenerator;
 
 import java.io.ByteArrayInputStream;
+import java.time.Duration;
 import java.util.concurrent.Future;
 
 import static org.asynchttpclient.Dsl.asyncHttpClient;
@@ -39,7 +40,7 @@ public class BodyChunkTest extends AbstractBasicTest {
     public void negativeContentTypeTest() throws Exception {
 
         AsyncHttpClientConfig config = config()
-                .setConnectTimeout(100)
+                .setConnectTimeout(Duration.ofMillis(100))
                 .setMaxConnections(50)
                 .setRequestTimeout(5 * 60 * 1000) // 5 minutes
                 .build();
diff --git a/client/src/test/java/org/asynchttpclient/request/body/ChunkingTest.java b/client/src/test/java/org/asynchttpclient/request/body/ChunkingTest.java
@@ -27,6 +27,7 @@
 import java.io.BufferedInputStream;
 import java.io.InputStream;
 import java.nio.file.Files;
+import java.time.Duration;
 import java.util.concurrent.ExecutionException;
 
 import static org.asynchttpclient.Dsl.asyncHttpClient;
@@ -105,7 +106,7 @@ private static DefaultAsyncHttpClientConfig.Builder httpClientBuilder() {
                 .setKeepAlive(true)
                 .setMaxConnectionsPerHost(1)
                 .setMaxConnections(1)
-                .setConnectTimeout(1000)
+                .setConnectTimeout(Duration.ofSeconds(1))
                 .setRequestTimeout(1000)
                 .setFollowRedirect(true);
     }
diff --git a/client/src/test/java/org/asynchttpclient/request/body/TransferListenerTest.java b/client/src/test/java/org/asynchttpclient/request/body/TransferListenerTest.java
@@ -28,6 +28,7 @@
 
 import java.io.File;
 import java.io.IOException;
+import java.time.Duration;
 import java.util.Enumeration;
 import java.util.concurrent.atomic.AtomicBoolean;
 import java.util.concurrent.atomic.AtomicInteger;
@@ -115,9 +116,9 @@ public void basicPutFileTest() throws Exception {
 
         File file = createTempFile(1024 * 100 * 10);
 
-        int timeout = (int) (file.length() / 1000);
+        long timeout = file.length() / 1000;
 
-        try (AsyncHttpClient client = asyncHttpClient(config().setConnectTimeout(timeout))) {
+        try (AsyncHttpClient client = asyncHttpClient(config().setConnectTimeout(Duration.ofMillis(timeout)))) {
             TransferCompletionHandler tl = new TransferCompletionHandler();
             tl.addTransferListener(new TransferListener() {
 

Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@`
`17`	`17`
`18`	`18`	`import java.io.IOException;`
`19`	`19`	`import java.io.InputStream;`
	`20`	`+import java.time.Duration;`
`20`	`21`	`import java.util.Properties;`
`21`	`22`
`22`	`23`	`public final class AsyncHttpClientConfigDefaults {`
`@@ -110,8 +111,8 @@ public static int defaultAcquireFreeChannelTimeout() {`
`110`	`111`	`return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getInt(ASYNC_CLIENT_CONFIG_ROOT + ACQUIRE_FREE_CHANNEL_TIMEOUT);`
`111`	`112`	`}`
`112`	`113`
`113`		`- public static int defaultConnectTimeout() {`
`114`		`- return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getInt(ASYNC_CLIENT_CONFIG_ROOT + CONNECTION_TIMEOUT_CONFIG);`
	`114`	`+ public static Duration defaultConnectTimeout() {`
	`115`	`+ return AsyncHttpClientConfigHelper.getAsyncHttpClientConfig().getDuration(ASYNC_CLIENT_CONFIG_ROOT + CONNECTION_TIMEOUT_CONFIG);`
`115`	`116`	`}`
`116`	`117`
`117`	`118`	`public static int defaultPooledConnectionIdleTimeout() {`