Merge branch 'master' into 2561

Author: taytzehao

.github/workflows/doctests.yaml

@@ -0,0 +1,41 @@
+name: Documentation Tests
+
+on:
+  push:
+    branches: [master, examples]
+  pull_request:
+    branches: [master, examples]
+
+permissions:
+  contents: read
+
+jobs:
+  doctests:
+    name: doctests
+    runs-on: ubuntu-latest
+
+    services:
+      redis-stack:
+        image: redis/redis-stack-server:latest
+        options: >-
+          --health-cmd "redis-cli ping" --health-interval 10s --health-timeout 5s --health-retries 5
+        ports:
+          - 6379:6379
+
+    strategy:
+      fail-fast: false
+      matrix:
+        go-version: [ "1.18", "1.19", "1.20" ]
+
+    steps:
+      - name: Set up ${{ matrix.go-version }}
+        uses: actions/setup-go@v4
+        with:
+          go-version: ${{ matrix.go-version }}
+
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Test doc examples
+        working-directory: ./doctests
+        run: go test

.gitignore

@@ -1,3 +1,4 @@
 *.rdb
 testdata/*
 .idea/
+.DS_Store

CHANGELOG.md

@@ -1,3 +1,14 @@
+## [9.0.5](https://github.com/redis/go-redis/compare/v9.0.4...v9.0.5) (2023-05-29)
+
+
+### Features
+
+* Add ACL LOG ([#2536](https://github.com/redis/go-redis/issues/2536)) ([31ba855](https://github.com/redis/go-redis/commit/31ba855ddebc38fbcc69a75d9d4fb769417cf602))
+* add field protocol to setupClusterQueryParams ([#2600](https://github.com/redis/go-redis/issues/2600)) ([840c25c](https://github.com/redis/go-redis/commit/840c25cb6f320501886a82a5e75f47b491e46fbe))
+* add protocol option ([#2598](https://github.com/redis/go-redis/issues/2598)) ([3917988](https://github.com/redis/go-redis/commit/391798880cfb915c4660f6c3ba63e0c1a459e2af))
+
+
+
 ## [9.0.4](https://github.com/redis/go-redis/compare/v9.0.3...v9.0.4) (2023-05-01)
 
 

cluster.go

@@ -62,6 +62,7 @@ type ClusterOptions struct {
 
 	OnConnect func(ctx context.Context, cn *Conn) error
 
+	Protocol int
 	Username string
 	Password string
 
@@ -216,6 +217,7 @@ func setupClusterConn(u *url.URL, host string, o *ClusterOptions) (*ClusterOptio
 func setupClusterQueryParams(u *url.URL, o *ClusterOptions) (*ClusterOptions, error) {
 	q := queryOptions{q: u.Query()}
 
+	o.Protocol = q.int("protocol")
 	o.ClientName = q.string("client_name")
 	o.MaxRedirects = q.int("max_redirects")
 	o.ReadOnly = q.bool("read_only")
@@ -263,6 +265,7 @@ func (opt *ClusterOptions) clientOptions() *Options {
 		Dialer:     opt.Dialer,
 		OnConnect:  opt.OnConnect,
 
+		Protocol: opt.Protocol,
 		Username: opt.Username,
 		Password: opt.Password,
 

cluster_test.go

@@ -583,6 +583,35 @@ var _ = Describe("ClusterClient", func() {
 		})
 	}
 
+	Describe("ClusterClient PROTO 2", func() {
+		BeforeEach(func() {
+			opt = redisClusterOptions()
+			opt.Protocol = 2
+			client = cluster.newClusterClient(ctx, opt)
+
+			err := client.ForEachMaster(ctx, func(ctx context.Context, master *redis.Client) error {
+				return master.FlushDB(ctx).Err()
+			})
+			Expect(err).NotTo(HaveOccurred())
+		})
+
+		AfterEach(func() {
+			_ = client.ForEachMaster(ctx, func(ctx context.Context, master *redis.Client) error {
+				return master.FlushDB(ctx).Err()
+			})
+			Expect(client.Close()).NotTo(HaveOccurred())
+		})
+
+		It("should CLUSTER PROTO 2", func() {
+			_ = client.ForEachShard(ctx, func(ctx context.Context, c *redis.Client) error {
+				val, err := c.Do(ctx, "HELLO").Result()
+				Expect(err).NotTo(HaveOccurred())
+				Expect(val).Should(ContainElements("proto", int64(2)))
+				return nil
+			})
+		})
+	})
+
 	Describe("ClusterClient", func() {
 		BeforeEach(func() {
 			opt = redisClusterOptions()
@@ -746,6 +775,15 @@ var _ = Describe("ClusterClient", func() {
 			})
 		})
 
+		It("should CLUSTER PROTO 3", func() {
+			_ = client.ForEachShard(ctx, func(ctx context.Context, c *redis.Client) error {
+				val, err := c.Do(ctx, "HELLO").Result()
+				Expect(err).NotTo(HaveOccurred())
+				Expect(val).Should(HaveKeyWithValue("proto", int64(3)))
+				return nil
+			})
+		})
+
 		It("should CLUSTER MYSHARDID", func() {
 			shardID, err := client.ClusterMyShardID(ctx).Result()
 			Expect(err).NotTo(HaveOccurred())
@@ -1481,6 +1519,10 @@ var _ = Describe("ClusterClient ParseURL", func() {
 			test: "UseDefault",
 			url:  "redis://localhost:123?conn_max_idle_time=",
 			o:    &redis.ClusterOptions{Addrs: []string{"localhost:123"}, ConnMaxIdleTime: 0},
+		}, {
+			test: "Protocol",
+			url:  "redis://localhost:123?protocol=2",
+			o:    &redis.ClusterOptions{Addrs: []string{"localhost:123"}, Protocol: 2},
 		}, {
 			test: "ClientName",
 			url:  "redis://localhost:123?client_name=cluster_hi",

command.go

@@ -340,6 +340,8 @@ func (cmd *Cmd) Bool() (bool, error) {
 
 func toBool(val interface{}) (bool, error) {
 	switch val := val.(type) {
+	case bool:
+		return val, nil
 	case int64:
 		return val != 0, nil
 	case string:
@@ -2373,7 +2375,7 @@ func readStreamGroups(rd *proto.Reader) ([]XInfoStreamGroup, error) {
 				}
 			case "entries-read":
 				group.EntriesRead, err = rd.ReadInt()
-				if err != nil {
+				if err != nil && err != Nil {
 					return nil, err
 				}
 			case "lag":

commands_test.go

@@ -612,7 +612,7 @@ var _ = Describe("Commands", func() {
 			// if too much time (>1s) is used during command execution, it may also cause the test to fail.
 			// so the ObjectIdleTime result should be <=now-start+1s
 			// link: https://github.com/redis/redis/blob/5b48d900498c85bbf4772c1d466c214439888115/src/object.c#L1265-L1272
-			Expect(idleTime.Val()).To(BeNumerically("<=", time.Now().Sub(start)+time.Second))
+			Expect(idleTime.Val()).To(BeNumerically("<=", time.Since(start)+time.Second))
 		})
 
 		It("should Persist", func() {
@@ -5912,6 +5912,97 @@ var _ = Describe("Commands", func() {
 						}
 					}
 				}
+
+				Expect(res.Groups).To(Equal([]redis.XInfoStreamGroup{
+					{
+						Name:            "group1",
+						LastDeliveredID: "3-0",
+						EntriesRead:     3,
+						Lag:             0,
+						PelCount:        3,
+						Pending: []redis.XInfoStreamGroupPending{
+							{ID: "1-0", Consumer: "consumer1", DeliveryTime: time.Time{}, DeliveryCount: 1},
+							{ID: "2-0", Consumer: "consumer1", DeliveryTime: time.Time{}, DeliveryCount: 1},
+						},
+						Consumers: []redis.XInfoStreamConsumer{
+							{
+								Name:       "consumer1",
+								SeenTime:   time.Time{},
+								ActiveTime: time.Time{},
+								PelCount:   2,
+								Pending: []redis.XInfoStreamConsumerPending{
+									{ID: "1-0", DeliveryTime: time.Time{}, DeliveryCount: 1},
+									{ID: "2-0", DeliveryTime: time.Time{}, DeliveryCount: 1},
+								},
+							},
+							{
+								Name:       "consumer2",
+								SeenTime:   time.Time{},
+								ActiveTime: time.Time{},
+								PelCount:   1,
+								Pending: []redis.XInfoStreamConsumerPending{
+									{ID: "3-0", DeliveryTime: time.Time{}, DeliveryCount: 1},
+								},
+							},
+						},
+					},
+					{
+						Name:            "group2",
+						LastDeliveredID: "3-0",
+						EntriesRead:     3,
+						Lag:             0,
+						PelCount:        2,
+						Pending: []redis.XInfoStreamGroupPending{
+							{ID: "2-0", Consumer: "consumer1", DeliveryTime: time.Time{}, DeliveryCount: 1},
+							{ID: "3-0", Consumer: "consumer1", DeliveryTime: time.Time{}, DeliveryCount: 1},
+						},
+						Consumers: []redis.XInfoStreamConsumer{
+							{
+								Name:       "consumer1",
+								SeenTime:   time.Time{},
+								ActiveTime: time.Time{},
+								PelCount:   2,
+								Pending: []redis.XInfoStreamConsumerPending{
+									{ID: "2-0", DeliveryTime: time.Time{}, DeliveryCount: 1},
+									{ID: "3-0", DeliveryTime: time.Time{}, DeliveryCount: 1},
+								},
+							},
+						},
+					},
+				}))
+
+				// entries-read = nil
+				Expect(client.Del(ctx, "xinfo-stream-full-stream").Err()).NotTo(HaveOccurred())
+				id, err := client.XAdd(ctx, &redis.XAddArgs{
+					Stream: "xinfo-stream-full-stream",
+					ID:     "*",
+					Values: []any{"k1", "v1"},
+				}).Result()
+				Expect(err).NotTo(HaveOccurred())
+				Expect(client.XGroupCreateMkStream(ctx, "xinfo-stream-full-stream", "xinfo-stream-full-group", "0").Err()).NotTo(HaveOccurred())
+				res, err = client.XInfoStreamFull(ctx, "xinfo-stream-full-stream", 0).Result()
+				Expect(err).NotTo(HaveOccurred())
+				Expect(res).To(Equal(&redis.XInfoStreamFull{
+					Length:            1,
+					RadixTreeKeys:     1,
+					RadixTreeNodes:    2,
+					LastGeneratedID:   id,
+					MaxDeletedEntryID: "0-0",
+					EntriesAdded:      1,
+					Entries:           []redis.XMessage{{ID: id, Values: map[string]any{"k1": "v1"}}},
+					Groups: []redis.XInfoStreamGroup{
+						{
+							Name:            "xinfo-stream-full-group",
+							LastDeliveredID: "0-0",
+							EntriesRead:     0,
+							Lag:             1,
+							PelCount:        0,
+							Pending:         []redis.XInfoStreamGroupPending{},
+							Consumers:       []redis.XInfoStreamConsumer{},
+						},
+					},
+					RecordedFirstEntryID: id,
+				}))
 			})
 
 			It("should XINFO GROUPS", func() {

doctests/README.md

@@ -0,0 +1,22 @@
+# Command examples for redis.io
+
+These examples appear on the [Redis documentation](https://redis.io) site as part of the tabbed examples interface.
+
+## How to add examples
+
+- Create a Go test file with a meaningful name in the current folder. 
+- Create a single method prefixed with `Example` and write your test in it.
+- Determine the id for the example you're creating and add it as the first line of the file: `// EXAMPLE: set_and_get`.
+- We're using the [Testable Examples](https://go.dev/blog/examples) feature of Go to test the desired output has been written to stdout.
+
+### Special markup
+
+See https://github.com/redis-stack/redis-stack-website#readme for more details.
+
+## How to test the examples
+
+- Start a Redis server locally on port 6379
+- CD into the `doctests` directory
+- Run `go test` to test all examples in the directory.
+- Run `go test filename.go` to test a single file
+

doctests/lpush_lrange_test.go

@@ -0,0 +1,47 @@
+// EXAMPLE: lpush_and_lrange
+// HIDE_START
+package example_commands_test
+
+import (
+	"context"
+	"fmt"
+	"github.com/redis/go-redis/v9"
+)
+
+func ExampleLPushLRange() {
+	ctx := context.Background()
+
+	rdb := redis.NewClient(&redis.Options{
+		Addr:     "localhost:6379",
+		Password: "", // no password docs
+		DB:       0,  // use default DB
+	})
+
+	// HIDE_END
+
+	// REMOVE_START
+	errFlush := rdb.FlushDB(ctx).Err() // Clear the database before each test
+	if errFlush != nil {
+		panic(errFlush)
+	}
+	// REMOVE_END
+
+	listSize, err := rdb.LPush(ctx, "my_bikes", "bike:1", "bike:2").Result()
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println(listSize)
+
+	value, err := rdb.LRange(ctx, "my_bikes", 0, -1).Result()
+	if err != nil {
+		panic(err)
+	}
+	fmt.Println(value)
+	// HIDE_START
+
+	// Output: 2
+	// [bike:2 bike:1]
+}
+
+// HIDE_END

doctests/set_get_test.go

@@ -0,0 +1,47 @@
+// EXAMPLE: set_and_get
+// HIDE_START
+package example_commands_test
+
+import (
+	"context"
+	"fmt"
+	"github.com/redis/go-redis/v9"
+)
+
+func ExampleSetGet() {
+	ctx := context.Background()
+
+	rdb := redis.NewClient(&redis.Options{
+		Addr:     "localhost:6379",
+		Password: "", // no password docs
+		DB:       0,  // use default DB
+	})
+
+	// HIDE_END
+
+	// REMOVE_START
+	errFlush := rdb.FlushDB(ctx).Err() // Clear the database before each test
+	if errFlush != nil {
+		panic(errFlush)
+	}
+	// REMOVE_END
+
+	err := rdb.Set(ctx, "bike:1", "Process 134", 0).Err()
+	if err != nil {
+		panic(err)
+	}
+
+	fmt.Println("OK")
+
+	value, err := rdb.Get(ctx, "bike:1").Result()
+	if err != nil {
+		panic(err)
+	}
+	fmt.Printf("The name of the bike is %s", value)
+	// HIDE_START
+
+	// Output: OK
+	// The name of the bike is Process 134
+}
+
+// HIDE_END