.circleci/config.yml

@@ -1,79 +1,23 @@
 version: 2.1
+setup: true
 orbs:
   go: circleci/go@1.7.3
+  continuation: circleci/continuation@0.1.2
 jobs:
-  build:
-    machine:
-      image: ubuntu-2204:current
-    resource_class: large
-    parallelism: 3
+  setup:
+    executor: continuation/default
     steps:
       - checkout
-      - go/install:
-          version: 1.21.0
-      - run: # test ./go.mod
-          command: |
-            list=$(go list ./... | circleci tests split --split-by=timings)
-            echo "Test Packages: $list"
-            for n in {1..5}; do ./dockertest.sh $list && break; done
-          no_output_timeout: 15m
-
-      - run: # test ./rueidishook/go.mod
-          command: |
-            cd $CIRCLE_WORKING_DIRECTORY/rueidishook
-            list=$(go list ./... | circleci tests split --split-by=timings)
-            echo "Test Packages: $list"
-            for n in {1..5}; do ../dockertest.sh $list && break; done
-          no_output_timeout: 15m
-
-      - run: # test ./mock/go.mod
-          command: |
-            cd $CIRCLE_WORKING_DIRECTORY/mock
-            list=$(go list ./... | circleci tests split --split-by=timings)
-            echo "Test Packages: $list"
-            for n in {1..5}; do ../dockertest.sh $list && break; done
-          no_output_timeout: 15m
-
-      - run: # test ./om/go.mod
-          command: |
-            cd $CIRCLE_WORKING_DIRECTORY/om
-            list=$(go list ./... | circleci tests split --split-by=timings)
-            echo "Test Packages: $list"
-            for n in {1..5}; do ../dockertest.sh $list && break; done
-          no_output_timeout: 15m
-
-      - run: # test ./rueidisaside/go.mod
-          command: |
-            cd $CIRCLE_WORKING_DIRECTORY/rueidisaside
-            list=$(go list ./... | circleci tests split --split-by=timings)
-            echo "Test Packages: $list"
-            for n in {1..5}; do ../dockertest.sh $list && break; done
-          no_output_timeout: 15m
-
-      - run: # test ./rueidiscompat/go.mod
-          command: |
-            cd $CIRCLE_WORKING_DIRECTORY/rueidiscompat
-            list=$(go list ./... | circleci tests split --split-by=timings)
-            echo "Test Packages: $list"
-            for n in {1..5}; do ../dockertest.sh $list && break; done
-          no_output_timeout: 15m
-
-      - run: # test ./rueidisotel/go.mod
-          command: |
-            cd $CIRCLE_WORKING_DIRECTORY/rueidisotel
-            list=$(go list ./... | circleci tests split --split-by=timings)
-            echo "Test Packages: $list"
-            for n in {1..5}; do ../dockertest.sh $list && break; done
-          no_output_timeout: 15m
-
-      - run: # test ./rueidisprob/go.mod
-          command: |
-            cd $CIRCLE_WORKING_DIRECTORY/rueidisprob
-            list=$(go list ./... | circleci tests split --split-by=timings)
-            echo "Test Packages: $list"
-            for n in {1..5}; do ../dockertest.sh $list && break; done
-          no_output_timeout: 15m
-
-      - store_test_results:
-          path: .
-      - run: curl -Os https://uploader.codecov.io/latest/linux/codecov && chmod +x codecov && ./codecov -t ${CODECOV_TOKEN}
+      - run:
+          name: Generate config
+          # Generate dynamic configuration based on go.mod files
+          command: |
+            ./.circleci/generate_config.sh > generated_config.yml
+      - continuation/continue:
+          configuration_path: generated_config.yml # use newly generated config to continue
+
+# our single workflow, that triggers the setup job defined above
+workflows:
+  setup:
+    jobs:
+      - setup

.circleci/generate_config.sh

@@ -0,0 +1,58 @@
+#!/usr/bin/env bash
+
+# Find all directories containing go.mod files
+modules=$(find . -maxdepth 2 -type f -name "go.mod" | xargs -n 1 dirname | sort -u)
+
+# Start the generated config with the version
+cat << EOF
+version: 2.1
+orbs:
+  go: circleci/go@1.7.3
+jobs:
+  build:
+    machine:
+      image: ubuntu-2204:current
+    resource_class: large
+    parallelism: 3
+    steps:
+      - checkout
+      - go/install:
+          version: 1.21.0
+EOF
+
+# Loop through each module and generate job configurations
+for module in $modules; do
+  module_name=$(basename "$module")
+  if [ "$module_name" = "." ]; then
+    cat << EOF
+      - run: # test ./go.mod
+          name: Test $module_name
+          command: |
+            list=\$(go list ./... | circleci tests split --split-by=timings)
+            echo "Test Packages: \$list"
+            for n in {1..5}; do
+              ./dockertest.sh \$list && break
+            done
+          no_output_timeout: 15m
+EOF
+  else
+    cat << EOF
+      - run: # test ./$module_name/go.mod
+          name: Test $module_name
+          command: |
+            cd "\$CIRCLE_WORKING_DIRECTORY/$module_name"
+            list=\$(go list ./... | circleci tests split --split-by=timings)
+            echo "Test Packages: \$list"
+            for n in {1..5}; do
+              ../dockertest.sh \$list && break
+            done
+          no_output_timeout: 15m
+EOF
+  fi
+done
+
+cat << EOF
+      - store_test_results:
+          path: .
+      - run: curl -Os https://uploader.codecov.io/latest/linux/codecov && chmod +x codecov && ./codecov -t ${CODECOV_TOKEN}
+EOF

README.md

@@ -484,6 +484,57 @@ client.Do(ctx, client.B().FtSearch().Index("idx").Query("@f:v").Build()).AsFtSea
 client.Do(ctx, client.B().Geosearch().Key("k").Fromlonlat(1, 1).Bybox(1).Height(1).Km().Build()).AsGeosearch()
 ```
 
+## Use DecodeSliceOfJSON to scan array result
+
+DecodeSliceOfJSON is useful when you would like to scan the results of an array into a slice of a specific struct.
+
+```golang
+type User struct {
+	Name string `json:"name"`
+}
+
+// Set some values
+if err = client.Do(ctx, client.B().Set().Key("user1").Value(`{"name": "name1"}`).Build()).Error(); err != nil {
+	return err
+}
+if err = client.Do(ctx, client.B().Set().Key("user2").Value(`{"name": "name2"}`).Build()).Error(); err != nil {
+	return err
+}
+
+// Scan MGET results into []*User
+var users []*User // or []User is also scannable
+if err := rueidis.DecodeSliceOfJSON(client.Do(ctx, client.B().Mget().Key("user1", "user2").Build()), &users); err != nil {
+	return err
+}
+
+for _, user := range users {
+	fmt.Printf("%+v\n", user)
+}
+/*
+&{name:name1}
+&{name:name2}
+*/
+```
+
+### !!!!!! DO NOT DO THIS !!!!!!
+
+Please make sure that all values in the result have same JSON structure.
+
+```golang
+// Set a pure string value
+if err = client.Do(ctx, client.B().Set().Key("user1").Value("userName1").Build()).Error(); err != nil {
+	return err
+}
+
+// Bad
+users := make([]*User, 0)
+if err := rueidis.DecodeSliceOfJSON(client.Do(ctx, client.B().Mget().Key("user1").Build()), &users); err != nil {
+	return err
+}
+// -> Error: invalid character 'u' looking for beginning of value
+// in this case, use client.Do(ctx, client.B().Mget().Key("user1").Build()).AsStrSlice()
+```
+
 ---
 
 ## Contributing
@@ -502,4 +553,4 @@ go generate
 ### Testing
 
 Please use the [./dockertest.sh](./dockertest.sh) script for running test cases locally.
-And please try your best to have 100% test coverage on code changes.
+And please try your best to have 100% test coverage on code changes.

helper.go

@@ -181,6 +181,28 @@ func JsonMSet(client Client, ctx context.Context, kvs map[string]string, path st
 	return doMultiSet(client, ctx, cmds.s)
 }
 
+// DecodeSliceOfJSON is a helper that struct-scans each RedisMessage into dest, which must be a slice of pointer.
+func DecodeSliceOfJSON[T any](result RedisResult, dest *[]T) error {
+	values, err := result.ToArray()
+	if err != nil {
+		return err
+	}
+
+	ts := make([]T, len(values))
+	for i, v := range values {
+		var t T
+		if err = v.DecodeJSON(&t); err != nil {
+			if IsRedisNil(err) {
+				continue
+			}
+			return err
+		}
+		ts[i] = t
+	}
+	*dest = ts
+	return nil
+}
+
 func clientMGet(client Client, ctx context.Context, cmd Completed, keys []string) (ret map[string]RedisMessage, err error) {
 	arr, err := client.Do(ctx, cmd).ToArray()
 	if err != nil {

helper_test.go

@@ -812,3 +812,110 @@ func TestJsonMSet(t *testing.T) {
 		})
 	})
 }
+
+func TestDecodeSliceOfJSON(t *testing.T) {
+	type Inner struct {
+		Field string
+	}
+	type T struct {
+		ID     int
+		Name   string
+		Inners []*Inner
+	}
+	values := []RedisMessage{
+		{string: `{"ID":1, "Name": "n1", "Inners": [{"Field": "f1"}]}`, typ: '+'},
+		{string: `{"ID":2, "Name": "n2", "Inners": [{"Field": "f2"}]}`, typ: '+'},
+	}
+	result := RedisResult{val: RedisMessage{typ: '*', values: values}}
+
+	t.Run("Scan []*T", func(t *testing.T) {
+		got := make([]*T, 0)
+		want := []*T{
+			{ID: 1, Name: "n1", Inners: []*Inner{{Field: "f1"}}},
+			{ID: 2, Name: "n2", Inners: []*Inner{{Field: "f2"}}},
+		}
+		if err := DecodeSliceOfJSON(result, &got); err != nil {
+			t.Fatal(err)
+		}
+		if !reflect.DeepEqual(want, got) {
+			t.Fatalf("DecodeSliceOfJSON not get value as expected %v", got)
+		}
+	})
+
+	t.Run("Scan []T", func(t *testing.T) {
+		got := make([]T, 0)
+		want := []T{
+			{ID: 1, Name: "n1", Inners: []*Inner{{Field: "f1"}}},
+			{ID: 2, Name: "n2", Inners: []*Inner{{Field: "f2"}}},
+		}
+		if err := DecodeSliceOfJSON(result, &got); err != nil {
+			t.Fatal(err)
+		}
+		if !reflect.DeepEqual(want, got) {
+			t.Fatalf("DecodeSliceOfJSON not get value as expected %v", got)
+		}
+	})
+
+	t.Run("Scan []*T: has nil error message", func(t *testing.T) {
+		hasNilValues := []RedisMessage{
+			{string: `{"ID":1, "Name": "n1", "Inners": [{"Field": "f1"}]}`, typ: '+'},
+			{typ: '_'},
+			{string: `{"ID":2, "Name": "n2", "Inners": [{"Field": "f2"}]}`, typ: '+'},
+		}
+		hasNilResult := RedisResult{val: RedisMessage{typ: '*', values: hasNilValues}}
+
+		got := make([]*T, 0)
+		want := []*T{
+			{ID: 1, Name: "n1", Inners: []*Inner{{Field: "f1"}}},
+			nil,
+			{ID: 2, Name: "n2", Inners: []*Inner{{Field: "f2"}}},
+		}
+		if err := DecodeSliceOfJSON(hasNilResult, &got); err != nil {
+			t.Fatal(err)
+		}
+		if !reflect.DeepEqual(want, got) {
+			t.Fatalf("DecodeSliceOfJSON not get value as expected %v", got)
+		}
+	})
+
+	t.Run("Scan []T: has nil error message", func(t *testing.T) {
+		hasNilValues := []RedisMessage{
+			{string: `{"ID":1, "Name": "n1", "Inners": [{"Field": "f1"}]}`, typ: '+'},
+			{typ: '_'},
+			{string: `{"ID":2, "Name": "n2", "Inners": [{"Field": "f2"}]}`, typ: '+'},
+		}
+		hasNilResult := RedisResult{val: RedisMessage{typ: '*', values: hasNilValues}}
+
+		got := make([]T, 0)
+		want := []T{
+			{ID: 1, Name: "n1", Inners: []*Inner{{Field: "f1"}}},
+			{ID: 0, Name: "", Inners: nil},
+			{ID: 2, Name: "n2", Inners: []*Inner{{Field: "f2"}}},
+		}
+		if err := DecodeSliceOfJSON(hasNilResult, &got); err != nil {
+			t.Fatal(err)
+		}
+		if !reflect.DeepEqual(want, got) {
+			t.Fatalf("DecodeSliceOfJSON not get value as expected %v", got)
+		}
+	})
+
+	t.Run("error result", func(t *testing.T) {
+		if err := DecodeSliceOfJSON(RedisResult{val: RedisMessage{typ: '-'}}, &[]*T{}); err == nil {
+			t.Fatal("DecodeSliceOfJSON not failed as expected")
+		}
+	})
+
+	t.Run("has non-nil error message in result", func(t *testing.T) {
+		hasErrValues := []RedisMessage{
+			{string: `{"ID":1, "Name": "n1", "Inners": [{"Field": "f1"}]}`, typ: '+'},
+			{string: `invalid`, typ: '-'},
+		}
+		hasErrResult := RedisResult{val: RedisMessage{typ: '*', values: hasErrValues}}
+
+		got := make([]*T, 0)
+		if err := DecodeSliceOfJSON(hasErrResult, &got); err == nil {
+			t.Fatal("DecodeSliceOfJSON not failed as expected")
+		}
+	})
+}

mock/go.mod

@@ -5,7 +5,7 @@ go 1.20
 replace github.com/redis/rueidis => ../
 
 require (
-	github.com/redis/rueidis v1.0.33
+	github.com/redis/rueidis v1.0.34
 	go.uber.org/mock v0.3.0
 )
 

om/go.mod

@@ -6,7 +6,7 @@ replace github.com/redis/rueidis => ../
 
 require (
 	github.com/oklog/ulid/v2 v2.1.0
-	github.com/redis/rueidis v1.0.33
+	github.com/redis/rueidis v1.0.34
 )
 
 require golang.org/x/sys v0.17.0 // indirect

pipe.go

@@ -21,7 +21,7 @@ import (
 )
 
 const LibName = "rueidis"
-const LibVer = "1.0.33"
+const LibVer = "1.0.34"
 
 var noHello = regexp.MustCompile("unknown command .?(HELLO|hello).?")
 

rueidisaside/go.mod

@@ -6,7 +6,7 @@ replace github.com/redis/rueidis => ../
 
 require (
 	github.com/oklog/ulid/v2 v2.1.0
-	github.com/redis/rueidis v1.0.33
+	github.com/redis/rueidis v1.0.34
 )
 
 require golang.org/x/sys v0.17.0 // indirect