Improve ClickHouse state store with authentication support and connection handling

Author: middt

state/clickhouse/clickhouse.go

@@ -20,6 +20,7 @@ import (
 	"errors"
 	"fmt"
 	"reflect"
+	"strings"
 	"time"
 
 	_ "github.com/ClickHouse/clickhouse-go/v2"
@@ -40,6 +41,8 @@ type clickhouseMetadata struct {
 	ClickHouseURL string
 	Database      string
 	Table         string
+	Username      string
+	Password      string
 }
 
 func NewClickHouseStateStore(logger logger.Logger) state.Store {
@@ -55,7 +58,28 @@ func (c *StateStore) Init(ctx context.Context, metadata state.Metadata) error {
 	}
 	c.config = config
 
-	db, err := sql.Open("clickhouse", c.config.ClickHouseURL)
+	// Construct DSN with authentication if provided
+	dsn := c.config.ClickHouseURL
+	// If username and password are provided and not already in the URL, add them to the DSN
+	if c.config.Username != "" && !strings.Contains(dsn, "username=") {
+		if !strings.Contains(dsn, "?") {
+			dsn += "?"
+		} else {
+			dsn += "&"
+		}
+		dsn += "username=" + c.config.Username
+	}
+
+	if c.config.Password != "" && !strings.Contains(dsn, "password=") {
+		if !strings.Contains(dsn, "?") {
+			dsn += "?"
+		} else if !strings.HasSuffix(dsn, "&") {
+			dsn += "&"
+		}
+		dsn += "password=" + c.config.Password
+	}
+
+	db, err := sql.Open("clickhouse", dsn)
 	if err != nil {
 		return fmt.Errorf("error opening connection: %v", err)
 	}
@@ -295,6 +319,15 @@ func parseAndValidateMetadata(metadata state.Metadata) (clickhouseMetadata, erro
 		return config, errors.New("ClickHouse table name is missing")
 	}
 
+	// Get username and password if provided
+	if val, ok := metadata.Properties["username"]; ok {
+		config.Username = val
+	}
+
+	if val, ok := metadata.Properties["password"]; ok {
+		config.Password = val
+	}
+
 	return config, nil
 }
 

state/clickhouse/clickhouse_test.go

@@ -29,7 +29,7 @@ import (
 )
 
 const (
-	testURL      = "tcp://localhost:9000"
+	testURL      = "clickhouse://localhost:9000"
 	testDatabase = "dapr_test"
 	testTable    = "state_test"
 	testUsername = "default"

tests/config/state/clickhouse/clickhouse.yml

@@ -7,7 +7,7 @@ spec:
   version: v1
   metadata:
   - name: clickhouseURL
-    value: "tcp://localhost:9000"
+    value: "clickhouse://localhost:9000"
   - name: databaseName
     value: "dapr_test"
   - name: tableName