| // |
| // |
| // Copyright 2017 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 <string.h> |
| |
| #include <functional> |
| #include <memory> |
| #include <new> |
| |
| #include "absl/status/status.h" |
| #include "absl/types/optional.h" |
| |
| #include <grpc/byte_buffer.h> |
| #include <grpc/grpc.h> |
| #include <grpc/impl/propagation_bits.h> |
| #include <grpc/slice.h> |
| #include <grpc/status.h> |
| #include <grpc/support/alloc.h> |
| #include <grpc/support/log.h> |
| #include <grpc/support/time.h> |
| |
| #include "src/core/lib/channel/channel_args.h" |
| #include "src/core/lib/channel/channel_fwd.h" |
| #include "src/core/lib/channel/channel_stack.h" |
| #include "src/core/lib/channel/channel_stack_builder.h" |
| #include "src/core/lib/config/core_configuration.h" |
| #include "src/core/lib/gpr/useful.h" |
| #include "src/core/lib/gprpp/status_helper.h" |
| #include "src/core/lib/iomgr/call_combiner.h" |
| #include "src/core/lib/iomgr/closure.h" |
| #include "src/core/lib/iomgr/error.h" |
| #include "src/core/lib/surface/channel_stack_type.h" |
| #include "src/core/lib/transport/transport.h" |
| #include "test/core/end2end/cq_verifier.h" |
| #include "test/core/end2end/end2end_tests.h" |
| #include "test/core/util/test_config.h" |
| |
| static std::unique_ptr<CoreTestFixture> begin_test( |
| const CoreTestConfiguration& config, const char* test_name, |
| grpc_channel_args* client_args, grpc_channel_args* server_args) { |
| gpr_log(GPR_INFO, "Running test: %s/%s", test_name, config.name); |
| auto f = config.create_fixture(grpc_core::ChannelArgs::FromC(client_args), |
| grpc_core::ChannelArgs::FromC(server_args)); |
| f->InitServer(grpc_core::ChannelArgs::FromC(server_args)); |
| f->InitClient(grpc_core::ChannelArgs::FromC(client_args)); |
| return f; |
| } |
| |
| // Tests failure on a send op batch: |
| // - 2 retries allowed for ABORTED status |
| // - on the first call attempt, the batch containing the |
| // send_initial_metadata op fails, and then the call returns ABORTED, |
| // all without ever going out on the wire |
| // - second attempt returns ABORTED but does not retry, because only 2 |
| // attempts are allowed |
| static void test_retry_send_op_fails(const CoreTestConfiguration& 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; |
| grpc_slice request_payload_slice = grpc_slice_from_static_string("foo"); |
| 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_string_create( |
| const_cast<char*>(GRPC_ARG_SERVICE_CONFIG), |
| const_cast<char*>( |
| "{\n" |
| " \"methodConfig\": [ {\n" |
| " \"name\": [\n" |
| " { \"service\": \"service\", \"method\": \"method\" }\n" |
| " ],\n" |
| " \"retryPolicy\": {\n" |
| " \"maxAttempts\": 2,\n" |
| " \"initialBackoff\": \"1s\",\n" |
| " \"maxBackoff\": \"120s\",\n" |
| " \"backoffMultiplier\": 1.6,\n" |
| " \"retryableStatusCodes\": [ \"ABORTED\" ]\n" |
| " }\n" |
| " } ]\n" |
| "}")), |
| }; |
| grpc_channel_args client_args = {GPR_ARRAY_SIZE(args), args}; |
| auto f = begin_test(config, "retry_send_op_fails", &client_args, nullptr); |
| |
| grpc_core::CqVerifier cqv(f->cq()); |
| |
| gpr_timespec deadline = grpc_timeout_seconds_to_deadline(5); |
| 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"); |
| |
| // Start a batch containing send 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_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<size_t>(op - ops), |
| grpc_core::CqVerifier::tag(1), nullptr); |
| GPR_ASSERT(GRPC_CALL_OK == error); |
| |
| // Start a batch containing recv ops. |
| memset(ops, 0, sizeof(ops)); |
| op = ops; |
| 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<size_t>(op - ops), |
| grpc_core::CqVerifier::tag(2), nullptr); |
| GPR_ASSERT(GRPC_CALL_OK == error); |
| |
| // Client send ops should now complete. |
| cqv.Expect(grpc_core::CqVerifier::tag(1), true); |
| cqv.Verify(); |
| |
| // Server should get a call. |
| error = grpc_server_request_call(f->server(), &s, &call_details, |
| &request_metadata_recv, f->cq(), f->cq(), |
| grpc_core::CqVerifier::tag(101)); |
| GPR_ASSERT(GRPC_CALL_OK == error); |
| cqv.Expect(grpc_core::CqVerifier::tag(101), true); |
| cqv.Verify(); |
| |
| // Server fails with status ABORTED. |
| 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<size_t>(op - ops), |
| grpc_core::CqVerifier::tag(102), nullptr); |
| GPR_ASSERT(GRPC_CALL_OK == error); |
| |
| // In principle, the server batch should complete before the client |
| // recv ops batch, but in the proxy fixtures, there are multiple threads |
| // involved, so the completion order tends to be a little racy. |
| cqv.Expect(grpc_core::CqVerifier::tag(102), true); |
| cqv.Expect(grpc_core::CqVerifier::tag(2), true); |
| cqv.Verify(); |
| |
| 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(was_cancelled == 0); |
| |
| // Make sure the "grpc-previous-rpc-attempts" header was sent in the retry. |
| bool found_retry_header = false; |
| for (size_t i = 0; i < request_metadata_recv.count; ++i) { |
| if (grpc_slice_eq( |
| request_metadata_recv.metadata[i].key, |
| grpc_slice_from_static_string("grpc-previous-rpc-attempts"))) { |
| GPR_ASSERT(grpc_slice_eq(request_metadata_recv.metadata[i].value, |
| grpc_slice_from_static_string("1"))); |
| found_retry_header = true; |
| break; |
| } |
| } |
| GPR_ASSERT(found_retry_header); |
| |
| 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); |
| } |
| |
| namespace { |
| |
| // A filter that, for the first call it sees, will fail all batches except |
| // for cancellations, so that the call fails with status ABORTED. |
| // All subsequent calls are allowed through without failures. |
| class FailFirstCallFilter { |
| public: |
| static grpc_channel_filter kFilterVtable; |
| |
| private: |
| class CallData { |
| public: |
| static grpc_error_handle Init(grpc_call_element* elem, |
| const grpc_call_element_args* args) { |
| new (elem->call_data) CallData(args); |
| return absl::OkStatus(); |
| } |
| |
| static void Destroy(grpc_call_element* elem, |
| const grpc_call_final_info* /*final_info*/, |
| grpc_closure* /*ignored*/) { |
| auto* calld = static_cast<CallData*>(elem->call_data); |
| calld->~CallData(); |
| } |
| |
| static void StartTransportStreamOpBatch( |
| grpc_call_element* elem, grpc_transport_stream_op_batch* batch) { |
| auto* chand = static_cast<FailFirstCallFilter*>(elem->channel_data); |
| auto* calld = static_cast<CallData*>(elem->call_data); |
| if (!chand->seen_first_) { |
| chand->seen_first_ = true; |
| calld->fail_ = true; |
| } |
| if (calld->fail_ && !batch->cancel_stream) { |
| grpc_transport_stream_op_batch_finish_with_failure( |
| batch, |
| grpc_error_set_int( |
| GRPC_ERROR_CREATE("FailFirstCallFilter failing batch"), |
| grpc_core::StatusIntProperty::kRpcStatus, GRPC_STATUS_ABORTED), |
| calld->call_combiner_); |
| return; |
| } |
| grpc_call_next_op(elem, batch); |
| } |
| |
| private: |
| explicit CallData(const grpc_call_element_args* args) |
| : call_combiner_(args->call_combiner) {} |
| |
| grpc_core::CallCombiner* call_combiner_; |
| bool fail_ = false; |
| }; |
| |
| static grpc_error_handle Init(grpc_channel_element* elem, |
| grpc_channel_element_args* /*args*/) { |
| new (elem->channel_data) FailFirstCallFilter(); |
| return absl::OkStatus(); |
| } |
| |
| static void Destroy(grpc_channel_element* elem) { |
| auto* chand = static_cast<FailFirstCallFilter*>(elem->channel_data); |
| chand->~FailFirstCallFilter(); |
| } |
| |
| bool seen_first_ = false; |
| }; |
| |
| grpc_channel_filter FailFirstCallFilter::kFilterVtable = { |
| CallData::StartTransportStreamOpBatch, |
| nullptr, |
| grpc_channel_next_op, |
| sizeof(CallData), |
| CallData::Init, |
| grpc_call_stack_ignore_set_pollset_or_pollset_set, |
| CallData::Destroy, |
| sizeof(FailFirstCallFilter), |
| Init, |
| grpc_channel_stack_no_post_init, |
| Destroy, |
| grpc_channel_next_get_info, |
| "FailFirstCallFilter", |
| }; |
| |
| } // namespace |
| |
| void retry_send_op_fails(const CoreTestConfiguration& config) { |
| GPR_ASSERT(config.feature_mask & FEATURE_MASK_SUPPORTS_CLIENT_CHANNEL); |
| grpc_core::CoreConfiguration::RunWithSpecialConfiguration( |
| [](grpc_core::CoreConfiguration::Builder* builder) { |
| grpc_core::BuildCoreConfiguration(builder); |
| builder->channel_init()->RegisterStage( |
| GRPC_CLIENT_SUBCHANNEL, 0, |
| [](grpc_core::ChannelStackBuilder* builder) { |
| // Skip on proxy (which explicitly disables retries). |
| if (!builder->channel_args() |
| .GetBool(GRPC_ARG_ENABLE_RETRIES) |
| .value_or(true)) { |
| return true; |
| } |
| // Install filter. |
| builder->PrependFilter(&FailFirstCallFilter::kFilterVtable); |
| return true; |
| }); |
| }, |
| [config] { test_retry_send_op_fails(config); }); |
| } |
| |
| void retry_send_op_fails_pre_init(void) {} |