feat(client/v2): improve error message on enums

[facundomedica]

Description

This PR improves AutoCLI by printing the possible enum values when an invalid input is provided, otherwise users don't know what is valid.

Closes: #XXXX

---

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 handling for invalid input in the Set method, providing users with a list of valid enum values in error messages.

• Documentation

  • Updated changelog to include improvements in error reporting for invalid inputs, enhancing user feedback.

[coderabbitai]

📝 Walkthrough

📝 Walkthrough

Walkthrough

The pull request modifies the Set method of the enumValue type in the client/v2/autocli/flag/enum.go file. The change enhances error handling by providing a list of valid enum values in the error message when an invalid string is supplied. This update improves the clarity of feedback given to users regarding acceptable input values.

Changes

File Path	Change Summary
client/v2/autocli/flag/enum.go	Updated the Set method to improve error handling by including a list of valid enum values in error messages.
client/v2/CHANGELOG.md	Added a new section for improvements, highlighting the enhancement of error messages in the context of invalid inputs.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant EnumValue

    User->>EnumValue: Call Set("invalid_value")
    EnumValue-->>User: Return error("invalid_value. Valid options are: [valid1, valid2, valid3]")

Loading

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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.

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.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

client/v2/autocli/flag/enum.go (1)

61-66: Excellent improvement to error messaging!

The changes effectively address the PR objective by providing clearer feedback to users when an invalid enum value is supplied. The implementation is correct and efficient, following the Uber Golang style guide.

A minor suggestion for improvement:

Consider pre-allocating the validValues slice to improve performance slightly:

-		var validValues []string
+		validValues := make([]string, 0, len(e.valMap))

This pre-allocation can be beneficial when dealing with a large number of enum values.

📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 2d8ca73 and c692c0b.

📒 Files selected for processing (1)

• client/v2/autocli/flag/enum.go (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

client/v2/autocli/flag/enum.go (1)

Pattern **/*.go: Review the Golang code for conformity with the Uber Golang style guide, highlighting any deviations.

[julienrbrt]

@facundomedica your pull request is missing a changelog!

Let's add one in client/v2/changelog under improvements yes

[julienrbrt]

utACK

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

client/v2/CHANGELOG.md (1)

46-48: LGTM! Consider a minor wording improvement.

The new changelog entry is correctly placed, formatted, and aligns with the PR objectives. Well done!

Consider slightly rewording the entry for clarity:

- * [#21936](https://github.com/cosmos/cosmos-sdk/pull/21936) Print possible enum values in error message after an invalid input was provided.
+ * [#21936](https://github.com/cosmos/cosmos-sdk/pull/21936) Enhance error messages to include possible enum values when an invalid input is provided.

This minor change makes the sentence more active and emphasizes the improvement in error handling.

📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 6c9d99d and e8ac1f2.

📒 Files selected for processing (1)

• client/v2/CHANGELOG.md (1 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

client/v2/CHANGELOG.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"