wip, hooks refactor

Author: ndyakov

internal/internal.go

@@ -6,8 +6,6 @@ import (
 	"github.com/redis/go-redis/v9/internal/rand"
 )
 
-type ParentHooksMixinKey struct{}
-
 func RetryBackoff(retry int, minBackoff, maxBackoff time.Duration) time.Duration {
 	if retry < 0 {
 		panic("not reached")

osscluster.go

@@ -920,7 +920,6 @@ type ClusterClient struct {
 	state         *clusterStateHolder
 	cmdsInfoCache *cmdsInfoCache
 	cmdable
-	hooksMixin
 }
 
 // NewClusterClient returns a Redis Cluster client as described in

pubsub.go

@@ -19,6 +19,7 @@ import (
 // PubSub automatically reconnects to Redis Server and resubscribes
 // to the channels in case of network errors.
 type PubSub struct {
+	baseClient
 	opt *Options
 
 	newConn   func(ctx context.Context, channels []string) (*pool.Conn, error)
@@ -40,6 +41,20 @@ type PubSub struct {
 	allCh  *channel
 }
 
+// NewPubSub creates a new PubSub that shares the baseClient with the provided client
+func NewPubSub(bc *baseClient) *PubSub {
+	ps := &PubSub{
+		baseClient: *bc,
+		opt:        bc.opt,
+		newConn: func(ctx context.Context, channels []string) (*pool.Conn, error) {
+			return bc.newConn(ctx)
+		},
+		closeConn: bc.connPool.CloseConn,
+	}
+	ps.init()
+	return ps
+}
+
 func (c *PubSub) init() {
 	c.exit = make(chan struct{})
 }

redis.go

@@ -205,6 +205,7 @@ func (hs *hooksMixin) processTxPipelineHook(ctx context.Context, cmds []Cmder) e
 type baseClient struct {
 	opt      *Options
 	connPool pool.Pooler
+	hooksMixin
 
 	onClose func() error // hook called when client is closed
 }
@@ -352,20 +353,8 @@ func (c *baseClient) initConn(ctx context.Context, cn *pool.Conn) error {
 	var err error
 	cn.Inited = true
 	connPool := pool.NewSingleConnPool(c.connPool, cn)
-	var parentHooks hooksMixin
-	pH := ctx.Value(internal.ParentHooksMixinKey{})
-	switch pH := pH.(type) {
-	case nil:
-		parentHooks = hooksMixin{}
-	case hooksMixin:
-		parentHooks = pH.clone()
-	case *hooksMixin:
-		parentHooks = (*pH).clone()
-	default:
-		parentHooks = hooksMixin{}
-	}
 
-	conn := newConn(c.opt, connPool, parentHooks)
+	conn := newConn(c.opt, connPool, c.hooksMixin)
 
 	protocol := c.opt.Protocol
 	// By default, use RESP3 in current version.
@@ -743,7 +732,6 @@ func txPipelineReadQueued(rd *proto.Reader, statusCmd *StatusCmd, cmds []Cmder)
 type Client struct {
 	*baseClient
 	cmdable
-	hooksMixin
 }
 
 // NewClient returns a client to the Redis Server specified by Options.
@@ -779,7 +767,7 @@ func (c *Client) WithTimeout(timeout time.Duration) *Client {
 }
 
 func (c *Client) Conn() *Conn {
-	return newConn(c.opt, pool.NewStickyConnPool(c.connPool), c.hooksMixin.clone())
+	return newConn(c.opt, pool.NewStickyConnPool(c.connPool), c.hooksMixin)
 }
 
 // Do create a Cmd from the args and processes the cmd.
@@ -790,7 +778,6 @@ func (c *Client) Do(ctx context.Context, args ...interface{}) *Cmd {
 }
 
 func (c *Client) Process(ctx context.Context, cmd Cmder) error {
-	ctx = context.WithValue(ctx, internal.ParentHooksMixinKey{}, c.hooksMixin)
 	err := c.processHook(ctx, cmd)
 	cmd.SetErr(err)
 	return err
@@ -913,20 +900,22 @@ type Conn struct {
 	baseClient
 	cmdable
 	statefulCmdable
-	hooksMixin
 }
 
+// newConn is a helper func to create a new Conn instance.
+// the Conn instance is not thread-safe and should not be shared between goroutines.
+// the parentHooks will be cloned, no need to clone before passing it.
 func newConn(opt *Options, connPool pool.Pooler, parentHooks hooksMixin) *Conn {
 	c := Conn{
 		baseClient: baseClient{
-			opt:      opt,
-			connPool: connPool,
+			opt:        opt,
+			connPool:   connPool,
+			hooksMixin: parentHooks.clone(),
 		},
 	}
 
 	c.cmdable = c.Process
 	c.statefulCmdable = c.Process
-	c.hooksMixin = parentHooks
 	c.initHooks(hooks{
 		dial:       c.baseClient.dial,
 		process:    c.baseClient.process,

sentinel.go

@@ -309,7 +309,6 @@ func masterReplicaDialer(
 // SentinelClient is a client for a Redis Sentinel.
 type SentinelClient struct {
 	*baseClient
-	hooksMixin
 }
 
 func NewSentinelClient(opt *Options) *SentinelClient {

tx.go

@@ -19,16 +19,15 @@ type Tx struct {
 	baseClient
 	cmdable
 	statefulCmdable
-	hooksMixin
 }
 
 func (c *Client) newTx() *Tx {
 	tx := Tx{
 		baseClient: baseClient{
-			opt:      c.opt,
-			connPool: pool.NewStickyConnPool(c.connPool),
+			opt:        c.opt,
+			connPool:   pool.NewStickyConnPool(c.connPool),
+			hooksMixin: c.hooksMixin.clone(),
 		},
-		hooksMixin: c.hooksMixin.clone(),
 	}
 	tx.init()
 	return &tx