feat grpc: add CallOptions::SetDeadline

commit_hash:fd3d0146e823072fecc84d6d547697d0fc7d6440

Author: kpavlov00

grpc/include/userver/ugrpc/client/call_options.hpp

@@ -11,6 +11,7 @@
 #include <grpcpp/client_context.h>
 #include <grpcpp/support/config.h>
 
+#include <userver/engine/deadline.hpp>
 #include <userver/utils/move_only_function.hpp>
 
 USERVER_NAMESPACE_BEGIN
@@ -39,6 +40,12 @@ class CallOptions {
     std::chrono::milliseconds GetTimeout() const;
     /// @}
 
+    /// @{
+    /// Set and get operation deadline.
+    void SetDeadline(engine::Deadline deadline);
+    engine::Deadline GetDeadline() const;
+    /// @}
+
     /// Add the (\a meta_key, \a meta_value) pair to the metadata associated with a client call.
     void AddMetadata(std::string_view meta_key, std::string_view meta_value);
 
@@ -56,6 +63,7 @@ class CallOptions {
     int attempts_{0};
 
     std::chrono::milliseconds timeout_{std::chrono::milliseconds::max()};
+    engine::Deadline deadline_;
 
     std::vector<std::pair<grpc::string, grpc::string>> metadata_;
 

grpc/include/userver/ugrpc/time_utils.hpp

@@ -8,7 +8,7 @@ USERVER_NAMESPACE_BEGIN
 
 namespace ugrpc {
 
-/// Converts `engine::Deadline::Duration` to `gpr_timespec`.
+/// Converts `engine::Deadline::Duration` to `gpr_timespec` (with `GPR_TIMESPAN` clock_type).
 gpr_timespec DurationToTimespec(const engine::Deadline::Duration& duration) noexcept;
 
 template <typename Rep, typename Period>
@@ -19,7 +19,7 @@ gpr_timespec DurationToTimespec(const std::chrono::duration<Rep, Period>& durati
 /// Converts `gpr_timespec` to `engine::Deadline::Duration`
 engine::Deadline::Duration TimespecToDuration(gpr_timespec t) noexcept;
 
-/// Converts `engine::Deadline` to `gpr_timespec`.
+/// Converts `engine::Deadline` to `gpr_timespec` (with `GPR_CLOCK_MONOTONIC` clock_type).
 gpr_timespec DeadlineToTimespec(const engine::Deadline& deadline) noexcept;
 
 /// Converts `gpr_timespec` to `engine::Deadline`

grpc/src/ugrpc/client/call_options.cpp

@@ -14,6 +14,10 @@ void CallOptions::SetTimeout(std::chrono::milliseconds timeout) { timeout_ = tim
 
 std::chrono::milliseconds CallOptions::GetTimeout() const { return timeout_; }
 
+void CallOptions::SetDeadline(engine::Deadline deadline) { deadline_ = deadline; }
+
+engine::Deadline CallOptions::GetDeadline() const { return deadline_; }
+
 void CallOptions::AddMetadata(std::string_view meta_key, std::string_view meta_value) {
     metadata_.emplace_back(ugrpc::impl::ToGrpcString(meta_key), ugrpc::impl::ToGrpcString(meta_value));
 }

grpc/src/ugrpc/client/impl/call_options_accessor.cpp

@@ -10,9 +10,11 @@ std::unique_ptr<grpc::ClientContext> CallOptionsAccessor::CreateClientContext(co
     auto client_context = call_options.client_context_factory_ ? call_options.client_context_factory_()
                                                                : std::make_unique<grpc::ClientContext>();
 
-    const auto timeout = call_options.GetTimeout();
-    if (std::chrono::milliseconds::max() != timeout) {
-        client_context->set_deadline(ugrpc::DurationToTimespec(timeout));
+    // default timeout_ gives unreachable deadline
+    // engine::Deadline::FromDuration(std::chrono::milliseconds::max()) -> !IsReachable
+    const auto deadline = std::min(call_options.deadline_, engine::Deadline::FromDuration(call_options.timeout_));
+    if (deadline.IsReachable()) {
+        client_context->set_deadline(deadline);
     }
 
     for (const auto& [meta_key, meta_value] : call_options.metadata_) {

grpc/src/ugrpc/client/middlewares/deadline_propagation/middleware.cpp

@@ -51,7 +51,7 @@ void UpdateDeadline(MiddlewareCallContext& context) {
         span.AddTag("deadline_updated", true);
         state.SetDeadlinePropagated();
 
-        client_context.set_deadline(ugrpc::DurationToTimespec(task_time_left));
+        client_context.set_deadline(task_deadline);
 
         AddTimeoutMsToSpan(span, task_time_left);
     } else {

grpc/tests/deadline_test.cpp

@@ -323,11 +323,7 @@ UTEST_F(GrpcTestInheritedDedline, TestServerDataExist) {
     const engine::Deadline deadline = engine::Deadline::FromDuration(tests::kLongTimeout);
 
     GetService().SetClientInitialTimeout(tests::kLongTimeout);
-    call_options.SetClientContextFactory([deadline] {
-        auto client_context = std::make_unique<grpc::ClientContext>();
-        client_context->set_deadline(deadline);
-        return client_context;
-    });
+    call_options.SetDeadline(deadline);
 
     // In tests the gpr_timespec <> steady_clock conversions were giving
     // ~0.5ms precision loss once in 10k runs. Thus the 10ms delay.
@@ -345,11 +341,7 @@ UTEST_F(GrpcTestInheritedDedline, TestDeadlineExpiresBeforeCall) {
 
     ugrpc::client::CallOptions call_options;
     const engine::Deadline deadline = engine::Deadline::FromDuration(tests::kShortTimeout);
-    call_options.SetClientContextFactory([deadline] {
-        auto client_context = std::make_unique<grpc::ClientContext>();
-        client_context->set_deadline(deadline);
-        return client_context;
-    });
+    call_options.SetDeadline(deadline);
 
     // Test that the time between client context
     // construction and client request is measured.