feat(cache-store): add deep copy function #20862
Conversation
WalkthroughWalkthroughThis change introduces a new Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range and nitpick comments (1)
CHANGELOG.md (1)
65-65: Ensure consistency in changelog entries.The added changelog entry is clear and concise. However, it would be more consistent with the rest of the entries if it mentioned the specific files or modules affected, similar to the previous entries.
Suggestion:
* (store/cachemulti, store/cachekv) [#20862](https://github.com/cosmos/cosmos-sdk/pull/20862) Add `Copy()` method for `CacheMultiStore` and `cachekv.Store`.
Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Files selected for processing (4)
- CHANGELOG.md (1 hunks)
- store/cachekv/store.go (1 hunks)
- store/cachemulti/store.go (1 hunks)
- store/types/store.go (2 hunks)
Additional context used
Path-based instructions (4)
store/cachemulti/store.go (1)
Pattern
**/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.store/cachekv/store.go (1)
Pattern
**/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.store/types/store.go (1)
Pattern
**/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.CHANGELOG.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
Additional comments not posted (3)
store/cachemulti/store.go (1)
130-154: LGTM!The
Copyfunction is correctly implemented and adheres to the Uber Golang style guide. It appropriately deep copies thedbfield and thecachekvstores map.store/cachekv/store.go (1)
164-194: LGTM!The
Copyfunction is correctly implemented and adheres to the Uber Golang style guide. It appropriately deep copies thecache,unsortedCache, andsortedCachefields.store/types/store.go (1)
168-169: LGTM!The addition of the
Copyfunction to theCacheMultiStoreinterface is consistent with the changes made instore/cachemulti/store.goandstore/cachekv/store.go. It adheres to the Uber Golang style guide.
|
The implementation is very heavy though. |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| for key, val := range store.cache { | ||
| newVal := *val // Create a copy of the cValue | ||
| cacheCopy[key] = &newVal | ||
| } |
Check warning
Code scanning / CodeQL
Iteration over map Warning
| for key := range store.unsortedCache { | ||
| unsortedCacheCopy[key] = struct{}{} | ||
| } |
Check warning
Code scanning / CodeQL
Iteration over map Warning
| for key, store := range cms.stores { | ||
| store, ok := store.(*cachekv.Store) | ||
| if ok { | ||
| newStores[key] = store.Copy() | ||
| } | ||
| } |
Check warning
Code scanning / CodeQL
Iteration over map Warning
@yihuang Yes, will depend mostly on the amount of entries in the cache. |
nop, just the deep copy itself, it also depends on the usage, if it's called multiple times for each tx, then the cost is pretty significant, and in our EVM integration, we also need to call sth like this, that's why we did the custom CoW cache store implementation. |
|
This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. |
Description
This PR adds a
Copy()function to theCacheMultiStoreto create a deep copy of the store.This function is useful to create snapshots of the multi-store while keeping the same
CacheMultiStorewith its cache entries throughout a transaction lifecycle. Also, it allows to revert changes at a specific point.Closes: #XXXX
Author Checklist
All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.
I have...
!in the type prefix if API or client breaking changeCHANGELOG.mdReviewers Checklist
All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.
Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.
I have...
Summary by CodeRabbit