feat(transport/http/binding): add option to control using proto text name as key during URL encoding

Author: demoManito

Diff for: api/metadata/metadata.pb.go

@@ -7,18 +7,18 @@ import (
 	"regexp"
 	"strings"
 
-	"google.golang.org/protobuf/reflect/protoreflect"
-
 	"google.golang.org/genproto/googleapis/api/annotations"
 	"google.golang.org/protobuf/compiler/protogen"
 	"google.golang.org/protobuf/proto"
+	"google.golang.org/protobuf/reflect/protoreflect"
 	"google.golang.org/protobuf/types/descriptorpb"
 )
 
 const (
-	contextPackage       = protogen.GoImportPath("context")
-	transportHTTPPackage = protogen.GoImportPath("github.com/go-kratos/kratos/v2/transport/http")
-	bindingPackage       = protogen.GoImportPath("github.com/go-kratos/kratos/v2/transport/http/binding")
+	contextPackage          = protogen.GoImportPath("context")
+	transportHTTPPackage    = protogen.GoImportPath("github.com/go-kratos/kratos/v2/transport/http")
+	bindingPackage          = protogen.GoImportPath("github.com/go-kratos/kratos/v2/transport/http/binding")
+	formEncodeOptionPackage = protogen.GoImportPath("github.com/go-kratos/kratos/v2/encoding/form/option")
 )
 
 var methodSets = make(map[string]int)
@@ -55,6 +55,7 @@ func generateFileContent(gen *protogen.Plugin, file *protogen.File, g *protogen.
 	g.P("// is compatible with the kratos package it is being compiled against.")
 	g.P("var _ = new(", contextPackage.Ident("Context"), ")")
 	g.P("var _ = ", bindingPackage.Ident("EncodeURL"))
+	g.P("var _ = ", formEncodeOptionPackage.Ident("Encode"))
 	g.P("const _ = ", transportHTTPPackage.Ident("SupportPackageIsVersion1"))
 	g.P()
 
@@ -209,15 +210,16 @@ func buildMethodDesc(g *protogen.GeneratedFile, m *protogen.Method, method, path
 		comment = "// " + m.GoName + strings.TrimPrefix(strings.TrimSuffix(comment, "\n"), "//")
 	}
 	return &methodDesc{
-		Name:         m.GoName,
-		OriginalName: string(m.Desc.Name()),
-		Num:          methodSets[m.GoName],
-		Request:      g.QualifiedGoIdent(m.Input.GoIdent),
-		Reply:        g.QualifiedGoIdent(m.Output.GoIdent),
-		Comment:      comment,
-		Path:         path,
-		Method:       method,
-		HasVars:      len(vars) > 0,
+		Name:                  m.GoName,
+		OriginalName:          string(m.Desc.Name()),
+		Num:                   methodSets[m.GoName],
+		Request:               g.QualifiedGoIdent(m.Input.GoIdent),
+		Reply:                 g.QualifiedGoIdent(m.Output.GoIdent),
+		Comment:               comment,
+		Path:                  path,
+		Method:                method,
+		HasVars:               len(vars) > 0,
+		UseProtoTextEncodeURL: *isUseProtoTextEncodeURL,
 	}
 }
 

Diff for: api/metadata/metadata_grpc.pb.go

@@ -70,7 +70,7 @@ func New{{.ServiceType}}HTTPClient (client *http.Client) {{.ServiceType}}HTTPCli
 func (c *{{$svrType}}HTTPClientImpl) {{.Name}}(ctx context.Context, in *{{.Request}}, opts ...http.CallOption) (*{{.Reply}}, error) {
 	var out {{.Reply}}
 	pattern := "{{.Path}}"
-	path := binding.EncodeURL(pattern, in, {{not .HasBody}})
+	path := binding.EncodeURL(pattern, in, {{not .HasBody}}, option.Encode().UseProtoTextAsKey({{.UseProtoTextEncodeURL}}))
 	opts = append(opts, http.Operation(Operation{{$svrType}}{{.OriginalName}}))
 	opts = append(opts, http.PathTemplate(pattern))
 	{{if .HasBody -}}

Diff for: api/metadata/metadata_http.pb.go

@@ -9,9 +9,10 @@ import (
 )
 
 var (
-	showVersion     = flag.Bool("version", false, "print the version and exit")
-	omitempty       = flag.Bool("omitempty", true, "omit if google.api is empty")
-	omitemptyPrefix = flag.String("omitempty_prefix", "", "omit if google.api is empty")
+	showVersion             = flag.Bool("version", false, "print the version and exit")
+	omitempty               = flag.Bool("omitempty", true, "omit if google.api is empty")
+	omitemptyPrefix         = flag.String("omitempty_prefix", "", "omit if google.api is empty")
+	isUseProtoTextEncodeURL = flag.Bool("prototext_encodeurl", false, "use proto text name as params form key")
 )
 
 func main() {

Diff for: cmd/protoc-gen-go-http/http.go

@@ -27,12 +27,13 @@ type methodDesc struct {
 	Reply        string
 	Comment      string
 	// http_rule
-	Path         string
-	Method       string
-	HasVars      bool
-	HasBody      bool
-	Body         string
-	ResponseBody string
+	Path                  string
+	Method                string
+	HasVars               bool
+	HasBody               bool
+	Body                  string
+	ResponseBody          string
+	UseProtoTextEncodeURL bool
 }
 
 func (s *serviceDesc) execute() string {

Diff for: cmd/protoc-gen-go-http/httpTemplate.tpl

@@ -27,8 +27,8 @@ var (
 var tagName = "json"
 
 func init() {
-	decoder.SetTagName(tagName)
 	encoder.SetTagName(tagName)
+	decoder.SetTagName(tagName)
 	encoding.RegisterCodec(codec{encoder: encoder, decoder: decoder})
 }
 

Diff for: cmd/protoc-gen-go-http/main.go

@@ -12,6 +12,7 @@ import (
 	"google.golang.org/protobuf/types/known/wrapperspb"
 
 	"github.com/go-kratos/kratos/v2/encoding"
+	"github.com/go-kratos/kratos/v2/encoding/form/option"
 	bdtest "github.com/go-kratos/kratos/v2/internal/testdata/binding"
 	"github.com/go-kratos/kratos/v2/internal/testdata/complex"
 	ectest "github.com/go-kratos/kratos/v2/internal/testdata/encoding"
@@ -264,7 +265,12 @@ func TestEncodeFieldMask(t *testing.T) {
 	req := &bdtest.HelloRequest{
 		UpdateMask: &fieldmaskpb.FieldMask{Paths: []string{"foo", "bar"}},
 	}
-	if v := EncodeFieldMask(req.ProtoReflect()); v != "updateMask=foo,bar" {
+	v := EncodeFieldMask(req.ProtoReflect())
+	if v != "updateMask=foo,bar" {
+		t.Errorf("got %s", v)
+	}
+	v = EncodeFieldMask(req.ProtoReflect(), option.Encode().UseProtoTextAsKey(true))
+	if v != "update_mask=foo,bar" {
 		t.Errorf("got %s", v)
 	}
 }
@@ -280,4 +286,9 @@ func TestOptional(t *testing.T) {
 	if query.Encode() != "name=foo&optInt32=100&sub.naming=bar" {
 		t.Fatalf("got %s", query.Encode())
 	}
+
+	query, _ = EncodeValues(req, option.Encode().UseProtoTextAsKey(true))
+	if query.Encode() != "name=foo&opt_int32=100&sub.naming=bar" {
+		t.Fatalf("got %s", query.Encode())
+	}
 }

Diff for: cmd/protoc-gen-go-http/template.go

@@ -0,0 +1,32 @@
+package option
+
+// EncodeOption is the encoding options.
+type EncodeOption struct {
+	ForceProtoTextAsKey bool // forces to use proto field text name.
+}
+
+// Encode creates a new EncodeOption instance.
+func Encode() *EncodeOption {
+	return &EncodeOption{}
+}
+
+// UseProtoTextAsKey forces to use proto field text name as key.
+func (opt *EncodeOption) UseProtoTextAsKey(isUse bool) *EncodeOption {
+	opt.ForceProtoTextAsKey = isUse
+	return opt
+}
+
+// MergeEncodeOptions merges the options.
+func MergeEncodeOptions(opts ...*EncodeOption) *EncodeOption {
+	opt := new(EncodeOption)
+	for _, o := range opts {
+		if o == nil {
+			continue
+		}
+
+		if o.ForceProtoTextAsKey {
+			opt.ForceProtoTextAsKey = true
+		}
+	}
+	return opt
+}

Diff for: encoding/form/form.go

@@ -0,0 +1,40 @@
+package option
+
+import "testing"
+
+func TestEncodeOption_UseProtoTextAsKey(t *testing.T) {
+	e := Encode().UseProtoTextAsKey(true)
+	if e.ForceProtoTextAsKey != true {
+		t.Error("expect true")
+	}
+	e = Encode().UseProtoTextAsKey(false)
+	if e.ForceProtoTextAsKey != false {
+		t.Error("expect false")
+	}
+}
+
+func TestMergeEncodeOptions(t *testing.T) {
+	opt := MergeEncodeOptions(nil)
+	if opt == nil {
+		t.Fatal("expect not nil")
+	}
+	if opt.ForceProtoTextAsKey {
+		t.Error("expect false")
+	}
+
+	opt = MergeEncodeOptions(Encode().UseProtoTextAsKey(true))
+	if opt == nil {
+		t.Fatal("expect not nil")
+	}
+	if !opt.ForceProtoTextAsKey {
+		t.Error("expect true")
+	}
+
+	opt = MergeEncodeOptions(&EncodeOption{}, Encode().UseProtoTextAsKey(true))
+	if opt == nil {
+		t.Fatal("expect not nil")
+	}
+	if !opt.ForceProtoTextAsKey {
+		t.Error("expect true")
+	}
+}