feat redis: add Client::GenericCommand

commit_hash:f314a1bb7763e9836bd75bb6a68628612d702baa

Author: vaninvv

.mapping.json

@@ -3376,6 +3376,7 @@
   "redis/include/userver/storages/redis/request_data_base.hpp":"taxi/uservices/userver/redis/include/userver/storages/redis/request_data_base.hpp",
   "redis/include/userver/storages/redis/request_eval.hpp":"taxi/uservices/userver/redis/include/userver/storages/redis/request_eval.hpp",
   "redis/include/userver/storages/redis/request_evalsha.hpp":"taxi/uservices/userver/redis/include/userver/storages/redis/request_evalsha.hpp",
+  "redis/include/userver/storages/redis/request_generic.hpp":"taxi/uservices/userver/redis/include/userver/storages/redis/request_generic.hpp",
   "redis/include/userver/storages/redis/scan_tag.hpp":"taxi/uservices/userver/redis/include/userver/storages/redis/scan_tag.hpp",
   "redis/include/userver/storages/redis/subscribe_client.hpp":"taxi/uservices/userver/redis/include/userver/storages/redis/subscribe_client.hpp",
   "redis/include/userver/storages/redis/subscription_token.hpp":"taxi/uservices/userver/redis/include/userver/storages/redis/subscription_token.hpp",

redis/include/userver/storages/redis/client.hpp

@@ -16,6 +16,7 @@
 #include <userver/storages/redis/request.hpp>
 #include <userver/storages/redis/request_eval.hpp>
 #include <userver/storages/redis/request_evalsha.hpp>
+#include <userver/storages/redis/request_generic.hpp>
 #include <userver/storages/redis/transaction.hpp>
 
 USERVER_NAMESPACE_BEGIN
@@ -107,6 +108,22 @@ class Client {
             EvalShaCommon(std::move(script_hash), std::move(keys), std::move(args), command_control)};
     }
 
+    /// @brief Execute a custom Redis command.
+    /// @param key_index Index of the key in the args vector used to determine the shard
+    ///
+    /// Sample usage:
+    /// @snippet redis/src/storages/redis/client_cluster_redistest.cpp  Sample generic command usage
+    template <typename ReplyType>
+    RequestGeneric<ReplyType> GenericCommand(
+        std::string command,
+        std::vector<std::string> args,
+        size_t key_index,
+        const CommandControl& command_control
+    ) {
+        return RequestGeneric<ReplyType>{
+            GenericCommon(std::move(command), std::move(args), key_index, command_control)};
+    }
+
     /// @brief Load the script to the server for further execution via EvalSha() member function.
     ///
     /// Sample usage:
@@ -517,6 +534,12 @@ class Client {
         std::vector<std::string> args,
         const CommandControl& command_control
     ) = 0;
+    virtual RequestGenericCommon GenericCommon(
+        std::string command,
+        std::vector<std::string> args,
+        size_t key_index,
+        const CommandControl& command_control
+    ) = 0;
 };
 
 std::string CreateTmpKey(const std::string& key, std::string prefix);

redis/include/userver/storages/redis/request.hpp

@@ -59,6 +59,9 @@ class [[nodiscard]] Request final {
     template <ScanTag TScanTag>
     friend class RequestScanData;
 
+    template <typename T1>
+    friend class RequestGeneric;
+
 private:
     ReplyPtr GetRaw() { return impl_->GetRaw(); }
 
@@ -165,6 +168,7 @@ using RequestDbsize = Request<size_t>;
 using RequestDecr = Request<int64_t>;
 using RequestDel = Request<size_t>;
 using RequestUnlink = Request<size_t>;
+using RequestGenericCommon = Request<ReplyData>;
 using RequestEvalCommon = Request<ReplyData>;
 using RequestEvalShaCommon = Request<ReplyData>;
 using RequestScriptLoad = Request<std::string>;

redis/include/userver/storages/redis/request_generic.hpp

@@ -0,0 +1,40 @@
+#pragma once
+
+/// @file
+/// @brief @copybrief storages::redis::RequestGeneric
+
+#include <userver/storages/redis/parse_reply.hpp>
+#include <userver/storages/redis/reply.hpp>
+#include <userver/storages/redis/request.hpp>
+
+USERVER_NAMESPACE_BEGIN
+
+namespace storages::redis {
+
+/// @brief Redis future for generic command responses.
+/// Can be used to request custom modules commands or unsupported yet commands
+template <typename ReplyType>
+class [[nodiscard]] RequestGeneric final {
+public:
+    explicit RequestGeneric(RequestGenericCommon&& request) : request_(std::move(request)) {}
+
+    void Wait() { request_.Wait(); }
+
+    void IgnoreResult() const { request_.IgnoreResult(); }
+
+    ReplyType Get(const std::string& request_description = {}) {
+        return impl::ParseReply<ReplyType, ReplyType>(request_.GetRaw(), request_description);
+    }
+
+    /// @cond
+    /// Internal helper for WaitAny/WaitAll
+    engine::impl::ContextAccessor* TryGetContextAccessor() noexcept { return request_.TryGetContextAccessor(); }
+    /// @endcond
+
+private:
+    RequestGenericCommon request_;
+};
+
+}  // namespace storages::redis
+
+USERVER_NAMESPACE_END

redis/src/storages/redis/client_impl.cpp

@@ -181,6 +181,18 @@ RequestEvalShaCommon ClientImpl::EvalShaCommon(
     ));
 }
 
+RequestGenericCommon ClientImpl::GenericCommon(
+    std::string command,
+    std::vector<std::string> args,
+    size_t key_index,
+    const CommandControl& command_control
+) {
+    size_t shard = ShardByKey(args.at(key_index), command_control);
+    return CreateRequest<RequestGenericCommon>(
+        MakeRequest(CmdArgs{command, std::move(args)}, shard, true, GetCommandControl(command_control))
+    );
+}
+
 RequestScriptLoad ClientImpl::ScriptLoad(std::string script, size_t shard, const CommandControl& command_control) {
     return CreateRequest<RequestScriptLoad>(
         MakeRequest(CmdArgs{"script", "load", std::move(script)}, shard, true, GetCommandControl(command_control))

redis/src/storages/redis/client_impl.hpp

@@ -89,6 +89,12 @@ class ClientImpl final : public Client, public std::enable_shared_from_this<Clie
         std::vector<std::string> args,
         const CommandControl& command_control
     ) override;
+    RequestGenericCommon GenericCommon(
+        std::string command,
+        std::vector<std::string> args,
+        size_t key_index,
+        const CommandControl& command_control
+    ) override;
     RequestScriptLoad ScriptLoad(std::string script, size_t shard, const CommandControl& command_control) override;
 
     RequestExists Exists(std::string key, const CommandControl& command_control) override;

redis/src/storages/redis/client_redistest.cpp

@@ -238,6 +238,23 @@ UTEST_F(RedisClientTest, EvalSha) {
     EXPECT_EQ(result_array[0], "key1");
 }
 
+UTEST_F(RedisClientTest, Generic) {
+    auto client = GetClient();
+    const storages::redis::CommandControl kCommandControl{};
+    constexpr size_t kKeyIndex = 0;
+    UEXPECT_NO_THROW(client->GenericCommand<void>("set", {"key0", "foo"}, kKeyIndex, kCommandControl).Wait());
+    EXPECT_EQ(client->GenericCommand<std::string>("get", {"key0"}, kKeyIndex, kCommandControl).Get(), "foo");
+    EXPECT_EQ(
+        client->GenericCommand<int64_t>("LPUSH", {"list", "1", "2", "3", "4"}, kKeyIndex, kCommandControl).Get(), 4
+    );
+    const std::vector<std::string> kExpected{"4", "3", "2", "1"};
+    EXPECT_EQ(
+        client->GenericCommand<std::vector<std::string>>("LRANGE", {"list", "0", "-1"}, kKeyIndex, kCommandControl)
+            .Get(),
+        kExpected
+    );
+}
+
 UTEST_F(RedisClientTest, Exists) {
     auto client = GetClient();
     client->Set("key1", "Hello", {}).Get();

redis/testing/include/userver/storages/redis/mock_client_base.hpp

@@ -87,6 +87,12 @@ class MockClientBase : public Client, public std::enable_shared_from_this<MockCl
         std::vector<std::string> args,
         const CommandControl& command_control
     ) override;
+    RequestGenericCommon GenericCommon(
+        std::string command,
+        std::vector<std::string> args,
+        size_t key_index,
+        const CommandControl& command_control
+    ) override;
 
     RequestScriptLoad ScriptLoad(std::string script, size_t shard, const CommandControl& command_control) override;