feat: add or vendor proto packages from Go dependencies

[jeronimoalbi]

Closes #3635

[jeronimoalbi]

There are two cases handled by this PR when a Go dependency contains proto files:

• The dependency contains a Buf config with the optional name property setted
• The dependency only contains proto files or a Buf config without a name property

For the first case a new dependency entry is added to app's Buf config; For the second case proto files are copied or exported to a proto_vendor directory.

All scaffold commands handle these cases by default.

All generate commands optionally handle these cases when the --enable-proto-vendor flag is present.

[jeronimoalbi]

Feature can be manually tested by scaffolding a chain which will have a new Buf dependency buf.build/cosmos/ibc added to proto/buf.yaml during scaffold which is not included in the default CLI app templates.

After that remove the buf.build/cosmos/ibc from proto/buf.yaml and run buf mod prune ./proto to cleanup the dependency. Running ignite generate proto-go --clear-cache -y --enable-proto-vendor should add it back.

Finally remove the buf.build/cosmos/ibc, run buf mod prune ./proto to cleanup the dependency again and temporary remove the name property from $(go env GOMODCACHE)/github.com/cosmos/ibc-go/[email protected]/proto/buf.yaml. Running ignite generate proto-go --clear-cache -y --enable-proto-vendor should vendor the proto files this time.

At this point I'm not sure how to properly test it using CI tests.

[jeronimoalbi]

Maybe the --update-buf-module flag could be renamed to --enable-proto-vendor or --enable-proto-vendoring 🤔

If you prefer any of those names over the current one let me know and I can change it.

[Pantani]

--enable-proto-vendor

my vote is for --enable-proto-vendor

[Ehsan-saradar]

Feature can be manually tested by scaffolding a chain which will have a new Buf dependency buf.build/cosmos/ibc added to proto/buf.yaml during scaffold which is not included in the default CLI app templates.

Hey @jeronimoalbi I don't remember an option for adding a buf dependency in scaffold chain command. Could you add some details?

[jeronimoalbi]

Hey @jeronimoalbi I don't remember an option for adding a buf dependency in scaffold chain command. Could you add some details?

There is not option in the CLI to explicitly add a Buf dependency, at this point developers should add them by hand by changing the buf.yaml file.
The changes in this PR try to discover Buf dependencies from the app's Go depedencies. The only case where a dependency is added to the buf.yaml by the CLI is when a Go dependency contains proto files and a buf.yaml file with the optional name property specified, in which case the name is added to app's Buf dependencies and then the Buf lock file is updated.

The scaffold commands automatically try to discover proto dependencies that might be missing, while the generate commands should opt-in by using the --enable-proto-vendor.

[Ehsan-saradar]

@jeronimoalbi I originally thought that the "during scaffold" part of your comment meant that you added an option to add buf dependencies during chain scaffold. 😅

[codecov]

Codecov Report

Merging #3724 (327ca6c) into main (57813c9) will decrease coverage by 0.20%.
The diff coverage is 0.00%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3724      +/-   ##
==========================================
- Coverage   24.83%   24.64%   -0.20%     
==========================================
  Files         295      295              
  Lines       24181    24376     +195     
==========================================
+ Hits         6006     6008       +2     
- Misses      17628    17822     +194     
+ Partials      547      546       -1     

Files	Coverage Δ
ignite/services/scaffolder/scaffolder.go	0.00% <0.00%> (ø)
ignite/cmd/generate_typescript_client.go	0.00% <0.00%> (ø)
ignite/cmd/generate_composables.go	0.00% <0.00%> (ø)
ignite/cmd/generate_go.go	0.00% <0.00%> (ø)
ignite/cmd/generate_hooks.go	0.00% <0.00%> (ø)
ignite/cmd/generate_openapi.go	0.00% <0.00%> (ø)
ignite/cmd/generate_pulsar.go	0.00% <0.00%> (ø)
ignite/cmd/generate_vuex.go	0.00% <0.00%> (ø)
ignite/pkg/cosmosgen/generate_go.go	0.00% <0.00%> (ø)
ignite/pkg/cosmosgen/generate_openapi.go	0.00% <0.00%> (ø)
... and 6 more

... and 1 file with indirect coverage changes