feat: (WIP) add writeTimeout and queryTimeout to ClientConfig. Properties added. Next, apply in transports.

Author: karel-rehor

src/main/java/com/influxdb/v3/client/config/ClientConfig.java

@@ -54,7 +54,11 @@
  *     <li><code>defaultTags</code> - defaultTags added when writing points to InfluxDB</li>
  *     <li><code>gzipThreshold</code> - threshold when gzip compression is used for writing points to InfluxDB</li>
  *     <li><code>writeNoSync</code> - skip waiting for WAL persistence on write</li>
- *     <li><code>responseTimeout</code> - timeout when connecting to InfluxDB</li>
+ *     <li><code>timeout</code> - <i>deprecated in 1.3.0</i> timeout when connecting to InfluxDB,
+ *     please use more informative properties <code>writeTimeout</code> and <code>queryTimeout</code></li>
+ *     <li><code>writeTimeout</code> - timeout when writing data to InfluxDB</li>
+ *     <li><code>queryTimeout</code> - timeout used to calculate a default GRPC deadline when querying InfluxDB.
+ *     Can be <code>null</code>, in which case queries can potentially run forever.</li>
  *     <li><code>allowHttpRedirects</code> - allow redirects for InfluxDB connections</li>
  *     <li><code>disableServerCertificateValidation</code> -
  *          disable server certificate validation for HTTPS connections
@@ -100,6 +104,8 @@ public final class ClientConfig {
     private final Boolean writeNoSync;
     private final Map<String, String> defaultTags;
     private final Duration timeout;
+    private final Duration writeTimeout;
+    private final Duration queryTimeout;
     private final Boolean allowHttpRedirects;
     private final Boolean disableServerCertificateValidation;
     private final String proxyUrl;
@@ -212,6 +218,28 @@ public Duration getTimeout() {
         return timeout;
     }
 
+    /**
+     * Gets the default timeout in seconds to use for REST Write API calls.  Default is
+     * {@value com.influxdb.v3.client.write.WriteOptions#DEFAULT_WRITE_TIMEOUT}
+     *
+     * @return the default timeout in seconds to use for REST Write API calls.
+     */
+    @Nonnull
+    public Duration getWriteTimeout() {
+        return writeTimeout;
+    }
+
+    /**
+     * Gets the default timeout in seconds to use for calculating a GRPC Deadline when making Query API calls.
+     * Can be null, in which case queries can potentially wait or run forever.
+     *
+     * @return the default timeout in seconds to use for Query API calls.
+     */
+    @Nullable
+    public Duration getQueryTimeout() {
+        return queryTimeout;
+    }
+
     /**
      * Gets the automatically following HTTP 3xx redirects. Default to 'false'.
      *
@@ -312,6 +340,8 @@ public boolean equals(final Object o) {
                 && Objects.equals(writeNoSync, that.writeNoSync)
                 && Objects.equals(defaultTags, that.defaultTags)
                 && Objects.equals(timeout, that.timeout)
+                && Objects.equals(writeTimeout, that.writeTimeout)
+                && Objects.equals(queryTimeout, that.queryTimeout)
                 && Objects.equals(allowHttpRedirects, that.allowHttpRedirects)
                 && Objects.equals(disableServerCertificateValidation, that.disableServerCertificateValidation)
                 && Objects.equals(proxy, that.proxy)
@@ -325,7 +355,7 @@ public boolean equals(final Object o) {
     public int hashCode() {
         return Objects.hash(host, Arrays.hashCode(token), authScheme, organization,
                 database, writePrecision, gzipThreshold, writeNoSync,
-                timeout, allowHttpRedirects, disableServerCertificateValidation,
+                timeout, writeTimeout, queryTimeout, allowHttpRedirects, disableServerCertificateValidation,
                 proxy, proxyUrl, authenticator, headers,
                 defaultTags, sslRootsFilePath);
     }
@@ -340,6 +370,8 @@ public String toString() {
                 .add("gzipThreshold=" + gzipThreshold)
                 .add("writeNoSync=" + writeNoSync)
                 .add("timeout=" + timeout)
+                .add("writeTimeout=" + writeTimeout)
+                .add("queryTimeout=" + queryTimeout)
                 .add("allowHttpRedirects=" + allowHttpRedirects)
                 .add("disableServerCertificateValidation=" + disableServerCertificateValidation)
                 .add("proxy=" + proxy)
@@ -367,6 +399,8 @@ public static final class Builder {
         private Boolean writeNoSync;
         private Map<String, String> defaultTags;
         private Duration timeout;
+        private Duration writeTimeout;
+        private Duration queryTimeout;
         private Boolean allowHttpRedirects;
         private Boolean disableServerCertificateValidation;
         private ProxySelector proxy;
@@ -497,17 +531,50 @@ public Builder defaultTags(@Nullable final Map<String, String> defaultTags) {
 
         /**
          * Sets the default timeout to use for the API calls. Default to '10 seconds'.
+         * <p>
+         * Note that this parameter is being superseded by clearer writeTimeout.
          *
          * @param timeout default timeout to use for the API calls. Default to '10 seconds'.
          * @return this
          */
+        @Deprecated
         @Nonnull
         public Builder timeout(@Nullable final Duration timeout) {
 
             this.timeout = timeout;
             return this;
         }
 
+        /**
+         *  Sets the default writeTimeout to use for Write API calls in the REST client.
+         *  Default is {@value com.influxdb.v3.client.write.WriteOptions#DEFAULT_WRITE_TIMEOUT}
+         *
+         * @param writeTimeout default timeout to use for REST API write calls. Default is
+         * {@value com.influxdb.v3.client.write.WriteOptions#DEFAULT_WRITE_TIMEOUT}
+         * @return - this
+         */
+        @Nonnull
+        public Builder writeTimeout(@Nullable final Duration writeTimeout) {
+
+          this.writeTimeout = writeTimeout;
+          return this;
+        }
+
+        /**
+         * Sets standard query timeout used to calculate a GRPC deadline when making Query API calls.
+         * If <code>null</code>, queries can potentially wait or run forever.
+         *
+         * @param queryTimeout default timeout used to calculate deadline for Query API calls.
+         *                     If <code>null</code>, queries can potentially wait or run forever.
+         *                     Default value is <code>null</code>.
+         * @return this
+         */
+        @Nonnull
+        public Builder queryTimeout(@Nullable final Duration queryTimeout) {
+          this.queryTimeout = queryTimeout;
+          return this;
+        }
+
         /**
          * Sets the automatically following HTTP 3xx redirects. Default to 'false'.
          *
@@ -719,6 +786,16 @@ public ClientConfig build(@Nonnull final Map<String, String> env, final Properti
             if (writeNoSync != null) {
                 this.writeNoSync(Boolean.parseBoolean(writeNoSync));
             }
+            final String writeTimeout = get.apply("INFLUX_WRITE_TIMEOUT", "influx.writeTimeout");
+            if (writeTimeout != null) {
+                long to = Long.parseLong(writeTimeout);
+                this.writeTimeout(Duration.ofSeconds(to));
+            }
+            final String queryTimeout = get.apply("INFLUX_QUERY_TIMEOUT", "influx.queryTimeout");
+            if (queryTimeout != null) {
+                long to = Long.parseLong(queryTimeout);
+                this.queryTimeout(Duration.ofSeconds(to));
+            }
 
             return new ClientConfig(this);
         }
@@ -761,7 +838,10 @@ private ClientConfig(@Nonnull final Builder builder) {
         gzipThreshold = builder.gzipThreshold != null ? builder.gzipThreshold : WriteOptions.DEFAULT_GZIP_THRESHOLD;
         writeNoSync = builder.writeNoSync != null ? builder.writeNoSync : WriteOptions.DEFAULT_NO_SYNC;
         defaultTags = builder.defaultTags;
-        timeout = builder.timeout != null ? builder.timeout : Duration.ofSeconds(10);
+        timeout = builder.timeout != null ? builder.timeout : Duration.ofSeconds(WriteOptions.DEFAULT_WRITE_TIMEOUT);
+        writeTimeout = builder.writeTimeout != null
+            ? builder.writeTimeout : Duration.ofSeconds(WriteOptions.DEFAULT_WRITE_TIMEOUT);
+        queryTimeout = builder.queryTimeout;
         allowHttpRedirects = builder.allowHttpRedirects != null ? builder.allowHttpRedirects : false;
         disableServerCertificateValidation = builder.disableServerCertificateValidation != null
                 ? builder.disableServerCertificateValidation : false;

src/main/java/com/influxdb/v3/client/write/WriteOptions.java

@@ -65,10 +65,17 @@ public final class WriteOptions {
      * Default NoSync.
      */
     public static final boolean DEFAULT_NO_SYNC = false;
-    /**
+
+  /**
+   * Default timeout for writes in seconds. Set to {@value}
+   */
+  public static final int DEFAULT_WRITE_TIMEOUT = 10;
+
+  /**
      * Default WriteOptions.
      * Deprecated use {@link #defaultWriteOptions} instead
      */
+
     @Deprecated(forRemoval = true)
     public static final WriteOptions DEFAULTS = new WriteOptions(
             null, DEFAULT_WRITE_PRECISION, DEFAULT_GZIP_THRESHOLD, DEFAULT_NO_SYNC, null, null);

src/test/java/com/influxdb/v3/client/config/ClientConfigTest.java

@@ -42,6 +42,8 @@ class ClientConfigTest {
             .database("my-db")
             .writePrecision(WritePrecision.NS)
             .timeout(Duration.ofSeconds(30))
+            .writeTimeout(Duration.ofSeconds(30))
+            .queryTimeout(Duration.ofSeconds(120))
             .allowHttpRedirects(true)
             .disableServerCertificateValidation(true)
             .headers(Map.of("X-device", "ab-01"));
@@ -241,6 +243,24 @@ void fromEnvLongPrecision() {
         Assertions.assertThat(cfg.getWritePrecision()).isEqualTo(WritePrecision.S);
     }
 
+    @Test
+    void timeoutsFromEnv() {
+        Map<String, String> env = Map.of(
+            "INFLUX_HOST", "http://localhost:9999/",
+            "INFLUX_TOKEN", "my-token",
+            "INFLUX_WRITE_TIMEOUT", "45",
+            "INFLUX_QUERY_TIMEOUT", "180");
+
+        Duration writeTimeout = Duration.ofSeconds(45);
+        Duration queryTimeout = Duration.ofSeconds(180);
+        ClientConfig cfg = new ClientConfig.Builder().build(env, null);
+        Assertions.assertThat(cfg.getHost()).isEqualTo("http://localhost:9999/");
+        Assertions.assertThat(cfg.getToken()).isEqualTo("my-token".toCharArray());
+        Assertions.assertThat(cfg.getWriteTimeout()).isEqualTo(writeTimeout);
+        Assertions.assertThat(cfg.getQueryTimeout()).isEqualTo(queryTimeout);
+
+    }
+
     @Test
     void fromSystemProperties() {
         // minimal
@@ -335,4 +355,24 @@ void fromSystemPropertiesLongPrecision() throws MalformedURLException {
         Assertions.assertThat(cfg.getWritePrecision()).isEqualTo(WritePrecision.S);
     }
 
+    @Test
+    void fromSystemPropertiesTimeouts() {
+        Properties props = new Properties();
+        props.put("influx.host", "http://localhost:9999/");
+        props.put("influx.token", "my-token");
+        props.put("influx.writeTimeout", "20");
+        props.put("influx.queryTimeout", "300");
+
+        ClientConfig cfg = new ClientConfig.Builder().build(new HashMap<>(), props);
+
+        Duration writeTimeout = Duration.ofSeconds(20);
+        Duration queryTimeout = Duration.ofSeconds(300);
+
+        Assertions.assertThat(cfg.getHost()).isEqualTo("http://localhost:9999/");
+        Assertions.assertThat(cfg.getToken()).isEqualTo("my-token".toCharArray());
+        Assertions.assertThat(cfg.getWriteTimeout()).isEqualTo(writeTimeout);
+        Assertions.assertThat(cfg.getQueryTimeout()).isEqualTo(queryTimeout);
+
+    }
+
 }