Merge pull request #2280 from ClickHouse/use-product-name

Updating the client name to include produce name in URL

Author: Paultagoras

jdbc-v2/src/main/java/com/clickhouse/jdbc/ConnectionImpl.java

@@ -1,6 +1,7 @@
 package com.clickhouse.jdbc;
 
 import com.clickhouse.client.api.Client;
+import com.clickhouse.client.api.ClientConfigProperties;
 import com.clickhouse.client.api.internal.ServerSettings;
 import com.clickhouse.client.api.query.GenericRecord;
 import com.clickhouse.client.api.query.QuerySettings;
@@ -50,6 +51,7 @@ public class ConnectionImpl implements Connection, JdbcV2Wrapper {
     protected String cluster;
     private String catalog;
     private String schema;
+    private String appName;
     private QuerySettings defaultQuerySettings;
 
     private final com.clickhouse.jdbc.metadata.DatabaseMetaData metadata;
@@ -62,14 +64,27 @@ public ConnectionImpl(String url, Properties info) throws SQLException {
             this.config = new JdbcConfiguration(url, info);
             this.onCluster = false;
             this.cluster = null;
+            this.appName = "";
             String clientName = "ClickHouse JDBC Driver V2/" + Driver.driverVersion;
 
+            Map<String, String> clientProperties = config.getClientProperties();
+            if (clientProperties.get(ClientConfigProperties.CLIENT_NAME.getKey()) != null) {
+                this.appName = clientProperties.get(ClientConfigProperties.CLIENT_NAME.getKey()).trim();
+                clientName = this.appName + " " + clientName; // Use the application name as client name
+            } else if (clientProperties.get(ClientConfigProperties.PRODUCT_NAME.getKey()) != null) {
+                // Backward compatibility for old property
+                this.appName = clientProperties.get(ClientConfigProperties.PRODUCT_NAME.getKey()).trim();
+                clientName = this.appName + " " + clientName; // Use the application name as client name
+            }
+
             if (this.config.isDisableFrameworkDetection()) {
                 log.debug("Framework detection is disabled.");
             } else {
                 String detectedFrameworks = Driver.FrameworksDetection.getFrameworksDetected();
                 log.debug("Detected frameworks: {}", detectedFrameworks);
-                clientName += " (" + detectedFrameworks + ")";
+                if (!detectedFrameworks.trim().isEmpty()) {
+                    clientName += " (" + detectedFrameworks + ")";
+                }
             }
 
             this.client = this.config.applyClientProperties(new Client.Builder())
@@ -441,8 +456,6 @@ public boolean isValid(int timeout) throws SQLException {
         return true;
     }
 
-    private String appName = "";
-
     @Override
     public void setClientInfo(String name, String value) throws SQLClientInfoException {
         if (ClientInfoProperties.APPLICATION_NAME.getKey().equals(name)) {

jdbc-v2/src/main/java/com/clickhouse/jdbc/internal/JdbcConfiguration.java

@@ -3,6 +3,7 @@
 import com.clickhouse.client.api.Client;
 import com.clickhouse.client.api.ClientConfigProperties;
 import com.clickhouse.jdbc.Driver;
+import com.google.common.collect.ImmutableMap;
 
 import java.net.URI;
 import java.sql.DriverPropertyInfo;
@@ -26,6 +27,9 @@ public class JdbcConfiguration {
     final boolean disableFrameworkDetection;
 
     final Map<String, String> clientProperties;
+    public Map<String, String> getClientProperties() {
+        return ImmutableMap.copyOf(clientProperties);
+    }
 
     private final Map<String, String> driverProperties;
 
@@ -62,6 +66,7 @@ public JdbcConfiguration(String url, Properties info) throws SQLException {
         if (bearerToken != null) {
             clientProperties.put(ClientConfigProperties.BEARERTOKEN_AUTH.getKey(), bearerToken);
         }
+
         this.connectionUrl = createConnectionURL(tmpConnectionUrl, useSSL);
         this.isIgnoreUnsupportedRequests= Boolean.parseBoolean(getDriverProperty(DriverProperties.IGNORE_UNSUPPORTED_VALUES.getKey(), "false"));
     }
@@ -186,9 +191,7 @@ private void initProperties(Map<String, String> urlProperties, Properties provid
             }
         }
 
-        for (Map.Entry<String, String> entry : urlProperties.entrySet()) {
-            props.put(entry.getKey(), entry.getValue());
-        }
+        props.putAll(urlProperties);
 
         // Process all properties
         Map<String, DriverPropertyInfo> propertyInfos = new HashMap<>();

jdbc-v2/src/test/java/com/clickhouse/jdbc/ConnectionTest.java

@@ -282,6 +282,35 @@ public void setAndGetClientInfoTest(String clientName) throws SQLException {
         }
     }
 
+    @Test(groups = { "integration" })
+    public void influenceUserAgentClientNameTest() throws SQLException {
+        String clientName = UUID.randomUUID().toString().replace("-", "");
+        influenceUserAgentTest(clientName, "?" + ClientConfigProperties.CLIENT_NAME.getKey() + "=" + clientName);
+        influenceUserAgentTest(clientName, "?" + ClientConfigProperties.PRODUCT_NAME.getKey() + "=" + clientName);
+    }
+    private void influenceUserAgentTest(String clientName, String urlParam) throws SQLException {
+        Properties info = new Properties();
+        info.setProperty("user", "default");
+        info.setProperty("password", ClickHouseServerForTest.getPassword());
+        info.setProperty(ClientConfigProperties.DATABASE.getKey(), ClickHouseServerForTest.getDatabase());
+
+        try (Connection localConnection = new ConnectionImpl(getEndpointString() + urlParam, info);
+             Statement stmt = localConnection.createStatement()) {
+
+            final String testQuery = "SELECT '" + UUID.randomUUID() + "'";
+            stmt.execute(testQuery);
+            stmt.execute("SYSTEM FLUSH LOGS");
+
+            final String logQuery ="SELECT http_user_agent " +
+                    " FROM system.query_log WHERE query = '" + testQuery.replaceAll("'", "\\\\'") + "'";
+            try (ResultSet rs = stmt.executeQuery(logQuery)) {
+                Assert.assertTrue(rs.next());
+                String userAgent = rs.getString("http_user_agent");
+                Assert.assertTrue(userAgent.startsWith(clientName), "Expected to start with '" + clientName + "' but value was '" + userAgent + "'");
+            }
+        }
+    }
+
     @DataProvider(name = "setAndGetClientInfoTestDataProvider")
     public static Object[][] setAndGetClientInfoTestDataProvider() {
         return new Object[][] {