1 //
2 // Copyright 2018 gRPC authors.
3 //
4 // Licensed under the Apache License, Version 2.0 (the "License");
5 // you may not use this file except in compliance with the License.
6 // You may obtain a copy of the License at
7 //
8 // http://www.apache.org/licenses/LICENSE-2.0
9 //
10 // Unless required by applicable law or agreed to in writing, software
11 // distributed under the License is distributed on an "AS IS" BASIS,
12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 // See the License for the specific language governing permissions and
14 // limitations under the License.
15 //
16
17 #include <stdio.h>
18 #include <string.h>
19
20 #include <grpc/byte_buffer.h>
21 #include <grpc/grpc.h>
22 #include <grpc/support/alloc.h>
23 #include <grpc/support/log.h>
24 #include <grpc/support/string_util.h>
25 #include <grpc/support/time.h>
26
27 #include "src/core/lib/channel/channel_args.h"
28 #include "src/core/lib/channel/channel_stack.h"
29 #include "src/core/lib/channel/channel_stack_builder.h"
30 #include "src/core/lib/config/core_configuration.h"
31 #include "src/core/lib/gpr/string.h"
32 #include "src/core/lib/gpr/useful.h"
33 #include "src/core/lib/iomgr/exec_ctx.h"
34 #include "src/core/lib/surface/channel_init.h"
35 #include "src/core/lib/transport/static_metadata.h"
36 #include "test/core/end2end/cq_verifier.h"
37 #include "test/core/end2end/end2end_tests.h"
38 #include "test/core/end2end/tests/cancel_test_helpers.h"
39
tag(intptr_t t)40 static void* tag(intptr_t t) { return reinterpret_cast<void*>(t); }
41
begin_test(grpc_end2end_test_config config,const char * test_name,grpc_channel_args * client_args,grpc_channel_args * server_args)42 static grpc_end2end_test_fixture begin_test(grpc_end2end_test_config config,
43 const char* test_name,
44 grpc_channel_args* client_args,
45 grpc_channel_args* server_args) {
46 grpc_end2end_test_fixture f;
47 gpr_log(GPR_INFO, "Running test: %s/%s", test_name, config.name);
48 f = config.create_fixture(client_args, server_args);
49 config.init_server(&f, server_args);
50 config.init_client(&f, client_args);
51 return f;
52 }
53
n_seconds_from_now(int n)54 static gpr_timespec n_seconds_from_now(int n) {
55 return grpc_timeout_seconds_to_deadline(n);
56 }
57
five_seconds_from_now(void)58 static gpr_timespec five_seconds_from_now(void) {
59 return n_seconds_from_now(5);
60 }
61
drain_cq(grpc_completion_queue * cq)62 static void drain_cq(grpc_completion_queue* cq) {
63 grpc_event ev;
64 do {
65 ev = grpc_completion_queue_next(cq, five_seconds_from_now(), nullptr);
66 } while (ev.type != GRPC_QUEUE_SHUTDOWN);
67 }
68
shutdown_server(grpc_end2end_test_fixture * f)69 static void shutdown_server(grpc_end2end_test_fixture* f) {
70 if (!f->server) return;
71 grpc_server_shutdown_and_notify(f->server, f->shutdown_cq, tag(1000));
72 GPR_ASSERT(grpc_completion_queue_pluck(f->shutdown_cq, tag(1000),
73 grpc_timeout_seconds_to_deadline(5),
74 nullptr)
75 .type == GRPC_OP_COMPLETE);
76 grpc_server_destroy(f->server);
77 f->server = nullptr;
78 }
79
shutdown_client(grpc_end2end_test_fixture * f)80 static void shutdown_client(grpc_end2end_test_fixture* f) {
81 if (!f->client) return;
82 grpc_channel_destroy(f->client);
83 f->client = nullptr;
84 }
85
end_test(grpc_end2end_test_fixture * f)86 static void end_test(grpc_end2end_test_fixture* f) {
87 shutdown_server(f);
88 shutdown_client(f);
89
90 grpc_completion_queue_shutdown(f->cq);
91 drain_cq(f->cq);
92 grpc_completion_queue_destroy(f->cq);
93 grpc_completion_queue_destroy(f->shutdown_cq);
94 }
95
96 // Tests that we honor the error passed to recv_trailing_metadata_ready
97 // when determining the call's status, even if the op completion runs before
98 // the recv_trailing_metadata op is started from the surface.
99 // - 1 retry allowed for ABORTED status
100 // - server returns ABORTED, but filter overwrites to INVALID_ARGUMENT,
101 // so no retry is done
test_retry_recv_trailing_metadata_error(grpc_end2end_test_config config)102 static void test_retry_recv_trailing_metadata_error(
103 grpc_end2end_test_config config) {
104 grpc_call* c;
105 grpc_call* s;
106 grpc_op ops[6];
107 grpc_op* op;
108 grpc_metadata_array initial_metadata_recv;
109 grpc_metadata_array trailing_metadata_recv;
110 grpc_metadata_array request_metadata_recv;
111 grpc_call_details call_details;
112 grpc_slice request_payload_slice = grpc_slice_from_static_string("foo");
113 grpc_slice response_payload_slice = grpc_slice_from_static_string("bar");
114 grpc_byte_buffer* request_payload =
115 grpc_raw_byte_buffer_create(&request_payload_slice, 1);
116 grpc_byte_buffer* response_payload =
117 grpc_raw_byte_buffer_create(&response_payload_slice, 1);
118 grpc_byte_buffer* request_payload_recv = nullptr;
119 grpc_byte_buffer* response_payload_recv = nullptr;
120 grpc_status_code status;
121 grpc_call_error error;
122 grpc_slice details;
123 int was_cancelled = 2;
124 char* peer;
125
126 grpc_arg args[] = {
127 grpc_channel_arg_string_create(
128 const_cast<char*>(GRPC_ARG_SERVICE_CONFIG),
129 const_cast<char*>(
130 "{\n"
131 " \"methodConfig\": [ {\n"
132 " \"name\": [\n"
133 " { \"service\": \"service\", \"method\": \"method\" }\n"
134 " ],\n"
135 " \"retryPolicy\": {\n"
136 " \"maxAttempts\": 2,\n"
137 " \"initialBackoff\": \"1s\",\n"
138 " \"maxBackoff\": \"120s\",\n"
139 " \"backoffMultiplier\": 1.6,\n"
140 " \"retryableStatusCodes\": [ \"ABORTED\" ]\n"
141 " }\n"
142 " } ]\n"
143 "}")),
144 };
145 grpc_channel_args client_args = {GPR_ARRAY_SIZE(args), args};
146 grpc_end2end_test_fixture f = begin_test(
147 config, "retry_recv_trailing_metadata_error", &client_args, nullptr);
148
149 cq_verifier* cqv = cq_verifier_create(f.cq);
150
151 gpr_timespec deadline = five_seconds_from_now();
152 c = grpc_channel_create_call(f.client, nullptr, GRPC_PROPAGATE_DEFAULTS, f.cq,
153 grpc_slice_from_static_string("/service/method"),
154 nullptr, deadline, nullptr);
155 GPR_ASSERT(c);
156
157 peer = grpc_call_get_peer(c);
158 GPR_ASSERT(peer != nullptr);
159 gpr_log(GPR_DEBUG, "client_peer_before_call=%s", peer);
160 gpr_free(peer);
161
162 grpc_metadata_array_init(&initial_metadata_recv);
163 grpc_metadata_array_init(&trailing_metadata_recv);
164 grpc_metadata_array_init(&request_metadata_recv);
165 grpc_call_details_init(&call_details);
166 grpc_slice status_details = grpc_slice_from_static_string("xyz");
167
168 memset(ops, 0, sizeof(ops));
169 op = ops;
170 op->op = GRPC_OP_SEND_INITIAL_METADATA;
171 op->data.send_initial_metadata.count = 0;
172 op++;
173 op->op = GRPC_OP_SEND_MESSAGE;
174 op->data.send_message.send_message = request_payload;
175 op++;
176 op->op = GRPC_OP_RECV_MESSAGE;
177 op->data.recv_message.recv_message = &response_payload_recv;
178 op++;
179 op->op = GRPC_OP_SEND_CLOSE_FROM_CLIENT;
180 op++;
181 op->op = GRPC_OP_RECV_INITIAL_METADATA;
182 op->data.recv_initial_metadata.recv_initial_metadata = &initial_metadata_recv;
183 op++;
184 error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(1),
185 nullptr);
186 GPR_ASSERT(GRPC_CALL_OK == error);
187
188 error =
189 grpc_server_request_call(f.server, &s, &call_details,
190 &request_metadata_recv, f.cq, f.cq, tag(101));
191 GPR_ASSERT(GRPC_CALL_OK == error);
192 CQ_EXPECT_COMPLETION(cqv, tag(101), true);
193 cq_verify(cqv);
194
195 peer = grpc_call_get_peer(s);
196 GPR_ASSERT(peer != nullptr);
197 gpr_log(GPR_DEBUG, "server_peer=%s", peer);
198 gpr_free(peer);
199 peer = grpc_call_get_peer(c);
200 GPR_ASSERT(peer != nullptr);
201 gpr_log(GPR_DEBUG, "client_peer=%s", peer);
202 gpr_free(peer);
203
204 memset(ops, 0, sizeof(ops));
205 op = ops;
206 op->op = GRPC_OP_SEND_INITIAL_METADATA;
207 op->data.send_initial_metadata.count = 0;
208 op++;
209 op->op = GRPC_OP_SEND_STATUS_FROM_SERVER;
210 op->data.send_status_from_server.trailing_metadata_count = 0;
211 op->data.send_status_from_server.status = GRPC_STATUS_ABORTED;
212 op->data.send_status_from_server.status_details = &status_details;
213 op++;
214 op->op = GRPC_OP_RECV_CLOSE_ON_SERVER;
215 op->data.recv_close_on_server.cancelled = &was_cancelled;
216 op++;
217 error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops), tag(102),
218 nullptr);
219 GPR_ASSERT(GRPC_CALL_OK == error);
220
221 CQ_EXPECT_COMPLETION(cqv, tag(102), true);
222 CQ_EXPECT_COMPLETION(cqv, tag(1), true);
223 cq_verify(cqv);
224
225 memset(ops, 0, sizeof(ops));
226 op = ops;
227 op->op = GRPC_OP_RECV_STATUS_ON_CLIENT;
228 op->data.recv_status_on_client.trailing_metadata = &trailing_metadata_recv;
229 op->data.recv_status_on_client.status = &status;
230 op->data.recv_status_on_client.status_details = &details;
231 op++;
232 error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(2),
233 nullptr);
234 GPR_ASSERT(GRPC_CALL_OK == error);
235
236 CQ_EXPECT_COMPLETION(cqv, tag(2), true);
237 cq_verify(cqv);
238
239 GPR_ASSERT(status == GRPC_STATUS_INVALID_ARGUMENT);
240 GPR_ASSERT(0 == grpc_slice_str_cmp(details, "injected error"));
241 GPR_ASSERT(0 == grpc_slice_str_cmp(call_details.method, "/service/method"));
242 GPR_ASSERT(0 == call_details.flags);
243 GPR_ASSERT(was_cancelled == 0);
244
245 grpc_slice_unref(details);
246 grpc_metadata_array_destroy(&initial_metadata_recv);
247 grpc_metadata_array_destroy(&trailing_metadata_recv);
248 grpc_metadata_array_destroy(&request_metadata_recv);
249 grpc_call_details_destroy(&call_details);
250 grpc_byte_buffer_destroy(request_payload);
251 grpc_byte_buffer_destroy(response_payload);
252 grpc_byte_buffer_destroy(request_payload_recv);
253 grpc_byte_buffer_destroy(response_payload_recv);
254
255 grpc_call_unref(c);
256 grpc_call_unref(s);
257
258 cq_verifier_destroy(cqv);
259
260 end_test(&f);
261 config.tear_down_data(&f);
262 }
263
264 namespace {
265
266 // A filter that returns recv_trailing_metadata_ready with an error.
267 class InjectStatusFilter {
268 public:
269 static grpc_channel_filter kFilterVtable;
270
271 public:
272 class CallData {
273 public:
Init(grpc_call_element * elem,const grpc_call_element_args *)274 static grpc_error_handle Init(grpc_call_element* elem,
275 const grpc_call_element_args* /*args*/) {
276 new (elem->call_data) CallData();
277 return GRPC_ERROR_NONE;
278 }
279
Destroy(grpc_call_element * elem,const grpc_call_final_info *,grpc_closure *)280 static void Destroy(grpc_call_element* elem,
281 const grpc_call_final_info* /*final_info*/,
282 grpc_closure* /*ignored*/) {
283 auto* calld = static_cast<CallData*>(elem->call_data);
284 calld->~CallData();
285 }
286
StartTransportStreamOpBatch(grpc_call_element * elem,grpc_transport_stream_op_batch * batch)287 static void StartTransportStreamOpBatch(
288 grpc_call_element* elem, grpc_transport_stream_op_batch* batch) {
289 auto* calld = static_cast<CallData*>(elem->call_data);
290 if (batch->recv_trailing_metadata) {
291 calld->original_recv_trailing_metadata_ready_ =
292 batch->payload->recv_trailing_metadata.recv_trailing_metadata_ready;
293 batch->payload->recv_trailing_metadata.recv_trailing_metadata_ready =
294 &calld->recv_trailing_metadata_ready_;
295 }
296 grpc_call_next_op(elem, batch);
297 }
298
299 private:
CallData()300 CallData() {
301 GRPC_CLOSURE_INIT(&recv_trailing_metadata_ready_,
302 RecvTrailingMetadataReady, this, nullptr);
303 }
304
RecvTrailingMetadataReady(void * arg,grpc_error_handle)305 static void RecvTrailingMetadataReady(void* arg,
306 grpc_error_handle /*error*/) {
307 auto* calld = static_cast<CallData*>(arg);
308 grpc_core::Closure::Run(
309 DEBUG_LOCATION, calld->original_recv_trailing_metadata_ready_,
310 grpc_error_set_int(
311 GRPC_ERROR_CREATE_FROM_STATIC_STRING("injected error"),
312 GRPC_ERROR_INT_GRPC_STATUS, GRPC_STATUS_INVALID_ARGUMENT));
313 }
314
315 grpc_closure recv_trailing_metadata_ready_;
316 grpc_closure* original_recv_trailing_metadata_ready_ = nullptr;
317 };
318
Init(grpc_channel_element *,grpc_channel_element_args *)319 static grpc_error_handle Init(grpc_channel_element* /*elem*/,
320 grpc_channel_element_args* /*args*/) {
321 return GRPC_ERROR_NONE;
322 }
323
Destroy(grpc_channel_element *)324 static void Destroy(grpc_channel_element* /*elem*/) {}
325 };
326
327 grpc_channel_filter InjectStatusFilter::kFilterVtable = {
328 CallData::StartTransportStreamOpBatch,
329 grpc_channel_next_op,
330 sizeof(CallData),
331 CallData::Init,
332 grpc_call_stack_ignore_set_pollset_or_pollset_set,
333 CallData::Destroy,
334 0,
335 Init,
336 Destroy,
337 grpc_channel_next_get_info,
338 "InjectStatusFilter",
339 };
340
AddFilter(grpc_channel_stack_builder * builder)341 bool AddFilter(grpc_channel_stack_builder* builder) {
342 // Skip on proxy (which explicitly disables retries).
343 const grpc_channel_args* args =
344 grpc_channel_stack_builder_get_channel_arguments(builder);
345 if (!grpc_channel_args_find_bool(args, GRPC_ARG_ENABLE_RETRIES, true)) {
346 return true;
347 }
348 // Install filter.
349 return grpc_channel_stack_builder_prepend_filter(
350 builder, &InjectStatusFilter::kFilterVtable, nullptr, nullptr);
351 }
352
353 } // namespace
354
retry_recv_trailing_metadata_error(grpc_end2end_test_config config)355 void retry_recv_trailing_metadata_error(grpc_end2end_test_config config) {
356 GPR_ASSERT(config.feature_mask & FEATURE_MASK_SUPPORTS_CLIENT_CHANNEL);
357 grpc_core::CoreConfiguration::RunWithSpecialConfiguration(
358 [](grpc_core::CoreConfiguration::Builder* builder) {
359 grpc_core::BuildCoreConfiguration(builder);
360 builder->channel_init()->RegisterStage(GRPC_CLIENT_SUBCHANNEL, 0,
361 AddFilter);
362 },
363 [config] { test_retry_recv_trailing_metadata_error(config); });
364 }
365
retry_recv_trailing_metadata_error_pre_init()366 void retry_recv_trailing_metadata_error_pre_init() {}
367