redis/go-redis
1
0
Fork 0
mirror of https://github.com/redis/go-redis.git synced 2025-04-16 09:23:06 +03:00
Code

Add FailoverClusterClient support for Universal client (#2794)

Browse Source 
* Add FailoverClusterClient support + fix example/hset-struct go.sum

* Improve NewUniversalClient comment

---------

Co-authored-by: Nedyalko Dyakov <nedyalko.dyakov@gmail.com>
This commit is contained in:
Alexander Menshchikov 2025-03-24 15:21:08 +03:00 committed by GitHub
parent 15059395a1
commit d86395694d
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 28 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
universal.go
View File

@ -154,6 +154,9 @@ func (o *UniversalOptions) Failover() *FailoverOptions {
SentinelUsername: o.SentinelUsername, SentinelUsername: o.SentinelUsername,
SentinelPassword: o.SentinelPassword, SentinelPassword: o.SentinelPassword,
RouteByLatency: o.RouteByLatency,
RouteRandomly: o.RouteRandomly,
MaxRetries: o.MaxRetries, MaxRetries: o.MaxRetries,
MinRetryBackoff: o.MinRetryBackoff, MinRetryBackoff: o.MinRetryBackoff,
MaxRetryBackoff: o.MaxRetryBackoff, MaxRetryBackoff: o.MaxRetryBackoff,
@ -256,14 +259,22 @@ var (
// NewUniversalClient returns a new multi client. The type of the returned client depends // NewUniversalClient returns a new multi client. The type of the returned client depends
// on the following conditions: // on the following conditions:
// //
// 1. If the MasterName option is specified, a sentinel-backed FailoverClient is returned. // 1. If the MasterName option is specified with RouteByLatency, RouteRandomly or IsClusterMode,
// 2. if the number of Addrs is two or more, a ClusterClient is returned. // a FailoverClusterClient is returned.
// 3. Otherwise, a single-node Client is returned. // 2. If the MasterName option is specified without RouteByLatency, RouteRandomly or IsClusterMode,
// a sentinel-backed FailoverClient is returned.
// 3. If the number of Addrs is two or more, or IsClusterMode option is specified,
// a ClusterClient is returned.
// 4. Otherwise, a single-node Client is returned.
func NewUniversalClient(opts *UniversalOptions) UniversalClient { func NewUniversalClient(opts *UniversalOptions) UniversalClient {
if opts.MasterName != "" { switch {
case opts.MasterName != "" && (opts.RouteByLatency || opts.RouteRandomly || opts.IsClusterMode):
return NewFailoverClusterClient(opts.Failover())
case opts.MasterName != "":
return NewFailoverClient(opts.Failover()) return NewFailoverClient(opts.Failover())
} else if len(opts.Addrs) > 1 || opts.IsClusterMode { case len(opts.Addrs) > 1 || opts.IsClusterMode:
return NewClusterClient(opts.Cluster()) return NewClusterClient(opts.Cluster())
default:
return NewClient(opts.Simple())
} }
return NewClient(opts.Simple())
} }

12
universal_test.go
View File

@ -24,6 +24,16 @@ var _ = Describe("UniversalClient", func() {
Expect(client.Ping(ctx).Err()).NotTo(HaveOccurred()) Expect(client.Ping(ctx).Err()).NotTo(HaveOccurred())
}) })
It("should connect to failover cluster", Label("NonRedisEnterprise"), func() {
client = redis.NewUniversalClient(&redis.UniversalOptions{
MasterName: sentinelName,
RouteRandomly: true,
Addrs: sentinelAddrs,
})
_, ok := client.(*redis.ClusterClient)
Expect(ok).To(BeTrue(), "expected a ClusterClient")
})
It("should connect to simple servers", func() { It("should connect to simple servers", func() {
client = redis.NewUniversalClient(&redis.UniversalOptions{ client = redis.NewUniversalClient(&redis.UniversalOptions{
Addrs: []string{redisAddr}, Addrs: []string{redisAddr},
@ -79,6 +89,7 @@ var _ = Describe("UniversalClient", func() {
err = client.Set(ctx, "somekey", "somevalue", 0).Err() err = client.Set(ctx, "somekey", "somevalue", 0).Err()
Expect(err).To(HaveOccurred()) Expect(err).To(HaveOccurred())
}) })
It("should connect to clusters if IsClusterMode is set even if only a single address is provided", Label("NonRedisEnterprise"), func() { It("should connect to clusters if IsClusterMode is set even if only a single address is provided", Label("NonRedisEnterprise"), func() {
client = redis.NewUniversalClient(&redis.UniversalOptions{ client = redis.NewUniversalClient(&redis.UniversalOptions{
Addrs: []string{cluster.addrs()[0]}, Addrs: []string{cluster.addrs()[0]},
@ -96,4 +107,3 @@ var _ = Describe("UniversalClient", func() {
Expect(client.ClusterSlots(ctx).Val()).To(HaveLen(3)) Expect(client.ClusterSlots(ctx).Val()).To(HaveLen(3))
}) })
}) })