feat(runtime/v2): store loader on simappv2 #21704
Conversation
![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)
runtime/v2/store.go (1)
69-90: LGTM with a suggestion!The
UpgradeStoreLoaderfunction implementation is correct and provides a robust mechanism for handling store upgrades based on the providedupgradeHeightandstoreUpgrades. It checks if the store supports upgrades and applies them accordingly, falling back to the default loading behavior if no upgrades are needed. The comments provide a clear explanation of the function's purpose and behavior.To further improve the documentation, consider adding a godoc comment for the
UpgradeStoreLoaderfunction, providing a more detailed explanation of its parameters, return value, and usage. This will enhance the overall documentation quality and make it easier for other developers to understand and use this function.
Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Files selected for processing (4)
- runtime/store.go (2 hunks)
- runtime/v2/store.go (2 hunks)
- simapp/v2/upgrades.go (2 hunks)
- x/upgrade/types/storeloader.go (1 hunks)
Files skipped from review as they are similar to previous changes (1)
- simapp/v2/upgrades.go
Additional context used
Path-based instructions (3)
x/upgrade/types/storeloader.go (1)
Pattern
**/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.runtime/v2/store.go (1)
Pattern
**/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.runtime/store.go (1)
Pattern
**/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.
Additional comments not posted (4)
x/upgrade/types/storeloader.go (1)
3-6: Refactoring Approved: Simplifies Code and Maintains Backward CompatibilityThe refactoring of moving the
UpgradeStoreLoaderfunction to theruntimepackage and assigning its value to a variable for backward compatibility is a good change because:
- It simplifies the code by delegating the store loading logic to the
runtimepackage's implementation, promoting a more modular design.- The variable assignment ensures that existing functionality remains accessible, maintaining backward compatibility.
- The change aligns with the objective of enabling more flexible data loading and upgrade capabilities.
Great work on this refactoring!
runtime/v2/store.go (2)
60-62: LGTM!The
StoreLoadertype definition is correct and the comment clearly explains its purpose of enabling custom store loading mechanisms, which is useful for store upgrades.
64-67: LGTM!The
DefaultStoreLoaderfunction implementation is correct and the comment clearly explains its behavior of callingLoadLatestVersionon the provided store.runtime/store.go (1)
184-202: LGTM!The
UpgradeStoreLoaderfunction is a well-designed addition that provides a flexible mechanism for custom store loading during upgrades. It takes the upgrade height and store upgrades as parameters and returns abaseapp.StoreLoader.The function correctly checks if the current commit version matches the specified upgrade height and if there are any store upgrades to apply. If the conditions are met, it invokes
LoadLatestVersionAndUpgradeon theCommitMultiStorewith the provided upgrades. If the upgrade conditions are not met, it falls back to the default store loader usingbaseapp.DefaultStoreLoader.The function signature and parameters follow the Golang conventions, and the code is properly documented with comments explaining its purpose and behavior.
Overall, this addition enhances the upgrade capabilities of the application by allowing custom store loading logic during upgrades.
Co-authored-by: marbar3778 <[email protected]> (cherry picked from commit 7d6ff0d) # Conflicts: # CHANGELOG.md # runtime/v2/app.go # runtime/v2/module.go # runtime/v2/store.go
Co-authored-by: Randy Grok <[email protected]> Co-authored-by: Julien Robert <[email protected]>
* main: test: fix sims (#21735) build: bump proto-builder (#21730) refactor(schema)!: rename IntegerStringKind and DecimalStringKind (#21694) feat(types/collections): add `LegacyDec` collection value (#21693) refactor(server): alias AppOptions to coreserver.DynamicConfig (#21711) refactor(simapp): simplify simapp di (#21718) feat: replace the cosmos-db usecases in the tests with `core/testing` (#21525) feat(runtime/v2): store loader on simappv2 (#21704) docs(x/auth): vesting (#21715) build(deps): Bump google.golang.org/grpc from 1.66.1 to 1.66.2 (#21670) refactor(systemtest): Add cli.RunAndWait for common operations (#21689) fix(runtime/v2): provide default factory options if unset in app builder (#21690) chore: remove duplicate proto files for the same proto file (#21648) feat(x/genutil): add better error messages for genesis validation (#21701) build(deps): Bump cosmossdk.io/core from 1.0.0-alpha.1 to 1.0.0-alpha.2 (#21698) test: migrate e2e/bank to system tests (#21607) chore: fix the gci lint issue in testutil (#21695) docs(x/authz): update grant docs (#21677)
Description
Closes: #21637
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
Summary by CodeRabbit
New Features
StoreLoaderhelper function.Bug Fixes
Documentation
Refactor