Improve library loading (#4188)

Author: andrew-codechimp

custom_components/battery_notes/__init__.py

@@ -190,8 +190,10 @@ async def async_setup_entry(
     async def _async_delayed_discovery(now: datetime) -> None:  # noqa: ARG001
         """Update the library and do discovery."""
         library_updater = LibraryUpdater(hass)
+
         await library_updater.copy_schema()
         await library_updater.get_library_updates(startup=True)
+        await hass.data[DATA_LIBRARY].load_libraries()
 
         if domain_config.enable_autodiscovery:
             await discovery_manager.start_discovery()

custom_components/battery_notes/library.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+import asyncio
 import json
 import logging
 import os
@@ -64,15 +65,32 @@ class Library:  # pylint: disable=too-few-public-methods
     def __init__(self, hass: HomeAssistant) -> None:
         """Init."""
         self.hass = hass
+        self._load_lock = asyncio.Lock()
+        self._is_loading = False
 
     async def load_libraries(self):
         """Load the user and default libraries."""
+        async with self._load_lock:
+            if self._is_loading:
+                _LOGGER.debug("Library already loading, skipping duplicate load")
+                return
+
+            self._is_loading = True
+            try:
+                await self._do_load_libraries()
+            finally:
+                self._is_loading = False
+
+    async def _do_load_libraries(self):
+        """Load libraries internally (must be called with lock held)."""
 
         def _load_library_json(library_file: str) -> dict[str, Any]:
             """Load library json file."""
             with open(library_file, encoding="utf-8") as file:
                 return cast(dict[str, Any], json.load(file))
 
+        new_manufacturer_devices: dict[str, list[LibraryDevice]] = {}
+
         # User Library
         domain_config = self.hass.data.get(MY_KEY)
         if domain_config and domain_config.user_library != "":
@@ -89,9 +107,9 @@ def _load_library_json(library_file: str) -> dict[str, Any]:
                 for json_device in user_json_data["devices"]:
                     library_device = LibraryDevice.from_json(json_device)
                     manufacturer = library_device.manufacturer.casefold()
-                    if manufacturer not in self._manufacturer_devices:
-                        self._manufacturer_devices[manufacturer] = []
-                    self._manufacturer_devices[manufacturer].append(library_device)
+                    if manufacturer not in new_manufacturer_devices:
+                        new_manufacturer_devices[manufacturer] = []
+                    new_manufacturer_devices[manufacturer].append(library_device)
                 _LOGGER.debug("Loaded %s user devices", len(user_json_data["devices"]))
 
             except FileNotFoundError:
@@ -115,6 +133,12 @@ def _load_library_json(library_file: str) -> dict[str, Any]:
                         "User library file not found at %s",
                         json_user_path,
                     )
+            except (json.JSONDecodeError, KeyError, ValueError) as err:
+                _LOGGER.error(
+                    "Failed to parse user library file at %s: %s",
+                    json_user_path,
+                    err,
+                )
 
         # Default Library
         json_default_path = self.hass.config.path(
@@ -130,18 +154,26 @@ def _load_library_json(library_file: str) -> dict[str, Any]:
             for json_device in default_json_data["devices"]:
                 library_device = LibraryDevice.from_json(json_device)
                 manufacturer = library_device.manufacturer.casefold()
-                if manufacturer not in self._manufacturer_devices:
-                    self._manufacturer_devices[manufacturer] = []
-                self._manufacturer_devices[manufacturer].append(library_device)
+                if manufacturer not in new_manufacturer_devices:
+                    new_manufacturer_devices[manufacturer] = []
+                new_manufacturer_devices[manufacturer].append(library_device)
             _LOGGER.debug(
                 "Loaded %s default devices", len(default_json_data[LIBRARY_DEVICES])
             )
 
+            self._manufacturer_devices = new_manufacturer_devices
+
         except FileNotFoundError:
             _LOGGER.error(
                 "library.json file not found at %s",
                 json_default_path,
             )
+        except (json.JSONDecodeError, KeyError, ValueError) as err:
+            _LOGGER.error(
+                "Failed to parse library file at %s: %s",
+                json_default_path,
+                err,
+            )
 
     async def get_device_battery_details(
         self,
@@ -159,6 +191,7 @@ async def get_device_battery_details(
         # device_to_find = ModelInfo("Philips", "Hue dimmer switch (929002398602)", None, None)
         # device_to_find = ModelInfo("Philips", "Hue dimmer switch", "929002398602", None)
         # device_to_find = ModelInfo("Philips", "Hue dimmer switch", "929002398602", "1")
+        # device_to_find = ModelInfo("LUMI", "lumi.sensor_magnet.aq2", None, None)
 
         # Get all devices matching manufacturer & model
         matching_devices = None
@@ -215,7 +248,8 @@ async def get_device_battery_details(
     @property
     def is_loaded(self) -> bool:
         """Library loaded successfully."""
-        return bool(self._manufacturer_devices)
+
+        return bool(self._manufacturer_devices) and not self._is_loading
 
     def device_basic_match(
         self, library_device: LibraryDevice, device_to_find: ModelInfo

custom_components/battery_notes/library_updater.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+import asyncio
 import json
 import logging
 import os
@@ -52,6 +53,7 @@ class LibraryUpdater:
     def __init__(self, hass: HomeAssistant):
         """Initialize the library updater."""
         self.hass = hass
+        self._update_lock = asyncio.Lock()
 
         domain_config = self.hass.data.get(MY_KEY)
         if not domain_config:
@@ -91,6 +93,11 @@ async def timer_update(self, now: datetime) -> None:  # noqa: ARG002
     @callback
     async def get_library_updates(self, startup: bool = False) -> None:
         """Make a call to get the latest library.json."""
+        async with self._update_lock:
+            await self._do_get_library_updates(startup)
+
+    async def _do_get_library_updates(self, startup: bool = False) -> None:
+        """Get library updates internally (must be called with lock held)."""
 
         def _update_library_json(library_file: str, content: str) -> None:
             os.makedirs(os.path.dirname(library_file), exist_ok=True)