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

Reworked Error message in newParam() in services.go #1894

Merged
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
2 changes: 1 addition & 1 deletion internal/descriptor/services.go
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ func (r *Registry) newParam(meth *Method, path string) (Parameter, error) {
if IsWellKnownType(*target.TypeName) {
glog.V(2).Infoln("found well known aggregate type:", target)
} else {
return Parameter{}, fmt.Errorf("aggregate type %s in parameter of %s.%s: %s", target.Type, meth.Service.GetName(), meth.GetName(), path)
return Parameter{}, fmt.Errorf("%s.%s: %s is a protobuf message type. Protobuf message types cannot be used as path parameters, use a scalar value type (such as string) instead", meth.Service.GetName(), meth.GetName(), path)
}
}
return Parameter{
Expand Down
49 changes: 49 additions & 0 deletions internal/descriptor/services_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -1347,3 +1347,52 @@ func TestExtractServicesWithDeleteBody(t *testing.T) {
t.Log(err)
}
}

func TestCauseErrorWithPathParam(t *testing.T) {
src := `
name: "path/to/example.proto",
package: "example"
message_type <
name: "TypeMessage"
field <
name: "message"
type: TYPE_MESSAGE
type_name: 'ExampleMessage'
number: 1,
label: LABEL_OPTIONAL
>
>
service <
name: "ExampleService"
method <
name: "Echo"
input_type: "TypeMessage"
output_type: "TypeMessage"
options <
[google.api.http] <
get: "/v1/example/echo/{message=*}"
>
>
>
>
`
var fd descriptorpb.FileDescriptorProto
if err := prototext.Unmarshal([]byte(src), &fd); err != nil {
t.Fatalf("proto.UnmarshalText(%s, &fd) failed with %v; want success", src, err)
}
target := "path/to/example.proto"
reg := NewRegistry()
input := []*descriptorpb.FileDescriptorProto{&fd}
reg.loadFile(fd.GetName(), &protogen.File{
Proto: &fd,
})
// switch this field to see the error
wantErr := true
err := reg.loadServices(reg.files[target])
if got, want := err != nil, wantErr; got != want {
if want {
t.Errorf("loadServices(%q, %q) succeeded; want an error", target, input)
}
t.Errorf("loadServices(%q, %q) failed with %v; want success", target, input, err)
}
}