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.

Sign up for GitHub

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

Add message field to the error message emitted by grpc-gateway #718

Merged
merged 3 commits into from
Aug 3, 2018
Merged

Add message field to the error message emitted by grpc-gateway #718

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a0cc7d7
Add message field to the error message emitted by grpc-gateway to mak…
ffredsh Aug 2, 2018
5f265ad
Fix indentation issue
ffredsh Aug 2, 2018
1283180
Add link to status proto in comment
ffredsh Aug 2, 2018
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
4 changes: 4 additions & 0 deletions runtime/errors.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,9 @@ var (

type errorBody struct {
Error string `protobuf:"bytes,1,name=error" json:"error"`
// This is to make the error more compatible with users that expect errors to be Status objects. It should be
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you add a link to https://github.com/grpc/grpc/blob/master/src/proto/grpc/status/status.proto?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done!

// the exact same message as the Error field.
Message string `protobuf:"bytes,1,name=message" json:"message"`
Code int32 `protobuf:"varint,2,name=code" json:"code"`
Details []*any.Any `protobuf:"bytes,3,rep,name=details" json:"details,omitempty"`
}
Expand Down Expand Up @@ -94,6 +97,7 @@ func DefaultHTTPError(ctx context.Context, mux *ServeMux, marshaler Marshaler, w

body := &errorBody{
Error: s.Message(),
Message: s.Message(),
Code: int32(s.Code()),
Details: s.Proto().GetDetails(),
}
Expand Down
3 changes: 3 additions & 0 deletions runtime/errors_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,9 @@ func TestDefaultHTTPError(t *testing.T) {
if got, want := body["error"].(string), spec.msg; !strings.Contains(got, want) {
t.Errorf(`body["error"] = %q; want %q; on spec.err=%v`, got, want, spec.err)
}
if got, want := body["message"].(string), spec.msg; !strings.Contains(got, want) {
t.Errorf(`body["message"] = %q; want %q; on spec.err=%v`, got, want, spec.err)
}

if spec.details != "" {
details, ok := body["details"].([]interface{})
Expand Down