feat: get influxdb version (#243)

Author: NguyenHoangSon96

CHANGELOG.md

@@ -14,6 +14,7 @@
      `"second"` (
      in addition to the existing `"ns"`, `"us"`, `"ms"`, `"s"`).
 3. [#241](https://github.com/InfluxCommunity/influxdb3-java/pull/241): Some default options will be used from a getter.
+4. [#243](https://github.com/InfluxCommunity/influxdb3-java/pull/243): Add function to get InfluxDB version.
 
 ### Bug Fixes
 

src/main/java/com/influxdb/v3/client/InfluxDBClient.java

@@ -449,6 +449,15 @@ Stream<VectorSchemaRoot> queryBatches(@Nonnull final String query,
                                           @Nonnull final Map<String, Object> parameters,
                                           @Nonnull final QueryOptions options);
 
+    /**
+     * Get InfluxDB server version.
+     *
+     * @return a string representing the server version.
+     * Returns <code>null</code> if the server version can't be determined.
+     */
+    @Nullable
+    String getServerVersion();
+
     /**
      * Creates a new instance of the {@link InfluxDBClient} for interacting with an InfluxDB server, simplifying
      * common operations such as writing, querying.

src/main/java/com/influxdb/v3/client/internal/InfluxDBClientImpl.java

@@ -290,6 +290,11 @@ public Stream<VectorSchemaRoot> queryBatches(@Nonnull final String query,
         return queryData(query, parameters, options);
     }
 
+    @Override
+    public String getServerVersion() {
+        return this.restClient.getServerVersion();
+    }
+
     @Override
     public void close() throws Exception {
         restClient.close();

src/main/java/com/influxdb/v3/client/internal/RestClient.java

@@ -33,9 +33,11 @@
 import java.security.SecureRandom;
 import java.security.cert.Certificate;
 import java.security.cert.CertificateFactory;
+import java.security.cert.X509Certificate;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Map;
+import java.util.Optional;
 import java.util.stream.Stream;
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
@@ -63,16 +65,16 @@ final class RestClient implements AutoCloseable {
 
     private static final TrustManager[] TRUST_ALL_CERTS = new TrustManager[]{
             new X509TrustManager() {
-                public java.security.cert.X509Certificate[] getAcceptedIssuers() {
+                public X509Certificate[] getAcceptedIssuers() {
                     return null;
                 }
 
                 public void checkClientTrusted(
-                        final java.security.cert.X509Certificate[] certs, final String authType) {
+                        final X509Certificate[] certs, final String authType) {
                 }
 
                 public void checkServerTrusted(
-                        final java.security.cert.X509Certificate[] certs, final String authType) {
+                        final X509Certificate[] certs, final String authType) {
                 }
             }
     };
@@ -140,11 +142,27 @@ public void checkServerTrusted(
         this.client = builder.build();
     }
 
-    void request(@Nonnull final String path,
-                 @Nonnull final HttpMethod method,
-                 @Nullable final byte[] data,
-                 @Nullable final Map<String, String> queryParams,
-                 @Nullable final Map<String, String> headers) {
+    public String getServerVersion() {
+        String influxdbVersion;
+        HttpResponse<String> response = request("ping", HttpMethod.GET, null, null, null);
+        try {
+            influxdbVersion = response.headers().firstValue("X-Influxdb-Version").orElse(null);
+            if (influxdbVersion == null) {
+                JsonNode jsonNode = objectMapper.readTree(response.body());
+                influxdbVersion = Optional.ofNullable(jsonNode.get("version")).map(JsonNode::asText).orElse(null);
+            }
+        } catch (JsonProcessingException e) {
+            return null;
+        }
+
+        return influxdbVersion;
+    }
+
+    HttpResponse<String> request(@Nonnull final String path,
+                                 @Nonnull final HttpMethod method,
+                                 @Nullable final byte[] data,
+                                 @Nullable final Map<String, String> queryParams,
+                                 @Nullable final Map<String, String> headers) {
 
         QueryStringEncoder uriEncoder = new QueryStringEncoder(String.format("%s%s", baseUrl, path));
         if (queryParams != null) {
@@ -235,6 +253,8 @@ void request(@Nonnull final String path,
             String message = String.format("HTTP status code: %d; Message: %s", statusCode, reason);
             throw new InfluxDBApiHttpException(message, response.headers(), response.statusCode());
         }
+
+        return response;
     }
 
     private X509TrustManager getX509TrustManagerFromFile(@Nonnull final String filePath) {

src/test/java/com/influxdb/v3/client/integration/E2ETest.java

@@ -384,6 +384,21 @@ public void testQueryRowsExceptionCases() throws Exception {
         }
     }
 
+    @EnabledIfEnvironmentVariable(named = "TESTING_INFLUXDB_URL", matches = ".*")
+    @EnabledIfEnvironmentVariable(named = "TESTING_INFLUXDB_TOKEN", matches = ".*")
+    @EnabledIfEnvironmentVariable(named = "TESTING_INFLUXDB_DATABASE", matches = ".*")
+    @Test
+    public void testGetServerVersion() throws Exception {
+        try (InfluxDBClient client = InfluxDBClient.getInstance(
+                System.getenv("TESTING_INFLUXDB_URL"),
+                System.getenv("TESTING_INFLUXDB_TOKEN").toCharArray(),
+                System.getenv("TESTING_INFLUXDB_DATABASE"),
+                null)) {
+
+            Assertions.assertThat(client.getServerVersion()).isNotEmpty();
+        }
+    }
+
     private void assertGetDataSuccess(@Nonnull final InfluxDBClient influxDBClient) {
         influxDBClient.writePoint(
                 Point.measurement("test1")

src/test/java/com/influxdb/v3/client/internal/RestClientTest.java

@@ -36,6 +36,7 @@
 import java.util.Optional;
 
 import io.netty.handler.codec.http.HttpMethod;
+import okhttp3.mockwebserver.MockResponse;
 import okhttp3.mockwebserver.RecordedRequest;
 import org.assertj.core.api.Assertions;
 import org.junit.jupiter.api.AfterEach;
@@ -476,4 +477,54 @@ public void errorHttpExceptionThrown() {
         Assertions.assertThat(he.getMessage())
           .isEqualTo("HTTP status code: 503; Message: temporarily offline");
     }
+
+    @Test
+    public void getServerVersionV2Successful() throws Exception {
+        String influxDBVersion = "v2.1.0";
+        mockServer.enqueue(createResponse(200).setHeader("x-influxdb-version", influxDBVersion));
+
+        restClient = new RestClient(new ClientConfig.Builder()
+                .host(baseURL)
+                .build());
+        String version = restClient.getServerVersion();
+
+        Assertions.assertThat(version).isEqualTo(influxDBVersion);
+    }
+
+    @Test
+    public void getServerVersionV3Successful() throws Exception {
+        String influxDBVersion = "3.0.0";
+        mockServer.enqueue(createResponse(200).setBody("{\"version\":\"" + influxDBVersion + "\"}"));
+
+        restClient = new RestClient(new ClientConfig.Builder()
+                .host(baseURL)
+                .build());
+        String version = restClient.getServerVersion();
+
+        Assertions.assertThat(version).isEqualTo(influxDBVersion);
+    }
+
+    @Test
+    public void getServerVersionError() {
+        MockResponse mockResponse = new MockResponse();
+        mockResponse.setBody("not json")
+                .setHeader("something", "something");
+        mockServer.enqueue(mockResponse);
+
+        restClient = new RestClient(new ClientConfig.Builder()
+                .host(baseURL)
+                .build());
+        String version = restClient.getServerVersion();
+        Assertions.assertThat(version).isEqualTo(null);
+    }
+
+    @Test
+    public void getServerVersionErrorNoBody() {
+        mockServer.enqueue(new MockResponse().setResponseCode(200));
+        restClient = new RestClient(new ClientConfig.Builder()
+                .host(baseURL)
+                .build());
+        String version = restClient.getServerVersion();
+        Assertions.assertThat(version).isEqualTo(null);
+    }
 }