Added configurable prefixes for Redis Tracker and Lock stores

changelog/6498.improvement.md

@@ -0,0 +1,2 @@
+Adding configurable prefixes to Redis Tracker and Lock stores so that a single Redis instance (and logical DB) can support multiple conversation trackers and lock.
+All conversations will be prefixed with `tracker:...` and all locks prefixed with `lock:...`. Additionally, you can add an alphanumeric-only `prefix: value` in `endpoints.yml` such that keys in redis will take the form `value:tracker:...` and `value:lock:...` respectively.

data/test_endpoints/example_endpoints.yml

@@ -14,6 +14,7 @@ tracker_store:
   port: 6379
   db: 0
   password: password
+  prefix: xyz
   record_exp: 30000
 # example of mongoDB external tracker store config
 #tracker_store:

docs/docs/lock-stores.mdx

@@ -57,6 +57,7 @@ address the same node when sending messages for a given conversation ID.
          port: <port of your redis instance, usually 6379>
          password: <password used for authentication>
          db: <number of your database within redis, e.g. 0>
+         prefix: <alphanumeric value to prepend to lock_store keys>
      ```
 
   3. To start the Rasa Core server using your Redis backend, add the `--endpoints`
@@ -76,6 +77,9 @@ address the same node when sending messages for a given conversation ID.
 
   * `db` (default: `1`): The number of your redis database
 
+  * `prefix` (default: `None`): The prefix to prepend to lock_store keys. Must
+     be alphanumeric
+
   * `password` (default: `None`): Password used for authentication
     (`None` equals no authentication)
 

docs/docs/tracker-stores.mdx

@@ -191,13 +191,14 @@ USER 1001`}</code></pre>
   2. Add required configuration to your `endpoints.yml`:
 
      ```yaml-rasa
-     tracker_store:
-         type: redis
-         url: <url of the redis instance, e.g. localhost>
-         port: <port of your redis instance, usually 6379>
-         db: <number of your database within redis, e.g. 0>
-         password: <password used for authentication>
-         use_ssl: <whether or not the communication is encrypted, default `false`>
+      tracker_store:
+        type: redis
+        url: <url of the redis instance, e.g. localhost>
+        port: <port of your redis instance, usually 6379>
+        db: <number of your database within redis, e.g. 0>
+        prefix: <alphanumeric value to prepend to tracker_store keys>
+        password: <password used for authentication>
+        use_ssl: <whether or not the communication is encrypted, default `false`>
      ```
 
   3. To start the Rasa server using your configured Redis instance,
@@ -219,12 +220,13 @@ USER 1001`}</code></pre>
 
      ```yaml-rasa {3}
       tracker_store:
-          type: redis
-          url: <url of the redis instance, e.g. localhost>
-          port: <port of your redis instance, usually 6379>
-          db: <number of your database within redis, e.g. 0>
-          password: <password used for authentication>
-          use_ssl: <whether or not the communication is encrypted, default `false`>
+        type: redis
+        url: <url of the redis instance, e.g. localhost>
+        port: <port of your redis instance, usually 6379>
+        db: <number of your database within redis, e.g. 0>
+        prefix: <alphanumeric value to prepend to tracker_store keys>
+        password: <password used for authentication>
+        use_ssl: <whether or not the communication is encrypted, default `false`>
      ```
 
 
@@ -237,6 +239,9 @@ USER 1001`}</code></pre>
 
   * `db` (default: `0`): The number of your redis database
 
+  * `prefix` (default: `None`): The prefix to prepend to lock_store keys. Must
+     be alphanumeric
+
   * `password` (default: `None`): Password used for authentication
     (`None` equals no authentication)
 

rasa/core/lock_store.py

@@ -198,6 +198,7 @@ def __init__(
         db: int = 1,
         password: Optional[Text] = None,
         use_ssl: bool = False,
+        prefix: Optional[Text] = None,
         socket_timeout: float = DEFAULT_SOCKET_TIMEOUT_IN_SECONDS,
     ) -> None:
         """Create a lock store which uses Redis for persistence.
@@ -210,6 +211,8 @@ def __init__(
             password: The password which should be used for authentication with the
                 Redis database.
             use_ssl: `True` if SSL should be used for the connection to Redis.
+            prefix: prefix to prepend to all keys used by the lockstore. Must be
+                alphanumeric.
             socket_timeout: Timeout in seconds after which an exception will be raised
                 in case Redis doesn't respond within `socket_timeout` seconds.
         """
@@ -223,19 +226,32 @@ def __init__(
             ssl=use_ssl,
             socket_timeout=socket_timeout,
         )
+
+        if (prefix is None) or (prefix == ""):
+            self.prefix = "lock:"
+        elif (prefix is not None) and (
+            (isinstance(prefix, str)) and (prefix.isalnum())
+        ):
+            self.prefix = prefix + ":lock:"
+        else:
+            self.prefix = "lock:"
+            logger.warning(
+                f"Omitting provided non-alphanumeric key prefix: '{prefix}'."
+            )
+
         super().__init__()
 
     def get_lock(self, conversation_id: Text) -> Optional[TicketLock]:
-        serialised_lock = self.red.get(conversation_id)
+        serialised_lock = self.red.get(self.prefix + conversation_id)
         if serialised_lock:
             return TicketLock.from_dict(json.loads(serialised_lock))
 
     def delete_lock(self, conversation_id: Text) -> None:
-        deletion_successful = self.red.delete(conversation_id)
+        deletion_successful = self.red.delete(self.prefix + conversation_id)
         self._log_deletion(conversation_id, deletion_successful)
 
     def save_lock(self, lock: TicketLock) -> None:
-        self.red.set(lock.conversation_id, lock.dumps())
+        self.red.set(self.prefix + lock.conversation_id, lock.dumps())
 
 
 class InMemoryLockStore(LockStore):

rasa/core/tracker_store.py

@@ -263,6 +263,7 @@ def __init__(
         password: Optional[Text] = None,
         event_broker: Optional[EventBroker] = None,
         record_exp: Optional[float] = None,
+        prefix: Optional[Text] = None,
         use_ssl: bool = False,
     ):
         import redis
@@ -271,6 +272,19 @@ def __init__(
             host=host, port=port, db=db, password=password, ssl=use_ssl
         )
         self.record_exp = record_exp
+
+        if (prefix is None) or (prefix == ""):
+            self.prefix = "tracker:"
+        elif (prefix is not None) and (
+            (isinstance(prefix, str)) and (prefix.isalnum())
+        ):
+            self.prefix = prefix + ":tracker:"
+        else:
+            self.prefix = "tracker:"
+            logger.warning(
+                f"Omitting provided non-alphanumeric key prefix: '{prefix}'."
+            )
+
         super().__init__(domain, event_broker)
 
     def save(self, tracker, timeout=None):
@@ -282,7 +296,7 @@ def save(self, tracker, timeout=None):
             timeout = self.record_exp
 
         serialised_tracker = self.serialise_tracker(tracker)
-        self.red.set(tracker.sender_id, serialised_tracker, ex=timeout)
+        self.red.set(self.prefix + tracker.sender_id, serialised_tracker, ex=timeout)
 
     def retrieve(self, sender_id):
         """
@@ -292,15 +306,15 @@ def retrieve(self, sender_id):
         Returns:
             DialogueStateTracker
         """
-        stored = self.red.get(sender_id)
+        stored = self.red.get(self.prefix + sender_id)
         if stored is not None:
             return self.deserialise_tracker(sender_id, stored)
         else:
             return None
 
     def keys(self) -> Iterable[Text]:
         """Returns keys of the Redis Tracker Store"""
-        return self.red.keys()
+        return self.red.keys(self.prefix + "*")
 
 
 class DynamoTrackerStore(TrackerStore):

tests/core/test_lock_store.py

@@ -28,6 +28,9 @@ def __init__(self):
         # added in redis==3.3.0, but not yet in fakeredis
         self.red.connection_pool.connection_class.health_check_interval = 0
 
+        # an optional configuration defined in endpoints.yml
+        self.prefix = "lock:"
+
         super(RedisLockStore, self).__init__()
 
 

tests/core/test_trackers.py

@@ -60,6 +60,9 @@ def __init__(self, _domain: Domain) -> None:
         # added in redis==3.3.0, but not yet in fakeredis
         self.red.connection_pool.connection_class.health_check_interval = 0
 
+        # Defined in RedisTrackerStore but needs to be added for the MockRedisTrackerStore
+        self.prefix = "tracker:"
+
         TrackerStore.__init__(self, _domain)