redis: Support a few more socket_* options

Added support for additional Redis client parameters
:paramref:`.RedisBackend.socket_connect_timeout`,
:paramref:`.RedisBackend.socket_keepalive` and
:paramref:`.RedisBackend.socket_keepalive_options`. Pull request courtesy
Takashi Kajinami.

Closes: #252
Pull-request: #252
Pull-request-sha: adf7a8a

Change-Id: Iad0a8960d6f5450035296de8563a7d885a675968

Author: kajinamit

docs/build/unreleased/250.rst

@@ -1,5 +1,5 @@
 .. change::
-    :tags: feature, redis
+    :tags: usecase, redis
     :tickets: 250
 
     Added a new backend :class:`.RedisClusterBackend`, allowing support for

docs/build/unreleased/redis-socket-opts.rst

@@ -0,0 +1,9 @@
+.. change::
+    :tags: usecase, redis
+    :tickets: 252
+
+    Added support for additional Redis client parameters
+    :paramref:`.RedisBackend.socket_connect_timeout`,
+    :paramref:`.RedisBackend.socket_keepalive` and
+    :paramref:`.RedisBackend.socket_keepalive_options`. Pull request courtesy
+    Takashi Kajinami.

dogpile/cache/backends/redis.py

@@ -52,6 +52,8 @@ class RedisBackend(BytesBackend):
 
     :param username: string, default is no username.
 
+     .. versionadded:: 1.3.1
+
     :param password: string, default is no password.
 
     :param port: integer, default is ``6379``.
@@ -74,6 +76,21 @@ class RedisBackend(BytesBackend):
     :param socket_timeout: float, seconds for socket timeout.
      Default is None (no timeout).
 
+    :param socket_connect_timeout: float, seconds for socket connection
+     timeout. Default is None (no timeout).
+
+     .. versionadded:: 1.3.2
+
+    :param socket_keepalive: boolean, when True, socket keepalive is enabled.
+     Default is False.
+
+     .. versionadded:: 1.3.2
+
+    :param socket_keepalive_options: dict, socket keepalive options.
+     Default is None (no options).
+
+     .. versionadded:: 1.3.2
+
     :param lock_sleep: integer, number of seconds to sleep when failed to
      acquire a lock.  This argument is only valid when
      ``distributed_lock`` is ``True``.
@@ -95,9 +112,10 @@ class RedisBackend(BytesBackend):
      directly, including parameters like ``ssl``, ``ssl_certfile``,
      ``charset``, etc.
 
-     .. versionadded:: 1.1.6  Added ``connection_kwargs`` parameter.
+     .. versionadded:: 1.1.6
+
+
 
-     .. versionadded:: 1.3.1  Added ``username`` parameter.
 
     """
 
@@ -112,6 +130,13 @@ def __init__(self, arguments):
         self.db = arguments.pop("db", 0)
         self.distributed_lock = arguments.pop("distributed_lock", False)
         self.socket_timeout = arguments.pop("socket_timeout", None)
+        self.socket_connect_timeout = arguments.pop(
+            "socket_connect_timeout", None
+        )
+        self.socket_keepalive = arguments.pop("socket_keepalive", False)
+        self.socket_keepalive_options = arguments.pop(
+            "socket_keepalive_options", None
+        )
         self.lock_timeout = arguments.pop("lock_timeout", None)
         self.lock_sleep = arguments.pop("lock_sleep", 0.1)
         self.thread_local_lock = arguments.pop("thread_local_lock", True)
@@ -144,8 +169,16 @@ def _create_client(self):
         else:
             args = {}
             args.update(self.connection_kwargs)
-            if self.socket_timeout:
+            if self.socket_timeout is not None:
                 args["socket_timeout"] = self.socket_timeout
+            if self.socket_connect_timeout is not None:
+                args["socket_connect_timeout"] = self.socket_connect_timeout
+            if self.socket_keepalive:
+                args["socket_keepalive"] = True
+                if self.socket_keepalive_options is not None:
+                    args[
+                        "socket_keepalive_options"
+                    ] = self.socket_keepalive_options
 
             if self.url is not None:
                 args.update(url=self.url)
@@ -256,6 +289,8 @@ class RedisSentinelBackend(RedisBackend):
 
     :param username: string, default is no username.
 
+     .. versionadded:: 1.3.1
+
     :param password: string, default is no password.
 
     :param db: integer, default is ``0``.
@@ -276,6 +311,21 @@ class RedisSentinelBackend(RedisBackend):
     :param socket_timeout: float, seconds for socket timeout.
      Default is None (no timeout).
 
+     .. versionadded:: 1.3.2
+
+    :param socket_connect_timeout: float, seconds for socket connection
+     timeout.  Default is None (no timeout).
+
+     .. versionadded:: 1.3.2
+
+    :param socket_keepalive: boolean, when True, socket keepalive is enabled
+     Default is False.
+
+     .. versionadded:: 1.3.2
+
+    :param socket_keepalive_options: dict, socket keepalive options.
+     Default is {} (no options).
+
     :param sentinels: is a list of sentinel nodes. Each node is represented by
      a pair (hostname, port).
      Default is None (not in sentinel mode).
@@ -303,7 +353,6 @@ class RedisSentinelBackend(RedisBackend):
      asynchronous runners, as they run in a different thread than the one
      used to create the lock.
 
-     .. versionadded:: 1.3.1  Added ``username`` parameter.
 
     """
 
@@ -343,6 +392,16 @@ def _create_client(self):
             sentinel_kwargs.setdefault("db", self.db)
         if self.socket_timeout is not None:
             connection_kwargs.setdefault("socket_timeout", self.socket_timeout)
+        if self.socket_connect_timeout is not None:
+            connection_kwargs.setdefault(
+                "socket_connect_timeout", self.socket_connect_timeout
+            )
+        if self.socket_keepalive:
+            connection_kwargs.setdefault("socket_keepalive", True)
+            if self.socket_keepalive_options is not None:
+                connection_kwargs.setdefault(
+                    "socket_keepalive_options", self.socket_keepalive_options
+                )
 
         sentinel = redis.sentinel.Sentinel(
             self.sentinels,
@@ -463,6 +522,12 @@ class RedisClusterBackend(RedisBackend):
     :param socket_timeout: float, seconds for socket timeout.
      Default is None (no timeout).
 
+    :param socket_connect_timeout: float, seconds for socket connection
+     timeout.  Default is None (no timeout).
+
+    :param socket_keepalive: boolean, when True, socket keepalive is enabled
+     Default is False.
+
     :param lock_sleep: integer, number of seconds to sleep when failed to
      acquire a lock.  This argument is only valid when
      ``distributed_lock`` is ``True``.

tests/cache/test_redis_backend.py

@@ -202,6 +202,41 @@ def test_connect_with_socket_timeout(self, MockStrictRedis):
         expected.update({"username": None, "password": None})
         self._test_helper(MockStrictRedis, expected, arguments)
 
+    def test_connect_with_socket_connect_timeout(self, MockStrictRedis):
+        arguments = {
+            "host": "127.0.0.1",
+            "port": 6379,
+            "socket_timeout": 1.0,
+            "db": 0,
+        }
+        expected = arguments.copy()
+        expected.update({"username": None, "password": None})
+        self._test_helper(MockStrictRedis, expected, arguments)
+
+    def test_connect_with_socket_keepalive(self, MockStrictRedis):
+        arguments = {
+            "host": "127.0.0.1",
+            "port": 6379,
+            "socket_keepalive": True,
+            "db": 0,
+        }
+        expected = arguments.copy()
+        expected.update({"username": None, "password": None})
+        self._test_helper(MockStrictRedis, expected, arguments)
+
+    def test_connect_with_socket_keepalive_options(self, MockStrictRedis):
+        arguments = {
+            "host": "127.0.0.1",
+            "port": 6379,
+            "socket_keepalive": True,
+            # 4 = socket.TCP_KEEPIDLE
+            "socket_keepalive_options": {4, 10.0},
+            "db": 0,
+        }
+        expected = arguments.copy()
+        expected.update({"username": None, "password": None})
+        self._test_helper(MockStrictRedis, expected, arguments)
+
     def test_connect_with_connection_pool(self, MockStrictRedis):
         pool = Mock()
         arguments = {"connection_pool": pool, "socket_timeout": 0.5}