Add support for the Proxy connect timeout in Quarkus REST Client

Closes: quarkusio#48976

Author: geoand

extensions/resteasy-classic/rest-client-config/runtime/src/main/java/io/quarkus/restclient/config/RestClientsConfig.java

@@ -1,6 +1,7 @@
 package io.quarkus.restclient.config;
 
 import java.io.InputStream;
+import java.time.Duration;
 import java.util.Map;
 import java.util.Optional;
 import java.util.OptionalInt;
@@ -89,6 +90,16 @@ public interface RestClientsConfig {
      */
     Optional<String> nonProxyHosts();
 
+    /**
+     * Proxy connection timeout
+     * <p>
+     * Can be overwritten by client-specific settings.
+     * <p>
+     * This property is not applicable to the RESTEasy Client.
+     */
+    @ConfigDocDefault("10s")
+    Optional<Duration> proxyConnectTimeout();
+
     /**
      * A timeout in milliseconds that REST clients should wait to connect to the remote endpoint.
      * <p>
@@ -484,6 +495,14 @@ default Optional<String> uriReload() {
          */
         Optional<String> nonProxyHosts();
 
+        /**
+         * Proxy connection timeout
+         * <p>
+         * This property is not applicable to the RESTEasy Client.
+         */
+        @ConfigDocDefault("10s")
+        Optional<Duration> proxyConnectTimeout();
+
         /**
          * An enumerated type string value with possible values of "MULTI_PAIRS" (default), "COMMA_SEPARATED",
          * or "ARRAY_PAIRS" that specifies the format in which multiple values for the same query parameter is used.

extensions/resteasy-reactive/rest-client/runtime/src/main/java/io/quarkus/rest/client/reactive/QuarkusRestClientBuilder.java

@@ -3,6 +3,7 @@
 import java.net.URI;
 import java.net.URL;
 import java.security.KeyStore;
+import java.time.Duration;
 import java.util.ServiceLoader;
 import java.util.concurrent.TimeUnit;
 
@@ -226,6 +227,14 @@ static QuarkusRestClientBuilder newBuilder() {
      */
     QuarkusRestClientBuilder nonProxyHosts(String nonProxyHosts);
 
+    /**
+     * Specifies the connect timeout for the proxy connection
+     *
+     * @param connectTimeout proxy connect timeout.
+     * @return the current builder
+     */
+    QuarkusRestClientBuilder proxyConnectTimeout(Duration connectTimeout);
+
     /**
      * Specifies the URI formatting style to use when multiple query parameter values are passed to the client.
      *

extensions/resteasy-reactive/rest-client/runtime/src/main/java/io/quarkus/rest/client/reactive/runtime/QuarkusRestClientBuilderImpl.java

@@ -3,6 +3,7 @@
 import java.net.URI;
 import java.net.URL;
 import java.security.KeyStore;
+import java.time.Duration;
 import java.util.Map;
 import java.util.concurrent.TimeUnit;
 
@@ -127,6 +128,12 @@ public QuarkusRestClientBuilder nonProxyHosts(String nonProxyHosts) {
         return this;
     }
 
+    @Override
+    public QuarkusRestClientBuilder proxyConnectTimeout(Duration connectTimeout) {
+        delegate.proxyConnectTimeout(connectTimeout);
+        return this;
+    }
+
     @Override
     public QuarkusRestClientBuilder multipartPostEncoderMode(String mode) {
         delegate.multipartPostEncoderMode(mode);

extensions/resteasy-reactive/rest-client/runtime/src/main/java/io/quarkus/rest/client/reactive/runtime/RestClientBuilderImpl.java

@@ -7,6 +7,7 @@
 import java.net.URISyntaxException;
 import java.net.URL;
 import java.security.KeyStore;
+import java.time.Duration;
 import java.util.ArrayList;
 import java.util.Comparator;
 import java.util.List;
@@ -81,6 +82,7 @@ public class RestClientBuilderImpl implements RestClientBuilder {
     private String proxyUser;
     private String proxyPassword;
     private String nonProxyHosts;
+    private Duration proxyConnectTimeout;
 
     private ClientLogger clientLogger;
     private LoggingScope loggingScope;
@@ -237,6 +239,11 @@ public RestClientBuilderImpl nonProxyHosts(String nonProxyHosts) {
         return this;
     }
 
+    public RestClientBuilderImpl proxyConnectTimeout(Duration proxyConnectTimeout) {
+        this.proxyConnectTimeout = proxyConnectTimeout;
+        return this;
+    }
+
     public RestClientBuilderImpl multipartPostEncoderMode(String mode) {
         this.multipartPostEncoderMode = mode;
         return this;
@@ -568,11 +575,16 @@ public <T> T build(Class<T> aClass) throws IllegalStateException, RestClientDefi
         }
 
         if (proxyHost != null) {
-            configureProxy(proxyHost, proxyPort, proxyUser, proxyPassword, nonProxyHosts);
+            configureProxy(proxyHost, proxyPort, proxyUser, proxyPassword, nonProxyHosts, proxyConnectTimeout);
         } else if (restClients.proxyAddress().isPresent()) {
             HostAndPort globalProxy = ProxyAddressUtil.parseAddress(restClients.proxyAddress().get());
-            configureProxy(globalProxy.host, globalProxy.port, restClients.proxyUser().orElse(null),
-                    restClients.proxyPassword().orElse(null), restClients.nonProxyHosts().orElse(null));
+            configureProxy(
+                    globalProxy.host,
+                    globalProxy.port,
+                    restClients.proxyUser().orElse(null),
+                    restClients.proxyPassword().orElse(null),
+                    restClients.nonProxyHosts().orElse(null),
+                    restClients.proxyConnectTimeout().orElse(null));
         }
 
         if (!clientBuilder.getConfiguration().hasProperty(QuarkusRestClientProperties.MULTIPART_ENCODER_MODE)) {
@@ -604,7 +616,7 @@ public <T> T build(Class<T> aClass) throws IllegalStateException, RestClientDefi
     }
 
     private void configureProxy(String proxyHost, Integer proxyPort, String proxyUser, String proxyPassword,
-            String nonProxyHosts) {
+            String nonProxyHosts, Duration proxyConnectTimeout) {
         if (proxyHost != null) {
             clientBuilder.proxy(proxyHost, proxyPort);
             if (proxyUser != null && proxyPassword != null) {
@@ -615,6 +627,10 @@ private void configureProxy(String proxyHost, Integer proxyPort, String proxyUse
             if (nonProxyHosts != null) {
                 clientBuilder.nonProxyHosts(nonProxyHosts);
             }
+
+            if (proxyConnectTimeout != null) {
+                clientBuilder.proxyConnectTimeout(proxyConnectTimeout);
+            }
         }
     }
 

extensions/resteasy-reactive/rest-client/runtime/src/main/java/io/quarkus/rest/client/reactive/runtime/RestClientCDIDelegateBuilder.java

@@ -194,6 +194,8 @@ private void configureProxy(QuarkusRestClientBuilder builder) {
             oneOf(restClientConfig.proxyUser(), configRoot.proxyUser()).ifPresent(builder::proxyUser);
             oneOf(restClientConfig.proxyPassword(), configRoot.proxyPassword()).ifPresent(builder::proxyPassword);
             oneOf(restClientConfig.nonProxyHosts(), configRoot.nonProxyHosts()).ifPresent(builder::nonProxyHosts);
+            oneOf(restClientConfig.proxyConnectTimeout(), configRoot.proxyConnectTimeout())
+                    .ifPresent(builder::proxyConnectTimeout);
         }
     }
 

extensions/resteasy-reactive/rest-client/runtime/src/test/java/io/quarkus/rest/client/reactive/runtime/RestClientCDIDelegateBuilderTest.java

@@ -25,6 +25,7 @@
 import java.security.KeyStoreException;
 import java.security.NoSuchAlgorithmException;
 import java.security.cert.CertificateException;
+import java.time.Duration;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
@@ -134,6 +135,7 @@ public List<RegisteredRestClient> getRestClients() {
         verify(restClientBuilderMock).proxyUser("proxyUser1");
         verify(restClientBuilderMock).proxyPassword("proxyPassword1");
         verify(restClientBuilderMock).nonProxyHosts("nonProxyHosts1");
+        verify(restClientBuilderMock).proxyConnectTimeout(Duration.ofSeconds(20));
         verify(restClientBuilderMock).connectTimeout(100, MILLISECONDS);
         verify(restClientBuilderMock).readTimeout(101, MILLISECONDS);
         verify(restClientBuilderMock).userAgent("agent1");
@@ -188,6 +190,7 @@ public List<RegisteredRestClient> getRestClients() {
         verify(restClientBuilderMock).proxyUser("proxyUser2");
         verify(restClientBuilderMock).proxyPassword("proxyPassword2");
         verify(restClientBuilderMock).nonProxyHosts("nonProxyHosts2");
+        verify(restClientBuilderMock).proxyConnectTimeout(Duration.ofSeconds(30));
         verify(restClientBuilderMock).connectTimeout(200, MILLISECONDS);
         verify(restClientBuilderMock).readTimeout(201, MILLISECONDS);
         verify(restClientBuilderMock).userAgent("agent2");
@@ -215,6 +218,7 @@ private static Map<String, String> createSampleConfigRoot() {
         rootConfig.put("quarkus.rest-client.proxy-user", "proxyUser2");
         rootConfig.put("quarkus.rest-client.proxy-password", "proxyPassword2");
         rootConfig.put("quarkus.rest-client.non-proxy-hosts", "nonProxyHosts2");
+        rootConfig.put("quarkus.rest-client.proxy-connect-timeout", "30s");
         rootConfig.put("quarkus.rest-client.connect-timeout", "200");
         rootConfig.put("quarkus.rest-client.read-timeout", "201");
         rootConfig.put("quarkus.rest-client.user-agent", "agent2");
@@ -250,6 +254,7 @@ private static Map<String, String> createSampleClientConfig(final String restCli
         clientConfig.put("quarkus.rest-client." + restClientName + ".proxy-user", "proxyUser1");
         clientConfig.put("quarkus.rest-client." + restClientName + ".proxy-password", "proxyPassword1");
         clientConfig.put("quarkus.rest-client." + restClientName + ".non-proxy-hosts", "nonProxyHosts1");
+        clientConfig.put("quarkus.rest-client." + restClientName + ".proxy-connect-timeout", "20s");
         clientConfig.put("quarkus.rest-client." + restClientName + ".connect-timeout", "100");
         clientConfig.put("quarkus.rest-client." + restClientName + ".read-timeout", "101");
         clientConfig.put("quarkus.rest-client." + restClientName + ".user-agent", "agent1");

independent-projects/resteasy-reactive/client/runtime/src/main/java/org/jboss/resteasy/reactive/client/impl/ClientBuilderImpl.java

@@ -9,6 +9,7 @@
 import java.security.KeyStoreException;
 import java.security.NoSuchAlgorithmException;
 import java.security.cert.CertificateException;
+import java.time.Duration;
 import java.util.List;
 import java.util.Map;
 import java.util.Optional;
@@ -56,6 +57,7 @@ public class ClientBuilderImpl extends ClientBuilder {
     private String proxyPassword;
     private String proxyUser;
     private String nonProxyHosts;
+    private Duration proxyConnectTimeout;
 
     private boolean followRedirects;
 
@@ -255,6 +257,9 @@ public ClientImpl build() {
                 if (proxyUser != null && !proxyUser.isBlank()) {
                     proxyOptions.setUsername(proxyUser);
                 }
+                if (proxyConnectTimeout != null) {
+                    proxyOptions.setConnectTimeout(proxyConnectTimeout);
+                }
                 options.setProxyOptions(proxyOptions);
                 configureNonProxyHosts(options, nonProxyHosts);
             }
@@ -491,4 +496,9 @@ public ClientBuilderImpl nonProxyHosts(String nonProxyHosts) {
         this.nonProxyHosts = nonProxyHosts;
         return this;
     }
+
+    public ClientBuilderImpl proxyConnectTimeout(Duration proxyConnectTimeout) {
+        this.proxyConnectTimeout = proxyConnectTimeout;
+        return this;
+    }
 }