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

feat(client): Add cobra's context to clientCtx #15458

Merged
merged 4 commits into from
Mar 20, 2023
Merged

Conversation

amaury1093
Copy link
Contributor

@amaury1093 amaury1093 commented Mar 20, 2023

Description

With Textual #13646, we pass a context.Context argument to a lot of signing functions. In a previous PR, #13747, we set this argument to context.TODO(), waiting for other pieces of Textual to be finished.

Now that Textual's implementation is finished, we should replace these instances of context.TODO(). There are 2 proposals:

  1. replace with context.Background(): easy, harmless, works with Textual... but feels incorrect, since we're creating a new context.Context on each sign.
  2. replace with cobra command's context.Context: more correct, needs some plumbing to pass it around to all functions.

This PR implements 2.


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)

@amaury1093 amaury1093 mentioned this pull request Mar 20, 2023
39 tasks
@amaury1093 amaury1093 marked this pull request as ready for review March 20, 2023 08:38
@amaury1093 amaury1093 requested a review from a team as a code owner March 20, 2023 08:38
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.

lgtm!

@facundomedica facundomedica enabled auto-merge (squash) March 20, 2023 13:53
@facundomedica facundomedica merged commit a4a3c81 into main Mar 20, 2023
@facundomedica facundomedica deleted the am/clientctx-context branch March 20, 2023 14:15
@@ -61,6 +62,16 @@ type Context struct {

// TODO: Deprecated (remove).
LegacyAmino *codec.LegacyAmino

// CmdContext is the context.Context from the Cobra command.
CmdContext context.Context
Copy link
Member

Choose a reason for hiding this comment

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

nit: rename to Context, or is there a reason it called cmdContext?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The struct is already called Context. I thought being explicit here was useful to know what we're talking about. Can rename to simply Context if other people also feel the same.

larry0x pushed a commit to larry0x/cosmos-sdk that referenced this pull request May 22, 2023
Co-authored-by: Facundo Medica <14063057+facundomedica@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants