1
0
mirror of https://github.com/redis/go-redis.git synced 2025-04-19 07:22:17 +03:00

Add Cache object to go-redis

This commit is contained in:
ofekshenawa 2024-01-21 21:54:26 +02:00
parent d70d9eaa48
commit d8b4f6e49f
2 changed files with 142 additions and 0 deletions

47
cache.go Normal file
View File

@ -0,0 +1,47 @@
package redis
import (
"github.com/dgraph-io/ristretto"
)
// Cache structure
type Cache struct {
cache *ristretto.Cache
}
// NewCache creates a new Cache instance with the given configuration
func NewCache(numKeys int64, memSize int64) (*Cache, error) {
// Create a new cache with the given configuration
config := &ristretto.Config{
NumCounters: numKeys * 10, // number of keys to track frequency of (10x number of items to cache)
MaxCost: memSize, // maximum cost of cache (in bytes)
BufferItems: 64, // number of keys per Get buffer
}
cache, err := ristretto.NewCache(config)
if err != nil {
return nil, err
}
return &Cache{cache: cache}, nil
}
// Set adds a value to the cache
func (c *Cache) Set(key, value interface{}, cost int64) bool {
return c.cache.Set(key, value, cost)
}
// Get retrieves a value from the cache
func (c *Cache) Get(key interface{}) (interface{}, bool) {
return c.cache.Get(key)
}
// ClearKey clears a specific key from the cache
func (c *Cache) ClearKey(key interface{}) {
c.cache.Del(key)
}
// Clear clears the entire cache
func (c *Cache) Clear() {
c.cache.Clear()
}

95
cache_test.go Normal file
View File

@ -0,0 +1,95 @@
package redis_test
import (
"log"
"testing"
"time"
"github.com/redis/go-redis/v9"
)
// Testredis.NewCache tests the creation of a new cache instance
func TestNewCache(t *testing.T) {
_, err := redis.NewCache(1000, 1<<20) // 1 MB size
if err != nil {
t.Fatalf("Failed to create cache: %v", err)
}
t.Log("Cache created successfully")
}
// TestCacheSetAndGet tests setting and getting values in the cache
func TestCacheSetAndGet(t *testing.T) {
cache, err := redis.NewCache(1000, 1<<20)
if err != nil {
t.Fatalf("Failed to create cache: %v", err)
}
key, value := "key1", "value1"
setSuccess := cache.Set(key, value, 1)
if !setSuccess {
t.Fatalf("Failed to set key: %s", key)
}
log.Printf("Set operation successful for key: %s", key)
// Allow value to pass through buffers
time.Sleep(10 * time.Millisecond)
getValue, found := cache.Get(key)
if !found || getValue != value {
t.Errorf("Failed to get key: %s, expected value: %s, got: %v", key, value, getValue)
} else {
log.Printf("Get operation successful for key: %s", key)
}
}
// TestCacheClearKey tests the clearing of a specific key from the cache
func TestCacheClearKey(t *testing.T) {
cache, err := redis.NewCache(1000, 1<<20)
if err != nil {
t.Fatalf("Failed to create cache: %v", err)
}
key := "key1"
cache.Set(key, "value1", 1)
log.Printf("Key %s set in cache", key)
time.Sleep(10 * time.Millisecond)
cache.ClearKey(key)
log.Printf("Key %s cleared from cache", key)
time.Sleep(10 * time.Millisecond)
_, found := cache.Get(key)
if found {
t.Errorf("Expected key %s to be cleared", key)
} else {
log.Printf("ClearKey operation successful for key: %s", key)
}
}
// TestCacheClear tests clearing all keys from the cache
func TestCacheClear(t *testing.T) {
cache, err := redis.NewCache(1000, 1<<20)
if err != nil {
t.Fatalf("Failed to create cache: %v", err)
}
key := "key1"
cache.Set(key, "value1", 1)
log.Printf("Key %s set in cache", key)
time.Sleep(10 * time.Millisecond)
cache.Clear()
t.Log("All keys cleared from cache")
time.Sleep(10 * time.Millisecond)
_, found := cache.Get(key)
if found {
t.Errorf("Expected cache to be cleared, but key %s was found", key)
} else {
t.Log("Clear operation successful, cache is empty")
}
}