feat(runtime/v2): store loader on simappv2 #21704

randygrok · 2024-09-13T07:16:07Z

Description

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...

included the correct type prefix in the PR title, you can find examples of the prefixes below:
confirmed ! in the type prefix if API or client breaking change
targeted the correct branch (see PR Targeting)
provided a link to the relevant issue or specification
reviewed "Files changed" and left comments if necessary
included the necessary unit and integration tests
added a changelog entry to CHANGELOG.md
updated the relevant documentation or specification, including comments for documenting Go code
confirmed all CI checks have passed

Reviewers 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...

confirmed the correct type prefix in the PR title
confirmed all author checklist items have been addressed
reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

New Features
- Introduced a flexible store loading mechanism, allowing for custom loading strategies.
- Enhanced store upgrade capabilities for better version management.
- Added a feature to simulate nested messages in the base application.
- Added documentation clarifying the location of the StoreLoader helper function.
Bug Fixes
- Improved the upgrade handling process to streamline store upgrades.
Documentation
- Updated testing capabilities by adding new dependencies for enhanced functionality.
Refactor
- Cleaned up code related to store loader configurations for clarity and relevance.

julienrbrt

nice! some nits

julienrbrt · 2024-09-13T07:28:38Z

runtime/v2/store.go

+ return store.LoadLatestVersion()
+}
+
+func V2UpgradeStoreLoader(upgradeHeight int64, storeUpgrades *store.StoreUpgrades) StoreLoader {


can we add a go doc?

Given that it is in runtime/v2, no need to prepend it by V2 imho.
For consistency, shall we place the other one from x/upgrade in runtime?
And just alias it back in x/upgrade for not introducing breaking changes?

Additionally, can we add a :tip: in x/upgrade docs mentioning for server/v2 this helper is in runtime/v2

julienrbrt · 2024-09-13T07:29:14Z

simapp/v2/app_test.go

@@ -21,6 +22,7 @@ import (
 serverv2 "cosmossdk.io/server/v2"
 comettypes "cosmossdk.io/server/v2/cometbft/types"
 "cosmossdk.io/store/v2/db"
+ authtypes "cosmossdk.io/x/auth/types"


probably from some of my tests, will remove

julienrbrt · 2024-09-13T07:29:18Z

simapp/v2/app_test.go

@@ -11,6 +11,7 @@ import (
 "github.com/spf13/viper"
 "github.com/stretchr/testify/require"

+ app2 "cosmossdk.io/core/app"


tac0turtle

LGTM, once juliens comments are addressed we can merge

coderabbitai

Actionable comments posted: 0

Outside diff range and nitpick comments (1)

runtime/v2/store.go (1)

69-90: LGTM with a suggestion!

The UpgradeStoreLoader function implementation is correct and provides a robust mechanism for handling store upgrades based on the provided upgradeHeight and storeUpgrades. 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 UpgradeStoreLoader function, 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

Commits

Files that changed from the base of the PR and between 346e715 and 7586ee2.

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 Compatibility

The refactoring of moving the UpgradeStoreLoader function to the runtime package 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 runtime package'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 StoreLoader type 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 DefaultStoreLoader function implementation is correct and the comment clearly explains its behavior of calling LoadLatestVersion on the provided store.

runtime/store.go (1)

184-202: LGTM!

The UpgradeStoreLoader function 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 a baseapp.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 LoadLatestVersionAndUpgrade on the CommitMultiStore with the provided upgrades. If the upgrade conditions are not met, it falls back to the default store loader using baseapp.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.

julienrbrt

lgtm!

Co-authored-by: marbar3778 <marbar3778@yahoo.com> (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 <98407738+randygrok@users.noreply.github.com> Co-authored-by: Julien Robert <julien@rbrt.fr>

* 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)

tac0turtle and others added 30 commits June 24, 2024 12:41

add state export

ebf5006

minor

268c034

Merge branch 'main' into marko/state_export

babf339

comment out export zero height

6780043

Merge branch 'main' into marko/state_export

61c0343

add logic for export app state and bootstrap simapp tests

b8ac0e5

fix bug with export genesis nil pointer

a1b0a5f

some additions to continue the test

71d0027

add context with value

cadccd4

remove commented code

7bc73f0

go mod tidy all

728313a

add version on export

e97fda6

include export validators

57c9751

add validators into status

a32d778

include new types mode

4bcf345

go mod tidy all

7006da5

temp commit, include logic for zeroheight

91570fb

remove zero height part

de93866

add export

9fc2546

apply into simapp v2

7a1fa60

Merge remote-tracking branch 'origin/main' into randy/export-genesis

6b32d53

remove option to export certain modules only

db542cf

remove modules to export feature

70f1090

remove modules to export feature part 2

ea0193d

remove debug entry in manager

c552beb

delete commented code

f67770e

rename RunWithCtx

2948e09

race condition not fixed yet

a0ffd0a

remove concurrent export

519d6b7

include issue number

f199f06

julienrbrt reviewed Sep 13, 2024

View reviewed changes

julienrbrt assigned julienrbrt and hieuvubk Sep 13, 2024

tac0turtle approved these changes Sep 13, 2024

View reviewed changes

move UpgradeStoreLoader to runtime mod

7586ee2

randygrok requested review from facundomedica, cool-develope, akhilkumarpilli and lucaslopezf as code owners September 13, 2024 12:57

github-actions bot added the C:x/upgrade label Sep 13, 2024

coderabbitai bot reviewed Sep 13, 2024

View reviewed changes

randygrok and others added 3 commits September 13, 2024 15:25

fix from review

4ecf936

Merge branch 'main' into feat/store-loader

c732286

add changelog

b2082c8

randygrok requested a review from julienrbrt September 13, 2024 13:56

lint upgrades

8c23aa5

julienrbrt approved these changes Sep 13, 2024

View reviewed changes

julienrbrt enabled auto-merge September 13, 2024 14:08

julienrbrt added this pull request to the merge queue Sep 13, 2024

Merged via the queue into main with commit 7d6ff0d Sep 13, 2024
74 checks passed

julienrbrt deleted the feat/store-loader branch September 13, 2024 14:27

mergify bot mentioned this pull request Sep 13, 2024

feat(runtime/v2): store loader on simappv2 (backport #21704) #21717

Merged

12 tasks

julienrbrt added a commit that referenced this pull request Sep 13, 2024

feat(runtime/v2): store loader on simappv2 (backport #21704) (#21717)

71803b7

Co-authored-by: Randy Grok <98407738+randygrok@users.noreply.github.com> Co-authored-by: Julien Robert <julien@rbrt.fr>

This was referenced Sep 16, 2024

feat(runtime(v2)): add sanity checks on store upgrades #21748

Merged

feat: make validator key injectable by application developers #21608

Merged

docs: minor cleanup to simulation docs #21777

Merged

refactor(stf): remove RunWithCtx #21739

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(runtime/v2): store loader on simappv2 #21704

feat(runtime/v2): store loader on simappv2 #21704

randygrok commented Sep 13, 2024 •

edited by coderabbitai bot

Loading

julienrbrt left a comment

julienrbrt Sep 13, 2024

julienrbrt Sep 13, 2024

randygrok Sep 13, 2024

julienrbrt Sep 13, 2024

randygrok Sep 13, 2024

julienrbrt Sep 13, 2024

tac0turtle left a comment

coderabbitai bot left a comment

julienrbrt left a comment

feat(runtime/v2): store loader on simappv2 #21704

feat(runtime/v2): store loader on simappv2 #21704

Conversation

randygrok commented Sep 13, 2024 • edited by coderabbitai bot Loading

Description

Author Checklist

Reviewers Checklist

Summary by CodeRabbit

Summary by CodeRabbit

julienrbrt left a comment

Choose a reason for hiding this comment

julienrbrt Sep 13, 2024

Choose a reason for hiding this comment

julienrbrt Sep 13, 2024

Choose a reason for hiding this comment

randygrok Sep 13, 2024

Choose a reason for hiding this comment

julienrbrt Sep 13, 2024

Choose a reason for hiding this comment

randygrok Sep 13, 2024

Choose a reason for hiding this comment

julienrbrt Sep 13, 2024

Choose a reason for hiding this comment

tac0turtle left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

julienrbrt left a comment

Choose a reason for hiding this comment

randygrok commented Sep 13, 2024 •

edited by coderabbitai bot

Loading