Handle changes to source entities in generic_hygrostat helper (home-assistant#146538)

Author: emontnemery

homeassistant/components/generic_hygrostat/__init__.py

@@ -5,11 +5,18 @@
 from homeassistant.components.humidifier import HumidifierDeviceClass
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import CONF_NAME, CONF_UNIQUE_ID, Platform
-from homeassistant.core import HomeAssistant
-from homeassistant.helpers import config_validation as cv, discovery
+from homeassistant.core import Event, HomeAssistant
+from homeassistant.helpers import (
+    config_validation as cv,
+    discovery,
+    entity_registry as er,
+)
 from homeassistant.helpers.device import (
+    async_entity_id_to_device_id,
     async_remove_stale_devices_links_keep_entity_device,
 )
+from homeassistant.helpers.event import async_track_entity_registry_updated_event
+from homeassistant.helpers.helper_integration import async_handle_source_entity_changes
 from homeassistant.helpers.typing import ConfigType
 
 DOMAIN = "generic_hygrostat"
@@ -88,6 +95,54 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
         entry.options[CONF_HUMIDIFIER],
     )
 
+    def set_humidifier_entity_id_or_uuid(source_entity_id: str) -> None:
+        hass.config_entries.async_update_entry(
+            entry,
+            options={**entry.options, CONF_HUMIDIFIER: source_entity_id},
+        )
+
+    async def source_entity_removed() -> None:
+        # The source entity has been removed, we need to clean the device links.
+        async_remove_stale_devices_links_keep_entity_device(hass, entry.entry_id, None)
+
+    entry.async_on_unload(
+        # We use async_handle_source_entity_changes to track changes to the humidifer,
+        # but not the humidity sensor because the generic_hygrostat adds itself to the
+        # humidifier's device.
+        async_handle_source_entity_changes(
+            hass,
+            helper_config_entry_id=entry.entry_id,
+            set_source_entity_id_or_uuid=set_humidifier_entity_id_or_uuid,
+            source_device_id=async_entity_id_to_device_id(
+                hass, entry.options[CONF_HUMIDIFIER]
+            ),
+            source_entity_id_or_uuid=entry.options[CONF_HUMIDIFIER],
+            source_entity_removed=source_entity_removed,
+        )
+    )
+
+    async def async_sensor_updated(
+        event: Event[er.EventEntityRegistryUpdatedData],
+    ) -> None:
+        """Handle entity registry update."""
+        data = event.data
+        if data["action"] != "update":
+            return
+        if "entity_id" not in data["changes"]:
+            return
+
+        # Entity_id changed, update the config entry
+        hass.config_entries.async_update_entry(
+            entry,
+            options={**entry.options, CONF_SENSOR: data["entity_id"]},
+        )
+
+    entry.async_on_unload(
+        async_track_entity_registry_updated_event(
+            hass, entry.options[CONF_SENSOR], async_sensor_updated
+        )
+    )
+
     await hass.config_entries.async_forward_entry_setups(entry, (Platform.HUMIDIFIER,))
     entry.async_on_unload(entry.add_update_listener(config_entry_update_listener))
     return True