refactor(client): check name validation for `keys add|import|rename` by levisyin · Pull Request #18950 · cosmos/cosmos-sdk

levisyin · 2024-01-05T03:18:53Z

Motivation

When I set the $name variable by mistake, and after running keys add $name command, it created a key with the empty name.

This looks odd when I ran keys list to check the created key, see the screenshot below. I'm confused about the name, is it empty or just the "" itself.

Also, an unnormal name isn't friendly to keys delete, keys show, and keys export subcommand.

So I think we should prevent from creating a key with an unnormal name

coderabbitai · 2024-01-05T03:19:01Z

Walkthrough

The recent changes involve enhancing the validation of user input for key management operations within a CLI application. Specifically, the updates ensure that the "name" variable for keys is not empty after any leading or trailing whitespace is removed. This validation has been added to the addition and import commands, and error handling has been implemented for renaming keys, particularly for private keys stored on a ledger device. The associated tests have been updated to cover these new validation scenarios.

Changes

Files	Change Summary
`client/keys/add.go`, `client/keys/import.go`	Added `strings` import and validation for trimmed "name" variable.
`client/keys/add_test.go`, `client/keys/import_test.go`	Updated and added tests for empty name validation in key addition and import commands.
`client/keys/rename.go`, `client/keys/rename_test.go`	Implemented error handling for empty new names in key renaming and updated tests to check for proper handling of empty new names.

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:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your comments unless it is explicitly tagged.

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.

levisyin · 2024-01-06T02:16:00Z

@julienrbrt Hi sir, suggestion changes addressed

julienrbrt · 2024-01-06T02:18:58Z

@julienrbrt Hi sir, suggestion changes addressed

Awesome, can we get a changelog?

levisyin · 2024-01-06T02:23:15Z

@julienrbrt Hi sir, suggestion changes addressed

Awesome, can we get a changelog?

Done 😀

julienrbrt

lgtm, ty!

likhita-809

utACK

…osmos#18950)

aljo242 · 2025-03-26T21:09:06Z

@Mergifyio backport release/v0.53.x

mergify · 2025-03-26T21:09:11Z

backport release/v0.53.x

✅ Backports have been created

Details

#24152 refactor(client): check name validation for keys add|import|rename (backport #18950) has been created for branch release/v0.53.x but encountered conflicts

…18950) (cherry picked from commit c307001) # Conflicts: # CHANGELOG.md # client/keys/import.go

…(backport #18950) (#24152) Co-authored-by: levisyin <150114626+levisyin@users.noreply.github.com> Co-authored-by: aljo242 <alex@interchainlabs.io>

refactor: check name validation for keys add|import|rename

d68e6fd

levisyin requested a review from a team January 5, 2024 03:18

levisyin changed the title ~~refactor: check name validation for keys add|import|rename~~ refactor(client/keys): check name validation for keys add|import|rename Jan 5, 2024

github-actions Bot added C:CLI C:Keys Keybase, KMS and HSMs labels Jan 5, 2024

Merge branch 'main' into refactor/check-name-valid

eaafd2c

coderabbitai Bot changed the title ~~refactor(client/keys): check name validation for keys add|import|rename~~ refactor: check name validation for keys add|import|rename Jan 5, 2024

coderabbitai Bot reviewed Jan 5, 2024

View reviewed changes

Comment thread client/keys/add.go

Comment thread client/keys/rename.go Outdated

Comment thread client/keys/import.go Outdated

fix: make ci lint happy

e894b67

julienrbrt changed the title ~~refactor: check name validation for keys add|import|rename~~ refactor(client): check name validation for keys add|import|rename Jan 5, 2024

julienrbrt reviewed Jan 5, 2024

View reviewed changes

Comment thread client/keys/add.go Outdated

levisyin and others added 2 commits January 6, 2024 10:14

address suggestion code

2dcff35

Merge branch 'main' into refactor/check-name-valid

ad56294

add changelog

043e728

julienrbrt approved these changes Jan 6, 2024

View reviewed changes

levisyin added 2 commits January 7, 2024 19:58

Merge branch 'main' into refactor/check-name-valid

40c4850

Merge branch 'main' into refactor/check-name-valid

4e8b7ba

likhita-809 approved these changes Jan 8, 2024

View reviewed changes

julienrbrt added this pull request to the merge queue Jan 8, 2024

Merged via the queue into cosmos:main with commit c307001 Jan 8, 2024

levisyin deleted the refactor/check-name-valid branch January 8, 2024 12:51

relyt29 pushed a commit to relyt29/cosmos-sdk that referenced this pull request Jan 22, 2024

refactor(client): check name validation for keys add|import|rename (c…

3b5ad69

…osmos#18950)

coderabbitai Bot mentioned this pull request Feb 16, 2024

feat(server): Allow calling back into the application struct in PostSetup. #19455

Merged

12 tasks

aljo242 mentioned this pull request Feb 25, 2025

Keys issues eval #23790

Closed

mergify Bot pushed a commit that referenced this pull request Mar 26, 2025

refactor(client): check name validation for keys add|import|rename (#…

2d52d87

…18950) (cherry picked from commit c307001) # Conflicts: # CHANGELOG.md # client/keys/import.go

mergify Bot mentioned this pull request Mar 26, 2025

refactor(client): check name validation for keys add|import|rename (backport #18950) #24152

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(client): check name validation for `keys add|import|rename`#18950

refactor(client): check name validation for `keys add|import|rename`#18950
julienrbrt merged 8 commits into
cosmos:mainfrom
levisyin:refactor/check-name-valid

levisyin commented Jan 5, 2024

Uh oh!

coderabbitai Bot commented Jan 5, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

CodeRabbit Discord Community

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

levisyin commented Jan 6, 2024

Uh oh!

julienrbrt commented Jan 6, 2024

Uh oh!

levisyin commented Jan 6, 2024

Uh oh!

julienrbrt left a comment

Uh oh!

likhita-809 left a comment

Uh oh!

aljo242 commented Mar 26, 2025

Uh oh!

mergify Bot commented Mar 26, 2025 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

levisyin commented Jan 5, 2024

Motivation

Uh oh!

coderabbitai Bot commented Jan 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

CodeRabbit Discord Community

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

levisyin commented Jan 6, 2024

Uh oh!

julienrbrt commented Jan 6, 2024

Uh oh!

levisyin commented Jan 6, 2024

Uh oh!

julienrbrt left a comment

Choose a reason for hiding this comment

Uh oh!

likhita-809 left a comment

Choose a reason for hiding this comment

Uh oh!

aljo242 commented Mar 26, 2025

Uh oh!

mergify Bot commented Mar 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Backports have been created

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

coderabbitai Bot commented Jan 5, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

mergify Bot commented Mar 26, 2025 •

edited

Loading