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

Fix grpc transcoding content type not matching response body #8312

Merged
merged 4 commits into from
Sep 24, 2019
Merged

Fix grpc transcoding content type not matching response body #8312

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bd38dd1
When trailer indicates a gRPC error and there was no HTTP body, ensur…
nareddyt Sep 20, 2019
659a6d9
Ensure this applies only to streaming empty gRPC responses.
nareddyt Sep 20, 2019
49d3fab
Format
nareddyt Sep 20, 2019
ad93445
Add another test case
nareddyt Sep 21, 2019
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
8 changes: 8 additions & 0 deletions source/extensions/filters/http/grpc_json_transcoder/json_transcoder_filter.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -400,9 +400,17 @@ Http::FilterHeadersStatus JsonTranscoderFilter::encodeHeaders(Http::HeaderMap& h
response_headers_ = &headers;

if (end_stream) {

if (method_->server_streaming()) {
// When there is no body in a streaming response, a empty JSON array is
// returned by default. Set the content type correctly.
headers.insertContentType().value().setReference(Http::Headers::get().ContentTypeValues.Json);
}

// In gRPC wire protocol, headers frame with end_stream is a trailers-only response.
// The return value from encodeTrailers is ignored since it is always continue.
encodeTrailers(headers);

return Http::FilterHeadersStatus::Continue;
}

Expand Down
19 changes: 19 additions & 0 deletions test/extensions/filters/http/grpc_json_transcoder/grpc_json_transcoder_integration_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -430,6 +430,8 @@ TEST_P(GrpcJsonTranscoderIntegrationTest, BindingAndBody) {

TEST_P(GrpcJsonTranscoderIntegrationTest, ServerStreamingGet) {
HttpIntegrationTest::initialize();

// 1: Normal streaming get
testTranscoding<bookstore::ListBooksRequest, bookstore::Book>(
Http::TestHeaderMapImpl{
{":method", "GET"}, {":path", "/shelves/1/books"}, {":authority", "host"}},
Expand All @@ -439,6 +441,22 @@ TEST_P(GrpcJsonTranscoderIntegrationTest, ServerStreamingGet) {
Status(), Http::TestHeaderMapImpl{{":status", "200"}, {"content-type", "application/json"}},
R"([{"id":"1","author":"Neal Stephenson","title":"Readme"})"
R"(,{"id":"2","author":"George R.R. Martin","title":"A Game of Thrones"}])");

// 2: Empty response (trailers only) from streaming backend.
// Response type is a valid JSON, so content type should be application/json.
// Regression test for github.com/envoyproxy/envoy#5011
testTranscoding<bookstore::ListBooksRequest, bookstore::Book>(
Http::TestHeaderMapImpl{
{":method", "GET"}, {":path", "/shelves/2/books"}, {":authority", "host"}},
"", {"shelf: 2"}, {}, Status(),
Http::TestHeaderMapImpl{{":status", "200"}, {"content-type", "application/json"}}, "[]");

// 3: Empty response (trailers only) from streaming backend, with a gRPC error.
testTranscoding<bookstore::ListBooksRequest, bookstore::Book>(
Http::TestHeaderMapImpl{
{":method", "GET"}, {":path", "/shelves/37/books"}, {":authority", "host"}},
"", {"shelf: 37"}, {}, Status(Code::NOT_FOUND, "Shelf 37 not found"),
Http::TestHeaderMapImpl{{":status", "200"}, {"content-type", "application/json"}}, "[]");
}

TEST_P(GrpcJsonTranscoderIntegrationTest, StreamingPost) {
Expand Down Expand Up @@ -553,6 +571,7 @@ TEST_P(GrpcJsonTranscoderIntegrationTest, DeepStruct) {

// The valid deep struct is parsed successfully.
// Since we didn't set the response, it return 503.
// Response body is empty (not a valid JSON), so content type should be application/grpc.
testTranscoding<bookstore::EchoStructReqResp, bookstore::EchoStructReqResp>(
Http::TestHeaderMapImpl{
{":method", "POST"}, {":path", "/echoStruct"}, {":authority", "host"}},
Expand Down