Merge pull request #4287 from bramstroker/fix/cache-invalidatio

Fix no stale profiles are cache after library reload

Author: bramstroker

custom_components/powercalc/helpers.py

@@ -3,7 +3,7 @@
 import logging
 import os.path
 import re
-from typing import Any, NamedTuple, TypeVar
+from typing import Any, NamedTuple, TypeVar, cast
 import uuid
 
 from homeassistant.components.binary_sensor import BinarySensorDeviceClass
@@ -112,9 +112,18 @@ async def wrapper(*args: Any, **kwargs: Any) -> R:  # noqa: ANN401
         cache[cache_key] = result
         return result
 
+    cast(Any, wrapper).cache_clear = cache.clear
     return wrapper
 
 
+def clear_async_cache(func: Callable[..., Coroutine[Any, Any, Any]]) -> None:
+    """Clear a function wrapped with async_cache."""
+    target = getattr(func, "__func__", func)
+    cache_clear = getattr(target, "cache_clear", None)
+    if callable(cache_clear):
+        cache_clear()
+
+
 def collect_placeholders(data: list | str | dict[str, Any]) -> set[str]:
     found: set[str] = set()
     if isinstance(data, dict):

custom_components/powercalc/power_profile/loader/remote.py

@@ -17,7 +17,7 @@
 from homeassistant.loader import async_get_integration
 
 from custom_components.powercalc.const import API_URL, BUILT_IN_LIBRARY_DIR, DOMAIN
-from custom_components.powercalc.helpers import async_cache
+from custom_components.powercalc.helpers import async_cache, clear_async_cache
 from custom_components.powercalc.power_profile.error import LibraryLoadingError, ProfileDownloadError
 from custom_components.powercalc.power_profile.loader.protocol import Loader
 from custom_components.powercalc.power_profile.power_profile import DeviceType, DiscoveryBy
@@ -66,6 +66,7 @@ async def initialize(self) -> None:
         integration = await async_get_integration(self.hass, DOMAIN)
         powercalc_version = AwesomeVersion(str(integration.version))
 
+        self._clear_caches()
         self.library_contents = await self.load_library_json()
         self.profile_hashes = await self.hass.async_add_executor_job(self._load_profile_hashes)
 
@@ -123,6 +124,15 @@ async def initialize(self) -> None:
             self.manufacturer_models[manufacturer_name] = kept_models
             self.model_lookup[manufacturer_name] = lookup
 
+    def _clear_caches(self) -> None:
+        """Clear cached lookups backed by mutable library state."""
+        clear_async_cache(self.get_manufacturer_listing)
+        clear_async_cache(self.find_manufacturers)
+        clear_async_cache(self.get_model_listing)
+        clear_async_cache(self.find_model)
+        clear_async_cache(self.find_model_migration)
+        clear_async_cache(self.load_model)
+
     async def load_library_json(self) -> dict[str, Any]:
         """Load library.json file"""
 

tests/power_profile/loader/test_remote.py

@@ -637,6 +637,55 @@ def load_library_json() -> dict:
         assert sorted(actual_models) == expected_models
 
 
+async def test_initialize_clears_cached_library_lookups(hass: HomeAssistant) -> None:
+    first_library = {
+        "manufacturers": [
+            {
+                "name": "Test",
+                "dir_name": "test",
+                "models": [
+                    {
+                        "id": "old_model",
+                        "name": "Old Model",
+                        "device_type": "light",
+                    },
+                ],
+            },
+        ],
+    }
+    second_library = {
+        "manufacturers": [
+            {
+                "name": "Test",
+                "dir_name": "test",
+                "models": [
+                    {
+                        "id": "new_model",
+                        "name": "New Model",
+                        "device_type": "light",
+                    },
+                ],
+            },
+        ],
+    }
+
+    with patch(
+        "custom_components.powercalc.power_profile.loader.remote.RemoteLoader.load_library_json",
+        new_callable=AsyncMock,
+        side_effect=[first_library, second_library],
+    ):
+        loader = RemoteLoader(hass)
+
+        await loader.initialize()
+        assert await loader.find_model("test", {"old_model"}) == ["old_model"]
+        assert await loader.get_model_listing("test", {DeviceType.LIGHT}) == {("old_model", "Old Model")}
+
+        await loader.initialize()
+        assert await loader.find_model("test", {"old_model"}) == []
+        assert await loader.find_model("test", {"new_model"}) == ["new_model"]
+        assert await loader.get_model_listing("test", {DeviceType.LIGHT}) == {("new_model", "New Model")}
+
+
 def clear_storage_dir(storage_path: str) -> None:
     if not os.path.exists(storage_path):
         return