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: list keys output for empty keys #15876

Merged
merged 3 commits into from
Apr 19, 2023
Merged

Conversation

mvid
Copy link
Contributor

@mvid mvid commented Apr 18, 2023

Make sure that the expected output format is honored. this println is breaking scripts that expect json output when requesting json output

Description

A recent change caused listing of an empty key set to always print a response string to stdout. This means you can't structure scripts around the keys list query, as requesting json won't return json. This breaks existing code.


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
  • added ! to 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
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • 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 ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

… breaking scripts that expect json output when requesting json output
@mvid mvid requested a review from a team as a code owner April 18, 2023 21:58
@github-actions github-actions bot added C:CLI C:Keys Keybase, KMS and HSMs labels Apr 18, 2023
Copy link
Contributor

@alexanderbez alexanderbez left a comment

Choose a reason for hiding this comment

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

utACK

client/keys/list.go Outdated Show resolved Hide resolved
Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

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

tACK.

Do you think it is worth fixing L47 as well to return a JSON with only the names?
Using the -n flag does not return a JSON (simd keys list -n --output json)

@julienrbrt julienrbrt added the backport/v0.47.x PR scheduled for inclusion in the v0.47's next stable release label Apr 19, 2023
@julienrbrt
Copy link
Member

I am going to merge this now. I let you open a follow-up PR if you think -n argument should return json as well.

@julienrbrt julienrbrt added this pull request to the merge queue Apr 19, 2023
Merged via the queue into cosmos:main with commit 5948b38 Apr 19, 2023
mergify bot pushed a commit that referenced this pull request Apr 19, 2023
(cherry picked from commit 5948b38)

# Conflicts:
#	CHANGELOG.md
@@ -187,6 +187,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
* (x/capability) [#15030](https://github.com/cosmos/cosmos-sdk/pull/15030) Prevent `x/capability` from consuming `GasMeter` gas during `InitMemStore`
* (types/coin) [#14739](https://github.com/cosmos/cosmos-sdk/pull/14739) Deprecate the method `Coin.IsEqual` in favour of `Coin.Equal`. The difference between the two methods is that the first one results in a panic when denoms are not equal. This panic lead to unexpected behavior
* (x/crypto) [#15258](https://github.com/cosmos/cosmos-sdk/pull/15258) Write keyhash file with permissions 0600 instead of 0555.
* (client/keys) [15867](https://github.com/cosmos/cosmos-sdk/pull/15876) Fix the output of the client keys query when there are no keys
Copy link
Member

Choose a reason for hiding this comment

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

Updated the changelog wording here.
It is not significant on main, as this line will get deleted when we release v0.47.2.

julienrbrt added a commit that referenced this pull request Apr 19, 2023
Co-authored-by: Mantas Vidutis <mantas.a.vidutis@gmail.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>
roy-dydx pushed a commit to dydxprotocol/cosmos-sdk that referenced this pull request Jul 11, 2023
…15894)

Co-authored-by: Mantas Vidutis <mantas.a.vidutis@gmail.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.47.x PR scheduled for inclusion in the v0.47's next stable release C:CLI C:Keys Keybase, KMS and HSMs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants