b4bac0f7a0
* Remove unnecessary exception re-wraps * Preserve exception chains on re-raise We slap "from cause" to almost all possible cases here. In some cases it could conceivably be better to do "from None" if we really want to hide the cause. However those should be in the minority, and "from cause" should be an improvement over the corresponding raise without a "from" in all cases anyway. The only case where we raise from None here is in plex, where the exception for an original invalid SSL cert is not the root cause for failure to validate a newly fetched one. Follow local convention on exception variable names if there is a consistent one, otherwise `err` to match with majority of codebase. * Fix mistaken re-wrap in homematicip_cloud/hap.py Missed the difference between HmipConnectionError and HmipcConnectionError. * Do not hide original error on plex new cert validation error Original is not the cause for the new one, but showing old in the traceback is useful nevertheless.
144 lines
5.1 KiB
Python
144 lines
5.1 KiB
Python
"""Provides the Toon DataUpdateCoordinator."""
|
|
import logging
|
|
import secrets
|
|
from typing import Optional
|
|
|
|
from toonapi import Status, Toon, ToonError
|
|
|
|
from homeassistant.components.webhook import (
|
|
async_register as webhook_register,
|
|
async_unregister as webhook_unregister,
|
|
)
|
|
from homeassistant.config_entries import ConfigEntry
|
|
from homeassistant.const import CONF_WEBHOOK_ID, EVENT_HOMEASSISTANT_STOP
|
|
from homeassistant.core import Event, HomeAssistant
|
|
from homeassistant.helpers.aiohttp_client import async_get_clientsession
|
|
from homeassistant.helpers.config_entry_oauth2_flow import OAuth2Session
|
|
from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
|
|
|
|
from .const import CONF_CLOUDHOOK_URL, DEFAULT_SCAN_INTERVAL, DOMAIN
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
|
|
class ToonDataUpdateCoordinator(DataUpdateCoordinator[Status]):
|
|
"""Class to manage fetching Toon data from single endpoint."""
|
|
|
|
def __init__(
|
|
self, hass: HomeAssistant, *, entry: ConfigEntry, session: OAuth2Session
|
|
):
|
|
"""Initialize global Toon data updater."""
|
|
self.session = session
|
|
self.entry = entry
|
|
|
|
async def async_token_refresh() -> str:
|
|
await session.async_ensure_token_valid()
|
|
return session.token["access_token"]
|
|
|
|
self.toon = Toon(
|
|
token=session.token["access_token"],
|
|
session=async_get_clientsession(hass),
|
|
token_refresh_method=async_token_refresh,
|
|
)
|
|
|
|
super().__init__(
|
|
hass, _LOGGER, name=DOMAIN, update_interval=DEFAULT_SCAN_INTERVAL
|
|
)
|
|
|
|
def update_listeners(self) -> None:
|
|
"""Call update on all listeners."""
|
|
for update_callback in self._listeners:
|
|
update_callback()
|
|
|
|
async def register_webhook(self, event: Optional[Event] = None) -> None:
|
|
"""Register a webhook with Toon to get live updates."""
|
|
if CONF_WEBHOOK_ID not in self.entry.data:
|
|
data = {**self.entry.data, CONF_WEBHOOK_ID: secrets.token_hex()}
|
|
self.hass.config_entries.async_update_entry(self.entry, data=data)
|
|
|
|
if self.hass.components.cloud.async_active_subscription():
|
|
|
|
if CONF_CLOUDHOOK_URL not in self.entry.data:
|
|
webhook_url = await self.hass.components.cloud.async_create_cloudhook(
|
|
self.entry.data[CONF_WEBHOOK_ID]
|
|
)
|
|
data = {**self.entry.data, CONF_CLOUDHOOK_URL: webhook_url}
|
|
self.hass.config_entries.async_update_entry(self.entry, data=data)
|
|
else:
|
|
webhook_url = self.entry.data[CONF_CLOUDHOOK_URL]
|
|
else:
|
|
webhook_url = self.hass.components.webhook.async_generate_url(
|
|
self.entry.data[CONF_WEBHOOK_ID]
|
|
)
|
|
|
|
# Ensure the webhook is not registered already
|
|
webhook_unregister(self.hass, self.entry.data[CONF_WEBHOOK_ID])
|
|
|
|
webhook_register(
|
|
self.hass,
|
|
DOMAIN,
|
|
"Toon",
|
|
self.entry.data[CONF_WEBHOOK_ID],
|
|
self.handle_webhook,
|
|
)
|
|
|
|
try:
|
|
await self.toon.subscribe_webhook(
|
|
application_id=self.entry.entry_id, url=webhook_url
|
|
)
|
|
_LOGGER.info("Registered Toon webhook: %s", webhook_url)
|
|
except ToonError as err:
|
|
_LOGGER.error("Error during webhook registration - %s", err)
|
|
|
|
self.hass.bus.async_listen_once(
|
|
EVENT_HOMEASSISTANT_STOP, self.unregister_webhook
|
|
)
|
|
|
|
async def handle_webhook(
|
|
self, hass: HomeAssistant, webhook_id: str, request
|
|
) -> None:
|
|
"""Handle webhook callback."""
|
|
try:
|
|
data = await request.json()
|
|
except ValueError:
|
|
return
|
|
|
|
_LOGGER.debug("Got webhook data: %s", data)
|
|
|
|
# Webhook expired notification, re-register
|
|
if data.get("code") == 510:
|
|
await self.register_webhook()
|
|
return
|
|
|
|
if (
|
|
"updateDataSet" not in data
|
|
or "commonName" not in data
|
|
or self.data.agreement.display_common_name != data["commonName"]
|
|
):
|
|
_LOGGER.warning("Received invalid data from Toon webhook - %s", data)
|
|
return
|
|
|
|
try:
|
|
await self.toon.update(data["updateDataSet"])
|
|
self.update_listeners()
|
|
except ToonError as err:
|
|
_LOGGER.error("Could not process data received from Toon webhook - %s", err)
|
|
|
|
async def unregister_webhook(self, event: Optional[Event] = None) -> None:
|
|
"""Remove / Unregister webhook for toon."""
|
|
_LOGGER.debug(
|
|
"Unregistering Toon webhook (%s)", self.entry.data[CONF_WEBHOOK_ID]
|
|
)
|
|
try:
|
|
await self.toon.unsubscribe_webhook(self.entry.entry_id)
|
|
except ToonError as err:
|
|
_LOGGER.error("Failed unregistering Toon webhook - %s", err)
|
|
|
|
webhook_unregister(self.hass, self.entry.data[CONF_WEBHOOK_ID])
|
|
|
|
async def _async_update_data(self) -> Status:
|
|
"""Fetch data from Toon."""
|
|
try:
|
|
return await self.toon.update()
|
|
except ToonError as error:
|
|
raise UpdateFailed(f"Invalid response from API: {error}") from error
|