add exception class for invalid modules

Author: tylerhutcherson

redisvl/exceptions.py

@@ -0,0 +1,6 @@
+class RedisVLException(Exception):
+    """Base RedisVL exception"""
+
+
+class RedisModuleVersionError(RedisVLException):
+    """Invalid module versions installed"""

redisvl/index/index.py

@@ -25,6 +25,7 @@
 import redis.asyncio as aredis
 from redis.commands.search.indexDefinition import IndexDefinition
 
+from redisvl.exceptions import RedisModuleVersionError
 from redisvl.index.storage import BaseStorage, HashStorage, JsonStorage
 from redisvl.query import BaseQuery, CountQuery, FilterQuery
 from redisvl.query.filter import FilterExpression
@@ -354,10 +355,17 @@ def from_existing(
 
         # Validate modules
         installed_modules = RedisConnectionFactory.get_modules(redis_client)
-        validate_modules(
-            installed_modules,
-            [{"name": "search", "ver": 20810}, {"name": "searchlight", "ver": 20810}]
-        )
+
+        try:
+            required_modules = [
+                {"name": "search", "ver": 20810},
+                {"name": "searchlight", "ver": 20810},
+            ]
+            validate_modules(installed_modules, required_modules)
+        except RedisModuleVersionError as e:
+            raise RedisModuleVersionError(
+                f"Loading from existing index failed. {str(e)}"
+            )
 
         # Fetch index info and convert to schema
         index_info = cls._info(name, redis_client)
@@ -863,10 +871,16 @@ async def from_existing(
 
         # Validate modules
         installed_modules = await RedisConnectionFactory.get_modules_async(redis_client)
-        validate_modules(
-            installed_modules,
-            [{"name": "search", "ver": 20810}, {"name": "searchlight", "ver": 20810}]
-        )
+        try:
+            required_modules = [
+                {"name": "search", "ver": 20810},
+                {"name": "searchlight", "ver": 20810},
+            ]
+            validate_modules(installed_modules, required_modules)
+        except RedisModuleVersionError as e:
+            raise RedisModuleVersionError(
+                f"Loading from existing index failed. {str(e)}"
+            )
 
         # Fetch index info and convert to schema
         index_info = await cls._info(name, redis_client)

redisvl/redis/connection.py

@@ -9,6 +9,7 @@
 from redis.connection import AbstractConnection, SSLConnection
 from redis.exceptions import ResponseError
 
+from redisvl.exceptions import RedisModuleVersionError
 from redisvl.redis.constants import DEFAULT_REQUIRED_MODULES
 from redisvl.redis.utils import convert_bytes
 from redisvl.version import __version__
@@ -143,11 +144,18 @@ def validate_modules(
             if int(installed_version) >= int(required_module["ver"]):  # type: ignore
                 return
 
-    raise ValueError(
-        f"Required Redis database module {required_module['name']} with version >= {required_module['ver']} not installed. "
-        "See Redis Stack documentation: https://redis.io/docs/stack/"
+    error_message = "Required Redis db module "
+
+    error_message += " OR ".join(
+        [f'{module["name"]} >= {module["ver"]}' for module in required_modules]
+    )
+
+    error_message += (
+        " not installed. See Redis Stack docs at https://redis.io/docs/stack/."
     )
 
+    raise RedisModuleVersionError(error_message)
+
 
 class RedisConnectionFactory:
     """Builds connections to a Redis database, supporting both synchronous and

tests/integration/test_connection.py

@@ -5,6 +5,7 @@
 from redis.asyncio import Redis as AsyncRedis
 from redis.exceptions import ConnectionError
 
+from redisvl.exceptions import RedisModuleVersionError
 from redisvl.redis.connection import (
     RedisConnectionFactory,
     compare_versions,
@@ -123,7 +124,7 @@ def test_validate_modules_exist_searchlight():
 
 
 def test_validate_modules_not_exist():
-    with pytest.raises(ValueError):
+    with pytest.raises(RedisModuleVersionError):
         validate_modules(
             installed_modules={"search": 20811},
             required_modules=[