Add an option to use the given key as-is (#112)

This is required when we're dealing with data cached in a different way
than through the CacheManager.

Author: lukasz-matter

matter_persistence/redis/manager.py

@@ -175,9 +175,9 @@ async def save_with_key(
         value: Any,
         object_class: type[Model] | None = None,
         expiration_in_seconds: int | None = None,
+        use_key_as_is: bool = False,
     ):
-        object_name = object_class.__name__ if object_class else None
-        hash_key = CacheHelper.create_basic_hash_key(key, object_name)
+        hash_key = self._get_key_from_params(key=key, object_class=object_class, use_key_as_is=use_key_as_is)
         if object_class:
             value = value.model_dump_json()
 
@@ -215,9 +215,8 @@ async def save_many_with_keys(
                 }
             await cache_client.set_many_values(processed_input, ttl=expiration_in_seconds)
 
-    async def get_with_key(self, key: str, object_class: type[Model] | None = None) -> Any:
-        object_name = object_class.__name__ if object_class else None
-        hash_key = CacheHelper.create_basic_hash_key(key, object_name)
+    async def get_with_key(self, key: str, object_class: type[Model] | None = None, use_key_as_is: bool = False) -> Any:
+        hash_key = self._get_key_from_params(key=key, object_class=object_class, use_key_as_is=use_key_as_is)
         async with self.__get_cache_client(for_writing=False) as cache_client:
             value = await cache_client.get_value(hash_key)
         if not value:
@@ -260,10 +259,9 @@ async def delete_with_key(
         self,
         key: str,
         object_class: type[Model] | None = None,
+        use_key_as_is: bool = False,
     ) -> Any:
-        object_name = object_class.__name__ if object_class else None
-        hash_key = CacheHelper.create_basic_hash_key(key, object_name)
-
+        hash_key = self._get_key_from_params(key=key, object_class=object_class, use_key_as_is=use_key_as_is)
         async with self.__get_cache_client(for_writing=True) as cache_client:
             if not await cache_client.delete_key(hash_key):
                 raise CacheRecordNotFoundError(
@@ -275,9 +273,9 @@ async def cache_record_with_key_exists(
         self,
         key: str,
         object_class: type[Model] | None = None,
+        use_key_as_is: bool = False,
     ) -> bool:
-        object_name = object_class.__name__ if object_class else None
-        hash_key = CacheHelper.create_basic_hash_key(key, object_name)
+        hash_key = self._get_key_from_params(key=key, object_class=object_class, use_key_as_is=use_key_as_is)
         async with self.__get_cache_client(for_writing=False) as cache_client:
             return bool(await cache_client.exists(hash_key))  # cache_client.exists() returns 0 or 1
 
@@ -287,3 +285,11 @@ async def is_cache_alive(self):
         """
         async with self.__get_cache_client(for_writing=False) as cache_client:
             return await cache_client.is_alive()
+
+    @staticmethod
+    def _get_key_from_params(key: str, object_class: type[Model] | None = None, use_key_as_is: bool = False) -> str:
+        if use_key_as_is:
+            return key
+        else:
+            object_name = object_class.__name__ if object_class else None
+            return CacheHelper.create_basic_hash_key(key, object_name)

tests/redis/conftest.py

@@ -23,7 +23,7 @@
 # https://pytest-asyncio.readthedocs.io/en/latest/how-to-guides/run_session_tests_in_same_loop.html
 def pytest_collection_modifyitems(items):
     pytest_asyncio_tests = (item for item in items if is_async_test(item))
-    session_scope_marker = pytest.mark.asyncio(scope="session")
+    session_scope_marker = pytest.mark.asyncio(loop_scope="session")
     for async_test in pytest_asyncio_tests:
         async_test.add_marker(session_scope_marker, append=False)
 

tests/redis/test_manager.py

@@ -2,6 +2,7 @@
 
 import pytest
 from pydantic import BaseModel
+from redis.asyncio import Redis
 
 from matter_persistence.redis.exceptions import CacheRecordNotFoundError
 from matter_persistence.redis.manager import CacheManager
@@ -66,9 +67,10 @@ async def test_cache_manager_incorrect_argument_combination():
         _ = CacheManager()
 
 
-async def test_cache_manager_save_with_key_and_get_with_key_success(cache_manager, test_dto):
-    await cache_manager.save_with_key("key", test_dto, TestDTO)
-    assert await cache_manager.get_with_key("key", TestDTO)
+@pytest.mark.parametrize("use_key_as_is", (True, False))
+async def test_cache_manager_save_with_key_and_get_with_key_success(cache_manager, test_dto, use_key_as_is: bool):
+    await cache_manager.save_with_key("key", test_dto, TestDTO, use_key_as_is=use_key_as_is)
+    assert await cache_manager.get_with_key("key", TestDTO, use_key_as_is=use_key_as_is)
 
 
 async def test_cache_manager_save_and_get_many_objects_with_keys_success(cache_manager: CacheManager) -> None:
@@ -107,18 +109,29 @@ async def test_cache_manager_save_with_key_and_get_with_key_expired(cache_manage
         await cache_manager.get_with_key("key", TestDTO)
 
 
-async def test_cache_manager_cache_record_with_key_exists(cache_manager, test_dto):
-    await cache_manager.save_with_key("key", test_dto, TestDTO)
-    assert await cache_manager.cache_record_with_key_exists("key", TestDTO)
+@pytest.mark.parametrize("use_key_as_is", (True, False))
+async def test_cache_manager_cache_record_with_key_exists(cache_manager, test_dto, use_key_as_is: bool):
+    await cache_manager.save_with_key("key", test_dto, TestDTO, use_key_as_is=use_key_as_is)
+    assert await cache_manager.cache_record_with_key_exists("key", TestDTO, use_key_as_is=use_key_as_is)
 
 
-async def test_cache_manager_delete_with_key(cache_manager):
-    await cache_manager.save_with_key("key", "value")
-    await cache_manager.delete_with_key("key")
+@pytest.mark.parametrize("use_key_as_is", (True, False))
+async def test_cache_manager_delete_with_key(cache_manager, use_key_as_is: bool):
+    await cache_manager.save_with_key("key", "value", use_key_as_is=use_key_as_is)
+    await cache_manager.delete_with_key("key", use_key_as_is=use_key_as_is)
     with pytest.raises(CacheRecordNotFoundError):
-        await cache_manager.get_with_key("key")
+        await cache_manager.get_with_key("key", use_key_as_is=use_key_as_is)
 
 
 async def test_cache_manager_set_many_with_sentinel(cache_manager_with_sentinel: CacheManager) -> None:
     await cache_manager_with_sentinel.save_with_key("test", "some_value")
     assert (await cache_manager_with_sentinel.get_with_key("test")).decode() == "some_value"
+
+
+async def test_cache_manager_use_key_as_is_works(
+    cache_manager: CacheManager, async_redis_client: Redis, test_dto: TestDTO
+) -> None:
+    key = "test.key.without.need.of.changing"
+    value = TestDTO(test_field=234)
+    await async_redis_client.set(key, value.model_dump_json())
+    assert await cache_manager.get_with_key(key=key, object_class=TestDTO, use_key_as_is=True) == value