Enhance SmartThings component subscription (#21124)
* Move to config v2 to store SmartApp oauth keys * Add migration functionality. * Regenerate refresh token on periodic basis * Fix regenerate and misc. optimizations * Review feedback * Subscription sync logic now performs a difference operation * Removed config entry reloading.
This commit is contained in:
1 parent
d9712027e8
commit
8b38b82e73
14 files changed
+529
-275
No files matched your search
@@ -14,16 +14,20 @@ from homeassistant.helpers.aiohttp_client import async_get_clientsession
|
||||
from homeassistant.helpers.dispatcher import (
|
||||
async_dispatcher_connect, async_dispatcher_send)
|
||||
from homeassistant.helpers.entity import Entity
|
||||
from homeassistant.helpers.event import async_track_time_interval
|
||||
from homeassistant.helpers.typing import ConfigType, HomeAssistantType
|
||||
|
||||
from .config_flow import SmartThingsFlowHandler # noqa
|
||||
from .const import (
|
||||
CONF_APP_ID, CONF_INSTALLED_APP_ID, DATA_BROKERS, DATA_MANAGER, DOMAIN,
|
||||
EVENT_BUTTON, SIGNAL_SMARTTHINGS_UPDATE, SUPPORTED_PLATFORMS)
|
||||
CONF_APP_ID, CONF_INSTALLED_APP_ID, CONF_OAUTH_CLIENT_ID,
|
||||
CONF_OAUTH_CLIENT_SECRET, CONF_REFRESH_TOKEN, DATA_BROKERS, DATA_MANAGER,
|
||||
DOMAIN, EVENT_BUTTON, SIGNAL_SMARTTHINGS_UPDATE, SUPPORTED_PLATFORMS,
|
||||
TOKEN_REFRESH_INTERVAL)
|
||||
from .smartapp import (
|
||||
setup_smartapp, setup_smartapp_endpoint, validate_installed_app)
|
||||
setup_smartapp, setup_smartapp_endpoint, smartapp_sync_subscriptions,
|
||||
validate_installed_app)
|
||||
|
||||
REQUIREMENTS = ['pysmartapp==0.3.0', 'pysmartthings==0.6.2']
|
||||
REQUIREMENTS = ['pysmartapp==0.3.0', 'pysmartthings==0.6.3']
|
||||
DEPENDENCIES = ['webhook']
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
@@ -35,6 +39,33 @@ async def async_setup(hass: HomeAssistantType, config: ConfigType):
|
||||
return True
|
||||
|
||||
|
||||
async def async_migrate_entry(hass: HomeAssistantType, entry: ConfigEntry):
|
||||
"""Handle migration of a previous version config entry.
|
||||
|
||||
A config entry created under a previous version must go through the
|
||||
integration setup again so we can properly retrieve the needed data
|
||||
elements. Force this by removing the entry and triggering a new flow.
|
||||
"""
|
||||
from pysmartthings import SmartThings
|
||||
|
||||
# Delete the installed app
|
||||
api = SmartThings(async_get_clientsession(hass),
|
||||
entry.data[CONF_ACCESS_TOKEN])
|
||||
await api.delete_installed_app(entry.data[CONF_INSTALLED_APP_ID])
|
||||
# Delete the entry
|
||||
hass.async_create_task(
|
||||
hass.config_entries.async_remove(entry.entry_id))
|
||||
# only create new flow if there isn't a pending one for SmartThings.
|
||||
flows = hass.config_entries.flow.async_progress()
|
||||
if not [flow for flow in flows if flow['handler'] == DOMAIN]:
|
||||
hass.async_create_task(
|
||||
hass.config_entries.flow.async_init(
|
||||
DOMAIN, context={'source': 'import'}))
|
||||
|
||||
# Return False because it could not be migrated.
|
||||
return False
|
||||
|
||||
|
||||
async def async_setup_entry(hass: HomeAssistantType, entry: ConfigEntry):
|
||||
"""Initialize config entry which represents an installed SmartApp."""
|
||||
from pysmartthings import SmartThings
|
||||
@@ -62,6 +93,14 @@ async def async_setup_entry(hass: HomeAssistantType, entry: ConfigEntry):
|
||||
installed_app = await validate_installed_app(
|
||||
api, entry.data[CONF_INSTALLED_APP_ID])
|
||||
|
||||
# Get SmartApp token to sync subscriptions
|
||||
token = await api.generate_tokens(
|
||||
entry.data[CONF_OAUTH_CLIENT_ID],
|
||||
entry.data[CONF_OAUTH_CLIENT_SECRET],
|
||||
entry.data[CONF_REFRESH_TOKEN])
|
||||
entry.data[CONF_REFRESH_TOKEN] = token.refresh_token
|
||||
hass.config_entries.async_update_entry(entry)
|
||||
|
||||
# Get devices and their current status
|
||||
devices = await api.devices(
|
||||
location_ids=[installed_app.location_id])
|
||||
@@ -71,18 +110,21 @@ async def async_setup_entry(hass: HomeAssistantType, entry: ConfigEntry):
|
||||
await device.status.refresh()
|
||||
except ClientResponseError:
|
||||
_LOGGER.debug("Unable to update status for device: %s (%s), "
|
||||
"the device will be ignored",
|
||||
"the device will be excluded",
|
||||
device.label, device.device_id, exc_info=True)
|
||||
devices.remove(device)
|
||||
|
||||
await asyncio.gather(*[retrieve_device_status(d)
|
||||
for d in devices.copy()])
|
||||
|
||||
# Sync device subscriptions
|
||||
await smartapp_sync_subscriptions(
|
||||
hass, token.access_token, installed_app.location_id,
|
||||
installed_app.installed_app_id, devices)
|
||||
|
||||
# Setup device broker
|
||||
broker = DeviceBroker(hass, devices,
|
||||
installed_app.installed_app_id)
|
||||
broker.event_handler_disconnect = \
|
||||
smart_app.connect_event(broker.event_handler)
|
||||
broker = DeviceBroker(hass, entry, token, smart_app, devices)
|
||||
broker.connect()
|
||||
hass.data[DOMAIN][DATA_BROKERS][entry.entry_id] = broker
|
||||
|
||||
except ClientResponseError as ex:
|
||||
@@ -117,8 +159,8 @@ async def async_setup_entry(hass: HomeAssistantType, entry: ConfigEntry):
|
||||
async def async_unload_entry(hass: HomeAssistantType, entry: ConfigEntry):
|
||||
"""Unload a config entry."""
|
||||
broker = hass.data[DOMAIN][DATA_BROKERS].pop(entry.entry_id, None)
|
||||
if broker and broker.event_handler_disconnect:
|
||||
broker.event_handler_disconnect()
|
||||
if broker:
|
||||
broker.disconnect()
|
||||
|
||||
tasks = [hass.config_entries.async_forward_entry_unload(entry, component)
|
||||
for component in SUPPORTED_PLATFORMS]
|
||||
@@ -128,14 +170,18 @@ async def async_unload_entry(hass: HomeAssistantType, entry: ConfigEntry):
|
||||
class DeviceBroker:
|
||||
"""Manages an individual SmartThings config entry."""
|
||||
|
||||
def __init__(self, hass: HomeAssistantType, devices: Iterable,
|
||||
installed_app_id: str):
|
||||
def __init__(self, hass: HomeAssistantType, entry: ConfigEntry,
|
||||
token, smart_app, devices: Iterable):
|
||||
"""Create a new instance of the DeviceBroker."""
|
||||
self._hass = hass
|
||||
self._installed_app_id = installed_app_id
|
||||
self.assignments = self._assign_capabilities(devices)
|
||||
self._entry = entry
|
||||
self._installed_app_id = entry.data[CONF_INSTALLED_APP_ID]
|
||||
self._smart_app = smart_app
|
||||
self._token = token
|
||||
self._event_disconnect = None
|
||||
self._regenerate_token_remove = None
|
||||
self._assignments = self._assign_capabilities(devices)
|
||||
self.devices = {device.device_id: device for device in devices}
|
||||
self.event_handler_disconnect = None
|
||||
|
||||
def _assign_capabilities(self, devices: Iterable):
|
||||
"""Assign platforms to capabilities."""
|
||||
@@ -158,17 +204,45 @@ class DeviceBroker:
|
||||
assignments[device.device_id] = slots
|
||||
return assignments
|
||||
|
||||
def connect(self):
|
||||
"""Connect handlers/listeners for device/lifecycle events."""
|
||||
# Setup interval to regenerate the refresh token on a periodic basis.
|
||||
# Tokens expire in 30 days and once expired, cannot be recovered.
|
||||
async def regenerate_refresh_token(now):
|
||||
"""Generate a new refresh token and update the config entry."""
|
||||
await self._token.refresh(
|
||||
self._entry.data[CONF_OAUTH_CLIENT_ID],
|
||||
self._entry.data[CONF_OAUTH_CLIENT_SECRET])
|
||||
self._entry.data[CONF_REFRESH_TOKEN] = self._token.refresh_token
|
||||
self._hass.config_entries.async_update_entry(self._entry)
|
||||
_LOGGER.debug('Regenerated refresh token for installed app: %s',
|
||||
self._installed_app_id)
|
||||
|
||||
self._regenerate_token_remove = async_track_time_interval(
|
||||
self._hass, regenerate_refresh_token, TOKEN_REFRESH_INTERVAL)
|
||||
|
||||
# Connect handler to incoming device events
|
||||
self._event_disconnect = \
|
||||
self._smart_app.connect_event(self._event_handler)
|
||||
|
||||
def disconnect(self):
|
||||
"""Disconnects handlers/listeners for device/lifecycle events."""
|
||||
if self._regenerate_token_remove:
|
||||
self._regenerate_token_remove()
|
||||
if self._event_disconnect:
|
||||
self._event_disconnect()
|
||||
|
||||
def get_assigned(self, device_id: str, platform: str):
|
||||
"""Get the capabilities assigned to the platform."""
|
||||
slots = self.assignments.get(device_id, {})
|
||||
slots = self._assignments.get(device_id, {})
|
||||
return [key for key, value in slots.items() if value == platform]
|
||||
|
||||
def any_assigned(self, device_id: str, platform: str):
|
||||
"""Return True if the platform has any assigned capabilities."""
|
||||
slots = self.assignments.get(device_id, {})
|
||||
slots = self._assignments.get(device_id, {})
|
||||
return any(value for value in slots.values() if value == platform)
|
||||
|
||||
async def event_handler(self, req, resp, app):
|
||||
async def _event_handler(self, req, resp, app):
|
||||
"""Broker for incoming events."""
|
||||
from pysmartapp.event import EVENT_TYPE_DEVICE
|
||||
from pysmartthings import Capability, Attribute
|
||||
|
||||
Reference in new issue
Block a user