mirror of https://github.com/grpc/grpc.git
Merge pull request #16842 from yashykt/interceptors
Experimental API for Client and Server Interceptionpull/17036/head
Yash Tibrewal
6 years ago
committed by
GitHub
commit
01313976e1
47 changed files with 4111 additions and 854 deletions
@ -0,0 +1,920 @@ |
|||||||
|
/*
|
||||||
|
* |
||||||
|
* Copyright 2018 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. |
||||||
|
* |
||||||
|
*/ |
||||||
|
|
||||||
|
#ifndef GRPCPP_IMPL_CODEGEN_CALL_OP_SET_H |
||||||
|
#define GRPCPP_IMPL_CODEGEN_CALL_OP_SET_H |
||||||
|
|
||||||
|
#include <assert.h> |
||||||
|
#include <array> |
||||||
|
#include <cstring> |
||||||
|
#include <functional> |
||||||
|
#include <map> |
||||||
|
#include <memory> |
||||||
|
#include <vector> |
||||||
|
|
||||||
|
#include <grpcpp/impl/codegen/byte_buffer.h> |
||||||
|
#include <grpcpp/impl/codegen/call.h> |
||||||
|
#include <grpcpp/impl/codegen/call_hook.h> |
||||||
|
#include <grpcpp/impl/codegen/call_op_set_interface.h> |
||||||
|
#include <grpcpp/impl/codegen/client_context.h> |
||||||
|
#include <grpcpp/impl/codegen/completion_queue_tag.h> |
||||||
|
#include <grpcpp/impl/codegen/config.h> |
||||||
|
#include <grpcpp/impl/codegen/core_codegen_interface.h> |
||||||
|
#include <grpcpp/impl/codegen/intercepted_channel.h> |
||||||
|
#include <grpcpp/impl/codegen/interceptor_common.h> |
||||||
|
#include <grpcpp/impl/codegen/serialization_traits.h> |
||||||
|
#include <grpcpp/impl/codegen/slice.h> |
||||||
|
#include <grpcpp/impl/codegen/string_ref.h> |
||||||
|
|
||||||
|
#include <grpc/impl/codegen/atm.h> |
||||||
|
#include <grpc/impl/codegen/compression_types.h> |
||||||
|
#include <grpc/impl/codegen/grpc_types.h> |
||||||
|
|
||||||
|
namespace grpc { |
||||||
|
|
||||||
|
class CompletionQueue; |
||||||
|
extern CoreCodegenInterface* g_core_codegen_interface; |
||||||
|
|
||||||
|
namespace internal { |
||||||
|
class Call; |
||||||
|
class CallHook; |
||||||
|
|
||||||
|
// TODO(yangg) if the map is changed before we send, the pointers will be a
|
||||||
|
// mess. Make sure it does not happen.
|
||||||
|
inline grpc_metadata* FillMetadataArray( |
||||||
|
const std::multimap<grpc::string, grpc::string>& metadata, |
||||||
|
size_t* metadata_count, const grpc::string& optional_error_details) { |
||||||
|
*metadata_count = metadata.size() + (optional_error_details.empty() ? 0 : 1); |
||||||
|
if (*metadata_count == 0) { |
||||||
|
return nullptr; |
||||||
|
} |
||||||
|
grpc_metadata* metadata_array = |
||||||
|
(grpc_metadata*)(g_core_codegen_interface->gpr_malloc( |
||||||
|
(*metadata_count) * sizeof(grpc_metadata))); |
||||||
|
size_t i = 0; |
||||||
|
for (auto iter = metadata.cbegin(); iter != metadata.cend(); ++iter, ++i) { |
||||||
|
metadata_array[i].key = SliceReferencingString(iter->first); |
||||||
|
metadata_array[i].value = SliceReferencingString(iter->second); |
||||||
|
} |
||||||
|
if (!optional_error_details.empty()) { |
||||||
|
metadata_array[i].key = |
||||||
|
g_core_codegen_interface->grpc_slice_from_static_buffer( |
||||||
|
kBinaryErrorDetailsKey, sizeof(kBinaryErrorDetailsKey) - 1); |
||||||
|
metadata_array[i].value = SliceReferencingString(optional_error_details); |
||||||
|
} |
||||||
|
return metadata_array; |
||||||
|
} |
||||||
|
} // namespace internal
|
||||||
|
|
||||||
|
/// Per-message write options.
|
||||||
|
class WriteOptions { |
||||||
|
public: |
||||||
|
WriteOptions() : flags_(0), last_message_(false) {} |
||||||
|
WriteOptions(const WriteOptions& other) |
||||||
|
: flags_(other.flags_), last_message_(other.last_message_) {} |
||||||
|
|
||||||
|
/// Clear all flags.
|
||||||
|
inline void Clear() { flags_ = 0; } |
||||||
|
|
||||||
|
/// Returns raw flags bitset.
|
||||||
|
inline uint32_t flags() const { return flags_; } |
||||||
|
|
||||||
|
/// Sets flag for the disabling of compression for the next message write.
|
||||||
|
///
|
||||||
|
/// \sa GRPC_WRITE_NO_COMPRESS
|
||||||
|
inline WriteOptions& set_no_compression() { |
||||||
|
SetBit(GRPC_WRITE_NO_COMPRESS); |
||||||
|
return *this; |
||||||
|
} |
||||||
|
|
||||||
|
/// Clears flag for the disabling of compression for the next message write.
|
||||||
|
///
|
||||||
|
/// \sa GRPC_WRITE_NO_COMPRESS
|
||||||
|
inline WriteOptions& clear_no_compression() { |
||||||
|
ClearBit(GRPC_WRITE_NO_COMPRESS); |
||||||
|
return *this; |
||||||
|
} |
||||||
|
|
||||||
|
/// Get value for the flag indicating whether compression for the next
|
||||||
|
/// message write is forcefully disabled.
|
||||||
|
///
|
||||||
|
/// \sa GRPC_WRITE_NO_COMPRESS
|
||||||
|
inline bool get_no_compression() const { |
||||||
|
return GetBit(GRPC_WRITE_NO_COMPRESS); |
||||||
|
} |
||||||
|
|
||||||
|
/// Sets flag indicating that the write may be buffered and need not go out on
|
||||||
|
/// the wire immediately.
|
||||||
|
///
|
||||||
|
/// \sa GRPC_WRITE_BUFFER_HINT
|
||||||
|
inline WriteOptions& set_buffer_hint() { |
||||||
|
SetBit(GRPC_WRITE_BUFFER_HINT); |
||||||
|
return *this; |
||||||
|
} |
||||||
|
|
||||||
|
/// Clears flag indicating that the write may be buffered and need not go out
|
||||||
|
/// on the wire immediately.
|
||||||
|
///
|
||||||
|
/// \sa GRPC_WRITE_BUFFER_HINT
|
||||||
|
inline WriteOptions& clear_buffer_hint() { |
||||||
|
ClearBit(GRPC_WRITE_BUFFER_HINT); |
||||||
|
return *this; |
||||||
|
} |
||||||
|
|
||||||
|
/// Get value for the flag indicating that the write may be buffered and need
|
||||||
|
/// not go out on the wire immediately.
|
||||||
|
///
|
||||||
|
/// \sa GRPC_WRITE_BUFFER_HINT
|
||||||
|
inline bool get_buffer_hint() const { return GetBit(GRPC_WRITE_BUFFER_HINT); } |
||||||
|
|
||||||
|
/// corked bit: aliases set_buffer_hint currently, with the intent that
|
||||||
|
/// set_buffer_hint will be removed in the future
|
||||||
|
inline WriteOptions& set_corked() { |
||||||
|
SetBit(GRPC_WRITE_BUFFER_HINT); |
||||||
|
return *this; |
||||||
|
} |
||||||
|
|
||||||
|
inline WriteOptions& clear_corked() { |
||||||
|
ClearBit(GRPC_WRITE_BUFFER_HINT); |
||||||
|
return *this; |
||||||
|
} |
||||||
|
|
||||||
|
inline bool is_corked() const { return GetBit(GRPC_WRITE_BUFFER_HINT); } |
||||||
|
|
||||||
|
/// last-message bit: indicates this is the last message in a stream
|
||||||
|
/// client-side: makes Write the equivalent of performing Write, WritesDone
|
||||||
|
/// in a single step
|
||||||
|
/// server-side: hold the Write until the service handler returns (sync api)
|
||||||
|
/// or until Finish is called (async api)
|
||||||
|
inline WriteOptions& set_last_message() { |
||||||
|
last_message_ = true; |
||||||
|
return *this; |
||||||
|
} |
||||||
|
|
||||||
|
/// Clears flag indicating that this is the last message in a stream,
|
||||||
|
/// disabling coalescing.
|
||||||
|
inline WriteOptions& clear_last_message() { |
||||||
|
last_message_ = false; |
||||||
|
return *this; |
||||||
|
} |
||||||
|
|
||||||
|
/// Guarantee that all bytes have been written to the socket before completing
|
||||||
|
/// this write (usually writes are completed when they pass flow control).
|
||||||
|
inline WriteOptions& set_write_through() { |
||||||
|
SetBit(GRPC_WRITE_THROUGH); |
||||||
|
return *this; |
||||||
|
} |
||||||
|
|
||||||
|
inline bool is_write_through() const { return GetBit(GRPC_WRITE_THROUGH); } |
||||||
|
|
||||||
|
/// Get value for the flag indicating that this is the last message, and
|
||||||
|
/// should be coalesced with trailing metadata.
|
||||||
|
///
|
||||||
|
/// \sa GRPC_WRITE_LAST_MESSAGE
|
||||||
|
bool is_last_message() const { return last_message_; } |
||||||
|
|
||||||
|
WriteOptions& operator=(const WriteOptions& rhs) { |
||||||
|
flags_ = rhs.flags_; |
||||||
|
return *this; |
||||||
|
} |
||||||
|
|
||||||
|
private: |
||||||
|
void SetBit(const uint32_t mask) { flags_ |= mask; } |
||||||
|
|
||||||
|
void ClearBit(const uint32_t mask) { flags_ &= ~mask; } |
||||||
|
|
||||||
|
bool GetBit(const uint32_t mask) const { return (flags_ & mask) != 0; } |
||||||
|
|
||||||
|
uint32_t flags_; |
||||||
|
bool last_message_; |
||||||
|
}; |
||||||
|
|
||||||
|
namespace internal { |
||||||
|
|
||||||
|
/// Default argument for CallOpSet. I is unused by the class, but can be
|
||||||
|
/// used for generating multiple names for the same thing.
|
||||||
|
template <int I> |
||||||
|
class CallNoOp { |
||||||
|
protected: |
||||||
|
void AddOp(grpc_op* ops, size_t* nops) {} |
||||||
|
void FinishOp(bool* status) {} |
||||||
|
void SetInterceptionHookPoint( |
||||||
|
InternalInterceptorBatchMethods* interceptor_methods) {} |
||||||
|
void SetFinishInterceptionHookPoint( |
||||||
|
InternalInterceptorBatchMethods* interceptor_methods) {} |
||||||
|
void SetHijackingState(InternalInterceptorBatchMethods* interceptor_methods) { |
||||||
|
} |
||||||
|
}; |
||||||
|
|
||||||
|
class CallOpSendInitialMetadata { |
||||||
|
public: |
||||||
|
CallOpSendInitialMetadata() : send_(false) { |
||||||
|
maybe_compression_level_.is_set = false; |
||||||
|
} |
||||||
|
|
||||||
|
void SendInitialMetadata(std::multimap<grpc::string, grpc::string>* metadata, |
||||||
|
uint32_t flags) { |
||||||
|
maybe_compression_level_.is_set = false; |
||||||
|
send_ = true; |
||||||
|
flags_ = flags; |
||||||
|
metadata_map_ = metadata; |
||||||
|
} |
||||||
|
|
||||||
|
void set_compression_level(grpc_compression_level level) { |
||||||
|
maybe_compression_level_.is_set = true; |
||||||
|
maybe_compression_level_.level = level; |
||||||
|
} |
||||||
|
|
||||||
|
protected: |
||||||
|
void AddOp(grpc_op* ops, size_t* nops) { |
||||||
|
if (!send_ || hijacked_) return; |
||||||
|
grpc_op* op = &ops[(*nops)++]; |
||||||
|
op->op = GRPC_OP_SEND_INITIAL_METADATA; |
||||||
|
op->flags = flags_; |
||||||
|
op->reserved = NULL; |
||||||
|
initial_metadata_ = |
||||||
|
FillMetadataArray(*metadata_map_, &initial_metadata_count_, ""); |
||||||
|
op->data.send_initial_metadata.count = initial_metadata_count_; |
||||||
|
op->data.send_initial_metadata.metadata = initial_metadata_; |
||||||
|
op->data.send_initial_metadata.maybe_compression_level.is_set = |
||||||
|
maybe_compression_level_.is_set; |
||||||
|
if (maybe_compression_level_.is_set) { |
||||||
|
op->data.send_initial_metadata.maybe_compression_level.level = |
||||||
|
maybe_compression_level_.level; |
||||||
|
} |
||||||
|
} |
||||||
|
void FinishOp(bool* status) { |
||||||
|
if (!send_ || hijacked_) return; |
||||||
|
g_core_codegen_interface->gpr_free(initial_metadata_); |
||||||
|
send_ = false; |
||||||
|
} |
||||||
|
|
||||||
|
void SetInterceptionHookPoint( |
||||||
|
InternalInterceptorBatchMethods* interceptor_methods) { |
||||||
|
if (!send_) return; |
||||||
|
interceptor_methods->AddInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints::PRE_SEND_INITIAL_METADATA); |
||||||
|
interceptor_methods->SetSendInitialMetadata(metadata_map_); |
||||||
|
} |
||||||
|
|
||||||
|
void SetFinishInterceptionHookPoint( |
||||||
|
InternalInterceptorBatchMethods* interceptor_methods) {} |
||||||
|
|
||||||
|
void SetHijackingState(InternalInterceptorBatchMethods* interceptor_methods) { |
||||||
|
hijacked_ = true; |
||||||
|
} |
||||||
|
|
||||||
|
bool hijacked_ = false; |
||||||
|
bool send_; |
||||||
|
uint32_t flags_; |
||||||
|
size_t initial_metadata_count_; |
||||||
|
std::multimap<grpc::string, grpc::string>* metadata_map_; |
||||||
|
grpc_metadata* initial_metadata_; |
||||||
|
struct { |
||||||
|
bool is_set; |
||||||
|
grpc_compression_level level; |
||||||
|
} maybe_compression_level_; |
||||||
|
}; |
||||||
|
|
||||||
|
class CallOpSendMessage { |
||||||
|
public: |
||||||
|
CallOpSendMessage() : send_buf_() {} |
||||||
|
|
||||||
|
/// Send \a message using \a options for the write. The \a options are cleared
|
||||||
|
/// after use.
|
||||||
|
template <class M> |
||||||
|
Status SendMessage(const M& message, |
||||||
|
WriteOptions options) GRPC_MUST_USE_RESULT; |
||||||
|
|
||||||
|
template <class M> |
||||||
|
Status SendMessage(const M& message) GRPC_MUST_USE_RESULT; |
||||||
|
|
||||||
|
protected: |
||||||
|
void AddOp(grpc_op* ops, size_t* nops) { |
||||||
|
if (!send_buf_.Valid() || hijacked_) return; |
||||||
|
grpc_op* op = &ops[(*nops)++]; |
||||||
|
op->op = GRPC_OP_SEND_MESSAGE; |
||||||
|
op->flags = write_options_.flags(); |
||||||
|
op->reserved = NULL; |
||||||
|
op->data.send_message.send_message = send_buf_.c_buffer(); |
||||||
|
// Flags are per-message: clear them after use.
|
||||||
|
write_options_.Clear(); |
||||||
|
} |
||||||
|
void FinishOp(bool* status) { send_buf_.Clear(); } |
||||||
|
|
||||||
|
void SetInterceptionHookPoint( |
||||||
|
InternalInterceptorBatchMethods* interceptor_methods) { |
||||||
|
if (!send_buf_.Valid()) return; |
||||||
|
interceptor_methods->AddInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints::PRE_SEND_MESSAGE); |
||||||
|
interceptor_methods->SetSendMessage(&send_buf_); |
||||||
|
} |
||||||
|
|
||||||
|
void SetFinishInterceptionHookPoint( |
||||||
|
InternalInterceptorBatchMethods* interceptor_methods) {} |
||||||
|
|
||||||
|
void SetHijackingState(InternalInterceptorBatchMethods* interceptor_methods) { |
||||||
|
hijacked_ = true; |
||||||
|
} |
||||||
|
|
||||||
|
private: |
||||||
|
bool hijacked_ = false; |
||||||
|
ByteBuffer send_buf_; |
||||||
|
WriteOptions write_options_; |
||||||
|
}; |
||||||
|
|
||||||
|
template <class M> |
||||||
|
Status CallOpSendMessage::SendMessage(const M& message, WriteOptions options) { |
||||||
|
write_options_ = options; |
||||||
|
bool own_buf; |
||||||
|
// TODO(vjpai): Remove the void below when possible
|
||||||
|
// The void in the template parameter below should not be needed
|
||||||
|
// (since it should be implicit) but is needed due to an observed
|
||||||
|
// difference in behavior between clang and gcc for certain internal users
|
||||||
|
Status result = SerializationTraits<M, void>::Serialize( |
||||||
|
message, send_buf_.bbuf_ptr(), &own_buf); |
||||||
|
if (!own_buf) { |
||||||
|
send_buf_.Duplicate(); |
||||||
|
} |
||||||
|
return result; |
||||||
|
} |
||||||
|
|
||||||
|
template <class M> |
||||||
|
Status CallOpSendMessage::SendMessage(const M& message) { |
||||||
|
return SendMessage(message, WriteOptions()); |
||||||
|
} |
||||||
|
|
||||||
|
template <class R> |
||||||
|
class CallOpRecvMessage { |
||||||
|
public: |
||||||
|
CallOpRecvMessage() |
||||||
|
: got_message(false), |
||||||
|
message_(nullptr), |
||||||
|
allow_not_getting_message_(false) {} |
||||||
|
|
||||||
|
void RecvMessage(R* message) { message_ = message; } |
||||||
|
|
||||||
|
// Do not change status if no message is received.
|
||||||
|
void AllowNoMessage() { allow_not_getting_message_ = true; } |
||||||
|
|
||||||
|
bool got_message; |
||||||
|
|
||||||
|
protected: |
||||||
|
void AddOp(grpc_op* ops, size_t* nops) { |
||||||
|
if (message_ == nullptr || hijacked_) return; |
||||||
|
grpc_op* op = &ops[(*nops)++]; |
||||||
|
op->op = GRPC_OP_RECV_MESSAGE; |
||||||
|
op->flags = 0; |
||||||
|
op->reserved = NULL; |
||||||
|
op->data.recv_message.recv_message = recv_buf_.c_buffer_ptr(); |
||||||
|
} |
||||||
|
|
||||||
|
void FinishOp(bool* status) { |
||||||
|
if (message_ == nullptr || hijacked_) return; |
||||||
|
if (recv_buf_.Valid()) { |
||||||
|
if (*status) { |
||||||
|
got_message = *status = |
||||||
|
SerializationTraits<R>::Deserialize(recv_buf_.bbuf_ptr(), message_) |
||||||
|
.ok(); |
||||||
|
recv_buf_.Release(); |
||||||
|
} else { |
||||||
|
got_message = false; |
||||||
|
recv_buf_.Clear(); |
||||||
|
} |
||||||
|
} else { |
||||||
|
got_message = false; |
||||||
|
if (!allow_not_getting_message_) { |
||||||
|
*status = false; |
||||||
|
} |
||||||
|
} |
||||||
|
message_ = nullptr; |
||||||
|
} |
||||||
|
|
||||||
|
void SetInterceptionHookPoint( |
||||||
|
InternalInterceptorBatchMethods* interceptor_methods) { |
||||||
|
interceptor_methods->SetRecvMessage(message_); |
||||||
|
} |
||||||
|
|
||||||
|
void SetFinishInterceptionHookPoint( |
||||||
|
InternalInterceptorBatchMethods* interceptor_methods) { |
||||||
|
if (!got_message) return; |
||||||
|
interceptor_methods->AddInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints::POST_RECV_MESSAGE); |
||||||
|
} |
||||||
|
void SetHijackingState(InternalInterceptorBatchMethods* interceptor_methods) { |
||||||
|
hijacked_ = true; |
||||||
|
if (message_ == nullptr) return; |
||||||
|
interceptor_methods->AddInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints::PRE_RECV_MESSAGE); |
||||||
|
got_message = true; |
||||||
|
} |
||||||
|
|
||||||
|
private: |
||||||
|
R* message_; |
||||||
|
ByteBuffer recv_buf_; |
||||||
|
bool allow_not_getting_message_; |
||||||
|
bool hijacked_ = false; |
||||||
|
}; |
||||||
|
|
||||||
|
class DeserializeFunc { |
||||||
|
public: |
||||||
|
virtual Status Deserialize(ByteBuffer* buf) = 0; |
||||||
|
virtual ~DeserializeFunc() {} |
||||||
|
}; |
||||||
|
|
||||||
|
template <class R> |
||||||
|
class DeserializeFuncType final : public DeserializeFunc { |
||||||
|
public: |
||||||
|
DeserializeFuncType(R* message) : message_(message) {} |
||||||
|
Status Deserialize(ByteBuffer* buf) override { |
||||||
|
return SerializationTraits<R>::Deserialize(buf->bbuf_ptr(), message_); |
||||||
|
} |
||||||
|
|
||||||
|
~DeserializeFuncType() override {} |
||||||
|
|
||||||
|
private: |
||||||
|
R* message_; // Not a managed pointer because management is external to this
|
||||||
|
}; |
||||||
|
|
||||||
|
class CallOpGenericRecvMessage { |
||||||
|
public: |
||||||
|
CallOpGenericRecvMessage() |
||||||
|
: got_message(false), allow_not_getting_message_(false) {} |
||||||
|
|
||||||
|
template <class R> |
||||||
|
void RecvMessage(R* message) { |
||||||
|
// Use an explicit base class pointer to avoid resolution error in the
|
||||||
|
// following unique_ptr::reset for some old implementations.
|
||||||
|
DeserializeFunc* func = new DeserializeFuncType<R>(message); |
||||||
|
deserialize_.reset(func); |
||||||
|
message_ = message; |
||||||
|
} |
||||||
|
|
||||||
|
// Do not change status if no message is received.
|
||||||
|
void AllowNoMessage() { allow_not_getting_message_ = true; } |
||||||
|
|
||||||
|
bool got_message; |
||||||
|
|
||||||
|
protected: |
||||||
|
void AddOp(grpc_op* ops, size_t* nops) { |
||||||
|
if (!deserialize_ || hijacked_) return; |
||||||
|
grpc_op* op = &ops[(*nops)++]; |
||||||
|
op->op = GRPC_OP_RECV_MESSAGE; |
||||||
|
op->flags = 0; |
||||||
|
op->reserved = NULL; |
||||||
|
op->data.recv_message.recv_message = recv_buf_.c_buffer_ptr(); |
||||||
|
} |
||||||
|
|
||||||
|
void FinishOp(bool* status) { |
||||||
|
if (!deserialize_ || hijacked_) return; |
||||||
|
if (recv_buf_.Valid()) { |
||||||
|
if (*status) { |
||||||
|
got_message = true; |
||||||
|
*status = deserialize_->Deserialize(&recv_buf_).ok(); |
||||||
|
recv_buf_.Release(); |
||||||
|
} else { |
||||||
|
got_message = false; |
||||||
|
recv_buf_.Clear(); |
||||||
|
} |
||||||
|
} else { |
||||||
|
got_message = false; |
||||||
|
if (!allow_not_getting_message_) { |
||||||
|
*status = false; |
||||||
|
} |
||||||
|
} |
||||||
|
deserialize_.reset(); |
||||||
|
} |
||||||
|
|
||||||
|
void SetInterceptionHookPoint( |
||||||
|
InternalInterceptorBatchMethods* interceptor_methods) { |
||||||
|
interceptor_methods->SetRecvMessage(message_); |
||||||
|
} |
||||||
|
|
||||||
|
void SetFinishInterceptionHookPoint( |
||||||
|
InternalInterceptorBatchMethods* interceptor_methods) { |
||||||
|
if (!got_message) return; |
||||||
|
interceptor_methods->AddInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints::POST_RECV_MESSAGE); |
||||||
|
} |
||||||
|
void SetHijackingState(InternalInterceptorBatchMethods* interceptor_methods) { |
||||||
|
hijacked_ = true; |
||||||
|
if (!deserialize_) return; |
||||||
|
interceptor_methods->AddInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints::PRE_RECV_MESSAGE); |
||||||
|
} |
||||||
|
|
||||||
|
private: |
||||||
|
void* message_; |
||||||
|
bool hijacked_ = false; |
||||||
|
std::unique_ptr<DeserializeFunc> deserialize_; |
||||||
|
ByteBuffer recv_buf_; |
||||||
|
bool allow_not_getting_message_; |
||||||
|
}; |
||||||
|
|
||||||
|
class CallOpClientSendClose { |
||||||
|
public: |
||||||
|
CallOpClientSendClose() : send_(false) {} |
||||||
|
|
||||||
|
void ClientSendClose() { send_ = true; } |
||||||
|
|
||||||
|
protected: |
||||||
|
void AddOp(grpc_op* ops, size_t* nops) { |
||||||
|
if (!send_ || hijacked_) return; |
||||||
|
grpc_op* op = &ops[(*nops)++]; |
||||||
|
op->op = GRPC_OP_SEND_CLOSE_FROM_CLIENT; |
||||||
|
op->flags = 0; |
||||||
|
op->reserved = NULL; |
||||||
|
} |
||||||
|
void FinishOp(bool* status) { send_ = false; } |
||||||
|
|
||||||
|
void SetInterceptionHookPoint( |
||||||
|
InternalInterceptorBatchMethods* interceptor_methods) { |
||||||
|
if (!send_) return; |
||||||
|
interceptor_methods->AddInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints::PRE_SEND_CLOSE); |
||||||
|
} |
||||||
|
|
||||||
|
void SetFinishInterceptionHookPoint( |
||||||
|
InternalInterceptorBatchMethods* interceptor_methods) {} |
||||||
|
|
||||||
|
void SetHijackingState(InternalInterceptorBatchMethods* interceptor_methods) { |
||||||
|
hijacked_ = true; |
||||||
|
} |
||||||
|
|
||||||
|
private: |
||||||
|
bool hijacked_ = false; |
||||||
|
bool send_; |
||||||
|
}; |
||||||
|
|
||||||
|
class CallOpServerSendStatus { |
||||||
|
public: |
||||||
|
CallOpServerSendStatus() : send_status_available_(false) {} |
||||||
|
|
||||||
|
void ServerSendStatus( |
||||||
|
std::multimap<grpc::string, grpc::string>* trailing_metadata, |
||||||
|
const Status& status) { |
||||||
|
send_error_details_ = status.error_details(); |
||||||
|
metadata_map_ = trailing_metadata; |
||||||
|
send_status_available_ = true; |
||||||
|
send_status_code_ = static_cast<grpc_status_code>(status.error_code()); |
||||||
|
send_error_message_ = status.error_message(); |
||||||
|
} |
||||||
|
|
||||||
|
protected: |
||||||
|
void AddOp(grpc_op* ops, size_t* nops) { |
||||||
|
if (!send_status_available_ || hijacked_) return; |
||||||
|
trailing_metadata_ = FillMetadataArray( |
||||||
|
*metadata_map_, &trailing_metadata_count_, send_error_details_); |
||||||
|
grpc_op* op = &ops[(*nops)++]; |
||||||
|
op->op = GRPC_OP_SEND_STATUS_FROM_SERVER; |
||||||
|
op->data.send_status_from_server.trailing_metadata_count = |
||||||
|
trailing_metadata_count_; |
||||||
|
op->data.send_status_from_server.trailing_metadata = trailing_metadata_; |
||||||
|
op->data.send_status_from_server.status = send_status_code_; |
||||||
|
error_message_slice_ = SliceReferencingString(send_error_message_); |
||||||
|
op->data.send_status_from_server.status_details = |
||||||
|
send_error_message_.empty() ? nullptr : &error_message_slice_; |
||||||
|
op->flags = 0; |
||||||
|
op->reserved = NULL; |
||||||
|
} |
||||||
|
|
||||||
|
void FinishOp(bool* status) { |
||||||
|
if (!send_status_available_ || hijacked_) return; |
||||||
|
g_core_codegen_interface->gpr_free(trailing_metadata_); |
||||||
|
send_status_available_ = false; |
||||||
|
} |
||||||
|
|
||||||
|
void SetInterceptionHookPoint( |
||||||
|
InternalInterceptorBatchMethods* interceptor_methods) { |
||||||
|
if (!send_status_available_) return; |
||||||
|
interceptor_methods->AddInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints::PRE_SEND_STATUS); |
||||||
|
interceptor_methods->SetSendTrailingMetadata(metadata_map_); |
||||||
|
interceptor_methods->SetSendStatus(&send_status_code_, &send_error_details_, |
||||||
|
&send_error_message_); |
||||||
|
} |
||||||
|
|
||||||
|
void SetFinishInterceptionHookPoint( |
||||||
|
InternalInterceptorBatchMethods* interceptor_methods) {} |
||||||
|
|
||||||
|
void SetHijackingState(InternalInterceptorBatchMethods* interceptor_methods) { |
||||||
|
hijacked_ = true; |
||||||
|
} |
||||||
|
|
||||||
|
private: |
||||||
|
bool hijacked_ = false; |
||||||
|
bool send_status_available_; |
||||||
|
grpc_status_code send_status_code_; |
||||||
|
grpc::string send_error_details_; |
||||||
|
grpc::string send_error_message_; |
||||||
|
size_t trailing_metadata_count_; |
||||||
|
std::multimap<grpc::string, grpc::string>* metadata_map_; |
||||||
|
grpc_metadata* trailing_metadata_; |
||||||
|
grpc_slice error_message_slice_; |
||||||
|
}; |
||||||
|
|
||||||
|
class CallOpRecvInitialMetadata { |
||||||
|
public: |
||||||
|
CallOpRecvInitialMetadata() : metadata_map_(nullptr) {} |
||||||
|
|
||||||
|
void RecvInitialMetadata(ClientContext* context) { |
||||||
|
context->initial_metadata_received_ = true; |
||||||
|
metadata_map_ = &context->recv_initial_metadata_; |
||||||
|
} |
||||||
|
|
||||||
|
protected: |
||||||
|
void AddOp(grpc_op* ops, size_t* nops) { |
||||||
|
if (metadata_map_ == nullptr || hijacked_) return; |
||||||
|
grpc_op* op = &ops[(*nops)++]; |
||||||
|
op->op = GRPC_OP_RECV_INITIAL_METADATA; |
||||||
|
op->data.recv_initial_metadata.recv_initial_metadata = metadata_map_->arr(); |
||||||
|
op->flags = 0; |
||||||
|
op->reserved = NULL; |
||||||
|
} |
||||||
|
|
||||||
|
void FinishOp(bool* status) { |
||||||
|
if (metadata_map_ == nullptr || hijacked_) return; |
||||||
|
} |
||||||
|
|
||||||
|
void SetInterceptionHookPoint( |
||||||
|
InternalInterceptorBatchMethods* interceptor_methods) { |
||||||
|
interceptor_methods->SetRecvInitialMetadata(metadata_map_); |
||||||
|
} |
||||||
|
|
||||||
|
void SetFinishInterceptionHookPoint( |
||||||
|
InternalInterceptorBatchMethods* interceptor_methods) { |
||||||
|
if (metadata_map_ == nullptr) return; |
||||||
|
interceptor_methods->AddInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints::POST_RECV_INITIAL_METADATA); |
||||||
|
metadata_map_ = nullptr; |
||||||
|
} |
||||||
|
|
||||||
|
void SetHijackingState(InternalInterceptorBatchMethods* interceptor_methods) { |
||||||
|
hijacked_ = true; |
||||||
|
if (metadata_map_ == nullptr) return; |
||||||
|
interceptor_methods->AddInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints::PRE_RECV_INITIAL_METADATA); |
||||||
|
} |
||||||
|
|
||||||
|
private: |
||||||
|
bool hijacked_ = false; |
||||||
|
MetadataMap* metadata_map_; |
||||||
|
}; |
||||||
|
|
||||||
|
class CallOpClientRecvStatus { |
||||||
|
public: |
||||||
|
CallOpClientRecvStatus() |
||||||
|
: recv_status_(nullptr), debug_error_string_(nullptr) {} |
||||||
|
|
||||||
|
void ClientRecvStatus(ClientContext* context, Status* status) { |
||||||
|
client_context_ = context; |
||||||
|
metadata_map_ = &client_context_->trailing_metadata_; |
||||||
|
recv_status_ = status; |
||||||
|
error_message_ = g_core_codegen_interface->grpc_empty_slice(); |
||||||
|
} |
||||||
|
|
||||||
|
protected: |
||||||
|
void AddOp(grpc_op* ops, size_t* nops) { |
||||||
|
if (recv_status_ == nullptr || hijacked_) return; |
||||||
|
grpc_op* op = &ops[(*nops)++]; |
||||||
|
op->op = GRPC_OP_RECV_STATUS_ON_CLIENT; |
||||||
|
op->data.recv_status_on_client.trailing_metadata = metadata_map_->arr(); |
||||||
|
op->data.recv_status_on_client.status = &status_code_; |
||||||
|
op->data.recv_status_on_client.status_details = &error_message_; |
||||||
|
op->data.recv_status_on_client.error_string = &debug_error_string_; |
||||||
|
op->flags = 0; |
||||||
|
op->reserved = NULL; |
||||||
|
} |
||||||
|
|
||||||
|
void FinishOp(bool* status) { |
||||||
|
if (recv_status_ == nullptr || hijacked_) return; |
||||||
|
grpc::string binary_error_details = metadata_map_->GetBinaryErrorDetails(); |
||||||
|
*recv_status_ = |
||||||
|
Status(static_cast<StatusCode>(status_code_), |
||||||
|
GRPC_SLICE_IS_EMPTY(error_message_) |
||||||
|
? grpc::string() |
||||||
|
: grpc::string(GRPC_SLICE_START_PTR(error_message_), |
||||||
|
GRPC_SLICE_END_PTR(error_message_)), |
||||||
|
binary_error_details); |
||||||
|
client_context_->set_debug_error_string( |
||||||
|
debug_error_string_ != nullptr ? debug_error_string_ : ""); |
||||||
|
g_core_codegen_interface->grpc_slice_unref(error_message_); |
||||||
|
if (debug_error_string_ != nullptr) { |
||||||
|
g_core_codegen_interface->gpr_free((void*)debug_error_string_); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
void SetInterceptionHookPoint( |
||||||
|
InternalInterceptorBatchMethods* interceptor_methods) { |
||||||
|
interceptor_methods->SetRecvStatus(recv_status_); |
||||||
|
interceptor_methods->SetRecvTrailingMetadata(metadata_map_); |
||||||
|
} |
||||||
|
|
||||||
|
void SetFinishInterceptionHookPoint( |
||||||
|
InternalInterceptorBatchMethods* interceptor_methods) { |
||||||
|
if (recv_status_ == nullptr) return; |
||||||
|
interceptor_methods->AddInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints::POST_RECV_STATUS); |
||||||
|
recv_status_ = nullptr; |
||||||
|
} |
||||||
|
|
||||||
|
void SetHijackingState(InternalInterceptorBatchMethods* interceptor_methods) { |
||||||
|
hijacked_ = true; |
||||||
|
if (recv_status_ == nullptr) return; |
||||||
|
interceptor_methods->AddInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints::PRE_RECV_STATUS); |
||||||
|
} |
||||||
|
|
||||||
|
private: |
||||||
|
bool hijacked_ = false; |
||||||
|
ClientContext* client_context_; |
||||||
|
MetadataMap* metadata_map_; |
||||||
|
Status* recv_status_; |
||||||
|
const char* debug_error_string_; |
||||||
|
grpc_status_code status_code_; |
||||||
|
grpc_slice error_message_; |
||||||
|
}; |
||||||
|
|
||||||
|
template <class Op1 = CallNoOp<1>, class Op2 = CallNoOp<2>, |
||||||
|
class Op3 = CallNoOp<3>, class Op4 = CallNoOp<4>, |
||||||
|
class Op5 = CallNoOp<5>, class Op6 = CallNoOp<6>> |
||||||
|
class CallOpSet; |
||||||
|
|
||||||
|
/// Primary implementation of CallOpSetInterface.
|
||||||
|
/// Since we cannot use variadic templates, we declare slots up to
|
||||||
|
/// the maximum count of ops we'll need in a set. We leverage the
|
||||||
|
/// empty base class optimization to slim this class (especially
|
||||||
|
/// when there are many unused slots used). To avoid duplicate base classes,
|
||||||
|
/// the template parmeter for CallNoOp is varied by argument position.
|
||||||
|
template <class Op1, class Op2, class Op3, class Op4, class Op5, class Op6> |
||||||
|
class CallOpSet : public CallOpSetInterface, |
||||||
|
public Op1, |
||||||
|
public Op2, |
||||||
|
public Op3, |
||||||
|
public Op4, |
||||||
|
public Op5, |
||||||
|
public Op6 { |
||||||
|
public: |
||||||
|
CallOpSet() : cq_tag_(this), return_tag_(this) {} |
||||||
|
// The copy constructor and assignment operator reset the value of
|
||||||
|
// cq_tag_, return_tag_, done_intercepting_ and interceptor_methods_ since
|
||||||
|
// those are only meaningful on a specific object, not across objects.
|
||||||
|
CallOpSet(const CallOpSet& other) |
||||||
|
: cq_tag_(this), |
||||||
|
return_tag_(this), |
||||||
|
call_(other.call_), |
||||||
|
done_intercepting_(false), |
||||||
|
interceptor_methods_(InterceptorBatchMethodsImpl()) {} |
||||||
|
|
||||||
|
CallOpSet& operator=(const CallOpSet& other) { |
||||||
|
cq_tag_ = this; |
||||||
|
return_tag_ = this; |
||||||
|
call_ = other.call_; |
||||||
|
done_intercepting_ = false; |
||||||
|
interceptor_methods_ = InterceptorBatchMethodsImpl(); |
||||||
|
return *this; |
||||||
|
} |
||||||
|
|
||||||
|
void FillOps(Call* call) override { |
||||||
|
done_intercepting_ = false; |
||||||
|
g_core_codegen_interface->grpc_call_ref(call->call()); |
||||||
|
call_ = |
||||||
|
*call; // It's fine to create a copy of call since it's just pointers
|
||||||
|
|
||||||
|
if (RunInterceptors()) { |
||||||
|
ContinueFillOpsAfterInterception(); |
||||||
|
} else { |
||||||
|
// After the interceptors are run, ContinueFillOpsAfterInterception will
|
||||||
|
// be run
|
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
bool FinalizeResult(void** tag, bool* status) override { |
||||||
|
if (done_intercepting_) { |
||||||
|
// We have already finished intercepting and filling in the results. This
|
||||||
|
// round trip from the core needed to be made because interceptors were
|
||||||
|
// run
|
||||||
|
*tag = return_tag_; |
||||||
|
*status = saved_status_; |
||||||
|
g_core_codegen_interface->grpc_call_unref(call_.call()); |
||||||
|
return true; |
||||||
|
} |
||||||
|
|
||||||
|
this->Op1::FinishOp(status); |
||||||
|
this->Op2::FinishOp(status); |
||||||
|
this->Op3::FinishOp(status); |
||||||
|
this->Op4::FinishOp(status); |
||||||
|
this->Op5::FinishOp(status); |
||||||
|
this->Op6::FinishOp(status); |
||||||
|
saved_status_ = *status; |
||||||
|
if (RunInterceptorsPostRecv()) { |
||||||
|
*tag = return_tag_; |
||||||
|
g_core_codegen_interface->grpc_call_unref(call_.call()); |
||||||
|
return true; |
||||||
|
} |
||||||
|
// Interceptors are going to be run, so we can't return the tag just yet.
|
||||||
|
// After the interceptors are run, ContinueFinalizeResultAfterInterception
|
||||||
|
return false; |
||||||
|
} |
||||||
|
|
||||||
|
void set_output_tag(void* return_tag) { return_tag_ = return_tag; } |
||||||
|
|
||||||
|
void* cq_tag() override { return cq_tag_; } |
||||||
|
|
||||||
|
/// set_cq_tag is used to provide a different core CQ tag than "this".
|
||||||
|
/// This is used for callback-based tags, where the core tag is the core
|
||||||
|
/// callback function. It does not change the use or behavior of any other
|
||||||
|
/// function (such as FinalizeResult)
|
||||||
|
void set_cq_tag(void* cq_tag) { cq_tag_ = cq_tag; } |
||||||
|
|
||||||
|
// This will be called while interceptors are run if the RPC is a hijacked
|
||||||
|
// RPC. This should set hijacking state for each of the ops.
|
||||||
|
void SetHijackingState() override { |
||||||
|
this->Op1::SetHijackingState(&interceptor_methods_); |
||||||
|
this->Op2::SetHijackingState(&interceptor_methods_); |
||||||
|
this->Op3::SetHijackingState(&interceptor_methods_); |
||||||
|
this->Op4::SetHijackingState(&interceptor_methods_); |
||||||
|
this->Op5::SetHijackingState(&interceptor_methods_); |
||||||
|
this->Op6::SetHijackingState(&interceptor_methods_); |
||||||
|
} |
||||||
|
|
||||||
|
// Should be called after interceptors are done running
|
||||||
|
void ContinueFillOpsAfterInterception() override { |
||||||
|
static const size_t MAX_OPS = 6; |
||||||
|
grpc_op ops[MAX_OPS]; |
||||||
|
size_t nops = 0; |
||||||
|
this->Op1::AddOp(ops, &nops); |
||||||
|
this->Op2::AddOp(ops, &nops); |
||||||
|
this->Op3::AddOp(ops, &nops); |
||||||
|
this->Op4::AddOp(ops, &nops); |
||||||
|
this->Op5::AddOp(ops, &nops); |
||||||
|
this->Op6::AddOp(ops, &nops); |
||||||
|
GPR_CODEGEN_ASSERT(GRPC_CALL_OK == |
||||||
|
g_core_codegen_interface->grpc_call_start_batch( |
||||||
|
call_.call(), ops, nops, cq_tag(), nullptr)); |
||||||
|
} |
||||||
|
|
||||||
|
// Should be called after interceptors are done running on the finalize result
|
||||||
|
// path
|
||||||
|
void ContinueFinalizeResultAfterInterception() override { |
||||||
|
done_intercepting_ = true; |
||||||
|
GPR_CODEGEN_ASSERT(GRPC_CALL_OK == |
||||||
|
g_core_codegen_interface->grpc_call_start_batch( |
||||||
|
call_.call(), nullptr, 0, cq_tag(), nullptr)); |
||||||
|
} |
||||||
|
|
||||||
|
private: |
||||||
|
// Returns true if no interceptors need to be run
|
||||||
|
bool RunInterceptors() { |
||||||
|
interceptor_methods_.ClearState(); |
||||||
|
interceptor_methods_.SetCallOpSetInterface(this); |
||||||
|
interceptor_methods_.SetCall(&call_); |
||||||
|
this->Op1::SetInterceptionHookPoint(&interceptor_methods_); |
||||||
|
this->Op2::SetInterceptionHookPoint(&interceptor_methods_); |
||||||
|
this->Op3::SetInterceptionHookPoint(&interceptor_methods_); |
||||||
|
this->Op4::SetInterceptionHookPoint(&interceptor_methods_); |
||||||
|
this->Op5::SetInterceptionHookPoint(&interceptor_methods_); |
||||||
|
this->Op6::SetInterceptionHookPoint(&interceptor_methods_); |
||||||
|
return interceptor_methods_.RunInterceptors(); |
||||||
|
} |
||||||
|
// Returns true if no interceptors need to be run
|
||||||
|
bool RunInterceptorsPostRecv() { |
||||||
|
// Call and OpSet had already been set on the set state.
|
||||||
|
// SetReverse also clears previously set hook points
|
||||||
|
interceptor_methods_.SetReverse(); |
||||||
|
this->Op1::SetFinishInterceptionHookPoint(&interceptor_methods_); |
||||||
|
this->Op2::SetFinishInterceptionHookPoint(&interceptor_methods_); |
||||||
|
this->Op3::SetFinishInterceptionHookPoint(&interceptor_methods_); |
||||||
|
this->Op4::SetFinishInterceptionHookPoint(&interceptor_methods_); |
||||||
|
this->Op5::SetFinishInterceptionHookPoint(&interceptor_methods_); |
||||||
|
this->Op6::SetFinishInterceptionHookPoint(&interceptor_methods_); |
||||||
|
return interceptor_methods_.RunInterceptors(); |
||||||
|
} |
||||||
|
|
||||||
|
void* cq_tag_; |
||||||
|
void* return_tag_; |
||||||
|
Call call_; |
||||||
|
bool done_intercepting_ = false; |
||||||
|
InterceptorBatchMethodsImpl interceptor_methods_; |
||||||
|
bool saved_status_; |
||||||
|
}; |
||||||
|
|
||||||
|
} // namespace internal
|
||||||
|
} // namespace grpc
|
||||||
|
|
||||||
|
#endif // GRPCPP_IMPL_CODEGEN_CALL_OP_SET_H
|
||||||
@ -0,0 +1,59 @@ |
|||||||
|
/*
|
||||||
|
* |
||||||
|
* Copyright 2018 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. |
||||||
|
* |
||||||
|
*/ |
||||||
|
|
||||||
|
#ifndef GRPCPP_IMPL_CODEGEN_CALL_OP_SET_INTERFACE_H |
||||||
|
#define GRPCPP_IMPL_CODEGEN_CALL_OP_SET_INTERFACE_H |
||||||
|
|
||||||
|
#include <grpcpp/impl/codegen/completion_queue_tag.h> |
||||||
|
|
||||||
|
namespace grpc { |
||||||
|
namespace internal { |
||||||
|
|
||||||
|
class Call; |
||||||
|
|
||||||
|
/// An abstract collection of call ops, used to generate the
|
||||||
|
/// grpc_call_op structure to pass down to the lower layers,
|
||||||
|
/// and as it is-a CompletionQueueTag, also massages the final
|
||||||
|
/// completion into the correct form for consumption in the C++
|
||||||
|
/// API.
|
||||||
|
class CallOpSetInterface : public CompletionQueueTag { |
||||||
|
public: |
||||||
|
/// Fills in grpc_op, starting from ops[*nops] and moving
|
||||||
|
/// upwards.
|
||||||
|
virtual void FillOps(internal::Call* call) = 0; |
||||||
|
|
||||||
|
/// Get the tag to be used at the core completion queue. Generally, the
|
||||||
|
/// value of cq_tag will be "this". However, it can be overridden if we
|
||||||
|
/// want core to process the tag differently (e.g., as a core callback)
|
||||||
|
virtual void* cq_tag() = 0; |
||||||
|
|
||||||
|
// This will be called while interceptors are run if the RPC is a hijacked
|
||||||
|
// RPC. This should set hijacking state for each of the ops.
|
||||||
|
virtual void SetHijackingState() = 0; |
||||||
|
|
||||||
|
// Should be called after interceptors are done running
|
||||||
|
virtual void ContinueFillOpsAfterInterception() = 0; |
||||||
|
|
||||||
|
// Should be called after interceptors are done running on the finalize result
|
||||||
|
// path
|
||||||
|
virtual void ContinueFinalizeResultAfterInterception() = 0; |
||||||
|
}; |
||||||
|
} // namespace internal
|
||||||
|
} // namespace grpc
|
||||||
|
|
||||||
|
#endif // GRPCPP_IMPL_CODEGEN_CALL_OP_SET_INTERFACE_H
|
||||||
@ -0,0 +1,80 @@ |
|||||||
|
/*
|
||||||
|
* |
||||||
|
* Copyright 2018 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. |
||||||
|
* |
||||||
|
*/ |
||||||
|
|
||||||
|
#ifndef GRPCPP_IMPL_CODEGEN_INTERCEPTED_CHANNEL_H |
||||||
|
#define GRPCPP_IMPL_CODEGEN_INTERCEPTED_CHANNEL_H |
||||||
|
|
||||||
|
#include <grpcpp/impl/codegen/channel_interface.h> |
||||||
|
|
||||||
|
namespace grpc { |
||||||
|
|
||||||
|
namespace internal { |
||||||
|
|
||||||
|
class InterceptorBatchMethodsImpl; |
||||||
|
|
||||||
|
/// An InterceptedChannel is available to client Interceptors. An
|
||||||
|
/// InterceptedChannel is unique to an interceptor, and when an RPC is started
|
||||||
|
/// on this channel, only those interceptors that come after this interceptor
|
||||||
|
/// see the RPC.
|
||||||
|
class InterceptedChannel : public ChannelInterface { |
||||||
|
public: |
||||||
|
virtual ~InterceptedChannel() { channel_ = nullptr; } |
||||||
|
|
||||||
|
/// Get the current channel state. If the channel is in IDLE and
|
||||||
|
/// \a try_to_connect is set to true, try to connect.
|
||||||
|
grpc_connectivity_state GetState(bool try_to_connect) override { |
||||||
|
return channel_->GetState(try_to_connect); |
||||||
|
} |
||||||
|
|
||||||
|
private: |
||||||
|
InterceptedChannel(ChannelInterface* channel, int pos) |
||||||
|
: channel_(channel), interceptor_pos_(pos) {} |
||||||
|
|
||||||
|
Call CreateCall(const RpcMethod& method, ClientContext* context, |
||||||
|
CompletionQueue* cq) override { |
||||||
|
return channel_->CreateCallInternal(method, context, cq, interceptor_pos_); |
||||||
|
} |
||||||
|
|
||||||
|
void PerformOpsOnCall(CallOpSetInterface* ops, Call* call) override { |
||||||
|
return channel_->PerformOpsOnCall(ops, call); |
||||||
|
} |
||||||
|
void* RegisterMethod(const char* method) override { |
||||||
|
return channel_->RegisterMethod(method); |
||||||
|
} |
||||||
|
|
||||||
|
void NotifyOnStateChangeImpl(grpc_connectivity_state last_observed, |
||||||
|
gpr_timespec deadline, CompletionQueue* cq, |
||||||
|
void* tag) override { |
||||||
|
return channel_->NotifyOnStateChangeImpl(last_observed, deadline, cq, tag); |
||||||
|
} |
||||||
|
bool WaitForStateChangeImpl(grpc_connectivity_state last_observed, |
||||||
|
gpr_timespec deadline) override { |
||||||
|
return channel_->WaitForStateChangeImpl(last_observed, deadline); |
||||||
|
} |
||||||
|
|
||||||
|
CompletionQueue* CallbackCQ() override { return channel_->CallbackCQ(); } |
||||||
|
|
||||||
|
ChannelInterface* channel_; |
||||||
|
int interceptor_pos_; |
||||||
|
|
||||||
|
friend class InterceptorBatchMethodsImpl; |
||||||
|
}; |
||||||
|
} // namespace internal
|
||||||
|
} // namespace grpc
|
||||||
|
|
||||||
|
#endif // GRPCPP_IMPL_CODEGEN_INTERCEPTED_CHANNEL_H
|
||||||
@ -0,0 +1,383 @@ |
|||||||
|
/*
|
||||||
|
* |
||||||
|
* Copyright 2018 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. |
||||||
|
* |
||||||
|
*/ |
||||||
|
|
||||||
|
#ifndef GRPCPP_IMPL_CODEGEN_INTERCEPTOR_COMMON_H |
||||||
|
#define GRPCPP_IMPL_CODEGEN_INTERCEPTOR_COMMON_H |
||||||
|
|
||||||
|
#include <grpcpp/impl/codegen/client_interceptor.h> |
||||||
|
#include <grpcpp/impl/codegen/server_interceptor.h> |
||||||
|
|
||||||
|
#include <grpc/impl/codegen/grpc_types.h> |
||||||
|
|
||||||
|
namespace grpc { |
||||||
|
namespace internal { |
||||||
|
|
||||||
|
/// Internal methods for setting the state
|
||||||
|
class InternalInterceptorBatchMethods |
||||||
|
: public experimental::InterceptorBatchMethods { |
||||||
|
public: |
||||||
|
virtual ~InternalInterceptorBatchMethods() {} |
||||||
|
|
||||||
|
virtual void AddInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints type) = 0; |
||||||
|
|
||||||
|
virtual void SetSendMessage(ByteBuffer* buf) = 0; |
||||||
|
|
||||||
|
virtual void SetSendInitialMetadata( |
||||||
|
std::multimap<grpc::string, grpc::string>* metadata) = 0; |
||||||
|
|
||||||
|
virtual void SetSendStatus(grpc_status_code* code, |
||||||
|
grpc::string* error_details, |
||||||
|
grpc::string* error_message) = 0; |
||||||
|
|
||||||
|
virtual void SetSendTrailingMetadata( |
||||||
|
std::multimap<grpc::string, grpc::string>* metadata) = 0; |
||||||
|
|
||||||
|
virtual void SetRecvMessage(void* message) = 0; |
||||||
|
|
||||||
|
virtual void SetRecvInitialMetadata(MetadataMap* map) = 0; |
||||||
|
|
||||||
|
virtual void SetRecvStatus(Status* status) = 0; |
||||||
|
|
||||||
|
virtual void SetRecvTrailingMetadata(MetadataMap* map) = 0; |
||||||
|
}; |
||||||
|
|
||||||
|
class InterceptorBatchMethodsImpl : public InternalInterceptorBatchMethods { |
||||||
|
public: |
||||||
|
InterceptorBatchMethodsImpl() { |
||||||
|
for (auto i = static_cast<experimental::InterceptionHookPoints>(0); |
||||||
|
i < experimental::InterceptionHookPoints::NUM_INTERCEPTION_HOOKS; |
||||||
|
i = static_cast<experimental::InterceptionHookPoints>( |
||||||
|
static_cast<size_t>(i) + 1)) { |
||||||
|
hooks_[static_cast<size_t>(i)] = false; |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
~InterceptorBatchMethodsImpl() {} |
||||||
|
|
||||||
|
bool QueryInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints type) override { |
||||||
|
return hooks_[static_cast<size_t>(type)]; |
||||||
|
} |
||||||
|
|
||||||
|
void Proceed() override { /* fill this */ |
||||||
|
if (call_->client_rpc_info() != nullptr) { |
||||||
|
return ProceedClient(); |
||||||
|
} |
||||||
|
GPR_CODEGEN_ASSERT(call_->server_rpc_info() != nullptr); |
||||||
|
ProceedServer(); |
||||||
|
} |
||||||
|
|
||||||
|
void Hijack() override { |
||||||
|
// Only the client can hijack when sending down initial metadata
|
||||||
|
GPR_CODEGEN_ASSERT(!reverse_ && ops_ != nullptr && |
||||||
|
call_->client_rpc_info() != nullptr); |
||||||
|
// It is illegal to call Hijack twice
|
||||||
|
GPR_CODEGEN_ASSERT(!ran_hijacking_interceptor_); |
||||||
|
auto* rpc_info = call_->client_rpc_info(); |
||||||
|
rpc_info->hijacked_ = true; |
||||||
|
rpc_info->hijacked_interceptor_ = current_interceptor_index_; |
||||||
|
ClearHookPoints(); |
||||||
|
ops_->SetHijackingState(); |
||||||
|
ran_hijacking_interceptor_ = true; |
||||||
|
rpc_info->RunInterceptor(this, current_interceptor_index_); |
||||||
|
} |
||||||
|
|
||||||
|
void AddInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints type) override { |
||||||
|
hooks_[static_cast<size_t>(type)] = true; |
||||||
|
} |
||||||
|
|
||||||
|
ByteBuffer* GetSendMessage() override { return send_message_; } |
||||||
|
|
||||||
|
std::multimap<grpc::string, grpc::string>* GetSendInitialMetadata() override { |
||||||
|
return send_initial_metadata_; |
||||||
|
} |
||||||
|
|
||||||
|
Status GetSendStatus() override { |
||||||
|
return Status(static_cast<StatusCode>(*code_), *error_message_, |
||||||
|
*error_details_); |
||||||
|
} |
||||||
|
|
||||||
|
void ModifySendStatus(const Status& status) override { |
||||||
|
*code_ = static_cast<grpc_status_code>(status.error_code()); |
||||||
|
*error_details_ = status.error_details(); |
||||||
|
*error_message_ = status.error_message(); |
||||||
|
} |
||||||
|
|
||||||
|
std::multimap<grpc::string, grpc::string>* GetSendTrailingMetadata() |
||||||
|
override { |
||||||
|
return send_trailing_metadata_; |
||||||
|
} |
||||||
|
|
||||||
|
void* GetRecvMessage() override { return recv_message_; } |
||||||
|
|
||||||
|
std::multimap<grpc::string_ref, grpc::string_ref>* GetRecvInitialMetadata() |
||||||
|
override { |
||||||
|
return recv_initial_metadata_->map(); |
||||||
|
} |
||||||
|
|
||||||
|
Status* GetRecvStatus() override { return recv_status_; } |
||||||
|
|
||||||
|
std::multimap<grpc::string_ref, grpc::string_ref>* GetRecvTrailingMetadata() |
||||||
|
override { |
||||||
|
return recv_trailing_metadata_->map(); |
||||||
|
} |
||||||
|
|
||||||
|
void SetSendMessage(ByteBuffer* buf) override { send_message_ = buf; } |
||||||
|
|
||||||
|
void SetSendInitialMetadata( |
||||||
|
std::multimap<grpc::string, grpc::string>* metadata) override { |
||||||
|
send_initial_metadata_ = metadata; |
||||||
|
} |
||||||
|
|
||||||
|
void SetSendStatus(grpc_status_code* code, grpc::string* error_details, |
||||||
|
grpc::string* error_message) override { |
||||||
|
code_ = code; |
||||||
|
error_details_ = error_details; |
||||||
|
error_message_ = error_message; |
||||||
|
} |
||||||
|
|
||||||
|
void SetSendTrailingMetadata( |
||||||
|
std::multimap<grpc::string, grpc::string>* metadata) override { |
||||||
|
send_trailing_metadata_ = metadata; |
||||||
|
} |
||||||
|
|
||||||
|
void SetRecvMessage(void* message) override { recv_message_ = message; } |
||||||
|
|
||||||
|
void SetRecvInitialMetadata(MetadataMap* map) override { |
||||||
|
recv_initial_metadata_ = map; |
||||||
|
} |
||||||
|
|
||||||
|
void SetRecvStatus(Status* status) override { recv_status_ = status; } |
||||||
|
|
||||||
|
void SetRecvTrailingMetadata(MetadataMap* map) override { |
||||||
|
recv_trailing_metadata_ = map; |
||||||
|
} |
||||||
|
|
||||||
|
std::unique_ptr<ChannelInterface> GetInterceptedChannel() override { |
||||||
|
auto* info = call_->client_rpc_info(); |
||||||
|
if (info == nullptr) { |
||||||
|
return std::unique_ptr<ChannelInterface>(nullptr); |
||||||
|
} |
||||||
|
// The intercepted channel starts from the interceptor just after the
|
||||||
|
// current interceptor
|
||||||
|
return std::unique_ptr<ChannelInterface>(new InterceptedChannel( |
||||||
|
info->channel(), current_interceptor_index_ + 1)); |
||||||
|
} |
||||||
|
|
||||||
|
// Clears all state
|
||||||
|
void ClearState() { |
||||||
|
reverse_ = false; |
||||||
|
ran_hijacking_interceptor_ = false; |
||||||
|
ClearHookPoints(); |
||||||
|
} |
||||||
|
|
||||||
|
// Prepares for Post_recv operations
|
||||||
|
void SetReverse() { |
||||||
|
reverse_ = true; |
||||||
|
ran_hijacking_interceptor_ = false; |
||||||
|
ClearHookPoints(); |
||||||
|
} |
||||||
|
|
||||||
|
// This needs to be set before interceptors are run
|
||||||
|
void SetCall(Call* call) { call_ = call; } |
||||||
|
|
||||||
|
// This needs to be set before interceptors are run using RunInterceptors().
|
||||||
|
// Alternatively, RunInterceptors(std::function<void(void)> f) can be used.
|
||||||
|
void SetCallOpSetInterface(CallOpSetInterface* ops) { ops_ = ops; } |
||||||
|
|
||||||
|
// Returns true if no interceptors are run. This should be used only by
|
||||||
|
// subclasses of CallOpSetInterface. SetCall and SetCallOpSetInterface should
|
||||||
|
// have been called before this. After all the interceptors are done running,
|
||||||
|
// either ContinueFillOpsAfterInterception or
|
||||||
|
// ContinueFinalizeOpsAfterInterception will be called. Note that neither of
|
||||||
|
// them is invoked if there were no interceptors registered.
|
||||||
|
bool RunInterceptors() { |
||||||
|
GPR_CODEGEN_ASSERT(ops_); |
||||||
|
auto* client_rpc_info = call_->client_rpc_info(); |
||||||
|
if (client_rpc_info != nullptr) { |
||||||
|
if (client_rpc_info->interceptors_.size() == 0) { |
||||||
|
return true; |
||||||
|
} else { |
||||||
|
RunClientInterceptors(); |
||||||
|
return false; |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
auto* server_rpc_info = call_->server_rpc_info(); |
||||||
|
if (server_rpc_info == nullptr || |
||||||
|
server_rpc_info->interceptors_.size() == 0) { |
||||||
|
return true; |
||||||
|
} |
||||||
|
RunServerInterceptors(); |
||||||
|
return false; |
||||||
|
} |
||||||
|
|
||||||
|
// Returns true if no interceptors are run. Returns false otherwise if there
|
||||||
|
// are interceptors registered. After the interceptors are done running \a f
|
||||||
|
// will be invoked. This is to be used only by BaseAsyncRequest and
|
||||||
|
// SyncRequest.
|
||||||
|
bool RunInterceptors(std::function<void(void)> f) { |
||||||
|
// This is used only by the server for initial call request
|
||||||
|
GPR_CODEGEN_ASSERT(reverse_ == true); |
||||||
|
GPR_CODEGEN_ASSERT(call_->client_rpc_info() == nullptr); |
||||||
|
auto* server_rpc_info = call_->server_rpc_info(); |
||||||
|
if (server_rpc_info == nullptr || |
||||||
|
server_rpc_info->interceptors_.size() == 0) { |
||||||
|
return true; |
||||||
|
} |
||||||
|
callback_ = std::move(f); |
||||||
|
RunServerInterceptors(); |
||||||
|
return false; |
||||||
|
} |
||||||
|
|
||||||
|
private: |
||||||
|
void RunClientInterceptors() { |
||||||
|
auto* rpc_info = call_->client_rpc_info(); |
||||||
|
if (!reverse_) { |
||||||
|
current_interceptor_index_ = 0; |
||||||
|
} else { |
||||||
|
if (rpc_info->hijacked_) { |
||||||
|
current_interceptor_index_ = rpc_info->hijacked_interceptor_; |
||||||
|
} else { |
||||||
|
current_interceptor_index_ = rpc_info->interceptors_.size() - 1; |
||||||
|
} |
||||||
|
} |
||||||
|
rpc_info->RunInterceptor(this, current_interceptor_index_); |
||||||
|
} |
||||||
|
|
||||||
|
void RunServerInterceptors() { |
||||||
|
auto* rpc_info = call_->server_rpc_info(); |
||||||
|
if (!reverse_) { |
||||||
|
current_interceptor_index_ = 0; |
||||||
|
} else { |
||||||
|
current_interceptor_index_ = rpc_info->interceptors_.size() - 1; |
||||||
|
} |
||||||
|
rpc_info->RunInterceptor(this, current_interceptor_index_); |
||||||
|
} |
||||||
|
|
||||||
|
void ProceedClient() { |
||||||
|
auto* rpc_info = call_->client_rpc_info(); |
||||||
|
if (rpc_info->hijacked_ && !reverse_ && |
||||||
|
current_interceptor_index_ == rpc_info->hijacked_interceptor_ && |
||||||
|
!ran_hijacking_interceptor_) { |
||||||
|
// We now need to provide hijacked recv ops to this interceptor
|
||||||
|
ClearHookPoints(); |
||||||
|
ops_->SetHijackingState(); |
||||||
|
ran_hijacking_interceptor_ = true; |
||||||
|
rpc_info->RunInterceptor(this, current_interceptor_index_); |
||||||
|
return; |
||||||
|
} |
||||||
|
if (!reverse_) { |
||||||
|
current_interceptor_index_++; |
||||||
|
// We are going down the stack of interceptors
|
||||||
|
if (current_interceptor_index_ < rpc_info->interceptors_.size()) { |
||||||
|
if (rpc_info->hijacked_ && |
||||||
|
current_interceptor_index_ > rpc_info->hijacked_interceptor_) { |
||||||
|
// This is a hijacked RPC and we are done with hijacking
|
||||||
|
ops_->ContinueFillOpsAfterInterception(); |
||||||
|
} else { |
||||||
|
rpc_info->RunInterceptor(this, current_interceptor_index_); |
||||||
|
} |
||||||
|
} else { |
||||||
|
// we are done running all the interceptors without any hijacking
|
||||||
|
ops_->ContinueFillOpsAfterInterception(); |
||||||
|
} |
||||||
|
} else { |
||||||
|
// We are going up the stack of interceptors
|
||||||
|
if (current_interceptor_index_ > 0) { |
||||||
|
// Continue running interceptors
|
||||||
|
current_interceptor_index_--; |
||||||
|
rpc_info->RunInterceptor(this, current_interceptor_index_); |
||||||
|
} else { |
||||||
|
// we are done running all the interceptors without any hijacking
|
||||||
|
ops_->ContinueFinalizeResultAfterInterception(); |
||||||
|
} |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
void ProceedServer() { |
||||||
|
auto* rpc_info = call_->server_rpc_info(); |
||||||
|
if (!reverse_) { |
||||||
|
current_interceptor_index_++; |
||||||
|
if (current_interceptor_index_ < rpc_info->interceptors_.size()) { |
||||||
|
return rpc_info->RunInterceptor(this, current_interceptor_index_); |
||||||
|
} else if (ops_) { |
||||||
|
return ops_->ContinueFillOpsAfterInterception(); |
||||||
|
} |
||||||
|
} else { |
||||||
|
// We are going up the stack of interceptors
|
||||||
|
if (current_interceptor_index_ > 0) { |
||||||
|
// Continue running interceptors
|
||||||
|
current_interceptor_index_--; |
||||||
|
return rpc_info->RunInterceptor(this, current_interceptor_index_); |
||||||
|
} else if (ops_) { |
||||||
|
return ops_->ContinueFinalizeResultAfterInterception(); |
||||||
|
} |
||||||
|
} |
||||||
|
GPR_CODEGEN_ASSERT(callback_); |
||||||
|
callback_(); |
||||||
|
} |
||||||
|
|
||||||
|
void ClearHookPoints() { |
||||||
|
for (auto i = static_cast<experimental::InterceptionHookPoints>(0); |
||||||
|
i < experimental::InterceptionHookPoints::NUM_INTERCEPTION_HOOKS; |
||||||
|
i = static_cast<experimental::InterceptionHookPoints>( |
||||||
|
static_cast<size_t>(i) + 1)) { |
||||||
|
hooks_[static_cast<size_t>(i)] = false; |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
std::array<bool, |
||||||
|
static_cast<size_t>( |
||||||
|
experimental::InterceptionHookPoints::NUM_INTERCEPTION_HOOKS)> |
||||||
|
hooks_; |
||||||
|
|
||||||
|
size_t current_interceptor_index_ = 0; // Current iterator
|
||||||
|
bool reverse_ = false; |
||||||
|
bool ran_hijacking_interceptor_ = false; |
||||||
|
Call* call_ = nullptr; // The Call object is present along with CallOpSet
|
||||||
|
// object/callback
|
||||||
|
CallOpSetInterface* ops_ = nullptr; |
||||||
|
std::function<void(void)> callback_; |
||||||
|
|
||||||
|
ByteBuffer* send_message_ = nullptr; |
||||||
|
|
||||||
|
std::multimap<grpc::string, grpc::string>* send_initial_metadata_; |
||||||
|
|
||||||
|
grpc_status_code* code_ = nullptr; |
||||||
|
grpc::string* error_details_ = nullptr; |
||||||
|
grpc::string* error_message_ = nullptr; |
||||||
|
Status send_status_; |
||||||
|
|
||||||
|
std::multimap<grpc::string, grpc::string>* send_trailing_metadata_ = nullptr; |
||||||
|
|
||||||
|
void* recv_message_ = nullptr; |
||||||
|
|
||||||
|
MetadataMap* recv_initial_metadata_ = nullptr; |
||||||
|
|
||||||
|
Status* recv_status_ = nullptr; |
||||||
|
|
||||||
|
MetadataMap* recv_trailing_metadata_ = nullptr; |
||||||
|
}; |
||||||
|
|
||||||
|
} // namespace internal
|
||||||
|
} // namespace grpc
|
||||||
|
|
||||||
|
#endif // GRPCPP_IMPL_CODEGEN_INTERCEPTOR_COMMON_H
|
||||||
@ -0,0 +1,100 @@ |
|||||||
|
/*
|
||||||
|
* |
||||||
|
* Copyright 2018 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. |
||||||
|
* |
||||||
|
*/ |
||||||
|
|
||||||
|
#ifndef GRPCPP_IMPL_CODEGEN_SERVER_INTERCEPTOR_H |
||||||
|
#define GRPCPP_IMPL_CODEGEN_SERVER_INTERCEPTOR_H |
||||||
|
|
||||||
|
#include <atomic> |
||||||
|
#include <vector> |
||||||
|
|
||||||
|
#include <grpc/impl/codegen/log.h> |
||||||
|
#include <grpcpp/impl/codegen/interceptor.h> |
||||||
|
#include <grpcpp/impl/codegen/string_ref.h> |
||||||
|
|
||||||
|
namespace grpc { |
||||||
|
|
||||||
|
class ServerContext; |
||||||
|
|
||||||
|
namespace internal { |
||||||
|
class InterceptorBatchMethodsImpl; |
||||||
|
} |
||||||
|
|
||||||
|
namespace experimental { |
||||||
|
class ServerRpcInfo; |
||||||
|
|
||||||
|
class ServerInterceptorFactoryInterface { |
||||||
|
public: |
||||||
|
virtual ~ServerInterceptorFactoryInterface() {} |
||||||
|
virtual Interceptor* CreateServerInterceptor(ServerRpcInfo* info) = 0; |
||||||
|
}; |
||||||
|
|
||||||
|
class ServerRpcInfo { |
||||||
|
public: |
||||||
|
~ServerRpcInfo(){}; |
||||||
|
|
||||||
|
ServerRpcInfo(const ServerRpcInfo&) = delete; |
||||||
|
ServerRpcInfo(ServerRpcInfo&&) = default; |
||||||
|
ServerRpcInfo& operator=(ServerRpcInfo&&) = default; |
||||||
|
|
||||||
|
// Getter methods
|
||||||
|
const char* method() { return method_; } |
||||||
|
grpc::ServerContext* server_context() { return ctx_; } |
||||||
|
|
||||||
|
private: |
||||||
|
ServerRpcInfo(grpc::ServerContext* ctx, const char* method) |
||||||
|
: ctx_(ctx), method_(method) { |
||||||
|
ref_.store(1); |
||||||
|
} |
||||||
|
|
||||||
|
// Runs interceptor at pos \a pos.
|
||||||
|
void RunInterceptor( |
||||||
|
experimental::InterceptorBatchMethods* interceptor_methods, size_t pos) { |
||||||
|
GPR_CODEGEN_ASSERT(pos < interceptors_.size()); |
||||||
|
interceptors_[pos]->Intercept(interceptor_methods); |
||||||
|
} |
||||||
|
|
||||||
|
void RegisterInterceptors( |
||||||
|
const std::vector< |
||||||
|
std::unique_ptr<experimental::ServerInterceptorFactoryInterface>>& |
||||||
|
creators) { |
||||||
|
for (const auto& creator : creators) { |
||||||
|
interceptors_.push_back(std::unique_ptr<experimental::Interceptor>( |
||||||
|
creator->CreateServerInterceptor(this))); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
void Ref() { ref_++; } |
||||||
|
void Unref() { |
||||||
|
if (--ref_ == 0) { |
||||||
|
delete this; |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
grpc::ServerContext* ctx_ = nullptr; |
||||||
|
const char* method_ = nullptr; |
||||||
|
std::atomic_int ref_; |
||||||
|
std::vector<std::unique_ptr<experimental::Interceptor>> interceptors_; |
||||||
|
|
||||||
|
friend class internal::InterceptorBatchMethodsImpl; |
||||||
|
friend class grpc::ServerContext; |
||||||
|
}; |
||||||
|
|
||||||
|
} // namespace experimental
|
||||||
|
} // namespace grpc
|
||||||
|
|
||||||
|
#endif // GRPCPP_IMPL_CODEGEN_SERVER_INTERCEPTOR_H
|
||||||
@ -0,0 +1,606 @@ |
|||||||
|
/*
|
||||||
|
* |
||||||
|
* Copyright 2018 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 <memory> |
||||||
|
#include <vector> |
||||||
|
|
||||||
|
#include <grpcpp/channel.h> |
||||||
|
#include <grpcpp/client_context.h> |
||||||
|
#include <grpcpp/create_channel.h> |
||||||
|
#include <grpcpp/generic/generic_stub.h> |
||||||
|
#include <grpcpp/impl/codegen/client_interceptor.h> |
||||||
|
#include <grpcpp/impl/codegen/proto_utils.h> |
||||||
|
#include <grpcpp/server.h> |
||||||
|
#include <grpcpp/server_builder.h> |
||||||
|
#include <grpcpp/server_context.h> |
||||||
|
|
||||||
|
#include "src/proto/grpc/testing/echo.grpc.pb.h" |
||||||
|
#include "test/core/util/port.h" |
||||||
|
#include "test/core/util/test_config.h" |
||||||
|
#include "test/cpp/end2end/interceptors_util.h" |
||||||
|
#include "test/cpp/end2end/test_service_impl.h" |
||||||
|
#include "test/cpp/util/byte_buffer_proto_helper.h" |
||||||
|
#include "test/cpp/util/string_ref_helper.h" |
||||||
|
|
||||||
|
#include <gtest/gtest.h> |
||||||
|
|
||||||
|
namespace grpc { |
||||||
|
namespace testing { |
||||||
|
namespace { |
||||||
|
|
||||||
|
class ClientInterceptorsStreamingEnd2endTest : public ::testing::Test { |
||||||
|
protected: |
||||||
|
ClientInterceptorsStreamingEnd2endTest() { |
||||||
|
int port = grpc_pick_unused_port_or_die(); |
||||||
|
|
||||||
|
ServerBuilder builder; |
||||||
|
server_address_ = "localhost:" + std::to_string(port); |
||||||
|
builder.AddListeningPort(server_address_, InsecureServerCredentials()); |
||||||
|
builder.RegisterService(&service_); |
||||||
|
server_ = builder.BuildAndStart(); |
||||||
|
} |
||||||
|
|
||||||
|
~ClientInterceptorsStreamingEnd2endTest() { server_->Shutdown(); } |
||||||
|
|
||||||
|
std::string server_address_; |
||||||
|
EchoTestServiceStreamingImpl service_; |
||||||
|
std::unique_ptr<Server> server_; |
||||||
|
}; |
||||||
|
|
||||||
|
class ClientInterceptorsEnd2endTest : public ::testing::Test { |
||||||
|
protected: |
||||||
|
ClientInterceptorsEnd2endTest() { |
||||||
|
int port = grpc_pick_unused_port_or_die(); |
||||||
|
|
||||||
|
ServerBuilder builder; |
||||||
|
server_address_ = "localhost:" + std::to_string(port); |
||||||
|
builder.AddListeningPort(server_address_, InsecureServerCredentials()); |
||||||
|
builder.RegisterService(&service_); |
||||||
|
server_ = builder.BuildAndStart(); |
||||||
|
} |
||||||
|
|
||||||
|
~ClientInterceptorsEnd2endTest() { server_->Shutdown(); } |
||||||
|
|
||||||
|
std::string server_address_; |
||||||
|
TestServiceImpl service_; |
||||||
|
std::unique_ptr<Server> server_; |
||||||
|
}; |
||||||
|
|
||||||
|
/* This interceptor does nothing. Just keeps a global count on the number of
|
||||||
|
* times it was invoked. */ |
||||||
|
class DummyInterceptor : public experimental::Interceptor { |
||||||
|
public: |
||||||
|
DummyInterceptor(experimental::ClientRpcInfo* info) {} |
||||||
|
|
||||||
|
virtual void Intercept(experimental::InterceptorBatchMethods* methods) { |
||||||
|
if (methods->QueryInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints::PRE_SEND_INITIAL_METADATA)) { |
||||||
|
num_times_run_++; |
||||||
|
} else if (methods->QueryInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints:: |
||||||
|
POST_RECV_INITIAL_METADATA)) { |
||||||
|
num_times_run_reverse_++; |
||||||
|
} |
||||||
|
methods->Proceed(); |
||||||
|
} |
||||||
|
|
||||||
|
static void Reset() { |
||||||
|
num_times_run_.store(0); |
||||||
|
num_times_run_reverse_.store(0); |
||||||
|
} |
||||||
|
|
||||||
|
static int GetNumTimesRun() { |
||||||
|
EXPECT_EQ(num_times_run_.load(), num_times_run_reverse_.load()); |
||||||
|
return num_times_run_.load(); |
||||||
|
} |
||||||
|
|
||||||
|
private: |
||||||
|
static std::atomic<int> num_times_run_; |
||||||
|
static std::atomic<int> num_times_run_reverse_; |
||||||
|
}; |
||||||
|
|
||||||
|
std::atomic<int> DummyInterceptor::num_times_run_; |
||||||
|
std::atomic<int> DummyInterceptor::num_times_run_reverse_; |
||||||
|
|
||||||
|
class DummyInterceptorFactory |
||||||
|
: public experimental::ClientInterceptorFactoryInterface { |
||||||
|
public: |
||||||
|
virtual experimental::Interceptor* CreateClientInterceptor( |
||||||
|
experimental::ClientRpcInfo* info) override { |
||||||
|
return new DummyInterceptor(info); |
||||||
|
} |
||||||
|
}; |
||||||
|
|
||||||
|
/* Hijacks Echo RPC and fills in the expected values */ |
||||||
|
class HijackingInterceptor : public experimental::Interceptor { |
||||||
|
public: |
||||||
|
HijackingInterceptor(experimental::ClientRpcInfo* info) { |
||||||
|
info_ = info; |
||||||
|
// Make sure it is the right method
|
||||||
|
EXPECT_EQ(strcmp("/grpc.testing.EchoTestService/Echo", info->method()), 0); |
||||||
|
} |
||||||
|
|
||||||
|
virtual void Intercept(experimental::InterceptorBatchMethods* methods) { |
||||||
|
bool hijack = false; |
||||||
|
if (methods->QueryInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints::PRE_SEND_INITIAL_METADATA)) { |
||||||
|
auto* map = methods->GetSendInitialMetadata(); |
||||||
|
// Check that we can see the test metadata
|
||||||
|
ASSERT_EQ(map->size(), static_cast<unsigned>(1)); |
||||||
|
auto iterator = map->begin(); |
||||||
|
EXPECT_EQ("testkey", iterator->first); |
||||||
|
EXPECT_EQ("testvalue", iterator->second); |
||||||
|
hijack = true; |
||||||
|
} |
||||||
|
if (methods->QueryInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints::PRE_SEND_MESSAGE)) { |
||||||
|
EchoRequest req; |
||||||
|
auto* buffer = methods->GetSendMessage(); |
||||||
|
auto copied_buffer = *buffer; |
||||||
|
SerializationTraits<EchoRequest>::Deserialize(&copied_buffer, &req); |
||||||
|
EXPECT_EQ(req.message(), "Hello"); |
||||||
|
} |
||||||
|
if (methods->QueryInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints::PRE_SEND_CLOSE)) { |
||||||
|
// Got nothing to do here for now
|
||||||
|
} |
||||||
|
if (methods->QueryInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints::POST_RECV_INITIAL_METADATA)) { |
||||||
|
auto* map = methods->GetRecvInitialMetadata(); |
||||||
|
// Got nothing better to do here for now
|
||||||
|
EXPECT_EQ(map->size(), static_cast<unsigned>(0)); |
||||||
|
} |
||||||
|
if (methods->QueryInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints::POST_RECV_MESSAGE)) { |
||||||
|
EchoResponse* resp = |
||||||
|
static_cast<EchoResponse*>(methods->GetRecvMessage()); |
||||||
|
// Check that we got the hijacked message, and re-insert the expected
|
||||||
|
// message
|
||||||
|
EXPECT_EQ(resp->message(), "Hello1"); |
||||||
|
resp->set_message("Hello"); |
||||||
|
} |
||||||
|
if (methods->QueryInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints::POST_RECV_STATUS)) { |
||||||
|
auto* map = methods->GetRecvTrailingMetadata(); |
||||||
|
bool found = false; |
||||||
|
// Check that we received the metadata as an echo
|
||||||
|
for (const auto& pair : *map) { |
||||||
|
found = pair.first.starts_with("testkey") && |
||||||
|
pair.second.starts_with("testvalue"); |
||||||
|
if (found) break; |
||||||
|
} |
||||||
|
EXPECT_EQ(found, true); |
||||||
|
auto* status = methods->GetRecvStatus(); |
||||||
|
EXPECT_EQ(status->ok(), true); |
||||||
|
} |
||||||
|
if (methods->QueryInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints::PRE_RECV_INITIAL_METADATA)) { |
||||||
|
auto* map = methods->GetRecvInitialMetadata(); |
||||||
|
// Got nothing better to do here at the moment
|
||||||
|
EXPECT_EQ(map->size(), static_cast<unsigned>(0)); |
||||||
|
} |
||||||
|
if (methods->QueryInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints::PRE_RECV_MESSAGE)) { |
||||||
|
// Insert a different message than expected
|
||||||
|
EchoResponse* resp = |
||||||
|
static_cast<EchoResponse*>(methods->GetRecvMessage()); |
||||||
|
resp->set_message("Hello1"); |
||||||
|
} |
||||||
|
if (methods->QueryInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints::PRE_RECV_STATUS)) { |
||||||
|
auto* map = methods->GetRecvTrailingMetadata(); |
||||||
|
// insert the metadata that we want
|
||||||
|
EXPECT_EQ(map->size(), static_cast<unsigned>(0)); |
||||||
|
map->insert(std::make_pair("testkey", "testvalue")); |
||||||
|
auto* status = methods->GetRecvStatus(); |
||||||
|
*status = Status(StatusCode::OK, ""); |
||||||
|
} |
||||||
|
if (hijack) { |
||||||
|
methods->Hijack(); |
||||||
|
} else { |
||||||
|
methods->Proceed(); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
private: |
||||||
|
experimental::ClientRpcInfo* info_; |
||||||
|
}; |
||||||
|
|
||||||
|
class HijackingInterceptorFactory |
||||||
|
: public experimental::ClientInterceptorFactoryInterface { |
||||||
|
public: |
||||||
|
virtual experimental::Interceptor* CreateClientInterceptor( |
||||||
|
experimental::ClientRpcInfo* info) override { |
||||||
|
return new HijackingInterceptor(info); |
||||||
|
} |
||||||
|
}; |
||||||
|
|
||||||
|
class HijackingInterceptorMakesAnotherCall : public experimental::Interceptor { |
||||||
|
public: |
||||||
|
HijackingInterceptorMakesAnotherCall(experimental::ClientRpcInfo* info) { |
||||||
|
info_ = info; |
||||||
|
// Make sure it is the right method
|
||||||
|
EXPECT_EQ(strcmp("/grpc.testing.EchoTestService/Echo", info->method()), 0); |
||||||
|
} |
||||||
|
|
||||||
|
virtual void Intercept(experimental::InterceptorBatchMethods* methods) { |
||||||
|
if (methods->QueryInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints::PRE_SEND_INITIAL_METADATA)) { |
||||||
|
auto* map = methods->GetSendInitialMetadata(); |
||||||
|
// Check that we can see the test metadata
|
||||||
|
ASSERT_EQ(map->size(), static_cast<unsigned>(1)); |
||||||
|
auto iterator = map->begin(); |
||||||
|
EXPECT_EQ("testkey", iterator->first); |
||||||
|
EXPECT_EQ("testvalue", iterator->second); |
||||||
|
// Make a copy of the map
|
||||||
|
metadata_map_ = *map; |
||||||
|
} |
||||||
|
if (methods->QueryInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints::PRE_SEND_MESSAGE)) { |
||||||
|
EchoRequest req; |
||||||
|
auto* buffer = methods->GetSendMessage(); |
||||||
|
auto copied_buffer = *buffer; |
||||||
|
SerializationTraits<EchoRequest>::Deserialize(&copied_buffer, &req); |
||||||
|
EXPECT_EQ(req.message(), "Hello"); |
||||||
|
req_ = req; |
||||||
|
stub_ = grpc::testing::EchoTestService::NewStub( |
||||||
|
methods->GetInterceptedChannel()); |
||||||
|
ctx_.AddMetadata(metadata_map_.begin()->first, |
||||||
|
metadata_map_.begin()->second); |
||||||
|
stub_->experimental_async()->Echo(&ctx_, &req_, &resp_, |
||||||
|
[this, methods](Status s) { |
||||||
|
EXPECT_EQ(s.ok(), true); |
||||||
|
EXPECT_EQ(resp_.message(), "Hello"); |
||||||
|
methods->Hijack(); |
||||||
|
}); |
||||||
|
// There isn't going to be any other interesting operation in this batch,
|
||||||
|
// so it is fine to return
|
||||||
|
return; |
||||||
|
} |
||||||
|
if (methods->QueryInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints::PRE_SEND_CLOSE)) { |
||||||
|
// Got nothing to do here for now
|
||||||
|
} |
||||||
|
if (methods->QueryInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints::POST_RECV_INITIAL_METADATA)) { |
||||||
|
auto* map = methods->GetRecvInitialMetadata(); |
||||||
|
// Got nothing better to do here for now
|
||||||
|
EXPECT_EQ(map->size(), static_cast<unsigned>(0)); |
||||||
|
} |
||||||
|
if (methods->QueryInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints::POST_RECV_MESSAGE)) { |
||||||
|
EchoResponse* resp = |
||||||
|
static_cast<EchoResponse*>(methods->GetRecvMessage()); |
||||||
|
// Check that we got the hijacked message, and re-insert the expected
|
||||||
|
// message
|
||||||
|
EXPECT_EQ(resp->message(), "Hello"); |
||||||
|
} |
||||||
|
if (methods->QueryInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints::POST_RECV_STATUS)) { |
||||||
|
auto* map = methods->GetRecvTrailingMetadata(); |
||||||
|
bool found = false; |
||||||
|
// Check that we received the metadata as an echo
|
||||||
|
for (const auto& pair : *map) { |
||||||
|
found = pair.first.starts_with("testkey") && |
||||||
|
pair.second.starts_with("testvalue"); |
||||||
|
if (found) break; |
||||||
|
} |
||||||
|
EXPECT_EQ(found, true); |
||||||
|
auto* status = methods->GetRecvStatus(); |
||||||
|
EXPECT_EQ(status->ok(), true); |
||||||
|
} |
||||||
|
if (methods->QueryInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints::PRE_RECV_INITIAL_METADATA)) { |
||||||
|
auto* map = methods->GetRecvInitialMetadata(); |
||||||
|
// Got nothing better to do here at the moment
|
||||||
|
EXPECT_EQ(map->size(), static_cast<unsigned>(0)); |
||||||
|
} |
||||||
|
if (methods->QueryInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints::PRE_RECV_MESSAGE)) { |
||||||
|
// Insert a different message than expected
|
||||||
|
EchoResponse* resp = |
||||||
|
static_cast<EchoResponse*>(methods->GetRecvMessage()); |
||||||
|
resp->set_message(resp_.message()); |
||||||
|
} |
||||||
|
if (methods->QueryInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints::PRE_RECV_STATUS)) { |
||||||
|
auto* map = methods->GetRecvTrailingMetadata(); |
||||||
|
// insert the metadata that we want
|
||||||
|
EXPECT_EQ(map->size(), static_cast<unsigned>(0)); |
||||||
|
map->insert(std::make_pair("testkey", "testvalue")); |
||||||
|
auto* status = methods->GetRecvStatus(); |
||||||
|
*status = Status(StatusCode::OK, ""); |
||||||
|
} |
||||||
|
|
||||||
|
methods->Proceed(); |
||||||
|
} |
||||||
|
|
||||||
|
private: |
||||||
|
experimental::ClientRpcInfo* info_; |
||||||
|
std::multimap<grpc::string, grpc::string> metadata_map_; |
||||||
|
ClientContext ctx_; |
||||||
|
EchoRequest req_; |
||||||
|
EchoResponse resp_; |
||||||
|
std::unique_ptr<grpc::testing::EchoTestService::Stub> stub_; |
||||||
|
}; |
||||||
|
|
||||||
|
class HijackingInterceptorMakesAnotherCallFactory |
||||||
|
: public experimental::ClientInterceptorFactoryInterface { |
||||||
|
public: |
||||||
|
virtual experimental::Interceptor* CreateClientInterceptor( |
||||||
|
experimental::ClientRpcInfo* info) override { |
||||||
|
return new HijackingInterceptorMakesAnotherCall(info); |
||||||
|
} |
||||||
|
}; |
||||||
|
|
||||||
|
class LoggingInterceptor : public experimental::Interceptor { |
||||||
|
public: |
||||||
|
LoggingInterceptor(experimental::ClientRpcInfo* info) { info_ = info; } |
||||||
|
|
||||||
|
virtual void Intercept(experimental::InterceptorBatchMethods* methods) { |
||||||
|
if (methods->QueryInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints::PRE_SEND_INITIAL_METADATA)) { |
||||||
|
auto* map = methods->GetSendInitialMetadata(); |
||||||
|
// Check that we can see the test metadata
|
||||||
|
ASSERT_EQ(map->size(), static_cast<unsigned>(1)); |
||||||
|
auto iterator = map->begin(); |
||||||
|
EXPECT_EQ("testkey", iterator->first); |
||||||
|
EXPECT_EQ("testvalue", iterator->second); |
||||||
|
} |
||||||
|
if (methods->QueryInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints::PRE_SEND_MESSAGE)) { |
||||||
|
EchoRequest req; |
||||||
|
auto* buffer = methods->GetSendMessage(); |
||||||
|
auto copied_buffer = *buffer; |
||||||
|
SerializationTraits<EchoRequest>::Deserialize(&copied_buffer, &req); |
||||||
|
EXPECT_TRUE(req.message().find("Hello") == 0); |
||||||
|
} |
||||||
|
if (methods->QueryInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints::PRE_SEND_CLOSE)) { |
||||||
|
// Got nothing to do here for now
|
||||||
|
} |
||||||
|
if (methods->QueryInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints::POST_RECV_INITIAL_METADATA)) { |
||||||
|
auto* map = methods->GetRecvInitialMetadata(); |
||||||
|
// Got nothing better to do here for now
|
||||||
|
EXPECT_EQ(map->size(), static_cast<unsigned>(0)); |
||||||
|
} |
||||||
|
if (methods->QueryInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints::POST_RECV_MESSAGE)) { |
||||||
|
EchoResponse* resp = |
||||||
|
static_cast<EchoResponse*>(methods->GetRecvMessage()); |
||||||
|
EXPECT_TRUE(resp->message().find("Hello") == 0); |
||||||
|
} |
||||||
|
if (methods->QueryInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints::POST_RECV_STATUS)) { |
||||||
|
auto* map = methods->GetRecvTrailingMetadata(); |
||||||
|
bool found = false; |
||||||
|
// Check that we received the metadata as an echo
|
||||||
|
for (const auto& pair : *map) { |
||||||
|
found = pair.first.starts_with("testkey") && |
||||||
|
pair.second.starts_with("testvalue"); |
||||||
|
if (found) break; |
||||||
|
} |
||||||
|
EXPECT_EQ(found, true); |
||||||
|
auto* status = methods->GetRecvStatus(); |
||||||
|
EXPECT_EQ(status->ok(), true); |
||||||
|
} |
||||||
|
methods->Proceed(); |
||||||
|
} |
||||||
|
|
||||||
|
private: |
||||||
|
experimental::ClientRpcInfo* info_; |
||||||
|
}; |
||||||
|
|
||||||
|
class LoggingInterceptorFactory |
||||||
|
: public experimental::ClientInterceptorFactoryInterface { |
||||||
|
public: |
||||||
|
virtual experimental::Interceptor* CreateClientInterceptor( |
||||||
|
experimental::ClientRpcInfo* info) override { |
||||||
|
return new LoggingInterceptor(info); |
||||||
|
} |
||||||
|
}; |
||||||
|
|
||||||
|
TEST_F(ClientInterceptorsEnd2endTest, ClientInterceptorLoggingTest) { |
||||||
|
ChannelArguments args; |
||||||
|
DummyInterceptor::Reset(); |
||||||
|
auto creators = std::unique_ptr<std::vector< |
||||||
|
std::unique_ptr<experimental::ClientInterceptorFactoryInterface>>>( |
||||||
|
new std::vector< |
||||||
|
std::unique_ptr<experimental::ClientInterceptorFactoryInterface>>()); |
||||||
|
creators->push_back(std::unique_ptr<LoggingInterceptorFactory>( |
||||||
|
new LoggingInterceptorFactory())); |
||||||
|
// Add 20 dummy interceptors
|
||||||
|
for (auto i = 0; i < 20; i++) { |
||||||
|
creators->push_back(std::unique_ptr<DummyInterceptorFactory>( |
||||||
|
new DummyInterceptorFactory())); |
||||||
|
} |
||||||
|
auto channel = experimental::CreateCustomChannelWithInterceptors( |
||||||
|
server_address_, InsecureChannelCredentials(), args, std::move(creators)); |
||||||
|
MakeCall(channel); |
||||||
|
// Make sure all 20 dummy interceptors were run
|
||||||
|
EXPECT_EQ(DummyInterceptor::GetNumTimesRun(), 20); |
||||||
|
} |
||||||
|
|
||||||
|
TEST_F(ClientInterceptorsEnd2endTest, ClientInterceptorHijackingTest) { |
||||||
|
ChannelArguments args; |
||||||
|
DummyInterceptor::Reset(); |
||||||
|
auto creators = std::unique_ptr<std::vector< |
||||||
|
std::unique_ptr<experimental::ClientInterceptorFactoryInterface>>>( |
||||||
|
new std::vector< |
||||||
|
std::unique_ptr<experimental::ClientInterceptorFactoryInterface>>()); |
||||||
|
// Add 20 dummy interceptors before hijacking interceptor
|
||||||
|
for (auto i = 0; i < 20; i++) { |
||||||
|
creators->push_back(std::unique_ptr<DummyInterceptorFactory>( |
||||||
|
new DummyInterceptorFactory())); |
||||||
|
} |
||||||
|
creators->push_back(std::unique_ptr<HijackingInterceptorFactory>( |
||||||
|
new HijackingInterceptorFactory())); |
||||||
|
// Add 20 dummy interceptors after hijacking interceptor
|
||||||
|
for (auto i = 0; i < 20; i++) { |
||||||
|
creators->push_back(std::unique_ptr<DummyInterceptorFactory>( |
||||||
|
new DummyInterceptorFactory())); |
||||||
|
} |
||||||
|
auto channel = experimental::CreateCustomChannelWithInterceptors( |
||||||
|
server_address_, InsecureChannelCredentials(), args, std::move(creators)); |
||||||
|
|
||||||
|
MakeCall(channel); |
||||||
|
// Make sure only 20 dummy interceptors were run
|
||||||
|
EXPECT_EQ(DummyInterceptor::GetNumTimesRun(), 20); |
||||||
|
} |
||||||
|
|
||||||
|
TEST_F(ClientInterceptorsEnd2endTest, ClientInterceptorLogThenHijackTest) { |
||||||
|
ChannelArguments args; |
||||||
|
auto creators = std::unique_ptr<std::vector< |
||||||
|
std::unique_ptr<experimental::ClientInterceptorFactoryInterface>>>( |
||||||
|
new std::vector< |
||||||
|
std::unique_ptr<experimental::ClientInterceptorFactoryInterface>>()); |
||||||
|
creators->push_back(std::unique_ptr<LoggingInterceptorFactory>( |
||||||
|
new LoggingInterceptorFactory())); |
||||||
|
creators->push_back(std::unique_ptr<HijackingInterceptorFactory>( |
||||||
|
new HijackingInterceptorFactory())); |
||||||
|
auto channel = experimental::CreateCustomChannelWithInterceptors( |
||||||
|
server_address_, InsecureChannelCredentials(), args, std::move(creators)); |
||||||
|
|
||||||
|
MakeCall(channel); |
||||||
|
} |
||||||
|
|
||||||
|
TEST_F(ClientInterceptorsEnd2endTest, |
||||||
|
ClientInterceptorHijackingMakesAnotherCallTest) { |
||||||
|
ChannelArguments args; |
||||||
|
DummyInterceptor::Reset(); |
||||||
|
auto creators = std::unique_ptr<std::vector< |
||||||
|
std::unique_ptr<experimental::ClientInterceptorFactoryInterface>>>( |
||||||
|
new std::vector< |
||||||
|
std::unique_ptr<experimental::ClientInterceptorFactoryInterface>>()); |
||||||
|
// Add 5 dummy interceptors before hijacking interceptor
|
||||||
|
for (auto i = 0; i < 5; i++) { |
||||||
|
creators->push_back(std::unique_ptr<DummyInterceptorFactory>( |
||||||
|
new DummyInterceptorFactory())); |
||||||
|
} |
||||||
|
creators->push_back( |
||||||
|
std::unique_ptr<experimental::ClientInterceptorFactoryInterface>( |
||||||
|
new HijackingInterceptorMakesAnotherCallFactory())); |
||||||
|
// Add 7 dummy interceptors after hijacking interceptor
|
||||||
|
for (auto i = 0; i < 7; i++) { |
||||||
|
creators->push_back(std::unique_ptr<DummyInterceptorFactory>( |
||||||
|
new DummyInterceptorFactory())); |
||||||
|
} |
||||||
|
auto channel = server_->experimental().InProcessChannelWithInterceptors( |
||||||
|
args, std::move(creators)); |
||||||
|
|
||||||
|
MakeCall(channel); |
||||||
|
// Make sure all interceptors were run once, since the hijacking interceptor
|
||||||
|
// makes an RPC on the intercepted channel
|
||||||
|
EXPECT_EQ(DummyInterceptor::GetNumTimesRun(), 12); |
||||||
|
} |
||||||
|
|
||||||
|
TEST_F(ClientInterceptorsEnd2endTest, |
||||||
|
ClientInterceptorLoggingTestWithCallback) { |
||||||
|
ChannelArguments args; |
||||||
|
DummyInterceptor::Reset(); |
||||||
|
auto creators = std::unique_ptr<std::vector< |
||||||
|
std::unique_ptr<experimental::ClientInterceptorFactoryInterface>>>( |
||||||
|
new std::vector< |
||||||
|
std::unique_ptr<experimental::ClientInterceptorFactoryInterface>>()); |
||||||
|
creators->push_back(std::unique_ptr<LoggingInterceptorFactory>( |
||||||
|
new LoggingInterceptorFactory())); |
||||||
|
// Add 20 dummy interceptors
|
||||||
|
for (auto i = 0; i < 20; i++) { |
||||||
|
creators->push_back(std::unique_ptr<DummyInterceptorFactory>( |
||||||
|
new DummyInterceptorFactory())); |
||||||
|
} |
||||||
|
auto channel = server_->experimental().InProcessChannelWithInterceptors( |
||||||
|
args, std::move(creators)); |
||||||
|
MakeCallbackCall(channel); |
||||||
|
// Make sure all 20 dummy interceptors were run
|
||||||
|
EXPECT_EQ(DummyInterceptor::GetNumTimesRun(), 20); |
||||||
|
} |
||||||
|
|
||||||
|
TEST_F(ClientInterceptorsStreamingEnd2endTest, ClientStreamingTest) { |
||||||
|
ChannelArguments args; |
||||||
|
DummyInterceptor::Reset(); |
||||||
|
auto creators = std::unique_ptr<std::vector< |
||||||
|
std::unique_ptr<experimental::ClientInterceptorFactoryInterface>>>( |
||||||
|
new std::vector< |
||||||
|
std::unique_ptr<experimental::ClientInterceptorFactoryInterface>>()); |
||||||
|
creators->push_back(std::unique_ptr<LoggingInterceptorFactory>( |
||||||
|
new LoggingInterceptorFactory())); |
||||||
|
// Add 20 dummy interceptors
|
||||||
|
for (auto i = 0; i < 20; i++) { |
||||||
|
creators->push_back(std::unique_ptr<DummyInterceptorFactory>( |
||||||
|
new DummyInterceptorFactory())); |
||||||
|
} |
||||||
|
auto channel = experimental::CreateCustomChannelWithInterceptors( |
||||||
|
server_address_, InsecureChannelCredentials(), args, std::move(creators)); |
||||||
|
MakeClientStreamingCall(channel); |
||||||
|
// Make sure all 20 dummy interceptors were run
|
||||||
|
EXPECT_EQ(DummyInterceptor::GetNumTimesRun(), 20); |
||||||
|
} |
||||||
|
|
||||||
|
TEST_F(ClientInterceptorsStreamingEnd2endTest, ServerStreamingTest) { |
||||||
|
ChannelArguments args; |
||||||
|
DummyInterceptor::Reset(); |
||||||
|
auto creators = std::unique_ptr<std::vector< |
||||||
|
std::unique_ptr<experimental::ClientInterceptorFactoryInterface>>>( |
||||||
|
new std::vector< |
||||||
|
std::unique_ptr<experimental::ClientInterceptorFactoryInterface>>()); |
||||||
|
creators->push_back(std::unique_ptr<LoggingInterceptorFactory>( |
||||||
|
new LoggingInterceptorFactory())); |
||||||
|
// Add 20 dummy interceptors
|
||||||
|
for (auto i = 0; i < 20; i++) { |
||||||
|
creators->push_back(std::unique_ptr<DummyInterceptorFactory>( |
||||||
|
new DummyInterceptorFactory())); |
||||||
|
} |
||||||
|
auto channel = experimental::CreateCustomChannelWithInterceptors( |
||||||
|
server_address_, InsecureChannelCredentials(), args, std::move(creators)); |
||||||
|
MakeServerStreamingCall(channel); |
||||||
|
// Make sure all 20 dummy interceptors were run
|
||||||
|
EXPECT_EQ(DummyInterceptor::GetNumTimesRun(), 20); |
||||||
|
} |
||||||
|
|
||||||
|
TEST_F(ClientInterceptorsStreamingEnd2endTest, BidiStreamingTest) { |
||||||
|
ChannelArguments args; |
||||||
|
DummyInterceptor::Reset(); |
||||||
|
auto creators = std::unique_ptr<std::vector< |
||||||
|
std::unique_ptr<experimental::ClientInterceptorFactoryInterface>>>( |
||||||
|
new std::vector< |
||||||
|
std::unique_ptr<experimental::ClientInterceptorFactoryInterface>>()); |
||||||
|
creators->push_back(std::unique_ptr<LoggingInterceptorFactory>( |
||||||
|
new LoggingInterceptorFactory())); |
||||||
|
// Add 20 dummy interceptors
|
||||||
|
for (auto i = 0; i < 20; i++) { |
||||||
|
creators->push_back(std::unique_ptr<DummyInterceptorFactory>( |
||||||
|
new DummyInterceptorFactory())); |
||||||
|
} |
||||||
|
auto channel = experimental::CreateCustomChannelWithInterceptors( |
||||||
|
server_address_, InsecureChannelCredentials(), args, std::move(creators)); |
||||||
|
MakeBidiStreamingCall(channel); |
||||||
|
// Make sure all 20 dummy interceptors were run
|
||||||
|
EXPECT_EQ(DummyInterceptor::GetNumTimesRun(), 20); |
||||||
|
} |
||||||
|
|
||||||
|
} // namespace
|
||||||
|
} // namespace testing
|
||||||
|
} // namespace grpc
|
||||||
|
|
||||||
|
int main(int argc, char** argv) { |
||||||
|
grpc_test_init(argc, argv); |
||||||
|
::testing::InitGoogleTest(&argc, argv); |
||||||
|
return RUN_ALL_TESTS(); |
||||||
|
} |
||||||
@ -0,0 +1,308 @@ |
|||||||
|
/*
|
||||||
|
* |
||||||
|
* Copyright 2018 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 "src/proto/grpc/testing/echo.grpc.pb.h" |
||||||
|
#include "test/cpp/util/string_ref_helper.h" |
||||||
|
|
||||||
|
#include <gtest/gtest.h> |
||||||
|
|
||||||
|
namespace grpc { |
||||||
|
namespace testing { |
||||||
|
class EchoTestServiceStreamingImpl : public EchoTestService::Service { |
||||||
|
public: |
||||||
|
~EchoTestServiceStreamingImpl() override {} |
||||||
|
|
||||||
|
Status BidiStream( |
||||||
|
ServerContext* context, |
||||||
|
grpc::ServerReaderWriter<EchoResponse, EchoRequest>* stream) override { |
||||||
|
EchoRequest req; |
||||||
|
EchoResponse resp; |
||||||
|
auto client_metadata = context->client_metadata(); |
||||||
|
for (const auto& pair : client_metadata) { |
||||||
|
context->AddTrailingMetadata(ToString(pair.first), ToString(pair.second)); |
||||||
|
} |
||||||
|
|
||||||
|
while (stream->Read(&req)) { |
||||||
|
resp.set_message(req.message()); |
||||||
|
EXPECT_TRUE(stream->Write(resp, grpc::WriteOptions())); |
||||||
|
} |
||||||
|
return Status::OK; |
||||||
|
} |
||||||
|
|
||||||
|
Status RequestStream(ServerContext* context, |
||||||
|
ServerReader<EchoRequest>* reader, |
||||||
|
EchoResponse* resp) override { |
||||||
|
auto client_metadata = context->client_metadata(); |
||||||
|
for (const auto& pair : client_metadata) { |
||||||
|
context->AddTrailingMetadata(ToString(pair.first), ToString(pair.second)); |
||||||
|
} |
||||||
|
|
||||||
|
EchoRequest req; |
||||||
|
string response_str = ""; |
||||||
|
while (reader->Read(&req)) { |
||||||
|
response_str += req.message(); |
||||||
|
} |
||||||
|
resp->set_message(response_str); |
||||||
|
return Status::OK; |
||||||
|
} |
||||||
|
|
||||||
|
Status ResponseStream(ServerContext* context, const EchoRequest* req, |
||||||
|
ServerWriter<EchoResponse>* writer) override { |
||||||
|
auto client_metadata = context->client_metadata(); |
||||||
|
for (const auto& pair : client_metadata) { |
||||||
|
context->AddTrailingMetadata(ToString(pair.first), ToString(pair.second)); |
||||||
|
} |
||||||
|
|
||||||
|
EchoResponse resp; |
||||||
|
resp.set_message(req->message()); |
||||||
|
for (int i = 0; i < 10; i++) { |
||||||
|
EXPECT_TRUE(writer->Write(resp)); |
||||||
|
} |
||||||
|
return Status::OK; |
||||||
|
} |
||||||
|
}; |
||||||
|
|
||||||
|
void MakeCall(const std::shared_ptr<Channel>& channel) { |
||||||
|
auto stub = grpc::testing::EchoTestService::NewStub(channel); |
||||||
|
ClientContext ctx; |
||||||
|
EchoRequest req; |
||||||
|
req.mutable_param()->set_echo_metadata(true); |
||||||
|
ctx.AddMetadata("testkey", "testvalue"); |
||||||
|
req.set_message("Hello"); |
||||||
|
EchoResponse resp; |
||||||
|
Status s = stub->Echo(&ctx, req, &resp); |
||||||
|
EXPECT_EQ(s.ok(), true); |
||||||
|
EXPECT_EQ(resp.message(), "Hello"); |
||||||
|
} |
||||||
|
|
||||||
|
void MakeClientStreamingCall(const std::shared_ptr<Channel>& channel) { |
||||||
|
auto stub = grpc::testing::EchoTestService::NewStub(channel); |
||||||
|
ClientContext ctx; |
||||||
|
EchoRequest req; |
||||||
|
req.mutable_param()->set_echo_metadata(true); |
||||||
|
ctx.AddMetadata("testkey", "testvalue"); |
||||||
|
req.set_message("Hello"); |
||||||
|
EchoResponse resp; |
||||||
|
string expected_resp = ""; |
||||||
|
auto writer = stub->RequestStream(&ctx, &resp); |
||||||
|
for (int i = 0; i < 10; i++) { |
||||||
|
writer->Write(req); |
||||||
|
expected_resp += "Hello"; |
||||||
|
} |
||||||
|
writer->WritesDone(); |
||||||
|
Status s = writer->Finish(); |
||||||
|
EXPECT_EQ(s.ok(), true); |
||||||
|
EXPECT_EQ(resp.message(), expected_resp); |
||||||
|
} |
||||||
|
|
||||||
|
void MakeServerStreamingCall(const std::shared_ptr<Channel>& channel) { |
||||||
|
auto stub = grpc::testing::EchoTestService::NewStub(channel); |
||||||
|
ClientContext ctx; |
||||||
|
EchoRequest req; |
||||||
|
req.mutable_param()->set_echo_metadata(true); |
||||||
|
ctx.AddMetadata("testkey", "testvalue"); |
||||||
|
req.set_message("Hello"); |
||||||
|
EchoResponse resp; |
||||||
|
string expected_resp = ""; |
||||||
|
auto reader = stub->ResponseStream(&ctx, req); |
||||||
|
int count = 0; |
||||||
|
while (reader->Read(&resp)) { |
||||||
|
EXPECT_EQ(resp.message(), "Hello"); |
||||||
|
count++; |
||||||
|
} |
||||||
|
ASSERT_EQ(count, 10); |
||||||
|
Status s = reader->Finish(); |
||||||
|
EXPECT_EQ(s.ok(), true); |
||||||
|
} |
||||||
|
|
||||||
|
void MakeBidiStreamingCall(const std::shared_ptr<Channel>& channel) { |
||||||
|
auto stub = grpc::testing::EchoTestService::NewStub(channel); |
||||||
|
ClientContext ctx; |
||||||
|
EchoRequest req; |
||||||
|
EchoResponse resp; |
||||||
|
ctx.AddMetadata("testkey", "testvalue"); |
||||||
|
auto stream = stub->BidiStream(&ctx); |
||||||
|
for (auto i = 0; i < 10; i++) { |
||||||
|
req.set_message("Hello" + std::to_string(i)); |
||||||
|
stream->Write(req); |
||||||
|
stream->Read(&resp); |
||||||
|
EXPECT_EQ(req.message(), resp.message()); |
||||||
|
} |
||||||
|
ASSERT_TRUE(stream->WritesDone()); |
||||||
|
Status s = stream->Finish(); |
||||||
|
EXPECT_EQ(s.ok(), true); |
||||||
|
} |
||||||
|
|
||||||
|
void MakeCallbackCall(const std::shared_ptr<Channel>& channel) { |
||||||
|
auto stub = grpc::testing::EchoTestService::NewStub(channel); |
||||||
|
ClientContext ctx; |
||||||
|
EchoRequest req; |
||||||
|
std::mutex mu; |
||||||
|
std::condition_variable cv; |
||||||
|
bool done = false; |
||||||
|
req.mutable_param()->set_echo_metadata(true); |
||||||
|
ctx.AddMetadata("testkey", "testvalue"); |
||||||
|
req.set_message("Hello"); |
||||||
|
EchoResponse resp; |
||||||
|
stub->experimental_async()->Echo(&ctx, &req, &resp, |
||||||
|
[&resp, &mu, &done, &cv](Status s) { |
||||||
|
// gpr_log(GPR_ERROR, "got the callback");
|
||||||
|
EXPECT_EQ(s.ok(), true); |
||||||
|
EXPECT_EQ(resp.message(), "Hello"); |
||||||
|
std::lock_guard<std::mutex> l(mu); |
||||||
|
done = true; |
||||||
|
cv.notify_one(); |
||||||
|
}); |
||||||
|
std::unique_lock<std::mutex> l(mu); |
||||||
|
while (!done) { |
||||||
|
cv.wait(l); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
bool CheckMetadata(const std::multimap<grpc::string_ref, grpc::string_ref>& map, |
||||||
|
const string& key, const string& value) { |
||||||
|
for (const auto& pair : map) { |
||||||
|
if (pair.first.starts_with(key) && pair.second.starts_with(value)) { |
||||||
|
return true; |
||||||
|
} |
||||||
|
} |
||||||
|
return false; |
||||||
|
} |
||||||
|
|
||||||
|
void* tag(int i) { return (void*)static_cast<intptr_t>(i); } |
||||||
|
int detag(void* p) { return static_cast<int>(reinterpret_cast<intptr_t>(p)); } |
||||||
|
|
||||||
|
class Verifier { |
||||||
|
public: |
||||||
|
Verifier() : lambda_run_(false) {} |
||||||
|
// Expect sets the expected ok value for a specific tag
|
||||||
|
Verifier& Expect(int i, bool expect_ok) { |
||||||
|
return ExpectUnless(i, expect_ok, false); |
||||||
|
} |
||||||
|
// ExpectUnless sets the expected ok value for a specific tag
|
||||||
|
// unless the tag was already marked seen (as a result of ExpectMaybe)
|
||||||
|
Verifier& ExpectUnless(int i, bool expect_ok, bool seen) { |
||||||
|
if (!seen) { |
||||||
|
expectations_[tag(i)] = expect_ok; |
||||||
|
} |
||||||
|
return *this; |
||||||
|
} |
||||||
|
// ExpectMaybe sets the expected ok value for a specific tag, but does not
|
||||||
|
// require it to appear
|
||||||
|
// If it does, sets *seen to true
|
||||||
|
Verifier& ExpectMaybe(int i, bool expect_ok, bool* seen) { |
||||||
|
if (!*seen) { |
||||||
|
maybe_expectations_[tag(i)] = MaybeExpect{expect_ok, seen}; |
||||||
|
} |
||||||
|
return *this; |
||||||
|
} |
||||||
|
|
||||||
|
// Next waits for 1 async tag to complete, checks its
|
||||||
|
// expectations, and returns the tag
|
||||||
|
int Next(CompletionQueue* cq, bool ignore_ok) { |
||||||
|
bool ok; |
||||||
|
void* got_tag; |
||||||
|
EXPECT_TRUE(cq->Next(&got_tag, &ok)); |
||||||
|
GotTag(got_tag, ok, ignore_ok); |
||||||
|
return detag(got_tag); |
||||||
|
} |
||||||
|
|
||||||
|
template <typename T> |
||||||
|
CompletionQueue::NextStatus DoOnceThenAsyncNext( |
||||||
|
CompletionQueue* cq, void** got_tag, bool* ok, T deadline, |
||||||
|
std::function<void(void)> lambda) { |
||||||
|
if (lambda_run_) { |
||||||
|
return cq->AsyncNext(got_tag, ok, deadline); |
||||||
|
} else { |
||||||
|
lambda_run_ = true; |
||||||
|
return cq->DoThenAsyncNext(lambda, got_tag, ok, deadline); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
// Verify keeps calling Next until all currently set
|
||||||
|
// expected tags are complete
|
||||||
|
void Verify(CompletionQueue* cq) { Verify(cq, false); } |
||||||
|
|
||||||
|
// This version of Verify allows optionally ignoring the
|
||||||
|
// outcome of the expectation
|
||||||
|
void Verify(CompletionQueue* cq, bool ignore_ok) { |
||||||
|
GPR_ASSERT(!expectations_.empty() || !maybe_expectations_.empty()); |
||||||
|
while (!expectations_.empty()) { |
||||||
|
Next(cq, ignore_ok); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
// This version of Verify stops after a certain deadline, and uses the
|
||||||
|
// DoThenAsyncNext API
|
||||||
|
// to call the lambda
|
||||||
|
void Verify(CompletionQueue* cq, |
||||||
|
std::chrono::system_clock::time_point deadline, |
||||||
|
const std::function<void(void)>& lambda) { |
||||||
|
if (expectations_.empty()) { |
||||||
|
bool ok; |
||||||
|
void* got_tag; |
||||||
|
EXPECT_EQ(DoOnceThenAsyncNext(cq, &got_tag, &ok, deadline, lambda), |
||||||
|
CompletionQueue::TIMEOUT); |
||||||
|
} else { |
||||||
|
while (!expectations_.empty()) { |
||||||
|
bool ok; |
||||||
|
void* got_tag; |
||||||
|
EXPECT_EQ(DoOnceThenAsyncNext(cq, &got_tag, &ok, deadline, lambda), |
||||||
|
CompletionQueue::GOT_EVENT); |
||||||
|
GotTag(got_tag, ok, false); |
||||||
|
} |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
private: |
||||||
|
void GotTag(void* got_tag, bool ok, bool ignore_ok) { |
||||||
|
auto it = expectations_.find(got_tag); |
||||||
|
if (it != expectations_.end()) { |
||||||
|
if (!ignore_ok) { |
||||||
|
EXPECT_EQ(it->second, ok); |
||||||
|
} |
||||||
|
expectations_.erase(it); |
||||||
|
} else { |
||||||
|
auto it2 = maybe_expectations_.find(got_tag); |
||||||
|
if (it2 != maybe_expectations_.end()) { |
||||||
|
if (it2->second.seen != nullptr) { |
||||||
|
EXPECT_FALSE(*it2->second.seen); |
||||||
|
*it2->second.seen = true; |
||||||
|
} |
||||||
|
if (!ignore_ok) { |
||||||
|
EXPECT_EQ(it2->second.ok, ok); |
||||||
|
} |
||||||
|
} else { |
||||||
|
gpr_log(GPR_ERROR, "Unexpected tag: %p", got_tag); |
||||||
|
abort(); |
||||||
|
} |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
struct MaybeExpect { |
||||||
|
bool ok; |
||||||
|
bool* seen; |
||||||
|
}; |
||||||
|
|
||||||
|
std::map<void*, bool> expectations_; |
||||||
|
std::map<void*, MaybeExpect> maybe_expectations_; |
||||||
|
bool lambda_run_; |
||||||
|
}; |
||||||
|
|
||||||
|
} // namespace testing
|
||||||
|
} // namespace grpc
|
||||||
@ -0,0 +1,623 @@ |
|||||||
|
/*
|
||||||
|
* |
||||||
|
* Copyright 2018 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 <memory> |
||||||
|
#include <vector> |
||||||
|
|
||||||
|
#include <grpcpp/channel.h> |
||||||
|
#include <grpcpp/client_context.h> |
||||||
|
#include <grpcpp/create_channel.h> |
||||||
|
#include <grpcpp/generic/generic_stub.h> |
||||||
|
#include <grpcpp/impl/codegen/proto_utils.h> |
||||||
|
#include <grpcpp/impl/codegen/server_interceptor.h> |
||||||
|
#include <grpcpp/server.h> |
||||||
|
#include <grpcpp/server_builder.h> |
||||||
|
#include <grpcpp/server_context.h> |
||||||
|
|
||||||
|
#include "src/proto/grpc/testing/echo.grpc.pb.h" |
||||||
|
#include "test/core/util/port.h" |
||||||
|
#include "test/core/util/test_config.h" |
||||||
|
#include "test/cpp/end2end/interceptors_util.h" |
||||||
|
#include "test/cpp/end2end/test_service_impl.h" |
||||||
|
#include "test/cpp/util/byte_buffer_proto_helper.h" |
||||||
|
|
||||||
|
#include <gtest/gtest.h> |
||||||
|
|
||||||
|
namespace grpc { |
||||||
|
namespace testing { |
||||||
|
namespace { |
||||||
|
|
||||||
|
/* This interceptor does nothing. Just keeps a global count on the number of
|
||||||
|
* times it was invoked. */ |
||||||
|
class DummyInterceptor : public experimental::Interceptor { |
||||||
|
public: |
||||||
|
DummyInterceptor(experimental::ServerRpcInfo* info) {} |
||||||
|
|
||||||
|
virtual void Intercept(experimental::InterceptorBatchMethods* methods) { |
||||||
|
if (methods->QueryInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints::PRE_SEND_INITIAL_METADATA)) { |
||||||
|
num_times_run_++; |
||||||
|
} else if (methods->QueryInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints:: |
||||||
|
POST_RECV_INITIAL_METADATA)) { |
||||||
|
num_times_run_reverse_++; |
||||||
|
} |
||||||
|
methods->Proceed(); |
||||||
|
} |
||||||
|
|
||||||
|
static void Reset() { |
||||||
|
num_times_run_.store(0); |
||||||
|
num_times_run_reverse_.store(0); |
||||||
|
} |
||||||
|
|
||||||
|
static int GetNumTimesRun() { |
||||||
|
EXPECT_EQ(num_times_run_.load(), num_times_run_reverse_.load()); |
||||||
|
return num_times_run_.load(); |
||||||
|
} |
||||||
|
|
||||||
|
private: |
||||||
|
static std::atomic<int> num_times_run_; |
||||||
|
static std::atomic<int> num_times_run_reverse_; |
||||||
|
}; |
||||||
|
|
||||||
|
std::atomic<int> DummyInterceptor::num_times_run_; |
||||||
|
std::atomic<int> DummyInterceptor::num_times_run_reverse_; |
||||||
|
|
||||||
|
class DummyInterceptorFactory |
||||||
|
: public experimental::ServerInterceptorFactoryInterface { |
||||||
|
public: |
||||||
|
virtual experimental::Interceptor* CreateServerInterceptor( |
||||||
|
experimental::ServerRpcInfo* info) override { |
||||||
|
return new DummyInterceptor(info); |
||||||
|
} |
||||||
|
}; |
||||||
|
|
||||||
|
class LoggingInterceptor : public experimental::Interceptor { |
||||||
|
public: |
||||||
|
LoggingInterceptor(experimental::ServerRpcInfo* info) { info_ = info; } |
||||||
|
|
||||||
|
virtual void Intercept(experimental::InterceptorBatchMethods* methods) { |
||||||
|
if (methods->QueryInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints::PRE_SEND_INITIAL_METADATA)) { |
||||||
|
auto* map = methods->GetSendInitialMetadata(); |
||||||
|
// Got nothing better to do here for now
|
||||||
|
EXPECT_EQ(map->size(), static_cast<unsigned>(0)); |
||||||
|
} |
||||||
|
if (methods->QueryInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints::PRE_SEND_MESSAGE)) { |
||||||
|
EchoRequest req; |
||||||
|
auto* buffer = methods->GetSendMessage(); |
||||||
|
auto copied_buffer = *buffer; |
||||||
|
SerializationTraits<EchoRequest>::Deserialize(&copied_buffer, &req); |
||||||
|
EXPECT_TRUE(req.message().find("Hello") == 0); |
||||||
|
} |
||||||
|
if (methods->QueryInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints::PRE_SEND_STATUS)) { |
||||||
|
auto* map = methods->GetSendTrailingMetadata(); |
||||||
|
bool found = false; |
||||||
|
// Check that we received the metadata as an echo
|
||||||
|
for (const auto& pair : *map) { |
||||||
|
found = pair.first.find("testkey") == 0 && |
||||||
|
pair.second.find("testvalue") == 0; |
||||||
|
if (found) break; |
||||||
|
} |
||||||
|
EXPECT_EQ(found, true); |
||||||
|
auto status = methods->GetSendStatus(); |
||||||
|
EXPECT_EQ(status.ok(), true); |
||||||
|
} |
||||||
|
if (methods->QueryInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints::POST_RECV_INITIAL_METADATA)) { |
||||||
|
auto* map = methods->GetRecvInitialMetadata(); |
||||||
|
bool found = false; |
||||||
|
// Check that we received the metadata as an echo
|
||||||
|
for (const auto& pair : *map) { |
||||||
|
found = pair.first.find("testkey") == 0 && |
||||||
|
pair.second.find("testvalue") == 0; |
||||||
|
if (found) break; |
||||||
|
} |
||||||
|
EXPECT_EQ(found, true); |
||||||
|
} |
||||||
|
if (methods->QueryInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints::POST_RECV_MESSAGE)) { |
||||||
|
EchoResponse* resp = |
||||||
|
static_cast<EchoResponse*>(methods->GetRecvMessage()); |
||||||
|
EXPECT_TRUE(resp->message().find("Hello") == 0); |
||||||
|
} |
||||||
|
if (methods->QueryInterceptionHookPoint( |
||||||
|
experimental::InterceptionHookPoints::POST_RECV_CLOSE)) { |
||||||
|
// Got nothing interesting to do here
|
||||||
|
} |
||||||
|
methods->Proceed(); |
||||||
|
} |
||||||
|
|
||||||
|
private: |
||||||
|
experimental::ServerRpcInfo* info_; |
||||||
|
}; |
||||||
|
|
||||||
|
class LoggingInterceptorFactory |
||||||
|
: public experimental::ServerInterceptorFactoryInterface { |
||||||
|
public: |
||||||
|
virtual experimental::Interceptor* CreateServerInterceptor( |
||||||
|
experimental::ServerRpcInfo* info) override { |
||||||
|
return new LoggingInterceptor(info); |
||||||
|
} |
||||||
|
}; |
||||||
|
|
||||||
|
void MakeBidiStreamingCall(const std::shared_ptr<Channel>& channel) { |
||||||
|
auto stub = grpc::testing::EchoTestService::NewStub(channel); |
||||||
|
ClientContext ctx; |
||||||
|
EchoRequest req; |
||||||
|
EchoResponse resp; |
||||||
|
ctx.AddMetadata("testkey", "testvalue"); |
||||||
|
auto stream = stub->BidiStream(&ctx); |
||||||
|
for (auto i = 0; i < 10; i++) { |
||||||
|
req.set_message("Hello" + std::to_string(i)); |
||||||
|
stream->Write(req); |
||||||
|
stream->Read(&resp); |
||||||
|
EXPECT_EQ(req.message(), resp.message()); |
||||||
|
} |
||||||
|
ASSERT_TRUE(stream->WritesDone()); |
||||||
|
Status s = stream->Finish(); |
||||||
|
EXPECT_EQ(s.ok(), true); |
||||||
|
} |
||||||
|
|
||||||
|
class ServerInterceptorsEnd2endSyncUnaryTest : public ::testing::Test { |
||||||
|
protected: |
||||||
|
ServerInterceptorsEnd2endSyncUnaryTest() { |
||||||
|
int port = grpc_pick_unused_port_or_die(); |
||||||
|
|
||||||
|
ServerBuilder builder; |
||||||
|
server_address_ = "localhost:" + std::to_string(port); |
||||||
|
builder.AddListeningPort(server_address_, InsecureServerCredentials()); |
||||||
|
builder.RegisterService(&service_); |
||||||
|
|
||||||
|
std::vector< |
||||||
|
std::unique_ptr<experimental::ServerInterceptorFactoryInterface>> |
||||||
|
creators; |
||||||
|
creators.push_back( |
||||||
|
std::unique_ptr<experimental::ServerInterceptorFactoryInterface>( |
||||||
|
new LoggingInterceptorFactory())); |
||||||
|
for (auto i = 0; i < 20; i++) { |
||||||
|
creators.push_back(std::unique_ptr<DummyInterceptorFactory>( |
||||||
|
new DummyInterceptorFactory())); |
||||||
|
} |
||||||
|
builder.experimental().SetInterceptorCreators(std::move(creators)); |
||||||
|
server_ = builder.BuildAndStart(); |
||||||
|
} |
||||||
|
std::string server_address_; |
||||||
|
TestServiceImpl service_; |
||||||
|
std::unique_ptr<Server> server_; |
||||||
|
}; |
||||||
|
|
||||||
|
TEST_F(ServerInterceptorsEnd2endSyncUnaryTest, UnaryTest) { |
||||||
|
ChannelArguments args; |
||||||
|
DummyInterceptor::Reset(); |
||||||
|
auto channel = CreateChannel(server_address_, InsecureChannelCredentials()); |
||||||
|
MakeCall(channel); |
||||||
|
// Make sure all 20 dummy interceptors were run
|
||||||
|
EXPECT_EQ(DummyInterceptor::GetNumTimesRun(), 20); |
||||||
|
} |
||||||
|
|
||||||
|
class ServerInterceptorsEnd2endSyncStreamingTest : public ::testing::Test { |
||||||
|
protected: |
||||||
|
ServerInterceptorsEnd2endSyncStreamingTest() { |
||||||
|
int port = grpc_pick_unused_port_or_die(); |
||||||
|
|
||||||
|
ServerBuilder builder; |
||||||
|
server_address_ = "localhost:" + std::to_string(port); |
||||||
|
builder.AddListeningPort(server_address_, InsecureServerCredentials()); |
||||||
|
builder.RegisterService(&service_); |
||||||
|
|
||||||
|
std::vector< |
||||||
|
std::unique_ptr<experimental::ServerInterceptorFactoryInterface>> |
||||||
|
creators; |
||||||
|
creators.push_back( |
||||||
|
std::unique_ptr<experimental::ServerInterceptorFactoryInterface>( |
||||||
|
new LoggingInterceptorFactory())); |
||||||
|
for (auto i = 0; i < 20; i++) { |
||||||
|
creators.push_back(std::unique_ptr<DummyInterceptorFactory>( |
||||||
|
new DummyInterceptorFactory())); |
||||||
|
} |
||||||
|
builder.experimental().SetInterceptorCreators(std::move(creators)); |
||||||
|
server_ = builder.BuildAndStart(); |
||||||
|
} |
||||||
|
std::string server_address_; |
||||||
|
EchoTestServiceStreamingImpl service_; |
||||||
|
std::unique_ptr<Server> server_; |
||||||
|
}; |
||||||
|
|
||||||
|
TEST_F(ServerInterceptorsEnd2endSyncStreamingTest, ClientStreamingTest) { |
||||||
|
ChannelArguments args; |
||||||
|
DummyInterceptor::Reset(); |
||||||
|
auto channel = CreateChannel(server_address_, InsecureChannelCredentials()); |
||||||
|
MakeClientStreamingCall(channel); |
||||||
|
// Make sure all 20 dummy interceptors were run
|
||||||
|
EXPECT_EQ(DummyInterceptor::GetNumTimesRun(), 20); |
||||||
|
} |
||||||
|
|
||||||
|
TEST_F(ServerInterceptorsEnd2endSyncStreamingTest, ServerStreamingTest) { |
||||||
|
ChannelArguments args; |
||||||
|
DummyInterceptor::Reset(); |
||||||
|
auto channel = CreateChannel(server_address_, InsecureChannelCredentials()); |
||||||
|
MakeServerStreamingCall(channel); |
||||||
|
// Make sure all 20 dummy interceptors were run
|
||||||
|
EXPECT_EQ(DummyInterceptor::GetNumTimesRun(), 20); |
||||||
|
} |
||||||
|
|
||||||
|
TEST_F(ServerInterceptorsEnd2endSyncStreamingTest, BidiStreamingTest) { |
||||||
|
ChannelArguments args; |
||||||
|
DummyInterceptor::Reset(); |
||||||
|
auto channel = CreateChannel(server_address_, InsecureChannelCredentials()); |
||||||
|
MakeBidiStreamingCall(channel); |
||||||
|
// Make sure all 20 dummy interceptors were run
|
||||||
|
EXPECT_EQ(DummyInterceptor::GetNumTimesRun(), 20); |
||||||
|
} |
||||||
|
|
||||||
|
class ServerInterceptorsAsyncEnd2endTest : public ::testing::Test {}; |
||||||
|
|
||||||
|
TEST_F(ServerInterceptorsAsyncEnd2endTest, UnaryTest) { |
||||||
|
DummyInterceptor::Reset(); |
||||||
|
int port = grpc_pick_unused_port_or_die(); |
||||||
|
string server_address = "localhost:" + std::to_string(port); |
||||||
|
ServerBuilder builder; |
||||||
|
EchoTestService::AsyncService service; |
||||||
|
builder.AddListeningPort(server_address, InsecureServerCredentials()); |
||||||
|
builder.RegisterService(&service); |
||||||
|
std::vector<std::unique_ptr<experimental::ServerInterceptorFactoryInterface>> |
||||||
|
creators; |
||||||
|
creators.push_back( |
||||||
|
std::unique_ptr<experimental::ServerInterceptorFactoryInterface>( |
||||||
|
new LoggingInterceptorFactory())); |
||||||
|
for (auto i = 0; i < 20; i++) { |
||||||
|
creators.push_back(std::unique_ptr<DummyInterceptorFactory>( |
||||||
|
new DummyInterceptorFactory())); |
||||||
|
} |
||||||
|
builder.experimental().SetInterceptorCreators(std::move(creators)); |
||||||
|
auto cq = builder.AddCompletionQueue(); |
||||||
|
auto server = builder.BuildAndStart(); |
||||||
|
|
||||||
|
ChannelArguments args; |
||||||
|
auto channel = CreateChannel(server_address, InsecureChannelCredentials()); |
||||||
|
auto stub = grpc::testing::EchoTestService::NewStub(channel); |
||||||
|
|
||||||
|
EchoRequest send_request; |
||||||
|
EchoRequest recv_request; |
||||||
|
EchoResponse send_response; |
||||||
|
EchoResponse recv_response; |
||||||
|
Status recv_status; |
||||||
|
|
||||||
|
ClientContext cli_ctx; |
||||||
|
ServerContext srv_ctx; |
||||||
|
grpc::ServerAsyncResponseWriter<EchoResponse> response_writer(&srv_ctx); |
||||||
|
|
||||||
|
send_request.set_message("Hello"); |
||||||
|
cli_ctx.AddMetadata("testkey", "testvalue"); |
||||||
|
std::unique_ptr<ClientAsyncResponseReader<EchoResponse>> response_reader( |
||||||
|
stub->AsyncEcho(&cli_ctx, send_request, cq.get())); |
||||||
|
|
||||||
|
service.RequestEcho(&srv_ctx, &recv_request, &response_writer, cq.get(), |
||||||
|
cq.get(), tag(2)); |
||||||
|
|
||||||
|
response_reader->Finish(&recv_response, &recv_status, tag(4)); |
||||||
|
|
||||||
|
Verifier().Expect(2, true).Verify(cq.get()); |
||||||
|
EXPECT_EQ(send_request.message(), recv_request.message()); |
||||||
|
|
||||||
|
EXPECT_TRUE(CheckMetadata(srv_ctx.client_metadata(), "testkey", "testvalue")); |
||||||
|
srv_ctx.AddTrailingMetadata("testkey", "testvalue"); |
||||||
|
|
||||||
|
send_response.set_message(recv_request.message()); |
||||||
|
response_writer.Finish(send_response, Status::OK, tag(3)); |
||||||
|
Verifier().Expect(3, true).Expect(4, true).Verify(cq.get()); |
||||||
|
|
||||||
|
EXPECT_EQ(send_response.message(), recv_response.message()); |
||||||
|
EXPECT_TRUE(recv_status.ok()); |
||||||
|
EXPECT_TRUE(CheckMetadata(cli_ctx.GetServerTrailingMetadata(), "testkey", |
||||||
|
"testvalue")); |
||||||
|
|
||||||
|
// Make sure all 20 dummy interceptors were run
|
||||||
|
EXPECT_EQ(DummyInterceptor::GetNumTimesRun(), 20); |
||||||
|
|
||||||
|
server->Shutdown(); |
||||||
|
cq->Shutdown(); |
||||||
|
void* ignored_tag; |
||||||
|
bool ignored_ok; |
||||||
|
while (cq->Next(&ignored_tag, &ignored_ok)) |
||||||
|
; |
||||||
|
grpc_recycle_unused_port(port); |
||||||
|
} |
||||||
|
|
||||||
|
TEST_F(ServerInterceptorsAsyncEnd2endTest, BidiStreamingTest) { |
||||||
|
DummyInterceptor::Reset(); |
||||||
|
int port = grpc_pick_unused_port_or_die(); |
||||||
|
string server_address = "localhost:" + std::to_string(port); |
||||||
|
ServerBuilder builder; |
||||||
|
EchoTestService::AsyncService service; |
||||||
|
builder.AddListeningPort(server_address, InsecureServerCredentials()); |
||||||
|
builder.RegisterService(&service); |
||||||
|
std::vector<std::unique_ptr<experimental::ServerInterceptorFactoryInterface>> |
||||||
|
creators; |
||||||
|
creators.push_back( |
||||||
|
std::unique_ptr<experimental::ServerInterceptorFactoryInterface>( |
||||||
|
new LoggingInterceptorFactory())); |
||||||
|
for (auto i = 0; i < 20; i++) { |
||||||
|
creators.push_back(std::unique_ptr<DummyInterceptorFactory>( |
||||||
|
new DummyInterceptorFactory())); |
||||||
|
} |
||||||
|
builder.experimental().SetInterceptorCreators(std::move(creators)); |
||||||
|
auto cq = builder.AddCompletionQueue(); |
||||||
|
auto server = builder.BuildAndStart(); |
||||||
|
|
||||||
|
ChannelArguments args; |
||||||
|
auto channel = CreateChannel(server_address, InsecureChannelCredentials()); |
||||||
|
auto stub = grpc::testing::EchoTestService::NewStub(channel); |
||||||
|
|
||||||
|
EchoRequest send_request; |
||||||
|
EchoRequest recv_request; |
||||||
|
EchoResponse send_response; |
||||||
|
EchoResponse recv_response; |
||||||
|
Status recv_status; |
||||||
|
|
||||||
|
ClientContext cli_ctx; |
||||||
|
ServerContext srv_ctx; |
||||||
|
grpc::ServerAsyncReaderWriter<EchoResponse, EchoRequest> srv_stream(&srv_ctx); |
||||||
|
|
||||||
|
send_request.set_message("Hello"); |
||||||
|
cli_ctx.AddMetadata("testkey", "testvalue"); |
||||||
|
std::unique_ptr<ClientAsyncReaderWriter<EchoRequest, EchoResponse>> |
||||||
|
cli_stream(stub->AsyncBidiStream(&cli_ctx, cq.get(), tag(1))); |
||||||
|
|
||||||
|
service.RequestBidiStream(&srv_ctx, &srv_stream, cq.get(), cq.get(), tag(2)); |
||||||
|
|
||||||
|
Verifier().Expect(1, true).Expect(2, true).Verify(cq.get()); |
||||||
|
|
||||||
|
EXPECT_TRUE(CheckMetadata(srv_ctx.client_metadata(), "testkey", "testvalue")); |
||||||
|
srv_ctx.AddTrailingMetadata("testkey", "testvalue"); |
||||||
|
|
||||||
|
cli_stream->Write(send_request, tag(3)); |
||||||
|
srv_stream.Read(&recv_request, tag(4)); |
||||||
|
Verifier().Expect(3, true).Expect(4, true).Verify(cq.get()); |
||||||
|
EXPECT_EQ(send_request.message(), recv_request.message()); |
||||||
|
|
||||||
|
send_response.set_message(recv_request.message()); |
||||||
|
srv_stream.Write(send_response, tag(5)); |
||||||
|
cli_stream->Read(&recv_response, tag(6)); |
||||||
|
Verifier().Expect(5, true).Expect(6, true).Verify(cq.get()); |
||||||
|
EXPECT_EQ(send_response.message(), recv_response.message()); |
||||||
|
|
||||||
|
cli_stream->WritesDone(tag(7)); |
||||||
|
srv_stream.Read(&recv_request, tag(8)); |
||||||
|
Verifier().Expect(7, true).Expect(8, false).Verify(cq.get()); |
||||||
|
|
||||||
|
srv_stream.Finish(Status::OK, tag(9)); |
||||||
|
cli_stream->Finish(&recv_status, tag(10)); |
||||||
|
Verifier().Expect(9, true).Expect(10, true).Verify(cq.get()); |
||||||
|
|
||||||
|
EXPECT_TRUE(recv_status.ok()); |
||||||
|
EXPECT_TRUE(CheckMetadata(cli_ctx.GetServerTrailingMetadata(), "testkey", |
||||||
|
"testvalue")); |
||||||
|
|
||||||
|
// Make sure all 20 dummy interceptors were run
|
||||||
|
EXPECT_EQ(DummyInterceptor::GetNumTimesRun(), 20); |
||||||
|
|
||||||
|
server->Shutdown(); |
||||||
|
cq->Shutdown(); |
||||||
|
void* ignored_tag; |
||||||
|
bool ignored_ok; |
||||||
|
while (cq->Next(&ignored_tag, &ignored_ok)) |
||||||
|
; |
||||||
|
grpc_recycle_unused_port(port); |
||||||
|
} |
||||||
|
|
||||||
|
TEST_F(ServerInterceptorsAsyncEnd2endTest, GenericRPCTest) { |
||||||
|
DummyInterceptor::Reset(); |
||||||
|
int port = grpc_pick_unused_port_or_die(); |
||||||
|
string server_address = "localhost:" + std::to_string(port); |
||||||
|
ServerBuilder builder; |
||||||
|
AsyncGenericService service; |
||||||
|
builder.AddListeningPort(server_address, InsecureServerCredentials()); |
||||||
|
builder.RegisterAsyncGenericService(&service); |
||||||
|
std::vector<std::unique_ptr<experimental::ServerInterceptorFactoryInterface>> |
||||||
|
creators; |
||||||
|
for (auto i = 0; i < 20; i++) { |
||||||
|
creators.push_back(std::unique_ptr<DummyInterceptorFactory>( |
||||||
|
new DummyInterceptorFactory())); |
||||||
|
} |
||||||
|
builder.experimental().SetInterceptorCreators(std::move(creators)); |
||||||
|
auto cq = builder.AddCompletionQueue(); |
||||||
|
auto server = builder.BuildAndStart(); |
||||||
|
|
||||||
|
ChannelArguments args; |
||||||
|
auto channel = CreateChannel(server_address, InsecureChannelCredentials()); |
||||||
|
GenericStub generic_stub(channel); |
||||||
|
|
||||||
|
const grpc::string kMethodName("/grpc.cpp.test.util.EchoTestService/Echo"); |
||||||
|
EchoRequest send_request; |
||||||
|
EchoRequest recv_request; |
||||||
|
EchoResponse send_response; |
||||||
|
EchoResponse recv_response; |
||||||
|
Status recv_status; |
||||||
|
|
||||||
|
ClientContext cli_ctx; |
||||||
|
GenericServerContext srv_ctx; |
||||||
|
GenericServerAsyncReaderWriter stream(&srv_ctx); |
||||||
|
|
||||||
|
// The string needs to be long enough to test heap-based slice.
|
||||||
|
send_request.set_message("Hello"); |
||||||
|
cli_ctx.AddMetadata("testkey", "testvalue"); |
||||||
|
|
||||||
|
std::unique_ptr<GenericClientAsyncReaderWriter> call = |
||||||
|
generic_stub.PrepareCall(&cli_ctx, kMethodName, cq.get()); |
||||||
|
call->StartCall(tag(1)); |
||||||
|
Verifier().Expect(1, true).Verify(cq.get()); |
||||||
|
std::unique_ptr<ByteBuffer> send_buffer = |
||||||
|
SerializeToByteBuffer(&send_request); |
||||||
|
call->Write(*send_buffer, tag(2)); |
||||||
|
// Send ByteBuffer can be destroyed after calling Write.
|
||||||
|
send_buffer.reset(); |
||||||
|
Verifier().Expect(2, true).Verify(cq.get()); |
||||||
|
call->WritesDone(tag(3)); |
||||||
|
Verifier().Expect(3, true).Verify(cq.get()); |
||||||
|
|
||||||
|
service.RequestCall(&srv_ctx, &stream, cq.get(), cq.get(), tag(4)); |
||||||
|
|
||||||
|
Verifier().Expect(4, true).Verify(cq.get()); |
||||||
|
EXPECT_EQ(kMethodName, srv_ctx.method()); |
||||||
|
EXPECT_TRUE(CheckMetadata(srv_ctx.client_metadata(), "testkey", "testvalue")); |
||||||
|
srv_ctx.AddTrailingMetadata("testkey", "testvalue"); |
||||||
|
|
||||||
|
ByteBuffer recv_buffer; |
||||||
|
stream.Read(&recv_buffer, tag(5)); |
||||||
|
Verifier().Expect(5, true).Verify(cq.get()); |
||||||
|
EXPECT_TRUE(ParseFromByteBuffer(&recv_buffer, &recv_request)); |
||||||
|
EXPECT_EQ(send_request.message(), recv_request.message()); |
||||||
|
|
||||||
|
send_response.set_message(recv_request.message()); |
||||||
|
send_buffer = SerializeToByteBuffer(&send_response); |
||||||
|
stream.Write(*send_buffer, tag(6)); |
||||||
|
send_buffer.reset(); |
||||||
|
Verifier().Expect(6, true).Verify(cq.get()); |
||||||
|
|
||||||
|
stream.Finish(Status::OK, tag(7)); |
||||||
|
Verifier().Expect(7, true).Verify(cq.get()); |
||||||
|
|
||||||
|
recv_buffer.Clear(); |
||||||
|
call->Read(&recv_buffer, tag(8)); |
||||||
|
Verifier().Expect(8, true).Verify(cq.get()); |
||||||
|
EXPECT_TRUE(ParseFromByteBuffer(&recv_buffer, &recv_response)); |
||||||
|
|
||||||
|
call->Finish(&recv_status, tag(9)); |
||||||
|
Verifier().Expect(9, true).Verify(cq.get()); |
||||||
|
|
||||||
|
EXPECT_EQ(send_response.message(), recv_response.message()); |
||||||
|
EXPECT_TRUE(recv_status.ok()); |
||||||
|
EXPECT_TRUE(CheckMetadata(cli_ctx.GetServerTrailingMetadata(), "testkey", |
||||||
|
"testvalue")); |
||||||
|
|
||||||
|
// Make sure all 20 dummy interceptors were run
|
||||||
|
EXPECT_EQ(DummyInterceptor::GetNumTimesRun(), 20); |
||||||
|
|
||||||
|
server->Shutdown(); |
||||||
|
cq->Shutdown(); |
||||||
|
void* ignored_tag; |
||||||
|
bool ignored_ok; |
||||||
|
while (cq->Next(&ignored_tag, &ignored_ok)) |
||||||
|
; |
||||||
|
grpc_recycle_unused_port(port); |
||||||
|
} |
||||||
|
|
||||||
|
TEST_F(ServerInterceptorsAsyncEnd2endTest, UnimplementedRpcTest) { |
||||||
|
DummyInterceptor::Reset(); |
||||||
|
int port = grpc_pick_unused_port_or_die(); |
||||||
|
string server_address = "localhost:" + std::to_string(port); |
||||||
|
ServerBuilder builder; |
||||||
|
builder.AddListeningPort(server_address, InsecureServerCredentials()); |
||||||
|
std::vector<std::unique_ptr<experimental::ServerInterceptorFactoryInterface>> |
||||||
|
creators; |
||||||
|
for (auto i = 0; i < 20; i++) { |
||||||
|
creators.push_back(std::unique_ptr<DummyInterceptorFactory>( |
||||||
|
new DummyInterceptorFactory())); |
||||||
|
} |
||||||
|
builder.experimental().SetInterceptorCreators(std::move(creators)); |
||||||
|
auto cq = builder.AddCompletionQueue(); |
||||||
|
auto server = builder.BuildAndStart(); |
||||||
|
|
||||||
|
ChannelArguments args; |
||||||
|
std::shared_ptr<Channel> channel = |
||||||
|
CreateChannel(server_address, InsecureChannelCredentials()); |
||||||
|
std::unique_ptr<grpc::testing::UnimplementedEchoService::Stub> stub; |
||||||
|
stub = grpc::testing::UnimplementedEchoService::NewStub(channel); |
||||||
|
EchoRequest send_request; |
||||||
|
EchoResponse recv_response; |
||||||
|
Status recv_status; |
||||||
|
|
||||||
|
ClientContext cli_ctx; |
||||||
|
send_request.set_message("Hello"); |
||||||
|
std::unique_ptr<ClientAsyncResponseReader<EchoResponse>> response_reader( |
||||||
|
stub->AsyncUnimplemented(&cli_ctx, send_request, cq.get())); |
||||||
|
|
||||||
|
response_reader->Finish(&recv_response, &recv_status, tag(4)); |
||||||
|
Verifier().Expect(4, true).Verify(cq.get()); |
||||||
|
|
||||||
|
EXPECT_EQ(StatusCode::UNIMPLEMENTED, recv_status.error_code()); |
||||||
|
EXPECT_EQ("", recv_status.error_message()); |
||||||
|
|
||||||
|
// Make sure all 20 dummy interceptors were run
|
||||||
|
EXPECT_EQ(DummyInterceptor::GetNumTimesRun(), 20); |
||||||
|
|
||||||
|
server->Shutdown(); |
||||||
|
cq->Shutdown(); |
||||||
|
void* ignored_tag; |
||||||
|
bool ignored_ok; |
||||||
|
while (cq->Next(&ignored_tag, &ignored_ok)) |
||||||
|
; |
||||||
|
grpc_recycle_unused_port(port); |
||||||
|
} |
||||||
|
|
||||||
|
class ServerInterceptorsSyncUnimplementedEnd2endTest : public ::testing::Test { |
||||||
|
}; |
||||||
|
|
||||||
|
TEST_F(ServerInterceptorsSyncUnimplementedEnd2endTest, UnimplementedRpcTest) { |
||||||
|
DummyInterceptor::Reset(); |
||||||
|
int port = grpc_pick_unused_port_or_die(); |
||||||
|
string server_address = "localhost:" + std::to_string(port); |
||||||
|
ServerBuilder builder; |
||||||
|
TestServiceImpl service; |
||||||
|
builder.RegisterService(&service); |
||||||
|
builder.AddListeningPort(server_address, InsecureServerCredentials()); |
||||||
|
std::vector<std::unique_ptr<experimental::ServerInterceptorFactoryInterface>> |
||||||
|
creators; |
||||||
|
for (auto i = 0; i < 20; i++) { |
||||||
|
creators.push_back(std::unique_ptr<DummyInterceptorFactory>( |
||||||
|
new DummyInterceptorFactory())); |
||||||
|
} |
||||||
|
builder.experimental().SetInterceptorCreators(std::move(creators)); |
||||||
|
auto server = builder.BuildAndStart(); |
||||||
|
|
||||||
|
ChannelArguments args; |
||||||
|
std::shared_ptr<Channel> channel = |
||||||
|
CreateChannel(server_address, InsecureChannelCredentials()); |
||||||
|
std::unique_ptr<grpc::testing::UnimplementedEchoService::Stub> stub; |
||||||
|
stub = grpc::testing::UnimplementedEchoService::NewStub(channel); |
||||||
|
EchoRequest send_request; |
||||||
|
EchoResponse recv_response; |
||||||
|
|
||||||
|
ClientContext cli_ctx; |
||||||
|
send_request.set_message("Hello"); |
||||||
|
Status recv_status = |
||||||
|
stub->Unimplemented(&cli_ctx, send_request, &recv_response); |
||||||
|
|
||||||
|
EXPECT_EQ(StatusCode::UNIMPLEMENTED, recv_status.error_code()); |
||||||
|
EXPECT_EQ("", recv_status.error_message()); |
||||||
|
|
||||||
|
// Make sure all 20 dummy interceptors were run
|
||||||
|
EXPECT_EQ(DummyInterceptor::GetNumTimesRun(), 20); |
||||||
|
|
||||||
|
server->Shutdown(); |
||||||
|
grpc_recycle_unused_port(port); |
||||||
|
} |
||||||
|
|
||||||
|
} // namespace
|
||||||
|
} // namespace testing
|
||||||
|
} // namespace grpc
|
||||||
|
|
||||||
|
int main(int argc, char** argv) { |
||||||
|
grpc_test_init(argc, argv); |
||||||
|
::testing::InitGoogleTest(&argc, argv); |
||||||
|
return RUN_ALL_TESTS(); |
||||||
|
} |
||||||
Loading…
Reference in new issue