refactor(cosmosanalysis): proper message filtering (#4686)

* refactor(cosmosanalysis): keep only messages

* updates

* simplify

* updates

* fix

* harden logic

(cherry picked from commit 20a54d4)

Author: julienrbrt

changelog.md

@@ -2,6 +2,110 @@
 
 ## Unreleased
 
+### Bug Fixes
+
+- [#4686](https://github.com/ignite/cli/pull/4686) Filter discovered protos to only messages.
+
+## [`v29.0.0-rc.1`](https://github.com/ignite/cli/releases/tag/v29.0.0-rc.1)
+
+### Features
+
+- [#4509](https://github.com/ignite/cli/pull/4509) Upgrade to Go 1.24. Running `ignite doctor` migrates the scaffolded `tools.go` to the tool directive in the go.mod
+- [#4588](https://github.com/ignite/cli/pull/4588) Run `buf format after scaffold proto files.
+- [#4603](https://github.com/ignite/cli/issues/4603) Add `GetIgniteInfo` gRPC API for apps.
+- [#4657](https://github.com/ignite/cli/pull/4657) Upgrade to Cosmos SDK [v0.53.0](https://github.com/cosmos/cosmos-sdk/releases/tag/v0.53.0).
+  - Add x/epochs module to default template (except for minimal template).
+  - Bump minimum compatible Cosmos SDK version to `v0.50.0`.
+
+### Changes
+
+- [#4596](https://github.com/ignite/cli/pull/4596) Add default `openapi.yml` when skipping proto gen.
+- [#4601](https://github.com/ignite/cli/pull/4601) Add `appregistry` as default plugin
+- [#4613](https://github.com/ignite/cli/pull/4613) Improve and simplify prompting logic by bubbletea.
+- [#4624](https://github.com/ignite/cli/pull/4624) Fix autocli templates for variadics.
+- [#4644](https://github.com/ignite/cli/pull/4644) Improve UI and UX for `testnet multi-node` command.
+- [#4645](https://github.com/ignite/cli/pull/4645) Refactor the xast.ModifyFunction to improve the readability.
+- [#4664](https://github.com/ignite/cli/pull/4664) Add verbose flags on `scaffold` and `generate` commands.
+  - The flag displays the steps Ignite is taking to generate the code.
+  - The verbosity only applies to the command. For full verbosity use the `IGNT_DEBUG` environment variable instead.
+
+### Fixes
+
+- [#4347](https://github.com/ignite/cli/pull/4347) Fix `ts-client` generation
+- [#4577](https://github.com/ignite/cli/pull/4577) Add proto version to query path.
+- [#4579](https://github.com/ignite/cli/pull/4579) Fix empty params response.
+- [#4585](https://github.com/ignite/cli/pull/4585) Fix faucet cmd issue.
+- [#4587](https://github.com/ignite/cli/pull/4587) Add missing light clients routes to IBC client keeper.
+- [#4595](https://github.com/ignite/cli/pull/4595) Fix wrong InterfaceRegistry for IBC modules.
+- [#4609](https://github.com/ignite/cli/pull/4609) Add work dir for relayer integration tests.
+- [#4658](https://github.com/ignite/cli/pull/4658) Fix indentation for params scaffolded into a struct.
+- [#4582](https://github.com/ignite/cli/issues/4582) Fix xast misplacing comments.
+- [#4660](https://github.com/ignite/cli/pull/4660) Fix xast test case indentation.
+- [#4667](https://github.com/ignite/cli/pull/4667) Harden `IsSlice`
+
+## [`v29.0.0-beta.1`](https://github.com/ignite/cli/releases/tag/v29.0.0-beta.1)
+
+### Features
+
+- [#3707](https://github.com/ignite/cli/pull/3707) and [#4094](https://github.com/ignite/cli/pull/4094) Add collections support.
+- [#3977](https://github.com/ignite/cli/pull/3977) Add `chain lint` command to lint the chain's codebase using `golangci-lint`
+- [#3770](https://github.com/ignite/cli/pull/3770) Add `scaffold configs` and `scaffold params` commands
+- [#4001](https://github.com/ignite/cli/pull/4001) Improve `xgenny` dry run
+- [#3967](https://github.com/ignite/cli/issues/3967) Add HD wallet parameters `address index` and `account number` to the chain account config
+- [#4004](https://github.com/ignite/cli/pull/4004) Remove all import placeholders using the `xast` pkg
+- [#4071](https://github.com/ignite/cli/pull/4071) Support custom proto path
+- [#3718](https://github.com/ignite/cli/pull/3718) Add `gen-mig-diffs` tool app to compare scaffold output of two versions of ignite
+- [#4100](https://github.com/ignite/cli/pull/4100) Set the `proto-dir` flag only for the `scaffold chain` command and use the proto path from the config
+- [#4111](https://github.com/ignite/cli/pull/4111) Remove vuex generation
+- [#4113](https://github.com/ignite/cli/pull/4113) Generate chain config documentation automatically
+- [#4131](https://github.com/ignite/cli/pull/4131) Support `bytes` as data type in the `scaffold` commands
+- [#4300](https://github.com/ignite/cli/pull/4300) Only panics the module in the most top function level
+- [#4327](https://github.com/ignite/cli/pull/4327) Use the TxConfig from simState instead create a new one
+- [#4326](https://github.com/ignite/cli/pull/4326) Add `buf.build` version to `ignite version` command
+- [#4436](https://github.com/ignite/cli/pull/4436) Return tx hash to the faucet API
+- [#4437](https://github.com/ignite/cli/pull/4437) Remove module placeholders
+- [#4289](https://github.com/ignite/cli/pull/4289), [#4423](https://github.com/ignite/cli/pull/4423), [#4432](https://github.com/ignite/cli/pull/4432), [#4507](https://github.com/ignite/cli/pull/4507), [#4524](https://github.com/ignite/cli/pull/4524) Cosmos SDK v0.52 support and downgrade back to 0.50, while keeping latest improvements.
+- [#4480](https://github.com/ignite/cli/pull/4480) Add field max length
+- [#4477](https://github.com/ignite/cli/pull/4477), [#4559](https://github.com/ignite/cli/pull/4559) IBC v10 support
+- [#4166](https://github.com/ignite/cli/issues/4166) Migrate buf config files to v2
+- [#4494](https://github.com/ignite/cli/pull/4494) Automatic migrate the buf configs to v2
+
+### Changes
+
+- [#4094](https://github.com/ignite/cli/pull/4094) Scaffolding a multi-index map using `ignite s map foo bar baz --index foobar,foobaz` is no longer supported. Use one index instead of use `collections.IndexedMap`.
+- [#4058](https://github.com/ignite/cli/pull/4058) Simplify scaffolded modules by including `ValidateBasic()` logic in message handler.
+- [#4058](https://github.com/ignite/cli/pull/4058) Use `address.Codec` instead of `AccAddressFromBech32`.
+- [#3993](https://github.com/ignite/cli/pull/3993) Oracle scaffolding was deprecated and has been removed
+- [#3962](https://github.com/ignite/cli/pull/3962) Rename all RPC endpoints and autocli commands generated for `map`/`list`/`single` types
+- [#3976](https://github.com/ignite/cli/pull/3976) Remove error checks for Cobra command value get calls
+- [#4002](https://github.com/ignite/cli/pull/4002) Bump buf build
+- [#4008](https://github.com/ignite/cli/pull/4008) Rename `pkg/yaml` to `pkg/xyaml`
+- [#4075](https://github.com/ignite/cli/pull/4075) Use `gopkg.in/yaml.v3` instead `gopkg.in/yaml.v2`
+- [#4118](https://github.com/ignite/cli/pull/4118) Version scaffolded protos as `v1` to follow SDK structure.
+- [#4167](https://github.com/ignite/cli/pull/4167) Scaffold `int64` instead of `int32` when a field type is `int`
+- [#4159](https://github.com/ignite/cli/pull/4159) Enable gci linter
+- [#4160](https://github.com/ignite/cli/pull/4160) Enable copyloopvar linter
+- [#4162](https://github.com/ignite/cli/pull/4162) Enable errcheck linter
+- [#4189](https://github.com/ignite/cli/pull/4189) Deprecate `ignite node` for `ignite connect` app
+- [#4290](https://github.com/ignite/cli/pull/4290) Remove ignite ics logic from ignite cli (this functionality will be in the `consumer` app)
+- [#4295](https://github.com/ignite/cli/pull/4295) Stop scaffolding `pulsar` files
+- [#4317](https://github.com/ignite/cli/pull/4317) Remove xchisel dependency
+- [#4361](https://github.com/ignite/cli/pull/4361) Remove unused `KeyPrefix` method
+- [#4384](https://github.com/ignite/cli/pull/4384) Compare genesis params into chain genesis tests
+- [#4463](https://github.com/ignite/cli/pull/4463) Run `chain simulation` with any simulation test case
+- [#4533](https://github.com/ignite/cli/pull/4533) Promote GitHub codespace instead of Gitpod
+- [#4549](https://github.com/ignite/cli/pull/4549) Remove unused placeholder vars
+- [#4557](https://github.com/ignite/cli/pull/4557) Remove github.com/gookit/color
+
+### Fixes
+
+- [#4000](https://github.com/ignite/cli/pull/4000) Run all dry runners before the wet run in the `xgenny` pkg
+- [#4091](https://github.com/ignite/cli/pull/4091) Fix race conditions in the plugin logic
+- [#4128](https://github.com/ignite/cli/pull/4128) Check for duplicate proto fields in config
+- [#4402](https://github.com/ignite/cli/pull/4402) Fix gentx parser into the cosmosutil package
+- [#4552](https://github.com/ignite/cli/pull/4552) Avoid direct access to proto field `perms.Account` and `perms.Permissions`
+- [#4555](https://github.com/ignite/cli/pull/4555) Fix buf lint issues into the chain code
+
 ## [`v28.10.0`](https://github.com/ignite/cli/releases/tag/v28.10.0)
 
 ### Features

ignite/pkg/cosmosanalysis/module/message.go

@@ -208,25 +208,6 @@ func RootGoImportPath(importPath string) string {
 	return importPath
 }
 
-func extractRelPath(pkgGoImportPath, baseGoPath string) (string, error) {
-	// Remove the import prefix to get the relative path
-	if strings.HasPrefix(pkgGoImportPath, baseGoPath) {
-		return strings.TrimPrefix(pkgGoImportPath, baseGoPath), nil
-	}
-
-	// When the import path prefix defined by the proto package
-	// doesn't match the base Go import path it means that the
-	// latter might have a version suffix and the former doesn't.
-	if p, v := path.Split(baseGoPath); semver.IsValid(v) {
-		// Use the import path without the version as prefix
-		p = strings.TrimRight(p, "/")
-
-		return strings.TrimPrefix(pkgGoImportPath, p), nil
-	}
-
-	return "", errors.Errorf("proto go import %s is not relative to %s", pkgGoImportPath, baseGoPath)
-}
-
 // discover discovers and sdk module by a proto pkg.
 func (d *moduleDiscoverer) discover(pkg protoanalysis.Package) (Module, error) {
 	// Check if the proto package services are implemented
@@ -235,19 +216,7 @@ func (d *moduleDiscoverer) discover(pkg protoanalysis.Package) (Module, error) {
 		return Module{}, err
 	}
 
-	pkgRelPath, err := extractRelPath(pkg.GoImportPath(), d.basegopath)
-	if err != nil {
-		return Module{}, err
-	}
-
-	// Find the `sdk.Msg` interface implementation
-	pkgPath := filepath.Join(d.sourcePath, pkgRelPath)
-	msgs, err := cosmosanalysis.FindImplementation(pkgPath, messageImplementation)
-	if err != nil {
-		return Module{}, err
-	}
-
-	if len(pkg.Services)+len(msgs) == 0 {
+	if len(pkg.Services) == 0 {
 		return Module{}, nil
 	}
 
@@ -257,22 +226,6 @@ func (d *moduleDiscoverer) discover(pkg protoanalysis.Package) (Module, error) {
 		Pkg:          pkg,
 	}
 
-	for _, msg := range msgs {
-		pkgmsg, err := pkg.MessageByName(msg)
-		if err != nil {
-			// no msg found in the proto defs corresponds to discovered sdk message.
-			// if it cannot be found, nothing to worry about, this means that it is used
-			// only internally and not open for actual use.
-			continue
-		}
-
-		m.Msgs = append(m.Msgs, Msg{
-			Name:     msg,
-			URI:      fmt.Sprintf("%s.%s", pkg.Name, msg),
-			FilePath: pkgmsg.Path,
-		})
-	}
-
 	// isType whether if protomsg can be added as an any Type to Module.
 	isType := func(protomsg protoanalysis.Message) bool {
 		// do not use GenesisState type.
@@ -315,19 +268,37 @@ func (d *moduleDiscoverer) discover(pkg protoanalysis.Package) (Module, error) {
 		})
 	}
 
-	// fill queries.
+	// fill queries & messages.
 	for _, s := range pkg.Services {
 		for _, q := range s.RPCFuncs {
-			if len(q.HTTPRules) == 0 {
-				continue
-			}
+			switch s.Name {
+			case "Msg":
+				pkgmsg, err := pkg.MessageByName(q.RequestType)
+				if err != nil {
+					// no msg found in the proto defs corresponds to discovered sdk message.
+					// if it cannot be found, nothing to worry about, this means that it is used
+					// only internally and not open for actual use.
+					continue
+				}
 
-			m.HTTPQueries = append(m.HTTPQueries, HTTPQuery{
-				Name:      q.Name,
-				FullName:  s.Name + q.Name,
-				Rules:     q.HTTPRules,
-				Paginated: q.Paginated,
-			})
+				m.Msgs = append(m.Msgs, Msg{
+					Name:     q.RequestType,
+					URI:      fmt.Sprintf("%s.%s", pkg.Name, q.RequestType),
+					FilePath: pkgmsg.Path,
+				})
+			case "Query":
+				// no http rules means this query is not exposed as a REST endpoint.
+				if len(q.HTTPRules) == 0 {
+					continue
+				}
+
+				m.HTTPQueries = append(m.HTTPQueries, HTTPQuery{
+					Name:      q.Name,
+					FullName:  s.Name + q.Name,
+					Rules:     q.HTTPRules,
+					Paginated: q.Paginated,
+				})
+			}
 		}
 	}
 

ignite/pkg/cosmosanalysis/module/module.go

@@ -29,6 +29,38 @@ func newModule(relChainPath, goImportPath string) module.Module {
 			},
 			GoImportName: "github.com/tendermint/planet/x/mars/types",
 			Messages: []protoanalysis.Message{
+				{
+					Name:               "MsgMyMessageRequest",
+					Path:               filepath.Join(relChainPath, "proto/planet/mars/mars.proto"),
+					HighestFieldNumber: 1,
+					Fields: map[string]string{
+						"mytypefield": "string",
+					},
+				},
+				{
+					Name:               "MsgMyMessageResponse",
+					Path:               filepath.Join(relChainPath, "proto/planet/mars/mars.proto"),
+					HighestFieldNumber: 1,
+					Fields: map[string]string{
+						"mytypefield": "string",
+					},
+				},
+				{
+					Name:               "MsgBarRequest",
+					Path:               filepath.Join(relChainPath, "proto/planet/mars/mars.proto"),
+					HighestFieldNumber: 1,
+					Fields: map[string]string{
+						"mytypefield": "string",
+					},
+				},
+				{
+					Name:               "MsgBarResponse",
+					Path:               filepath.Join(relChainPath, "proto/planet/mars/mars.proto"),
+					HighestFieldNumber: 1,
+					Fields: map[string]string{
+						"mytypefield": "string",
+					},
+				},
 				{
 					Name:               "QueryMyQueryRequest",
 					Path:               filepath.Join(relChainPath, "proto/planet/mars/mars.proto"),
@@ -58,6 +90,21 @@ func newModule(relChainPath, goImportPath string) module.Module {
 				},
 			},
 			Services: []protoanalysis.Service{
+				{
+					Name: "Msg",
+					RPCFuncs: []protoanalysis.RPCFunc{
+						{
+							Name:        "MyMessage",
+							RequestType: "MsgMyMessageRequest",
+							ReturnsType: "MsgMyMessageResponse",
+						},
+						{
+							Name:        "Bar",
+							RequestType: "MsgBarRequest",
+							ReturnsType: "MsgBarResponse",
+						},
+					},
+				},
 				{
 					Name: "Query",
 					RPCFuncs: []protoanalysis.RPCFunc{
@@ -89,7 +136,18 @@ func newModule(relChainPath, goImportPath string) module.Module {
 				},
 			},
 		},
-		Msgs: []module.Msg(nil),
+		Msgs: []module.Msg{
+			{
+				Name:     "MsgMyMessageRequest",
+				URI:      "tendermint.planet.mars.MsgMyMessageRequest",
+				FilePath: filepath.Join(relChainPath, "proto/planet/mars/mars.proto"),
+			},
+			{
+				Name:     "MsgBarRequest",
+				URI:      "tendermint.planet.mars.MsgBarRequest",
+				FilePath: filepath.Join(relChainPath, "proto/planet/mars/mars.proto"),
+			},
+		},
 		HTTPQueries: []module.HTTPQuery{
 			{
 				Name:     "MyQuery",

ignite/pkg/cosmosanalysis/module/module_test.go

@@ -4,13 +4,35 @@ import "cosmos/base/query/v1beta1/pagination.proto";
 import "google/api/annotations.proto";
 option go_package = "github.com/tendermint/planet/x/mars/types";
 
+service Msg {
+  rpc MyMessage(MsgMyMessageRequest) returns (MsgMyMessageResponse);
+
+  rpc Bar(MsgBarRequest) returns (MsgBarResponse);
+}
+
+message MsgMyMessageRequest {
+  string mytypefield = 1;
+}
+
+message MsgMyMessageResponse {
+  string mytypefield = 1;
+}
+
+message MsgBarRequest {
+  string mytypefield = 1;
+}
+
+message MsgBarResponse {
+  string mytypefield = 1;
+}
+
 service Query {
   rpc MyQuery(QueryMyQueryRequest) returns (QueryMyQueryResponse) {
-    option (google.api.http).get = "/tendermint/mars/withoutmsg/my_query/{mytypefield}";
+    option (google.api.http).get = "/tendermint/mars/my_query/{mytypefield}";
   }
 
   rpc Foo(QueryFooRequest) returns (QueryFooResponse) {
-    option (google.api.http).get = "/tendermint/mars/withoutmsg/foo/";
+    option (google.api.http).get = "/tendermint/mars/foo/";
   }
 }
 

ignite/pkg/cosmosanalysis/module/testdata/earth/proto/planet/mars/mars.proto

@@ -4,13 +4,35 @@ import "cosmos/base/query/v1beta1/pagination.proto";
 import "google/api/annotations.proto";
 option go_package = "github.com/tendermint/planet/x/mars/types";
 
+service Msg {
+  rpc MyMessage(MsgMyMessageRequest) returns (MsgMyMessageResponse);
+
+  rpc Bar(MsgBarRequest) returns (MsgBarResponse);
+}
+
+message MsgMyMessageRequest {
+  string mytypefield = 1;
+}
+
+message MsgMyMessageResponse {
+  string mytypefield = 1;
+}
+
+message MsgBarRequest {
+  string mytypefield = 1;
+}
+
+message MsgBarResponse {
+  string mytypefield = 1;
+}
+
 service Query {
   rpc MyQuery(QueryMyQueryRequest) returns (QueryMyQueryResponse) {
-    option (google.api.http).get = "/tendermint/mars/withoutmsg/my_query/{mytypefield}";
+    option (google.api.http).get = "/tendermint/mars/my_query/{mytypefield}";
   }
 
   rpc Foo(QueryFooRequest) returns (QueryFooResponse) {
-    option (google.api.http).get = "/tendermint/mars/withoutmsg/foo/";
+    option (google.api.http).get = "/tendermint/mars/foo/";
   }
 }