Reload meta-areas on regular-area load (#511)

* added area load signal dispatcher and handler for auto-reloading meta-areas

* MA entries wont wait for HA to load anymore, still pending adding reload logic when it actually starts

* put the load notification under a check after hass is loaded

* more lint

* added throttling and delay to reload call

* being more literal with timedelta argument

* fix: Convert reload method to async and update related calls (#534)

Co-authored-by: Juicy <julien.decoen@gmail.com>

* removed await from async_schedule as it returns None which is not awaitable

* added sleep to climate test to account for race conditions, linting

* updated manifests and test shellscript

* added listener to HA start to reload, modified the entity registry reload to also consider newly created entities

* added logic on climate control test to account for async event propagation delays

* removed unnecessary dependencies from tox and split github action for parallelization

* adding version getter to lint github action

* adding version getter to lint github action

* updating tests and lint

* mark beta test as continue-on-error as it is not a blocker

* added tests for the reload logic

* linter pass on area reload test file

* added negative test cases for area reload

---------

Co-authored-by: Juicy <julien.decoen.pro@gmail.com>
Co-authored-by: Juicy <julien.decoen@gmail.com>

Author: 3 people

.github/workflows/lint.yml

@@ -28,5 +28,11 @@ jobs:
         - name: "Install requirements"
           run: python3 -m pip install -r requirements-test.txt
 
+        - name: Get latest HA stable version from PyPI
+          run: |
+            VERSIONS=$(curl -s https://pypi.org/pypi/homeassistant/json | jq -r '.releases | keys | .[]')
+            STABLE=$(echo "$VERSIONS" | grep -Ev '[a-zA-Z]' | sort -Vr | head -n1)
+            echo "HA_STABLE_VERSION=$STABLE" >> $GITHUB_ENV
+
         - name: "Run"
           run: tox -e lint

.github/workflows/pytest.yml

@@ -12,35 +12,59 @@ permissions:
   contents: read
 
 jobs:
-  test:
+  test-stable:
+    name: "Test against stable release"
     runs-on: ubuntu-latest
-
     steps:
       - uses: actions/checkout@v5
 
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
-          python-version: '3.13'
+          python-version: "3.13"
 
       - name: Install tox and jq
         run: |
           python -m pip install --upgrade pip
           pip install -r requirements-test.txt
           sudo apt-get update && sudo apt-get install -y jq
 
-      - name: Get latest HA versions from PyPI
-        id: ha_versions
+      - name: Get latest HA stable version from PyPI
         run: |
           VERSIONS=$(curl -s https://pypi.org/pypi/homeassistant/json | jq -r '.releases | keys | .[]')
           STABLE=$(echo "$VERSIONS" | grep -Ev '[a-zA-Z]' | sort -Vr | head -n1)
-          BETA=$(echo "$VERSIONS" | grep 'b' | sort -Vr | head -n1)
-
           echo "HA_STABLE_VERSION=$STABLE" >> $GITHUB_ENV
-          echo "HA_BETA_VERSION=$BETA" >> $GITHUB_ENV
 
-      - name: Run tox for both versions
-        run: tox -e ha-stable,ha-beta
+      - name: Run tox for stable
+        run: tox -e ha-stable
         env:
           HA_STABLE_VERSION: ${{ env.HA_STABLE_VERSION }}
+
+  test-beta:
+    name: "Test against beta release"
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install tox and jq
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements-test.txt
+          sudo apt-get update && sudo apt-get install -y jq
+
+      - name: Get latest HA beta version from PyPI
+        run: |
+          VERSIONS=$(curl -s https://pypi.org/pypi/homeassistant/json | jq -r '.releases | keys | .[]')
+          BETA=$(echo "$VERSIONS" | grep 'b' | sort -Vr | head -n1)
+          echo "HA_BETA_VERSION=$BETA" >> $GITHUB_ENV
+
+      - name: Run tox for beta
+        run: tox -e ha-beta
+        env:
           HA_BETA_VERSION: ${{ env.HA_BETA_VERSION }}

custom_components/magic_areas/__init__.py

@@ -35,7 +35,14 @@ async def async_setup_entry(hass: HomeAssistant, config_entry: ConfigEntry):
     """Set up the component."""
 
     @callback
-    def _async_registry_updated(
+    async def _async_reload_entry(*args, **kwargs) -> None:
+        hass.config_entries.async_update_entry(
+            config_entry,
+            data={**config_entry.data, "entity_ts": datetime.now(UTC)},
+        )
+
+    @callback
+    async def _async_registry_updated(
         event: (
             Event[EventEntityRegistryUpdatedData]
             | Event[EventDeviceRegistryUpdatedData]
@@ -61,10 +68,7 @@ def _async_registry_updated(
             "%s: Reloading entry due entity registry change",
             config_entry.data[ATTR_NAME],
         )
-        hass.config_entries.async_update_entry(
-            config_entry,
-            data={**config_entry.data, "entity_ts": datetime.now(UTC)},
-        )
+        await _async_reload_entry()
 
     async def _async_setup_integration(*args, **kwargs) -> None:
         """Load integration when Hass has finished starting."""
@@ -88,20 +92,23 @@ async def _async_setup_integration(*args, **kwargs) -> None:
         tracked_listeners.append(config_entry.add_update_listener(async_update_options))
 
         # Watch for area changes.
-        tracked_listeners.append(
-            hass.bus.async_listen(
-                EVENT_ENTITY_REGISTRY_UPDATED,
-                _async_registry_updated,
-                _entity_registry_filter,
+        if not magic_area.is_meta():
+            tracked_listeners.append(
+                hass.bus.async_listen(
+                    EVENT_ENTITY_REGISTRY_UPDATED,
+                    _async_registry_updated,
+                    magic_area.make_entity_registry_filter(),
+                )
             )
-        )
-        tracked_listeners.append(
-            hass.bus.async_listen(
-                EVENT_DEVICE_REGISTRY_UPDATED,
-                _async_registry_updated,
-                _device_registry_filter,
+            tracked_listeners.append(
+                hass.bus.async_listen(
+                    EVENT_DEVICE_REGISTRY_UPDATED,
+                    _async_registry_updated,
+                    magic_area.make_device_registry_filter(),
+                )
             )
-        )
+            # Reload once Home Assistant has finished starting to make sure we have all entities.
+            hass.bus.async_listen_once(EVENT_HOMEASSISTANT_STARTED, _async_reload_entry)
 
         hass.data[MODULE_DATA][config_entry.entry_id] = {
             DATA_AREA_OBJECT: magic_area,
@@ -115,13 +122,7 @@ async def _async_setup_integration(*args, **kwargs) -> None:
 
     hass.data.setdefault(MODULE_DATA, {})
 
-    # Wait for Hass to have started before setting up.
-    if hass.is_running:
-        hass.create_task(_async_setup_integration())
-    else:
-        hass.bus.async_listen_once(
-            EVENT_HOMEASSISTANT_STARTED, _async_setup_integration
-        )
+    await _async_setup_integration()
 
     return True
 
@@ -133,13 +134,10 @@ async def async_update_options(hass: HomeAssistant, config_entry: ConfigEntry) -
     )
     await hass.config_entries.async_reload(config_entry.entry_id)
 
-    # @TODO Reload corresponding meta areas (floor+interior/exterior+global)
-
 
 async def async_unload_entry(hass: HomeAssistant, config_entry: ConfigEntry) -> bool:
     """Unload a config entry."""
 
-    platforms_unloaded = []
     if MODULE_DATA not in hass.data:
         _LOGGER.warning(
             "Module data object for Magic Areas not found, possibly already removed."
@@ -158,17 +156,13 @@ async def async_unload_entry(hass: HomeAssistant, config_entry: ConfigEntry) ->
     area_data = data[config_entry.entry_id]
     area = area_data[DATA_AREA_OBJECT]
 
-    for platform in area.available_platforms():
-        unload_ok = await hass.config_entries.async_forward_entry_unload(
-            config_entry, platform
-        )
-        platforms_unloaded.append(unload_ok)
+    all_unloaded = await hass.config_entries.async_unload_platforms(
+        config_entry, area.available_platforms()
+    )
 
     for tracked_listener in area_data[DATA_TRACKED_LISTENERS]:
         tracked_listener()
 
-    all_unloaded = all(platforms_unloaded)
-
     if all_unloaded:
         data.pop(config_entry.entry_id)
 
@@ -212,15 +206,3 @@ async def async_migrate_entry(hass, config_entry: ConfigEntry):
     )
 
     return True
-
-
-@callback
-def _entity_registry_filter(event_data: EventEntityRegistryUpdatedData) -> bool:
-    """Filter entity registry events."""
-    return event_data["action"] == "update" and "area_id" in event_data["changes"]
-
-
-@callback
-def _device_registry_filter(event_data: EventDeviceRegistryUpdatedData) -> bool:
-    """Filter device registry events."""
-    return event_data["action"] == "update" and "area_id" in event_data["changes"]