test/core/end2end/tests/retry_send_initial_metadata_refs.cc

   1 /*
   2  *
   3  * Copyright 2017 gRPC authors.
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  */
  18
  19 #include <stdio.h>
  20 #include <string.h>
  21
  22 #include <grpc/byte_buffer.h>
  23 #include <grpc/grpc.h>
  24 #include <grpc/support/alloc.h>
  25 #include <grpc/support/log.h>
  26 #include <grpc/support/string_util.h>
  27 #include <grpc/support/time.h>
  28
  29 #include "src/core/lib/channel/channel_args.h"
  30 #include "src/core/lib/gpr/string.h"
  31 #include "src/core/lib/gpr/useful.h"
  32 #include "src/core/lib/iomgr/exec_ctx.h"
  33 #include "src/core/lib/transport/static_metadata.h"
  34 #include "test/core/end2end/cq_verifier.h"
  35 #include "test/core/end2end/end2end_tests.h"
  36 #include "test/core/end2end/tests/cancel_test_helpers.h"
  37
  38 static void* tag(intptr_t t) { return reinterpret_cast<void*>(t); }
  39
  40 static grpc_end2end_test_fixture begin_test(grpc_end2end_test_config config,
  41                                             const char* test_name,
  42                                             grpc_channel_args* client_args,
  43                                             grpc_channel_args* server_args) {
  44   grpc_end2end_test_fixture f;
  45   gpr_log(GPR_INFO, "Running test: %s/%s", test_name, config.name);
  46   f = config.create_fixture(client_args, server_args);
  47   config.init_server(&f, server_args);
  48   config.init_client(&f, client_args);
  49   return f;
  50 }
  51
  52 static gpr_timespec n_seconds_from_now(int n) {
  53   return grpc_timeout_seconds_to_deadline(n);
  54 }
  55
  56 static gpr_timespec five_seconds_from_now(void) {
  57   return n_seconds_from_now(5);
  58 }
  59
  60 static void drain_cq(grpc_completion_queue* cq) {
  61   grpc_event ev;
  62   do {
  63     ev = grpc_completion_queue_next(cq, five_seconds_from_now(), nullptr);
  64   } while (ev.type != GRPC_QUEUE_SHUTDOWN);
  65 }
  66
  67 static void shutdown_server(grpc_end2end_test_fixture* f) {
  68   if (!f->server) return;
  69   grpc_server_shutdown_and_notify(f->server, f->shutdown_cq, tag(1000));
  70   GPR_ASSERT(grpc_completion_queue_pluck(f->shutdown_cq, tag(1000),
  71                                          grpc_timeout_seconds_to_deadline(5),
  72                                          nullptr)
  73                  .type == GRPC_OP_COMPLETE);
  74   grpc_server_destroy(f->server);
  75   f->server = nullptr;
  76 }
  77
  78 static void shutdown_client(grpc_end2end_test_fixture* f) {
  79   if (!f->client) return;
  80   grpc_channel_destroy(f->client);
  81   f->client = nullptr;
  82 }
  83
  84 static void end_test(grpc_end2end_test_fixture* f) {
  85   shutdown_server(f);
  86   shutdown_client(f);
  87
  88   grpc_completion_queue_shutdown(f->cq);
  89   drain_cq(f->cq);
  90   grpc_completion_queue_destroy(f->cq);
  91   grpc_completion_queue_destroy(f->shutdown_cq);
  92 }
  93
  94 // Tests that we hold refs to send_initial_metadata payload while
  95 // cached, even after the caller has released its refs:
  96 // - 2 retries allowed for ABORTED status
  97 // - first attempt returns ABORTED
  98 // - second attempt returns OK
  99 static void test_retry_send_initial_metadata_refs(
 100     grpc_end2end_test_config config) {
 101   grpc_call* c;
 102   grpc_call* s;
 103   grpc_op ops[6];
 104   grpc_op* op;
 105   grpc_metadata_array client_send_initial_metadata;
 106   grpc_metadata_array initial_metadata_recv;
 107   grpc_metadata_array trailing_metadata_recv;
 108   grpc_metadata_array request_metadata_recv;
 109   grpc_call_details call_details;
 110   grpc_slice request_payload_slice = grpc_slice_from_static_string("foo");
 111   grpc_slice response_payload_slice = grpc_slice_from_static_string("bar");
 112   grpc_byte_buffer* request_payload =
 113       grpc_raw_byte_buffer_create(&request_payload_slice, 1);
 114   grpc_byte_buffer* response_payload =
 115       grpc_raw_byte_buffer_create(&response_payload_slice, 1);
 116   grpc_byte_buffer* request_payload_recv = nullptr;
 117   grpc_byte_buffer* response_payload_recv = nullptr;
 118   grpc_status_code status;
 119   grpc_call_error error;
 120   grpc_slice details;
 121   int was_cancelled = 2;
 122   char* peer;
 123
 124   grpc_arg args[] = {
 125       grpc_channel_arg_string_create(
 126           const_cast<char*>(GRPC_ARG_SERVICE_CONFIG),
 127           const_cast<char*>(
 128               "{\n"
 129               "  \"methodConfig\": [ {\n"
 130               "    \"name\": [\n"
 131               "      { \"service\": \"service\", \"method\": \"method\" }\n"
 132               "    ],\n"
 133               "    \"retryPolicy\": {\n"
 134               "      \"maxAttempts\": 3,\n"
 135               "      \"initialBackoff\": \"1s\",\n"
 136               "      \"maxBackoff\": \"120s\",\n"
 137               "      \"backoffMultiplier\": 1.6,\n"
 138               "      \"retryableStatusCodes\": [ \"ABORTED\" ]\n"
 139               "    }\n"
 140               "  } ]\n"
 141               "}")),
 142   };
 143   grpc_channel_args client_args = {GPR_ARRAY_SIZE(args), args};
 144   grpc_end2end_test_fixture f = begin_test(
 145       config, "retry_send_initial_metadata_refs", &client_args, nullptr);
 146
 147   cq_verifier* cqv = cq_verifier_create(f.cq);
 148
 149   gpr_timespec deadline = five_seconds_from_now();
 150   c = grpc_channel_create_call(f.client, nullptr, GRPC_PROPAGATE_DEFAULTS, f.cq,
 151                                grpc_slice_from_static_string("/service/method"),
 152                                nullptr, deadline, nullptr);
 153   GPR_ASSERT(c);
 154
 155   peer = grpc_call_get_peer(c);
 156   GPR_ASSERT(peer != nullptr);
 157   gpr_log(GPR_DEBUG, "client_peer_before_call=%s", peer);
 158   gpr_free(peer);
 159
 160   grpc_metadata_array_init(&client_send_initial_metadata);
 161   client_send_initial_metadata.count = 2;
 162   client_send_initial_metadata.metadata = static_cast<grpc_metadata*>(
 163       gpr_malloc(client_send_initial_metadata.count * sizeof(grpc_metadata)));
 164   // First element is short enough for slices to be inlined.
 165   client_send_initial_metadata.metadata[0].key =
 166       grpc_slice_from_copied_string(std::string("foo").c_str());
 167   client_send_initial_metadata.metadata[0].value =
 168       grpc_slice_from_copied_string(std::string("bar").c_str());
 169   // Second element requires slice allocation.
 170   client_send_initial_metadata.metadata[1].key = grpc_slice_from_copied_string(
 171       std::string(GRPC_SLICE_INLINED_SIZE + 1, 'x').c_str());
 172   client_send_initial_metadata.metadata[1].value =
 173       grpc_slice_from_copied_string(
 174           std::string(GRPC_SLICE_INLINED_SIZE + 1, 'y').c_str());
 175
 176   grpc_metadata_array_init(&initial_metadata_recv);
 177   grpc_metadata_array_init(&trailing_metadata_recv);
 178   grpc_metadata_array_init(&request_metadata_recv);
 179   grpc_call_details_init(&call_details);
 180   grpc_slice status_details = grpc_slice_from_static_string("xyz");
 181
 182   memset(ops, 0, sizeof(ops));
 183   op = ops;
 184   op->op = GRPC_OP_SEND_INITIAL_METADATA;
 185   op->data.send_initial_metadata.count = client_send_initial_metadata.count;
 186   op->data.send_initial_metadata.metadata =
 187       client_send_initial_metadata.metadata;
 188   op++;
 189   op->op = GRPC_OP_SEND_MESSAGE;
 190   op->data.send_message.send_message = request_payload;
 191   op++;
 192   op->op = GRPC_OP_SEND_CLOSE_FROM_CLIENT;
 193   op++;
 194   error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(1),
 195                                 nullptr);
 196   GPR_ASSERT(GRPC_CALL_OK == error);
 197   CQ_EXPECT_COMPLETION(cqv, tag(1), true);
 198   cq_verify(cqv);
 199
 200   for (size_t i = 0; i < client_send_initial_metadata.count; ++i) {
 201     grpc_slice_unref(client_send_initial_metadata.metadata[i].key);
 202     grpc_slice_unref(client_send_initial_metadata.metadata[i].value);
 203   }
 204   grpc_metadata_array_destroy(&client_send_initial_metadata);
 205
 206   memset(ops, 0, sizeof(ops));
 207   op = ops;
 208   op->op = GRPC_OP_RECV_MESSAGE;
 209   op->data.recv_message.recv_message = &response_payload_recv;
 210   op++;
 211   op->op = GRPC_OP_RECV_INITIAL_METADATA;
 212   op->data.recv_initial_metadata.recv_initial_metadata = &initial_metadata_recv;
 213   op++;
 214   op->op = GRPC_OP_RECV_STATUS_ON_CLIENT;
 215   op->data.recv_status_on_client.trailing_metadata = &trailing_metadata_recv;
 216   op->data.recv_status_on_client.status = &status;
 217   op->data.recv_status_on_client.status_details = &details;
 218   op++;
 219   error = grpc_call_start_batch(c, ops, static_cast<size_t>(op - ops), tag(2),
 220                                 nullptr);
 221   GPR_ASSERT(GRPC_CALL_OK == error);
 222
 223   error =
 224       grpc_server_request_call(f.server, &s, &call_details,
 225                                &request_metadata_recv, f.cq, f.cq, tag(101));
 226   GPR_ASSERT(GRPC_CALL_OK == error);
 227   CQ_EXPECT_COMPLETION(cqv, tag(101), true);
 228   cq_verify(cqv);
 229
 230   // Make sure the "grpc-previous-rpc-attempts" header was not sent in the
 231   // initial attempt.
 232   for (size_t i = 0; i < request_metadata_recv.count; ++i) {
 233     GPR_ASSERT(!grpc_slice_eq(request_metadata_recv.metadata[i].key,
 234                               GRPC_MDSTR_GRPC_PREVIOUS_RPC_ATTEMPTS));
 235   }
 236
 237   peer = grpc_call_get_peer(s);
 238   GPR_ASSERT(peer != nullptr);
 239   gpr_log(GPR_DEBUG, "server_peer=%s", peer);
 240   gpr_free(peer);
 241   peer = grpc_call_get_peer(c);
 242   GPR_ASSERT(peer != nullptr);
 243   gpr_log(GPR_DEBUG, "client_peer=%s", peer);
 244   gpr_free(peer);
 245
 246   memset(ops, 0, sizeof(ops));
 247   op = ops;
 248   op->op = GRPC_OP_SEND_INITIAL_METADATA;
 249   op->data.send_initial_metadata.count = 0;
 250   op++;
 251   op->op = GRPC_OP_SEND_STATUS_FROM_SERVER;
 252   op->data.send_status_from_server.trailing_metadata_count = 0;
 253   op->data.send_status_from_server.status = GRPC_STATUS_ABORTED;
 254   op->data.send_status_from_server.status_details = &status_details;
 255   op++;
 256   op->op = GRPC_OP_RECV_CLOSE_ON_SERVER;
 257   op->data.recv_close_on_server.cancelled = &was_cancelled;
 258   op++;
 259   error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops), tag(102),
 260                                 nullptr);
 261   GPR_ASSERT(GRPC_CALL_OK == error);
 262
 263   CQ_EXPECT_COMPLETION(cqv, tag(102), true);
 264   cq_verify(cqv);
 265
 266   grpc_call_unref(s);
 267   grpc_metadata_array_destroy(&request_metadata_recv);
 268   grpc_metadata_array_init(&request_metadata_recv);
 269   grpc_call_details_destroy(&call_details);
 270   grpc_call_details_init(&call_details);
 271
 272   error =
 273       grpc_server_request_call(f.server, &s, &call_details,
 274                                &request_metadata_recv, f.cq, f.cq, tag(201));
 275   GPR_ASSERT(GRPC_CALL_OK == error);
 276   CQ_EXPECT_COMPLETION(cqv, tag(201), true);
 277   cq_verify(cqv);
 278
 279   // Make sure the "grpc-previous-rpc-attempts" header was sent in the retry.
 280   GPR_ASSERT(contains_metadata_slices(&request_metadata_recv,
 281                                       GRPC_MDSTR_GRPC_PREVIOUS_RPC_ATTEMPTS,
 282                                       GRPC_MDSTR_1));
 283   // It should also contain the initial metadata, even though the client
 284   // freed it already.
 285   GPR_ASSERT(contains_metadata(&request_metadata_recv, "foo", "bar"));
 286   GPR_ASSERT(
 287       contains_metadata(&request_metadata_recv,
 288                         std::string(GRPC_SLICE_INLINED_SIZE + 1, 'x').c_str(),
 289                         std::string(GRPC_SLICE_INLINED_SIZE + 1, 'y').c_str()));
 290
 291   peer = grpc_call_get_peer(s);
 292   GPR_ASSERT(peer != nullptr);
 293   gpr_log(GPR_DEBUG, "server_peer=%s", peer);
 294   gpr_free(peer);
 295   peer = grpc_call_get_peer(c);
 296   GPR_ASSERT(peer != nullptr);
 297   gpr_log(GPR_DEBUG, "client_peer=%s", peer);
 298   gpr_free(peer);
 299
 300   memset(ops, 0, sizeof(ops));
 301   op = ops;
 302   op->op = GRPC_OP_SEND_INITIAL_METADATA;
 303   op->data.send_initial_metadata.count = 0;
 304   op++;
 305   op->op = GRPC_OP_RECV_MESSAGE;
 306   op->data.recv_message.recv_message = &request_payload_recv;
 307   op++;
 308   op->op = GRPC_OP_SEND_MESSAGE;
 309   op->data.send_message.send_message = response_payload;
 310   op++;
 311   op->op = GRPC_OP_SEND_STATUS_FROM_SERVER;
 312   op->data.send_status_from_server.trailing_metadata_count = 0;
 313   op->data.send_status_from_server.status = GRPC_STATUS_OK;
 314   op->data.send_status_from_server.status_details = &status_details;
 315   op++;
 316   op->op = GRPC_OP_RECV_CLOSE_ON_SERVER;
 317   op->data.recv_close_on_server.cancelled = &was_cancelled;
 318   op++;
 319   error = grpc_call_start_batch(s, ops, static_cast<size_t>(op - ops), tag(202),
 320                                 nullptr);
 321   GPR_ASSERT(GRPC_CALL_OK == error);
 322
 323   CQ_EXPECT_COMPLETION(cqv, tag(202), true);
 324   CQ_EXPECT_COMPLETION(cqv, tag(2), true);
 325   cq_verify(cqv);
 326
 327   GPR_ASSERT(status == GRPC_STATUS_OK);
 328   GPR_ASSERT(0 == grpc_slice_str_cmp(details, "xyz"));
 329   GPR_ASSERT(0 == grpc_slice_str_cmp(call_details.method, "/service/method"));
 330   GPR_ASSERT(0 == call_details.flags);
 331   GPR_ASSERT(was_cancelled == 0);
 332
 333   grpc_slice_unref(details);
 334   grpc_metadata_array_destroy(&initial_metadata_recv);
 335   grpc_metadata_array_destroy(&trailing_metadata_recv);
 336   grpc_metadata_array_destroy(&request_metadata_recv);
 337   grpc_call_details_destroy(&call_details);
 338   grpc_byte_buffer_destroy(request_payload);
 339   grpc_byte_buffer_destroy(response_payload);
 340   grpc_byte_buffer_destroy(request_payload_recv);
 341   grpc_byte_buffer_destroy(response_payload_recv);
 342
 343   grpc_call_unref(c);
 344   grpc_call_unref(s);
 345
 346   cq_verifier_destroy(cqv);
 347
 348   end_test(&f);
 349   config.tear_down_data(&f);
 350 }
 351
 352 void retry_send_initial_metadata_refs(grpc_end2end_test_config config) {
 353   GPR_ASSERT(config.feature_mask & FEATURE_MASK_SUPPORTS_CLIENT_CHANNEL);
 354   test_retry_send_initial_metadata_refs(config);
 355 }
 356
 357 void retry_send_initial_metadata_refs_pre_init(void) {}