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): overwrite client context instead of setting new one #20356

Merged
merged 3 commits into from
May 14, 2024
Merged

feat(client): overwrite client context instead of setting new one #20356

merged 3 commits into from
May 14, 2024

Conversation

islishude
Copy link
Contributor

@islishude islishude commented May 12, 2024

Description

Closes: #XXXX

CreateExecuteContext already sets the client context, we don't need to create a new instance

func CreateExecuteContext(ctx context.Context) context.Context {
	srvCtx := server.NewDefaultContext()
	ctx = context.WithValue(ctx, client.ClientContextKey, &client.Context{})
	ctx = context.WithValue(ctx, server.ServerContextKey, srvCtx)

	return ctx
}

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
    • Improved the efficiency of setting command context in command line operations.
  • Tests
    • Enhanced testing for command context handling, including a new test case for scenarios where no context is provided.

@islishude islishude requested a review from a team as a code owner May 12, 2024 03:49
Copy link
Contributor

coderabbitai bot commented May 12, 2024

Walkthrough

Walkthrough

The recent updates aim to refine the management of command contexts within the software application. Specifically, improvements have been implemented to enhance the efficiency of handling command contexts in the SetCmdClientContext function. The test function, TestSetCmdClientContextHandler, has been expanded with additional test cases and structural improvements to increase reliability and test coverage.

Changes

File(s) Summary of Changes
client/cmd.go Updated SetCmdClientContext to handle command contexts more efficiently by simplifying logic and optimizing context value assignment.
client/cmd_test.go Enriched TestSetCmdClientContextHandler by introducing a new field in the test cases struct, adding test cases for various context scenarios, and optimizing defaultContext creation.

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.

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

@github-actions github-actions bot added the C:CLI label May 12, 2024
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: 0

Review Details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits Files that changed from the base of the PR and between 0c91044 and 0f4d04c.
Files selected for processing (2)
  • client/cmd.go (1 hunks)
  • client/cmd_test.go (2 hunks)
Additional Context Used
Path-based Instructions (2)
client/cmd_test.go (2)

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


Pattern **/*_test.go: "Assess the unit test code assessing sufficient code coverage for the changes associated in the pull request"

client/cmd.go (1)

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

Additional comments not posted (5)
client/cmd_test.go (4)

78-78: Initialization of defaultContext is clear and correctly sets the ClientContextKey. This is a good practice as it ensures that each test starts with a known state.


84-84: Adding the ctx field to the test cases struct is a beneficial change. It allows for more flexible and comprehensive testing by enabling the simulation of different context scenarios.


90-90: Repeatedly setting defaultContext in each test case ensures consistency across tests. This is crucial for isolating tests and avoiding side effects from previous tests.

Also applies to: 98-98, 107-107


110-116: Introducing a test case for a nil context scenario is an excellent addition. It tests the robustness of the command handling code against missing context, which is a common source of runtime errors.

client/cmd.go (1)

362-371: The refactoring of SetCmdClientContext to check if the context already exists and update it if so, rather than always creating a new one, is a significant improvement. This change reduces unnecessary object creation and can lead to performance improvements, especially in command-heavy applications.

@julienrbrt julienrbrt self-assigned this May 12, 2024
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: 0

Review Details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits Files that changed from the base of the PR and between 0f4d04c and 6847787.
Files selected for processing (1)
  • client/cmd_test.go (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • client/cmd_test.go

Copy link
Member

@tac0turtle tac0turtle left a comment

Choose a reason for hiding this comment

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

utACK

@julienrbrt julienrbrt added the backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release label May 14, 2024
@julienrbrt julienrbrt enabled auto-merge May 14, 2024 13:18
}

v := cmd.Context().Value(ClientContextKey)
if clientCtxPtr, ok := v.(*Context); ok {
Copy link
Member

@julienrbrt julienrbrt May 14, 2024

Choose a reason for hiding this comment

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

Looks like a good compromise with what we had in v0.47 (https://github.com/cosmos/cosmos-sdk/blob/release/v0.47.x/client/cmd.go#L350-L360) vs what we have now in v0.50 (https://github.com/cosmos/cosmos-sdk/blob/v0.50.6/client/cmd.go#L361-L371).
Adding the backport label.

@julienrbrt julienrbrt added this pull request to the merge queue May 14, 2024
auto-merge was automatically disabled May 14, 2024 13:28

Head branch was pushed to by a user without write access

Merged via the queue into cosmos:main with commit b2fe0ff May 14, 2024
8 checks passed
mergify bot pushed a commit that referenced this pull request May 14, 2024
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: 0

Out of diff range and nitpick comments (1)
CHANGELOG.md (1)

65-65: Ensure consistency in changelog formatting.

The changelog entry is correctly formatted and consistent with other entries. No issues found.

Review Details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits Files that changed from the base of the PR and between 6847787 and 34f4be9.
Files selected for processing (3)
  • CHANGELOG.md (1 hunks)
  • client/cmd.go (1 hunks)
  • client/cmd_test.go (2 hunks)
Files skipped from review as they are similar to previous changes (2)
  • client/cmd.go
  • client/cmd_test.go
Additional Context Used
Path-based Instructions (1)
CHANGELOG.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

@islishude islishude deleted the feat-client-set-ctx-once branch May 14, 2024 13:38
julienrbrt added a commit that referenced this pull request May 14, 2024
…ckport #20356) (#20383)

Co-authored-by: Shude Li <islishude@gmail.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>
@coderabbitai coderabbitai bot mentioned this pull request Jun 7, 2024
12 tasks
SpicyLemon added a commit to provenance-io/cosmos-sdk that referenced this pull request Jun 10, 2024
* fix(crypto): error if incorrect ledger public key (backport cosmos#19691) (cosmos#19745)

Co-authored-by: Rootul P <rootulp@gmail.com>
Co-authored-by: sontrinh16 <trinhleson2000@gmail.com>

* build(deps): Bump github.com/cometbft/cometbft from 0.38.5 to 0.38.6 (cosmos#19751)

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>

* fix: align signer extraction adapter for mempool remove (backport cosmos#19759) (cosmos#19773)

Co-authored-by: mmsqe <mavis@crypto.com>
Co-authored-by: marbar3778 <marbar3778@yahoo.com>

* fix(x/upgrade): Stop treating inline JSON as a URL (backport cosmos#19706) (cosmos#19767)

Co-authored-by: Richard Gibson <richard.gibson@gmail.com>
Co-authored-by: marbar3778 <marbar3778@yahoo.com>

* fix(client/v2): fix comment parsing (backport cosmos#19377) (cosmos#19777)

Co-authored-by: Julien Robert <julien@rbrt.fr>

* build(deps): Bump github.com/cosmos/iavl from 1.0.1 to 1.1.1 in store (cosmos#19770)

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Cool Developer <cool199966@outlook.com>
Co-authored-by: marbar3778 <marbar3778@yahoo.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>

* chore(store): add release date (cosmos#19797)

* build(deps): Bump github.com/cosmos/gogoproto from 1.4.11 to 1.4.12 (cosmos#19811)

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>

* feat(x/gov): emit proposer address in submit proposal event (backport cosmos#19842) (cosmos#19844)

Co-authored-by: Aryan Tikarya <akaladarshi@gmail.com>
Co-authored-by: marbar3778 <marbar3778@yahoo.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>

* feat(x/gov): emit depositor in `proposal_deposit` event (backport cosmos#19853) (cosmos#19859)

Co-authored-by: Kien <kien@notional.ventures>
Co-authored-by: Julien Robert <julien@rbrt.fr>

* reuse fromAddrString (minor cleanup) (cosmos#19881)

* feat(client): replace `event-query-tx-for` with `wait-tx` (backport cosmos#19870) (cosmos#19887)

* feat(server): add custom start handler (backport cosmos#19854) (cosmos#19884)

Co-authored-by: Julien Robert <julien@rbrt.fr>

* build(deps): Bump cosmossdk.io/store from 1.0.2 to 1.1.0 (cosmos#19810)

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: marbar3778 <marbar3778@yahoo.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>

* docs(x/mint): Fix inconsistency in mint docs  (backport cosmos#19915) (cosmos#19925)

* build(deps): Bump github.com/cosmos/iavl from 1.1.1 to 1.1.2 (cosmos#19985)

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>

* fix(client/v2): add encoder for `cosmos.base.v1beta1.DecCoin` (backport cosmos#19976) (cosmos#20001)

Co-authored-by: Julien Robert <julien@rbrt.fr>

* fix(mempool): use no-op mempool as default (backport cosmos#19970) (cosmos#20008)

Co-authored-by: Tom <54514587+GAtom22@users.noreply.github.com>
Co-authored-by: marbar3778 <marbar3778@yahoo.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>

* feat: Conditionally emit metrics based on enablement (backport cosmos#19903) (cosmos#20017)

Co-authored-by: Lucas Francisco López <lucaslopezf@gmail.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>

* fix(x/bank): align query with multi denoms for send-enabled (backport cosmos#20028) (cosmos#20029)

Co-authored-by: mmsqe <mavis@crypto.com>

* fix: Implement gogoproto customtype to secp256r1 keys (backport cosmos#20027) (cosmos#20031)

Co-authored-by: Facundo Medica <14063057+facundomedica@users.noreply.github.com>

* fix(client/v2): respect output format from client ctx (backport cosmos#20033) (cosmos#20046)

Co-authored-by: mmsqe <mavis@crypto.com>

* build(deps): Bump cosmossdk.io/x/tx from 0.13.1 to 0.13.2 (cosmos#20042)

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>

* feat(x/bank): support depinject for send restrictions (backport cosmos#20014) (cosmos#20024)

* fix(baseapp): don't share global gas meter in tx execution (backport cosmos#19616) (cosmos#20050)

* fix: secp256r1 json missing quotes (backport cosmos#20060) (cosmos#20069)

Co-authored-by: Facundo Medica <14063057+facundomedica@users.noreply.github.com>

* build(deps): Bump github.com/cosmos/cosmos-proto from 1.0.0-beta.4 to 1.0.0-beta.5 (cosmos#20095)

* feat(client/v2): implement version filtering using annotation (backport cosmos#20083) (cosmos#20099)

Co-authored-by: Julien Robert <julien@rbrt.fr>

* chore: prepare v0.50.6 (cosmos#19998)

* fix: use timestamp for sim log file name (backport cosmos#20108) (cosmos#20111)

Co-authored-by: mmsqe <mavis@crypto.com>

* fix(x/authz,x/feegrant): check blocked address (cosmos#20102)

* chore: update v0.50.6 release notes (cosmos#20124)

* build(deps): bump sdk in modules (cosmos#20126)

* docs(gas/fees): Update block gas documentation (backport cosmos#20128) (cosmos#20131)

Co-authored-by: samricotta <37125168+samricotta@users.noreply.github.com>

* fix(baseapp): avoid header height overwrite block height (backport cosmos#20107) (cosmos#20129)

Co-authored-by: mmsqe <mavis@crypto.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>

* docs: fix broken link (backport cosmos#20133) (cosmos#20138)

* build(deps): bump modules in simapp (cosmos#20137)

* build(deps): Bump cosmossdk.io/x/tx from 0.13.2 to 0.13.3 (cosmos#20152)

* docs: add authz reference info in the circuit antehandler (backport cosmos#20146) (cosmos#20155)

Co-authored-by: Reece Williams <31943163+Reecepbcups@users.noreply.github.com>

* fix(testsuite/sims): set all signatures (backport cosmos#20151) (cosmos#20185)

Co-authored-by: Leon <156270887+leonz789@users.noreply.github.com>

* build(deps): Bump github.com/cometbft/cometbft from 0.38.6 to 0.38.7 (cosmos#20206)

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>

* fix(server): bootstrap-state command can't parse latest genesis format (backport cosmos#20020) (cosmos#20045)

Co-authored-by: yihuang <huang@crypto.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>
Co-authored-by: sontrinh16 <trinhleson2000@gmail.com>
Co-authored-by: marbar3778 <marbar3778@yahoo.com>

* fix: remove txs from mempool when antehandler fails in recheck (backport cosmos#20144) (cosmos#20251)

Co-authored-by: Marko <marko@baricevic.me>

* feat(baseapp): expose grpc query router via depinject. (cosmos#20264)

* feat(client/v2): override short description in generated command (backport cosmos#20266) (cosmos#20269)

Co-authored-by: John Letey <j@letey.de>
Co-authored-by: Julien Robert <julien@rbrt.fr>

* feat(runtime): Add missing NewTransientStoreService (backport cosmos#20261) (cosmos#20327)

Co-authored-by: beer-1 <147697694+beer-1@users.noreply.github.com>

* fix: allow tx decoding to fail in GetBlockWithTxs (backport cosmos#20323) (cosmos#20329)

Co-authored-by: Facundo Medica <14063057+facundomedica@users.noreply.github.com>
Co-authored-by: marbar3778 <marbar3778@yahoo.com>

* fix(client/v2): correctly check subcommand short descriptions (backport cosmos#20330) (cosmos#20340)

* build(deps): Bump cosmossdk.io/api from 0.7.4 to 0.7.5 (cosmos#20338)

* style: Fix gov query proposals examples syntax (backport cosmos#20353) (cosmos#20357)

* feat(client): add consensus address for debug cmd (backport cosmos#20328) (cosmos#20366)

Co-authored-by: mmsqe <mavis@crypto.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>

* feat(client): overwrite client context instead of setting new one (backport cosmos#20356) (cosmos#20383)

Co-authored-by: Shude Li <islishude@gmail.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>

* fix: correctly assign `execModeSimulate` to context for `simulateTx` (backport cosmos#20342) (cosmos#20346)

Co-authored-by: Damian Nolan <damiannolan@gmail.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>
Co-authored-by: marbar3778 <marbar3778@yahoo.com>

* docs: update diagram to be shown properly (backport cosmos#20454) (cosmos#20460)

Co-authored-by: tianyeyouyou <150894831+tianyeyouyou@users.noreply.github.com>
Co-authored-by: marbar3778 <marbar3778@yahoo.com>

* docs: fix note blocks display failure (backport cosmos#20457) (cosmos#20459)

Co-authored-by: cocoyeal <150209682+cocoyeal@users.noreply.github.com>

* docs: update link contents (backport cosmos#20437) (cosmos#20462)

Co-authored-by: PolyMa <151764357+polymaer@users.noreply.github.com>

* fix(x/consensus): harden consensus params proposal (cosmos#20381)

Co-authored-by: Sergio Mena <sergio@informal.systems>
Co-authored-by: sontrinh16 <trinhleson2000@gmail.com>

* docs: add docs on permissions (backport cosmos#20526) (cosmos#20527)

Co-authored-by: Marko <marko@baricevic.me>

* chore(x/upgrade): bump vulnerable `go-getter` library (cosmos#20530)

* chore: prepare v0.50.7 (cosmos#20475)

* Add changelog entry and mark v0.50.7-pio-1 in the changelog.

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Co-authored-by: Rootul P <rootulp@gmail.com>
Co-authored-by: sontrinh16 <trinhleson2000@gmail.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: mmsqe <mavis@crypto.com>
Co-authored-by: marbar3778 <marbar3778@yahoo.com>
Co-authored-by: Richard Gibson <richard.gibson@gmail.com>
Co-authored-by: Julien Robert <julien@rbrt.fr>
Co-authored-by: Cool Developer <cool199966@outlook.com>
Co-authored-by: Aryan Tikarya <akaladarshi@gmail.com>
Co-authored-by: Kien <kien@notional.ventures>
Co-authored-by: yihuang <huang@crypto.com>
Co-authored-by: Tom <54514587+GAtom22@users.noreply.github.com>
Co-authored-by: Lucas Francisco López <lucaslopezf@gmail.com>
Co-authored-by: Facundo Medica <14063057+facundomedica@users.noreply.github.com>
Co-authored-by: samricotta <37125168+samricotta@users.noreply.github.com>
Co-authored-by: Reece Williams <31943163+Reecepbcups@users.noreply.github.com>
Co-authored-by: Leon <156270887+leonz789@users.noreply.github.com>
Co-authored-by: Marko <marko@baricevic.me>
Co-authored-by: John Letey <j@letey.de>
Co-authored-by: beer-1 <147697694+beer-1@users.noreply.github.com>
Co-authored-by: Shude Li <islishude@gmail.com>
Co-authored-by: Damian Nolan <damiannolan@gmail.com>
Co-authored-by: tianyeyouyou <150894831+tianyeyouyou@users.noreply.github.com>
Co-authored-by: cocoyeal <150209682+cocoyeal@users.noreply.github.com>
Co-authored-by: PolyMa <151764357+polymaer@users.noreply.github.com>
Co-authored-by: Sergio Mena <sergio@informal.systems>
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 C:CLI
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants