Expose DialStrategy function to user for custom connection routing (#855

)

* Expose DialStrategy function to user for custom connection routing

* fix changes

* test: example of usage

* test: example of usage

* do not expose connect type

* fix tests

* remove dial strategy from docs

* fix test

clickhouse.go

@@ -195,22 +195,45 @@ func (ch *clickhouse) Stats() driver.Stats {
 
 func (ch *clickhouse) dial(ctx context.Context) (conn *connect, err error) {
 	connID := int(atomic.AddInt64(&ch.connID, 1))
-	for i := range ch.opt.Addr {
+
+	dialFunc := func(ctx context.Context, addr string, opt *Options) (DialResult, error) {
+		conn, err := dial(ctx, addr, connID, opt)
+
+		return DialResult{conn}, err
+	}
+
+	dialStrategy := DefaultDialStrategy
+	if ch.opt.DialStrategy != nil {
+		dialStrategy = ch.opt.DialStrategy
+	}
+
+	result, err := dialStrategy(ctx, connID, ch.opt, dialFunc)
+	if err != nil {
+		return nil, err
+	}
+	return result.conn, nil
+}
+
+func DefaultDialStrategy(ctx context.Context, connID int, opt *Options, dial Dial) (r DialResult, err error) {
+	for i := range opt.Addr {
 		var num int
-		switch ch.opt.ConnOpenStrategy {
+		switch opt.ConnOpenStrategy {
 		case ConnOpenInOrder:
 			num = i
 		case ConnOpenRoundRobin:
-			num = (int(connID) + i) % len(ch.opt.Addr)
+			num = (int(connID) + i) % len(opt.Addr)
 		}
-		if conn, err = dial(ctx, ch.opt.Addr[num], connID, ch.opt); err == nil {
-			return conn, nil
+
+		if r, err = dial(ctx, opt.Addr[num], opt); err == nil {
+			return r, nil
 		}
 	}
+
 	if err == nil {
 		err = ErrAcquireConnNoAddress
 	}
-	return nil, err
+
+	return r, err
 }
 
 func (ch *clickhouse) acquire(ctx context.Context) (conn *connect, err error) {

clickhouse_options.go

@@ -115,13 +115,19 @@ func ParseDSN(dsn string) (*Options, error) {
 	return opt, nil
 }
 
+type Dial func(ctx context.Context, addr string, opt *Options) (DialResult, error)
+type DialResult struct {
+	conn *connect
+}
+
 type Options struct {
 	Protocol Protocol
 
 	TLS                  *tls.Config
 	Addr                 []string
 	Auth                 Auth
 	DialContext          func(ctx context.Context, addr string) (net.Conn, error)
+	DialStrategy         func(ctx context.Context, connID int, options *Options, dial Dial) (DialResult, error)
 	Debug                bool
 	Debugf               func(format string, v ...interface{}) // only works when Debug is true
 	Settings             Settings

tests/conn_test.go

@@ -242,3 +242,23 @@ func TestBlockBufferSize(t *testing.T) {
 	}
 	require.Equal(t, 10000000, i)
 }
+
+func TestConnCustomDialStrategy(t *testing.T) {
+	env, err := GetTestEnvironment(testSet)
+	require.NoError(t, err)
+
+	opts := clientOptionsFromEnv(env, clickhouse.Settings{})
+	validAddr := opts.Addr[0]
+	opts.Addr = []string{"invalid.host:9001"}
+
+	opts.DialStrategy = func(ctx context.Context, connID int, opts *clickhouse.Options, dial clickhouse.Dial) (clickhouse.DialResult, error) {
+		return dial(ctx, validAddr, opts)
+	}
+
+	conn, err := clickhouse.Open(&opts)
+	require.NoError(t, err)
+
+	require.NoError(t, err)
+	require.NoError(t, conn.Ping(context.Background()))
+	require.NoError(t, conn.Close())
+}