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

(serverv2/cometbft) Commands support both json and yaml output #20670

Merged
merged 2 commits into from
Jun 17, 2024

Conversation

hieuvubk
Copy link
Contributor

@hieuvubk hieuvubk commented Jun 14, 2024

Description

Closes: #20495


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 output handling for various commands by introducing a new printOutput function.
    • Consolidated output formats (JSON, YAML) handling to enhance flexibility and maintainability.

@hieuvubk hieuvubk requested a review from a team as a code owner June 14, 2024 08:38
Copy link
Contributor

coderabbitai bot commented Jun 14, 2024

Walkthrough

The refactoring in server/v2/cometbft/commands.go centralizes output handling by introducing a printOutput function. This new function supports JSON and YAML formats based on a flag, improving flexibility and structure. The changes involve updating key command functions to utilize printOutput instead of directly printing output, aligning with the goal of supporting multiple output formats.

Changes

Files Change Summary
.../server/v2/cometbft/commands.go Introduced printOutput function to handle JSON and YAML format output. Updated various functions (StatusCommand, BlockCommand, QueryBlockResultsCmd) to use printOutput for output handling. No output handling change in BootstrapStateCmd, included for completeness.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CometBFTServer
    participant cobra.Command

    User ->> CometBFTServer: Invoke statusCommand()
    CometBFTServer ->> cobra.Command: cmd.ExecuteC()
    cobra.Command ->> CometBFTServer: Run cmd function (statusCommand)
    CometBFTServer ->> CometBFTServer: Fetch status data
    CometBFTServer ->> CometBFTServer: printOutput(cmd, data)
    CometBFTServer ->> cobra.Command: Write output based on format
    cobra.Command ->> User: Display results
Loading

Assessment against linked issues

Objective Addressed Explanation
server/v2/cometbft commands should support both json and yaml output (#20495)

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

@hieuvubk your pull request is missing a changelog!

@hieuvubk
Copy link
Contributor Author

Local tested with yaml & json output:
Ảnh chụp Màn hình 2024-06-14 lúc 15 15 14
Ảnh chụp Màn hình 2024-06-14 lúc 15 15 38

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

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between fa45e10 and d9252e9.

Files selected for processing (1)
  • server/v2/cometbft/commands.go (6 hunks)
Additional context used
Path-based instructions (1)
server/v2/cometbft/commands.go (1)

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


// TODO: figure out yaml and json output
return nil
return printOutput(cmd, output)
Copy link
Contributor

Choose a reason for hiding this comment

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

Tip

Codebase Verification

Ensure consistent output handling by replacing cmd.Println with printOutput.

  • server/v2/cometbft/commands.go:
    • Line 75: cmd.Println(nodeKey.ID())
    • Line 220: cmd.Println(sdkPK)
    • Line 284: cmd.Println(valConsAddr.String())
    • Line 307: cmd.Println(string(bs))
Analysis chain

Ensure consistent output handling across commands.

This script checks if any command directly prints the output instead of using the printOutput function, which could lead to inconsistencies in how outputs are handled across different commands.

Also applies to: 220-220, 284-284, 307-307, 363-363

Scripts executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify that all command functions use `printOutput` consistently for handling outputs.

# Test: Search for inconsistent usage of output handling in command functions. Expect: Uniform usage of `printOutput`.
rg --type go "cmd.Println" -g "commands.go"

Length of output: 405



Script:

#!/bin/bash
# Extract relevant lines and surrounding context from commands.go to review the usage of `cmd.Println`.

# Get the lines around each usage of `cmd.Println` to understand the context.
rg --type go --context 5 "cmd.Println" -g "commands.go"

Length of output: 2640

Comment on lines +415 to +443
func printOutput(cmd *cobra.Command, out []byte) error {
// Get flags output
outFlag, err := cmd.Flags().GetString(flags.FlagOutput)
if err != nil {
return err
}

if outFlag == "text" {
out, err = yaml.JSONToYAML(out)
if err != nil {
return err
}
}

writer := cmd.OutOrStdout()
_, err = writer.Write(out)
if err != nil {
return err
}

if outFlag != "text" {
// append new-line for formats besides YAML
_, err = writer.Write([]byte("\n"))
if err != nil {
return err
}
}
return nil
}
Copy link
Contributor

Choose a reason for hiding this comment

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

Refactor error handling to streamline the function.

func printOutput(cmd *cobra.Command, out []byte) error {
    outFlag, err := cmd.Flags().GetString(flags.FlagOutput)
    if err != nil {
        return err
    }

    writer := cmd.OutOrStdout()
    if outFlag == "text" {
        out, err = yaml.JSONToYAML(out)
        if err != nil {
            return err
        }
        _, err = writer.Write(out)
    } else {
        _, err = writer.Write(out)
        if err == nil {
            _, err = writer.Write([]byte("\n"))
        }
    }
    return err
}

This refactor simplifies the branching logic by handling the write operation in a single block and ensuring the new line is added only in non-YAML formats.

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
func printOutput(cmd *cobra.Command, out []byte) error {
// Get flags output
outFlag, err := cmd.Flags().GetString(flags.FlagOutput)
if err != nil {
return err
}
if outFlag == "text" {
out, err = yaml.JSONToYAML(out)
if err != nil {
return err
}
}
writer := cmd.OutOrStdout()
_, err = writer.Write(out)
if err != nil {
return err
}
if outFlag != "text" {
// append new-line for formats besides YAML
_, err = writer.Write([]byte("\n"))
if err != nil {
return err
}
}
return nil
}
func printOutput(cmd *cobra.Command, out []byte) error {
outFlag, err := cmd.Flags().GetString(flags.FlagOutput)
if err != nil {
return err
}
writer := cmd.OutOrStdout()
if outFlag == "text" {
out, err = yaml.JSONToYAML(out)
if err != nil {
return err
}
_, err = writer.Write(out)
} else {
_, err = writer.Write(out)
if err == nil {
_, err = writer.Write([]byte("\n"))
}
}
return err
}

@hieuvubk hieuvubk enabled auto-merge June 17, 2024 06:37
@hieuvubk hieuvubk added this pull request to the merge queue Jun 17, 2024
Merged via the queue into main with commit 9ab7d39 Jun 17, 2024
64 of 65 checks passed
@hieuvubk hieuvubk deleted the hieu/comet_output branch June 17, 2024 06:47
alpe added a commit that referenced this pull request Jun 17, 2024
* main:
  feat(tx): port simappv2 changes (#20648)
  build(deps): Bump github.com/spf13/cobra from 1.8.0 to 1.8.1 (#20682)
  chore(proto): fix comments (#20679)
  (serverv2/cometbft) Commands support both json and yaml output (#20670)
  fix(x/staking,x/auth):  regenerate mock to fix test (#20684)
  docs: ADR 074: Msg v2 (#20618)
  fix: nested multisig signatures using CLI (#20438)
  chore: fix spelling errors (#20674)
  fix: align Dockerfile for build-push-action (#20672)
  fix: avoid build fail when make localnet-build-env (#20671)
  build(deps): Bump bufbuild/buf-setup-action from 1.32.2 to 1.33.0 (#20669)
  chore: make function comment match function names (#20666)
  chore(consensus): add cometInfo to consensus  (#20615)
  chore: fix typos (#20662)
  fix: Properly parse json in the wait-tx command. (#20631)
  fix(sims): check before sending RotateConsPubKey (#20659)
  test(types/address): add unit tests for the file types/address.go  (#20237)
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.

server/v2/cometbft commands should support both json and yaml output
5 participants