fix(client/v2): improve message parsing by replacing proto.Merge with cloneMessage (backport cosmos#24722) (cosmos#24818)

Co-authored-by: julienrbrt <[email protected]>
Co-authored-by: Alex | Interchain Labs <[email protected]>
Co-authored-by: Aaron <[email protected]>

Author: 4 people

client/v2/CHANGELOG.md

@@ -34,6 +34,12 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 # Changelog
 
+## [v2.0.0-beta.11](https://github.com/cosmos/cosmos-sdk/tree/client/v2.0.0-beta.11) - 2025-05-30
+
+### Bug Fixes
+
+* [#24722](https://github.com/cosmos/cosmos-sdk/pull/24722) Fix msg parsing in when no pulsar file is present.
+
 ## [v2.0.0-beta.9](https://github.com/cosmos/cosmos-sdk/tree/client/v2.0.0-beta.9) - 2025-04-24
 
 ### Features
@@ -42,7 +48,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 ### Improvements
 
-* [#22890](https://github.com/cosmos/cosmos-sdk/pull/22890)  Added support for flattening inner message fields in autocli as positional arguments.
+* [#22890](https://github.com/cosmos/cosmos-sdk/pull/22890) Added support for flattening inner message fields in autocli as positional arguments.
 
 ### Bug Fixes
 

client/v2/Makefile

@@ -1,2 +1,6 @@
 codegen:
-	@(cd internal; buf generate)
+	@(cd internal; buf generate --template testpbpulsar/buf.gen.yaml)
+	@(cd internal; buf generate --template testpbgogo/buf.gen.yaml)
+	@(cd internal/testpbgogo; rm *_grpc.pb.go; rm *.pulsar.go)
+	@(cd internal; mv github.com/cosmos/cosmos-sdk/client/v2/internal/testpbgogo/* testpbgogo)
+	@(cd internal; rm -r github.com)

client/v2/autocli/common_test.go

@@ -6,6 +6,7 @@ import (
 	"net"
 	"testing"
 
+	"github.com/cosmos/gogoproto/proto"
 	"github.com/spf13/cobra"
 	"google.golang.org/grpc"
 	"google.golang.org/grpc/credentials/insecure"
@@ -15,14 +16,16 @@ import (
 	autocliv1 "cosmossdk.io/api/cosmos/autocli/v1"
 	reflectionv2alpha1 "cosmossdk.io/api/cosmos/base/reflection/v2alpha1"
 	"cosmossdk.io/client/v2/autocli/flag"
-	"cosmossdk.io/client/v2/internal/testpb"
+	"cosmossdk.io/client/v2/internal/testpbgogo"
+	testpb "cosmossdk.io/client/v2/internal/testpbpulsar"
 
 	"github.com/cosmos/cosmos-sdk/client"
 	"github.com/cosmos/cosmos-sdk/client/flags"
 	addresscodec "github.com/cosmos/cosmos-sdk/codec/address"
 	sdkkeyring "github.com/cosmos/cosmos-sdk/crypto/keyring"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	moduletestutil "github.com/cosmos/cosmos-sdk/types/module/testutil"
+	"github.com/cosmos/cosmos-sdk/types/msgservice"
 	"github.com/cosmos/cosmos-sdk/x/bank"
 	banktypes "github.com/cosmos/cosmos-sdk/x/bank/types"
 )
@@ -57,6 +60,7 @@ func initFixture(t *testing.T) *fixture {
 
 	interfaceRegistry := encodingConfig.Codec.InterfaceRegistry()
 	banktypes.RegisterInterfaces(interfaceRegistry)
+	msgservice.RegisterMsgServiceDesc(interfaceRegistry, &testpbgogo.MsgGogoOnly_serviceDesc)
 
 	clientCtx := client.Context{}.
 		WithKeyring(kr).
@@ -69,10 +73,15 @@ func initFixture(t *testing.T) *fixture {
 		WithChainID("autocli-test")
 
 	conn := &testClientConn{ClientConn: clientConn}
+
+	// using merged registry to get pulsar + gogo files
+	mergedFiles, err := proto.MergedRegistry()
+	assert.NilError(t, err)
+
 	b := &Builder{
 		Builder: flag.Builder{
 			TypeResolver:          protoregistry.GlobalTypes,
-			FileResolver:          protoregistry.GlobalFiles,
+			FileResolver:          mergedFiles,
 			AddressCodec:          addresscodec.NewBech32Codec("cosmos"),
 			ValidatorAddressCodec: addresscodec.NewBech32Codec("cosmosvaloper"),
 			ConsensusAddressCodec: addresscodec.NewBech32Codec("cosmosvalcons"),

client/v2/autocli/msg.go

@@ -161,7 +161,9 @@ func (b *Builder) BuildMsgMethodCommand(descriptor protoreflect.MethodDescriptor
 		// Here we use dynamicpb, to create a proto v1 compatible message.
 		// The SDK codec will handle protov2 -> protov1 (marshal)
 		msg := dynamicpb.NewMessage(input.Descriptor())
-		proto.Merge(msg, input.Interface())
+		if err := cloneMessage(msg, input); err != nil {
+			return fmt.Errorf("failed to clone message: %w", err)
+		}
 
 		return clienttx.GenerateOrBroadcastTxCLI(clientCtx, cmd.Flags(), msg)
 	}
@@ -217,11 +219,23 @@ func (b *Builder) handleGovProposal(
 	// Here we use dynamicpb, to create a proto v1 compatible message.
 	// The SDK codec will handle protov2 -> protov1 (marshal)
 	msg := dynamicpb.NewMessage(input.Descriptor())
-	proto.Merge(msg, input.Interface())
+	if err := cloneMessage(msg, input); err != nil {
+		return fmt.Errorf("failed to clone message: %w", err)
+	}
 
 	if err := proposal.SetMsgs([]gogoproto.Message{msg}); err != nil {
 		return fmt.Errorf("failed to set msg in proposal %w", err)
 	}
 
 	return clienttx.GenerateOrBroadcastTxCLI(clientCtx, cmd.Flags(), proposal)
 }
+
+// cloneMessage safely copies fields from src message to dst message.
+// this avoids the proto.Merge issue with field descriptors from different repositories.
+func cloneMessage(dst, src protoreflect.Message) error {
+	bz, err := proto.Marshal(src.Interface())
+	if err != nil {
+		return err
+	}
+	return proto.Unmarshal(bz, dst.Interface())
+}

client/v2/autocli/msg_test.go

@@ -15,7 +15,8 @@ import (
 
 	autocliv1 "cosmossdk.io/api/cosmos/autocli/v1"
 	bankv1beta1 "cosmossdk.io/api/cosmos/bank/v1beta1"
-	"cosmossdk.io/client/v2/internal/testpb"
+	"cosmossdk.io/client/v2/internal/testpbgogo"
+	testpb "cosmossdk.io/client/v2/internal/testpbpulsar"
 
 	"github.com/cosmos/cosmos-sdk/client"
 )
@@ -124,6 +125,31 @@ func TestMsg(t *testing.T) {
 	assertNormalizedJSONEqual(t, out.Bytes(), goldenLoad(t, "msg-output.golden"))
 }
 
+// TestMsgGogo set same as previous, but the message are only gogoproto generated.
+// There are no protov2 files registered in the global registry for those types.
+func TestMsgGogo(t *testing.T) {
+	fixture := initFixture(t)
+	out, err := runCmd(fixture, buildCustomModuleMsgCommand(&autocliv1.ServiceCommandDescriptor{
+		Service: testpbgogo.MsgGogoOnly_serviceDesc.ServiceName, // using gogoproto only test msg
+		RpcCommandOptions: []*autocliv1.RpcCommandOptions{
+			{
+				RpcMethod:      "Send",
+				Use:            "send [a_coin] [str] [flags]",
+				Short:          "Send coins from one account to another",
+				PositionalArgs: []*autocliv1.PositionalArgDescriptor{{ProtoField: "a_coin"}, {ProtoField: "str"}},
+				// an_address should be automatically added
+			},
+		},
+	}), "send",
+		"1foo", "henlo",
+		"--from", "cosmos1y74p8wyy4enfhfn342njve6cjmj5c8dtl6emdk",
+		"--generate-only",
+		"--output", "json",
+	)
+	assert.NilError(t, err)
+	golden.Assert(t, out.String(), "msg-gogo-output.golden")
+}
+
 func TestMsgWithFlattenFields(t *testing.T) {
 	fixture := initFixture(t)
 

client/v2/autocli/query_test.go

@@ -18,7 +18,7 @@ import (
 	autocliv1 "cosmossdk.io/api/cosmos/autocli/v1"
 	queryv1beta1 "cosmossdk.io/api/cosmos/base/query/v1beta1"
 	basev1beta1 "cosmossdk.io/api/cosmos/base/v1beta1"
-	"cosmossdk.io/client/v2/internal/testpb"
+	testpb "cosmossdk.io/client/v2/internal/testpbpulsar"
 
 	"github.com/cosmos/cosmos-sdk/client"
 )

client/v2/autocli/testdata/help-deprecated.golden

@@ -8,7 +8,7 @@ Flags:
       --a-bool                                                               
       --a-coin cosmos.base.v1beta1.Coin                                      
       --a-consensus-address account address or key name                      
-      --a-message testpb.AMessage (json)                                     
+      --a-message testpbpulsar.AMessage (json)                               
       --a-validator-address account address or key name                      
       --an-address account address or key name                               
       --an-enum Enum (unspecified | one | two | five | neg-three)             (default unspecified)
@@ -41,7 +41,7 @@ Flags:
       --positional2 string                                                   
       --positional3-varargs cosmos.base.v1beta1.Coin (repeated)              
       --shorthand-deprecated-field string                                    
-      --some-messages testpb.AMessage (json) (repeated)                      
+      --some-messages testpbpulsar.AMessage (json) (repeated)                
       --str string                                                           
       --strings strings                                                      
       --timestamp timestamp (RFC 3339)                                       

client/v2/autocli/testdata/help-echo.golden

@@ -13,7 +13,7 @@ Flags:
       --a-bool                                                               
       --a-coin cosmos.base.v1beta1.Coin                                      some random coin
       --a-consensus-address account address or key name                      
-      --a-message testpb.AMessage (json)                                     
+      --a-message testpbpulsar.AMessage (json)                               
       --a-validator-address account address or key name                      
       --an-address account address or key name                               
       --an-enum Enum (unspecified | one | two | five | neg-three)             (default unspecified)
@@ -42,7 +42,7 @@ Flags:
       --page-offset uint                                                     
       --page-reverse                                                         
   -s, --shorthand-deprecated-field string                                     (DEPRECATED: bad idea)
-      --some-messages testpb.AMessage (json) (repeated)                      
+      --some-messages testpbpulsar.AMessage (json) (repeated)                
       --str string                                                           
       --strings strings                                                      
       --timestamp timestamp (RFC 3339)                                       

client/v2/autocli/testdata/help-skip.golden

@@ -1,4 +1,4 @@
-Querying commands for the testpb.Query service
+Querying commands for the testpbpulsar.Query service
 
 Usage:
   test skipecho [flags]

client/v2/autocli/testdata/help-toplevel.golden

@@ -6,10 +6,10 @@ Usage:
 
 Available Commands:
   completion     Generate the autocompletion script for the specified shell
-  deprecatedecho Querying commands for the testpb.Query service
+  deprecatedecho Querying commands for the testpbpulsar.Query service
   echo           echo echos the value provided by the user
   help           Help about any command
-  skipecho       Querying commands for the testpb.Query service
+  skipecho       Querying commands for the testpbpulsar.Query service
 
 Flags:
   -h, --help   help for test

client/v2/autocli/testdata/msg-gogo-output.golden

@@ -0,0 +1 @@
+{"body":{"messages":[{"@type":"/testpbgogo.MsgRequestGogoOnly","str":"henlo","a_coin":{"denom":"foo","amount":"1"},"an_address":"cosmos1y74p8wyy4enfhfn342njve6cjmj5c8dtl6emdk","a_validator_address":""}],"memo":"","timeout_height":"0","unordered":false,"timeout_timestamp":null,"extension_options":[],"non_critical_extension_options":[]},"auth_info":{"signer_infos":[],"fee":{"amount":[],"gas_limit":"200000","payer":"","granter":""},"tip":null},"signatures":[]}

client/v2/internal/buf.lock

@@ -9,8 +9,8 @@ deps:
   - remote: buf.build
     owner: cosmos
     repository: cosmos-sdk
-    commit: 05419252bcc241ea8023acf1ed4cadc5
-    digest: shake256:1e54a48c19a8b59d35e0a7efa76402939f515f2d8005df099856f24c37c20a52800308f025abb8cffcd014d437b49707388aaca4865d9d063d8f25d5d4eb77d5
+    commit: 34ac2e8322d44db08830e553ad21b93c
+    digest: shake256:b0dd0de5ef770147002e290a9e9f8de8cc8727cbf932628892fbb9027d5ebec5c2a63c0e340e4ef7af72369ecdf51221dcc385ce2137afaa72532228f6999d74
   - remote: buf.build
     owner: cosmos
     repository: gogo-proto
@@ -19,15 +19,10 @@ deps:
   - remote: buf.build
     owner: googleapis
     repository: googleapis
-    commit: 7e6f6e774e29406da95bd61cdcdbc8bc
-    digest: shake256:fe43dd2265ea0c07d76bd925eeba612667cf4c948d2ce53d6e367e1b4b3cb5fa69a51e6acb1a6a50d32f894f054a35e6c0406f6808a483f2752e10c866ffbf73
+    commit: 751cbe31638d43a9bfb6162cd2352e67
+    digest: shake256:87f55470d9d124e2d1dedfe0231221f4ed7efbc55bc5268917c678e2d9b9c41573a7f9a557f6d8539044524d9fc5ca8fbb7db05eb81379d168285d76b57eb8a4
   - remote: buf.build
     owner: protocolbuffers
     repository: wellknowntypes
-    commit: 657250e6a39648cbb169d079a60bd9ba
-    digest: shake256:00de25001b8dd2e29d85fc4bcc3ede7aed886d76d67f5e0f7a9b320b90f871d3eb73507d50818d823a0512f3f8db77a11c043685528403e31ff3fef18323a9fb
-  - remote: buf.build
-    owner: tendermint
-    repository: tendermint
-    commit: 33ed361a90514289beabf3189e1d7665
-    digest: shake256:038267e06294714fd883610626554b04a127b576b4e253befb4206cb72d5d3c1eeccacd4b9ec8e3fb891f7c14e1cb0f770c077d2989638995b0a61c85afedb1d
+    commit: 7727a3b7399540398e5736b9916f0faa
+    digest: shake256:74c046f009811965d227acd11bb2c6259bf387759d4230b95405e402a2ed4212d6f4babab690407d07bc81095c3917c4ae9144195ddfb081525c9aec58e51173

client/v2/internal/buf.yaml

@@ -1,7 +1,9 @@
 version: v1
 deps:
+  - buf.build/cosmos/gogo-proto
   - buf.build/cosmos/cosmos-sdk
   - buf.build/cosmos/cosmos-proto
+  - buf.build/protocolbuffers/wellknowntypes
 lint:
   use:
     - STANDARD

client/v2/internal/testpbgogo/buf.gen.yaml

@@ -0,0 +1,14 @@
+version: v1
+managed:
+  enabled: true
+  go_package_prefix:
+    default: github.com/cosmos/cosmos-sdk/client/v2/internal
+    except:
+      - buf.build/cosmos/cosmos-proto
+      - buf.build/cosmos/cosmos-sdk
+    override:
+      buf.build/cosmos/gogo-proto: github.com/cosmos/gogoproto
+plugins:
+  - name: gocosmos
+    out: .
+    opt: plugins=grpc,Mgoogle/protobuf/any.proto=github.com/cosmos/gogoproto/types/any