feat(cache): add GetPrefixKeysCtx

feat(cache): add GetPrefixKeysCtx

Author: jaronnie

cache/cache.go

@@ -11,4 +11,7 @@ type Cache interface {
 
 	// SetNoExpireCtx Because zero cache set ctx has default expire, so jzero add this method
 	SetNoExpireCtx(ctx context.Context, key string, val any) error
+
+	// GetPrefixKeysCtx get prefix key, give prefix key return all matched key
+	GetPrefixKeysCtx(ctx context.Context, prefix string) ([]string, error)
 }

cache/redis.go

@@ -23,6 +23,27 @@ func (c redisNode) SetNoExpireCtx(ctx context.Context, key string, val any) erro
 	return c.rds.SetCtx(ctx, key, string(data))
 }
 
+func (c redisNode) GetPrefixKeysCtx(ctx context.Context, keyPrefix string) ([]string, error) {
+	var (
+		cursor  uint64
+		allKeys []string
+		err     error
+	)
+
+	for {
+		var keys []string
+		keys, cursor, err = c.rds.ScanCtx(ctx, cursor, keyPrefix+"*", 100)
+		if err != nil {
+			return nil, err
+		}
+		allKeys = append(allKeys, keys...)
+		if cursor == 0 {
+			break
+		}
+	}
+	return allKeys, nil
+}
+
 func (c redisNode) Del(keys ...string) error {
 	return c.node.Del(keys...)
 }

cache/redis_test.go

@@ -0,0 +1,33 @@
+package cache
+
+import (
+	"context"
+	"testing"
+
+	"github.com/alicebob/miniredis/v2"
+	"github.com/pkg/errors"
+	"github.com/stretchr/testify/assert"
+	"github.com/zeromicro/go-zero/core/stores/redis"
+)
+
+func TestRedisNode(t *testing.T) {
+	r, err := miniredis.Run()
+	assert.NoError(t, err)
+	defer r.Close()
+
+	cache := NewRedisNode(redis.New(r.Addr()), errors.New("not found"))
+
+	err = cache.SetCtx(context.Background(), "JWT_ADMIN_AUTH:1:abc", "abc")
+	assert.NoError(t, err)
+
+	err = cache.SetCtx(context.Background(), "JWT_ADMIN_AUTH:1:def", "def")
+	assert.NoError(t, err)
+
+	err = cache.SetCtx(context.Background(), "JWT_ADMIN_AUTH:1:ghi", "ghi")
+	assert.NoError(t, err)
+
+	keys, err := cache.GetPrefixKeysCtx(context.Background(), "JWT_ADMIN_AUTH:1:")
+	assert.NoError(t, err)
+
+	assert.Equal(t, []string{"JWT_ADMIN_AUTH:1:abc", "JWT_ADMIN_AUTH:1:def", "JWT_ADMIN_AUTH:1:ghi"}, keys)
+}

cache/sync_map.go

@@ -22,6 +22,24 @@ type (
 	}
 )
 
+func (sm *syncMap) GetPrefixKeysCtx(ctx context.Context, prefix string) ([]string, error) {
+	var allKeys []string
+
+	sm.storage.Range(func(key, value any) bool {
+		keyStr, ok := key.(string)
+		if !ok {
+			return true
+		}
+
+		if len(keyStr) >= len(prefix) && keyStr[:len(prefix)] == prefix {
+			allKeys = append(allKeys, keyStr)
+		}
+		return true
+	})
+
+	return allKeys, nil
+}
+
 func (sm *syncMap) SetNoExpireCtx(ctx context.Context, key string, val any) error {
 	return sm.SetCtx(ctx, key, val)
 }

cache/sync_map_test.go

@@ -0,0 +1,26 @@
+package cache
+
+import (
+	"context"
+	"testing"
+
+	"github.com/pkg/errors"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestSyncMap(t *testing.T) {
+	t.Run("TestSyncMap", func(t *testing.T) {
+		cache := NewSyncMap(errors.New("not found"))
+
+		err := cache.SetCtx(context.Background(), "JWT_ADMIN_AUTH:1:abc", "abc")
+		assert.NoError(t, err)
+		err = cache.SetCtx(context.Background(), "JWT_ADMIN_AUTH:1:def", "def")
+		assert.NoError(t, err)
+		err = cache.SetCtx(context.Background(), "JWT_ADMIN_AUTH:1:ghi", "ghi")
+		assert.NoError(t, err)
+
+		keys, err := cache.GetPrefixKeysCtx(context.Background(), "JWT_ADMIN_AUTH:1:")
+		assert.NoError(t, err)
+		assert.Equal(t, []string{"JWT_ADMIN_AUTH:1:abc", "JWT_ADMIN_AUTH:1:def", "JWT_ADMIN_AUTH:1:ghi"}, keys)
+	})
+}

go.mod

@@ -5,20 +5,23 @@ go 1.22.3
 require (
 	github.com/Masterminds/sprig/v3 v3.2.3
 	github.com/a8m/envsubst v1.4.2
+	github.com/alicebob/miniredis/v2 v2.33.0
 	github.com/eddieowens/opts v0.1.0
 	github.com/fsnotify/fsnotify v1.8.0
 	github.com/guregu/null/v5 v5.0.0
 	github.com/huandu/go-assert v1.1.6
 	github.com/huandu/go-sqlbuilder v1.28.0
 	github.com/pkg/errors v0.9.1
 	github.com/spf13/cast v1.5.1
+	github.com/stretchr/testify v1.9.0
 	github.com/zeromicro/go-zero v1.7.4
 )
 
 require (
 	filippo.io/edwards25519 v1.1.0 // indirect
 	github.com/Masterminds/goutils v1.1.1 // indirect
 	github.com/Masterminds/semver/v3 v3.2.0 // indirect
+	github.com/alicebob/gopher-json v0.0.0-20230218143504-906a9b012302 // indirect
 	github.com/beorn7/perks v1.0.1 // indirect
 	github.com/cenkalti/backoff/v4 v4.3.0 // indirect
 	github.com/cespare/xxhash/v2 v2.3.0 // indirect
@@ -46,13 +49,15 @@ require (
 	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
 	github.com/openzipkin/zipkin-go v0.4.3 // indirect
 	github.com/pelletier/go-toml/v2 v2.2.2 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/prometheus/client_golang v1.20.5 // indirect
 	github.com/prometheus/client_model v0.6.1 // indirect
 	github.com/prometheus/common v0.55.0 // indirect
 	github.com/prometheus/procfs v0.15.1 // indirect
 	github.com/redis/go-redis/v9 v9.7.0 // indirect
 	github.com/shopspring/decimal v1.2.0 // indirect
 	github.com/spaolacci/murmur3 v1.1.0 // indirect
+	github.com/yuin/gopher-lua v1.1.1 // indirect
 	go.etcd.io/etcd/api/v3 v3.5.15 // indirect
 	go.etcd.io/etcd/client/pkg/v3 v3.5.15 // indirect
 	go.etcd.io/etcd/client/v3 v3.5.15 // indirect
@@ -80,4 +85,5 @@ require (
 	google.golang.org/grpc v1.65.0 // indirect
 	google.golang.org/protobuf v1.35.2 // indirect
 	gopkg.in/yaml.v2 v2.4.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
 )