fix(client/v2): correctly handle enhanced sub commands

[johnletey]

Description

When attempting to enhance sub commands, AutoCLI would be adding two sub commands to the main command.

---

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 command-line interface by selectively adding commands based on specific conditions, improving user control over available commands.
• Bug Fixes
  • Resolved issues with command registration, ensuring that only appropriate commands are displayed based on enhancement settings.

[coderabbitai]

📝 Walkthrough

Walkthrough

The changes in this pull request introduce conditional checks in the AddMsgServiceCommands and AddQueryServiceCommands functions. These checks determine whether to add commands to their respective parent commands based on the EnhanceCustomCommand property of the command descriptor. This modification alters the command registration process by selectively including commands, thus potentially limiting the commands available in the command-line interface.

Changes

Files	Change Summary
client/v2/autocli/msg.go, client/v2/autocli/query.go	Introduced conditional checks in AddMsgServiceCommands and AddQueryServiceCommands to add commands based on EnhanceCustomCommand.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI
    participant CommandDescriptor

    User->>CLI: Request command
    CLI->>CommandDescriptor: Check EnhanceCustomCommand
    alt EnhanceCustomCommand is false
        CLI->>CLI: Add command to parent
    else EnhanceCustomCommand is true
        CLI->>CLI: Do not add command
    end

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: 1

Outside diff range and nitpick comments (1)

client/v2/autocli/query.go (1)

56-58: Conditional check for adding subcommands based on EnhanceCustomCommand flag.

The introduced conditional check allows for selective inclusion of subcommands based on the EnhanceCustomCommand property. If EnhanceCustomCommand is true, the subcommand will not be automatically added to the command. This change provides more control over the CLI commands and allows for customization.

Consider adding a comment to clarify the intention behind the EnhanceCustomCommand flag and its impact on command registration.

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 01212de and 53f5842.

Files selected for processing (2)

• client/v2/autocli/msg.go (1 hunks)
• client/v2/autocli/query.go (1 hunks)

Additional context used

Path-based instructions (2)

client/v2/autocli/query.go (1)

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

client/v2/autocli/msg.go (1)

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

Additional comments not posted (1)

client/v2/autocli/query.go (1)

Line range hint 1-200: Code conforms to the Uber Golang style guide.

The Golang code follows the naming conventions, formatting, and code structure recommended by the Uber Golang style guide. The package naming and import grouping adhere to the guidelines. The code also follows the recommended error handling and return practices.

[coderabbitai]

The conditional check alters the command registration behavior.

This change introduces a gate that conditionally adds the subCmd to the parent cmd based on the EnhanceCustomCommand property of the subCmdDesc descriptor. Commands will only be included if EnhanceCustomCommand is false.

Consider adding documentation or comments to clarify:

• The purpose and effect of the EnhanceCustomCommand property.
• How this change impacts the CLI user experience, as certain commands may not be available based on this setting.

[julienrbrt]

Could we add a comment on this? This makes sense to respect the EnhanceCustomCommand on subcommands too but let's be explicit with a comment.
Any way we could capture this in a test? (see query_test.go)

[johnletey]

Should I work on this, or @JulianToledano?

[julienrbrt]

Should I work on this, or @JulianToledano?

You can do it if you can. Assignees are for PR reviews. If you can't, then we'll do it.

[johnletey]

If you can't, then we'll do it.

If that would be possible, your team understands the test suite better ... so I'd appreciate your help here!

[julienrbrt]

tACK! We'll add a test in a follow-up