refactor(x/account): Enable AutoCLI for x/accounts #22727

DongLieu · 2024-12-03T08:42:25Z

Description

Closes: #21953

This PR focuses a modification to the protobuf definition of AccountQueryRequest, MsgInit, MsgExecute and related func in the x/accounts module. The primary goal is to shift the responsibility of encoding messages from the client to the module itself, ensuring that the module handles all message transformations internally. And then enable AutoCLI easily.

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, you can find examples of the prefixes below:
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.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

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

New Features
- Introduced JSON-based message representation for account queries and transactions.
- Added new command-line interface options for account management.
Bug Fixes
- Enhanced error handling during account initialization and message processing.
Tests
- Updated test cases to reflect changes in message handling and structure.
Documentation
- Improved clarity on account message formats and command usage.

coderabbitai · 2024-12-03T08:42:32Z

📝 Walkthrough

Walkthrough

The pull request introduces significant modifications to the Cosmos SDK's account management module, primarily focusing on the restructuring of message formats and the implementation of AutoCLI functionality. Key changes include the replacement of protobuf message fields with JSON string representations in various message types, such as AccountQueryRequest, MsgInit, and MsgExecute. Additionally, the CLI implementation has been updated to utilize AutoCLI, while legacy CLI commands have been removed. The changes enhance the flexibility and clarity of message handling and improve integration with JSON-based systems.

Changes

File Path	Change Summary
api/cosmos/accounts/v1/query.pulsar.go	Replaced `request` field with `query_request_type_url` and `json_message` in `AccountQueryRequest`. Updated initialization logic and methods accordingly.
api/cosmos/accounts/v1/tx.pulsar.go	Modified `MsgInit` and `MsgExecute` to replace `message` field with `json_message` and added `execute_msg_type_url` in `MsgExecute`. Updated getter methods and field descriptors.
tests/integration/accounts/multisig/account_test.go	Enhanced test logic in `TestConfigUpdate` to handle new message structure with `ExecuteMsgTypeUrl` and `JsonMessage`.
x/accounts/autocli.go	Introduced `AutoCLIOptions` method for account management commands, defining service command descriptors for queries and transactions.
x/accounts/cli/cli.go	Deleted legacy CLI implementation, removing various command functions related to account management.
x/accounts/cli/cli_test.go	Deleted test suite for the old CLI commands, which included tests for transaction initialization and execution.
x/accounts/defaults/multisig/account_test.go	Added `encodeJSONToProto` function for converting JSON to protobuf and updated test functions for better JSON handling.
x/accounts/genesis_test.go	Updated `TestGenesis` to use JSON string representation for genesis account initialization messages.
x/accounts/internal/implementation/encoding.go	Added `EncodeMsgJSONToProto` function for converting JSON strings to protobuf messages.
x/accounts/keeper.go	Updated `initFromMsg` and `init` methods to enhance error handling and schema construction for account initialization.
x/accounts/module.go	Removed `RegisterQueryHandlers` and `RegisterMsgHandlers` methods, altering how commands are registered in the module.
x/accounts/msg_server.go	Modified `Execute` method to encode messages using JSON instead of unpacking raw messages.
x/accounts/msg_server_test.go	Updated tests to use JSON representations instead of protobuf types for message handling.
x/accounts/proto/cosmos/accounts/v1/query.proto	Updated `AccountQueryRequest` to replace `request` with `query_request_type_url` and `json_message`.
x/accounts/proto/cosmos/accounts/v1/tx.proto	Modified `MsgInit` and `MsgExecute` to replace `message` with `json_message` and `execute_msg_type_url`.
x/accounts/query_server.go	Changed request unpacking in `AccountQuery` method to use JSON encoding.
x/accounts/query_server_test.go	Updated tests to reflect changes in message handling, focusing on JSON strings.
x/accounts/v1/schema.go	Renamed `makeAccountSchema` to `MakeAccountSchema`, changing its visibility to exported.

Assessment against linked issues

Objective	Addressed	Explanation
Enable AutoCLI for x/accounts (#21953)	✅

Possibly related issues

AutoCLI Enhancements #18310: The changes in this PR enhance the AutoCLI functionality, which aligns with the objectives of improving command handling mentioned in this issue.

Possibly related PRs

feat(auth): support accounts from auth #21688: Related to modifications in message structures, specifically AccountQueryRequest and message types.
docs: Module account address documentation #22289: Aligns with documentation improvements for account functionalities, reflecting the new structured message formats.
test: x/accounts systemtests #22320: The new test function TestAccountsMigration relates to changes in account handling and message structures.
refactor(server/v2/cometbft): add codec.Codec and clean-up APIs #22566: Refactoring related to message handling improvements that may connect with the changes in this PR.
fix: TestAccountsMigration systemtest with simdv2 #22673: New methods for registering handlers complement the changes in message processing in this PR.

Suggested labels

C:x/accounts, C:CLI, backport/v0.52.x

Suggested reviewers

sontrinh16
kocubinski
testinginprod
julienrbrt

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>, please review it.
- 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @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.
- @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

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

Actionable comments posted: 12

🧹 Outside diff range and nitpick comments (11)

x/accounts/module.go (2)
99-99: Change GetTxCmd method to explicitly indicate deprecated status

Returning nil from GetTxCmd may cause confusion. Consider adding a comment to indicate that the transaction command is deprecated or intentionally not implemented.

Apply this diff to add a deprecation comment:
 func (AppModule) GetTxCmd() *cobra.Command {
+	// GetTxCmd returns nil as transaction commands are now handled by AutoCLI.
 	return nil
 }
103-103: Change GetQueryCmd method to explicitly indicate deprecated status

Similarly, for GetQueryCmd, consider adding a comment to clarify that query commands are now handled differently.

Apply this diff to add a clarification comment:
 func (AppModule) GetQueryCmd() *cobra.Command {
+	// GetQueryCmd returns nil as query commands are now handled by AutoCLI.
 	return nil
 }
x/accounts/keeper.go (1)

183-183: Ensure proper error handling when encoding JSON to Proto

While calling implementation.EncodeMsgJSONToProto, consider adding a check for the specific type of errors returned, to provide more context or handle certain error conditions differently if necessary.

No code changes are necessary, but consider reviewing the error handling strategy for this function.
api/cosmos/accounts/v1/tx.pulsar.go (1)
Line range hint 75-84: Rename 'JsonMessage' to 'JSONMessage' to follow Go naming conventions

According to the Uber Go Style Guide, initialisms like "JSON" should be capitalized consistently throughout the code. Consider renaming JsonMessage to JSONMessage to improve readability and maintain consistency.

Apply this diff to rename the field descriptors:
-fd_MsgInit_json_message protoreflect.FieldDescriptor
+fd_MsgInit_JSONMessage protoreflect.FieldDescriptor

...

-fd_MsgInit_json_message = md_MsgInit.Fields().ByName("json_message")
+fd_MsgInit_JSONMessage = md_MsgInit.Fields().ByName("json_message")
x/accounts/msg_server_test.go (1)
6-6: Organize imports according to project guidelines

The import statements are not ordered according to the project's conventions. Please sort and group the imports properly.

Apply this diff to organize the imports:
 import (
 	"testing"

+	"cosmossdk.io/x/accounts/accountstd"

 	"github.com/stretchr/testify/require"

 	v1 "cosmossdk.io/x/accounts/v1"
 )
🧰 Tools

🪛 golangci-lint (1.62.2)

6-6: File is not gci-ed with --skip-generated -s standard -s default -s prefix(cosmossdk.io) -s prefix(github.com/cosmos/cosmos-sdk) --custom-order

(gci)
x/accounts/internal/implementation/encoding.go (2)
4-4: Organize imports according to project guidelines

The import statements should be grouped and ordered according to project conventions for better readability.

Apply this diff to organize the imports:
 import (
+	"bytes"
	"fmt"
	"reflect"
	"strings"

+	"github.com/cosmos/gogoproto/jsonpb"

	"github.com/cosmos/gogoproto/proto"

	"cosmossdk.io/core/transaction"

	codectypes "github.com/cosmos/cosmos-sdk/codec/types"
 )
Also applies to: 14-14

71-82: Use protojson instead of jsonpb for JSON unmarshaling

The jsonpb package is deprecated. Consider using protojson from google.golang.org/protobuf/encoding/protojson for better compatibility with new protobuf APIs.

Apply this diff to update the unmarshaling code:
-import (
-	"bytes"
-	"fmt"
-	"reflect"
-	"strings"

-	"github.com/cosmos/gogoproto/jsonpb"

-	"github.com/cosmos/gogoproto/proto"

-	"cosmossdk.io/core/transaction"

-	codectypes "github.com/cosmos/cosmos-sdk/codec/types"
-)
+import (
+	"bytes"
+	"fmt"
+	"reflect"
+	"strings"

+	"google.golang.org/protobuf/encoding/protojson"

+	"github.com/cosmos/gogoproto/proto"

+	"cosmossdk.io/core/transaction"

+	codectypes "github.com/cosmos/cosmos-sdk/codec/types"
+)

 func EncodeMsgJSONToProto(name, jsonMsg string) (proto.Message, error) {
 	typ := proto.MessageType(name)
 	if typ == nil {
 		return nil, fmt.Errorf("message type %s not found", name)
 	}
 	msg := reflect.New(typ.Elem()).Interface().(proto.Message)
-	err := jsonpb.Unmarshal(bytes.NewBufferString(jsonMsg), msg)
+	err := protojson.Unmarshal([]byte(jsonMsg), msg)
 	if err != nil {
 		return nil, fmt.Errorf("failed to unmarshal JSON to proto.Message: %w", err)
 	}
 	return msg, nil
 }
x/accounts/query_server_test.go (2)
8-8: Remove commented-out import

The import statement for emptypb is commented out. It's best to remove unused imports to keep the codebase clean.

Apply this diff to remove the commented-out import:
-	// "google.golang.org/protobuf/types/known/emptypb"
🧰 Tools

🪛 golangci-lint (1.62.2)

8-8: File is not gci-ed with --skip-generated -s standard -s default -s prefix(cosmossdk.io) -s prefix(github.com/cosmos/cosmos-sdk) --custom-order

(gci)

8-8: Organize imports according to project guidelines

The import statements should be sorted according to the project's conventions for consistency and readability.

After removing unnecessary imports, ensure the remaining imports are organized properly.

🧰 Tools

🪛 golangci-lint (1.62.2)

8-8: File is not gci-ed with --skip-generated -s standard -s default -s prefix(cosmossdk.io) -s prefix(github.com/cosmos/cosmos-sdk) --custom-order

(gci)
tests/integration/accounts/multisig/account_test.go (2)
146-151: Consider simplifying the type URL extraction

While the current implementation works, consider using strings.TrimPrefix() for cleaner type URL extraction. Also, consider adding a constant for the type URL prefix to avoid magic strings.
- split := strings.Split(anyUpdateMsg.TypeUrl, "/")
- nameTypeUrl := split[len(split)-1]
+ const typeURLPrefix = "/"
+ nameTypeUrl := strings.TrimPrefix(anyUpdateMsg.TypeUrl, typeURLPrefix)
184-211: Consider extracting message preparation logic into a helper function

There's duplicate code for preparing the MsgExecute. Consider creating a test helper function to reduce duplication and improve maintainability.
func (s *IntegrationTestSuite) prepareExecuteMsg(msg proto.Message, sender, target string) (*accountsv1.MsgExecute, error) {
    anyMsg := codectypes.UnsafePackAny(msg)
    typeURL := strings.TrimPrefix(anyMsg.TypeUrl, "/")
    jsonMsg, err := json.Marshal(msg)
    if err != nil {
        return nil, err
    }
    
    return &accountsv1.MsgExecute{
        Sender:            sender,
        Target:            target,
        ExecuteMsgTypeUrl: typeURL,
        JsonMessage:       string(jsonMsg),
        Funds:             []sdk.Coin{},
    }, nil
}

📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 4d1adcf and 3b3ec1f.

⛔ Files ignored due to path filters (2)

x/accounts/v1/query.pb.go is excluded by !**/*.pb.go
x/accounts/v1/tx.pb.go is excluded by !**/*.pb.go

📒 Files selected for processing (18)

api/cosmos/accounts/v1/query.pulsar.go (16 hunks)
api/cosmos/accounts/v1/tx.pulsar.go (31 hunks)
tests/integration/accounts/multisig/account_test.go (4 hunks)
x/accounts/autocli.go (1 hunks)
x/accounts/cli/cli.go (0 hunks)
x/accounts/cli/cli_test.go (0 hunks)
x/accounts/defaults/multisig/account_test.go (5 hunks)
x/accounts/genesis_test.go (1 hunks)
x/accounts/internal/implementation/encoding.go (3 hunks)
x/accounts/keeper.go (1 hunks)
x/accounts/module.go (1 hunks)
x/accounts/msg_server.go (1 hunks)
x/accounts/msg_server_test.go (2 hunks)
x/accounts/proto/cosmos/accounts/v1/query.proto (1 hunks)
x/accounts/proto/cosmos/accounts/v1/tx.proto (2 hunks)
x/accounts/query_server.go (1 hunks)
x/accounts/query_server_test.go (2 hunks)
x/accounts/v1/schema.go (1 hunks)

💤 Files with no reviewable changes (2)

x/accounts/cli/cli_test.go
x/accounts/cli/cli.go

🧰 Additional context used

📓 Path-based instructions (14)

x/accounts/internal/implementation/encoding.go (1)