Add support for extra Redis connection params

Author: danie1k

ldclient/impl/integrations/redis/redis_big_segment_store.py

@@ -1,7 +1,7 @@
 from ldclient import log
 from ldclient.interfaces import BigSegmentStore, BigSegmentStoreMetadata
 
-from typing import Optional, Set, cast
+from typing import Any, Optional, Set, cast
 
 have_redis = False
 try:
@@ -16,11 +16,11 @@ class _RedisBigSegmentStore(BigSegmentStore):
     KEY_USER_INCLUDE = ':big_segment_include:'
     KEY_USER_EXCLUDE = ':big_segment_exclude:'
 
-    def __init__(self, url: str, prefix: Optional[str], max_connections: int):
+    def __init__(self, url: str, prefix: Optional[str], **conn_options: Any):
         if not have_redis:
             raise NotImplementedError("Cannot use Redis Big Segment store because redis package is not installed")
         self._prefix = prefix or 'launchdarkly'
-        self._pool = redis.ConnectionPool.from_url(url=url, max_connections=max_connections)
+        self._pool = redis.ConnectionPool.from_url(url=url, **conn_options)
         log.info("Started RedisBigSegmentStore connected to URL: " + url + " using prefix: " + self._prefix)
 
     def get_metadata(self) -> BigSegmentStoreMetadata:

ldclient/impl/integrations/redis/redis_feature_store.py

@@ -13,11 +13,11 @@
 
 
 class _RedisFeatureStoreCore(DiagnosticDescription, FeatureStoreCore):
-    def __init__(self, url, prefix, max_connections):
+    def __init__(self, url, prefix, **conn_options):
         if not have_redis:
             raise NotImplementedError("Cannot use Redis feature store because redis package is not installed")
         self._prefix = prefix or 'launchdarkly'
-        self._pool = redis.ConnectionPool.from_url(url=url, max_connections=max_connections)
+        self._pool = redis.ConnectionPool.from_url(url=url, **conn_options)
         self.test_update_hook = None  # exposed for testing
         log.info("Started RedisFeatureStore connected to URL: " + url + " using prefix: " + self._prefix)
 

ldclient/integrations/__init__.py

@@ -144,11 +144,13 @@ class Redis:
     def new_feature_store(url: str='redis://localhost:6379/0',
                           prefix: str='launchdarkly',
                           max_connections: int=16,
-                          caching: CacheConfig=CacheConfig.default()) -> CachingStoreWrapper:
+                          caching: CacheConfig=CacheConfig.default(),
+                          **conn_options: Any) -> CachingStoreWrapper:
         """
         Creates a Redis-backed implementation of :class:`~ldclient.interfaces.FeatureStore`.
         For more details about how and why you can use a persistent feature store, see the
         `SDK reference guide <https://docs.launchdarkly.com/sdk/concepts/data-stores>`_.
+        `SDK reference guide <https://docs.launchdarkly.com/sdk/concepts/data-stores>`_.
 
         To use this method, you must first install the ``redis`` package. Then, put the object
         returned by this method into the ``feature_store`` property of your client configuration
@@ -167,16 +169,19 @@ def new_feature_store(url: str='redis://localhost:6379/0',
           connection pool; defaults to ``DEFAULT_MAX_CONNECTIONS``
         :param caching: specifies whether local caching should be enabled and if so,
           sets the cache properties; defaults to :func:`ldclient.feature_store.CacheConfig.default()`
+        :param conn_options: extra options for initializing Redis connection from the url,
+          see `redis.connection.ConnectionPool.from_url` for more details.
         """
-        core = _RedisFeatureStoreCore(url, prefix, max_connections)
+        core = _RedisFeatureStoreCore(url, prefix, max_connections, **conn_options)
         wrapper = CachingStoreWrapper(core, caching)
         wrapper._core = core  # exposed for testing
         return wrapper
 
     @staticmethod
     def new_big_segment_store(url: str='redis://localhost:6379/0',
                               prefix: str='launchdarkly',
-                              max_connections: int=16) -> BigSegmentStore:
+                              max_connections: int=16,
+                              **conn_options: Any) -> BigSegmentStore:
         """
         Creates a Redis-backed Big Segment store.
 
@@ -198,8 +203,10 @@ def new_big_segment_store(url: str='redis://localhost:6379/0',
           ``DEFAULT_PREFIX``
         :param max_connections: the maximum number of Redis connections to keep in the
           connection pool; defaults to ``DEFAULT_MAX_CONNECTIONS``
+        :param conn_options: extra options for initializing Redis connection from the url,
+          see `redis.connection.ConnectionPool.from_url` for more details.
         """
-        return _RedisBigSegmentStore(url, prefix, max_connections)
+        return _RedisBigSegmentStore(url, prefix, max_connections, **conn_options)
 
 class Files:
     """Provides factory methods for integrations with filesystem data.