Merge branch 'master' into sz/master

Author: vmihailenco

.github/workflows/build.yml

@@ -13,7 +13,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        go-version: [1.17.x, 1.18.x]
+        go-version: [1.18.x, 1.19.x]
 
     services:
       redis:

Makefile

@@ -6,6 +6,8 @@ test: testdeps
 	go test ./... -run=NONE -bench=. -benchmem
 	env GOOS=linux GOARCH=386 go test ./...
 	go vet
+	cd internal/customvet && go build .
+	go vet -vettool ./internal/customvet/customvet
 
 testdeps: testdata/redis/src/redis-server
 

command.go

@@ -104,7 +104,7 @@ func cmdString(cmd Cmder, val interface{}) string {
 		b = internal.AppendArg(b, val)
 	}
 
-	return internal.String(b)
+	return util.BytesToString(b)
 }
 
 //------------------------------------------------------------------------------
@@ -1093,6 +1093,10 @@ func NewKeyValueSliceCmd(ctx context.Context, args ...interface{}) *KeyValueSlic
 	}
 }
 
+func (cmd *KeyValueSliceCmd) SetVal(val []KeyValue) {
+	cmd.val = val
+}
+
 func (cmd *KeyValueSliceCmd) Val() []KeyValue {
 	return cmd.val
 }
@@ -1288,40 +1292,40 @@ func (cmd *MapStringStringCmd) readReply(rd *proto.Reader) error {
 
 //------------------------------------------------------------------------------
 
-type StringIntMapCmd struct {
+type MapStringIntCmd struct {
 	baseCmd
 
 	val map[string]int64
 }
 
-var _ Cmder = (*StringIntMapCmd)(nil)
+var _ Cmder = (*MapStringIntCmd)(nil)
 
-func NewStringIntMapCmd(ctx context.Context, args ...interface{}) *StringIntMapCmd {
-	return &StringIntMapCmd{
+func NewMapStringIntCmd(ctx context.Context, args ...interface{}) *MapStringIntCmd {
+	return &MapStringIntCmd{
 		baseCmd: baseCmd{
 			ctx:  ctx,
 			args: args,
 		},
 	}
 }
 
-func (cmd *StringIntMapCmd) SetVal(val map[string]int64) {
+func (cmd *MapStringIntCmd) SetVal(val map[string]int64) {
 	cmd.val = val
 }
 
-func (cmd *StringIntMapCmd) Val() map[string]int64 {
+func (cmd *MapStringIntCmd) Val() map[string]int64 {
 	return cmd.val
 }
 
-func (cmd *StringIntMapCmd) Result() (map[string]int64, error) {
+func (cmd *MapStringIntCmd) Result() (map[string]int64, error) {
 	return cmd.val, cmd.err
 }
 
-func (cmd *StringIntMapCmd) String() string {
+func (cmd *MapStringIntCmd) String() string {
 	return cmdString(cmd, cmd.val)
 }
 
-func (cmd *StringIntMapCmd) readReply(rd *proto.Reader) error {
+func (cmd *MapStringIntCmd) readReply(rd *proto.Reader) error {
 	n, err := rd.ReadMapLen()
 	if err != nil {
 		return err
@@ -3117,6 +3121,10 @@ func NewGeoSearchLocationCmd(
 	}
 }
 
+func (cmd *GeoSearchLocationCmd) SetVal(val []GeoLocation) {
+	cmd.val = val
+}
+
 func (cmd *GeoSearchLocationCmd) Val() []GeoLocation {
 	return cmd.val
 }
@@ -3573,6 +3581,10 @@ func NewMapStringInterfaceCmd(ctx context.Context, args ...interface{}) *MapStri
 	}
 }
 
+func (cmd *MapStringInterfaceCmd) SetVal(val map[string]interface{}) {
+	cmd.val = val
+}
+
 func (cmd *MapStringInterfaceCmd) Val() map[string]interface{} {
 	return cmd.val
 }
@@ -3633,6 +3645,10 @@ func NewMapStringStringSliceCmd(ctx context.Context, args ...interface{}) *MapSt
 	}
 }
 
+func (cmd *MapStringStringSliceCmd) SetVal(val []map[string]string) {
+	cmd.val = val
+}
+
 func (cmd *MapStringStringSliceCmd) Val() []map[string]string {
 	return cmd.val
 }

commands.go

@@ -346,7 +346,7 @@ type Cmdable interface {
 
 	Publish(ctx context.Context, channel string, message interface{}) *IntCmd
 	PubSubChannels(ctx context.Context, pattern string) *StringSliceCmd
-	PubSubNumSub(ctx context.Context, channels ...string) *StringIntMapCmd
+	PubSubNumSub(ctx context.Context, channels ...string) *MapStringIntCmd
 	PubSubNumPat(ctx context.Context) *IntCmd
 
 	ClusterSlots(ctx context.Context) *ClusterSlotsCmd
@@ -3088,14 +3088,14 @@ func (c cmdable) PubSubChannels(ctx context.Context, pattern string) *StringSlic
 	return cmd
 }
 
-func (c cmdable) PubSubNumSub(ctx context.Context, channels ...string) *StringIntMapCmd {
+func (c cmdable) PubSubNumSub(ctx context.Context, channels ...string) *MapStringIntCmd {
 	args := make([]interface{}, 2+len(channels))
 	args[0] = "pubsub"
 	args[1] = "numsub"
 	for i, channel := range channels {
 		args[2+i] = channel
 	}
-	cmd := NewStringIntMapCmd(ctx, args...)
+	cmd := NewMapStringIntCmd(ctx, args...)
 	_ = c(ctx, cmd)
 	return cmd
 }

internal/arg.go

@@ -4,14 +4,16 @@ import (
 	"fmt"
 	"strconv"
 	"time"
+
+	"github.com/go-redis/redis/v9/internal/util"
 )
 
 func AppendArg(b []byte, v interface{}) []byte {
 	switch v := v.(type) {
 	case nil:
 		return append(b, "<nil>"...)
 	case string:
-		return appendUTF8String(b, Bytes(v))
+		return appendUTF8String(b, util.StringToBytes(v))
 	case []byte:
 		return appendUTF8String(b, v)
 	case int:

internal/customvet/.gitignore

@@ -0,0 +1 @@
+/customvet

internal/customvet/checks/setval/setval.go

@@ -0,0 +1,61 @@
+package setval
+
+import (
+	"go/ast"
+	"go/token"
+	"go/types"
+	"golang.org/x/tools/go/analysis"
+)
+
+var Analyzer = &analysis.Analyzer{
+	Name: "setval",
+	Doc:  "find Cmder types that are missing a SetVal method",
+
+	Run: func(pass *analysis.Pass) (interface{}, error) {
+		cmderTypes := make(map[string]token.Pos)
+		typesWithSetValMethod := make(map[string]bool)
+
+		for _, file := range pass.Files {
+			for _, decl := range file.Decls {
+				funcName, receiverType := parseFuncDecl(decl, pass.TypesInfo)
+
+				switch funcName {
+				case "Result":
+					cmderTypes[receiverType] = decl.Pos()
+				case "SetVal":
+					typesWithSetValMethod[receiverType] = true
+				}
+			}
+		}
+
+		for cmder, pos := range cmderTypes {
+			if !typesWithSetValMethod[cmder] {
+				pass.Reportf(pos, "%s is missing a SetVal method", cmder)
+			}
+		}
+
+		return nil, nil
+	},
+}
+
+func parseFuncDecl(decl ast.Decl, typesInfo *types.Info) (funcName, receiverType string) {
+	funcDecl, ok := decl.(*ast.FuncDecl)
+	if !ok {
+		return "", "" // Not a function declaration.
+	}
+
+	if funcDecl.Recv == nil {
+		return "", "" // Not a method.
+	}
+
+	if len(funcDecl.Recv.List) != 1 {
+		return "", "" // Unexpected number of receiver arguments. (Can this happen?)
+	}
+
+	receiverTypeObj := typesInfo.TypeOf(funcDecl.Recv.List[0].Type)
+	if receiverTypeObj == nil {
+		return "", "" // Unable to determine the receiver type.
+	}
+
+	return funcDecl.Name.Name, receiverTypeObj.String()
+}

internal/customvet/checks/setval/setval_test.go

@@ -0,0 +1,12 @@
+package setval_test
+
+import (
+	"github.com/go-redis/redis/internal/customvet/checks/setval"
+	"golang.org/x/tools/go/analysis/analysistest"
+	"testing"
+)
+
+func Test(t *testing.T) {
+	testdata := analysistest.TestData()
+	analysistest.Run(t, testdata, setval.Analyzer, "a")
+}

internal/customvet/checks/setval/testdata/src/a/a.go

@@ -0,0 +1,29 @@
+package a
+
+type GoodCmd struct {
+	val int
+}
+
+func (c *GoodCmd) SetVal(val int) {
+	c.val = val
+}
+
+func (c *GoodCmd) Result() (int, error) {
+	return c.val, nil
+}
+
+type BadCmd struct {
+	val int
+}
+
+func (c *BadCmd) Result() (int, error) { // want "\\*a.BadCmd is missing a SetVal method"
+	return c.val, nil
+}
+
+type NotACmd struct {
+	val int
+}
+
+func (c *NotACmd) Val() int {
+	return c.val
+}

internal/customvet/go.mod

@@ -0,0 +1,10 @@
+module github.com/go-redis/redis/internal/customvet
+
+go 1.17
+
+require golang.org/x/tools v0.1.12
+
+require (
+	golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4 // indirect
+	golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f // indirect
+)