feat: url to connect to the InfluxDB is always evaluate as a connection string (#335)

Author: bednar

CHANGELOG.md

@@ -67,6 +67,7 @@ This release also uses new version of InfluxDB OSS API definitions - [oss.yml](h
 1. [#315](https://github.com/influxdata/influxdb-client-java/pull/315): Add support for timezones [FluxDSL]
 1. [#317](https://github.com/influxdata/influxdb-client-java/pull/317): Gets HTTP headers from the unsuccessful HTTP request
 1. [#334](https://github.com/influxdata/influxdb-client-java/pull/334): Supports not operator [FluxDSL]
+1. [#335](https://github.com/influxdata/influxdb-client-java/pull/335): URL to connect to the InfluxDB is always evaluate as a connection string
 1. [#329](https://github.com/influxdata/influxdb-client-java/pull/329): Add support for write `consistency` parameter [InfluxDB Enterprise]
 
     Configure `consistency` via `Write API`:

client-kotlin/src/main/kotlin/com/influxdb/client/kotlin/InfluxDBClientKotlinFactory.kt

@@ -50,9 +50,12 @@ class InfluxDBClientKotlinFactory {
         }
 
         /**
-         * Create an instance of the InfluxDB 2.x client. The url could be a connection string with various configurations.
+         * Create an instance of the InfluxDB 2.x client.
          *
-         * e.g.: "http://localhost:8086?readTimeout=5000&connectTimeout=5000&logLevel=BASIC
+         * <p>
+         * The url could be a connection string with various configurations. For more info
+         * see: {@link InfluxDBClientOptions.Builder#connectionString(String)}.
+         * </p>
          *
          * @param connectionString connection string with various configurations.
          * @return client
@@ -76,7 +79,12 @@ class InfluxDBClientKotlinFactory {
          * and client produces {@link com.influxdb.exceptions.UnauthorizedException}.
          * </p>
          *
-         * @param url      the url to connect to the InfluxDB
+         * <p>
+         * The url could be a connection string with various configurations. For more info
+         * see: {@link InfluxDBClientOptions.Builder#connectionString(String)}.
+         * </p>
+         *
+         * @param url      the url to connect to InfluxDB (required). Example: http://localhost:8086?readTimeout=5000
          * @param username the username to use in the basic auth
          * @param password the password to use in the basic auth
          * @return client
@@ -97,7 +105,12 @@ class InfluxDBClientKotlinFactory {
         /**
          * Create an instance of the InfluxDB 2.x reactive client.
          *
-         * @param url   the url to connect to the InfluxDB
+         * <p>
+         * The url could be a connection string with various configurations. For more info
+         * see: {@link InfluxDBClientOptions.Builder#connectionString(String)}.
+         * </p>
+         *
+         * @param url   the url to connect to InfluxDB (required). Example: http://localhost:8086?readTimeout=5000
          * @param token the token to use for the authorization
          * @return client
          * @see InfluxDBClientOptions.Builder.url
@@ -110,7 +123,12 @@ class InfluxDBClientKotlinFactory {
         /**
          * Create an instance of the InfluxDB 2.x reactive client.
          *
-         * @param url   the url to connect to the InfluxDB
+         * <p>
+         * The url could be a connection string with various configurations. For more info
+         * see: {@link InfluxDBClientOptions.Builder#connectionString(String)}.
+         * </p>
+         *
+         * @param url   the url to connect to InfluxDB (required). Example: http://localhost:8086?readTimeout=5000
          * @param token the token to use for the authorization
          * @param org    the name of an organization
          * @return client
@@ -124,7 +142,12 @@ class InfluxDBClientKotlinFactory {
         /**
          * Create an instance of the InfluxDB 2.x reactive client.
          *
-         * @param url   the url to connect to the InfluxDB
+         * <p>
+         * The url could be a connection string with various configurations. For more info
+         * see: {@link InfluxDBClientOptions.Builder#connectionString(String)}.
+         * </p>
+         *
+         * @param url   the url to connect to InfluxDB (required). Example: http://localhost:8086?readTimeout=5000
          * @param token the token to use for the authorization
          * @param org    the name of an organization
          * @param bucket the name of a bucket

client-kotlin/src/test/kotlin/com/influxdb/client/kotlin/InfluxDBClientKotlinFactoryTest.kt

@@ -76,4 +76,13 @@ class InfluxDBClientKotlinFactoryTest : AbstractTest() {
             Assertions.assertThat(it).isNotNull
         }
     }
+
+    @Test
+    @Throws(NoSuchFieldException::class, IllegalAccessException::class)
+    fun connectionStringConfiguration() {
+        val client = InfluxDBClientKotlinFactory.create("http://localhost:8086?connectTimeout=45000", "xyz".toCharArray())
+        val retrofit = getDeclaredField<Retrofit>(client, "retrofit", AbstractInfluxDBClient::class.java)
+        val okHttpClient = retrofit.callFactory() as OkHttpClient
+        Assertions.assertThat(okHttpClient.connectTimeoutMillis).isEqualTo(45000)
+    }
 }

client-reactive/src/main/java/com/influxdb/client/reactive/InfluxDBClientReactiveFactory.java

@@ -55,9 +55,12 @@ public static InfluxDBClientReactive create() {
     }
 
     /**
-     * Create an instance of the InfluxDB 2.x client. The url could be a connection string with various configurations.
+     * Create an instance of the InfluxDB 2.x client.
+     *
      * <p>
-     * e.g.: "http://localhost:8086?readTimeout=5000&amp;connectTimeout=5000&amp;logLevel=BASIC
+     * The url could be a connection string with various configurations. For more info
+     * see: {@link InfluxDBClientOptions.Builder#connectionString(String)}.
+     * </p>
      *
      * @param connectionString connection string with various configurations.
      * @return client
@@ -82,7 +85,12 @@ public static InfluxDBClientReactive create(@Nonnull final String connectionStri
      * and client produces {@link com.influxdb.exceptions.UnauthorizedException}.
      * </p>
      *
-     * @param url      the url to connect to the InfluxDB
+     * <p>
+     * The url could be a connection string with various configurations. For more info
+     * see: {@link InfluxDBClientOptions.Builder#connectionString(String)}.
+     * </p>
+     *
+     * @param url      url the url to connect to InfluxDB (required). Example: http://localhost:8086?readTimeout=5000
      * @param username the username to use in the basic auth
      * @param password the password to use in the basic auth
      * @return client
@@ -104,7 +112,12 @@ public static InfluxDBClientReactive create(@Nonnull final String url,
     /**
      * Create an instance of the InfluxDB 2.x reactive client.
      *
-     * @param url   the url to connect to the InfluxDB
+     * <p>
+     * The url could be a connection string with various configurations. For more info
+     * see: {@link InfluxDBClientOptions.Builder#connectionString(String)}.
+     * </p>
+     *
+     * @param url   url the url to connect to InfluxDB (required). Example: http://localhost:8086?readTimeout=5000
      * @param token the token to use for the authorization
      * @return client
      * @see InfluxDBClientOptions.Builder#url(String)
@@ -118,7 +131,12 @@ public static InfluxDBClientReactive create(@Nonnull final String url, @Nonnull
     /**
      * Create an instance of the InfluxDB 2.x reactive client.
      *
-     * @param url   the url to connect to the InfluxDB
+     * <p>
+     * The url could be a connection string with various configurations. For more info
+     * see: {@link InfluxDBClientOptions.Builder#connectionString(String)}.
+     * </p>
+     *
+     * @param url   url the url to connect to InfluxDB (required). Example: http://localhost:8086?readTimeout=5000
      * @param token the token to use for the authorization
      * @param org   the name of an organization
      * @return client
@@ -135,7 +153,12 @@ public static InfluxDBClientReactive create(@Nonnull final String url,
     /**
      * Create an instance of the InfluxDB 2.x reactive client.
      *
-     * @param url    the url to connect to the InfluxDB
+     * <p>
+     * The url could be a connection string with various configurations. For more info
+     * see: {@link InfluxDBClientOptions.Builder#connectionString(String)}.
+     * </p>
+     *
+     * @param url    url the url to connect to InfluxDB (required). Example: http://localhost:8086?readTimeout=5000
      * @param token  the token to use for the authorization
      * @param org    the name of an organization
      * @param bucket the name of a bucket

client-reactive/src/test/java/com/influxdb/client/reactive/InfluxDBClientReactiveFactoryTest.java

@@ -91,4 +91,16 @@ public void autoClosable() {
             Assertions.assertThat(client).isNotNull();
         } 
     }
+
+    @Test
+    void connectionStringConfiguration() throws NoSuchFieldException, IllegalAccessException {
+        InfluxDBClientReactive client = InfluxDBClientReactiveFactory.create("http://localhost:8086?readTimeout=15000", "xyz".toCharArray());
+
+        Assertions.assertThat(client).isNotNull();
+
+        Retrofit retrofit = getDeclaredField(client, "retrofit", AbstractInfluxDBClient.class);
+        OkHttpClient okHttpClient = (OkHttpClient) retrofit.callFactory();
+
+        Assertions.assertThat(okHttpClient.readTimeoutMillis()).isEqualTo(15_000);
+    }
 }

client-reactive/src/test/java/com/influxdb/client/reactive/QueryReactiveApiTest.java

@@ -22,10 +22,13 @@
 package com.influxdb.client.reactive;
 
 import java.io.InterruptedIOException;
+import java.util.ArrayList;
+import java.util.List;
 import java.util.concurrent.Executors;
 import java.util.concurrent.Future;
 import java.util.concurrent.TimeUnit;
 
+import com.influxdb.exceptions.InfluxException;
 import com.influxdb.test.AbstractMockServerTest;
 
 import io.reactivex.rxjava3.core.Flowable;
@@ -64,7 +67,7 @@ public void doNotPropagateErrorOnCanceledConsumer() throws InterruptedException
 
         QueryReactiveApi queryApi = influxDBClient.getQueryReactiveApi();
 
-        final Throwable[] throwable = new Throwable[1];
+        final List<Throwable> throwable = new ArrayList<>();
         Future<?> future = Executors
                 .newSingleThreadScheduledExecutor()
                 .scheduleWithFixedDelay(() -> Flowable
@@ -73,14 +76,14 @@ public void doNotPropagateErrorOnCanceledConsumer() throws InterruptedException
                                         s -> {
 
                                         },
-                                        t -> throwable[0] = t),
+                                        throwable::add),
                         0, 1, TimeUnit.SECONDS);
 
         Thread.sleep(2_000);
         future.cancel(true);
         Thread.sleep(2_000);
 
-        Assertions.assertThat(throwable[0]).isNotNull();
-        Assertions.assertThat(throwable[0]).isInstanceOf(InterruptedIOException.class);
+        Assertions.assertThat(throwable).isNotEmpty();
+        Assertions.assertThat(throwable).hasOnlyElementsOfTypes(InterruptedIOException.class, InfluxException.class);
     }
 }

client-scala/src/main/scala/com/influxdb/client/scala/InfluxDBClientScalaFactory.scala

@@ -51,9 +51,10 @@ object InfluxDBClientScalaFactory {
   }
 
   /**
-   * Create an instance of the InfluxDB 2.x client. The url could be a connection string with various configurations.
+   * Create an instance of the InfluxDB 2.x client.
    *
-   * e.g.: "http://localhost:8086?readTimeout=5000&connectTimeout=5000&logLevel=BASIC
+   * The url could be a connection string with various configurations. For more info
+   * see: [[InfluxDBClientOptions.Builder#connectionString(connectionString:java.lang.String)]].
    *
    * @param connectionString connection string with various configurations.
    * @return client
@@ -75,7 +76,10 @@ object InfluxDBClientScalaFactory {
    * [[http://bit.ly/session-length time-to-live (TTL)]] (default 60 minutes) is reached
    * and client produces [[com.influxdb.exceptions.UnauthorizedException]].
    *
-   * @param url      the url to connect to the InfluxDB
+   * The url could be a connection string with various configurations. For more info
+   * see: [[InfluxDBClientOptions.Builder#connectionString(connectionString:java.lang.String)]].
+   *
+   * @param url      the url the url to connect to InfluxDB (required). Example: http://localhost:8086?readTimeout=5000
    * @param username the username to use in the basic auth
    * @param password the password to use in the basic auth
    * @return client
@@ -94,7 +98,10 @@ object InfluxDBClientScalaFactory {
   /**
    * Create an instance of the InfluxDB 2.x reactive client.
    *
-   * @param url   the url to connect to the InfluxDB
+   * The url could be a connection string with various configurations. For more info
+   * see: [[InfluxDBClientOptions.Builder#connectionString(connectionString:java.lang.String)]].
+   *
+   * @param url   the url the url to connect to InfluxDB (required). Example: http://localhost:8086?readTimeout=5000
    * @param token the token to use for the authorization
    * @return client
    * @see [[InfluxDBClientOptions.Builder]]
@@ -107,7 +114,10 @@ object InfluxDBClientScalaFactory {
   /**
    * Create an instance of the InfluxDB 2.x reactive client.
    *
-   * @param url   the url to connect to the InfluxDB
+   * The url could be a connection string with various configurations. For more info
+   * see: [[InfluxDBClientOptions.Builder#connectionString(connectionString:java.lang.String)]].
+   *
+   * @param url   the url the url to connect to InfluxDB (required). Example: http://localhost:8086?readTimeout=5000
    * @param token the token to use for the authorization
    * @param org      the name of an organization
    * @return client
@@ -121,7 +131,10 @@ object InfluxDBClientScalaFactory {
   /**
    * Create an instance of the InfluxDB 2.x reactive client.
    *
-   * @param url   the url to connect to the InfluxDB
+   * The url could be a connection string with various configurations. For more info
+   * see: [[InfluxDBClientOptions.Builder#connectionString(connectionString:java.lang.String)]].
+   *
+   * @param url   the url the url to connect to InfluxDB (required). Example: http://localhost:8086?readTimeout=5000
    * @param token the token to use for the authorization
    * @param org      the name of an organization
    * @param bucket   the name of a bucket

client-scala/src/test/scala/com/influxdb/client/scala/InfluxDBClientScalaFactoryTest.scala

@@ -62,4 +62,16 @@ class InfluxDBClientScalaFactoryTest extends AnyFunSuite with Matchers {
     okHttpClient.writeTimeoutMillis should be(10000)
     okHttpClient.connectTimeoutMillis should be(18000)
   }
+
+  test("connectionStringConfiguration") {
+
+    val utils = new InfluxDBUtils {}
+
+    val client = InfluxDBClientScalaFactory.create("http://localhost:8086?readTimeout=55000", "xyz".toCharArray)
+
+    val retrofit = utils.getDeclaredField(client, "retrofit", classOf[AbstractInfluxDBClient]).asInstanceOf[Retrofit]
+    val okHttpClient = retrofit.callFactory.asInstanceOf[OkHttpClient]
+
+    okHttpClient.readTimeoutMillis should be(55000)
+  }
 }

client/src/main/java/com/influxdb/client/InfluxDBClientFactory.java

@@ -84,7 +84,12 @@ public static InfluxDBClient create(@Nonnull final String connectionString) {
      * and client produces {@link com.influxdb.exceptions.UnauthorizedException}.
      * </p>
      *
-     * @param url      the url to connect to the InfluxDB
+     * <p>
+     * The url could be a connection string with various configurations. For more info
+     * see: {@link InfluxDBClientOptions.Builder#connectionString(String)}.
+     * </p>
+     *
+     * @param url      url the url to connect to InfluxDB (required). Example: http://localhost:8086?readTimeout=5000
      * @param username the username to use in the basic auth
      * @param password the password to use in the basic auth
      * @return client
@@ -106,7 +111,12 @@ public static InfluxDBClient create(@Nonnull final String url,
     /**
      * Create an instance of the InfluxDB 2.x client.
      *
-     * @param url   the url to connect to the InfluxDB
+     * <p>
+     * The url could be a connection string with various configurations. For more info
+     * see: {@link InfluxDBClientOptions.Builder#connectionString(String)}.
+     * </p>
+     *
+     * @param url   url the url to connect to InfluxDB (required). Example: http://localhost:8086?readTimeout=5000
      * @param token the token to use for the authorization
      * @return client
      * @see InfluxDBClientOptions.Builder#url(String)
@@ -120,7 +130,12 @@ public static InfluxDBClient create(@Nonnull final String url, @Nonnull final ch
     /**
      * Create an instance of the InfluxDB 2.x client.
      *
-     * @param url   the url to connect to the InfluxDB
+     * <p>
+     * The url could be a connection string with various configurations. For more info
+     * see: {@link InfluxDBClientOptions.Builder#connectionString(String)}.
+     * </p>
+     *
+     * @param url   url the url to connect to InfluxDB (required). Example: http://localhost:8086?readTimeout=5000
      * @param token the token to use for the authorization
      * @param org   the name of an organization
      * @return client
@@ -137,7 +152,12 @@ public static InfluxDBClient create(@Nonnull final String url,
     /**
      * Create an instance of the InfluxDB 2.x client.
      *
-     * @param url    the url to connect to the InfluxDB
+     * <p>
+     * The url could be a connection string with various configurations. For more info
+     * see: {@link InfluxDBClientOptions.Builder#connectionString(String)}.
+     * </p>
+     *
+     * @param url    url the url to connect to InfluxDB (required). Example: http://localhost:8086?readTimeout=5000
      * @param token  the token to use for the authorization
      * @param org    the name of an organization
      * @param bucket the name of a bucket
@@ -163,7 +183,12 @@ public static InfluxDBClient create(@Nonnull final String url,
     /**
      * Create an instance of the InfluxDB 2.x client to connect into InfluxDB 1.8.
      *
-     * @param url             the url to connect to the InfluxDB 1.8
+     * <p>
+     * The url could be a connection string with various configurations. For more info
+     * see: {@link InfluxDBClientOptions.Builder#connectionString(String)}.
+     * </p>
+     *
+     * @param url             the url to connect to InfluxDB 1.8 (required). http://localhost:8086?readTimeout=5000
      * @param username        authorization username
      * @param password        authorization password
      * @param database        database name
@@ -182,7 +207,12 @@ public static InfluxDBClient createV1(@Nonnull final String url,
     /**
      * Create an instance of the InfluxDB 2.x client to connect into InfluxDB 1.8.
      *
-     * @param url             the url to connect to the InfluxDB 1.8
+     * <p>
+     * The url could be a connection string with various configurations. For more info
+     * see: {@link InfluxDBClientOptions.Builder#connectionString(String)}.
+     * </p>
+     *
+     * @param url             the url to connect to InfluxDB 1.8 (required). http://localhost:8086?readTimeout=5000
      * @param username        authorization username
      * @param password        authorization password
      * @param database        database name