/
json_transcoder_filter.cc
1038 lines (889 loc) · 40.8 KB
/
json_transcoder_filter.cc
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#include "source/extensions/filters/http/grpc_json_transcoder/json_transcoder_filter.h"
#include <memory>
#include <unordered_set>
#include "envoy/common/exception.h"
#include "envoy/extensions/filters/http/grpc_json_transcoder/v3/transcoder.pb.h"
#include "envoy/http/filter.h"
#include "source/common/common/assert.h"
#include "source/common/common/enum_to_int.h"
#include "source/common/common/utility.h"
#include "source/common/grpc/common.h"
#include "source/common/http/headers.h"
#include "source/common/http/utility.h"
#include "source/common/protobuf/protobuf.h"
#include "source/common/protobuf/utility.h"
#include "source/common/runtime/runtime_features.h"
#include "source/extensions/filters/http/grpc_json_transcoder/http_body_utils.h"
#include "google/api/annotations.pb.h"
#include "google/api/http.pb.h"
#include "google/api/httpbody.pb.h"
#include "grpc_transcoding/json_request_translator.h"
#include "grpc_transcoding/path_matcher_utility.h"
#include "grpc_transcoding/response_to_json_translator.h"
using absl::Status;
using absl::StatusCode;
using Envoy::Protobuf::FileDescriptorSet;
using Envoy::Protobuf::io::ZeroCopyInputStream;
using google::api::HttpRule;
using google::grpc::transcoding::JsonRequestTranslator;
using JsonRequestTranslatorPtr = std::unique_ptr<JsonRequestTranslator>;
using google::grpc::transcoding::MessageStream;
using google::grpc::transcoding::PathMatcherBuilder;
using google::grpc::transcoding::PathMatcherUtility;
using google::grpc::transcoding::RequestMessageTranslator;
using RequestMessageTranslatorPtr = std::unique_ptr<RequestMessageTranslator>;
using google::grpc::transcoding::ResponseToJsonTranslator;
using ResponseToJsonTranslatorPtr = std::unique_ptr<ResponseToJsonTranslator>;
using google::grpc::transcoding::Transcoder;
using TranscoderPtr = std::unique_ptr<Transcoder>;
using google::grpc::transcoding::TranscoderInputStream;
using TranscoderInputStreamPtr = std::unique_ptr<TranscoderInputStream>;
namespace Envoy {
namespace Extensions {
namespace HttpFilters {
namespace GrpcJsonTranscoder {
struct RcDetailsValues {
// The gRPC json transcoder filter failed to transcode when processing request headers.
// This will generally be accompanied by details about the transcoder failure.
const std::string GrpcTranscodeFailedEarly = "early_grpc_json_transcode_failure";
// The gRPC json transcoder filter failed to transcode when processing the request body.
// This will generally be accompanied by details about the transcoder failure.
const std::string GrpcTranscodeFailed = "grpc_json_transcode_failure";
};
using RcDetails = ConstSingleton<RcDetailsValues>;
namespace {
const Http::LowerCaseString& trailerHeader() {
CONSTRUCT_ON_FIRST_USE(Http::LowerCaseString, "trailer");
}
// Transcoder:
// https://github.com/grpc-ecosystem/grpc-httpjson-transcoding/blob/master/src/include/grpc_transcoding/transcoder.h
// implementation based on JsonRequestTranslator & ResponseToJsonTranslator
class TranscoderImpl : public Transcoder {
public:
/**
* Construct a transcoder implementation
* @param request_translator a JsonRequestTranslator that does the request translation
* @param response_translator a ResponseToJsonTranslator that does the response translation
*/
TranscoderImpl(RequestMessageTranslatorPtr request_translator,
JsonRequestTranslatorPtr json_request_translator,
ResponseToJsonTranslatorPtr response_translator)
: request_translator_(std::move(request_translator)),
json_request_translator_(std::move(json_request_translator)),
request_message_stream_(request_translator_ ? *request_translator_
: json_request_translator_->Output()),
response_translator_(std::move(response_translator)),
request_stream_(request_message_stream_.CreateInputStream()),
response_stream_(response_translator_->CreateInputStream()) {}
// Transcoder
::google::grpc::transcoding::TranscoderInputStream* RequestOutput() override {
return request_stream_.get();
}
absl::Status RequestStatus() override { return request_message_stream_.Status(); }
ZeroCopyInputStream* ResponseOutput() override { return response_stream_.get(); }
absl::Status ResponseStatus() override { return response_translator_->Status(); }
private:
RequestMessageTranslatorPtr request_translator_;
JsonRequestTranslatorPtr json_request_translator_;
MessageStream& request_message_stream_;
ResponseToJsonTranslatorPtr response_translator_;
TranscoderInputStreamPtr request_stream_;
TranscoderInputStreamPtr response_stream_;
};
} // namespace
JsonTranscoderConfig::JsonTranscoderConfig(
const envoy::extensions::filters::http::grpc_json_transcoder::v3::GrpcJsonTranscoder&
proto_config,
Api::Api& api) {
disabled_ = proto_config.services().empty();
if (disabled_) {
return;
}
FileDescriptorSet descriptor_set;
switch (proto_config.descriptor_set_case()) {
case envoy::extensions::filters::http::grpc_json_transcoder::v3::GrpcJsonTranscoder::
DescriptorSetCase::kProtoDescriptor: {
auto file_or_error = api.fileSystem().fileReadToEnd(proto_config.proto_descriptor());
THROW_IF_STATUS_NOT_OK(file_or_error, throw);
if (!descriptor_set.ParseFromString(file_or_error.value())) {
throw EnvoyException("transcoding_filter: Unable to parse proto descriptor");
}
break;
}
case envoy::extensions::filters::http::grpc_json_transcoder::v3::GrpcJsonTranscoder::
DescriptorSetCase::kProtoDescriptorBin:
if (!descriptor_set.ParseFromString(proto_config.proto_descriptor_bin())) {
throw EnvoyException("transcoding_filter: Unable to parse proto descriptor");
}
break;
case envoy::extensions::filters::http::grpc_json_transcoder::v3::GrpcJsonTranscoder::
DescriptorSetCase::DESCRIPTOR_SET_NOT_SET:
throw EnvoyException("transcoding_filter: descriptor not set");
}
for (const auto& file : descriptor_set.file()) {
addFileDescriptor(file);
}
convert_grpc_status_ = proto_config.convert_grpc_status();
if (convert_grpc_status_) {
addBuiltinSymbolDescriptor("google.protobuf.Any");
addBuiltinSymbolDescriptor("google.rpc.Status");
}
type_helper_ = std::make_unique<google::grpc::transcoding::TypeHelper>(
Protobuf::util::NewTypeResolverForDescriptorPool(Grpc::Common::typeUrlPrefix(),
&descriptor_pool_));
PathMatcherBuilder<MethodInfoSharedPtr> pmb;
// clang-format off
// We cannot convert this to a absl hash set as PathMatcherUtility::RegisterByHttpRule takes a
// std::unordered_set as an argument
std::unordered_set<std::string> ignored_query_parameters;
// clang-format on
for (const auto& query_param : proto_config.ignored_query_parameters()) {
ignored_query_parameters.insert(query_param);
}
for (const auto& service_name : proto_config.services()) {
auto service = descriptor_pool_.FindServiceByName(service_name);
if (service == nullptr) {
throw EnvoyException("transcoding_filter: Could not find '" + service_name +
"' in the proto descriptor");
}
for (int i = 0; i < service->method_count(); ++i) {
auto method = service->method(i);
HttpRule http_rule;
if (method->options().HasExtension(google::api::http)) {
http_rule = method->options().GetExtension(google::api::http);
} else if (proto_config.auto_mapping()) {
auto post = "/" + service->full_name() + "/" + method->name();
http_rule.set_post(post);
http_rule.set_body("*");
}
MethodInfoSharedPtr method_info;
Status status = createMethodInfo(method, http_rule, method_info);
if (!status.ok()) {
throw EnvoyException(absl::StrCat("transcoding_filter: Cannot register '",
method->full_name(), "': ", status.message()));
}
if (!PathMatcherUtility::RegisterByHttpRule(pmb, http_rule, ignored_query_parameters,
method_info)) {
throw EnvoyException(absl::StrCat("transcoding_filter: Cannot register '",
method->full_name(), "' to path matcher"));
}
}
}
switch (proto_config.url_unescape_spec()) {
PANIC_ON_PROTO_ENUM_SENTINEL_VALUES;
case envoy::extensions::filters::http::grpc_json_transcoder::v3::GrpcJsonTranscoder::
ALL_CHARACTERS_EXCEPT_RESERVED:
pmb.SetUrlUnescapeSpec(
google::grpc::transcoding::UrlUnescapeSpec::kAllCharactersExceptReserved);
break;
case envoy::extensions::filters::http::grpc_json_transcoder::v3::GrpcJsonTranscoder::
ALL_CHARACTERS_EXCEPT_SLASH:
pmb.SetUrlUnescapeSpec(google::grpc::transcoding::UrlUnescapeSpec::kAllCharactersExceptSlash);
break;
case envoy::extensions::filters::http::grpc_json_transcoder::v3::GrpcJsonTranscoder::
ALL_CHARACTERS:
pmb.SetUrlUnescapeSpec(google::grpc::transcoding::UrlUnescapeSpec::kAllCharacters);
break;
}
pmb.SetQueryParamUnescapePlus(proto_config.query_param_unescape_plus());
pmb.SetMatchUnregisteredCustomVerb(proto_config.match_unregistered_custom_verb());
path_matcher_ = pmb.Build();
const auto& print_config = proto_config.print_options();
response_translate_options_.json_print_options.add_whitespace = print_config.add_whitespace();
response_translate_options_.json_print_options.always_print_primitive_fields =
print_config.always_print_primitive_fields();
response_translate_options_.json_print_options.always_print_enums_as_ints =
print_config.always_print_enums_as_ints();
response_translate_options_.json_print_options.preserve_proto_field_names =
print_config.preserve_proto_field_names();
response_translate_options_.stream_newline_delimited = print_config.stream_newline_delimited();
match_incoming_request_route_ = proto_config.match_incoming_request_route();
ignore_unknown_query_parameters_ = proto_config.ignore_unknown_query_parameters();
request_validation_options_ = proto_config.request_validation_options();
case_insensitive_enum_parsing_ = proto_config.case_insensitive_enum_parsing();
if (proto_config.has_max_request_body_size()) {
max_request_body_size_ = proto_config.max_request_body_size().value();
}
if (proto_config.has_max_response_body_size()) {
max_response_body_size_ = proto_config.max_response_body_size().value();
}
}
void JsonTranscoderConfig::addFileDescriptor(const Protobuf::FileDescriptorProto& file) {
if (descriptor_pool_.BuildFile(file) == nullptr) {
throw EnvoyException("transcoding_filter: Unable to build proto descriptor pool");
}
}
void JsonTranscoderConfig::addBuiltinSymbolDescriptor(const std::string& symbol_name) {
if (descriptor_pool_.FindFileContainingSymbol(symbol_name) != nullptr) {
return;
}
auto* builtin_pool = Protobuf::DescriptorPool::generated_pool();
if (!builtin_pool) {
return;
}
Protobuf::DescriptorPoolDatabase pool_database(*builtin_pool);
Protobuf::FileDescriptorProto file_proto;
pool_database.FindFileContainingSymbol(symbol_name, &file_proto);
addFileDescriptor(file_proto);
}
Status JsonTranscoderConfig::resolveField(const Protobuf::Descriptor* descriptor,
const std::string& field_path_str,
std::vector<const ProtobufWkt::Field*>* field_path,
bool* is_http_body) {
const ProtobufWkt::Type* message_type =
type_helper_->Info()->GetTypeByTypeUrl(Grpc::Common::typeUrl(descriptor->full_name()));
if (message_type == nullptr) {
return {StatusCode::kNotFound, "Could not resolve type: " + descriptor->full_name()};
}
Status status = type_helper_->ResolveFieldPath(
*message_type, field_path_str == "*" ? "" : field_path_str, field_path);
if (!status.ok()) {
return status;
}
if (field_path->empty()) {
*is_http_body = descriptor->full_name() == google::api::HttpBody::descriptor()->full_name();
} else {
const ProtobufWkt::Type* body_type =
type_helper_->Info()->GetTypeByTypeUrl(field_path->back()->type_url());
*is_http_body = body_type != nullptr &&
body_type->name() == google::api::HttpBody::descriptor()->full_name();
}
return {};
}
Status JsonTranscoderConfig::createMethodInfo(const Protobuf::MethodDescriptor* descriptor,
const HttpRule& http_rule,
MethodInfoSharedPtr& method_info) {
method_info = std::make_shared<MethodInfo>();
method_info->descriptor_ = descriptor;
Status status =
resolveField(descriptor->input_type(), http_rule.body(),
&method_info->request_body_field_path, &method_info->request_type_is_http_body_);
if (!status.ok()) {
return status;
}
status = resolveField(descriptor->output_type(), http_rule.response_body(),
&method_info->response_body_field_path,
&method_info->response_type_is_http_body_);
if (!status.ok()) {
return status;
}
if (!method_info->response_body_field_path.empty() && !method_info->response_type_is_http_body_) {
// TODO(euroelessar): Implement https://github.com/envoyproxy/envoy/issues/11136.
return {StatusCode::kUnimplemented,
"Setting \"response_body\" is not supported yet for non-HttpBody fields: " +
descriptor->full_name()};
}
return {};
}
bool JsonTranscoderConfig::matchIncomingRequestInfo() const {
return match_incoming_request_route_;
}
bool JsonTranscoderConfig::convertGrpcStatus() const { return convert_grpc_status_; }
absl::Status JsonTranscoderConfig::createTranscoder(
const Http::RequestHeaderMap& headers, ZeroCopyInputStream& request_input,
google::grpc::transcoding::TranscoderInputStream& response_input,
std::unique_ptr<Transcoder>& transcoder, MethodInfoSharedPtr& method_info) const {
ASSERT(!disabled_);
const std::string method(headers.getMethodValue());
std::string path(headers.getPathValue());
std::string args;
const size_t pos = path.find('?');
if (pos != std::string::npos) {
args = path.substr(pos + 1);
path = path.substr(0, pos);
}
google::grpc::transcoding::RequestInfo request_info;
request_info.reject_binding_body_field_collisions =
request_validation_options_.reject_binding_body_field_collisions();
request_info.case_insensitive_enum_parsing = case_insensitive_enum_parsing_;
std::vector<VariableBinding> variable_bindings;
method_info =
path_matcher_->Lookup(method, path, args, &variable_bindings, &request_info.body_field_path);
if (!method_info) {
return {StatusCode::kNotFound, "Could not resolve " + path + " to a method."};
}
auto status = methodToRequestInfo(method_info, &request_info);
if (!status.ok()) {
return status;
}
for (const auto& binding : variable_bindings) {
google::grpc::transcoding::RequestWeaver::BindingInfo resolved_binding;
status = type_helper_->ResolveFieldPath(*request_info.message_type, binding.field_path,
&resolved_binding.field_path);
if (!status.ok()) {
if (ignore_unknown_query_parameters_) {
continue;
}
return status;
}
// HttpBody fields should be passed as-is and not be parsed as JSON.
const bool is_http_body = method_info->request_type_is_http_body_;
const bool is_inside_http_body =
is_http_body && absl::c_equal(absl::MakeSpan(resolved_binding.field_path)
.subspan(0, method_info->request_body_field_path.size()),
method_info->request_body_field_path);
if (!is_inside_http_body) {
resolved_binding.value = binding.value;
request_info.variable_bindings.emplace_back(std::move(resolved_binding));
}
}
RequestMessageTranslatorPtr request_translator;
JsonRequestTranslatorPtr json_request_translator;
if (method_info->request_type_is_http_body_) {
request_translator = std::make_unique<RequestMessageTranslator>(*type_helper_->Resolver(),
false, std::move(request_info));
request_translator->Input().StartObject("")->EndObject();
} else {
json_request_translator = std::make_unique<JsonRequestTranslator>(
type_helper_->Resolver(), &request_input, std::move(request_info),
method_info->descriptor_->client_streaming(), true);
}
const auto response_type_url =
Grpc::Common::typeUrl(method_info->descriptor_->output_type()->full_name());
ResponseToJsonTranslatorPtr response_translator{new ResponseToJsonTranslator(
type_helper_->Resolver(), response_type_url, method_info->descriptor_->server_streaming(),
&response_input, response_translate_options_)};
transcoder = std::make_unique<TranscoderImpl>(std::move(request_translator),
std::move(json_request_translator),
std::move(response_translator));
return {};
}
absl::Status
JsonTranscoderConfig::methodToRequestInfo(const MethodInfoSharedPtr& method_info,
google::grpc::transcoding::RequestInfo* info) const {
const std::string& request_type_full_name = method_info->descriptor_->input_type()->full_name();
auto request_type_url = Grpc::Common::typeUrl(request_type_full_name);
info->message_type = type_helper_->Info()->GetTypeByTypeUrl(request_type_url);
if (info->message_type == nullptr) {
ENVOY_LOG(debug, "Cannot resolve input-type: {}", request_type_full_name);
return {StatusCode::kNotFound, "Could not resolve type: " + request_type_full_name};
}
return {};
}
absl::Status JsonTranscoderConfig::translateProtoMessageToJson(const Protobuf::Message& message,
std::string* json_out) const {
return ProtobufUtil::BinaryToJsonString(
type_helper_->Resolver(), Grpc::Common::typeUrl(message.GetDescriptor()->full_name()),
message.SerializeAsString(), json_out, response_translate_options_.json_print_options);
}
JsonTranscoderFilter::JsonTranscoderFilter(const JsonTranscoderConfig& config) : config_(config) {}
void JsonTranscoderFilter::initPerRouteConfig() {
const auto* route_local =
Http::Utility::resolveMostSpecificPerFilterConfig<JsonTranscoderConfig>(decoder_callbacks_);
per_route_config_ = route_local ? route_local : &config_;
}
void JsonTranscoderFilter::maybeExpandBufferLimits() {
const uint32_t max_request_size = per_route_config_->max_request_body_size_.value_or(0);
if (max_request_size > decoder_callbacks_->decoderBufferLimit()) {
decoder_callbacks_->setDecoderBufferLimit(max_request_size);
}
const uint32_t max_response_size = per_route_config_->max_response_body_size_.value_or(0);
if (max_response_size > encoder_callbacks_->encoderBufferLimit()) {
encoder_callbacks_->setEncoderBufferLimit(max_response_size);
}
}
Http::FilterHeadersStatus JsonTranscoderFilter::decodeHeaders(Http::RequestHeaderMap& headers,
bool end_stream) {
initPerRouteConfig();
if (per_route_config_->disabled()) {
ENVOY_STREAM_LOG(debug,
"Transcoding is disabled for the route. Request headers is passed through.",
*decoder_callbacks_);
return Http::FilterHeadersStatus::Continue;
}
if (Grpc::Common::isGrpcRequestHeaders(headers)) {
ENVOY_STREAM_LOG(debug,
"Request headers has application/grpc content-type. Request is passed through "
"without transcoding.",
*decoder_callbacks_);
return Http::FilterHeadersStatus::Continue;
}
const auto status =
per_route_config_->createTranscoder(headers, request_in_, response_in_, transcoder_, method_);
if (!status.ok()) {
ENVOY_STREAM_LOG(debug, "Failed to transcode request headers: {}", *decoder_callbacks_,
status.message());
if (status.code() == StatusCode::kNotFound &&
!per_route_config_->request_validation_options_.reject_unknown_method()) {
ENVOY_STREAM_LOG(debug,
"Request is passed through without transcoding because it cannot be mapped "
"to a gRPC method.",
*decoder_callbacks_);
return Http::FilterHeadersStatus::Continue;
}
if (status.code() == StatusCode::kInvalidArgument &&
!per_route_config_->request_validation_options_.reject_unknown_query_parameters()) {
ENVOY_STREAM_LOG(debug,
"Request is passed through without transcoding because it contains unknown "
"query parameters.",
*decoder_callbacks_);
return Http::FilterHeadersStatus::Continue;
}
// protobuf::util::Status.error_code is the same as Envoy GrpcStatus
// This cast is safe.
auto http_code = Envoy::Grpc::Utility::grpcToHttpStatus(
static_cast<Envoy::Grpc::Status::GrpcStatus>(status.code()));
ENVOY_STREAM_LOG(debug, "Request is rejected due to strict rejection policy.",
*decoder_callbacks_);
error_ = true;
decoder_callbacks_->sendLocalReply(
static_cast<Http::Code>(http_code), status.message(), nullptr, absl::nullopt,
absl::StrCat(RcDetails::get().GrpcTranscodeFailedEarly, "{",
StringUtil::replaceAllEmptySpace(MessageUtil::codeEnumToString(status.code())),
"}"));
return Http::FilterHeadersStatus::StopIteration;
}
maybeExpandBufferLimits();
if (method_->request_type_is_http_body_) {
if (headers.ContentType() != nullptr) {
absl::string_view content_type = headers.getContentTypeValue();
content_type_.assign(content_type.begin(), content_type.end());
}
bool done = !readToBuffer(*transcoder_->RequestOutput(), initial_request_data_);
if (!done) {
ENVOY_STREAM_LOG(
debug,
"Transcoding of query arguments of HttpBody request is not done (unexpected state)",
*decoder_callbacks_);
error_ = true;
decoder_callbacks_->sendLocalReply(
Http::Code::BadRequest, "Bad request", nullptr, absl::nullopt,
absl::StrCat(RcDetails::get().GrpcTranscodeFailedEarly, "{BAD_REQUEST}"));
return Http::FilterHeadersStatus::StopIteration;
}
if (checkAndRejectIfRequestTranscoderFailed(RcDetails::get().GrpcTranscodeFailed)) {
return Http::FilterHeadersStatus::StopIteration;
}
}
headers.removeContentLength();
headers.setReferenceContentType(Http::Headers::get().ContentTypeValues.Grpc);
headers.setEnvoyOriginalPath(headers.getPathValue());
headers.addReferenceKey(Http::Headers::get().EnvoyOriginalMethod, headers.getMethodValue());
headers.setPath("/" + method_->descriptor_->service()->full_name() + "/" +
method_->descriptor_->name());
headers.setReferenceMethod(Http::Headers::get().MethodValues.Post);
headers.setReferenceTE(Http::Headers::get().TEValues.Trailers);
if (!per_route_config_->matchIncomingRequestInfo()) {
decoder_callbacks_->downstreamCallbacks()->clearRouteCache();
}
if (end_stream && method_->request_type_is_http_body_) {
maybeSendHttpBodyRequestMessage(nullptr);
} else if (end_stream) {
request_in_.finish();
Buffer::OwnedImpl data;
readToBuffer(*transcoder_->RequestOutput(), data);
if (checkAndRejectIfRequestTranscoderFailed(RcDetails::get().GrpcTranscodeFailedEarly)) {
return Http::FilterHeadersStatus::StopIteration;
}
if (data.length() > 0) {
ENVOY_STREAM_LOG(debug, "adding initial data during decodeHeaders, transcoded data size={}",
*decoder_callbacks_, data.length());
decoder_callbacks_->addDecodedData(data, true);
}
}
return Http::FilterHeadersStatus::Continue;
}
Http::FilterDataStatus JsonTranscoderFilter::decodeData(Buffer::Instance& data, bool end_stream) {
ASSERT(!error_);
if (!transcoder_) {
ENVOY_STREAM_LOG(debug, "Request data is passed through", *decoder_callbacks_);
return Http::FilterDataStatus::Continue;
}
if (method_->request_type_is_http_body_) {
request_data_.move(data);
if (decoderBufferLimitReached(request_data_.length())) {
return Http::FilterDataStatus::StopIterationNoBuffer;
}
// TODO(euroelessar): Upper bound message size for streaming case.
if (end_stream || method_->descriptor_->client_streaming()) {
maybeSendHttpBodyRequestMessage(&data);
} else {
// TODO(euroelessar): Avoid buffering if content length is already known.
return Http::FilterDataStatus::StopIterationAndBuffer;
}
} else {
request_in_.move(data);
if (decoderBufferLimitReached(request_in_.bytesStored())) {
return Http::FilterDataStatus::StopIterationNoBuffer;
}
if (end_stream) {
request_in_.finish();
}
readToBuffer(*transcoder_->RequestOutput(), data);
}
if (checkAndRejectIfRequestTranscoderFailed(RcDetails::get().GrpcTranscodeFailed)) {
return Http::FilterDataStatus::StopIterationNoBuffer;
}
ENVOY_STREAM_LOG(debug,
"continuing request during decodeData, transcoded data size={}, end_stream={}",
*decoder_callbacks_, data.length(), end_stream);
return Http::FilterDataStatus::Continue;
}
Http::FilterTrailersStatus JsonTranscoderFilter::decodeTrailers(Http::RequestTrailerMap&) {
ASSERT(!error_);
if (!transcoder_) {
ENVOY_STREAM_LOG(debug, "Request trailers is passed through", *decoder_callbacks_);
return Http::FilterTrailersStatus::Continue;
}
if (method_->request_type_is_http_body_) {
maybeSendHttpBodyRequestMessage(nullptr);
} else {
request_in_.finish();
Buffer::OwnedImpl data;
readToBuffer(*transcoder_->RequestOutput(), data);
if (data.length()) {
ENVOY_STREAM_LOG(debug,
"adding remaining data during decodeTrailers, transcoded data size={}",
*decoder_callbacks_, data.length());
decoder_callbacks_->addDecodedData(data, true);
}
}
return Http::FilterTrailersStatus::Continue;
}
void JsonTranscoderFilter::setDecoderFilterCallbacks(
Http::StreamDecoderFilterCallbacks& callbacks) {
decoder_callbacks_ = &callbacks;
}
Http::FilterHeadersStatus JsonTranscoderFilter::encodeHeaders(Http::ResponseHeaderMap& headers,
bool end_stream) {
if (!Grpc::Common::isGrpcResponseHeaders(headers, end_stream)) {
ENVOY_STREAM_LOG(
debug,
"Response headers is NOT application/grpc content-type. Response is passed through "
"without transcoding.",
*encoder_callbacks_);
error_ = true;
}
if (error_ || !transcoder_) {
ENVOY_STREAM_LOG(debug, "Response headers is passed through", *encoder_callbacks_);
return Http::FilterHeadersStatus::Continue;
}
response_headers_ = &headers;
if (end_stream) {
if (method_->descriptor_->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.setReferenceContentType(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.
doTrailers(headers);
return Http::FilterHeadersStatus::Continue;
}
headers.setReferenceContentType(Http::Headers::get().ContentTypeValues.Json);
// In case of HttpBody in response - content type is unknown at this moment.
// So "Continue" only for regular streaming use case and StopIteration for
// all other cases (non streaming, streaming + httpBody)
if (method_->descriptor_->server_streaming() && !method_->response_type_is_http_body_) {
return Http::FilterHeadersStatus::Continue;
}
return Http::FilterHeadersStatus::StopIteration;
}
Http::FilterDataStatus JsonTranscoderFilter::encodeData(Buffer::Instance& data, bool end_stream) {
if (error_ || !transcoder_) {
ENVOY_STREAM_LOG(debug, "Response data is passed through", *encoder_callbacks_);
return Http::FilterDataStatus::Continue;
}
has_body_ = true;
if (method_->response_type_is_http_body_) {
bool frame_processed = buildResponseFromHttpBodyOutput(*response_headers_, data);
if (!method_->descriptor_->server_streaming()) {
return Http::FilterDataStatus::StopIterationAndBuffer;
}
if (!http_body_response_headers_set_ && !frame_processed) {
return Http::FilterDataStatus::StopIterationAndBuffer;
}
return Http::FilterDataStatus::Continue;
}
response_in_.move(data);
if (encoderBufferLimitReached(response_in_.bytesStored() + response_out_.length())) {
return Http::FilterDataStatus::StopIterationNoBuffer;
}
if (end_stream) {
response_in_.finish();
}
readToBuffer(*transcoder_->ResponseOutput(), response_out_);
if (checkAndRejectIfResponseTranscoderFailed()) {
return Http::FilterDataStatus::StopIterationNoBuffer;
}
if (!method_->descriptor_->server_streaming() && !end_stream) {
ENVOY_STREAM_LOG(debug,
"internally buffering unary response waiting for end_stream during "
"encodeData, transcoded data size={}",
*encoder_callbacks_, response_out_.length());
return Http::FilterDataStatus::StopIterationNoBuffer;
}
data.move(response_out_);
ENVOY_STREAM_LOG(debug,
"continuing response during encodeData, transcoded data size={}, end_stream={}",
*encoder_callbacks_, data.length(), end_stream);
return Http::FilterDataStatus::Continue;
}
Http::FilterTrailersStatus
JsonTranscoderFilter::encodeTrailers(Http::ResponseTrailerMap& trailers) {
doTrailers(trailers);
return Http::FilterTrailersStatus::Continue;
}
void JsonTranscoderFilter::doTrailers(Http::ResponseHeaderOrTrailerMap& headers_or_trailers) {
if (error_ || !transcoder_ || !per_route_config_ || per_route_config_->disabled()) {
ENVOY_STREAM_LOG(debug, "Response headers/trailers is passed through", *encoder_callbacks_);
return;
}
response_in_.finish();
const absl::optional<Grpc::Status::GrpcStatus> grpc_status =
Grpc::Common::getGrpcStatus(headers_or_trailers, true);
if (grpc_status && maybeConvertGrpcStatus(*grpc_status, headers_or_trailers)) {
return;
}
if (!method_->response_type_is_http_body_) {
readToBuffer(*transcoder_->ResponseOutput(), response_out_);
if (checkAndRejectIfResponseTranscoderFailed()) {
return;
}
if (response_out_.length() > 0) {
ENVOY_STREAM_LOG(debug,
"adding remaining data during encodeTrailers, transcoded data size={}",
*encoder_callbacks_, response_out_.length());
encoder_callbacks_->addEncodedData(response_out_, true);
}
}
// If there was no previous headers frame, this |trailers| map is our |response_headers_|,
// so there is no need to copy headers from one to the other.
const bool is_trailers_only_response = response_headers_ == &headers_or_trailers;
const bool is_server_streaming = method_->descriptor_->server_streaming();
if (is_server_streaming && !is_trailers_only_response) {
// Continue if headers were sent already.
return;
}
if (!grpc_status || grpc_status.value() == Grpc::Status::WellKnownGrpcStatus::InvalidCode) {
response_headers_->setStatus(enumToInt(Http::Code::ServiceUnavailable));
} else {
response_headers_->setStatus(Grpc::Utility::grpcToHttpStatus(grpc_status.value()));
if (!is_trailers_only_response) {
response_headers_->setGrpcStatus(grpc_status.value());
}
}
if (!is_trailers_only_response) {
// Copy the grpc-message header if it exists.
const Http::HeaderEntry* grpc_message_header = headers_or_trailers.GrpcMessage();
if (grpc_message_header) {
response_headers_->setGrpcMessage(grpc_message_header->value().getStringView());
}
}
// remove Trailer headers if the client connection was http/1
if (encoder_callbacks_->streamInfo().protocol() < Http::Protocol::Http2) {
response_headers_->remove(trailerHeader());
}
if (!method_->descriptor_->server_streaming()) {
// Set content-length for non-streaming responses.
response_headers_->setContentLength(
encoder_callbacks_->encodingBuffer() ? encoder_callbacks_->encodingBuffer()->length() : 0);
}
}
void JsonTranscoderFilter::setEncoderFilterCallbacks(
Http::StreamEncoderFilterCallbacks& callbacks) {
encoder_callbacks_ = &callbacks;
}
bool JsonTranscoderFilter::checkAndRejectIfRequestTranscoderFailed(const std::string& details) {
const auto& request_status = transcoder_->RequestStatus();
if (!request_status.ok()) {
ENVOY_STREAM_LOG(debug, "Transcoding request error {}", *decoder_callbacks_,
request_status.ToString());
error_ = true;
decoder_callbacks_->sendLocalReply(
Http::Code::BadRequest,
absl::string_view(request_status.message().data(), request_status.message().size()),
nullptr, absl::nullopt,
absl::StrCat(
details, "{",
StringUtil::replaceAllEmptySpace(MessageUtil::codeEnumToString(request_status.code())),
"}"));
return true;
}
return false;
}
bool JsonTranscoderFilter::checkAndRejectIfResponseTranscoderFailed() {
const auto& response_status = transcoder_->ResponseStatus();
if (!response_status.ok()) {
ENVOY_STREAM_LOG(debug, "Transcoding response error {}", *encoder_callbacks_,
response_status.ToString());
error_ = true;
encoder_callbacks_->sendLocalReply(
Http::Code::BadGateway,
absl::string_view(response_status.message().data(), response_status.message().size()),
nullptr, absl::nullopt,
absl::StrCat(
RcDetails::get().GrpcTranscodeFailed, "{",
StringUtil::replaceAllEmptySpace(MessageUtil::codeEnumToString(response_status.code())),
"}"));
return true;
}
return false;
}
bool JsonTranscoderFilter::readToBuffer(Protobuf::io::ZeroCopyInputStream& stream,
Buffer::Instance& data) {
const void* out;
int size;
while (stream.Next(&out, &size)) {
if (size == 0) {
return true;
}
data.add(out, size);
}
return false;
}
void JsonTranscoderFilter::maybeSendHttpBodyRequestMessage(Buffer::Instance* data) {
if (first_request_sent_ && request_data_.length() == 0) {
return;
}
Buffer::OwnedImpl message_payload;
message_payload.move(initial_request_data_);
HttpBodyUtils::appendHttpBodyEnvelope(message_payload, method_->request_body_field_path,
std::move(content_type_), request_data_.length());
content_type_.clear();
message_payload.move(request_data_);
Envoy::Grpc::Encoder().prependFrameHeader(Envoy::Grpc::GRPC_FH_DEFAULT, message_payload);
if (data) {
data->move(message_payload);
} else {
decoder_callbacks_->addDecodedData(message_payload, true);
}
first_request_sent_ = true;
}
bool JsonTranscoderFilter::buildResponseFromHttpBodyOutput(
Http::ResponseHeaderMap& response_headers, Buffer::Instance& data) {
std::vector<Grpc::Frame> frames;
std::ignore = decoder_.decode(data, frames);
if (frames.empty()) {
return false;
}
google::api::HttpBody http_body;
for (auto& frame : frames) {
if (frame.length_ > 0) {
http_body.Clear();
Buffer::ZeroCopyInputStreamImpl stream(std::move(frame.data_));
if (!HttpBodyUtils::parseMessageByFieldPath(&stream, method_->response_body_field_path,
&http_body)) {
// TODO(euroelessar): Return error to client.
encoder_callbacks_->resetStream();
return true;
}
const auto& body = http_body.data();
data.add(body);
if (!method_->descriptor_->server_streaming()) {
// Non streaming case: single message with content type / length
response_headers.setContentType(http_body.content_type());
response_headers.setContentLength(body.size());
return true;
} else if (!http_body_response_headers_set_) {
// Streaming case: set content type only once from first HttpBody message
response_headers.setContentType(http_body.content_type());
http_body_response_headers_set_ = true;
}
}
}
return true;
}
bool JsonTranscoderFilter::maybeConvertGrpcStatus(Grpc::Status::GrpcStatus grpc_status,
Http::ResponseHeaderOrTrailerMap& trailers) {
ASSERT(per_route_config_ && !per_route_config_->disabled());
if (!per_route_config_->convertGrpcStatus()) {
return false;
}
// Send a serialized status only if there was no body.
if (has_body_) {
return false;
}
if (grpc_status == Grpc::Status::WellKnownGrpcStatus::Ok ||
grpc_status == Grpc::Status::WellKnownGrpcStatus::InvalidCode) {
return false;
}
// TODO(mattklein123): The dynamic cast here is needed because ResponseHeaderOrTrailerMap is not
// a header map. This can likely be cleaned up.
auto status_details =
Grpc::Common::getGrpcStatusDetailsBin(dynamic_cast<Http::HeaderMap&>(trailers));
if (!status_details) {
// If no rpc.Status object was sent in the grpc-status-details-bin header,
// construct it from the grpc-status and grpc-message headers.
status_details.emplace();
status_details->set_code(grpc_status);
auto grpc_message_header = trailers.GrpcMessage();
if (grpc_message_header) {
auto message = grpc_message_header->value().getStringView();
auto decoded_message = Http::Utility::PercentEncoding::decode(message);
status_details->set_message(decoded_message.data(), decoded_message.size());
}
}
std::string json_status;
auto translate_status =
per_route_config_->translateProtoMessageToJson(*status_details, &json_status);
if (!translate_status.ok()) {
ENVOY_STREAM_LOG(debug, "Transcoding status error {}", *encoder_callbacks_,
translate_status.ToString());
return false;
}
response_headers_->setStatus(Grpc::Utility::grpcToHttpStatus(grpc_status));
bool is_trailers_only_response = response_headers_ == &trailers;
if (is_trailers_only_response) {
// Drop the gRPC status headers, we already have them in the JSON body.
response_headers_->removeGrpcStatus();
response_headers_->removeGrpcMessage();
response_headers_->remove(Http::Headers::get().GrpcStatusDetailsBin);
}
// remove Trailer headers if the client connection was http/1
if (encoder_callbacks_->streamInfo().protocol() < Http::Protocol::Http2) {
response_headers_->remove(trailerHeader());
}
response_headers_->setReferenceContentType(Http::Headers::get().ContentTypeValues.Json);
response_headers_->setContentLength(json_status.length());
Buffer::OwnedImpl status_data(json_status);
encoder_callbacks_->addEncodedData(status_data, false);
return true;
}
bool JsonTranscoderFilter::decoderBufferLimitReached(uint64_t buffer_length) {
// The limit is either the configured maximum request body size, or, if not configured,
// the default buffer limit.
const uint32_t max_size =
per_route_config_->max_request_body_size_.value_or(decoder_callbacks_->decoderBufferLimit());
if (buffer_length > max_size) {
ENVOY_STREAM_LOG(debug,
"Request rejected because the transcoder's internal buffer size exceeds the "
"configured limit: {} > {}",
*decoder_callbacks_, buffer_length, max_size);
error_ = true;