Merge branch 'master' into add-conn-pool-wait-stats

lzakharov · web-flow · commit 2837660e062c · 2024-02-29T10:51:36.000+03:00
diff --git a/.github/wordlist.txt b/.github/wordlist.txt
@@ -2,6 +2,7 @@ ACLs
 autoload
 autoloader
 autoloading
+analytics
 Autoloading
 backend
 backends
@@ -13,6 +14,7 @@ customizable
 Customizable
 dataset
 de
+DisableIdentity
 ElastiCache
 extensibility
 FPM
@@ -43,6 +45,7 @@ RocksDB
 runtime
 SHA
 sharding
+SETNAME
 SSL
 struct
 stunnel
diff --git a/README.md b/README.md
@@ -161,6 +161,30 @@ func ExampleClient() *redis.Client {
 
 ```
 
+
+### Advanced Configuration
+
+go-redis supports extending the client identification phase to allow projects to send their own custom client identification.
+
+#### Default Client Identification
+
+By default, go-redis automatically sends the client library name and version during the connection process. This feature is available in redis-server as of version 7.2. As a result, the command is "fire and forget", meaning it should fail silently, in the case that the redis server does not support this feature.
+
+#### Disabling Identity Verification
+
+When connection identity verification is not required or needs to be explicitly disabled, a `DisableIndentity` configuration option exists. In V10 of this library, `DisableIndentity` will become `DisableIdentity` in order to fix the associated typo.
+
+To disable verification, set the `DisableIndentity` option to `true` in the Redis client options:
+
+```go
+rdb := redis.NewClient(&redis.Options{
+    Addr:            "localhost:6379",
+    Password:        "",
+    DB:              0,
+    DisableIndentity: true, // Disable set-info on connect
+})
+```
+
 ## Contributing
 
 Please see [out contributing guidelines](CONTRIBUTING.md) to help us improve this library!
diff --git a/commands.go b/commands.go
@@ -309,7 +309,7 @@ func (c statefulCmdable) ClientSetInfo(ctx context.Context, info LibraryInfo) *S
 
 	var cmd *StatusCmd
 	if info.LibName != nil {
-		libName := fmt.Sprintf("go-redis(%s,%s)", *info.LibName, runtime.Version())
+		libName := fmt.Sprintf("go-redis(%s,%s)", *info.LibName, internal.ReplaceSpaces(runtime.Version()))
 		cmd = NewStatusCmd(ctx, "client", "setinfo", "LIB-NAME", libName)
 	} else {
 		cmd = NewStatusCmd(ctx, "client", "setinfo", "LIB-VER", *info.LibVer)
diff --git a/commands_test.go b/commands_test.go
@@ -2105,7 +2105,7 @@ var _ = Describe("Commands", func() {
 
 			logEntries, err := client.ACLLog(ctx, 10).Result()
 			Expect(err).NotTo(HaveOccurred())
-			Expect(len(logEntries)).To(Equal(1))
+			Expect(len(logEntries)).To(Equal(4))
 
 			for _, entry := range logEntries {
 				Expect(entry.Reason).To(Equal("command"))
@@ -2121,7 +2121,7 @@ var _ = Describe("Commands", func() {
 
 			limitedLogEntries, err := client.ACLLog(ctx, 2).Result()
 			Expect(err).NotTo(HaveOccurred())
-			Expect(len(limitedLogEntries)).To(Equal(1))
+			Expect(len(limitedLogEntries)).To(Equal(2))
 		})
 
 		It("should ACL LOG RESET", Label("NonRedisEnterprise"), func() {
diff --git a/example/del-keys-without-ttl/go.mod b/example/del-keys-without-ttl/go.mod
@@ -5,7 +5,7 @@ go 1.18
 replace github.com/redis/go-redis/v9 => ../..
 
 require (
-	github.com/redis/go-redis/v9 v9.5.0
+	github.com/redis/go-redis/v9 v9.5.1
 	go.uber.org/zap v1.24.0
 )
 
diff --git a/example/hll/go.mod b/example/hll/go.mod
@@ -4,7 +4,7 @@ go 1.18
 
 replace github.com/redis/go-redis/v9 => ../..
 
-require github.com/redis/go-redis/v9 v9.5.0
+require github.com/redis/go-redis/v9 v9.5.1
 
 require (
 	github.com/cespare/xxhash/v2 v2.2.0 // indirect
diff --git a/example/lua-scripting/go.mod b/example/lua-scripting/go.mod
@@ -4,7 +4,7 @@ go 1.18
 
 replace github.com/redis/go-redis/v9 => ../..
 
-require github.com/redis/go-redis/v9 v9.5.0
+require github.com/redis/go-redis/v9 v9.5.1
 
 require (
 	github.com/cespare/xxhash/v2 v2.2.0 // indirect
diff --git a/example/otel/go.mod b/example/otel/go.mod
@@ -9,8 +9,8 @@ replace github.com/redis/go-redis/extra/redisotel/v9 => ../../extra/redisotel
 replace github.com/redis/go-redis/extra/rediscmd/v9 => ../../extra/rediscmd
 
 require (
-	github.com/redis/go-redis/extra/redisotel/v9 v9.5.0
-	github.com/redis/go-redis/v9 v9.5.0
+	github.com/redis/go-redis/extra/redisotel/v9 v9.5.1
+	github.com/redis/go-redis/v9 v9.5.1
 	github.com/uptrace/uptrace-go v1.21.0
 	go.opentelemetry.io/otel v1.21.0
 )
@@ -23,7 +23,7 @@ require (
 	github.com/go-logr/stdr v1.2.2 // indirect
 	github.com/golang/protobuf v1.5.3 // indirect
 	github.com/grpc-ecosystem/grpc-gateway/v2 v2.19.0 // indirect
-	github.com/redis/go-redis/extra/rediscmd/v9 v9.5.0 // indirect
+	github.com/redis/go-redis/extra/rediscmd/v9 v9.5.1 // indirect
 	go.opentelemetry.io/contrib/instrumentation/runtime v0.46.1 // indirect
 	go.opentelemetry.io/otel/exporters/otlp/internal/retry v1.17.0 // indirect
 	go.opentelemetry.io/otel/exporters/otlp/otlpmetric v0.43.0 // indirect
diff --git a/example/redis-bloom/go.mod b/example/redis-bloom/go.mod
@@ -4,7 +4,7 @@ go 1.18
 
 replace github.com/redis/go-redis/v9 => ../..
 
-require github.com/redis/go-redis/v9 v9.5.0
+require github.com/redis/go-redis/v9 v9.5.1
 
 require (
 	github.com/cespare/xxhash/v2 v2.2.0 // indirect
diff --git a/example/scan-struct/go.mod b/example/scan-struct/go.mod
@@ -6,7 +6,7 @@ replace github.com/redis/go-redis/v9 => ../..
 
 require (
 	github.com/davecgh/go-spew v1.1.1
-	github.com/redis/go-redis/v9 v9.5.0
+	github.com/redis/go-redis/v9 v9.5.1
 )
 
 require (
diff --git a/extra/rediscensus/go.mod b/extra/rediscensus/go.mod
@@ -8,7 +8,7 @@ replace github.com/redis/go-redis/extra/rediscmd/v9 => ../rediscmd
 
 require (
 	github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
-	github.com/redis/go-redis/extra/rediscmd/v9 v9.5.0
-	github.com/redis/go-redis/v9 v9.5.0
+	github.com/redis/go-redis/extra/rediscmd/v9 v9.5.1
+	github.com/redis/go-redis/v9 v9.5.1
 	go.opencensus.io v0.24.0
 )
diff --git a/extra/rediscmd/go.mod b/extra/rediscmd/go.mod
@@ -7,5 +7,5 @@ replace github.com/redis/go-redis/v9 => ../..
 require (
 	github.com/bsm/ginkgo/v2 v2.7.0
 	github.com/bsm/gomega v1.26.0
-	github.com/redis/go-redis/v9 v9.5.0
+	github.com/redis/go-redis/v9 v9.5.1
 )
diff --git a/extra/redisotel/go.mod b/extra/redisotel/go.mod
@@ -7,8 +7,8 @@ replace github.com/redis/go-redis/v9 => ../..
 replace github.com/redis/go-redis/extra/rediscmd/v9 => ../rediscmd
 
 require (
-	github.com/redis/go-redis/extra/rediscmd/v9 v9.5.0
-	github.com/redis/go-redis/v9 v9.5.0
+	github.com/redis/go-redis/extra/rediscmd/v9 v9.5.1
+	github.com/redis/go-redis/v9 v9.5.1
 	go.opentelemetry.io/otel v1.16.0
 	go.opentelemetry.io/otel/metric v1.16.0
 	go.opentelemetry.io/otel/sdk v1.16.0
diff --git a/extra/redisprometheus/go.mod b/extra/redisprometheus/go.mod
@@ -6,7 +6,7 @@ replace github.com/redis/go-redis/v9 => ../..
 
 require (
 	github.com/prometheus/client_golang v1.14.0
-	github.com/redis/go-redis/v9 v9.5.0
+	github.com/redis/go-redis/v9 v9.5.1
 )
 
 require (
diff --git a/internal/util.go b/internal/util.go
@@ -2,6 +2,7 @@ package internal
 
 import (
 	"context"
+	"strings"
 	"time"
 
 	"github.com/redis/go-redis/v9/internal/util"
@@ -44,3 +45,22 @@ func isLower(s string) bool {
 	}
 	return true
 }
+
+func ReplaceSpaces(s string) string {
+	// Pre-allocate a builder with the same length as s to minimize allocations.
+	// This is a basic optimization; adjust the initial size based on your use case.
+	var builder strings.Builder
+	builder.Grow(len(s))
+
+	for _, char := range s {
+		if char == ' ' {
+			// Replace space with a hyphen.
+			builder.WriteRune('-')
+		} else {
+			// Copy the character as-is.
+			builder.WriteRune(char)
+		}
+	}
+
+	return builder.String()
+}
diff --git a/redis.go b/redis.go
@@ -334,22 +334,24 @@ func (c *baseClient) initConn(ctx context.Context, cn *pool.Conn) error {
 			pipe.ClientSetName(ctx, c.opt.ClientName)
 		}
 
-		if !c.opt.DisableIndentity {
-			libName := ""
-			libVer := Version()
-			if c.opt.IdentitySuffix != "" {
-				libName = c.opt.IdentitySuffix
-			}
-			pipe.ClientSetInfo(ctx, WithLibraryName(libName))
-			pipe.ClientSetInfo(ctx, WithLibraryVersion(libVer))
-		}
-
 		return nil
 	})
 	if err != nil {
 		return err
 	}
 
+	if !c.opt.DisableIndentity {
+		libName := ""
+		libVer := Version()
+		if c.opt.IdentitySuffix != "" {
+			libName = c.opt.IdentitySuffix
+		}
+		p := conn.Pipeline()
+		p.ClientSetInfo(ctx, WithLibraryName(libName))
+		p.ClientSetInfo(ctx, WithLibraryVersion(libVer))
+		_, _ = p.Exec(ctx)
+	}
+
 	if c.opt.OnConnect != nil {
 		return c.opt.OnConnect(ctx, conn)
 	}
diff --git a/sentinel.go b/sentinel.go
@@ -153,6 +153,9 @@ func (opt *FailoverOptions) sentinelOptions(addr string) *Options {
 		ConnMaxLifetime: opt.ConnMaxLifetime,
 
 		TLSConfig: opt.TLSConfig,
+
+		DisableIndentity: opt.DisableIndentity,
+		IdentitySuffix:   opt.IdentitySuffix,
 	}
 }
 
@@ -190,6 +193,9 @@ func (opt *FailoverOptions) clusterOptions() *ClusterOptions {
 		ConnMaxLifetime: opt.ConnMaxLifetime,
 
 		TLSConfig: opt.TLSConfig,
+
+		DisableIndentity: opt.DisableIndentity,
+		IdentitySuffix:   opt.IdentitySuffix,
 	}
 }
 
diff --git a/version.go b/version.go
@@ -2,5 +2,5 @@ package redis
 
 // Version is the current release version.
 func Version() string {
-	return "9.5.0"
+	return "9.5.1"
 }

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ go 1.18`
`5`	`5`	`replace github.com/redis/go-redis/v9 => ../..`
`6`	`6`
`7`	`7`	`require (`
`8`		`- github.com/redis/go-redis/v9 v9.5.0`
	`8`	`+ github.com/redis/go-redis/v9 v9.5.1`
`9`	`9`	`go.uber.org/zap v1.24.0`
`10`	`10`	`)`
`11`	`11`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ replace github.com/redis/go-redis/v9 => ../..`
`6`	`6`
`7`	`7`	`require (`
`8`	`8`	`github.com/davecgh/go-spew v1.1.1`
`9`		`- github.com/redis/go-redis/v9 v9.5.0`
	`9`	`+ github.com/redis/go-redis/v9 v9.5.1`
`10`	`10`	`)`
`11`	`11`
`12`	`12`	`require (`