mirror of
https://github.com/home-assistant/core.git
synced 2025-07-22 04:37:06 +00:00
Split up hassio coordinator and data into new file to allow preload (#112147)
* Split up hassio coordinator and data into new file to allow preload Since we cannot mark hassio as having a config_flow, it will not get preloaded and since cloud will almost always load right after it and block the import executor, we want to preload the hassio config_flow and platform modules so the other dependants can continue on while cloud is being imported to not delay startup * tweak * tweak
This commit is contained in:
parent
ec8d23d0af
commit
d50b4ccd62
@ -2,9 +2,8 @@
|
|||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
import asyncio
|
import asyncio
|
||||||
from collections import defaultdict
|
|
||||||
from contextlib import suppress
|
from contextlib import suppress
|
||||||
from datetime import datetime, timedelta
|
from datetime import datetime
|
||||||
import logging
|
import logging
|
||||||
import os
|
import os
|
||||||
import re
|
import re
|
||||||
@ -17,14 +16,12 @@ from homeassistant.components import panel_custom
|
|||||||
from homeassistant.components.homeassistant import async_set_stop_handler
|
from homeassistant.components.homeassistant import async_set_stop_handler
|
||||||
from homeassistant.config_entries import ConfigEntry
|
from homeassistant.config_entries import ConfigEntry
|
||||||
from homeassistant.const import (
|
from homeassistant.const import (
|
||||||
ATTR_MANUFACTURER,
|
|
||||||
ATTR_NAME,
|
ATTR_NAME,
|
||||||
EVENT_CORE_CONFIG_UPDATE,
|
EVENT_CORE_CONFIG_UPDATE,
|
||||||
HASSIO_USER_NAME,
|
HASSIO_USER_NAME,
|
||||||
Platform,
|
Platform,
|
||||||
)
|
)
|
||||||
from homeassistant.core import (
|
from homeassistant.core import (
|
||||||
CALLBACK_TYPE,
|
|
||||||
Event,
|
Event,
|
||||||
HassJob,
|
HassJob,
|
||||||
HomeAssistant,
|
HomeAssistant,
|
||||||
@ -35,24 +32,24 @@ from homeassistant.core import (
|
|||||||
from homeassistant.exceptions import HomeAssistantError
|
from homeassistant.exceptions import HomeAssistantError
|
||||||
from homeassistant.helpers import config_validation as cv, device_registry as dr
|
from homeassistant.helpers import config_validation as cv, device_registry as dr
|
||||||
from homeassistant.helpers.aiohttp_client import async_get_clientsession
|
from homeassistant.helpers.aiohttp_client import async_get_clientsession
|
||||||
from homeassistant.helpers.debounce import Debouncer
|
|
||||||
from homeassistant.helpers.device_registry import DeviceInfo
|
|
||||||
from homeassistant.helpers.event import async_call_later
|
from homeassistant.helpers.event import async_call_later
|
||||||
from homeassistant.helpers.storage import Store
|
from homeassistant.helpers.storage import Store
|
||||||
from homeassistant.helpers.typing import ConfigType
|
from homeassistant.helpers.typing import ConfigType
|
||||||
from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
|
|
||||||
from homeassistant.loader import bind_hass
|
from homeassistant.loader import bind_hass
|
||||||
from homeassistant.util.async_ import create_eager_task
|
from homeassistant.util.async_ import create_eager_task
|
||||||
from homeassistant.util.dt import now
|
from homeassistant.util.dt import now
|
||||||
|
|
||||||
|
# config_flow, and entity platforms are imported to ensure
|
||||||
|
# other dependencies that wait for hassio are not waiting
|
||||||
|
# for hassio to import its platforms
|
||||||
|
from . import binary_sensor, config_flow, sensor, update # noqa: F401
|
||||||
from .addon_manager import AddonError, AddonInfo, AddonManager, AddonState # noqa: F401
|
from .addon_manager import AddonError, AddonInfo, AddonManager, AddonState # noqa: F401
|
||||||
from .addon_panel import async_setup_addon_panel
|
from .addon_panel import async_setup_addon_panel
|
||||||
from .auth import async_setup_auth_view
|
from .auth import async_setup_auth_view
|
||||||
from .const import (
|
from .const import (
|
||||||
|
ADDONS_COORDINATOR,
|
||||||
ATTR_ADDON,
|
ATTR_ADDON,
|
||||||
ATTR_ADDONS,
|
ATTR_ADDONS,
|
||||||
ATTR_AUTO_UPDATE,
|
|
||||||
ATTR_CHANGELOG,
|
|
||||||
ATTR_COMPRESSED,
|
ATTR_COMPRESSED,
|
||||||
ATTR_FOLDERS,
|
ATTR_FOLDERS,
|
||||||
ATTR_HOMEASSISTANT,
|
ATTR_HOMEASSISTANT,
|
||||||
@ -60,26 +57,31 @@ from .const import (
|
|||||||
ATTR_INPUT,
|
ATTR_INPUT,
|
||||||
ATTR_LOCATION,
|
ATTR_LOCATION,
|
||||||
ATTR_PASSWORD,
|
ATTR_PASSWORD,
|
||||||
ATTR_REPOSITORY,
|
|
||||||
ATTR_SLUG,
|
ATTR_SLUG,
|
||||||
ATTR_STARTED,
|
DATA_CORE_INFO,
|
||||||
ATTR_STATE,
|
DATA_HOST_INFO,
|
||||||
ATTR_URL,
|
DATA_INFO,
|
||||||
ATTR_VERSION,
|
|
||||||
CONTAINER_CHANGELOG,
|
|
||||||
CONTAINER_INFO,
|
|
||||||
CONTAINER_STATS,
|
|
||||||
CORE_CONTAINER,
|
|
||||||
DATA_KEY_ADDONS,
|
|
||||||
DATA_KEY_CORE,
|
|
||||||
DATA_KEY_HOST,
|
|
||||||
DATA_KEY_OS,
|
|
||||||
DATA_KEY_SUPERVISOR,
|
|
||||||
DATA_KEY_SUPERVISOR_ISSUES,
|
DATA_KEY_SUPERVISOR_ISSUES,
|
||||||
|
DATA_OS_INFO,
|
||||||
|
DATA_STORE,
|
||||||
|
DATA_SUPERVISOR_INFO,
|
||||||
DOMAIN,
|
DOMAIN,
|
||||||
REQUEST_REFRESH_DELAY,
|
HASSIO_UPDATE_INTERVAL,
|
||||||
SUPERVISOR_CONTAINER,
|
)
|
||||||
SupervisorEntityModel,
|
from .data import (
|
||||||
|
HassioDataUpdateCoordinator,
|
||||||
|
get_addons_changelogs, # noqa: F401
|
||||||
|
get_addons_info, # noqa: F401
|
||||||
|
get_addons_stats, # noqa: F401
|
||||||
|
get_core_info, # noqa: F401
|
||||||
|
get_core_stats, # noqa: F401
|
||||||
|
get_host_info, # noqa: F401
|
||||||
|
get_info, # noqa: F401
|
||||||
|
get_issues_info, # noqa: F401
|
||||||
|
get_os_info, # noqa: F401
|
||||||
|
get_store, # noqa: F401
|
||||||
|
get_supervisor_info, # noqa: F401
|
||||||
|
get_supervisor_stats, # noqa: F401
|
||||||
)
|
)
|
||||||
from .discovery import HassioServiceInfo, async_setup_discovery_view # noqa: F401
|
from .discovery import HassioServiceInfo, async_setup_discovery_view # noqa: F401
|
||||||
from .handler import ( # noqa: F401
|
from .handler import ( # noqa: F401
|
||||||
@ -116,6 +118,9 @@ _LOGGER = logging.getLogger(__name__)
|
|||||||
|
|
||||||
STORAGE_KEY = DOMAIN
|
STORAGE_KEY = DOMAIN
|
||||||
STORAGE_VERSION = 1
|
STORAGE_VERSION = 1
|
||||||
|
# If new platforms are added, be sure to import them above
|
||||||
|
# so we do not make other components that depend on hassio
|
||||||
|
# wait for the import of the platforms
|
||||||
PLATFORMS = [Platform.BINARY_SENSOR, Platform.SENSOR, Platform.UPDATE]
|
PLATFORMS = [Platform.BINARY_SENSOR, Platform.SENSOR, Platform.UPDATE]
|
||||||
|
|
||||||
CONF_FRONTEND_REPO = "development_repo"
|
CONF_FRONTEND_REPO = "development_repo"
|
||||||
@ -125,22 +130,6 @@ CONFIG_SCHEMA = vol.Schema(
|
|||||||
extra=vol.ALLOW_EXTRA,
|
extra=vol.ALLOW_EXTRA,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
DATA_CORE_INFO = "hassio_core_info"
|
|
||||||
DATA_CORE_STATS = "hassio_core_stats"
|
|
||||||
DATA_HOST_INFO = "hassio_host_info"
|
|
||||||
DATA_STORE = "hassio_store"
|
|
||||||
DATA_INFO = "hassio_info"
|
|
||||||
DATA_OS_INFO = "hassio_os_info"
|
|
||||||
DATA_SUPERVISOR_INFO = "hassio_supervisor_info"
|
|
||||||
DATA_SUPERVISOR_STATS = "hassio_supervisor_stats"
|
|
||||||
DATA_ADDONS_CHANGELOGS = "hassio_addons_changelogs"
|
|
||||||
DATA_ADDONS_INFO = "hassio_addons_info"
|
|
||||||
DATA_ADDONS_STATS = "hassio_addons_stats"
|
|
||||||
HASSIO_UPDATE_INTERVAL = timedelta(minutes=5)
|
|
||||||
|
|
||||||
ADDONS_COORDINATOR = "hassio_addons_coordinator"
|
|
||||||
|
|
||||||
SERVICE_ADDON_START = "addon_start"
|
SERVICE_ADDON_START = "addon_start"
|
||||||
SERVICE_ADDON_STOP = "addon_stop"
|
SERVICE_ADDON_STOP = "addon_stop"
|
||||||
SERVICE_ADDON_RESTART = "addon_restart"
|
SERVICE_ADDON_RESTART = "addon_restart"
|
||||||
@ -283,126 +272,6 @@ def hostname_from_addon_slug(addon_slug: str) -> str:
|
|||||||
return addon_slug.replace("_", "-")
|
return addon_slug.replace("_", "-")
|
||||||
|
|
||||||
|
|
||||||
@callback
|
|
||||||
@bind_hass
|
|
||||||
def get_info(hass: HomeAssistant) -> dict[str, Any] | None:
|
|
||||||
"""Return generic information from Supervisor.
|
|
||||||
|
|
||||||
Async friendly.
|
|
||||||
"""
|
|
||||||
return hass.data.get(DATA_INFO)
|
|
||||||
|
|
||||||
|
|
||||||
@callback
|
|
||||||
@bind_hass
|
|
||||||
def get_host_info(hass: HomeAssistant) -> dict[str, Any] | None:
|
|
||||||
"""Return generic host information.
|
|
||||||
|
|
||||||
Async friendly.
|
|
||||||
"""
|
|
||||||
return hass.data.get(DATA_HOST_INFO)
|
|
||||||
|
|
||||||
|
|
||||||
@callback
|
|
||||||
@bind_hass
|
|
||||||
def get_store(hass: HomeAssistant) -> dict[str, Any] | None:
|
|
||||||
"""Return store information.
|
|
||||||
|
|
||||||
Async friendly.
|
|
||||||
"""
|
|
||||||
return hass.data.get(DATA_STORE)
|
|
||||||
|
|
||||||
|
|
||||||
@callback
|
|
||||||
@bind_hass
|
|
||||||
def get_supervisor_info(hass: HomeAssistant) -> dict[str, Any] | None:
|
|
||||||
"""Return Supervisor information.
|
|
||||||
|
|
||||||
Async friendly.
|
|
||||||
"""
|
|
||||||
return hass.data.get(DATA_SUPERVISOR_INFO)
|
|
||||||
|
|
||||||
|
|
||||||
@callback
|
|
||||||
@bind_hass
|
|
||||||
def get_addons_info(hass: HomeAssistant) -> dict[str, dict[str, Any]] | None:
|
|
||||||
"""Return Addons info.
|
|
||||||
|
|
||||||
Async friendly.
|
|
||||||
"""
|
|
||||||
return hass.data.get(DATA_ADDONS_INFO)
|
|
||||||
|
|
||||||
|
|
||||||
@callback
|
|
||||||
@bind_hass
|
|
||||||
def get_addons_stats(hass: HomeAssistant) -> dict[str, Any]:
|
|
||||||
"""Return Addons stats.
|
|
||||||
|
|
||||||
Async friendly.
|
|
||||||
"""
|
|
||||||
return hass.data.get(DATA_ADDONS_STATS) or {}
|
|
||||||
|
|
||||||
|
|
||||||
@callback
|
|
||||||
@bind_hass
|
|
||||||
def get_core_stats(hass: HomeAssistant) -> dict[str, Any]:
|
|
||||||
"""Return core stats.
|
|
||||||
|
|
||||||
Async friendly.
|
|
||||||
"""
|
|
||||||
return hass.data.get(DATA_CORE_STATS) or {}
|
|
||||||
|
|
||||||
|
|
||||||
@callback
|
|
||||||
@bind_hass
|
|
||||||
def get_supervisor_stats(hass: HomeAssistant) -> dict[str, Any]:
|
|
||||||
"""Return supervisor stats.
|
|
||||||
|
|
||||||
Async friendly.
|
|
||||||
"""
|
|
||||||
return hass.data.get(DATA_SUPERVISOR_STATS) or {}
|
|
||||||
|
|
||||||
|
|
||||||
@callback
|
|
||||||
@bind_hass
|
|
||||||
def get_addons_changelogs(hass: HomeAssistant):
|
|
||||||
"""Return Addons changelogs.
|
|
||||||
|
|
||||||
Async friendly.
|
|
||||||
"""
|
|
||||||
return hass.data.get(DATA_ADDONS_CHANGELOGS)
|
|
||||||
|
|
||||||
|
|
||||||
@callback
|
|
||||||
@bind_hass
|
|
||||||
def get_os_info(hass: HomeAssistant) -> dict[str, Any] | None:
|
|
||||||
"""Return OS information.
|
|
||||||
|
|
||||||
Async friendly.
|
|
||||||
"""
|
|
||||||
return hass.data.get(DATA_OS_INFO)
|
|
||||||
|
|
||||||
|
|
||||||
@callback
|
|
||||||
@bind_hass
|
|
||||||
def get_core_info(hass: HomeAssistant) -> dict[str, Any] | None:
|
|
||||||
"""Return Home Assistant Core information from Supervisor.
|
|
||||||
|
|
||||||
Async friendly.
|
|
||||||
"""
|
|
||||||
return hass.data.get(DATA_CORE_INFO)
|
|
||||||
|
|
||||||
|
|
||||||
@callback
|
|
||||||
@bind_hass
|
|
||||||
def get_issues_info(hass: HomeAssistant) -> SupervisorIssues | None:
|
|
||||||
"""Return Supervisor issues info.
|
|
||||||
|
|
||||||
Async friendly.
|
|
||||||
"""
|
|
||||||
return hass.data.get(DATA_KEY_SUPERVISOR_ISSUES)
|
|
||||||
|
|
||||||
|
|
||||||
@callback
|
@callback
|
||||||
@bind_hass
|
@bind_hass
|
||||||
def is_hassio(hass: HomeAssistant) -> bool:
|
def is_hassio(hass: HomeAssistant) -> bool:
|
||||||
@ -652,372 +521,3 @@ async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
|
|||||||
hass.data.pop(ADDONS_COORDINATOR, None)
|
hass.data.pop(ADDONS_COORDINATOR, None)
|
||||||
|
|
||||||
return unload_ok
|
return unload_ok
|
||||||
|
|
||||||
|
|
||||||
@callback
|
|
||||||
def async_register_addons_in_dev_reg(
|
|
||||||
entry_id: str, dev_reg: dr.DeviceRegistry, addons: list[dict[str, Any]]
|
|
||||||
) -> None:
|
|
||||||
"""Register addons in the device registry."""
|
|
||||||
for addon in addons:
|
|
||||||
params = DeviceInfo(
|
|
||||||
identifiers={(DOMAIN, addon[ATTR_SLUG])},
|
|
||||||
model=SupervisorEntityModel.ADDON,
|
|
||||||
sw_version=addon[ATTR_VERSION],
|
|
||||||
name=addon[ATTR_NAME],
|
|
||||||
entry_type=dr.DeviceEntryType.SERVICE,
|
|
||||||
configuration_url=f"homeassistant://hassio/addon/{addon[ATTR_SLUG]}",
|
|
||||||
)
|
|
||||||
if manufacturer := addon.get(ATTR_REPOSITORY) or addon.get(ATTR_URL):
|
|
||||||
params[ATTR_MANUFACTURER] = manufacturer
|
|
||||||
dev_reg.async_get_or_create(config_entry_id=entry_id, **params)
|
|
||||||
|
|
||||||
|
|
||||||
@callback
|
|
||||||
def async_register_os_in_dev_reg(
|
|
||||||
entry_id: str, dev_reg: dr.DeviceRegistry, os_dict: dict[str, Any]
|
|
||||||
) -> None:
|
|
||||||
"""Register OS in the device registry."""
|
|
||||||
params = DeviceInfo(
|
|
||||||
identifiers={(DOMAIN, "OS")},
|
|
||||||
manufacturer="Home Assistant",
|
|
||||||
model=SupervisorEntityModel.OS,
|
|
||||||
sw_version=os_dict[ATTR_VERSION],
|
|
||||||
name="Home Assistant Operating System",
|
|
||||||
entry_type=dr.DeviceEntryType.SERVICE,
|
|
||||||
)
|
|
||||||
dev_reg.async_get_or_create(config_entry_id=entry_id, **params)
|
|
||||||
|
|
||||||
|
|
||||||
@callback
|
|
||||||
def async_register_host_in_dev_reg(
|
|
||||||
entry_id: str,
|
|
||||||
dev_reg: dr.DeviceRegistry,
|
|
||||||
) -> None:
|
|
||||||
"""Register host in the device registry."""
|
|
||||||
params = DeviceInfo(
|
|
||||||
identifiers={(DOMAIN, "host")},
|
|
||||||
manufacturer="Home Assistant",
|
|
||||||
model=SupervisorEntityModel.HOST,
|
|
||||||
name="Home Assistant Host",
|
|
||||||
entry_type=dr.DeviceEntryType.SERVICE,
|
|
||||||
)
|
|
||||||
dev_reg.async_get_or_create(config_entry_id=entry_id, **params)
|
|
||||||
|
|
||||||
|
|
||||||
@callback
|
|
||||||
def async_register_core_in_dev_reg(
|
|
||||||
entry_id: str,
|
|
||||||
dev_reg: dr.DeviceRegistry,
|
|
||||||
core_dict: dict[str, Any],
|
|
||||||
) -> None:
|
|
||||||
"""Register OS in the device registry."""
|
|
||||||
params = DeviceInfo(
|
|
||||||
identifiers={(DOMAIN, "core")},
|
|
||||||
manufacturer="Home Assistant",
|
|
||||||
model=SupervisorEntityModel.CORE,
|
|
||||||
sw_version=core_dict[ATTR_VERSION],
|
|
||||||
name="Home Assistant Core",
|
|
||||||
entry_type=dr.DeviceEntryType.SERVICE,
|
|
||||||
)
|
|
||||||
dev_reg.async_get_or_create(config_entry_id=entry_id, **params)
|
|
||||||
|
|
||||||
|
|
||||||
@callback
|
|
||||||
def async_register_supervisor_in_dev_reg(
|
|
||||||
entry_id: str,
|
|
||||||
dev_reg: dr.DeviceRegistry,
|
|
||||||
supervisor_dict: dict[str, Any],
|
|
||||||
) -> None:
|
|
||||||
"""Register OS in the device registry."""
|
|
||||||
params = DeviceInfo(
|
|
||||||
identifiers={(DOMAIN, "supervisor")},
|
|
||||||
manufacturer="Home Assistant",
|
|
||||||
model=SupervisorEntityModel.SUPERVIOSR,
|
|
||||||
sw_version=supervisor_dict[ATTR_VERSION],
|
|
||||||
name="Home Assistant Supervisor",
|
|
||||||
entry_type=dr.DeviceEntryType.SERVICE,
|
|
||||||
)
|
|
||||||
dev_reg.async_get_or_create(config_entry_id=entry_id, **params)
|
|
||||||
|
|
||||||
|
|
||||||
@callback
|
|
||||||
def async_remove_addons_from_dev_reg(
|
|
||||||
dev_reg: dr.DeviceRegistry, addons: set[str]
|
|
||||||
) -> None:
|
|
||||||
"""Remove addons from the device registry."""
|
|
||||||
for addon_slug in addons:
|
|
||||||
if dev := dev_reg.async_get_device(identifiers={(DOMAIN, addon_slug)}):
|
|
||||||
dev_reg.async_remove_device(dev.id)
|
|
||||||
|
|
||||||
|
|
||||||
class HassioDataUpdateCoordinator(DataUpdateCoordinator): # pylint: disable=hass-enforce-coordinator-module
|
|
||||||
"""Class to retrieve Hass.io status."""
|
|
||||||
|
|
||||||
def __init__(
|
|
||||||
self, hass: HomeAssistant, config_entry: ConfigEntry, dev_reg: dr.DeviceRegistry
|
|
||||||
) -> None:
|
|
||||||
"""Initialize coordinator."""
|
|
||||||
super().__init__(
|
|
||||||
hass,
|
|
||||||
_LOGGER,
|
|
||||||
name=DOMAIN,
|
|
||||||
update_interval=HASSIO_UPDATE_INTERVAL,
|
|
||||||
# We don't want an immediate refresh since we want to avoid
|
|
||||||
# fetching the container stats right away and avoid hammering
|
|
||||||
# the Supervisor API on startup
|
|
||||||
request_refresh_debouncer=Debouncer(
|
|
||||||
hass, _LOGGER, cooldown=REQUEST_REFRESH_DELAY, immediate=False
|
|
||||||
),
|
|
||||||
)
|
|
||||||
self.hassio: HassIO = hass.data[DOMAIN]
|
|
||||||
self.data = {}
|
|
||||||
self.entry_id = config_entry.entry_id
|
|
||||||
self.dev_reg = dev_reg
|
|
||||||
self.is_hass_os = (get_info(self.hass) or {}).get("hassos") is not None
|
|
||||||
self._container_updates: defaultdict[str, dict[str, set[str]]] = defaultdict(
|
|
||||||
lambda: defaultdict(set)
|
|
||||||
)
|
|
||||||
|
|
||||||
async def _async_update_data(self) -> dict[str, Any]:
|
|
||||||
"""Update data via library."""
|
|
||||||
is_first_update = not self.data
|
|
||||||
|
|
||||||
try:
|
|
||||||
await self.force_data_refresh(is_first_update)
|
|
||||||
except HassioAPIError as err:
|
|
||||||
raise UpdateFailed(f"Error on Supervisor API: {err}") from err
|
|
||||||
|
|
||||||
new_data: dict[str, Any] = {}
|
|
||||||
supervisor_info = get_supervisor_info(self.hass) or {}
|
|
||||||
addons_info = get_addons_info(self.hass) or {}
|
|
||||||
addons_stats = get_addons_stats(self.hass)
|
|
||||||
addons_changelogs = get_addons_changelogs(self.hass)
|
|
||||||
store_data = get_store(self.hass) or {}
|
|
||||||
|
|
||||||
repositories = {
|
|
||||||
repo[ATTR_SLUG]: repo[ATTR_NAME]
|
|
||||||
for repo in store_data.get("repositories", [])
|
|
||||||
}
|
|
||||||
|
|
||||||
new_data[DATA_KEY_ADDONS] = {
|
|
||||||
addon[ATTR_SLUG]: {
|
|
||||||
**addon,
|
|
||||||
**((addons_stats or {}).get(addon[ATTR_SLUG]) or {}),
|
|
||||||
ATTR_AUTO_UPDATE: (addons_info.get(addon[ATTR_SLUG]) or {}).get(
|
|
||||||
ATTR_AUTO_UPDATE, False
|
|
||||||
),
|
|
||||||
ATTR_CHANGELOG: (addons_changelogs or {}).get(addon[ATTR_SLUG]),
|
|
||||||
ATTR_REPOSITORY: repositories.get(
|
|
||||||
addon.get(ATTR_REPOSITORY), addon.get(ATTR_REPOSITORY, "")
|
|
||||||
),
|
|
||||||
}
|
|
||||||
for addon in supervisor_info.get("addons", [])
|
|
||||||
}
|
|
||||||
if self.is_hass_os:
|
|
||||||
new_data[DATA_KEY_OS] = get_os_info(self.hass)
|
|
||||||
|
|
||||||
new_data[DATA_KEY_CORE] = {
|
|
||||||
**(get_core_info(self.hass) or {}),
|
|
||||||
**get_core_stats(self.hass),
|
|
||||||
}
|
|
||||||
new_data[DATA_KEY_SUPERVISOR] = {
|
|
||||||
**supervisor_info,
|
|
||||||
**get_supervisor_stats(self.hass),
|
|
||||||
}
|
|
||||||
new_data[DATA_KEY_HOST] = get_host_info(self.hass) or {}
|
|
||||||
|
|
||||||
# If this is the initial refresh, register all addons and return the dict
|
|
||||||
if is_first_update:
|
|
||||||
async_register_addons_in_dev_reg(
|
|
||||||
self.entry_id, self.dev_reg, new_data[DATA_KEY_ADDONS].values()
|
|
||||||
)
|
|
||||||
async_register_core_in_dev_reg(
|
|
||||||
self.entry_id, self.dev_reg, new_data[DATA_KEY_CORE]
|
|
||||||
)
|
|
||||||
async_register_supervisor_in_dev_reg(
|
|
||||||
self.entry_id, self.dev_reg, new_data[DATA_KEY_SUPERVISOR]
|
|
||||||
)
|
|
||||||
async_register_host_in_dev_reg(self.entry_id, self.dev_reg)
|
|
||||||
if self.is_hass_os:
|
|
||||||
async_register_os_in_dev_reg(
|
|
||||||
self.entry_id, self.dev_reg, new_data[DATA_KEY_OS]
|
|
||||||
)
|
|
||||||
|
|
||||||
# Remove add-ons that are no longer installed from device registry
|
|
||||||
supervisor_addon_devices = {
|
|
||||||
list(device.identifiers)[0][1]
|
|
||||||
for device in self.dev_reg.devices.values()
|
|
||||||
if self.entry_id in device.config_entries
|
|
||||||
and device.model == SupervisorEntityModel.ADDON
|
|
||||||
}
|
|
||||||
if stale_addons := supervisor_addon_devices - set(new_data[DATA_KEY_ADDONS]):
|
|
||||||
async_remove_addons_from_dev_reg(self.dev_reg, stale_addons)
|
|
||||||
|
|
||||||
if not self.is_hass_os and (
|
|
||||||
dev := self.dev_reg.async_get_device(identifiers={(DOMAIN, "OS")})
|
|
||||||
):
|
|
||||||
# Remove the OS device if it exists and the installation is not hassos
|
|
||||||
self.dev_reg.async_remove_device(dev.id)
|
|
||||||
|
|
||||||
# If there are new add-ons, we should reload the config entry so we can
|
|
||||||
# create new devices and entities. We can return an empty dict because
|
|
||||||
# coordinator will be recreated.
|
|
||||||
if self.data and set(new_data[DATA_KEY_ADDONS]) - set(
|
|
||||||
self.data[DATA_KEY_ADDONS]
|
|
||||||
):
|
|
||||||
self.hass.async_create_task(
|
|
||||||
self.hass.config_entries.async_reload(self.entry_id)
|
|
||||||
)
|
|
||||||
return {}
|
|
||||||
|
|
||||||
return new_data
|
|
||||||
|
|
||||||
async def force_info_update_supervisor(self) -> None:
|
|
||||||
"""Force update of the supervisor info."""
|
|
||||||
self.hass.data[DATA_SUPERVISOR_INFO] = await self.hassio.get_supervisor_info()
|
|
||||||
await self.async_refresh()
|
|
||||||
|
|
||||||
async def force_data_refresh(self, first_update: bool) -> None:
|
|
||||||
"""Force update of the addon info."""
|
|
||||||
container_updates = self._container_updates
|
|
||||||
|
|
||||||
data = self.hass.data
|
|
||||||
hassio = self.hassio
|
|
||||||
updates = {
|
|
||||||
DATA_INFO: hassio.get_info(),
|
|
||||||
DATA_CORE_INFO: hassio.get_core_info(),
|
|
||||||
DATA_SUPERVISOR_INFO: hassio.get_supervisor_info(),
|
|
||||||
DATA_OS_INFO: hassio.get_os_info(),
|
|
||||||
}
|
|
||||||
if CONTAINER_STATS in container_updates[CORE_CONTAINER]:
|
|
||||||
updates[DATA_CORE_STATS] = hassio.get_core_stats()
|
|
||||||
if CONTAINER_STATS in container_updates[SUPERVISOR_CONTAINER]:
|
|
||||||
updates[DATA_SUPERVISOR_STATS] = hassio.get_supervisor_stats()
|
|
||||||
|
|
||||||
results = await asyncio.gather(*updates.values())
|
|
||||||
for key, result in zip(updates, results):
|
|
||||||
data[key] = result
|
|
||||||
|
|
||||||
_addon_data = data[DATA_SUPERVISOR_INFO].get("addons", [])
|
|
||||||
all_addons: list[str] = []
|
|
||||||
started_addons: list[str] = []
|
|
||||||
for addon in _addon_data:
|
|
||||||
slug = addon[ATTR_SLUG]
|
|
||||||
all_addons.append(slug)
|
|
||||||
if addon[ATTR_STATE] == ATTR_STARTED:
|
|
||||||
started_addons.append(slug)
|
|
||||||
#
|
|
||||||
# Update add-on info if its the first update or
|
|
||||||
# there is at least one entity that needs the data.
|
|
||||||
#
|
|
||||||
# When entities are added they call async_enable_container_updates
|
|
||||||
# to enable updates for the endpoints they need via
|
|
||||||
# async_added_to_hass. This ensures that we only update
|
|
||||||
# the data for the endpoints that are needed to avoid unnecessary
|
|
||||||
# API calls since otherwise we would fetch stats for all containers
|
|
||||||
# and throw them away.
|
|
||||||
#
|
|
||||||
for data_key, update_func, enabled_key, wanted_addons, needs_first_update in (
|
|
||||||
(
|
|
||||||
DATA_ADDONS_STATS,
|
|
||||||
self._update_addon_stats,
|
|
||||||
CONTAINER_STATS,
|
|
||||||
started_addons,
|
|
||||||
False,
|
|
||||||
),
|
|
||||||
(
|
|
||||||
DATA_ADDONS_CHANGELOGS,
|
|
||||||
self._update_addon_changelog,
|
|
||||||
CONTAINER_CHANGELOG,
|
|
||||||
all_addons,
|
|
||||||
True,
|
|
||||||
),
|
|
||||||
(
|
|
||||||
DATA_ADDONS_INFO,
|
|
||||||
self._update_addon_info,
|
|
||||||
CONTAINER_INFO,
|
|
||||||
all_addons,
|
|
||||||
True,
|
|
||||||
),
|
|
||||||
):
|
|
||||||
container_data: dict[str, Any] = data.setdefault(data_key, {})
|
|
||||||
container_data.update(
|
|
||||||
dict(
|
|
||||||
await asyncio.gather(
|
|
||||||
*[
|
|
||||||
update_func(slug)
|
|
||||||
for slug in wanted_addons
|
|
||||||
if (first_update and needs_first_update)
|
|
||||||
or enabled_key in container_updates[slug]
|
|
||||||
]
|
|
||||||
)
|
|
||||||
)
|
|
||||||
)
|
|
||||||
|
|
||||||
async def _update_addon_stats(self, slug: str) -> tuple[str, dict[str, Any] | None]:
|
|
||||||
"""Update single addon stats."""
|
|
||||||
try:
|
|
||||||
stats = await self.hassio.get_addon_stats(slug)
|
|
||||||
return (slug, stats)
|
|
||||||
except HassioAPIError as err:
|
|
||||||
_LOGGER.warning("Could not fetch stats for %s: %s", slug, err)
|
|
||||||
return (slug, None)
|
|
||||||
|
|
||||||
async def _update_addon_changelog(self, slug: str) -> tuple[str, str | None]:
|
|
||||||
"""Return the changelog for an add-on."""
|
|
||||||
try:
|
|
||||||
changelog = await self.hassio.get_addon_changelog(slug)
|
|
||||||
return (slug, changelog)
|
|
||||||
except HassioAPIError as err:
|
|
||||||
_LOGGER.warning("Could not fetch changelog for %s: %s", slug, err)
|
|
||||||
return (slug, None)
|
|
||||||
|
|
||||||
async def _update_addon_info(self, slug: str) -> tuple[str, dict[str, Any] | None]:
|
|
||||||
"""Return the info for an add-on."""
|
|
||||||
try:
|
|
||||||
info = await self.hassio.get_addon_info(slug)
|
|
||||||
return (slug, info)
|
|
||||||
except HassioAPIError as err:
|
|
||||||
_LOGGER.warning("Could not fetch info for %s: %s", slug, err)
|
|
||||||
return (slug, None)
|
|
||||||
|
|
||||||
@callback
|
|
||||||
def async_enable_container_updates(
|
|
||||||
self, slug: str, entity_id: str, types: set[str]
|
|
||||||
) -> CALLBACK_TYPE:
|
|
||||||
"""Enable updates for an add-on."""
|
|
||||||
enabled_updates = self._container_updates[slug]
|
|
||||||
for key in types:
|
|
||||||
enabled_updates[key].add(entity_id)
|
|
||||||
|
|
||||||
@callback
|
|
||||||
def _remove() -> None:
|
|
||||||
for key in types:
|
|
||||||
enabled_updates[key].remove(entity_id)
|
|
||||||
|
|
||||||
return _remove
|
|
||||||
|
|
||||||
async def _async_refresh(
|
|
||||||
self,
|
|
||||||
log_failures: bool = True,
|
|
||||||
raise_on_auth_failed: bool = False,
|
|
||||||
scheduled: bool = False,
|
|
||||||
raise_on_entry_error: bool = False,
|
|
||||||
) -> None:
|
|
||||||
"""Refresh data."""
|
|
||||||
if not scheduled and not raise_on_auth_failed:
|
|
||||||
# Force refreshing updates for non-scheduled updates
|
|
||||||
# If `raise_on_auth_failed` is set, it means this is
|
|
||||||
# the first refresh and we do not want to delay
|
|
||||||
# startup or cause a timeout so we only refresh the
|
|
||||||
# updates if this is not a scheduled refresh and
|
|
||||||
# we are not doing the first refresh.
|
|
||||||
try:
|
|
||||||
await self.hassio.refresh_updates()
|
|
||||||
except HassioAPIError as err:
|
|
||||||
_LOGGER.warning("Error on Supervisor API: %s", err)
|
|
||||||
|
|
||||||
await super()._async_refresh(
|
|
||||||
log_failures, raise_on_auth_failed, scheduled, raise_on_entry_error
|
|
||||||
)
|
|
||||||
|
@ -12,8 +12,7 @@ from homeassistant.config_entries import ConfigEntry
|
|||||||
from homeassistant.core import HomeAssistant
|
from homeassistant.core import HomeAssistant
|
||||||
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
||||||
|
|
||||||
from . import ADDONS_COORDINATOR
|
from .const import ADDONS_COORDINATOR, ATTR_STARTED, ATTR_STATE, DATA_KEY_ADDONS
|
||||||
from .const import ATTR_STARTED, ATTR_STATE, DATA_KEY_ADDONS
|
|
||||||
from .entity import HassioAddonEntity
|
from .entity import HassioAddonEntity
|
||||||
|
|
||||||
|
|
||||||
|
@ -1,14 +1,11 @@
|
|||||||
"""Config flow for Home Assistant Supervisor integration."""
|
"""Config flow for Home Assistant Supervisor integration."""
|
||||||
from __future__ import annotations
|
from __future__ import annotations
|
||||||
|
|
||||||
import logging
|
|
||||||
from typing import Any
|
from typing import Any
|
||||||
|
|
||||||
from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
|
from homeassistant.config_entries import ConfigFlow, ConfigFlowResult
|
||||||
|
|
||||||
from . import DOMAIN
|
from .const import DOMAIN
|
||||||
|
|
||||||
_LOGGER = logging.getLogger(__name__)
|
|
||||||
|
|
||||||
|
|
||||||
class HassIoConfigFlow(ConfigFlow, domain=DOMAIN):
|
class HassIoConfigFlow(ConfigFlow, domain=DOMAIN):
|
||||||
|
@ -1,4 +1,5 @@
|
|||||||
"""Hass.io const variables."""
|
"""Hass.io const variables."""
|
||||||
|
from datetime import timedelta
|
||||||
from enum import StrEnum
|
from enum import StrEnum
|
||||||
|
|
||||||
DOMAIN = "hassio"
|
DOMAIN = "hassio"
|
||||||
@ -58,6 +59,22 @@ EVENT_ISSUE_REMOVED = "issue_removed"
|
|||||||
|
|
||||||
UPDATE_KEY_SUPERVISOR = "supervisor"
|
UPDATE_KEY_SUPERVISOR = "supervisor"
|
||||||
|
|
||||||
|
ADDONS_COORDINATOR = "hassio_addons_coordinator"
|
||||||
|
|
||||||
|
|
||||||
|
DATA_CORE_INFO = "hassio_core_info"
|
||||||
|
DATA_CORE_STATS = "hassio_core_stats"
|
||||||
|
DATA_HOST_INFO = "hassio_host_info"
|
||||||
|
DATA_STORE = "hassio_store"
|
||||||
|
DATA_INFO = "hassio_info"
|
||||||
|
DATA_OS_INFO = "hassio_os_info"
|
||||||
|
DATA_SUPERVISOR_INFO = "hassio_supervisor_info"
|
||||||
|
DATA_SUPERVISOR_STATS = "hassio_supervisor_stats"
|
||||||
|
DATA_ADDONS_CHANGELOGS = "hassio_addons_changelogs"
|
||||||
|
DATA_ADDONS_INFO = "hassio_addons_info"
|
||||||
|
DATA_ADDONS_STATS = "hassio_addons_stats"
|
||||||
|
HASSIO_UPDATE_INTERVAL = timedelta(minutes=5)
|
||||||
|
|
||||||
ATTR_AUTO_UPDATE = "auto_update"
|
ATTR_AUTO_UPDATE = "auto_update"
|
||||||
ATTR_VERSION = "version"
|
ATTR_VERSION = "version"
|
||||||
ATTR_VERSION_LATEST = "version_latest"
|
ATTR_VERSION_LATEST = "version_latest"
|
||||||
|
546
homeassistant/components/hassio/data.py
Normal file
546
homeassistant/components/hassio/data.py
Normal file
@ -0,0 +1,546 @@
|
|||||||
|
"""Data for Hass.io."""
|
||||||
|
from __future__ import annotations
|
||||||
|
|
||||||
|
import asyncio
|
||||||
|
from collections import defaultdict
|
||||||
|
import logging
|
||||||
|
from typing import Any
|
||||||
|
|
||||||
|
from homeassistant.config_entries import ConfigEntry
|
||||||
|
from homeassistant.const import ATTR_MANUFACTURER, ATTR_NAME
|
||||||
|
from homeassistant.core import CALLBACK_TYPE, HomeAssistant, callback
|
||||||
|
from homeassistant.helpers import device_registry as dr
|
||||||
|
from homeassistant.helpers.debounce import Debouncer
|
||||||
|
from homeassistant.helpers.device_registry import DeviceInfo
|
||||||
|
from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
|
||||||
|
from homeassistant.loader import bind_hass
|
||||||
|
|
||||||
|
from .const import (
|
||||||
|
ATTR_AUTO_UPDATE,
|
||||||
|
ATTR_CHANGELOG,
|
||||||
|
ATTR_REPOSITORY,
|
||||||
|
ATTR_SLUG,
|
||||||
|
ATTR_STARTED,
|
||||||
|
ATTR_STATE,
|
||||||
|
ATTR_URL,
|
||||||
|
ATTR_VERSION,
|
||||||
|
CONTAINER_CHANGELOG,
|
||||||
|
CONTAINER_INFO,
|
||||||
|
CONTAINER_STATS,
|
||||||
|
CORE_CONTAINER,
|
||||||
|
DATA_ADDONS_CHANGELOGS,
|
||||||
|
DATA_ADDONS_INFO,
|
||||||
|
DATA_ADDONS_STATS,
|
||||||
|
DATA_CORE_INFO,
|
||||||
|
DATA_CORE_STATS,
|
||||||
|
DATA_HOST_INFO,
|
||||||
|
DATA_INFO,
|
||||||
|
DATA_KEY_ADDONS,
|
||||||
|
DATA_KEY_CORE,
|
||||||
|
DATA_KEY_HOST,
|
||||||
|
DATA_KEY_OS,
|
||||||
|
DATA_KEY_SUPERVISOR,
|
||||||
|
DATA_KEY_SUPERVISOR_ISSUES,
|
||||||
|
DATA_OS_INFO,
|
||||||
|
DATA_STORE,
|
||||||
|
DATA_SUPERVISOR_INFO,
|
||||||
|
DATA_SUPERVISOR_STATS,
|
||||||
|
DOMAIN,
|
||||||
|
HASSIO_UPDATE_INTERVAL,
|
||||||
|
REQUEST_REFRESH_DELAY,
|
||||||
|
SUPERVISOR_CONTAINER,
|
||||||
|
SupervisorEntityModel,
|
||||||
|
)
|
||||||
|
from .handler import HassIO, HassioAPIError
|
||||||
|
from .issues import SupervisorIssues
|
||||||
|
|
||||||
|
_LOGGER = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
@callback
|
||||||
|
@bind_hass
|
||||||
|
def get_info(hass: HomeAssistant) -> dict[str, Any] | None:
|
||||||
|
"""Return generic information from Supervisor.
|
||||||
|
|
||||||
|
Async friendly.
|
||||||
|
"""
|
||||||
|
return hass.data.get(DATA_INFO)
|
||||||
|
|
||||||
|
|
||||||
|
@callback
|
||||||
|
@bind_hass
|
||||||
|
def get_host_info(hass: HomeAssistant) -> dict[str, Any] | None:
|
||||||
|
"""Return generic host information.
|
||||||
|
|
||||||
|
Async friendly.
|
||||||
|
"""
|
||||||
|
return hass.data.get(DATA_HOST_INFO)
|
||||||
|
|
||||||
|
|
||||||
|
@callback
|
||||||
|
@bind_hass
|
||||||
|
def get_store(hass: HomeAssistant) -> dict[str, Any] | None:
|
||||||
|
"""Return store information.
|
||||||
|
|
||||||
|
Async friendly.
|
||||||
|
"""
|
||||||
|
return hass.data.get(DATA_STORE)
|
||||||
|
|
||||||
|
|
||||||
|
@callback
|
||||||
|
@bind_hass
|
||||||
|
def get_supervisor_info(hass: HomeAssistant) -> dict[str, Any] | None:
|
||||||
|
"""Return Supervisor information.
|
||||||
|
|
||||||
|
Async friendly.
|
||||||
|
"""
|
||||||
|
return hass.data.get(DATA_SUPERVISOR_INFO)
|
||||||
|
|
||||||
|
|
||||||
|
@callback
|
||||||
|
@bind_hass
|
||||||
|
def get_addons_info(hass: HomeAssistant) -> dict[str, dict[str, Any]] | None:
|
||||||
|
"""Return Addons info.
|
||||||
|
|
||||||
|
Async friendly.
|
||||||
|
"""
|
||||||
|
return hass.data.get(DATA_ADDONS_INFO)
|
||||||
|
|
||||||
|
|
||||||
|
@callback
|
||||||
|
@bind_hass
|
||||||
|
def get_addons_stats(hass: HomeAssistant) -> dict[str, Any]:
|
||||||
|
"""Return Addons stats.
|
||||||
|
|
||||||
|
Async friendly.
|
||||||
|
"""
|
||||||
|
return hass.data.get(DATA_ADDONS_STATS) or {}
|
||||||
|
|
||||||
|
|
||||||
|
@callback
|
||||||
|
@bind_hass
|
||||||
|
def get_core_stats(hass: HomeAssistant) -> dict[str, Any]:
|
||||||
|
"""Return core stats.
|
||||||
|
|
||||||
|
Async friendly.
|
||||||
|
"""
|
||||||
|
return hass.data.get(DATA_CORE_STATS) or {}
|
||||||
|
|
||||||
|
|
||||||
|
@callback
|
||||||
|
@bind_hass
|
||||||
|
def get_supervisor_stats(hass: HomeAssistant) -> dict[str, Any]:
|
||||||
|
"""Return supervisor stats.
|
||||||
|
|
||||||
|
Async friendly.
|
||||||
|
"""
|
||||||
|
return hass.data.get(DATA_SUPERVISOR_STATS) or {}
|
||||||
|
|
||||||
|
|
||||||
|
@callback
|
||||||
|
@bind_hass
|
||||||
|
def get_addons_changelogs(hass: HomeAssistant):
|
||||||
|
"""Return Addons changelogs.
|
||||||
|
|
||||||
|
Async friendly.
|
||||||
|
"""
|
||||||
|
return hass.data.get(DATA_ADDONS_CHANGELOGS)
|
||||||
|
|
||||||
|
|
||||||
|
@callback
|
||||||
|
@bind_hass
|
||||||
|
def get_os_info(hass: HomeAssistant) -> dict[str, Any] | None:
|
||||||
|
"""Return OS information.
|
||||||
|
|
||||||
|
Async friendly.
|
||||||
|
"""
|
||||||
|
return hass.data.get(DATA_OS_INFO)
|
||||||
|
|
||||||
|
|
||||||
|
@callback
|
||||||
|
@bind_hass
|
||||||
|
def get_core_info(hass: HomeAssistant) -> dict[str, Any] | None:
|
||||||
|
"""Return Home Assistant Core information from Supervisor.
|
||||||
|
|
||||||
|
Async friendly.
|
||||||
|
"""
|
||||||
|
return hass.data.get(DATA_CORE_INFO)
|
||||||
|
|
||||||
|
|
||||||
|
@callback
|
||||||
|
@bind_hass
|
||||||
|
def get_issues_info(hass: HomeAssistant) -> SupervisorIssues | None:
|
||||||
|
"""Return Supervisor issues info.
|
||||||
|
|
||||||
|
Async friendly.
|
||||||
|
"""
|
||||||
|
return hass.data.get(DATA_KEY_SUPERVISOR_ISSUES)
|
||||||
|
|
||||||
|
|
||||||
|
@callback
|
||||||
|
def async_register_addons_in_dev_reg(
|
||||||
|
entry_id: str, dev_reg: dr.DeviceRegistry, addons: list[dict[str, Any]]
|
||||||
|
) -> None:
|
||||||
|
"""Register addons in the device registry."""
|
||||||
|
for addon in addons:
|
||||||
|
params = DeviceInfo(
|
||||||
|
identifiers={(DOMAIN, addon[ATTR_SLUG])},
|
||||||
|
model=SupervisorEntityModel.ADDON,
|
||||||
|
sw_version=addon[ATTR_VERSION],
|
||||||
|
name=addon[ATTR_NAME],
|
||||||
|
entry_type=dr.DeviceEntryType.SERVICE,
|
||||||
|
configuration_url=f"homeassistant://hassio/addon/{addon[ATTR_SLUG]}",
|
||||||
|
)
|
||||||
|
if manufacturer := addon.get(ATTR_REPOSITORY) or addon.get(ATTR_URL):
|
||||||
|
params[ATTR_MANUFACTURER] = manufacturer
|
||||||
|
dev_reg.async_get_or_create(config_entry_id=entry_id, **params)
|
||||||
|
|
||||||
|
|
||||||
|
@callback
|
||||||
|
def async_register_os_in_dev_reg(
|
||||||
|
entry_id: str, dev_reg: dr.DeviceRegistry, os_dict: dict[str, Any]
|
||||||
|
) -> None:
|
||||||
|
"""Register OS in the device registry."""
|
||||||
|
params = DeviceInfo(
|
||||||
|
identifiers={(DOMAIN, "OS")},
|
||||||
|
manufacturer="Home Assistant",
|
||||||
|
model=SupervisorEntityModel.OS,
|
||||||
|
sw_version=os_dict[ATTR_VERSION],
|
||||||
|
name="Home Assistant Operating System",
|
||||||
|
entry_type=dr.DeviceEntryType.SERVICE,
|
||||||
|
)
|
||||||
|
dev_reg.async_get_or_create(config_entry_id=entry_id, **params)
|
||||||
|
|
||||||
|
|
||||||
|
@callback
|
||||||
|
def async_register_host_in_dev_reg(
|
||||||
|
entry_id: str,
|
||||||
|
dev_reg: dr.DeviceRegistry,
|
||||||
|
) -> None:
|
||||||
|
"""Register host in the device registry."""
|
||||||
|
params = DeviceInfo(
|
||||||
|
identifiers={(DOMAIN, "host")},
|
||||||
|
manufacturer="Home Assistant",
|
||||||
|
model=SupervisorEntityModel.HOST,
|
||||||
|
name="Home Assistant Host",
|
||||||
|
entry_type=dr.DeviceEntryType.SERVICE,
|
||||||
|
)
|
||||||
|
dev_reg.async_get_or_create(config_entry_id=entry_id, **params)
|
||||||
|
|
||||||
|
|
||||||
|
@callback
|
||||||
|
def async_register_core_in_dev_reg(
|
||||||
|
entry_id: str,
|
||||||
|
dev_reg: dr.DeviceRegistry,
|
||||||
|
core_dict: dict[str, Any],
|
||||||
|
) -> None:
|
||||||
|
"""Register OS in the device registry."""
|
||||||
|
params = DeviceInfo(
|
||||||
|
identifiers={(DOMAIN, "core")},
|
||||||
|
manufacturer="Home Assistant",
|
||||||
|
model=SupervisorEntityModel.CORE,
|
||||||
|
sw_version=core_dict[ATTR_VERSION],
|
||||||
|
name="Home Assistant Core",
|
||||||
|
entry_type=dr.DeviceEntryType.SERVICE,
|
||||||
|
)
|
||||||
|
dev_reg.async_get_or_create(config_entry_id=entry_id, **params)
|
||||||
|
|
||||||
|
|
||||||
|
@callback
|
||||||
|
def async_register_supervisor_in_dev_reg(
|
||||||
|
entry_id: str,
|
||||||
|
dev_reg: dr.DeviceRegistry,
|
||||||
|
supervisor_dict: dict[str, Any],
|
||||||
|
) -> None:
|
||||||
|
"""Register OS in the device registry."""
|
||||||
|
params = DeviceInfo(
|
||||||
|
identifiers={(DOMAIN, "supervisor")},
|
||||||
|
manufacturer="Home Assistant",
|
||||||
|
model=SupervisorEntityModel.SUPERVIOSR,
|
||||||
|
sw_version=supervisor_dict[ATTR_VERSION],
|
||||||
|
name="Home Assistant Supervisor",
|
||||||
|
entry_type=dr.DeviceEntryType.SERVICE,
|
||||||
|
)
|
||||||
|
dev_reg.async_get_or_create(config_entry_id=entry_id, **params)
|
||||||
|
|
||||||
|
|
||||||
|
@callback
|
||||||
|
def async_remove_addons_from_dev_reg(
|
||||||
|
dev_reg: dr.DeviceRegistry, addons: set[str]
|
||||||
|
) -> None:
|
||||||
|
"""Remove addons from the device registry."""
|
||||||
|
for addon_slug in addons:
|
||||||
|
if dev := dev_reg.async_get_device(identifiers={(DOMAIN, addon_slug)}):
|
||||||
|
dev_reg.async_remove_device(dev.id)
|
||||||
|
|
||||||
|
|
||||||
|
class HassioDataUpdateCoordinator(DataUpdateCoordinator): # pylint: disable=hass-enforce-coordinator-module
|
||||||
|
"""Class to retrieve Hass.io status."""
|
||||||
|
|
||||||
|
def __init__(
|
||||||
|
self, hass: HomeAssistant, config_entry: ConfigEntry, dev_reg: dr.DeviceRegistry
|
||||||
|
) -> None:
|
||||||
|
"""Initialize coordinator."""
|
||||||
|
super().__init__(
|
||||||
|
hass,
|
||||||
|
_LOGGER,
|
||||||
|
name=DOMAIN,
|
||||||
|
update_interval=HASSIO_UPDATE_INTERVAL,
|
||||||
|
# We don't want an immediate refresh since we want to avoid
|
||||||
|
# fetching the container stats right away and avoid hammering
|
||||||
|
# the Supervisor API on startup
|
||||||
|
request_refresh_debouncer=Debouncer(
|
||||||
|
hass, _LOGGER, cooldown=REQUEST_REFRESH_DELAY, immediate=False
|
||||||
|
),
|
||||||
|
)
|
||||||
|
self.hassio: HassIO = hass.data[DOMAIN]
|
||||||
|
self.data = {}
|
||||||
|
self.entry_id = config_entry.entry_id
|
||||||
|
self.dev_reg = dev_reg
|
||||||
|
self.is_hass_os = (get_info(self.hass) or {}).get("hassos") is not None
|
||||||
|
self._container_updates: defaultdict[str, dict[str, set[str]]] = defaultdict(
|
||||||
|
lambda: defaultdict(set)
|
||||||
|
)
|
||||||
|
|
||||||
|
async def _async_update_data(self) -> dict[str, Any]:
|
||||||
|
"""Update data via library."""
|
||||||
|
is_first_update = not self.data
|
||||||
|
|
||||||
|
try:
|
||||||
|
await self.force_data_refresh(is_first_update)
|
||||||
|
except HassioAPIError as err:
|
||||||
|
raise UpdateFailed(f"Error on Supervisor API: {err}") from err
|
||||||
|
|
||||||
|
new_data: dict[str, Any] = {}
|
||||||
|
supervisor_info = get_supervisor_info(self.hass) or {}
|
||||||
|
addons_info = get_addons_info(self.hass) or {}
|
||||||
|
addons_stats = get_addons_stats(self.hass)
|
||||||
|
addons_changelogs = get_addons_changelogs(self.hass)
|
||||||
|
store_data = get_store(self.hass) or {}
|
||||||
|
|
||||||
|
repositories = {
|
||||||
|
repo[ATTR_SLUG]: repo[ATTR_NAME]
|
||||||
|
for repo in store_data.get("repositories", [])
|
||||||
|
}
|
||||||
|
|
||||||
|
new_data[DATA_KEY_ADDONS] = {
|
||||||
|
addon[ATTR_SLUG]: {
|
||||||
|
**addon,
|
||||||
|
**((addons_stats or {}).get(addon[ATTR_SLUG]) or {}),
|
||||||
|
ATTR_AUTO_UPDATE: (addons_info.get(addon[ATTR_SLUG]) or {}).get(
|
||||||
|
ATTR_AUTO_UPDATE, False
|
||||||
|
),
|
||||||
|
ATTR_CHANGELOG: (addons_changelogs or {}).get(addon[ATTR_SLUG]),
|
||||||
|
ATTR_REPOSITORY: repositories.get(
|
||||||
|
addon.get(ATTR_REPOSITORY), addon.get(ATTR_REPOSITORY, "")
|
||||||
|
),
|
||||||
|
}
|
||||||
|
for addon in supervisor_info.get("addons", [])
|
||||||
|
}
|
||||||
|
if self.is_hass_os:
|
||||||
|
new_data[DATA_KEY_OS] = get_os_info(self.hass)
|
||||||
|
|
||||||
|
new_data[DATA_KEY_CORE] = {
|
||||||
|
**(get_core_info(self.hass) or {}),
|
||||||
|
**get_core_stats(self.hass),
|
||||||
|
}
|
||||||
|
new_data[DATA_KEY_SUPERVISOR] = {
|
||||||
|
**supervisor_info,
|
||||||
|
**get_supervisor_stats(self.hass),
|
||||||
|
}
|
||||||
|
new_data[DATA_KEY_HOST] = get_host_info(self.hass) or {}
|
||||||
|
|
||||||
|
# If this is the initial refresh, register all addons and return the dict
|
||||||
|
if is_first_update:
|
||||||
|
async_register_addons_in_dev_reg(
|
||||||
|
self.entry_id, self.dev_reg, new_data[DATA_KEY_ADDONS].values()
|
||||||
|
)
|
||||||
|
async_register_core_in_dev_reg(
|
||||||
|
self.entry_id, self.dev_reg, new_data[DATA_KEY_CORE]
|
||||||
|
)
|
||||||
|
async_register_supervisor_in_dev_reg(
|
||||||
|
self.entry_id, self.dev_reg, new_data[DATA_KEY_SUPERVISOR]
|
||||||
|
)
|
||||||
|
async_register_host_in_dev_reg(self.entry_id, self.dev_reg)
|
||||||
|
if self.is_hass_os:
|
||||||
|
async_register_os_in_dev_reg(
|
||||||
|
self.entry_id, self.dev_reg, new_data[DATA_KEY_OS]
|
||||||
|
)
|
||||||
|
|
||||||
|
# Remove add-ons that are no longer installed from device registry
|
||||||
|
supervisor_addon_devices = {
|
||||||
|
list(device.identifiers)[0][1]
|
||||||
|
for device in self.dev_reg.devices.values()
|
||||||
|
if self.entry_id in device.config_entries
|
||||||
|
and device.model == SupervisorEntityModel.ADDON
|
||||||
|
}
|
||||||
|
if stale_addons := supervisor_addon_devices - set(new_data[DATA_KEY_ADDONS]):
|
||||||
|
async_remove_addons_from_dev_reg(self.dev_reg, stale_addons)
|
||||||
|
|
||||||
|
if not self.is_hass_os and (
|
||||||
|
dev := self.dev_reg.async_get_device(identifiers={(DOMAIN, "OS")})
|
||||||
|
):
|
||||||
|
# Remove the OS device if it exists and the installation is not hassos
|
||||||
|
self.dev_reg.async_remove_device(dev.id)
|
||||||
|
|
||||||
|
# If there are new add-ons, we should reload the config entry so we can
|
||||||
|
# create new devices and entities. We can return an empty dict because
|
||||||
|
# coordinator will be recreated.
|
||||||
|
if self.data and set(new_data[DATA_KEY_ADDONS]) - set(
|
||||||
|
self.data[DATA_KEY_ADDONS]
|
||||||
|
):
|
||||||
|
self.hass.async_create_task(
|
||||||
|
self.hass.config_entries.async_reload(self.entry_id)
|
||||||
|
)
|
||||||
|
return {}
|
||||||
|
|
||||||
|
return new_data
|
||||||
|
|
||||||
|
async def force_info_update_supervisor(self) -> None:
|
||||||
|
"""Force update of the supervisor info."""
|
||||||
|
self.hass.data[DATA_SUPERVISOR_INFO] = await self.hassio.get_supervisor_info()
|
||||||
|
await self.async_refresh()
|
||||||
|
|
||||||
|
async def force_data_refresh(self, first_update: bool) -> None:
|
||||||
|
"""Force update of the addon info."""
|
||||||
|
container_updates = self._container_updates
|
||||||
|
|
||||||
|
data = self.hass.data
|
||||||
|
hassio = self.hassio
|
||||||
|
updates = {
|
||||||
|
DATA_INFO: hassio.get_info(),
|
||||||
|
DATA_CORE_INFO: hassio.get_core_info(),
|
||||||
|
DATA_SUPERVISOR_INFO: hassio.get_supervisor_info(),
|
||||||
|
DATA_OS_INFO: hassio.get_os_info(),
|
||||||
|
}
|
||||||
|
if CONTAINER_STATS in container_updates[CORE_CONTAINER]:
|
||||||
|
updates[DATA_CORE_STATS] = hassio.get_core_stats()
|
||||||
|
if CONTAINER_STATS in container_updates[SUPERVISOR_CONTAINER]:
|
||||||
|
updates[DATA_SUPERVISOR_STATS] = hassio.get_supervisor_stats()
|
||||||
|
|
||||||
|
results = await asyncio.gather(*updates.values())
|
||||||
|
for key, result in zip(updates, results):
|
||||||
|
data[key] = result
|
||||||
|
|
||||||
|
_addon_data = data[DATA_SUPERVISOR_INFO].get("addons", [])
|
||||||
|
all_addons: list[str] = []
|
||||||
|
started_addons: list[str] = []
|
||||||
|
for addon in _addon_data:
|
||||||
|
slug = addon[ATTR_SLUG]
|
||||||
|
all_addons.append(slug)
|
||||||
|
if addon[ATTR_STATE] == ATTR_STARTED:
|
||||||
|
started_addons.append(slug)
|
||||||
|
#
|
||||||
|
# Update add-on info if its the first update or
|
||||||
|
# there is at least one entity that needs the data.
|
||||||
|
#
|
||||||
|
# When entities are added they call async_enable_container_updates
|
||||||
|
# to enable updates for the endpoints they need via
|
||||||
|
# async_added_to_hass. This ensures that we only update
|
||||||
|
# the data for the endpoints that are needed to avoid unnecessary
|
||||||
|
# API calls since otherwise we would fetch stats for all containers
|
||||||
|
# and throw them away.
|
||||||
|
#
|
||||||
|
for data_key, update_func, enabled_key, wanted_addons, needs_first_update in (
|
||||||
|
(
|
||||||
|
DATA_ADDONS_STATS,
|
||||||
|
self._update_addon_stats,
|
||||||
|
CONTAINER_STATS,
|
||||||
|
started_addons,
|
||||||
|
False,
|
||||||
|
),
|
||||||
|
(
|
||||||
|
DATA_ADDONS_CHANGELOGS,
|
||||||
|
self._update_addon_changelog,
|
||||||
|
CONTAINER_CHANGELOG,
|
||||||
|
all_addons,
|
||||||
|
True,
|
||||||
|
),
|
||||||
|
(
|
||||||
|
DATA_ADDONS_INFO,
|
||||||
|
self._update_addon_info,
|
||||||
|
CONTAINER_INFO,
|
||||||
|
all_addons,
|
||||||
|
True,
|
||||||
|
),
|
||||||
|
):
|
||||||
|
container_data: dict[str, Any] = data.setdefault(data_key, {})
|
||||||
|
container_data.update(
|
||||||
|
dict(
|
||||||
|
await asyncio.gather(
|
||||||
|
*[
|
||||||
|
update_func(slug)
|
||||||
|
for slug in wanted_addons
|
||||||
|
if (first_update and needs_first_update)
|
||||||
|
or enabled_key in container_updates[slug]
|
||||||
|
]
|
||||||
|
)
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
async def _update_addon_stats(self, slug: str) -> tuple[str, dict[str, Any] | None]:
|
||||||
|
"""Update single addon stats."""
|
||||||
|
try:
|
||||||
|
stats = await self.hassio.get_addon_stats(slug)
|
||||||
|
return (slug, stats)
|
||||||
|
except HassioAPIError as err:
|
||||||
|
_LOGGER.warning("Could not fetch stats for %s: %s", slug, err)
|
||||||
|
return (slug, None)
|
||||||
|
|
||||||
|
async def _update_addon_changelog(self, slug: str) -> tuple[str, str | None]:
|
||||||
|
"""Return the changelog for an add-on."""
|
||||||
|
try:
|
||||||
|
changelog = await self.hassio.get_addon_changelog(slug)
|
||||||
|
return (slug, changelog)
|
||||||
|
except HassioAPIError as err:
|
||||||
|
_LOGGER.warning("Could not fetch changelog for %s: %s", slug, err)
|
||||||
|
return (slug, None)
|
||||||
|
|
||||||
|
async def _update_addon_info(self, slug: str) -> tuple[str, dict[str, Any] | None]:
|
||||||
|
"""Return the info for an add-on."""
|
||||||
|
try:
|
||||||
|
info = await self.hassio.get_addon_info(slug)
|
||||||
|
return (slug, info)
|
||||||
|
except HassioAPIError as err:
|
||||||
|
_LOGGER.warning("Could not fetch info for %s: %s", slug, err)
|
||||||
|
return (slug, None)
|
||||||
|
|
||||||
|
@callback
|
||||||
|
def async_enable_container_updates(
|
||||||
|
self, slug: str, entity_id: str, types: set[str]
|
||||||
|
) -> CALLBACK_TYPE:
|
||||||
|
"""Enable updates for an add-on."""
|
||||||
|
enabled_updates = self._container_updates[slug]
|
||||||
|
for key in types:
|
||||||
|
enabled_updates[key].add(entity_id)
|
||||||
|
|
||||||
|
@callback
|
||||||
|
def _remove() -> None:
|
||||||
|
for key in types:
|
||||||
|
enabled_updates[key].remove(entity_id)
|
||||||
|
|
||||||
|
return _remove
|
||||||
|
|
||||||
|
async def _async_refresh(
|
||||||
|
self,
|
||||||
|
log_failures: bool = True,
|
||||||
|
raise_on_auth_failed: bool = False,
|
||||||
|
scheduled: bool = False,
|
||||||
|
raise_on_entry_error: bool = False,
|
||||||
|
) -> None:
|
||||||
|
"""Refresh data."""
|
||||||
|
if not scheduled and not raise_on_auth_failed:
|
||||||
|
# Force refreshing updates for non-scheduled updates
|
||||||
|
# If `raise_on_auth_failed` is set, it means this is
|
||||||
|
# the first refresh and we do not want to delay
|
||||||
|
# startup or cause a timeout so we only refresh the
|
||||||
|
# updates if this is not a scheduled refresh and
|
||||||
|
# we are not doing the first refresh.
|
||||||
|
try:
|
||||||
|
await self.hassio.refresh_updates()
|
||||||
|
except HassioAPIError as err:
|
||||||
|
_LOGGER.warning("Error on Supervisor API: %s", err)
|
||||||
|
|
||||||
|
await super()._async_refresh(
|
||||||
|
log_failures, raise_on_auth_failed, scheduled, raise_on_entry_error
|
||||||
|
)
|
@ -7,7 +7,6 @@ from homeassistant.helpers.device_registry import DeviceInfo
|
|||||||
from homeassistant.helpers.entity import EntityDescription
|
from homeassistant.helpers.entity import EntityDescription
|
||||||
from homeassistant.helpers.update_coordinator import CoordinatorEntity
|
from homeassistant.helpers.update_coordinator import CoordinatorEntity
|
||||||
|
|
||||||
from . import DOMAIN, HassioDataUpdateCoordinator
|
|
||||||
from .const import (
|
from .const import (
|
||||||
ATTR_SLUG,
|
ATTR_SLUG,
|
||||||
CONTAINER_STATS,
|
CONTAINER_STATS,
|
||||||
@ -17,9 +16,11 @@ from .const import (
|
|||||||
DATA_KEY_HOST,
|
DATA_KEY_HOST,
|
||||||
DATA_KEY_OS,
|
DATA_KEY_OS,
|
||||||
DATA_KEY_SUPERVISOR,
|
DATA_KEY_SUPERVISOR,
|
||||||
|
DOMAIN,
|
||||||
KEY_TO_UPDATE_TYPES,
|
KEY_TO_UPDATE_TYPES,
|
||||||
SUPERVISOR_CONTAINER,
|
SUPERVISOR_CONTAINER,
|
||||||
)
|
)
|
||||||
|
from .data import HassioDataUpdateCoordinator
|
||||||
|
|
||||||
|
|
||||||
class HassioAddonEntity(CoordinatorEntity[HassioDataUpdateCoordinator]):
|
class HassioAddonEntity(CoordinatorEntity[HassioDataUpdateCoordinator]):
|
||||||
|
@ -12,8 +12,8 @@ from homeassistant.const import PERCENTAGE, EntityCategory, UnitOfInformation
|
|||||||
from homeassistant.core import HomeAssistant
|
from homeassistant.core import HomeAssistant
|
||||||
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
||||||
|
|
||||||
from . import ADDONS_COORDINATOR
|
|
||||||
from .const import (
|
from .const import (
|
||||||
|
ADDONS_COORDINATOR,
|
||||||
ATTR_CPU_PERCENT,
|
ATTR_CPU_PERCENT,
|
||||||
ATTR_MEMORY_PERCENT,
|
ATTR_MEMORY_PERCENT,
|
||||||
ATTR_VERSION,
|
ATTR_VERSION,
|
||||||
|
@ -16,14 +16,8 @@ from homeassistant.core import HomeAssistant
|
|||||||
from homeassistant.exceptions import HomeAssistantError
|
from homeassistant.exceptions import HomeAssistantError
|
||||||
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
||||||
|
|
||||||
from . import (
|
|
||||||
ADDONS_COORDINATOR,
|
|
||||||
async_update_addon,
|
|
||||||
async_update_core,
|
|
||||||
async_update_os,
|
|
||||||
async_update_supervisor,
|
|
||||||
)
|
|
||||||
from .const import (
|
from .const import (
|
||||||
|
ADDONS_COORDINATOR,
|
||||||
ATTR_AUTO_UPDATE,
|
ATTR_AUTO_UPDATE,
|
||||||
ATTR_CHANGELOG,
|
ATTR_CHANGELOG,
|
||||||
ATTR_VERSION,
|
ATTR_VERSION,
|
||||||
@ -39,7 +33,13 @@ from .entity import (
|
|||||||
HassioOSEntity,
|
HassioOSEntity,
|
||||||
HassioSupervisorEntity,
|
HassioSupervisorEntity,
|
||||||
)
|
)
|
||||||
from .handler import HassioAPIError
|
from .handler import (
|
||||||
|
HassioAPIError,
|
||||||
|
async_update_addon,
|
||||||
|
async_update_core,
|
||||||
|
async_update_os,
|
||||||
|
async_update_supervisor,
|
||||||
|
)
|
||||||
|
|
||||||
ENTITY_DESCRIPTION = UpdateEntityDescription(
|
ENTITY_DESCRIPTION = UpdateEntityDescription(
|
||||||
name="Update",
|
name="Update",
|
||||||
|
@ -470,7 +470,7 @@ async def test_release_notes_between_versions(
|
|||||||
config_entry.add_to_hass(hass)
|
config_entry.add_to_hass(hass)
|
||||||
|
|
||||||
with patch.dict(os.environ, MOCK_ENVIRON), patch(
|
with patch.dict(os.environ, MOCK_ENVIRON), patch(
|
||||||
"homeassistant.components.hassio.get_addons_changelogs",
|
"homeassistant.components.hassio.data.get_addons_changelogs",
|
||||||
return_value={"test": "# 2.0.1\nNew updates\n# 2.0.0\nOld updates"},
|
return_value={"test": "# 2.0.1\nNew updates\n# 2.0.0\nOld updates"},
|
||||||
):
|
):
|
||||||
result = await async_setup_component(
|
result = await async_setup_component(
|
||||||
@ -506,7 +506,7 @@ async def test_release_notes_full(
|
|||||||
config_entry.add_to_hass(hass)
|
config_entry.add_to_hass(hass)
|
||||||
|
|
||||||
with patch.dict(os.environ, MOCK_ENVIRON), patch(
|
with patch.dict(os.environ, MOCK_ENVIRON), patch(
|
||||||
"homeassistant.components.hassio.get_addons_changelogs",
|
"homeassistant.components.hassio.data.get_addons_changelogs",
|
||||||
return_value={"test": "# 2.0.0\nNew updates\n# 2.0.0\nOld updates"},
|
return_value={"test": "# 2.0.0\nNew updates\n# 2.0.0\nOld updates"},
|
||||||
):
|
):
|
||||||
result = await async_setup_component(
|
result = await async_setup_component(
|
||||||
@ -542,7 +542,7 @@ async def test_not_release_notes(
|
|||||||
config_entry.add_to_hass(hass)
|
config_entry.add_to_hass(hass)
|
||||||
|
|
||||||
with patch.dict(os.environ, MOCK_ENVIRON), patch(
|
with patch.dict(os.environ, MOCK_ENVIRON), patch(
|
||||||
"homeassistant.components.hassio.get_addons_changelogs",
|
"homeassistant.components.hassio.data.get_addons_changelogs",
|
||||||
return_value={"test": None},
|
return_value={"test": None},
|
||||||
):
|
):
|
||||||
result = await async_setup_component(
|
result = await async_setup_component(
|
||||||
|
Loading…
x
Reference in New Issue
Block a user