Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

< feat>[encoding/form]: support json format in query string #3519

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 17 additions & 3 deletions encoding/form/proto_decode.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import (
"google.golang.org/protobuf/proto"
"google.golang.org/protobuf/reflect/protoreflect"
"google.golang.org/protobuf/reflect/protoregistry"
"google.golang.org/protobuf/types/dynamicpb"
"google.golang.org/protobuf/types/known/durationpb"
"google.golang.org/protobuf/types/known/fieldmaskpb"
"google.golang.org/protobuf/types/known/structpb"
Expand All @@ -26,11 +27,16 @@ var errInvalidFormatMapKey = errors.New("invalid formatting for map key")

// DecodeValues decode url value into proto message.
func DecodeValues(msg proto.Message, values url.Values) error {
for key, values := range values {
if err := populateFieldValues(msg.ProtoReflect(), strings.Split(key, "."), values); err != nil {
dynamicMessage := dynamicpb.NewMessage(msg.ProtoReflect().Descriptor())

for key, vals := range values {
if err := populateFieldValues(dynamicMessage, strings.Split(key, "."), vals); err != nil {
return err
}
}

proto.Merge(msg, dynamicMessage)

return nil
}

Expand Down Expand Up @@ -325,8 +331,16 @@ func parseMessage(md protoreflect.MessageDescriptor, value string) (protoreflect
}
msg = &v
default:
return protoreflect.Value{}, fmt.Errorf("unsupported message type: %q", string(md.FullName()))
msg = dynamicpb.NewMessage(md)
if err := protojson.Unmarshal([]byte(value), msg); err != nil {
return protoreflect.Value{}, err
}
}

if msg == nil {
return protoreflect.Value{}, nil
}

return protoreflect.ValueOfMessage(msg.ProtoReflect()), nil
}

Expand Down
58 changes: 58 additions & 0 deletions encoding/form/proto_decode_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import (
"strconv"
"testing"

"google.golang.org/protobuf/encoding/protojson"
"google.golang.org/protobuf/reflect/protoreflect"

"github.com/go-kratos/kratos/v2/internal/testdata/complex"
Expand Down Expand Up @@ -48,6 +49,63 @@ func TestDecodeValues(t *testing.T) {
}
}

func TestDecodeJsonValues(t *testing.T) {
origin := &complex.ComplexField{
Name: "ComplexField",
Inner1: &complex.Inner1{
Name: "Inner1",
Sex: complex.Sex_man,
},
Inner2: []*complex.Inner2{
{
Name: "Inner11",
Inner1: []*complex.Inner1{
{
Name: "Inner111",
Sex: complex.Sex_man,
},
},
},
{
Name: "Inner12",
Inner1: []*complex.Inner1{
{
Name: "Inner121",
Sex: complex.Sex_man,
},
{
Name: "Inner122",
Sex: complex.Sex_woman,
},
},
},
},
}
data, err := protojson.Marshal(origin)
if err != nil {
t.Fatal(err)
}

// url.ParseQuery("complex_field={"name":"ComplexField", "inner1":{"name":"Inner1"}, "inner2":[{"name":"Inner11", "inner1":[{"name":"Inner111"}]}, {"name":"Inner12", "inner1":[{"name":"Inner121"}, {"name":"Inner122", "sex":"woman"}]}]}")
form, err := url.ParseQuery(fmt.Sprintf("complex_field=%s", string(data)))
if err != nil {
t.Fatal(err)
}

comp := &complex.Complex{Age: 10}
err = DecodeValues(comp, form)
if err != nil {
t.Fatal(err)
}
if !reflect.DeepEqual(origin, comp.ComplexField) {
t.Errorf("want %v, got %v", origin, comp.ComplexField)
}
// check if age is not overridden
if comp.Age != 10 {
t.Errorf("want %v, got %v", "10", comp.Age)
}
}

func TestGetFieldDescriptor(t *testing.T) {
comp := &complex.Complex{}

Expand Down
Loading