diff --git a/CMakeLists.txt b/CMakeLists.txt index 50259800c3d..305a9622ea0 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -1116,6 +1116,7 @@ add_library(end2end_nosec_tests test/core/end2end/tests/retry_cancel_during_delay.cc test/core/end2end/tests/retry_cancellation.cc test/core/end2end/tests/retry_disabled.cc + test/core/end2end/tests/retry_exceeds_buffer_size_in_delay.cc test/core/end2end/tests/retry_exceeds_buffer_size_in_initial_batch.cc test/core/end2end/tests/retry_exceeds_buffer_size_in_subsequent_batch.cc test/core/end2end/tests/retry_lb_drop.cc @@ -1250,6 +1251,7 @@ add_library(end2end_tests test/core/end2end/tests/retry_cancel_during_delay.cc test/core/end2end/tests/retry_cancellation.cc test/core/end2end/tests/retry_disabled.cc + test/core/end2end/tests/retry_exceeds_buffer_size_in_delay.cc test/core/end2end/tests/retry_exceeds_buffer_size_in_initial_batch.cc test/core/end2end/tests/retry_exceeds_buffer_size_in_subsequent_batch.cc test/core/end2end/tests/retry_lb_drop.cc diff --git a/build_autogenerated.yaml b/build_autogenerated.yaml index 1bddf9ce3de..edd92982a1c 100644 --- a/build_autogenerated.yaml +++ b/build_autogenerated.yaml @@ -87,6 +87,7 @@ libs: - test/core/end2end/tests/retry_cancel_during_delay.cc - test/core/end2end/tests/retry_cancellation.cc - test/core/end2end/tests/retry_disabled.cc + - test/core/end2end/tests/retry_exceeds_buffer_size_in_delay.cc - test/core/end2end/tests/retry_exceeds_buffer_size_in_initial_batch.cc - test/core/end2end/tests/retry_exceeds_buffer_size_in_subsequent_batch.cc - test/core/end2end/tests/retry_lb_drop.cc @@ -196,6 +197,7 @@ libs: - test/core/end2end/tests/retry_cancel_during_delay.cc - test/core/end2end/tests/retry_cancellation.cc - test/core/end2end/tests/retry_disabled.cc + - test/core/end2end/tests/retry_exceeds_buffer_size_in_delay.cc - test/core/end2end/tests/retry_exceeds_buffer_size_in_initial_batch.cc - test/core/end2end/tests/retry_exceeds_buffer_size_in_subsequent_batch.cc - test/core/end2end/tests/retry_lb_drop.cc diff --git a/gRPC-Core.podspec b/gRPC-Core.podspec index fbd7146ede5..512515a9dce 100644 --- a/gRPC-Core.podspec +++ b/gRPC-Core.podspec @@ -2087,6 +2087,7 @@ Pod::Spec.new do |s| 'test/core/end2end/tests/retry_cancel_during_delay.cc', 'test/core/end2end/tests/retry_cancellation.cc', 'test/core/end2end/tests/retry_disabled.cc', + 'test/core/end2end/tests/retry_exceeds_buffer_size_in_delay.cc', 'test/core/end2end/tests/retry_exceeds_buffer_size_in_initial_batch.cc', 'test/core/end2end/tests/retry_exceeds_buffer_size_in_subsequent_batch.cc', 'test/core/end2end/tests/retry_lb_drop.cc', diff --git a/grpc.gyp b/grpc.gyp index b717f768564..de939ad8bcf 100644 --- a/grpc.gyp +++ b/grpc.gyp @@ -241,6 +241,7 @@ 'test/core/end2end/tests/retry_cancel_during_delay.cc', 'test/core/end2end/tests/retry_cancellation.cc', 'test/core/end2end/tests/retry_disabled.cc', + 'test/core/end2end/tests/retry_exceeds_buffer_size_in_delay.cc', 'test/core/end2end/tests/retry_exceeds_buffer_size_in_initial_batch.cc', 'test/core/end2end/tests/retry_exceeds_buffer_size_in_subsequent_batch.cc', 'test/core/end2end/tests/retry_lb_drop.cc', @@ -343,6 +344,7 @@ 'test/core/end2end/tests/retry_cancel_during_delay.cc', 'test/core/end2end/tests/retry_cancellation.cc', 'test/core/end2end/tests/retry_disabled.cc', + 'test/core/end2end/tests/retry_exceeds_buffer_size_in_delay.cc', 'test/core/end2end/tests/retry_exceeds_buffer_size_in_initial_batch.cc', 'test/core/end2end/tests/retry_exceeds_buffer_size_in_subsequent_batch.cc', 'test/core/end2end/tests/retry_lb_drop.cc', diff --git a/test/core/end2end/end2end_nosec_tests.cc b/test/core/end2end/end2end_nosec_tests.cc index 958b1b73f8f..277df1765ac 100644 --- a/test/core/end2end/end2end_nosec_tests.cc +++ b/test/core/end2end/end2end_nosec_tests.cc @@ -131,6 +131,8 @@ extern void retry_cancellation(grpc_end2end_test_config config); extern void retry_cancellation_pre_init(void); extern void retry_disabled(grpc_end2end_test_config config); extern void retry_disabled_pre_init(void); +extern void retry_exceeds_buffer_size_in_delay(grpc_end2end_test_config config); +extern void retry_exceeds_buffer_size_in_delay_pre_init(void); extern void retry_exceeds_buffer_size_in_initial_batch(grpc_end2end_test_config config); extern void retry_exceeds_buffer_size_in_initial_batch_pre_init(void); extern void retry_exceeds_buffer_size_in_subsequent_batch(grpc_end2end_test_config config); @@ -246,6 +248,7 @@ void grpc_end2end_tests_pre_init(void) { retry_cancel_during_delay_pre_init(); retry_cancellation_pre_init(); retry_disabled_pre_init(); + retry_exceeds_buffer_size_in_delay_pre_init(); retry_exceeds_buffer_size_in_initial_batch_pre_init(); retry_exceeds_buffer_size_in_subsequent_batch_pre_init(); retry_lb_drop_pre_init(); @@ -336,6 +339,7 @@ void grpc_end2end_tests(int argc, char **argv, retry_cancel_during_delay(config); retry_cancellation(config); retry_disabled(config); + retry_exceeds_buffer_size_in_delay(config); retry_exceeds_buffer_size_in_initial_batch(config); retry_exceeds_buffer_size_in_subsequent_batch(config); retry_lb_drop(config); @@ -574,6 +578,10 @@ void grpc_end2end_tests(int argc, char **argv, retry_disabled(config); continue; } + if (0 == strcmp("retry_exceeds_buffer_size_in_delay", argv[i])) { + retry_exceeds_buffer_size_in_delay(config); + continue; + } if (0 == strcmp("retry_exceeds_buffer_size_in_initial_batch", argv[i])) { retry_exceeds_buffer_size_in_initial_batch(config); continue; diff --git a/test/core/end2end/end2end_tests.cc b/test/core/end2end/end2end_tests.cc index d3603b3886f..a00026496ae 100644 --- a/test/core/end2end/end2end_tests.cc +++ b/test/core/end2end/end2end_tests.cc @@ -133,6 +133,8 @@ extern void retry_cancellation(grpc_end2end_test_config config); extern void retry_cancellation_pre_init(void); extern void retry_disabled(grpc_end2end_test_config config); extern void retry_disabled_pre_init(void); +extern void retry_exceeds_buffer_size_in_delay(grpc_end2end_test_config config); +extern void retry_exceeds_buffer_size_in_delay_pre_init(void); extern void retry_exceeds_buffer_size_in_initial_batch(grpc_end2end_test_config config); extern void retry_exceeds_buffer_size_in_initial_batch_pre_init(void); extern void retry_exceeds_buffer_size_in_subsequent_batch(grpc_end2end_test_config config); @@ -249,6 +251,7 @@ void grpc_end2end_tests_pre_init(void) { retry_cancel_during_delay_pre_init(); retry_cancellation_pre_init(); retry_disabled_pre_init(); + retry_exceeds_buffer_size_in_delay_pre_init(); retry_exceeds_buffer_size_in_initial_batch_pre_init(); retry_exceeds_buffer_size_in_subsequent_batch_pre_init(); retry_lb_drop_pre_init(); @@ -340,6 +343,7 @@ void grpc_end2end_tests(int argc, char **argv, retry_cancel_during_delay(config); retry_cancellation(config); retry_disabled(config); + retry_exceeds_buffer_size_in_delay(config); retry_exceeds_buffer_size_in_initial_batch(config); retry_exceeds_buffer_size_in_subsequent_batch(config); retry_lb_drop(config); @@ -582,6 +586,10 @@ void grpc_end2end_tests(int argc, char **argv, retry_disabled(config); continue; } + if (0 == strcmp("retry_exceeds_buffer_size_in_delay", argv[i])) { + retry_exceeds_buffer_size_in_delay(config); + continue; + } if (0 == strcmp("retry_exceeds_buffer_size_in_initial_batch", argv[i])) { retry_exceeds_buffer_size_in_initial_batch(config); continue; diff --git a/test/core/end2end/generate_tests.bzl b/test/core/end2end/generate_tests.bzl index 58aae8f0020..c5f4f40e434 100755 --- a/test/core/end2end/generate_tests.bzl +++ b/test/core/end2end/generate_tests.bzl @@ -286,6 +286,10 @@ END2END_TESTS = { proxyable = False, ), "retry_disabled": _test_options(needs_client_channel = True, proxyable = False), + "retry_exceeds_buffer_size_in_delay": _test_options( + needs_client_channel = True, + proxyable = False, + ), "retry_exceeds_buffer_size_in_initial_batch": _test_options( needs_client_channel = True, proxyable = False, diff --git a/test/core/end2end/tests/retry_exceeds_buffer_size_in_delay.cc b/test/core/end2end/tests/retry_exceeds_buffer_size_in_delay.cc new file mode 100644 index 00000000000..79b03dd1cf7 --- /dev/null +++ b/test/core/end2end/tests/retry_exceeds_buffer_size_in_delay.cc @@ -0,0 +1,319 @@ +// +// Copyright 2021 gRPC authors. +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// + +#include "test/core/end2end/end2end_tests.h" + +#include +#include + +#include +#include +#include +#include +#include +#include + +#include "src/core/lib/channel/channel_args.h" +#include "src/core/lib/gpr/string.h" +#include "src/core/lib/gpr/useful.h" +#include "src/core/lib/iomgr/exec_ctx.h" +#include "src/core/lib/transport/static_metadata.h" + +#include "test/core/end2end/cq_verifier.h" +#include "test/core/end2end/tests/cancel_test_helpers.h" + +static void* tag(intptr_t t) { return reinterpret_cast(t); } + +static grpc_end2end_test_fixture begin_test(grpc_end2end_test_config config, + const char* test_name, + grpc_channel_args* client_args, + grpc_channel_args* server_args) { + grpc_end2end_test_fixture f; + gpr_log(GPR_INFO, "Running test: %s/%s", test_name, config.name); + f = config.create_fixture(client_args, server_args); + config.init_server(&f, server_args); + config.init_client(&f, client_args); + return f; +} + +static gpr_timespec n_seconds_from_now(int n) { + return grpc_timeout_seconds_to_deadline(n); +} + +static gpr_timespec five_seconds_from_now(void) { + return n_seconds_from_now(5); +} + +static void drain_cq(grpc_completion_queue* cq) { + grpc_event ev; + do { + ev = grpc_completion_queue_next(cq, five_seconds_from_now(), nullptr); + } while (ev.type != GRPC_QUEUE_SHUTDOWN); +} + +static void shutdown_server(grpc_end2end_test_fixture* f) { + if (!f->server) return; + grpc_server_shutdown_and_notify(f->server, f->shutdown_cq, tag(1000)); + GPR_ASSERT(grpc_completion_queue_pluck(f->shutdown_cq, tag(1000), + grpc_timeout_seconds_to_deadline(5), + nullptr) + .type == GRPC_OP_COMPLETE); + grpc_server_destroy(f->server); + f->server = nullptr; +} + +static void shutdown_client(grpc_end2end_test_fixture* f) { + if (!f->client) return; + grpc_channel_destroy(f->client); + f->client = nullptr; +} + +static void end_test(grpc_end2end_test_fixture* f) { + shutdown_server(f); + shutdown_client(f); + + grpc_completion_queue_shutdown(f->cq); + drain_cq(f->cq); + grpc_completion_queue_destroy(f->cq); + grpc_completion_queue_destroy(f->shutdown_cq); +} + +// Tests the case where the retry buffer size is exceeded during backoff. +// - 1 retry allowed for ABORTED status +// - buffer size set to 100 KiB (larger than initial metadata) +// - client initially sends initial metadata (smaller than buffer size) +// - server sends ABORTED, client goes into backoff delay +// - client sends a 100 KiB message, thus exceeding the buffer size limit +// - retry attempt gets ABORTED but is not retried +static void test_retry_exceeds_buffer_size_in_delay( + grpc_end2end_test_config config) { + grpc_call* c; + grpc_call* s; + grpc_op ops[6]; + grpc_op* op; + grpc_metadata_array initial_metadata_recv; + grpc_metadata_array trailing_metadata_recv; + grpc_metadata_array request_metadata_recv; + grpc_call_details call_details; + const size_t buf_size = 102401; + char* buf = static_cast(gpr_malloc(buf_size * sizeof(*buf))); + memset(buf, 'a', buf_size - 1); + buf[buf_size - 1] = '\0'; + grpc_slice request_payload_slice = grpc_slice_from_static_string(buf); + grpc_slice response_payload_slice = grpc_slice_from_static_string("bar"); + grpc_byte_buffer* request_payload = + grpc_raw_byte_buffer_create(&request_payload_slice, 1); + grpc_byte_buffer* response_payload = + grpc_raw_byte_buffer_create(&response_payload_slice, 1); + grpc_byte_buffer* request_payload_recv = nullptr; + grpc_byte_buffer* response_payload_recv = nullptr; + grpc_status_code status; + grpc_call_error error; + grpc_slice details; + int was_cancelled = 2; + char* peer; + + grpc_arg args[] = { + grpc_channel_arg_integer_create( + const_cast(GRPC_ARG_ENABLE_RETRIES), 1), + grpc_channel_arg_string_create( + const_cast(GRPC_ARG_SERVICE_CONFIG), + const_cast( + "{\n" + " \"methodConfig\": [ {\n" + " \"name\": [\n" + " { \"service\": \"service\", \"method\": \"method\" }\n" + " ],\n" + " \"retryPolicy\": {\n" + " \"maxAttempts\": 3,\n" + " \"initialBackoff\": \"2s\",\n" + " \"maxBackoff\": \"120s\",\n" + " \"backoffMultiplier\": 1.6,\n" + " \"retryableStatusCodes\": [ \"ABORTED\" ]\n" + " }\n" + " } ]\n" + "}")), + grpc_channel_arg_integer_create( + const_cast(GRPC_ARG_PER_RPC_RETRY_BUFFER_SIZE), 102400), + }; + grpc_channel_args client_args = {GPR_ARRAY_SIZE(args), args}; + grpc_end2end_test_fixture f = begin_test( + config, "retry_exceeds_buffer_size_in_delay", &client_args, nullptr); + + cq_verifier* cqv = cq_verifier_create(f.cq); + + gpr_timespec deadline = grpc_timeout_milliseconds_to_deadline(15000); + c = grpc_channel_create_call(f.client, nullptr, GRPC_PROPAGATE_DEFAULTS, f.cq, + grpc_slice_from_static_string("/service/method"), + nullptr, deadline, nullptr); + GPR_ASSERT(c); + + peer = grpc_call_get_peer(c); + GPR_ASSERT(peer != nullptr); + gpr_log(GPR_DEBUG, "client_peer_before_call=%s", peer); + gpr_free(peer); + + grpc_metadata_array_init(&initial_metadata_recv); + grpc_metadata_array_init(&trailing_metadata_recv); + grpc_metadata_array_init(&request_metadata_recv); + grpc_call_details_init(&call_details); + grpc_slice status_details = grpc_slice_from_static_string("xyz"); + + // Client sends initial metadata and starts the recv ops. + memset(ops, 0, sizeof(ops)); + op = ops; + op->op = GRPC_OP_SEND_INITIAL_METADATA; + op->data.send_initial_metadata.count = 0; + op++; + op->op = GRPC_OP_RECV_MESSAGE; + op->data.recv_message.recv_message = &response_payload_recv; + op++; + op->op = GRPC_OP_RECV_INITIAL_METADATA; + op->data.recv_initial_metadata.recv_initial_metadata = &initial_metadata_recv; + op++; + op->op = GRPC_OP_RECV_STATUS_ON_CLIENT; + op->data.recv_status_on_client.trailing_metadata = &trailing_metadata_recv; + op->data.recv_status_on_client.status = &status; + op->data.recv_status_on_client.status_details = &details; + op++; + error = grpc_call_start_batch(c, ops, static_cast(op - ops), tag(1), + nullptr); + GPR_ASSERT(GRPC_CALL_OK == error); + + // Server gets a call. + error = + grpc_server_request_call(f.server, &s, &call_details, + &request_metadata_recv, f.cq, f.cq, tag(101)); + GPR_ASSERT(GRPC_CALL_OK == error); + CQ_EXPECT_COMPLETION(cqv, tag(101), true); + cq_verify(cqv); + + peer = grpc_call_get_peer(s); + GPR_ASSERT(peer != nullptr); + gpr_log(GPR_DEBUG, "server_peer=%s", peer); + gpr_free(peer); + peer = grpc_call_get_peer(c); + GPR_ASSERT(peer != nullptr); + gpr_log(GPR_DEBUG, "client_peer=%s", peer); + gpr_free(peer); + + // Server sends ABORTED. This tells the client to retry. + memset(ops, 0, sizeof(ops)); + op = ops; + op->op = GRPC_OP_SEND_INITIAL_METADATA; + op->data.send_initial_metadata.count = 0; + op++; + op->op = GRPC_OP_SEND_STATUS_FROM_SERVER; + op->data.send_status_from_server.trailing_metadata_count = 0; + op->data.send_status_from_server.status = GRPC_STATUS_ABORTED; + op->data.send_status_from_server.status_details = &status_details; + op++; + op->op = GRPC_OP_RECV_CLOSE_ON_SERVER; + op->data.recv_close_on_server.cancelled = &was_cancelled; + op++; + error = grpc_call_start_batch(s, ops, static_cast(op - ops), tag(102), + nullptr); + GPR_ASSERT(GRPC_CALL_OK == error); + CQ_EXPECT_COMPLETION(cqv, tag(102), true); + cq_verify(cqv); + + grpc_call_unref(s); + grpc_metadata_array_destroy(&request_metadata_recv); + grpc_metadata_array_init(&request_metadata_recv); + grpc_call_details_destroy(&call_details); + grpc_call_details_init(&call_details); + + // Do a bit more polling, to make sure the client sees status from the + // first attempt. (Note: This polls for 1s, which is less than the + // retry initial backoff time of 2s from the service config above.) + cq_verify_empty(cqv); + + // Client sends a message that puts it over the buffer size limit. + memset(ops, 0, sizeof(ops)); + op = ops; + op->op = GRPC_OP_SEND_MESSAGE; + op->data.send_message.send_message = request_payload; + op++; + op->op = GRPC_OP_SEND_CLOSE_FROM_CLIENT; + op++; + error = grpc_call_start_batch(c, ops, static_cast(op - ops), tag(2), + nullptr); + GPR_ASSERT(GRPC_CALL_OK == error); + CQ_EXPECT_COMPLETION(cqv, tag(2), true); + cq_verify(cqv); + + // Server gets another call. + error = + grpc_server_request_call(f.server, &s, &call_details, + &request_metadata_recv, f.cq, f.cq, tag(201)); + GPR_ASSERT(GRPC_CALL_OK == error); + CQ_EXPECT_COMPLETION(cqv, tag(201), true); + cq_verify(cqv); + + // Server again sends ABORTED. But this time, the client won't retry, + // since the call has been committed by exceeding the buffer size. + memset(ops, 0, sizeof(ops)); + op = ops; + op->op = GRPC_OP_SEND_INITIAL_METADATA; + op->data.send_initial_metadata.count = 0; + op++; + op->op = GRPC_OP_SEND_STATUS_FROM_SERVER; + op->data.send_status_from_server.trailing_metadata_count = 0; + op->data.send_status_from_server.status = GRPC_STATUS_ABORTED; + op->data.send_status_from_server.status_details = &status_details; + op++; + op->op = GRPC_OP_RECV_CLOSE_ON_SERVER; + op->data.recv_close_on_server.cancelled = &was_cancelled; + op++; + error = grpc_call_start_batch(s, ops, static_cast(op - ops), tag(202), + nullptr); + GPR_ASSERT(GRPC_CALL_OK == error); + CQ_EXPECT_COMPLETION(cqv, tag(202), true); + CQ_EXPECT_COMPLETION(cqv, tag(1), true); + cq_verify(cqv); + + GPR_ASSERT(status == GRPC_STATUS_ABORTED); + GPR_ASSERT(0 == grpc_slice_str_cmp(details, "xyz")); + GPR_ASSERT(0 == grpc_slice_str_cmp(call_details.method, "/service/method")); + GPR_ASSERT(0 == call_details.flags); + GPR_ASSERT(was_cancelled == 0); + + grpc_slice_unref(details); + grpc_metadata_array_destroy(&initial_metadata_recv); + grpc_metadata_array_destroy(&trailing_metadata_recv); + grpc_metadata_array_destroy(&request_metadata_recv); + grpc_call_details_destroy(&call_details); + grpc_byte_buffer_destroy(request_payload); + grpc_byte_buffer_destroy(response_payload); + grpc_byte_buffer_destroy(request_payload_recv); + grpc_byte_buffer_destroy(response_payload_recv); + + grpc_call_unref(c); + grpc_call_unref(s); + + cq_verifier_destroy(cqv); + + end_test(&f); + config.tear_down_data(&f); + gpr_free(buf); +} + +void retry_exceeds_buffer_size_in_delay(grpc_end2end_test_config config) { + GPR_ASSERT(config.feature_mask & FEATURE_MASK_SUPPORTS_CLIENT_CHANNEL); + test_retry_exceeds_buffer_size_in_delay(config); +} + +void retry_exceeds_buffer_size_in_delay_pre_init(void) {}