Add httpReadTimeout and httpConnectTimeout config to K8s client [ci fast]

Signed-off-by: naineshmp <pnainesh18@gmail.com>
Signed-off-by: Paolo Di Tommaso <paolo.ditommaso@gmail.com>

Author: pditommaso

docs/config.rst

@@ -423,6 +423,8 @@ storageSubPath      The path in the persistent volume to be mounted (default: ro
 computeResourceType Define whether use Kubernetes ``Pod`` or ``Job`` resource type to carry out Nextflow tasks (default: ``Pod``).
 fetchNodeName       If you trace the hostname, activate this option (default: ``false``, requires version ``22.05.0-edge`` or later).
 volumeClaims        (deprecated)
+httpReadTimeout     Defines the Kubernetes client request HTTP connection read timeout e.g. ``'60s'`` (requires version ``22.10.0`` or later).
+httpConnectTimeout  Defines the Kubernetes client request HTTP connection timeout e.g. ``'60s'`` (requires version ``22.10.0`` or later).
 =================== ================
 
 See the :ref:`k8s-page` documentation for more details.

modules/nextflow/src/main/groovy/nextflow/k8s/K8sConfig.groovy

@@ -30,6 +30,7 @@ import nextflow.k8s.model.PodOptions
 import nextflow.k8s.model.PodSecurityContext
 import nextflow.k8s.model.PodVolumeClaim
 import nextflow.k8s.model.ResourceType
+import nextflow.util.Duration
 
 /**
  * Model Kubernetes specific settings defined in the nextflow
@@ -203,7 +204,6 @@ class K8sConfig implements Map<String,Object> {
         return result ? result.claimName : null
     }
 
-
     @Memoized
     ClientConfig getClient() {
 
@@ -220,6 +220,12 @@ class K8sConfig implements Map<String,Object> {
             result.serviceAccount = target.serviceAccount as String
         }
 
+        if( target.httpConnectTimeout )
+            result.httpConnectTimeout = target.httpConnectTimeout as Duration
+
+        if( target.httpReadTimeout )
+            result.httpReadTimeout = target.httpReadTimeout as Duration
+
         return result
     }
 

modules/nextflow/src/main/groovy/nextflow/k8s/client/ClientConfig.groovy

@@ -16,6 +16,9 @@
  */
 
 package nextflow.k8s.client
+
+import nextflow.util.Duration
+
 import javax.net.ssl.KeyManager
 import java.nio.file.Path
 import java.nio.file.Paths
@@ -53,6 +56,18 @@ class ClientConfig {
 
     KeyManager[] keyManagers
 
+    /**
+     * Timeout when reading from Input stream when a connection is established to a resource.
+     * If the timeout expires before there is data available for read, a {@link java.net.SocketTimeoutException} is raised
+     */
+    Duration httpReadTimeout
+
+    /**
+     * Timeout when opening a communications link to the resource referenced by K8sClient request connection
+     * If the timeout expires before there is data available for read, a {@link java.net.SocketTimeoutException} is raised
+     */
+    Duration httpConnectTimeout
+
     /**
      * When true signal that the configuration was retrieved from within a K8s cluster
      */
@@ -65,7 +80,7 @@ class ClientConfig {
     }
 
     String toString() {
-        "${this.class.getSimpleName()}[ server=$server, namespace=$namespace, token=${cut(token)}, sslCert=${cut(sslCert)}, clientCert=${cut(clientCert)}, clientKey=${cut(clientKey)}, verifySsl=$verifySsl, fromFile=$isFromCluster ]"
+        "${this.class.getSimpleName()}[ server=$server, namespace=$namespace, token=${cut(token)}, sslCert=${cut(sslCert)}, clientCert=${cut(clientCert)}, clientKey=${cut(clientKey)}, verifySsl=$verifySsl, fromFile=$isFromCluster, httpReadTimeout=$httpReadTimeout, httpConnectTimeout=$httpConnectTimeout ]"
     }
 
     private String cut(String str) {

modules/nextflow/src/main/groovy/nextflow/k8s/client/K8sClient.groovy

@@ -590,6 +590,12 @@ class K8sClient {
     }
 
     protected void setupHttpsConn( HttpsURLConnection conn ) {
+        if (config.httpReadTimeout != null) {
+            conn.setReadTimeout(config.httpReadTimeout.toMillis() as int)
+        }
+        if (config.httpConnectTimeout != null) {
+            conn.setConnectTimeout(config.httpConnectTimeout.toMillis() as int)
+        }
         if (config.keyManagers != null || trustManagers != null) {
             SSLContext sslContext = SSLContext.getInstance("TLS");
             sslContext.init(config.keyManagers, trustManagers, new SecureRandom());

modules/nextflow/src/test/groovy/nextflow/k8s/K8sConfigTest.groovy

@@ -22,6 +22,7 @@ import nextflow.k8s.client.ClientConfig
 import nextflow.k8s.model.PodEnv
 import nextflow.k8s.model.PodSecurityContext
 import nextflow.k8s.model.PodVolumeClaim
+import nextflow.util.Duration
 import spock.lang.Specification
 /**
  *
@@ -140,6 +141,30 @@ class K8sConfigTest extends Specification {
         client.server == 'http://foo'
         client.namespace == 'this'
         client.serviceAccount == 'that'
+        client.httpConnectTimeout == null // testing default null
+        client.httpReadTimeout == null // testing default null
+
+    }
+
+    def 'should create client config with http request timeouts' () {
+
+        given:
+        def CONFIG = [
+                namespace: 'this',
+                serviceAccount: 'that',
+                client: [server: 'http://foo'],
+                httpReadTimeout: '20s',
+                httpConnectTimeout: '25s' ]
+
+        when:
+        def config = new K8sConfig(CONFIG)
+        def client = config.getClient()
+        then:
+        client.server == 'http://foo'
+        client.namespace == 'this'
+        client.serviceAccount == 'that'
+        client.httpConnectTimeout == Duration.of('25s')
+        client.httpReadTimeout == Duration.of('20s')
 
     }