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.

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

feat(x/params): add lru caching #3120

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open

Conversation

moul
Copy link
Member

@moul moul commented Nov 14, 2024

LRU caching uses a specified CacheMaxSize to limit the number of entries. Keys are immediately invalidated when a setter is called. The LRU is shared across all the getters.

Fix #3023
Related with #2911

@moul moul self-assigned this Nov 14, 2024
@github-actions github-actions bot added the 📦 🌐 tendermint v2 Issues or PRs tm2 related label Nov 14, 2024
Signed-off-by: moul <[email protected]>
Copy link

codecov bot commented Nov 15, 2024

Codecov Report

Attention: Patch coverage is 70.83333% with 7 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
tm2/pkg/sdk/params/keeper.go 75.00% 3 Missing and 1 partial ⚠️
gno.land/pkg/gnoland/node_inmemory.go 0.00% 2 Missing and 1 partial ⚠️

📢 Thoughts on this report? Let us know!

moul added 3 commits November 15, 2024 23:09
Signed-off-by: moul <[email protected]>
Signed-off-by: moul <[email protected]>
Signed-off-by: moul <[email protected]>
@github-actions github-actions bot added the 📦 ⛰️ gno.land Issues or PRs gno.land package related label Nov 15, 2024
@moul moul marked this pull request as ready for review November 15, 2024 22:57
Signed-off-by: moul <[email protected]>
Copy link
Contributor

@ajnavarro ajnavarro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What are the performance gains of this PR? K/V storages usually have cache mechanisms like the one implemented here, so maybe it is redundant?

@@ -7,6 +7,7 @@ import (
"github.com/gnolang/gno/tm2/pkg/amino"
"github.com/gnolang/gno/tm2/pkg/sdk"
"github.com/gnolang/gno/tm2/pkg/store"
"github.com/golang/groupcache/lru"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe this lib is more maintained than the one used: https://github.com/hashicorp/golang-lru

Comment on lines +123 to +125
if bz == nil {
return
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what is the meaning of that code? can we have nil values in our cache? why?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was considering the two situations, and I feel that since the goal is to avoid unnecessary lookups, caching the "not found" error prevents a misconfigured script from periodically querying the same nonexistent value for a real lookup.

It's just a feeling; I'm not sure if that's the best approach.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we can use bloom filters for that specific case if we receive a lot of queries for data we don't have.

@Gno2D2
Copy link
Collaborator

Gno2D2 commented Dec 8, 2024

🛠 PR Checks Summary

All Automated Checks passed. ✅

Manual Checks (for Reviewers):
  • IGNORE the bot requirements for this PR (force green CI check)
Read More

🤖 This bot helps streamline PR reviews by verifying automated checks and providing guidance for contributors and reviewers.

✅ Automated Checks (for Contributors):

🟢 Maintainers must be able to edit this pull request (more info)

☑️ Contributor Actions:
  1. Fix any issues flagged by automated checks.
  2. Follow the Contributor Checklist to ensure your PR is ready for review.
    • Add new tests, or document why they are unnecessary.
    • Provide clear examples/screenshots, if necessary.
    • Update documentation, if required.
    • Ensure no breaking changes, or include BREAKING CHANGE notes.
    • Link related issues/PRs, where applicable.
☑️ Reviewer Actions:
  1. Complete manual checks for the PR, including the guidelines and additional checks if applicable.
📚 Resources:
Debug
Automated Checks
Maintainers must be able to edit this pull request (more info)

If

🟢 Condition met
└── 🟢 The pull request was created from a fork (head branch repo: moul/gno)

Then

🟢 Requirement satisfied
└── 🟢 Maintainer can modify this pull request

Manual Checks
**IGNORE** the bot requirements for this PR (force green CI check)

If

🟢 Condition met
└── 🟢 On every pull request

Can be checked by

  • Any user with comment edit permission

@thehowl
Copy link
Member

thehowl commented Jan 15, 2025

This PR is a bit old, and I know there's other developments on the params module. @moul, tell me if you want me to take a look or I can hold off the review for the moment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📦 🌐 tendermint v2 Issues or PRs tm2 related 📦 ⛰️ gno.land Issues or PRs gno.land package related
Projects
Status: 📥 Inbox
Status: In Review
Development

Successfully merging this pull request may close these issues.

sdk/params: add lazy caching with LRU
4 participants