refactor: upgrade protoc-gen-grpc-gateway to use the new Go code generator (#1668)

adambabik · web-flow · commit ad1c1bb26c2d · 2020-09-15T11:05:56.000+01:00
* refactor: upgrade protoc-gen-grpc-gateway to use the new Go code generator

This change upgrades protoc-gen-grpc-gateway to use
google.golang.org/protobuf/compiler/protogen
which is the new package for writing protoc plugins
generating Go code.

It also fixes all places to use packages from
google.golang.org/protobuf module instead of
github.com/golang/protobuf.

Signed-off-by: Adam Babik &lt;a.babik@designfortress.com&gt;

* refactor: regenerate BUILD.bazel files

Signed-off-by: Adam Babik &lt;a.babik@designfortress.com&gt;
diff --git a/internal/codegenerator/BUILD.bazel b/internal/codegenerator/BUILD.bazel
@@ -10,8 +10,8 @@ go_library(
     ],
     importpath = "github.com/grpc-ecosystem/grpc-gateway/v2/internal/codegenerator",
     deps = [
-        "@io_bazel_rules_go//proto/wkt:compiler_plugin_go_proto",
         "@org_golang_google_protobuf//proto:go_default_library",
+        "@org_golang_google_protobuf//types/pluginpb:go_default_library",
     ],
 )
 
@@ -21,8 +21,8 @@ go_test(
     embed = [":go_default_library"],
     deps = [
         "@com_github_google_go_cmp//cmp:go_default_library",
-        "@io_bazel_rules_go//proto/wkt:compiler_plugin_go_proto",
         "@org_golang_google_protobuf//proto:go_default_library",
         "@org_golang_google_protobuf//testing/protocmp:go_default_library",
+        "@org_golang_google_protobuf//types/pluginpb:go_default_library",
     ],
 )
diff --git a/internal/codegenerator/parse_req.go b/internal/codegenerator/parse_req.go
@@ -5,8 +5,8 @@ import (
 	"io"
 	"io/ioutil"
 
-	pluginpb "github.com/golang/protobuf/protoc-gen-go/plugin"
 	"google.golang.org/protobuf/proto"
+	"google.golang.org/protobuf/types/pluginpb"
 )
 
 // ParseRequest parses a code generator request from a proto Message.
diff --git a/internal/codegenerator/parse_req_test.go b/internal/codegenerator/parse_req_test.go
@@ -8,11 +8,11 @@ import (
 	"strings"
 	"testing"
 
-	pluginpb "github.com/golang/protobuf/protoc-gen-go/plugin"
 	"github.com/google/go-cmp/cmp"
 	"github.com/grpc-ecosystem/grpc-gateway/v2/internal/codegenerator"
 	"google.golang.org/protobuf/proto"
 	"google.golang.org/protobuf/testing/protocmp"
+	"google.golang.org/protobuf/types/pluginpb"
 )
 
 var parseReqTests = []struct {
diff --git a/internal/descriptor/BUILD.bazel b/internal/descriptor/BUILD.bazel
@@ -18,10 +18,10 @@ go_library(
         "@com_github_ghodss_yaml//:go_default_library",
         "@com_github_golang_glog//:go_default_library",
         "@go_googleapis//google/api:annotations_go_proto",
-        "@io_bazel_rules_go//proto/wkt:compiler_plugin_go_proto",
-        "@io_bazel_rules_go//proto/wkt:descriptor_go_proto",
         "@org_golang_google_protobuf//encoding/protojson:go_default_library",
         "@org_golang_google_protobuf//proto:go_default_library",
+        "@org_golang_google_protobuf//types/descriptorpb:go_default_library",
+        "@org_golang_google_protobuf//types/pluginpb:go_default_library",
     ],
 )
 
@@ -37,9 +37,9 @@ go_test(
     embed = [":go_default_library"],
     deps = [
         "//internal/httprule:go_default_library",
-        "@io_bazel_rules_go//proto/wkt:compiler_plugin_go_proto",
-        "@io_bazel_rules_go//proto/wkt:descriptor_go_proto",
         "@org_golang_google_protobuf//encoding/prototext:go_default_library",
         "@org_golang_google_protobuf//proto:go_default_library",
+        "@org_golang_google_protobuf//types/descriptorpb:go_default_library",
+        "@org_golang_google_protobuf//types/pluginpb:go_default_library",
     ],
 )
diff --git a/internal/descriptor/registry.go b/internal/descriptor/registry.go
@@ -7,9 +7,9 @@ import (
 	"strings"
 
 	"github.com/golang/glog"
-	descriptorpb "github.com/golang/protobuf/protoc-gen-go/descriptor"
-	pluginpb "github.com/golang/protobuf/protoc-gen-go/plugin"
 	"google.golang.org/genproto/googleapis/api/annotations"
+	"google.golang.org/protobuf/types/descriptorpb"
+	"google.golang.org/protobuf/types/pluginpb"
 )
 
 // Registry is a registry of information extracted from pluginpb.CodeGeneratorRequest.
diff --git a/internal/descriptor/registry_test.go b/internal/descriptor/registry_test.go
@@ -3,9 +3,9 @@ package descriptor
 import (
 	"testing"
 
-	descriptorpb "github.com/golang/protobuf/protoc-gen-go/descriptor"
-	pluginpb "github.com/golang/protobuf/protoc-gen-go/plugin"
 	"google.golang.org/protobuf/encoding/prototext"
+	"google.golang.org/protobuf/types/descriptorpb"
+	"google.golang.org/protobuf/types/pluginpb"
 )
 
 func loadFile(t *testing.T, reg *Registry, src string) *descriptorpb.FileDescriptorProto {
diff --git a/internal/descriptor/services.go b/internal/descriptor/services.go
@@ -5,10 +5,10 @@ import (
 	"strings"
 
 	"github.com/golang/glog"
-	descriptorpb "github.com/golang/protobuf/protoc-gen-go/descriptor"
 	"github.com/grpc-ecosystem/grpc-gateway/v2/internal/httprule"
 	options "google.golang.org/genproto/googleapis/api/annotations"
 	"google.golang.org/protobuf/proto"
+	"google.golang.org/protobuf/types/descriptorpb"
 )
 
 // loadServices registers services and their methods from "targetFile" to "r".
@@ -37,7 +37,7 @@ func (r *Registry) loadServices(file *File) error {
 			}
 			if len(optsList) == 0 {
 				logFn := glog.V(1).Infof
-				if  r.warnOnUnboundMethods {
+				if r.warnOnUnboundMethods {
 					logFn = glog.Warningf
 				}
 				logFn("No HttpRule found for method: %s.%s", svc.GetName(), md.GetName())
diff --git a/internal/descriptor/services_test.go b/internal/descriptor/services_test.go
@@ -4,10 +4,10 @@ import (
 	"reflect"
 	"testing"
 
-	descriptorpb "github.com/golang/protobuf/protoc-gen-go/descriptor"
 	"github.com/grpc-ecosystem/grpc-gateway/v2/internal/httprule"
 	"google.golang.org/protobuf/encoding/prototext"
 	"google.golang.org/protobuf/proto"
+	"google.golang.org/protobuf/types/descriptorpb"
 )
 
 func compilePath(t *testing.T, path string) httprule.Template {
diff --git a/internal/descriptor/types.go b/internal/descriptor/types.go
@@ -4,9 +4,10 @@ import (
 	"fmt"
 	"strings"
 
-	descriptorpb "github.com/golang/protobuf/protoc-gen-go/descriptor"
 	"github.com/grpc-ecosystem/grpc-gateway/v2/internal/casing"
 	"github.com/grpc-ecosystem/grpc-gateway/v2/internal/httprule"
+	"google.golang.org/protobuf/types/descriptorpb"
+	"google.golang.org/protobuf/types/pluginpb"
 )
 
 // IsWellKnownType returns true if the provided fully qualified type name is considered 'well-known'.
@@ -41,7 +42,7 @@ func (p GoPackage) String() string {
 // File wraps descriptorpb.FileDescriptorProto for richer features.
 type File struct {
 	*descriptorpb.FileDescriptorProto
-	// GoPkg is the go package of the go file generated from this file..
+	// GoPkg is the go package of the go file generated from this file.
 	GoPkg GoPackage
 	// Messages is the list of messages defined in this file.
 	Messages []*Message
@@ -65,6 +66,14 @@ func (f *File) proto2() bool {
 	return f.Syntax == nil || f.GetSyntax() == "proto2"
 }
 
+// ResponseFile wraps pluginpb.CodeGeneratorResponse_File.
+type ResponseFile struct {
+	*pluginpb.CodeGeneratorResponse_File
+
+	// GoPkg is the Go package of the generated file.
+	GoPkg GoPackage
+}
+
 // Message describes a protocol buffer message types
 type Message struct {
 	// File is the file where the message is defined
diff --git a/internal/descriptor/types_test.go b/internal/descriptor/types_test.go
@@ -3,8 +3,8 @@ package descriptor
 import (
 	"testing"
 
-	descriptorpb "github.com/golang/protobuf/protoc-gen-go/descriptor"
 	"google.golang.org/protobuf/encoding/prototext"
+	"google.golang.org/protobuf/types/descriptorpb"
 )
 
 func TestGoPackageStandard(t *testing.T) {
diff --git a/internal/generator/BUILD.bazel b/internal/generator/BUILD.bazel
@@ -6,8 +6,5 @@ go_library(
     name = "go_default_library",
     srcs = ["generator.go"],
     importpath = "github.com/grpc-ecosystem/grpc-gateway/v2/internal/generator",
-    deps = [
-        "//internal/descriptor:go_default_library",
-        "@io_bazel_rules_go//proto/wkt:compiler_plugin_go_proto",
-    ],
+    deps = ["//internal/descriptor:go_default_library"],
 )
diff --git a/internal/generator/generator.go b/internal/generator/generator.go
@@ -2,12 +2,11 @@
 package generator
 
 import (
-	pluginpb "github.com/golang/protobuf/protoc-gen-go/plugin"
-	descriptorpb "github.com/grpc-ecosystem/grpc-gateway/v2/internal/descriptor"
+	"github.com/grpc-ecosystem/grpc-gateway/v2/internal/descriptor"
 )
 
 // Generator is an abstraction of code generators.
 type Generator interface {
 	// Generate generates output files from input .proto files.
-	Generate(targets []*descriptorpb.File) ([]*pluginpb.CodeGeneratorResponse_File, error)
+	Generate(targets []*descriptor.File) ([]*descriptor.ResponseFile, error)
 }
diff --git a/protoc-gen-grpc-gateway/BUILD.bazel b/protoc-gen-grpc-gateway/BUILD.bazel
@@ -8,12 +8,10 @@ go_library(
     srcs = ["main.go"],
     importpath = "github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway",
     deps = [
-        "//internal/codegenerator:go_default_library",
         "//internal/descriptor:go_default_library",
         "//protoc-gen-grpc-gateway/internal/gengateway:go_default_library",
         "@com_github_golang_glog//:go_default_library",
-        "@io_bazel_rules_go//proto/wkt:compiler_plugin_go_proto",
-        "@org_golang_google_protobuf//proto:go_default_library",
+        "@org_golang_google_protobuf//compiler/protogen:go_default_library",
     ],
 )
 
diff --git a/protoc-gen-grpc-gateway/internal/gengateway/BUILD.bazel b/protoc-gen-grpc-gateway/internal/gengateway/BUILD.bazel
@@ -16,8 +16,8 @@ go_library(
         "//internal/generator:go_default_library",
         "//utilities:go_default_library",
         "@com_github_golang_glog//:go_default_library",
-        "@io_bazel_rules_go//proto/wkt:compiler_plugin_go_proto",
         "@org_golang_google_protobuf//proto:go_default_library",
+        "@org_golang_google_protobuf//types/pluginpb:go_default_library",
     ],
 )
 
@@ -32,7 +32,7 @@ go_test(
     deps = [
         "//internal/descriptor:go_default_library",
         "//internal/httprule:go_default_library",
-        "@io_bazel_rules_go//proto/wkt:descriptor_go_proto",
         "@org_golang_google_protobuf//proto:go_default_library",
+        "@org_golang_google_protobuf//types/descriptorpb:go_default_library",
     ],
 )
diff --git a/protoc-gen-grpc-gateway/internal/gengateway/generator.go b/protoc-gen-grpc-gateway/internal/gengateway/generator.go
@@ -9,10 +9,10 @@ import (
 	"strings"
 
 	"github.com/golang/glog"
-	pluginpb "github.com/golang/protobuf/protoc-gen-go/plugin"
 	"github.com/grpc-ecosystem/grpc-gateway/v2/internal/descriptor"
 	gen "github.com/grpc-ecosystem/grpc-gateway/v2/internal/generator"
 	"google.golang.org/protobuf/proto"
+	"google.golang.org/protobuf/types/pluginpb"
 )
 
 var (
@@ -93,10 +93,11 @@ func New(reg *descriptor.Registry, useRequestContext bool, registerFuncSuffix, p
 	}
 }
 
-func (g *generator) Generate(targets []*descriptor.File) ([]*pluginpb.CodeGeneratorResponse_File, error) {
-	var files []*pluginpb.CodeGeneratorResponse_File
+func (g *generator) Generate(targets []*descriptor.File) ([]*descriptor.ResponseFile, error) {
+	var files []*descriptor.ResponseFile
 	for _, file := range targets {
 		glog.V(1).Infof("Processing %s", file.GetName())
+
 		code, err := g.generate(file)
 		if err == errNoTargetService {
 			glog.V(1).Infof("%s: %v", file.GetName(), err)
@@ -110,19 +111,22 @@ func (g *generator) Generate(targets []*descriptor.File) ([]*pluginpb.CodeGenera
 			glog.Errorf("%v: %s", err, code)
 			return nil, err
 		}
+
 		name, err := g.getFilePath(file)
 		if err != nil {
 			glog.Errorf("%v: %s", err, code)
 			return nil, err
 		}
 		ext := filepath.Ext(name)
 		base := strings.TrimSuffix(name, ext)
-		output := fmt.Sprintf("%s.pb.gw.go", base)
-		files = append(files, &pluginpb.CodeGeneratorResponse_File{
-			Name:    proto.String(output),
-			Content: proto.String(string(formatted)),
+		filename := fmt.Sprintf("%s.pb.gw.go", base)
+		files = append(files, &descriptor.ResponseFile{
+			GoPkg: file.GoPkg,
+			CodeGeneratorResponse_File: &pluginpb.CodeGeneratorResponse_File{
+				Name:    proto.String(filename),
+				Content: proto.String(string(formatted)),
+			},
 		})
-		glog.V(1).Infof("Will emit %s", output)
 	}
 	return files, nil
 }
diff --git a/protoc-gen-grpc-gateway/internal/gengateway/generator_test.go b/protoc-gen-grpc-gateway/internal/gengateway/generator_test.go
@@ -6,9 +6,9 @@ import (
 	"strings"
 	"testing"
 
-	descriptorpb "github.com/golang/protobuf/protoc-gen-go/descriptor"
 	"github.com/grpc-ecosystem/grpc-gateway/v2/internal/descriptor"
 	"google.golang.org/protobuf/proto"
+	"google.golang.org/protobuf/types/descriptorpb"
 )
 
 func newExampleFileDescriptor() *descriptor.File {
diff --git a/protoc-gen-grpc-gateway/internal/gengateway/template_test.go b/protoc-gen-grpc-gateway/internal/gengateway/template_test.go
@@ -4,10 +4,10 @@ import (
 	"strings"
 	"testing"
 
-	descriptorpb "github.com/golang/protobuf/protoc-gen-go/descriptor"
 	"github.com/grpc-ecosystem/grpc-gateway/v2/internal/descriptor"
 	"github.com/grpc-ecosystem/grpc-gateway/v2/internal/httprule"
 	"google.golang.org/protobuf/proto"
+	"google.golang.org/protobuf/types/descriptorpb"
 )
 
 func crossLinkFixture(f *descriptor.File) *descriptor.File {
diff --git a/protoc-gen-grpc-gateway/main.go b/protoc-gen-grpc-gateway/main.go
diff --git a/protoc-gen-openapiv2/BUILD.bazel b/protoc-gen-openapiv2/BUILD.bazel
diff --git a/protoc-gen-openapiv2/internal/genopenapi/BUILD.bazel b/protoc-gen-openapiv2/internal/genopenapi/BUILD.bazel
diff --git a/protoc-gen-openapiv2/internal/genopenapi/generator.go b/protoc-gen-openapiv2/internal/genopenapi/generator.go
diff --git a/protoc-gen-openapiv2/internal/genopenapi/template.go b/protoc-gen-openapiv2/internal/genopenapi/template.go
diff --git a/protoc-gen-openapiv2/internal/genopenapi/template_test.go b/protoc-gen-openapiv2/internal/genopenapi/template_test.go
diff --git a/protoc-gen-openapiv2/main.go b/protoc-gen-openapiv2/main.go

Original file line number	Diff line number	Diff line change
`@@ -5,8 +5,8 @@ import (`
`5`	`5`	`"io"`
`6`	`6`	`"io/ioutil"`
`7`	`7`
`8`		`- pluginpb "github.com/golang/protobuf/protoc-gen-go/plugin"`
`9`	`8`	`"google.golang.org/protobuf/proto"`
	`9`	`+ "google.golang.org/protobuf/types/pluginpb"`
`10`	`10`	`)`
`11`	`11`
`12`	`12`	`// ParseRequest parses a code generator request from a proto Message.`
Original file line number	Diff line number	Diff line change
`@@ -5,10 +5,10 @@ import (`
`5`	`5`	`"strings"`
`6`	`6`
`7`	`7`	`"github.com/golang/glog"`
`8`		`- descriptorpb "github.com/golang/protobuf/protoc-gen-go/descriptor"`
`9`	`8`	`"github.com/grpc-ecosystem/grpc-gateway/v2/internal/httprule"`
`10`	`9`	`options "google.golang.org/genproto/googleapis/api/annotations"`
`11`	`10`	`"google.golang.org/protobuf/proto"`
	`11`	`+ "google.golang.org/protobuf/types/descriptorpb"`
`12`	`12`	`)`
`13`	`13`
`14`	`14`	`// loadServices registers services and their methods from "targetFile" to "r".`
`@@ -37,7 +37,7 @@ func (r Registry) loadServices(file File) error {`
`37`	`37`	`}`
`38`	`38`	`if len(optsList) == 0 {`
`39`	`39`	`logFn := glog.V(1).Infof`
`40`		`- if r.warnOnUnboundMethods {`
	`40`	`+ if r.warnOnUnboundMethods {`
`41`	`41`	`logFn = glog.Warningf`
`42`	`42`	`}`
`43`	`43`	`logFn("No HttpRule found for method: %s.%s", svc.GetName(), md.GetName())`
Original file line number	Diff line number	Diff line change
`@@ -3,8 +3,8 @@ package descriptor`
`3`	`3`	`import (`
`4`	`4`	`"testing"`
`5`	`5`
`6`		`- descriptorpb "github.com/golang/protobuf/protoc-gen-go/descriptor"`
`7`	`6`	`"google.golang.org/protobuf/encoding/prototext"`
	`7`	`+ "google.golang.org/protobuf/types/descriptorpb"`
`8`	`8`	`)`
`9`	`9`
`10`	`10`	`func TestGoPackageStandard(t *testing.T) {`