fixture tweak, add util fn, fix test

Author: rbs333

redisvl/extensions/router/semantic.py

@@ -1,5 +1,5 @@
 from pathlib import Path
-from typing import Any, ClassVar, Dict, List, Optional, Type, Union
+from typing import Any, Dict, List, Optional, Type, Union
 
 import redis.commands.search.reducers as reducers
 import yaml
@@ -23,7 +23,7 @@
 from redisvl.redis.connection import RedisConnectionFactory
 from redisvl.redis.utils import convert_bytes, hashify, make_dict
 from redisvl.utils.log import get_logger
-from redisvl.utils.utils import deprecated_argument, model_to_dict
+from redisvl.utils.utils import deprecated_argument, model_to_dict, scan_by_pattern
 from redisvl.utils.vectorize.base import BaseVectorizer
 from redisvl.utils.vectorize.text.huggingface import HFTextVectorizer
 
@@ -43,7 +43,6 @@ class SemanticRouter(BaseModel):
     """Configuration for routing behavior."""
 
     _index: SearchIndex = PrivateAttr()
-    _persist_config: bool = PrivateAttr()
 
     model_config = ConfigDict(arbitrary_types_allowed=True)
 
@@ -170,7 +169,7 @@ def _initialize_index(
 
         if not existed or overwrite:
             # write the routes to Redis
-            self.add_routes(self.routes)
+            self._add_routes(self.routes)
 
     @property
     def route_names(self) -> List[str]:
@@ -213,7 +212,7 @@ def _route_ref_key(index: SearchIndex, route_name: str, reference_hash: str) ->
         """Generate the route reference key."""
         return f"{index.prefix}:{route_name}:{reference_hash}"
 
-    def add_routes(self, routes: List[Route]):
+    def _add_routes(self, routes: List[Route]):
         """Add routes to the router and index.
 
         Args:
@@ -719,8 +718,8 @@ def get_route_references(
             queries = self._make_filter_queries(reference_ids)
         elif route_name:
             if not keys:
-                _, keys = self._index.client.scan(  # type: ignore
-                    cursor=0, match=f"{self._index.prefix}:{route_name}:*"
+                keys = scan_by_pattern(
+                    self._index.client, f"{self._index.prefix}:{route_name}:*"  # type: ignore
                 )
 
             queries = self._make_filter_queries(
@@ -757,10 +756,9 @@ def delete_route_references(
             res = self._index.batch_query(queries)
             keys = [r[0]["id"] for r in res if len(r) > 0]
         elif not keys:
-            _, keys = self._index.client.scan(  # type: ignore
-                cursor=0, match=f"{self._index.prefix}:{route_name}:*"
+            keys = scan_by_pattern(
+                self._index.client, f"{self._index.prefix}:{route_name}:*"  # type: ignore
             )
-            keys = convert_bytes(keys)
 
         if not keys:
             raise ValueError(f"No references found for route {route_name}")

redisvl/utils/utils.py

@@ -7,10 +7,11 @@
 from enum import Enum
 from functools import wraps
 from time import time
-from typing import Any, Callable, Coroutine, Dict, Optional
+from typing import Any, Callable, Coroutine, Dict, Optional, Sequence
 from warnings import warn
 
 from pydantic import BaseModel
+from redis import Redis
 from ulid import ULID
 
 
@@ -213,3 +214,22 @@ def norm_l2_distance(value: float) -> float:
     Normalize the L2 distance.
     """
     return 1 / (1 + value)
+
+
+def scan_by_pattern(
+    redis_client: Redis,
+    pattern: str,
+) -> Sequence[str]:
+    """
+    Scan the Redis database for keys matching a specific pattern.
+
+    Args:
+        redis (Redis): The Redis client instance.
+        pattern (str): The pattern to match keys against.
+
+    Returns:
+        List[str]: A dictionary containing the keys and their values.
+    """
+    from redisvl.redis.utils import convert_bytes
+
+    return convert_bytes(list(redis_client.scan_iter(match=pattern)))

schemas/semantic_router.yaml

@@ -1,4 +1,4 @@
-name: test-router-01JSEWS2CA00GT0HMABBGVEKRR
+name: test-router-01JSHERM5V4G94GN3W68XB45PK
 routes:
 - name: greeting
   references:

tests/integration/test_query.py

@@ -22,6 +22,7 @@
     Timestamp,
 )
 from redisvl.redis.utils import array_to_buffer
+from redisvl.utils.utils import create_ulid
 
 # TODO expand to multiple schema types and sync + async
 
@@ -145,11 +146,12 @@ def sorted_range_query():
 @pytest.fixture
 def index(sample_data, redis_url):
     # construct a search index from the schema
+    idx = f"user_index_{create_ulid()}"
     index = SearchIndex.from_dict(
         {
             "index": {
-                "name": "user_index",
-                "prefix": "v1",
+                "name": idx,
+                "prefix": idx,
                 "storage_type": "hash",
             },
             "fields": [
@@ -190,17 +192,20 @@ def hash_preprocess(item: dict) -> dict:
     yield index
 
     # clean up
-    index.delete(drop=True)
+    index.clear()
+    index.delete()
 
 
 @pytest.fixture
 def L2_index(sample_data, redis_url):
     # construct a search index from the schema
+    idx = f"L2_index_{create_ulid()}"
+
     index = SearchIndex.from_dict(
         {
             "index": {
-                "name": "L2_index",
-                "prefix": "L2_index",
+                "name": idx,
+                "prefix": idx,
                 "storage_type": "hash",
             },
             "fields": [
@@ -240,7 +245,8 @@ def hash_preprocess(item: dict) -> dict:
     yield index
 
     # clean up
-    index.delete(drop=True)
+    index.clear()
+    index.delete()
 
 
 def test_search_and_query(index):

tests/integration/test_semantic_router.py

@@ -520,4 +520,4 @@ def test_delete_route_references(semantic_router):
     assert deleted == 2
 
     router_dict = semantic_router.to_dict()
-    assert len(router_dict["references"]) == 0
+    assert len(router_dict["routes"][0]["references"]) == 0