feat: improve buf rate limit (#4133)

* draft improvements * use --path flag mutilple times * remove `Build.Proto.ThirdPartyPaths` from the config * add logic for run buf by folder or by file * update cosmos-sdk * fix exclude files for swagger * fix buf cache * add changelog * update buf deps * fix unit test * fix wrong proto go path * clear buf cache * fix doctor tests and remove `third_party_paths` from the docs * improve Test_extractRootModulePath test cases * Update ignite/pkg/cosmosbuf/cache.go Co-authored-by: Jerónimo Albi <[email protected]> * fix changelog.md * improve cache logic * create a dircache pkg * add comments * rename methods `CopyCache` to `CopyTo` and `SaveCache` to `Save` --------- Co-authored-by: Pantani <Pantani> Co-authored-by: Jerónimo Albi <[email protected]> (cherry picked from commit 0b41262) # Conflicts: # ignite/cmd/cmd.go # ignite/config/chain/base/config.go # ignite/config/chain/v1/testdata/config.yaml # ignite/config/chain/v1/testdata/config2.yaml # ignite/internal/analytics/analytics.go # ignite/pkg/cosmosbuf/buf.go # ignite/pkg/cosmosgen/generate_go.go # ignite/pkg/cosmosgen/generate_openapi.go # integration/doctor/testdata/config-need-migrate.txt
ignite · Jun 21, 2024 · 86a2568 · 86a2568
1 parent 8cebfc3
commit 86a2568
Show file tree

Hide file tree

Showing 30 changed files with 596 additions and 285 deletions.
diff --git a/changelog.md b/changelog.md
@@ -5,6 +5,21 @@
 ### Features
 
 - [#4183](https://github.com/ignite/cli/pull/4183) Set `chain-id` in the client.toml
+- [#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
+- [#4076](https://github.com/ignite/cli/pull/4076) Remove the ignite `relayer` and `tools` commands with all ts-relayer logic
+- [#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
+- [#4077](https://github.com/ignite/cli/pull/4077) Merge the swagger files manually instead use nodetime `swagger-combine`
+- [#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
+- [#4133](https://github.com/ignite/cli/pull/4133) Improve buf rate limit
+- [#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
 
 ### Changes
 

diff --git a/docs/docs/02-guide/06-ibc.md b/docs/docs/02-guide/06-ibc.md
@@ -432,9 +432,6 @@ version: 1
 build:
   proto:
     path: proto
-    third_party_paths:
-    - third_party/proto
-    - proto_vendor
 accounts:
 - name: alice
   coins:
@@ -463,9 +460,6 @@ version: 1
 build:
   proto:
     path: proto
-    third_party_paths:
-    - third_party/proto
-    - proto_vendor
 accounts:
 - name: alice
   coins:

diff --git a/docs/docs/02-guide/07-interchange/02-init.md b/docs/docs/02-guide/07-interchange/02-init.md
@@ -129,9 +129,6 @@ version: 1
 build:
   proto:
     path: proto
-    third_party_paths:
-    - third_party/proto
-    - proto_vendor
 accounts:
 - name: alice
   coins:
@@ -164,9 +161,6 @@ version: 1
 build:
   proto:
     path: proto
-    third_party_paths:
-    - third_party/proto
-    - proto_vendor
 accounts:
 - name: alice
   coins:

diff --git a/docs/docs/08-references/02-config.md b/docs/docs/08-references/02-config.md
@@ -203,17 +203,6 @@ build:
     path: "myproto"
 ```
 
-Ignite comes with required third-party proto out of the box. Ignite also looks
-into `third_party/proto` and `proto_vendor` directories for extra proto files.
-If your project keeps third-party proto files in a different directory, you
-should tell Ignite about this:
-
-```yml
-build:
-  proto:
-    third_party_paths: ["my_third_party/proto"]
-```
-
 ## Faucet
 
 The faucet service sends tokens to addresses.

diff --git a/docs/versioned_docs/version-v0.25/kb/03-config.md b/docs/versioned_docs/version-v0.25/kb/03-config.md
@@ -57,7 +57,6 @@ build:
 | Key               | Required | Type            | Description                                                                                |
 | ----------------- | -------- | --------------- | ------------------------------------------------------------------------------------------ |
 | path              | N        | String          | Path to protocol buffer files. Default: `"proto"`.                                         |
-| third_party_paths | N        | List of Strings | Path to third-party protocol buffer files. Default: `["third_party/proto", "proto_vendor"]`. |
 
 ## client
 

diff --git a/docs/versioned_docs/version-v0.25/kb/06-proto.md b/docs/versioned_docs/version-v0.25/kb/06-proto.md
@@ -20,11 +20,3 @@ Third-party proto files, including those of Cosmos SDK and Tendermint, are bundl
 ```protobuf
 import "cosmos/base/query/v1beta1/pagination.proto";
 ```
-
-You can also manually add third-party proto files. By default, Ignite CLI imports proto files from these directories: `third_party/proto` and `proto_vendor`. You can define third-party paths of the import directory in `config.yml`:
-
-```yaml
-build:
-  proto:
-    third_party_paths: ["my_third_party_proto"]
-```
diff --git a/ignite/cmd/cmd.go b/ignite/cmd/cmd.go
@@ -12,6 +12,7 @@ import (
 	"github.com/spf13/cobra"
 	flag "github.com/spf13/pflag"
 
+<<<<<<< HEAD
 	"github.com/ignite/cli/v28/ignite/config"
 	"github.com/ignite/cli/v28/ignite/pkg/cache"
 	"github.com/ignite/cli/v28/ignite/pkg/cliui"
@@ -20,6 +21,26 @@ import (
 	"github.com/ignite/cli/v28/ignite/pkg/gitpod"
 	"github.com/ignite/cli/v28/ignite/pkg/goenv"
 	"github.com/ignite/cli/v28/ignite/version"
+=======
+	"github.com/ignite/cli/v29/ignite/config"
+	chainconfig "github.com/ignite/cli/v29/ignite/config/chain"
+	"github.com/ignite/cli/v29/ignite/pkg/cache"
+	"github.com/ignite/cli/v29/ignite/pkg/cliui"
+	uilog "github.com/ignite/cli/v29/ignite/pkg/cliui/log"
+	"github.com/ignite/cli/v29/ignite/pkg/dircache"
+	"github.com/ignite/cli/v29/ignite/pkg/errors"
+	"github.com/ignite/cli/v29/ignite/pkg/gitpod"
+	"github.com/ignite/cli/v29/ignite/pkg/goenv"
+	"github.com/ignite/cli/v29/ignite/pkg/gomodulepath"
+	"github.com/ignite/cli/v29/ignite/version"
+)
+
+type key int
+
+const (
+	keyChainConfig     key = iota
+	keyChainConfigPath key = iota
+>>>>>>> 0b412628 (feat: improve buf rate limit (#4133))
 )
 
 const (
@@ -228,6 +249,9 @@ func newCache(cmd *cobra.Command) (cache.Storage, error) {
 		if err := storage.Clear(); err != nil {
 			return cache.Storage{}, err
 		}
+		if err := dircache.ClearCache(); err != nil {
+			return cache.Storage{}, err
+		}
 	}
 
 	return storage, nil

diff --git a/ignite/config/chain/base/config.go b/ignite/config/chain/base/config.go
@@ -47,11 +47,15 @@ type Build struct {
 // Proto holds proto build configs.
 type Proto struct {
 	// Path is the relative path of where app's proto files are located at.
+<<<<<<< HEAD
 	Path string `yaml:"path"`
 
 	// ThirdPartyPath is the relative path of where the third party proto files are
 	// located that used by the app.
 	ThirdPartyPaths []string `yaml:"third_party_paths"`
+=======
+	Path string `yaml:"path" doc:"Relative path where the application's proto files are located."`
+>>>>>>> 0b412628 (feat: improve buf rate limit (#4133))
 }
 
 // Client configures code generation for clients.
@@ -204,8 +208,12 @@ func DefaultConfig() Config {
 	return Config{
 		Build: Build{
 			Proto: Proto{
+<<<<<<< HEAD
 				Path:            "proto",
 				ThirdPartyPaths: []string{"third_party/proto", "proto_vendor"},
+=======
+				Path: defaults.ProtoDir,
+>>>>>>> 0b412628 (feat: improve buf rate limit (#4133))
 			},
 		},
 		Faucet: Faucet{

diff --git a/ignite/config/chain/v1/config_test.go b/ignite/config/chain/v1/config_test.go
@@ -29,8 +29,7 @@ func TestConfigDecode(t *testing.T) {
 			Build: base.Build{
 				Binary: "evmosd",
 				Proto: base.Proto{
-					Path:            "proto",
-					ThirdPartyPaths: []string{"third_party/proto", "proto_vendor"},
+					Path: "proto",
 				},
 			},
 			Accounts: []base.Account{

diff --git a/ignite/config/chain/v1/testdata/config.yaml b/ignite/config/chain/v1/testdata/config.yaml
@@ -3,9 +3,12 @@ build:
   binary: evmosd
   proto:
     path: proto
+<<<<<<< HEAD
     third_party_paths:
     - third_party/proto
     - proto_vendor
+=======
+>>>>>>> 0b412628 (feat: improve buf rate limit (#4133))
 accounts:
 - name: alice
   coins:

diff --git a/ignite/config/chain/v1/testdata/config2.yaml b/ignite/config/chain/v1/testdata/config2.yaml
@@ -3,9 +3,12 @@ build:
   binary: evmosd
   proto:
     path: proto
+<<<<<<< HEAD
     third_party_paths:
     - third_party/proto
     - proto_vendor
+=======
+>>>>>>> 0b412628 (feat: improve buf rate limit (#4133))
 accounts:
 - name: alice
   coins:

diff --git a/ignite/internal/analytics/analytics.go b/ignite/internal/analytics/analytics.go
@@ -12,18 +12,25 @@ import (
 	"github.com/manifoldco/promptui"
 	"github.com/spf13/cobra"
 
+<<<<<<< HEAD
 	"github.com/ignite/cli/v28/ignite/pkg/gitpod"
 	"github.com/ignite/cli/v28/ignite/pkg/matomo"
 	"github.com/ignite/cli/v28/ignite/pkg/randstr"
 	"github.com/ignite/cli/v28/ignite/version"
+=======
+	"github.com/ignite/cli/v29/ignite/config"
+	"github.com/ignite/cli/v29/ignite/pkg/gacli"
+	"github.com/ignite/cli/v29/ignite/pkg/gitpod"
+	"github.com/ignite/cli/v29/ignite/pkg/randstr"
+	"github.com/ignite/cli/v29/ignite/version"
+>>>>>>> 0b412628 (feat: improve buf rate limit (#4133))
 )
 
 const (
 	telemetryEndpoint  = "https://matomo-cli.ignite.com"
 	envDoNotTrack      = "DO_NOT_TRACK"
 	envCI              = "CI"
 	envGitHubActions   = "GITHUB_ACTIONS"
-	igniteDir          = ".ignite"
 	igniteAnonIdentity = "anon_identity.json"
 )
 
@@ -106,14 +113,15 @@ func checkDNT() (anonIdentity, error) {
 		return anonIdentity{DoNotTrack: true}, nil
 	}
 
-	home, err := os.UserHomeDir()
+	globalPath, err := config.DirPath()
 	if err != nil {
 		return anonIdentity{}, err
 	}
-	if err := os.Mkdir(filepath.Join(home, igniteDir), 0o700); err != nil && !os.IsExist(err) {
+	if err := os.Mkdir(globalPath, 0o700); err != nil && !os.IsExist(err) {
 		return anonIdentity{}, err
 	}
-	identityPath := filepath.Join(home, igniteDir, igniteAnonIdentity)
+
+	identityPath := filepath.Join(globalPath, igniteAnonIdentity)
 	data, err := os.ReadFile(identityPath)
 	if err != nil && !os.IsNotExist(err) {
 		return anonIdentity{}, err