Fall back to polling if webhook cannot be registered on Nuki (#91013)

fix(nuki): throw warning if webhook cannot be created

homeassistant/components/nuki/__init__.py

@@ -25,7 +25,6 @@
     Platform,
 )
 from homeassistant.core import Event, HomeAssistant
-from homeassistant.exceptions import ConfigEntryNotReady
 from homeassistant.helpers import (
     device_registry as dr,
     entity_registry as er,
@@ -47,7 +46,7 @@
     DOMAIN,
     ERROR_STATES,
 )
-from .helpers import parse_id
+from .helpers import NukiWebhookException, parse_id
 
 _NukiDeviceT = TypeVar("_NukiDeviceT", bound=NukiDevice)
 
@@ -61,71 +60,10 @@ def _get_bridge_devices(bridge: NukiBridge) -> tuple[list[NukiLock], list[NukiOp
     return bridge.locks, bridge.openers
 
 
-def _register_webhook(bridge: NukiBridge, entry_id: str, url: str) -> bool:
-    # Register HA URL as webhook if not already
-    callbacks = bridge.callback_list()
-    for item in callbacks["callbacks"]:
-        if entry_id in item["url"]:
-            if item["url"] == url:
-                return True
-            bridge.callback_remove(item["id"])
-
-    if bridge.callback_add(url)["success"]:
-        return True
-
-    return False
-
-
-def _remove_webhook(bridge: NukiBridge, entry_id: str) -> None:
-    # Remove webhook if set
-    callbacks = bridge.callback_list()
-    for item in callbacks["callbacks"]:
-        if entry_id in item["url"]:
-            bridge.callback_remove(item["id"])
-
-
-async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
-    """Set up the Nuki entry."""
-
-    hass.data.setdefault(DOMAIN, {})
-
-    # Migration of entry unique_id
-    if isinstance(entry.unique_id, int):
-        new_id = parse_id(entry.unique_id)
-        params = {"unique_id": new_id}
-        if entry.title == entry.unique_id:
-            params["title"] = new_id
-        hass.config_entries.async_update_entry(entry, **params)
-
-    try:
-        bridge = await hass.async_add_executor_job(
-            NukiBridge,
-            entry.data[CONF_HOST],
-            entry.data[CONF_TOKEN],
-            entry.data[CONF_PORT],
-            True,
-            DEFAULT_TIMEOUT,
-        )
-
-        locks, openers = await hass.async_add_executor_job(_get_bridge_devices, bridge)
-    except InvalidCredentialsException as err:
-        raise exceptions.ConfigEntryAuthFailed from err
-    except RequestException as err:
-        raise exceptions.ConfigEntryNotReady from err
-
-    # Device registration for the bridge
-    info = bridge.info()
-    bridge_id = parse_id(info["ids"]["hardwareId"])
-    dev_reg = dr.async_get(hass)
-    dev_reg.async_get_or_create(
-        config_entry_id=entry.entry_id,
-        identifiers={(DOMAIN, bridge_id)},
-        manufacturer="Nuki Home Solutions GmbH",
-        name=f"Nuki Bridge {bridge_id}",
-        model="Hardware Bridge",
-        sw_version=info["versions"]["firmwareVersion"],
-    )
-
+async def _create_webhook(
+    hass: HomeAssistant, entry: ConfigEntry, bridge: NukiBridge
+) -> None:
+    # Create HomeAssistant webhook
     async def handle_webhook(
         hass: HomeAssistant, webhook_id: str, request: web.Request
     ) -> web.Response:
@@ -163,7 +101,7 @@ async def handle_webhook(
         )
     except NoURLAvailableError:
         webhook.async_unregister(hass, entry.entry_id)
-        raise ConfigEntryNotReady(
+        raise NukiWebhookException(
             f"Error registering URL for webhook {entry.entry_id}: "
             "HomeAssistant URL is not available"
         ) from None
@@ -193,13 +131,86 @@ async def handle_webhook(
                 )
         except InvalidCredentialsException as err:
             webhook.async_unregister(hass, entry.entry_id)
-            raise ConfigEntryNotReady(f"Invalid credentials for Bridge: {err}") from err
+            raise NukiWebhookException(
+                f"Invalid credentials for Bridge: {err}"
+            ) from err
         except RequestException as err:
             webhook.async_unregister(hass, entry.entry_id)
-            raise ConfigEntryNotReady(
+            raise NukiWebhookException(
                 f"Error communicating with Bridge: {err}"
             ) from err
 
+
+def _register_webhook(bridge: NukiBridge, entry_id: str, url: str) -> bool:
+    # Register HA URL as webhook if not already
+    callbacks = bridge.callback_list()
+    for item in callbacks["callbacks"]:
+        if entry_id in item["url"]:
+            if item["url"] == url:
+                return True
+            bridge.callback_remove(item["id"])
+
+    if bridge.callback_add(url)["success"]:
+        return True
+
+    return False
+
+
+def _remove_webhook(bridge: NukiBridge, entry_id: str) -> None:
+    # Remove webhook if set
+    callbacks = bridge.callback_list()
+    for item in callbacks["callbacks"]:
+        if entry_id in item["url"]:
+            bridge.callback_remove(item["id"])
+
+
+async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
+    """Set up the Nuki entry."""
+
+    hass.data.setdefault(DOMAIN, {})
+
+    # Migration of entry unique_id
+    if isinstance(entry.unique_id, int):
+        new_id = parse_id(entry.unique_id)
+        params = {"unique_id": new_id}
+        if entry.title == entry.unique_id:
+            params["title"] = new_id
+        hass.config_entries.async_update_entry(entry, **params)
+
+    try:
+        bridge = await hass.async_add_executor_job(
+            NukiBridge,
+            entry.data[CONF_HOST],
+            entry.data[CONF_TOKEN],
+            entry.data[CONF_PORT],
+            True,
+            DEFAULT_TIMEOUT,
+        )
+
+        locks, openers = await hass.async_add_executor_job(_get_bridge_devices, bridge)
+    except InvalidCredentialsException as err:
+        raise exceptions.ConfigEntryAuthFailed from err
+    except RequestException as err:
+        raise exceptions.ConfigEntryNotReady from err
+
+    # Device registration for the bridge
+    info = bridge.info()
+    bridge_id = parse_id(info["ids"]["hardwareId"])
+    dev_reg = dr.async_get(hass)
+    dev_reg.async_get_or_create(
+        config_entry_id=entry.entry_id,
+        identifiers={(DOMAIN, bridge_id)},
+        manufacturer="Nuki Home Solutions GmbH",
+        name=f"Nuki Bridge {bridge_id}",
+        model="Hardware Bridge",
+        sw_version=info["versions"]["firmwareVersion"],
+    )
+
+    try:
+        await _create_webhook(hass, entry, bridge)
+    except NukiWebhookException as err:
+        _LOGGER.warning("Error registering HomeAssistant webhook: %s", err)
+
     async def _stop_nuki(_: Event):
         """Stop and remove the Nuki webhook."""
         webhook.async_unregister(hass, entry.entry_id)

homeassistant/components/nuki/helpers.py

@@ -13,3 +13,7 @@ class CannotConnect(exceptions.HomeAssistantError):
 
 class InvalidAuth(exceptions.HomeAssistantError):
     """Error to indicate there is invalid auth."""
+
+
+class NukiWebhookException(exceptions.HomeAssistantError):
+    """Error to indicate there was an issue with the webhook."""