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(x/genutil): add better error messages for genesis validation (backport #21701) #21708

Merged
merged 4 commits into from
Sep 13, 2024

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Sep 13, 2024

Description

Closes: #17250

Add more specific errors for the following cases during simd genesis validate:

  • Invalid JSON
  • Missing app_state
  • Missing module configuration inside the app_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...

  • 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
    • Enhanced error messages for genesis validation, providing clearer feedback for developers.
  • Bug Fixes
    • Resolved an issue with block commits related to halt height, restoring expected functionality.
  • Tests
    • Improved test cases for genesis validation, including scenarios for invalid JSON and missing configurations.

This is an automatic backport of pull request #21701 done by [Mergify](https://mergify.com).

…1701)

(cherry picked from commit 9c5cea0)

# Conflicts:
#	CHANGELOG.md
#	x/genutil/client/cli/validate_genesis.go
Copy link
Contributor Author

mergify bot commented Sep 13, 2024

Cherry-pick of 9c5cea0 has failed:

On branch mergify/bp/release/v0.50.x/pr-21701
Your branch is up to date with 'origin/release/v0.50.x'.

You are currently cherry-picking commit 9c5cea08c.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	modified:   x/genutil/client/cli/validate_genesis_test.go

Unmerged paths:
  (use "git add <file>..." to mark resolution)
	both modified:   CHANGELOG.md
	both modified:   x/genutil/client/cli/validate_genesis.go

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

@mergify mergify bot requested a review from a team as a code owner September 13, 2024 09:47
@mergify mergify bot added the conflicts label Sep 13, 2024
Copy link
Contributor

coderabbitai bot commented Sep 13, 2024

Important

Review skipped

Bot user detected.

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.


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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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

@github-actions github-actions bot added C:CLI C:x/genutil genutil module issues labels Sep 13, 2024
@tac0turtle tac0turtle force-pushed the mergify/bp/release/v0.50.x/pr-21701 branch from f6c5007 to d6d4ef6 Compare September 13, 2024 10:09
@julienrbrt julienrbrt force-pushed the mergify/bp/release/v0.50.x/pr-21701 branch from d6d4ef6 to e0b60eb Compare September 13, 2024 10:20
@tac0turtle tac0turtle force-pushed the mergify/bp/release/v0.50.x/pr-21701 branch from e0b60eb to 2fb2738 Compare September 13, 2024 10:27
@tac0turtle tac0turtle enabled auto-merge (squash) September 13, 2024 10:29
@julienrbrt julienrbrt force-pushed the mergify/bp/release/v0.50.x/pr-21701 branch from 2fb2738 to 9490a94 Compare September 13, 2024 10:33
@tac0turtle tac0turtle merged commit f78ed49 into release/v0.50.x Sep 13, 2024
40 of 43 checks passed
@tac0turtle tac0turtle deleted the mergify/bp/release/v0.50.x/pr-21701 branch September 13, 2024 10:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C:CLI C:x/genutil genutil module issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants