Hacktoberfest 2026:維護者為十月標記出來的 issue,仍然開放、適合新手。 瀏覽 Hacktoberfest issue

[jdbc-v2] User-Agent wraps detected frameworks in double parentheses: ((apache.spark))

未關閉 適合新手
#3,214 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

維護者通常 1 天內回覆

還沒有人認領這個 Issue。

評估

難度
2/5
預估耗時
1-3 小時
新手友好度
70/100
Issue 類型
缺陷
描述清晰度
描述清楚
活躍度
活躍
技術堆疊
java
領域
database

研究方向

雙重分組來自 jdbc-v2 中的兩處:jdbc-v2/src/main/java/com/clickhouse/jdbc/Driver.java 中的 Driver.FrameworksDetection.getFrameworksDetected() 會為每個名稱加上括號,而 jdbc-v2 中的 ConnectionImpl 又對串接後的結果再包一層括號。僅在 jdbc-v2 的副本中移除按名稱加上的括號,保持 jdbc-v1 中的 DriverV1.FrameworksDetection 不變。完成標準是:包含 org.apache.spark 的呼叫堆疊只產生一個分組,例如 (apache.spark);沒有框架的呼叫堆疊仍然不產生任何分組。位於 org.apache.spark 套件中的測試必須先重設靜態欄位 frameworksDetected。

由索引模型根據 Issue 內容生成。

描述

bug jdbc-v2

Description

When jdbc-v2 detects a framework on the call stack (apache.spark, apache.flink, apache.nifi), it adds the framework names to the User-Agent header inside two levels of parentheses:

jdbc-v2/0.12.0-rc1-SNAPSHOT ((apache.spark)) clickhouse-java-v2/0.12.0-rc1-SNAPSHOT (Linux; jvm:17.0.20.1) Apache-HttpClient/5.6.4

With two frameworks on the stack, each name gets its own inner group:

jdbc-v2/0.12.0-rc1-SNAPSHOT ((apache.flink); (apache.spark)) clickhouse-java-v2/0.12.0-rc1-SNAPSHOT (Linux; jvm:17.0.20.1) Apache-HttpClient/5.6.4

Nested comments are valid HTTP (RFC 9110), so requests do not fail. But the header is read by tools that parse system.query_log.http_user_agent (see #2775), and a single comment group is the shape that the rest of the header uses.

Root cause

Two places add parentheses:

  1. Driver.FrameworksDetection.getFrameworksDetected() wraps each name: inferredFrameworks.add(String.format("(%s)", framework)), then joins with "; ".
    https://github.com/ClickHouse/clickhouse-java/blob/5392b642e5ca0375a77b8cc0f15b29b97a8f772f/jdbc-v2/src/main/java/com/clickhouse/jdbc/Driver.java#L50-L55
  2. ConnectionImpl wraps the result again: clientName += " (" + detectedFrameworks + ")".
    https://github.com/ClickHouse/clickhouse-java/blob/5392b642e5ca0375a77b8cc0f15b29b97a8f772f/jdbc-v2/src/main/java/com/clickhouse/jdbc/ConnectionImpl.java#L101-L107

FrameworksDetection is the same code as DriverV1.FrameworksDetection in jdbc-v1. jdbc-v1 appends the result directly to the product name, with no outer group, so there the inner parentheses are the only group:
https://github.com/ClickHouse/clickhouse-java/blob/5392b642e5ca0375a77b8cc0f15b29b97a8f772f/clickhouse-jdbc/src/main/java/com/clickhouse/jdbc/internal/ClickHouseConnectionImpl.java#L287-L291
jdbc-v2 kept the per-name parentheses and added an outer group, so the names are wrapped twice.

Suggested fix

In jdbc-v2 only, remove one level. For example, add the plain name in Driver.FrameworksDetection (inferredFrameworks.add(framework)) and keep the outer group in ConnectionImpl. Result:

  • one framework: jdbc-v2/<v> (apache.spark) clickhouse-java-v2/<v> ...
  • two frameworks: jdbc-v2/<v> (apache.flink; apache.spark) clickhouse-java-v2/<v> ...

Cases that must not change:

  • No framework on the stack: no group (today: jdbc-v2/<v> clickhouse-java-v2/<v> ...).
  • jdbc-v1 (DriverV1.FrameworksDetection): it has no outer group, so it needs its per-name parentheses.

A unit test can call Driver.FrameworksDetection.getFrameworksDetected() from a class in an org.apache.spark.* package. The result is cached in a static field, so the test must reset FrameworksDetection.frameworksDetected (package-private) first.

Related: #3213 (open) changes the client-v2 part of the header to the standard format for #3202. It does not change the jdbc-v2 framework group and says this is a separate issue. A maintainer could also decide to move the frameworks into the new client_metadata key/value pairs. That changes the jdbc-v2 output and needs a key name, so it is a design decision, not part of this bug.

Steps to reproduce
  1. Put a class in a package whose name contains apache.spark (for example org.apache.spark.repro) and open a jdbc-v2 connection from it.
  2. Run a query that has a unique marker, then SYSTEM FLUSH LOGS.
  3. Read http_user_agent for that query from system.query_log.
Error Log or Exception StackTrace

No exception. Observed http_user_agent values (one JVM per row, because detection result is cached per JVM):

[spark on stack]                    jdbc-v2/0.12.0-rc1-SNAPSHOT ((apache.spark)) clickhouse-java-v2/0.12.0-rc1-SNAPSHOT (Linux; jvm:17.0.20.1) Apache-HttpClient/5.6.4
[spark, client_name=my-app/1.0]     my-app/1.0 jdbc-v2/0.12.0-rc1-SNAPSHOT ((apache.spark)) clickhouse-java-v2/0.12.0-rc1-SNAPSHOT (Linux; jvm:17.0.20.1) Apache-HttpClient/5.6.4
[spark -> flink on stack]           jdbc-v2/0.12.0-rc1-SNAPSHOT ((apache.flink); (apache.spark)) clickhouse-java-v2/0.12.0-rc1-SNAPSHOT (Linux; jvm:17.0.20.1) Apache-HttpClient/5.6.4
[no framework on stack]             jdbc-v2/0.12.0-rc1-SNAPSHOT clickhouse-java-v2/0.12.0-rc1-SNAPSHOT (Linux; jvm:17.0.20.1) Apache-HttpClient/5.6.4
Expected Behaviour

One comment group with the framework names:

jdbc-v2/0.12.0-rc1-SNAPSHOT (apache.spark) clickhouse-java-v2/0.12.0-rc1-SNAPSHOT ...
jdbc-v2/0.12.0-rc1-SNAPSHOT (apache.flink; apache.spark) clickhouse-java-v2/0.12.0-rc1-SNAPSHOT ...
Code Example
package org.apache.spark.repro;   // "apache.spark" in the stack trace triggers detection

import java.sql.*;
import java.util.*;

public class SparkApp {
    public static void main(String[] args) throws Exception {
        Properties p = new Properties();
        p.setProperty("user", "default");
        p.setProperty("password", "<password>");
        String marker = "ua_probe_" + UUID.randomUUID().toString().replace("-", "");
        try (Connection c = new com.clickhouse.jdbc.Driver().connect("jdbc:clickhouse://localhost:8123/default", p);
             Statement s = c.createStatement()) {
            s.executeQuery("SELECT '" + marker + "'").close();
            s.execute("SYSTEM FLUSH LOGS");
            try (ResultSet rs = s.executeQuery("SELECT http_user_agent FROM system.query_log"
                    + " WHERE type = 'QueryFinish' AND query LIKE '%" + marker + "%'"
                    + " AND query NOT LIKE '%query_log%' LIMIT 1")) {
                rs.next();
                System.out.println(rs.getString(1));
                // prints: jdbc-v2/<v> ((apache.spark)) clickhouse-java-v2/<v> (...)
            }
        }
    }
}

For the two-framework case, call the same code from a class in org.apache.flink.repro that SparkApp calls.

Configuration
Client Configuration
// defaults; framework detection is enabled by default
Environment
  • Cloud
  • Client version: jdbc-v2 0.12.0-rc1-SNAPSHOT, built from main at 5392b642e5ca0375a77b8cc0f15b29b97a8f772f
  • Language version: Java 17.0.20.1
  • OS: Linux
ClickHouse Server
  • ClickHouse Server version: 26.9.1.1629
  • ClickHouse Server non-default settings, if any: none relevant
  • CREATE TABLE statements for tables involved: none (SELECT '<marker>' only)

Found by automated analysis (Polyglot AI) while working on #3202. Verified by running the code above against a live ClickHouse server, not only by reading the code.

主要語言
Java
星號
1.6k
分支
642
平均合併
1 天 11 小時
30 天內合併 PR
41

環境準備

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

ClickHouse/clickhouse-java 的其他 Issue

查看 ClickHouse/clickhouse-java 的全部 Issue

相似的 Issue

更多 Java Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。