refactor(lru): switch LRU implementation to golang-lru #3674
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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
|
brbrr marked this conversation as resolved.
|
This file contains hidden or 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,51 @@ | ||
| package utils | ||
|
|
||
| import ( | ||
| "fmt" | ||
|
|
||
| lru "github.com/hashicorp/golang-lru/v2" | ||
| "github.com/hashicorp/golang-lru/v2/simplelru" | ||
| ) | ||
|
|
||
| // LRU is a thread-safe size-bounded LRU cache. | ||
| type LRU[K comparable, V any] struct { | ||
| c *lru.Cache[K, V] | ||
| } | ||
|
|
||
| // NewLRU returns a new thread-safe LRU cache or panics if size <= 0. | ||
| // Use for caches sized by constants or validated config, where a zero size | ||
| // indicates a programmer error rather than a runtime condition. | ||
| func NewLRU[K comparable, V any](size int) *LRU[K, V] { | ||
| c, err := lru.New[K, V](size) | ||
| if err != nil { | ||
| panic(fmt.Errorf("lru: %w (size=%d)", err, size)) | ||
| } | ||
| return &LRU[K, V]{c: c} | ||
| } | ||
|
|
||
| func (l *LRU[K, V]) Add(key K, value V) (evicted bool) { return l.c.Add(key, value) } | ||
| func (l *LRU[K, V]) Get(key K) (V, bool) { return l.c.Get(key) } | ||
| func (l *LRU[K, V]) Remove(key K) (present bool) { return l.c.Remove(key) } | ||
| func (l *LRU[K, V]) Purge() { l.c.Purge() } | ||
| func (l *LRU[K, V]) Len() int { return l.c.Len() } | ||
|
|
||
| // SimpleLRU is a non-thread-safe size-bounded LRU cache. | ||
| // Use when external synchronization is provided (e.g. single-goroutine ownership). | ||
| type SimpleLRU[K comparable, V any] struct { | ||
| c *simplelru.LRU[K, V] | ||
| } | ||
|
|
||
| // NewSimpleLRU returns a new non-thread-safe LRU cache or panics if size <= 0. | ||
| func NewSimpleLRU[K comparable, V any](size int) *SimpleLRU[K, V] { | ||
| c, err := simplelru.NewLRU[K, V](size, nil) | ||
| if err != nil { | ||
| panic(fmt.Errorf("simplelru: %w (size=%d)", err, size)) | ||
| } | ||
| return &SimpleLRU[K, V]{c: c} | ||
| } | ||
|
|
||
| func (l *SimpleLRU[K, V]) Add(key K, value V) (evicted bool) { return l.c.Add(key, value) } | ||
| func (l *SimpleLRU[K, V]) Get(key K) (V, bool) { return l.c.Get(key) } | ||
| func (l *SimpleLRU[K, V]) Remove(key K) (present bool) { return l.c.Remove(key) } | ||
| func (l *SimpleLRU[K, V]) Purge() { l.c.Purge() } | ||
| func (l *SimpleLRU[K, V]) Len() int { return l.c.Len() } | ||
This file contains hidden or 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,66 @@ | ||
| package utils | ||
|
|
||
| import ( | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| //nolint:dupl // duplicate tests as there's identical APIs | ||
| func TestNewLRU(t *testing.T) { | ||
| t.Run("returns usable cache for positive size", func(t *testing.T) { | ||
| c := NewLRU[string, int](2) | ||
| require.NotNil(t, c) | ||
| assert.Equal(t, 0, c.Len()) | ||
|
|
||
| c.Add("a", 1) | ||
| c.Add("b", 2) | ||
| assert.Equal(t, 2, c.Len()) | ||
|
|
||
| v, ok := c.Get("a") | ||
| assert.True(t, ok) | ||
| assert.Equal(t, 1, v) | ||
| }) | ||
|
|
||
| t.Run("panics on zero size", func(t *testing.T) { | ||
| assert.PanicsWithError(t, "lru: must provide a positive size (size=0)", func() { | ||
| NewLRU[string, int](0) | ||
| }) | ||
| }) | ||
|
|
||
| t.Run("panics on negative size", func(t *testing.T) { | ||
| assert.PanicsWithError(t, "lru: must provide a positive size (size=-1)", func() { | ||
| NewLRU[string, int](-1) | ||
| }) | ||
| }) | ||
| } | ||
|
|
||
| //nolint:dupl // duplicate tests as there's identical APIs | ||
| func TestNewSimpleLRU(t *testing.T) { | ||
| t.Run("returns usable cache for positive size", func(t *testing.T) { | ||
| c := NewSimpleLRU[string, int](2) | ||
| require.NotNil(t, c) | ||
| assert.Equal(t, 0, c.Len()) | ||
|
|
||
| c.Add("a", 1) | ||
| c.Add("b", 2) | ||
| assert.Equal(t, 2, c.Len()) | ||
|
|
||
| v, ok := c.Get("a") | ||
| assert.True(t, ok) | ||
| assert.Equal(t, 1, v) | ||
| }) | ||
|
|
||
| t.Run("panics on zero size", func(t *testing.T) { | ||
| assert.PanicsWithError(t, "simplelru: must provide a positive size (size=0)", func() { | ||
| NewSimpleLRU[string, int](0) | ||
| }) | ||
| }) | ||
|
|
||
| t.Run("panics on negative size", func(t *testing.T) { | ||
| assert.PanicsWithError(t, "simplelru: must provide a positive size (size=-1)", func() { | ||
| NewSimpleLRU[string, int](-1) | ||
| }) | ||
| }) | ||
| } |
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.
Uh oh!
There was an error while loading. Please reload this page.