Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

Properly set the report timezone for ClickHouse (#80196)

metamben4e60ba6fad86
diff --git a/modules/drivers/clickhouse/src/metabase/driver/clickhouse.clj b/modules/drivers/clickhouse/src/metabase/driver/clickhouse.clj
index db3d7639496..046dbad33a5 100644
--- a/modules/drivers/clickhouse/src/metabase/driver/clickhouse.clj
+++ b/modules/drivers/clickhouse/src/metabase/driver/clickhouse.clj
@@ -115,11 +115,11 @@
:else nil)]
(sql-jdbc.execute/set-role-if-supported! driver conn db))
(when-not (sql-jdbc.execute/recursive-connection?)
- (when session-timezone
- (let [^com.clickhouse.jdbc.ConnectionImpl clickhouse-conn (.unwrap conn com.clickhouse.jdbc.ConnectionImpl)
- query-settings (new QuerySettings)]
- (.setOption query-settings "session_timezone" session-timezone)
- (.setDefaultQuerySettings clickhouse-conn query-settings)))
+ (let [^com.clickhouse.jdbc.ConnectionImpl clickhouse-conn (.unwrap conn com.clickhouse.jdbc.ConnectionImpl)
+ query-settings (new QuerySettings)]
+ (when session-timezone
+ (.serverSetting query-settings "session_timezone" session-timezone))
+ (.setDefaultQuerySettings clickhouse-conn query-settings))
(sql-jdbc.execute/set-best-transaction-level! driver conn)
(sql-jdbc.execute/set-time-zone-if-supported! driver conn session-timezone))
(f conn))))
diff --git a/modules/drivers/clickhouse/test/metabase/driver/clickhouse_test.clj b/modules/drivers/clickhouse/test/metabase/driver/clickhouse_test.clj
index 6e926badd78..ce0dc307df5 100644
--- a/modules/drivers/clickhouse/test/metabase/driver/clickhouse_test.clj
+++ b/modules/drivers/clickhouse/test/metabase/driver/clickhouse_test.clj
@@ -10,6 +10,7 @@
[metabase.driver.clickhouse-version :as clickhouse-version]
[metabase.driver.sql-jdbc :as sql-jdbc]
[metabase.driver.sql-jdbc.connection :as sql-jdbc.conn]
+ [metabase.driver.sql-jdbc.execute :as sql-jdbc.execute]
[metabase.lib-be.core :as lib-be]
[metabase.lib.card :as lib.card]
[metabase.lib.core :as lib]
@@ -21,7 +22,10 @@
[metabase.test.data.clickhouse :as ctd]
[metabase.upload.impl-test :as upload-test]
[taoensso.nippy :as nippy]
- [toucan2.tools.with-temp :as t2.with-temp]))
+ [toucan2.tools.with-temp :as t2.with-temp])
+ (:import
+ (com.clickhouse.jdbc ConnectionImpl)
+ (java.sql Connection)))
(set! *warn-on-reflection* true)
@@ -67,6 +71,40 @@
spec (sql-jdbc.conn/connection-details->spec :clickhouse details)]
(driver/db-default-timezone :clickhouse spec))))))
+(deftest clickhouse-report-timezone-reaches-server-test
+ ;; Regression for #79671.
+ (mt/test-driver :clickhouse
+ (mt/with-report-timezone-id! "America/Santiago"
+ (is (= [["America/Santiago" "America/Santiago"]]
+ (->> "SELECT timezone() AS tz, getSetting('session_timezone') AS s"
+ (lib/native-query (mt/metadata-provider))
+ qp/process-query
+ mt/rows))))))
+
+(deftest ^:synchronized clickhouse-session-timezone-does-not-leak-across-borrows-test
+ (mt/test-driver :clickhouse
+ (sql-jdbc.conn/invalidate-pool-for-db! (mt/db))
+ (let [underlying-conn-ids (atom [])
+ observe (fn [opts]
+ (sql-jdbc.execute/do-with-connection-with-options
+ :clickhouse (mt/id) opts
+ (fn [^Connection conn]
+ (swap! underlying-conn-ids conj
+ (System/identityHashCode (.unwrap conn ConnectionImpl)))
+ (with-open [stmt (.createStatement conn)
+ rs (.executeQuery stmt "SELECT getSetting('session_timezone')")]
+ (.next rs)
+ (.getString rs 1)))))]
+ (is (= "America/Santiago" (observe {:session-timezone "America/Santiago"})))
+ (let [result (observe nil)]
+ ;; Guard: the leak is only observable when the pool hands us the same underlying
+ ;; ConnectionImpl. With a freshly invalidated pool and back-to-back borrows this holds;
+ ;; if it stops holding, the test has to be fixed.
+ (is (apply = @underlying-conn-ids)
+ (str "expected both borrows to reuse the same underlying connection: " @underlying-conn-ids))
+ (is (= "" result)
+ "a borrow without :session-timezone must not inherit the previous borrow's timezone")))))
+
(deftest ^:parallel clickhouse-connection-string
(testing "connection with no additional options"
(is (= ctd/default-connection-params
diff --git a/test/metabase/driver/sql_jdbc/execute_test.clj b/test/metabase/driver/sql_jdbc/execute_test.clj
index 21c452d84de..34cc87ffa11 100644
--- a/test/metabase/driver/sql_jdbc/execute_test.clj
+++ b/test/metabase/driver/sql_jdbc/execute_test.clj
@@ -89,7 +89,7 @@
#_{:clj-kondo/ignore [:metabase/disallow-hardcoded-driver-names-in-tests]}
(mt/test-drivers (disj (descendants driver/hierarchy :sql-jdbc)
;; too tricky to stub the connection
- :presto-jdbc :databricks :starburst)
+ :presto-jdbc :databricks :starburst :clickhouse)
(let [connection-option-calls (volatile! [])
is-default-options
(identical? (get-method sql-jdbc.execute/do-with-connection-with-options :sql-jdbc)