-
Notifications
You must be signed in to change notification settings - Fork 1
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.
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
Implement redis cache. #157
Draft
Gerrit91
wants to merge
2
commits into
master
Choose a base branch
from
redis-cache
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| package cache | ||
|
|
||
| import ( | ||
| "context" | ||
| "encoding/json" | ||
| "errors" | ||
| "fmt" | ||
| "time" | ||
|
|
||
| "github.com/redis/go-redis/v9" | ||
| ) | ||
|
|
||
| type ( | ||
| RedisCache[O any] struct { | ||
| client *redis.Client | ||
| expiration time.Duration | ||
| fetch FetchFunc[string, O] | ||
| prefix string | ||
| } | ||
| ) | ||
|
|
||
| func NewRedis[O any](client *redis.Client, prefix string, expiration time.Duration, fetch FetchFunc[string, O]) *RedisCache[O] { | ||
| return &RedisCache[O]{ | ||
| client: client, | ||
| expiration: expiration, | ||
| fetch: fetch, | ||
| prefix: prefix, | ||
| } | ||
| } | ||
|
|
||
| func (c *RedisCache[O]) prefixedKey(key string) string { | ||
| return c.prefix + key | ||
| } | ||
|
|
||
| func (c *RedisCache[O]) Get(ctx context.Context, key string) (O, error) { | ||
| var o O | ||
|
|
||
| encoded, err := c.client.Get(ctx, c.prefixedKey(key)).Result() | ||
| if err == nil { | ||
| err = json.Unmarshal([]byte(encoded), &o) | ||
| if err != nil { | ||
| return o, err | ||
| } | ||
|
|
||
| return o, nil | ||
| } | ||
|
|
||
| if !errors.Is(err, redis.Nil) { | ||
| return o, err | ||
| } | ||
|
|
||
| o, err = c.fetch(ctx, key) | ||
| if err != nil { | ||
| return o, fmt.Errorf("error fetching cache entry: %w", err) | ||
| } | ||
|
|
||
| enc, err := json.Marshal(o) | ||
| if err != nil { | ||
| return o, fmt.Errorf("unable to marshal cache entry: %w", err) | ||
| } | ||
|
|
||
| _, err = c.client.Set(ctx, c.prefixedKey(key), enc, c.expiration).Result() | ||
| if err != nil { | ||
| return o, fmt.Errorf("unable to store cache entry: %w", err) | ||
| } | ||
|
|
||
| return o, nil | ||
| } | ||
|
|
||
| // Refresh the entry with given key regardless expiration | ||
| func (c *RedisCache[O]) Refresh(ctx context.Context, key string) (O, error) { | ||
| o, err := c.fetch(ctx, key) | ||
| if err != nil { | ||
| var zero O | ||
| return zero, fmt.Errorf("error fetching cache entry: %w", err) | ||
| } | ||
|
|
||
| enc, err := json.Marshal(o) | ||
| if err != nil { | ||
| return o, fmt.Errorf("unable to marshal cache entry: %w", err) | ||
| } | ||
|
|
||
| _, err = c.client.Set(ctx, c.prefixedKey(key), enc, c.expiration).Result() | ||
| if err != nil { | ||
| return o, fmt.Errorf("unable to store cache entry: %w", err) | ||
| } | ||
|
|
||
| return o, nil | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| package cache | ||
|
|
||
| import ( | ||
| "context" | ||
| "strings" | ||
| "testing" | ||
| "time" | ||
|
|
||
| "github.com/alicebob/miniredis/v2" | ||
| "github.com/redis/go-redis/v9" | ||
| "github.com/stretchr/testify/require" | ||
| "github.com/tj/assert" | ||
| ) | ||
|
|
||
| func TestRedisCache(t *testing.T) { | ||
| ctx := context.Background() | ||
| s := miniredis.RunT(t) | ||
| c := redis.NewClient(&redis.Options{Addr: s.Addr()}) | ||
|
|
||
| type testObject struct { | ||
| Name string `json:"name"` | ||
| } | ||
|
|
||
| cache := NewRedis(c, "prefix_", 2*time.Second, func(ctx context.Context, key string) (*testObject, error) { | ||
| return &testObject{ | ||
| Name: strings.ToUpper(key), | ||
| }, nil | ||
| }) | ||
|
|
||
| o, err := cache.Get(ctx, "darth vader") | ||
| require.NoError(t, err) | ||
|
|
||
| assert.Equal(t, &testObject{ | ||
| Name: "DARTH VADER", | ||
| }, o) | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
prefix could be inherited from O in my opinion, this would prevent accidental clashes