Merge pull request #1680 from sky93/main

Add NewFromConnection method for Redis

Author: ReneWerner87

.github/workflows/test-redis.yml

@@ -18,6 +18,9 @@ jobs:
                     - 1.19.x
                     - 1.20.x
                     - 1.21.x
+                    - 1.22.x
+                    - 1.23.x
+                    - 1.24.x
                 redis:
                     - '6.x'
                     - '7.x'

redis/README.md

@@ -21,6 +21,7 @@ A Redis storage driver using [go-redis/redis](https://github.com/go-redis/redis)
 ### Signatures
 ```go
 func New(config ...Config) Storage
+func NewFromConnection(conn redis.UniversalClient) *Storage
 func (s *Storage) Get(key string) ([]byte, error)
 func (s *Storage) Set(key string, val []byte, exp time.Duration) error
 func (s *Storage) Delete(key string) error
@@ -199,6 +200,43 @@ var ConfigDefault = Config{
 }
 ```
 
+### Using an Existing Redis Connection
+If you already have a Redis client configured in your application, you can create a Storage instance directly from that client. This is useful when you want to share an existing connection throughout your application instead of creating a new one.
+
+```go
+import (
+    "github.com/gofiber/storage/redis"
+    redigo "github.com/redis/go-redis/v9"
+    "fmt"
+    "context"
+)
+
+func main() {
+    // Create or reuse a Redis universal client (e.g., redis.NewClient, redis.NewClusterClient, etc.)
+    client := redigo.NewUniversalClient(&redigo.UniversalOptions{
+        Addrs: []string{"127.0.0.1:6379"},
+    })
+
+    // Create a new Storage instance from the existing Redis client
+    store := redis.NewFromConnection(client)
+
+    // Set a value
+    if err := store.Set("john", []byte("doe"), 0); err != nil {
+        panic(err)
+    }
+
+    // Get the value
+    val, err := store.Get("john")
+    if err != nil {
+        panic(err)
+    }
+    fmt.Println("Stored value:", string(val))
+
+    // Clean up
+    store.Close()
+}
+```
+
 ### Example: Using DragonflyDB
 > **Note:** You can use [DragonflyDB](https://dragonflydb.io/) in the same way as Redis.  
 > Simply start a DragonflyDB server and configure it just like Redis. Then, call `New()` and use it exactly as you would with Redis.

redis/redis.go

@@ -13,6 +13,13 @@ type Storage struct {
 	db redis.UniversalClient
 }
 
+// NewFromConnection creates a new instance of Storage using the provided Redis universal client.
+func NewFromConnection(conn redis.UniversalClient) *Storage {
+	return &Storage{
+		db: conn,
+	}
+}
+
 // New creates a new Redis storage instance.
 func New(config ...Config) *Storage {
 	// Set default config

redis/redis_test.go

@@ -539,3 +539,27 @@ func Benchmark_Redis_SetAndDelete(b *testing.B) {
 
 	require.NoError(b, err)
 }
+
+func Test_Redis_NewFromConnection(t *testing.T) {
+	t.Parallel()
+
+	connection := New(Config{
+		Reset: true,
+	})
+
+	testStore := NewFromConnection(connection.Conn())
+
+	err := testStore.Set("foo", []byte("bar"), 0)
+	require.NoError(t, err, "failed to set key in Redis storage")
+
+	val, err := testStore.Get("foo")
+	require.NoError(t, err, "failed to get key from Redis storage")
+	require.Equal(t, []byte("bar"), val, "value mismatch in Redis storage")
+
+	err = testStore.Delete("foo")
+	require.NoError(t, err, "failed to delete key in Redis storage")
+
+	val, err = testStore.Get("foo")
+
+	require.Nil(t, val, "expected value to be nil after deletion")
+}