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: avoid cli redundant log in stdout #19371

Merged
merged 2 commits into from
Feb 7, 2024
Merged

Conversation

mmsqe
Copy link
Contributor

@mmsqe mmsqe commented Feb 7, 2024

log to stderr instead

Description

Closes: #19368


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

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
    • Enhanced logging practices by directing redundant logs to stderr instead of stdout.
    • Improved migration error handling and messaging for better clarity.

Copy link
Contributor

coderabbitai bot commented Feb 7, 2024

Warning

Rate Limit Exceeded

@mmsqe has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 16 minutes and 59 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between 4b8f326 and 34b55fd.

Walkthrough

The changes focus on refining logging practices within a specific module, transitioning from using standard output to standard error for logging purposes. This adjustment is aimed at enhancing error handling and messaging, particularly in the context of migration processes, by ensuring that migration errors and success messages are more accurately directed, thereby improving the overall clarity and effectiveness of the logging system.

Changes

File(s) Change Summary
CHANGELOG.md Modified logging practices to use stderr instead of stdout for non-capturable output.
crypto/.../keyring.go Updated error and success message output to stderr using fmt.Fprintln, improving error handling and messaging during migrations.

Assessment against linked issues

Objective Addressed Explanation
Address stdout/stderr stream confusion and ensure consistent, machine-readable CLI output (#19368)
Review and correct fmt.Print* usage in the SDK, especially in crypto/keyring/keyring.go, for appropriate stdout/stderr output
Propose changes for directing non-capturable output to stderr and capturable output to stdout for enhanced CLI usability (#19368)
Search and rectify similar stdout/stderr issues across the SDK's crypto libraries (#19368) The changes specifically address keyring.go, but it's unclear if a comprehensive search was conducted across all crypto libraries.

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-tests for this file.
  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

CHANGELOG.md Outdated Show resolved Hide resolved
@mmsqe mmsqe marked this pull request as ready for review February 7, 2024 13:16
@mmsqe mmsqe requested a review from a team as a code owner February 7, 2024 13:16
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.

Review Status

Actionable comments generated: 1

Configuration used: .coderabbit.yml

Commits Files that changed from the base of the PR and between 4b8f326 and 67fed2d85d0e800dd8f9d63abe609f2031d1d5a1.
Files selected for processing (2)
  • CHANGELOG.md (1 hunks)
  • crypto/keyring/keyring.go (2 hunks)
Additional comments: 2
crypto/keyring/keyring.go (2)
  • 919-919: Directing migration error messages to os.Stderr aligns with the PR's objective to avoid cluttering stdout. This change is appropriate for the context.
  • 993-993: Directing the success message for key migration to os.Stderr is consistent with the PR's goal and improves the usability of CLI tools by keeping stdout clean for machine-readable output.

CHANGELOG.md Outdated Show resolved Hide resolved
@mmsqe mmsqe changed the title fix: avoid cli redundunt log in stdout fix: avoid cli redundant log in stdout Feb 7, 2024
@julienrbrt julienrbrt added the backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release label Feb 7, 2024
@tac0turtle tac0turtle added this pull request to the merge queue Feb 7, 2024
Merged via the queue into cosmos:main with commit 863194f Feb 7, 2024
52 of 56 checks passed
mergify bot pushed a commit that referenced this pull request Feb 7, 2024
(cherry picked from commit 863194f)

# Conflicts:
#	CHANGELOG.md
mhofman pushed a commit to agoric-labs/cosmos-sdk that referenced this pull request Feb 8, 2024
JimLarson added a commit to agoric-labs/cosmos-sdk that referenced this pull request Feb 10, 2024
@mmsqe mmsqe deleted the log_stderr branch February 28, 2024 02:28
JeancarloBarrios pushed a commit to agoric-labs/cosmos-sdk that referenced this pull request Sep 28, 2024
@faddat faddat mentioned this pull request Nov 8, 2024
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Bug]: prevalent stdout/stderr stream confusion
3 participants