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(runtime/v2): Export Genesis #20009

Merged
merged 10 commits into from
Apr 25, 2024
Merged

feat(runtime/v2): Export Genesis #20009

merged 10 commits into from
Apr 25, 2024

Conversation

hieuvubk
Copy link
Contributor

Description

Closes: #19244


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

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

@hieuvubk hieuvubk requested a review from a team as a code owner April 11, 2024 09:17
Copy link
Contributor

coderabbitai bot commented Apr 11, 2024

Important

Auto Review Skipped

Auto reviews are disabled on base/target branches other than the default branch. Please add the base/target branch pattern to the list of additional branches to be reviewed in the settings.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@hieuvubk your pull request is missing a changelog!

runtime/v2/manager.go Outdated Show resolved Hide resolved
runtime/v2/manager.go Outdated Show resolved Hide resolved
runtime/v2/manager.go Outdated Show resolved Hide resolved
runtime/v2/manager.go Fixed Show fixed Hide fixed
runtime/v2/manager.go Fixed Show fixed Hide fixed
runtime/v2/manager.go Dismissed Show dismissed Hide dismissed
@julienrbrt julienrbrt changed the title (Runtime/v2): Init & Export Genesis feat(runtime/v2): Init & Export Genesis Apr 11, 2024
runtime/v2/manager.go Outdated Show resolved Hide resolved
Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

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

We should use an sdk.Context

runtime/v2/manager.go Outdated Show resolved Hide resolved
runtime/v2/manager.go Outdated Show resolved Hide resolved
runtime/v2/manager.go Outdated Show resolved Hide resolved
runtime/v2/manager.go Outdated Show resolved Hide resolved
Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

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

lgtm! I suppose the validator updates stuff should be refactored when we have an implementation of genesis in stf (too early to do it now imho)

runtime/v2/manager.go Fixed Show fixed Hide fixed
runtime/v2/manager.go Fixed Show fixed Hide fixed
Copy link
Member

@kocubinski kocubinski left a comment

Choose a reason for hiding this comment

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

This approach conflicts with work in #20076 which takes a different approach. Tangibly this PR will panic at this site https://github.com/cosmos/cosmos-sdk/blob/server_modular/runtime/v2/app.go#L134-L136 since ExecuteGenesisTx is not implemented (and probably shouldn't be in v2) on runtime/v2.App.

We should decide which approach we want to take first so I'm requesting changes for now.

Copy link
Contributor

@alpe alpe left a comment

Choose a reason for hiding this comment

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

Very nice start! The export should work as expected.
I have added some nits and personal preferences to share some thoughts. i hope they help. But feel free to ignore. Good work 🌷

for moduleName := range channels {
res := <-channels[moduleName]
if res.err != nil {
return nil, fmt.Errorf("genesis export error in %s: %w", moduleName, res.err)
Copy link
Contributor

Choose a reason for hiding this comment

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

🤔 would it make sense to collect all error messages instead and return them together? It is also ok to fail fast on first error. You could cancel the context in this case (ctx, cancel := context.WithCancel(ctx)) (assuming the modules would abort) and exit the Go routines early, too.


genesisData := make(map[string]json.RawMessage)
for moduleName := range channels {
res := <-channels[moduleName]
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: this is blocking on the first channel in the map. If you would move the module name into the genesisResult, you can have a channel just for the results instead that would be a fifo. Not sure if this gives some significant performance benefit or makes it harder to read. 🤷

runtime/v2/manager.go Outdated Show resolved Hide resolved
runtime/v2/manager.go Outdated Show resolved Hide resolved
ch <- genesisResult{jm, nil}
}(module, channels[moduleName])
}
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Modules that do not implement the export method are silently ignored. Would some log output make sense?

Copy link
Member

@julienrbrt julienrbrt Apr 19, 2024

Choose a reason for hiding this comment

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

All mandatory modules are present and checked by assertNoForgottenModules.
I'd rather have assertNoForgottenModules panic when unnecessary modules are present than adding extra log personally.

We have relaxed the required modules in the previous sdk release, but you could still add modules to say OrderBeginBlock that don't implement BeginBlocker, and it will be silently skipped. Given this is a green field, imho best to have assertNoForgottenModules more pedantic in this new module manager.

runtime/v2/manager.go Show resolved Hide resolved
@tac0turtle tac0turtle changed the title feat(runtime/v2): Init & Export Genesis feat(runtime/v2): Export Genesis Apr 23, 2024
runtime/v2/manager.go Dismissed Show dismissed Hide dismissed
@hieuvubk hieuvubk requested review from alpe and kocubinski April 25, 2024 06:19
@tac0turtle tac0turtle merged commit ddea308 into server_modular Apr 25, 2024
54 of 59 checks passed
@tac0turtle tac0turtle deleted the mm_genesis branch April 25, 2024 15:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants