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
|
Contributor
There was a problem hiding this comment. I am thinking it is better to create a package inside utils/lru/lru.go so that imports are called
Contributor
There was a problem hiding this comment. I see this comment was marked as resolved without being resolved, why?
Contributor
Author
There was a problem hiding this comment. I think it was updated in 3ad6be2. Let me know if that's not enough, or it's not what you meant.
Contributor
There was a problem hiding this comment. Maybe a git error, is not showing up in the diff
Contributor
There was a problem hiding this comment. @brbrr to clarify, we should have a |
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,30 @@ | ||
| package utils | ||
|
|
||
| import ( | ||
| "fmt" | ||
|
|
||
| lru "github.com/hashicorp/golang-lru/v2" | ||
| "github.com/hashicorp/golang-lru/v2/simplelru" | ||
| ) | ||
|
|
||
| // 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.Cache[K, V] { | ||
| c, err := lru.New[K, V](size) | ||
| if err != nil { | ||
| panic(fmt.Errorf("lru: %w (size=%d)", err, size)) | ||
| } | ||
| return c | ||
| } | ||
|
|
||
| // NewSimpleLRU returns a new non-thread-safe LRU cache or panics if size <= 0. | ||
| // Use the same way as NewLRU when external synchronization is provided | ||
| // (e.g. single-goroutine ownership). | ||
| func NewSimpleLRU[K comparable, V any](size int) *simplelru.LRU[K, V] { | ||
| c, err := simplelru.NewLRU[K, V](size, nil) | ||
| if err != nil { | ||
| panic(fmt.Errorf("simplelru: %w (size=%d)", err, size)) | ||
| } | ||
| return c | ||
|
brbrr marked this conversation as resolved.
Outdated
|
||
| } | ||
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.
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.
I know this is out of scope, but since we are touching it, could
NewAggregatedBloomCachereturn*AggregatedBloomFilterCache?Its methods are all pointer-receivers, so a pointer is more consistent and avoids copies diverging on
fallbackFuncin future uses.Also, it's only called in
blockchain.goand tests today, so the change stays small.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.
This doesn't make sense to me, can you explain what you mean? How having pointer receivers affects what the constructor should return?
This is a valid one.
Out of scope changes should be address in a different PR, let's try not squeeze them here