feat(x/genutil): add better error messages for genesis validation #21701
Conversation
WalkthroughWalkthroughThe pull request introduces enhancements to the Changes
Assessment against linked issues
Possibly related PRs
Suggested labels
Tip OpenAI O1 model for chat
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 using PR comments)
Other keywords and placeholders
Documentation and Community
|
…ror-trace' into ziscky/17250-validate-genesis-error-trace
ziscky
requested review from
kocubinski,
hieuvubk,
julienrbrt and
a team
as code owners
![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 (2)
CHANGELOG.md (2)
Line range hint
568-605: Improvements Section is Comprehensive but Could Benefit from CategorizationThe "Improvements" section provides an extensive list of enhancements made across the SDK and individual modules. The improvements span CLI commands, query/message types, performance optimizations, and more.
While the content appears to be accurately captured, the section is quite lengthy. To improve readability and organization, consider categorizing the improvements into subsections like:
- CLI Improvements
- API Improvements
- Module-Specific Improvements
- Performance Improvements
- Miscellaneous Improvements
This will allow readers to more quickly find and parse relevant changes. Overall though, great job compiling this comprehensive list of improvements!
Line range hint
608-626: Bug Fixes Accurately CapturedThe "Bug Fixes" section accurately lists the various bugs that were fixed across the SDK and individual modules. Each fix includes a brief description of the issue and a link to the relevant PR for more context.
Spot checking the PR links shows that they are all valid and point to relevant bug fix PRs. The descriptions concisely capture the core problem that was resolved.
One minor suggestion would be to group related fixes together to make the section even easier to parse. For example, you could have sub-sections for:
- CLI Fixes
- Panic/Crash Fixes
- Error Handling Fixes
- Other Fixes
But overall, this section looks great and comprehensively represents the bug fixing work done. Nice job!
Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Files selected for processing (3)
- CHANGELOG.md (1 hunks)
- x/genutil/client/cli/validate_genesis.go (4 hunks)
- x/genutil/client/cli/validate_genesis_test.go (4 hunks)
Additional context used
Path-based instructions (3)
x/genutil/client/cli/validate_genesis.go (1)
Pattern
**/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.x/genutil/client/cli/validate_genesis_test.go (2)
Pattern
**/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.
Pattern
**/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"CHANGELOG.md (1)
Pattern
**/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
Additional comments not posted (19)
x/genutil/client/cli/validate_genesis.go (5)
5-8: LGTM!The new imports are necessary for the changes made in the file.
38-38: LGTM!The change is intended to provide more informative error messages when JSON unmarshalling fails. The
enrichUnmarshalErrorfunction is defined later in the file and needs to be reviewed separately.
47-49: LGTM!The change improves the clarity of the error message when the
app_stateis missing in the genesis file.
55-59: LGTM!The change improves the clarity of the error message when a section is missing in the
app_state.
69-75: LGTM!The
enrichUnmarshalErrorfunction improves the clarity of the error messages when JSON unmarshalling fails. The function is used in the error handling fortypes.AppGenesisFromFileearlier in the file.x/genutil/client/cli/validate_genesis_test.go (12)
9-11: LGTM!The new imports are valid and necessary for the changes made in the test file.
13-18: LGTM!The new imports are valid and necessary for the changes made in the test file.
42-42: LGTM!The initialization of the
cdcvariable is correct and necessary for the changes made in the test file.
44-47: LGTM!The changes to the
testCasesstruct are valid and necessary for the new test cases added in the file.
49-54: LGTM!The new test case for "invalid json" scenario is valid and tests the scenario of invalid JSON input during genesis validation.
55-67: LGTM!The new test case for "invalid: missing module config in app_state" scenario is valid and tests the scenario of missing module configuration in the app state during genesis validation. The use of a custom module manager with a "custommod" module is appropriate for this test case.
71-72: LGTM!The updated error message for the "exported 0.37 genesis file" test case is appropriate and provides a clear indication of the expected error.
82-83: LGTM!The updated error message for the "valid 0.50 genesis file" test case is appropriate, indicating that no error is expected for a valid genesis file.
92-92: LGTM!The changes to the
clitestutil.ExecTestCLICmdfunction call are valid and necessary for executing theValidateGenesisCmdwith the appropriate module manager and genesis file.
93-94: LGTM!The changes to the error handling logic are valid and necessary for verifying the expected error messages in the test cases. The use of
require.Containsis appropriate for checking if the actual error contains the expected error string.
Line range hint
1-101: Test file conforms to the Uber Golang style guide.The test file follows the best practices for writing Go tests and conforms to the Uber Golang style guide. It has a clear structure, descriptive naming, and uses common Go test patterns. No deviations or issues were found.
Line range hint
1-101: Unit test code provides sufficient coverage.The unit test code provides sufficient code coverage for the changes associated with the pull request. The test cases cover the important scenarios and edge cases related to the genesis validation logic, including invalid JSON, missing module config, exported 0.37 genesis file, and valid 0.50 genesis file. The use of different module managers and genesis files ensures that the
ValidateGenesisCmdfunction is tested with various configurations.CHANGELOG.md (2)
Line range hint
301-324: State Machine Breaking Changes Look GoodThe "State Machine Breaking" section provides a clear and comprehensive list of the breaking changes to the state machine across various modules. Each change includes a concise description and a link to the relevant PR for more details. The breaking changes appear to be accurately captured based on the information provided.
Line range hint
1-1186: Excellent Changelog - Comprehensive and Well-OrganizedAfter reviewing the changelog in detail, I must say this is an excellent piece of documentation. The changelog comprehensively covers all the key changes made across multiple versions of the Cosmos SDK, including breaking changes, new features, improvements, bug fixes, and more.
The changes are logically grouped into clear sections and subsections, making it easy for readers to find the information they care about. Each change includes a concise yet informative description, along with links to the relevant PR(s) for those who want to dive into the details.
A few sections, like "Improvements" and "Bug Fixes", could potentially benefit from some additional sub-grouping to further enhance organization and readability. But this is a minor nitpick in the grand scheme of things.
Overall, this changelog is a shining example of what good documentation looks like. It's clear that significant effort went into compiling all these changes into a coherent, well-structured document. SDK users are lucky to have this as a reference to understand how the project has evolved over time.
To the authors (and reviewers and approvers) of this changelog - thank you for your diligence and hard work! This is the type of quality documentation that makes a huge difference to the developer experience.
julienrbrt
added
backport/v0.50.x
|
Ah my bad, I didn't see the introduced staking dep here in the tests. |
* 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: #17250
Add more specific errors for the following cases during
simd genesis validate:app_stateapp_state( this is what the creator of the issue experienced, I managed to reproduce the exact error )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