reactor: modify storage inteaface and add contxt.Context

app.go

@@ -41,23 +41,23 @@ type Map map[string]interface{}
 type Storage interface {
 	// Get gets the value for the given key.
 	// `nil, nil` is returned when the key does not exist
-	Get(key string) ([]byte, error)
+	Get(ctx context.Context, key string) ([]byte, error)
 
 	// Set stores the given value for the given key along
 	// with an expiration value, 0 means no expiration.
 	// Empty key or value will be ignored without an error.
-	Set(key string, val []byte, exp time.Duration) error
+	Set(ctx context.Context, key string, val []byte, exp time.Duration) error
 
 	// Delete deletes the value for the given key.
 	// It returns no error if the storage does not contain the key,
-	Delete(key string) error
+	Delete(ctx context.Context, key string) error
 
 	// Reset resets the storage and delete all keys.
-	Reset() error
+	Reset(ctx context.Context) error
 
 	// Close closes the storage and will stop any running garbage
 	// collectors and open connections.
-	Close() error
+	Close(ctx context.Context) error
 }
 
 // ErrorHandler defines a function that will process all errors

ctx.go

@@ -1484,7 +1484,7 @@ func (c *Ctx) SaveFile(fileheader *multipart.FileHeader, path string) error {
 }
 
 // SaveFileToStorage saves any multipart file to an external storage system.
-func (c *Ctx) SaveFileToStorage(fileheader *multipart.FileHeader, path string, storage Storage) error {
+func (c *Ctx) SaveFileToStorage(ctx context.Context, fileheader *multipart.FileHeader, path string, storage Storage) error {
 	file, err := fileheader.Open()
 	if err != nil {
 		return err
@@ -1495,7 +1495,7 @@ func (c *Ctx) SaveFileToStorage(fileheader *multipart.FileHeader, path string, s
 		return err
 	}
 
-	return storage.Set(path, content, 0)
+	return storage.Set(ctx, path, content, 0)
 }
 
 // Secure returns whether a secure connection was established.

internal/memory/memory.go

@@ -3,6 +3,7 @@
 package memory
 
 import (
+	"context"
 	"sync"
 	"sync/atomic"
 	"time"
@@ -31,7 +32,7 @@ func New() *Storage {
 }
 
 // Get value by key
-func (s *Storage) Get(key string) interface{} {
+func (s *Storage) Get(_ context.Context, key string) interface{} {
 	s.RLock()
 	v, ok := s.data[key]
 	s.RUnlock()
@@ -42,7 +43,7 @@ func (s *Storage) Get(key string) interface{} {
 }
 
 // Set key with value
-func (s *Storage) Set(key string, val interface{}, ttl time.Duration) {
+func (s *Storage) Set(_ context.Context, key string, val interface{}, ttl time.Duration) {
 	var exp uint32
 	if ttl > 0 {
 		exp = uint32(ttl.Seconds()) + atomic.LoadUint32(&utils.Timestamp)
@@ -54,14 +55,14 @@ func (s *Storage) Set(key string, val interface{}, ttl time.Duration) {
 }
 
 // Delete key by key
-func (s *Storage) Delete(key string) {
+func (s *Storage) Delete(_ context.Context, key string) {
 	s.Lock()
 	delete(s.data, key)
 	s.Unlock()
 }
 
 // Reset all keys
-func (s *Storage) Reset() {
+func (s *Storage) Reset(_ context.Context) {
 	nd := make(map[string]item)
 	s.Lock()
 	s.data = nd

internal/storage/memory/memory.go

@@ -3,6 +3,7 @@
 package memory
 
 import (
+	"context"
 	"sync"
 	"sync/atomic"
 	"time"
@@ -44,7 +45,7 @@ func New(config ...Config) *Storage {
 }
 
 // Get value by key
-func (s *Storage) Get(key string) ([]byte, error) {
+func (s *Storage) Get(_ context.Context, key string) ([]byte, error) {
 	if len(key) <= 0 {
 		return nil, nil
 	}
@@ -59,7 +60,7 @@ func (s *Storage) Get(key string) ([]byte, error) {
 }
 
 // Set key with value
-func (s *Storage) Set(key string, val []byte, exp time.Duration) error {
+func (s *Storage) Set(_ context.Context, key string, val []byte, exp time.Duration) error {
 	// Ain't Nobody Got Time For That
 	if len(key) <= 0 || len(val) <= 0 {
 		return nil
@@ -78,7 +79,7 @@ func (s *Storage) Set(key string, val []byte, exp time.Duration) error {
 }
 
 // Delete key by key
-func (s *Storage) Delete(key string) error {
+func (s *Storage) Delete(_ context.Context, key string) error {
 	// Ain't Nobody Got Time For That
 	if len(key) <= 0 {
 		return nil
@@ -90,7 +91,7 @@ func (s *Storage) Delete(key string) error {
 }
 
 // Reset all keys
-func (s *Storage) Reset() error {
+func (s *Storage) Reset(_ context.Context) error {
 	ndb := make(map[string]entry)
 	s.mux.Lock()
 	s.db = ndb
@@ -99,7 +100,7 @@ func (s *Storage) Reset() error {
 }
 
 // Close the memory storage
-func (s *Storage) Close() error {
+func (s *Storage) Close(_ context.Context) error {
 	s.done <- struct{}{}
 	return nil
 }
@@ -137,7 +138,7 @@ func (s *Storage) gc() {
 	}
 }
 
-// Return database client
+// Conn Return database client
 func (s *Storage) Conn() map[string]entry {
 	return s.db
 }

internal/storage/memory/memory_test.go

@@ -1,6 +1,7 @@
 package memory
 
 import (
+	"context"
 	"testing"
 	"time"
 
@@ -16,7 +17,7 @@ func Test_Storage_Memory_Set(t *testing.T) {
 		val = []byte("doe")
 	)
 
-	err := testStore.Set(key, val, 0)
+	err := testStore.Set(context.TODO(), key, val, 0)
 	utils.AssertEqual(t, nil, err)
 }
 
@@ -27,10 +28,10 @@ func Test_Storage_Memory_Set_Override(t *testing.T) {
 		val = []byte("doe")
 	)
 
-	err := testStore.Set(key, val, 0)
+	err := testStore.Set(context.TODO(), key, val, 0)
 	utils.AssertEqual(t, nil, err)
 
-	err = testStore.Set(key, val, 0)
+	err = testStore.Set(context.TODO(), key, val, 0)
 	utils.AssertEqual(t, nil, err)
 }
 
@@ -41,10 +42,10 @@ func Test_Storage_Memory_Get(t *testing.T) {
 		val = []byte("doe")
 	)
 
-	err := testStore.Set(key, val, 0)
+	err := testStore.Set(context.TODO(), key, val, 0)
 	utils.AssertEqual(t, nil, err)
 
-	result, err := testStore.Get(key)
+	result, err := testStore.Get(context.TODO(), key)
 	utils.AssertEqual(t, nil, err)
 	utils.AssertEqual(t, val, result)
 }
@@ -57,7 +58,7 @@ func Test_Storage_Memory_Set_Expiration(t *testing.T) {
 		exp = 1 * time.Second
 	)
 
-	err := testStore.Set(key, val, exp)
+	err := testStore.Set(context.TODO(), key, val, exp)
 	utils.AssertEqual(t, nil, err)
 
 	time.Sleep(1100 * time.Millisecond)
@@ -68,15 +69,15 @@ func Test_Storage_Memory_Get_Expired(t *testing.T) {
 		key = "john"
 	)
 
-	result, err := testStore.Get(key)
+	result, err := testStore.Get(context.TODO(), key)
 	utils.AssertEqual(t, nil, err)
 	utils.AssertEqual(t, true, len(result) == 0)
 }
 
 func Test_Storage_Memory_Get_NotExist(t *testing.T) {
 	t.Parallel()
 
-	result, err := testStore.Get("notexist")
+	result, err := testStore.Get(context.TODO(), "notexist")
 	utils.AssertEqual(t, nil, err)
 	utils.AssertEqual(t, true, len(result) == 0)
 }
@@ -88,13 +89,13 @@ func Test_Storage_Memory_Delete(t *testing.T) {
 		val = []byte("doe")
 	)
 
-	err := testStore.Set(key, val, 0)
+	err := testStore.Set(context.TODO(), key, val, 0)
 	utils.AssertEqual(t, nil, err)
 
-	err = testStore.Delete(key)
+	err = testStore.Delete(context.TODO(), key)
 	utils.AssertEqual(t, nil, err)
 
-	result, err := testStore.Get(key)
+	result, err := testStore.Get(context.TODO(), key)
 	utils.AssertEqual(t, nil, err)
 	utils.AssertEqual(t, true, len(result) == 0)
 }
@@ -105,27 +106,27 @@ func Test_Storage_Memory_Reset(t *testing.T) {
 		val = []byte("doe")
 	)
 
-	err := testStore.Set("john1", val, 0)
+	err := testStore.Set(context.TODO(), "john1", val, 0)
 	utils.AssertEqual(t, nil, err)
 
-	err = testStore.Set("john2", val, 0)
+	err = testStore.Set(context.TODO(), "john2", val, 0)
 	utils.AssertEqual(t, nil, err)
 
-	err = testStore.Reset()
+	err = testStore.Reset(context.TODO())
 	utils.AssertEqual(t, nil, err)
 
-	result, err := testStore.Get("john1")
+	result, err := testStore.Get(context.TODO(), "john1")
 	utils.AssertEqual(t, nil, err)
 	utils.AssertEqual(t, true, len(result) == 0)
 
-	result, err = testStore.Get("john2")
+	result, err = testStore.Get(context.TODO(), "john2")
 	utils.AssertEqual(t, nil, err)
 	utils.AssertEqual(t, true, len(result) == 0)
 }
 
 func Test_Storage_Memory_Close(t *testing.T) {
 	t.Parallel()
-	utils.AssertEqual(t, nil, testStore.Close())
+	utils.AssertEqual(t, nil, testStore.Close(context.TODO()))
 }
 
 func Test_Storage_Memory_Conn(t *testing.T) {
@@ -149,13 +150,13 @@ func Benchmark_Storage_Memory(b *testing.B) {
 		b.ResetTimer()
 		for n := 0; n < b.N; n++ {
 			for _, key := range keys {
-				d.Set(key, value, ttl)
+				d.Set(context.TODO(), key, value, ttl)
 			}
 			for _, key := range keys {
-				_, _ = d.Get(key)
+				_, _ = d.Get(context.TODO(), key)
 			}
 			for _, key := range keys {
-				d.Delete(key)
+				d.Delete(context.TODO(), key)
 			}
 		}
 	})

middleware/cache/cache.go

@@ -3,6 +3,7 @@
 package cache
 
 import (
+	"context"
 	"strconv"
 	"strings"
 	"sync"
@@ -80,11 +81,11 @@ func New(config ...Config) fiber.Handler {
 	}()
 
 	// Delete key from both manager and storage
-	deleteKey := func(dkey string) {
-		manager.delete(dkey)
+	deleteKey := func(ctx context.Context, dkey string) {
+		manager.delete(ctx, dkey)
 		// External storage saves body data with different key
 		if cfg.Storage != nil {
-			manager.delete(dkey + "_body")
+			manager.delete(ctx, dkey+"_body")
 		}
 	}
 
@@ -113,7 +114,7 @@ func New(config ...Config) fiber.Handler {
 		key := cfg.KeyGenerator(c) + "_" + c.Method()
 
 		// Get entry from pool
-		e := manager.get(key)
+		e := manager.get(c.Context(), key)
 
 		// Lock entry
 		mux.Lock()
@@ -123,7 +124,7 @@ func New(config ...Config) fiber.Handler {
 
 		// Check if entry is expired
 		if e.exp != 0 && ts >= e.exp {
-			deleteKey(key)
+			deleteKey(c.Context(), key)
 			if cfg.MaxBytes > 0 {
 				_, size := heap.remove(e.heapidx)
 				storedBytes -= size
@@ -132,7 +133,7 @@ func New(config ...Config) fiber.Handler {
 			// Separate body value to avoid msgp serialization
 			// We can store raw bytes with Storage 👍
 			if cfg.Storage != nil {
-				e.body = manager.getRaw(key + "_body")
+				e.body = manager.getRaw(c.Context(), key+"_body")
 			}
 			// Set response headers from cache
 			c.Response().SetBodyRaw(e.body)
@@ -189,7 +190,7 @@ func New(config ...Config) fiber.Handler {
 		if cfg.MaxBytes > 0 {
 			for storedBytes+bodySize > cfg.MaxBytes {
 				key, size := heap.removeFirst()
-				deleteKey(key)
+				deleteKey(c.Context(), key)
 				storedBytes -= size
 			}
 		}
@@ -231,14 +232,14 @@ func New(config ...Config) fiber.Handler {
 
 		// For external Storage we store raw body separated
 		if cfg.Storage != nil {
-			manager.setRaw(key+"_body", e.body, expiration)
+			manager.setRaw(c.Context(), key+"_body", e.body, expiration)
 			// avoid body msgp encoding
 			e.body = nil
-			manager.set(key, e, expiration)
+			manager.set(c.Context(), key, e, expiration)
 			manager.release(e)
 		} else {
 			// Store entry in memory
-			manager.set(key, e, expiration)
+			manager.set(c.Context(), key, e, expiration)
 		}
 
 		c.Set(cfg.CacheHeader, cacheMiss)