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

fix(server/v2): remove dup commands + reduce api surface #20810

Merged
merged 2 commits into from
Jul 4, 2024

Conversation

julienrbrt
Copy link
Member

@julienrbrt julienrbrt commented Jun 28, 2024

Description

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

  • Refactor

    • Improved command organization in the initRootCmd function to eliminate duplicates and streamline child command additions.
    • Reorganized the CLICommands method to ensure only non-empty sets of commands, transactions, and queries are included.
  • Bug Fixes

    • Fixed the issue of duplicate command additions in the root command initialization.

@julienrbrt julienrbrt requested a review from a team as a code owner June 28, 2024 13:11
Copy link
Contributor

coderabbitai bot commented Jun 28, 2024

Walkthrough

Walkthrough

The changes primarily involve refactoring and organizing command-related functionalities for improved code maintainability. Key modifications include moving specific CLI commands between categories, breaking down larger functions into more specialized ones, and optimizing command addition processes by removing duplications.

Changes

File Change Summary
server/v2/cometbft/server.go Moved ResetAllCmd and ResetStateCmd from Commands to Queries in CLICommands method.
server/v2/commands.go Refactored Commands function into more focused createStartCommand; updated AddCommands to use the new function.
server/v2/server.go Revised CLICommands method to check the length of command sets before appending, ensuring only non-empty sets are included.
simapp/v2/simdv2/cmd/commands.go Updated initRootCmd to remove duplicate command additions and add key-based commands in a single block.

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

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

@julienrbrt your pull request is missing a changelog!

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c7375f7 and 613f14d.

Files selected for processing (4)
  • server/v2/cometbft/server.go (1 hunks)
  • server/v2/commands.go (5 hunks)
  • server/v2/server.go (1 hunks)
  • simapp/v2/simdv2/cmd/commands.go (2 hunks)
Files skipped from review due to trivial changes (1)
  • server/v2/commands.go
Additional context used
Path-based instructions (3)
server/v2/server.go (1)

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

simapp/v2/simdv2/cmd/commands.go (1)

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

server/v2/cometbft/server.go (1)

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

Additional comments not posted (3)
server/v2/server.go (1)

139-151: Optimization of command addition based on non-empty checks.

The changes ensure that only non-empty command sets are appended, which helps in maintaining a cleaner and more efficient command structure. This aligns well with the PR's goal to reduce the API surface.

simapp/v2/simdv2/cmd/commands.go (1)

102-111: Consolidation of command additions in initRootCmd.

The changes effectively remove duplicate additions of commands, which helps in simplifying the command structure and aligns with the PR's goal to reduce the API surface.

server/v2/cometbft/server.go (1)

198-201: Reclassification of commands to queries.

Moving ResetAllCmd and ResetStateCmd from Commands to Queries could be beneficial for clarity and organization, assuming these operations are more query-like in nature. It's important to ensure that this reclassification aligns with the expected use cases and functionality of these commands.

Copy link
Contributor

@hieuvubk hieuvubk left a comment

Choose a reason for hiding this comment

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

tACK

@@ -99,6 +99,16 @@ func initRootCmd[AppT serverv2.AppI[T], T transaction.Tx](
panic(fmt.Sprintf("failed to create logger: %v", err))
}

// add keybase, auxiliary RPC, query, genesis, and tx child commands
rootCmd.AddCommand(
server.StatusCommand(),
Copy link
Contributor

Choose a reason for hiding this comment

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

we should remove this command since having comet status command

@julienrbrt julienrbrt enabled auto-merge July 4, 2024 08:03
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 613f14d and 98305c9.

Files selected for processing (1)
  • simapp/v2/simdv2/cmd/commands.go (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • simapp/v2/simdv2/cmd/commands.go

Copy link
Member

@tac0turtle tac0turtle left a comment

Choose a reason for hiding this comment

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

Thank you

@julienrbrt julienrbrt added this pull request to the merge queue Jul 4, 2024
Merged via the queue into main with commit 9df6019 Jul 4, 2024
69 checks passed
@julienrbrt julienrbrt deleted the julien/serverv2cmd branch July 4, 2024 08:26
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