refactor: add generate proto vendor target

All generate commands require support for proto vendoring and Buf dependencies updates. A new target was added to make proto vendoring optional and to avoid using an extra argument in all generate targets.
ignite · Nov 8, 2023 · 1246448 · 1246448
1 parent 39d52b0
commit 1246448
Show file tree

Hide file tree

Showing 8 changed files with 65 additions and 24 deletions.
diff --git a/ignite/cmd/generate_composables.go b/ignite/cmd/generate_composables.go
@@ -44,7 +44,13 @@ func generateComposablesHandler(cmd *cobra.Command, _ []string) error {
 		return err
 	}
 
-	if err := c.Generate(cmd.Context(), cacheStorage, chain.GenerateComposables(output)); err != nil {
+	var opts []chain.GenerateTarget
+	if flagGetUpdateBufModule(cmd) {
+		opts = append(opts, chain.GenerateProtoVendor())
+	}
+
+	err = c.Generate(cmd.Context(), cacheStorage, chain.GenerateComposables(output), opts...)
+	if err != nil {
 		return err
 	}
 

diff --git a/ignite/cmd/generate_go.go b/ignite/cmd/generate_go.go
@@ -39,8 +39,12 @@ func generateGoHandler(cmd *cobra.Command, _ []string) error {
 		return err
 	}
 
-	updateBufModule := flagGetUpdateBufModule(cmd)
-	err = c.Generate(cmd.Context(), cacheStorage, chain.GenerateGo(updateBufModule))
+	var opts []chain.GenerateTarget
+	if flagGetUpdateBufModule(cmd) {
+		opts = append(opts, chain.GenerateProtoVendor())
+	}
+
+	err = c.Generate(cmd.Context(), cacheStorage, chain.GenerateGo(), opts...)
 	if err != nil {
 		return err
 	}

diff --git a/ignite/cmd/generate_hooks.go b/ignite/cmd/generate_hooks.go
@@ -44,7 +44,13 @@ func generateHooksHandler(cmd *cobra.Command, _ []string) error {
 		return err
 	}
 
-	if err := c.Generate(cmd.Context(), cacheStorage, chain.GenerateHooks(output)); err != nil {
+	var opts []chain.GenerateTarget
+	if flagGetUpdateBufModule(cmd) {
+		opts = append(opts, chain.GenerateProtoVendor())
+	}
+
+	err = c.Generate(cmd.Context(), cacheStorage, chain.GenerateHooks(output), opts...)
+	if err != nil {
 		return err
 	}
 

diff --git a/ignite/cmd/generate_openapi.go b/ignite/cmd/generate_openapi.go
@@ -39,7 +39,13 @@ func generateOpenAPIHandler(cmd *cobra.Command, _ []string) error {
 		return err
 	}
 
-	if err := c.Generate(cmd.Context(), cacheStorage, chain.GenerateOpenAPI()); err != nil {
+	var opts []chain.GenerateTarget
+	if flagGetUpdateBufModule(cmd) {
+		opts = append(opts, chain.GenerateProtoVendor())
+	}
+
+	err = c.Generate(cmd.Context(), cacheStorage, chain.GenerateOpenAPI(), opts...)
+	if err != nil {
 		return err
 	}
 

diff --git a/ignite/cmd/generate_pulsar.go b/ignite/cmd/generate_pulsar.go
@@ -40,8 +40,12 @@ func generatePulsarHandler(cmd *cobra.Command, _ []string) error {
 		return err
 	}
 
-	updateBufModule := flagGetUpdateBufModule(cmd)
-	err = c.Generate(cmd.Context(), cacheStorage, chain.GeneratePulsar(updateBufModule))
+	var opts []chain.GenerateTarget
+	if flagGetUpdateBufModule(cmd) {
+		opts = append(opts, chain.GenerateProtoVendor())
+	}
+
+	err = c.Generate(cmd.Context(), cacheStorage, chain.GeneratePulsar(), opts...)
 	if err != nil {
 		return err
 	}

diff --git a/ignite/cmd/generate_typescript_client.go b/ignite/cmd/generate_typescript_client.go
@@ -73,12 +73,12 @@ func generateTSClientHandler(cmd *cobra.Command, _ []string) error {
 		return err
 	}
 
-	updateBufModule := flagGetUpdateBufModule(cmd)
-	err = c.Generate(
-		cmd.Context(),
-		cacheStorage,
-		chain.GenerateTSClient(output, useCache, updateBufModule),
-	)
+	var opts []chain.GenerateTarget
+	if flagGetUpdateBufModule(cmd) {
+		opts = append(opts, chain.GenerateProtoVendor())
+	}
+
+	err = c.Generate(cmd.Context(), cacheStorage, chain.GenerateTSClient(output, useCache), opts...)
 	if err != nil {
 		return err
 	}

diff --git a/ignite/cmd/generate_vuex.go b/ignite/cmd/generate_vuex.go
@@ -45,7 +45,13 @@ func generateVuexHandler(cmd *cobra.Command, _ []string) error {
 		return err
 	}
 
-	if err := c.Generate(cmd.Context(), cacheStorage, chain.GenerateVuex(output)); err != nil {
+	var opts []chain.GenerateTarget
+	if flagGetUpdateBufModule(cmd) {
+		opts = append(opts, chain.GenerateProtoVendor())
+	}
+
+	err = c.Generate(cmd.Context(), cacheStorage, chain.GenerateVuex(output), opts...)
+	if err != nil {
 		return err
 	}
 

diff --git a/ignite/services/chain/generate.go b/ignite/services/chain/generate.go
@@ -16,7 +16,7 @@ import (
 
 type generateOptions struct {
 	useCache             bool
-	updateBufModule      bool
+	isProtoVendorEnabled bool
 	isGoEnabled          bool
 	isPulsarEnabled      bool
 	isTSClientEnabled    bool
@@ -34,31 +34,28 @@ type generateOptions struct {
 type GenerateTarget func(*generateOptions)
 
 // GenerateGo enables generating proto based Go code needed for the chain's source code.
-func GenerateGo(updateBufModule bool) GenerateTarget {
+func GenerateGo() GenerateTarget {
 	return func(o *generateOptions) {
 		o.isGoEnabled = true
-		o.updateBufModule = updateBufModule
 	}
 }
 
 // GeneratePulsar enables generating proto based Go code needed for the chain's source code.
-func GeneratePulsar(updateBufModule bool) GenerateTarget {
+func GeneratePulsar() GenerateTarget {
 	return func(o *generateOptions) {
 		o.isPulsarEnabled = true
-		o.updateBufModule = updateBufModule
 	}
 }
 
 // GenerateTSClient enables generating proto based Typescript Client.
 // The path assigns the output path to use for the generated Typescript client
 // overriding the configured or default path. Path can be an empty string.
-func GenerateTSClient(path string, useCache, updateBufModule bool) GenerateTarget {
+func GenerateTSClient(path string, useCache bool) GenerateTarget {
 	return func(o *generateOptions) {
 		o.isOpenAPIEnabled = true
 		o.isTSClientEnabled = true
 		o.tsClientPath = path
 		o.useCache = useCache
-		o.updateBufModule = updateBufModule
 	}
 }
 
@@ -99,6 +96,18 @@ func GenerateOpenAPI() GenerateTarget {
 	}
 }
 
+// GenerateProtoVendor enables `proto_vendor` folder generation.
+// Proto vendor is generated from Go dependencies that contain proto files that
+// are not included in the app's Buf config.
+// Enabling proto vendoring might update Buf config with missing dependencies
+// if a Go dependency contains proto files and a Buf config with a name that is
+// not listed in the Buf dependencies.
+func GenerateProtoVendor() GenerateTarget {
+	return func(o *generateOptions) {
+		o.isProtoVendorEnabled = true
+	}
+}
+
 // generateFromConfig makes code generation from proto files from the given config.
 func (c *Chain) generateFromConfig(ctx context.Context, cacheStorage cache.Storage, generateClients bool) error {
 	conf, err := c.Config()
@@ -115,7 +124,7 @@ func (c *Chain) generateFromConfig(ctx context.Context, cacheStorage cache.Stora
 
 	if generateClients {
 		if p := conf.Client.Typescript.Path; p != "" {
-			targets = append(targets, GenerateTSClient(p, true, false))
+			targets = append(targets, GenerateTSClient(p, true))
 		}
 
 		//nolint:staticcheck //ignore SA1019 until vuex config option is removed
@@ -133,7 +142,7 @@ func (c *Chain) generateFromConfig(ctx context.Context, cacheStorage cache.Stora
 	}
 
 	// Generate proto based code for Go and optionally for any optional targets
-	return c.Generate(ctx, cacheStorage, GenerateGo(false), targets...)
+	return c.Generate(ctx, cacheStorage, GenerateGo(), targets...)
 }
 
 // Generate makes code generation from proto files for given target and additionalTargets.
@@ -173,7 +182,7 @@ func (c *Chain) Generate(
 		options = append(options, cosmosgen.WithPulsarGeneration())
 	}
 
-	if targetOptions.updateBufModule {
+	if targetOptions.isProtoVendorEnabled {
 		options = append(options, cosmosgen.UpdateBufModule())
 	}