Skip to content

Commit 3917988

Browse files
ljun20160606ljun20160606
authored
feat: add protocol option (#2598)
1 parent 31ba855 commit 3917988

11 files changed

+197
-2
lines changed

‎cluster.go

+2
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,7 @@ type ClusterOptions struct {
6262

6363
OnConnect func(ctx context.Context, cn *Conn) error
6464

65+
Protocol int
6566
Username string
6667
Password string
6768

@@ -263,6 +264,7 @@ func (opt *ClusterOptions) clientOptions() *Options {
263264
Dialer: opt.Dialer,
264265
OnConnect: opt.OnConnect,
265266

267+
Protocol: opt.Protocol,
266268
Username: opt.Username,
267269
Password: opt.Password,
268270

‎cluster_test.go

+38
Original file line numberDiff line numberDiff line change
@@ -583,6 +583,35 @@ var _ = Describe("ClusterClient", func() {
583583
})
584584
}
585585

586+
Describe("ClusterClient PROTO 2", func() {
587+
BeforeEach(func() {
588+
opt = redisClusterOptions()
589+
opt.Protocol = 2
590+
client = cluster.newClusterClient(ctx, opt)
591+
592+
err := client.ForEachMaster(ctx, func(ctx context.Context, master *redis.Client) error {
593+
return master.FlushDB(ctx).Err()
594+
})
595+
Expect(err).NotTo(HaveOccurred())
596+
})
597+
598+
AfterEach(func() {
599+
_ = client.ForEachMaster(ctx, func(ctx context.Context, master *redis.Client) error {
600+
return master.FlushDB(ctx).Err()
601+
})
602+
Expect(client.Close()).NotTo(HaveOccurred())
603+
})
604+
605+
It("should CLUSTER PROTO 2", func() {
606+
_ = client.ForEachShard(ctx, func(ctx context.Context, c *redis.Client) error {
607+
val, err := c.Do(ctx, "HELLO").Result()
608+
Expect(err).NotTo(HaveOccurred())
609+
Expect(val).Should(ContainElements("proto", int64(2)))
610+
return nil
611+
})
612+
})
613+
})
614+
586615
Describe("ClusterClient", func() {
587616
BeforeEach(func() {
588617
opt = redisClusterOptions()
@@ -746,6 +775,15 @@ var _ = Describe("ClusterClient", func() {
746775
})
747776
})
748777

778+
It("should CLUSTER PROTO 3", func() {
779+
_ = client.ForEachShard(ctx, func(ctx context.Context, c *redis.Client) error {
780+
val, err := c.Do(ctx, "HELLO").Result()
781+
Expect(err).NotTo(HaveOccurred())
782+
Expect(val).Should(HaveKeyWithValue("proto", int64(3)))
783+
return nil
784+
})
785+
})
786+
749787
It("should CLUSTER MYSHARDID", func() {
750788
shardID, err := client.ClusterMyShardID(ctx).Result()
751789
Expect(err).NotTo(HaveOccurred())

‎options.go

+4
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,9 @@ type Options struct {
4545
// Hook that is called when new connection is established.
4646
OnConnect func(ctx context.Context, cn *Conn) error
4747

48+
// Protocol 2 or 3. Use the version to negotiate RESP version with redis-server.
49+
// Default is 3.
50+
Protocol int
4851
// Use the specified Username to authenticate the current connection
4952
// with one of the connections defined in the ACL list when connecting
5053
// to a Redis 6.0 instance, or greater, that is using the Redis ACL system.
@@ -437,6 +440,7 @@ func setupConnParams(u *url.URL, o *Options) (*Options, error) {
437440
o.DB = db
438441
}
439442

443+
o.Protocol = q.int("protocol")
440444
o.ClientName = q.string("client_name")
441445
o.MaxRetries = q.int("max_retries")
442446
o.MinRetryBackoff = q.duration("min_retry_backoff")

‎options_test.go

+3
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,9 @@ func TestParseURL(t *testing.T) {
6262
}, {
6363
url: "redis://localhost:123/?db=2&client_name=hi", // client name
6464
o: &Options{Addr: "localhost:123", DB: 2, ClientName: "hi"},
65+
}, {
66+
url: "redis://localhost:123/?db=2&protocol=2", // RESP Protocol
67+
o: &Options{Addr: "localhost:123", DB: 2, Protocol: 2},
6568
}, {
6669
url: "unix:///tmp/redis.sock",
6770
o: &Options{Addr: "/tmp/redis.sock"},

‎redis.go

+6-1
Original file line numberDiff line numberDiff line change
@@ -279,10 +279,15 @@ func (c *baseClient) initConn(ctx context.Context, cn *pool.Conn) error {
279279
conn := newConn(c.opt, connPool)
280280

281281
var auth bool
282+
protocol := c.opt.Protocol
283+
// By default, use RESP3 in current version.
284+
if protocol < 2 {
285+
protocol = 3
286+
}
282287

283288
// for redis-server versions that do not support the HELLO command,
284289
// RESP2 will continue to be used.
285-
if err := conn.Hello(ctx, 3, username, password, "").Err(); err == nil {
290+
if err := conn.Hello(ctx, protocol, username, password, "").Err(); err == nil {
286291
auth = true
287292
} else if !isRedisError(err) {
288293
// When the server responds with the RESP protocol and the result is not a normal

‎redis_test.go

+27
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,33 @@ var _ = Describe("Client", func() {
185185
Expect(val).Should(ContainSubstring("name=hi"))
186186
})
187187

188+
It("should client PROTO 2", func() {
189+
opt := redisOptions()
190+
opt.Protocol = 2
191+
db := redis.NewClient(opt)
192+
193+
defer func() {
194+
Expect(db.Close()).NotTo(HaveOccurred())
195+
}()
196+
197+
val, err := db.Do(ctx, "HELLO").Result()
198+
Expect(err).NotTo(HaveOccurred())
199+
Expect(val).Should(ContainElements("proto", int64(2)))
200+
})
201+
202+
It("should client PROTO 3", func() {
203+
opt := redisOptions()
204+
db := redis.NewClient(opt)
205+
206+
defer func() {
207+
Expect(db.Close()).NotTo(HaveOccurred())
208+
}()
209+
210+
val, err := db.Do(ctx, "HELLO").Result()
211+
Expect(err).NotTo(HaveOccurred())
212+
Expect(val).Should(HaveKeyWithValue("proto", int64(3)))
213+
})
214+
188215
It("processes custom commands", func() {
189216
cmd := redis.NewCmd(ctx, "PING")
190217
_ = client.Process(ctx, cmd)

‎ring.go

+3-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import (
1212
"time"
1313

1414
"github.com/cespare/xxhash/v2"
15-
rendezvous "github.com/dgryski/go-rendezvous" //nolint
15+
"github.com/dgryski/go-rendezvous" //nolint
1616

1717
"github.com/redis/go-redis/v9/internal"
1818
"github.com/redis/go-redis/v9/internal/hashtag"
@@ -70,6 +70,7 @@ type RingOptions struct {
7070
Dialer func(ctx context.Context, network, addr string) (net.Conn, error)
7171
OnConnect func(ctx context.Context, cn *Conn) error
7272

73+
Protocol int
7374
Username string
7475
Password string
7576
DB int
@@ -136,6 +137,7 @@ func (opt *RingOptions) clientOptions() *Options {
136137
Dialer: opt.Dialer,
137138
OnConnect: opt.OnConnect,
138139

140+
Protocol: opt.Protocol,
139141
Username: opt.Username,
140142
Password: opt.Password,
141143
DB: opt.DB,

‎ring_test.go

+40
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,37 @@ import (
1515
"github.com/redis/go-redis/v9"
1616
)
1717

18+
var _ = Describe("Redis Ring PROTO 2", func() {
19+
const heartbeat = 100 * time.Millisecond
20+
21+
var ring *redis.Ring
22+
23+
BeforeEach(func() {
24+
opt := redisRingOptions()
25+
opt.Protocol = 2
26+
opt.HeartbeatFrequency = heartbeat
27+
ring = redis.NewRing(opt)
28+
29+
err := ring.ForEachShard(ctx, func(ctx context.Context, cl *redis.Client) error {
30+
return cl.FlushDB(ctx).Err()
31+
})
32+
Expect(err).NotTo(HaveOccurred())
33+
})
34+
35+
AfterEach(func() {
36+
Expect(ring.Close()).NotTo(HaveOccurred())
37+
})
38+
39+
It("should ring PROTO 2", func() {
40+
_ = ring.ForEachShard(ctx, func(ctx context.Context, c *redis.Client) error {
41+
val, err := c.Do(ctx, "HELLO").Result()
42+
Expect(err).NotTo(HaveOccurred())
43+
Expect(val).Should(ContainElements("proto", int64(2)))
44+
return nil
45+
})
46+
})
47+
})
48+
1849
var _ = Describe("Redis Ring", func() {
1950
const heartbeat = 100 * time.Millisecond
2051

@@ -65,6 +96,15 @@ var _ = Describe("Redis Ring", func() {
6596
})
6697
})
6798

99+
It("should ring PROTO 3", func() {
100+
_ = ring.ForEachShard(ctx, func(ctx context.Context, c *redis.Client) error {
101+
val, err := c.Do(ctx, "HELLO").Result()
102+
Expect(err).NotTo(HaveOccurred())
103+
Expect(val).Should(HaveKeyWithValue("proto", int64(3)))
104+
return nil
105+
})
106+
})
107+
68108
It("distributes keys", func() {
69109
setRingKeys()
70110

‎sentinel.go

+3
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ type FailoverOptions struct {
5454
Dialer func(ctx context.Context, network, addr string) (net.Conn, error)
5555
OnConnect func(ctx context.Context, cn *Conn) error
5656

57+
Protocol int
5758
Username string
5859
Password string
5960
DB int
@@ -88,6 +89,7 @@ func (opt *FailoverOptions) clientOptions() *Options {
8889
OnConnect: opt.OnConnect,
8990

9091
DB: opt.DB,
92+
Protocol: opt.Protocol,
9193
Username: opt.Username,
9294
Password: opt.Password,
9395

@@ -151,6 +153,7 @@ func (opt *FailoverOptions) clusterOptions() *ClusterOptions {
151153
Dialer: opt.Dialer,
152154
OnConnect: opt.OnConnect,
153155

156+
Protocol: opt.Protocol,
154157
Username: opt.Username,
155158
Password: opt.Password,
156159

‎sentinel_test.go

+67
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,30 @@ import (
1010
"github.com/redis/go-redis/v9"
1111
)
1212

13+
var _ = Describe("Sentinel PROTO 2", func() {
14+
var client *redis.Client
15+
16+
BeforeEach(func() {
17+
client = redis.NewFailoverClient(&redis.FailoverOptions{
18+
MasterName: sentinelName,
19+
SentinelAddrs: sentinelAddrs,
20+
MaxRetries: -1,
21+
Protocol: 2,
22+
})
23+
Expect(client.FlushDB(ctx).Err()).NotTo(HaveOccurred())
24+
})
25+
26+
AfterEach(func() {
27+
_ = client.Close()
28+
})
29+
30+
It("should sentinel client PROTO 2", func() {
31+
val, err := client.Do(ctx, "HELLO").Result()
32+
Expect(err).NotTo(HaveOccurred())
33+
Expect(val).Should(ContainElements("proto", int64(2)))
34+
})
35+
})
36+
1337
var _ = Describe("Sentinel", func() {
1438
var client *redis.Client
1539
var master *redis.Client
@@ -134,6 +158,40 @@ var _ = Describe("Sentinel", func() {
134158
Expect(err).NotTo(HaveOccurred())
135159
Expect(val).Should(ContainSubstring("name=sentinel_hi"))
136160
})
161+
162+
It("should sentinel client PROTO 3", func() {
163+
val, err := client.Do(ctx, "HELLO").Result()
164+
Expect(err).NotTo(HaveOccurred())
165+
Expect(val).Should(HaveKeyWithValue("proto", int64(3)))
166+
})
167+
})
168+
169+
var _ = Describe("NewFailoverClusterClient PROTO 2", func() {
170+
var client *redis.ClusterClient
171+
172+
BeforeEach(func() {
173+
client = redis.NewFailoverClusterClient(&redis.FailoverOptions{
174+
MasterName: sentinelName,
175+
SentinelAddrs: sentinelAddrs,
176+
Protocol: 2,
177+
178+
RouteRandomly: true,
179+
})
180+
Expect(client.FlushDB(ctx).Err()).NotTo(HaveOccurred())
181+
})
182+
183+
AfterEach(func() {
184+
_ = client.Close()
185+
})
186+
187+
It("should sentinel cluster PROTO 2", func() {
188+
_ = client.ForEachShard(ctx, func(ctx context.Context, c *redis.Client) error {
189+
val, err := client.Do(ctx, "HELLO").Result()
190+
Expect(err).NotTo(HaveOccurred())
191+
Expect(val).Should(ContainElements("proto", int64(2)))
192+
return nil
193+
})
194+
})
137195
})
138196

139197
var _ = Describe("NewFailoverClusterClient", func() {
@@ -237,6 +295,15 @@ var _ = Describe("NewFailoverClusterClient", func() {
237295
return nil
238296
})
239297
})
298+
299+
It("should sentinel cluster PROTO 3", func() {
300+
_ = client.ForEachShard(ctx, func(ctx context.Context, c *redis.Client) error {
301+
val, err := client.Do(ctx, "HELLO").Result()
302+
Expect(err).NotTo(HaveOccurred())
303+
Expect(val).Should(HaveKeyWithValue("proto", int64(3)))
304+
return nil
305+
})
306+
})
240307
})
241308

242309
var _ = Describe("SentinelAclAuth", func() {

‎universal.go

+4
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ type UniversalOptions struct {
2626
Dialer func(ctx context.Context, network, addr string) (net.Conn, error)
2727
OnConnect func(ctx context.Context, cn *Conn) error
2828

29+
Protocol int
2930
Username string
3031
Password string
3132
SentinelUsername string
@@ -77,6 +78,7 @@ func (o *UniversalOptions) Cluster() *ClusterOptions {
7778
Dialer: o.Dialer,
7879
OnConnect: o.OnConnect,
7980

81+
Protocol: o.Protocol,
8082
Username: o.Username,
8183
Password: o.Password,
8284

@@ -122,6 +124,7 @@ func (o *UniversalOptions) Failover() *FailoverOptions {
122124
OnConnect: o.OnConnect,
123125

124126
DB: o.DB,
127+
Protocol: o.Protocol,
125128
Username: o.Username,
126129
Password: o.Password,
127130
SentinelUsername: o.SentinelUsername,
@@ -162,6 +165,7 @@ func (o *UniversalOptions) Simple() *Options {
162165
OnConnect: o.OnConnect,
163166

164167
DB: o.DB,
168+
Protocol: o.Protocol,
165169
Username: o.Username,
166170
Password: o.Password,
167171

0 commit comments

Comments
 (0)