cosmos-sdk icon indicating copy to clipboard operation
cosmos-sdk copied to clipboard

refactor!: turn MsgsV2 into ReflectMessages to make it less confusing

Open aaronc opened this issue 1 year ago • 3 comments

Description

This is an alternative to #19817 that rather than just removing stuff, names things more clearly removing any mention of V2 and instead distinguishing a "reflected" version of the message from the actual version.

For instance, it's probably confusing when there is GetMsgs and GetMsgsV2 - which one am I supposed to use? Naively, you'd think v2 is better, but that's not really right.

Now, GetMsgsV2 is GetReflectMessages which returns protoreflect.Message not protov2.Message and the documentation clearly states that GetMsgs returns the actual messages and GetReflectMessages is just for performing some dynamic read operations (like get signers) on those messages. Hopefully this is clearer and obviates the need to do some of the less efficient stuff in #19817.


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 message handling by replacing proto with protoreflect across components for improved compatibility and performance.
  • Bug Fixes

    • Ensured consistent method signatures and function calls for reliable message processing.
  • Documentation

    • Updated CHANGELOG.md to reflect recent method replacements and usage clarifications.
  • Tests

    • Aligned and updated test functions to match new method implementations and message handling protocols.

aaronc avatar Mar 22 '24 19:03 aaronc

Walkthrough

Walkthrough

The changes aim to standardize message signer retrieval methods to GetMsgSigners and GetReflectMsgSigners, updating function signatures and imports for compatibility with protoreflect.Message. These modifications enhance message handling efficiency and support protobuf reflection across various packages.

Changes

File Path Change Summary
x/accounts/keeper.go Added imports for gogoproto and protoreflect; introduced new interfaces and modified method signatures in the Keeper struct.
x/authz/keeper/keeper.go Replaced GetMsgV1Signers with GetMsgSigners in DispatchActions.
x/gov/keeper/proposal.go Updated SubmitProposal to use GetMsgSigners instead of GetMsgV1Signers.
x/group/keeper/proposal_executor.go Changed method call to use GetMsgSigners in ensureMsgAuthZ within doExecuteMsgs.
CHANGELOG.md Noted changes from Tx.GetMsgsV2 to Tx.GetReflectMessages, and GetMsgV1Signers to GetMsgSigners.
baseapp/baseapp.go Adjusted imports and function signatures to use protoreflect.Message instead of protov2.Message.
codec/proto_codec_test.go Replaced GetMsgV1Signers and GetMsgV2Signers with unified methods for message signers.
types/tx_msg.go Replaced GetMsgsV2 with GetReflectMessages in Tx interface, returning []protoreflect.Message.
x/accounts/defaults/multisig/utils_test.go Updated return type and method names in utils_test.go.
x/accounts/utils_test.go Introduced mockSigner type with GetMsgSigners method; removed Balance method in bankQueryServer.

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.

coderabbitai[bot] avatar Mar 22 '24 19:03 coderabbitai[bot]

Can you fix conflict + linting?

julienrbrt avatar Apr 15 '24 09:04 julienrbrt

Looks like @tac0turtle took care of linting and I'm seeing an unrelated test failure for x/accounts, but maybe that's fixed on main. Is this ready to merge?

aaronc avatar Apr 18 '24 17:04 aaronc

I'll pick this up tomorrow.

tac0turtle avatar May 15 '24 21:05 tac0turtle

Vini? Sorry I noticed there's a lint error just haven't gotten a chance to fix yet

aaronc avatar May 15 '24 22:05 aaronc

Vini? Sorry I noticed there's a lint error just haven't gotten a chance to fix yet

Sorry wasn't meant for here. The lint error has been annoying.

tac0turtle avatar May 16 '24 04:05 tac0turtle