Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix cache key eviction #231

Merged
merged 2 commits into from
May 24, 2023
Merged

Fix cache key eviction #231

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3c1b0b0
fix(store/memory): Fix random eviction from sync.Map using internal b…
novln May 24, 2023
0ad6d77
refactor(store/redis): Use same technique for key concat as memory store
novln May 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 14 additions & 21 deletions drivers/store/memory/store.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@ package memory

import (
"context"
"strings"
"time"

"github.com/ulule/limiter/v3"
"github.com/ulule/limiter/v3/drivers/store/common"
"github.com/ulule/limiter/v3/internal/bytebuffer"
)

// Store is the in-memory store.
Expand Down Expand Up @@ -35,48 +35,41 @@ func NewStoreWithOptions(options limiter.StoreOptions) limiter.Store {

// Get returns the limit for given identifier.
func (store *Store) Get(ctx context.Context, key string, rate limiter.Rate) (limiter.Context, error) {
buffer := bytebuffer.New()
defer buffer.Close()
buffer.Concat(store.Prefix, ":", key)

count, expiration := store.cache.Increment(buffer.String(), 1, rate.Period)
count, expiration := store.cache.Increment(store.getCacheKey(key), 1, rate.Period)

lctx := common.GetContextFromState(time.Now(), rate, expiration, count)
return lctx, nil
}

// Increment increments the limit by given count & returns the new limit value for given identifier.
func (store *Store) Increment(ctx context.Context, key string, count int64, rate limiter.Rate) (limiter.Context, error) {
buffer := bytebuffer.New()
defer buffer.Close()
buffer.Concat(store.Prefix, ":", key)

newCount, expiration := store.cache.Increment(buffer.String(), count, rate.Period)
newCount, expiration := store.cache.Increment(store.getCacheKey(key), count, rate.Period)

lctx := common.GetContextFromState(time.Now(), rate, expiration, newCount)
return lctx, nil
}

// Peek returns the limit for given identifier, without modification on current values.
func (store *Store) Peek(ctx context.Context, key string, rate limiter.Rate) (limiter.Context, error) {
buffer := bytebuffer.New()
defer buffer.Close()
buffer.Concat(store.Prefix, ":", key)

count, expiration := store.cache.Get(buffer.String(), rate.Period)
count, expiration := store.cache.Get(store.getCacheKey(key), rate.Period)

lctx := common.GetContextFromState(time.Now(), rate, expiration, count)
return lctx, nil
}

// Reset returns the limit for given identifier.
func (store *Store) Reset(ctx context.Context, key string, rate limiter.Rate) (limiter.Context, error) {
buffer := bytebuffer.New()
defer buffer.Close()
buffer.Concat(store.Prefix, ":", key)

count, expiration := store.cache.Reset(buffer.String(), rate.Period)
count, expiration := store.cache.Reset(store.getCacheKey(key), rate.Period)

lctx := common.GetContextFromState(time.Now(), rate, expiration, count)
return lctx, nil
}

// getCacheKey returns the full path for an identifier.
func (store *Store) getCacheKey(key string) string {
buffer := strings.Builder{}
buffer.WriteString(store.Prefix)
buffer.WriteString(":")
buffer.WriteString(key)
return buffer.String()
}
22 changes: 13 additions & 9 deletions drivers/store/redis/store.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ package redis

import (
"context"
"fmt"
"strings"
"sync"
"sync/atomic"
Expand Down Expand Up @@ -98,22 +97,19 @@ func NewStoreWithOptions(client Client, options limiter.StoreOptions) (limiter.S

// Increment increments the limit by given count & gives back the new limit for given identifier
func (store *Store) Increment(ctx context.Context, key string, count int64, rate limiter.Rate) (limiter.Context, error) {
key = fmt.Sprintf("%s:%s", store.Prefix, key)
cmd := store.evalSHA(ctx, store.getLuaIncrSHA, []string{key}, count, rate.Period.Milliseconds())
cmd := store.evalSHA(ctx, store.getLuaIncrSHA, []string{store.getCacheKey(key)}, count, rate.Period.Milliseconds())
return currentContext(cmd, rate)
}

// Get returns the limit for given identifier.
func (store *Store) Get(ctx context.Context, key string, rate limiter.Rate) (limiter.Context, error) {
key = fmt.Sprintf("%s:%s", store.Prefix, key)
cmd := store.evalSHA(ctx, store.getLuaIncrSHA, []string{key}, 1, rate.Period.Milliseconds())
cmd := store.evalSHA(ctx, store.getLuaIncrSHA, []string{store.getCacheKey(key)}, 1, rate.Period.Milliseconds())
return currentContext(cmd, rate)
}

// Peek returns the limit for given identifier, without modification on current values.
func (store *Store) Peek(ctx context.Context, key string, rate limiter.Rate) (limiter.Context, error) {
key = fmt.Sprintf("%s:%s", store.Prefix, key)
cmd := store.evalSHA(ctx, store.getLuaPeekSHA, []string{key})
cmd := store.evalSHA(ctx, store.getLuaPeekSHA, []string{store.getCacheKey(key)})
count, ttl, err := parseCountAndTTL(cmd)
if err != nil {
return limiter.Context{}, err
Expand All @@ -130,8 +126,7 @@ func (store *Store) Peek(ctx context.Context, key string, rate limiter.Rate) (li

// Reset returns the limit for given identifier which is set to zero.
func (store *Store) Reset(ctx context.Context, key string, rate limiter.Rate) (limiter.Context, error) {
key = fmt.Sprintf("%s:%s", store.Prefix, key)
_, err := store.client.Del(ctx, key).Result()
_, err := store.client.Del(ctx, store.getCacheKey(key)).Result()
if err != nil {
return limiter.Context{}, err
}
Expand All @@ -143,6 +138,15 @@ func (store *Store) Reset(ctx context.Context, key string, rate limiter.Rate) (l
return common.GetContextFromState(now, rate, expiration, count), nil
}

// getCacheKey returns the full path for an identifier.
func (store *Store) getCacheKey(key string) string {
buffer := strings.Builder{}
buffer.WriteString(store.Prefix)
buffer.WriteString(":")
buffer.WriteString(key)
return buffer.String()
}

// preloadLuaScripts preloads the "incr" and "peek" lua scripts.
func (store *Store) preloadLuaScripts(ctx context.Context) error {
// Verify if we need to load lua scripts.
Expand Down