jeans/supervisor
1
0
Fork 0
mirror of https://github.com/home-assistant/supervisor.git synced 2025-11-16 06:20:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

Optimize API connection handling by removing redundant port checks (#6212)

Browse Source 
* Simplify ensure_access_token

Make the caller of ensure_access_token responsible for connection error
handling. This is especially useful for API connection checks, as it
avoids an extra call to the API (if we fail to connect when refreshing
the token there is no point in calling the API to check if it is up).
Document the change in the docstring.

Also avoid the overhead of creating a Job object. We can simply use an
asyncio.Lock() to ensure only one coroutine is refreshing the token at
a time. This also avoids Job interference in Exception handling.

* Remove check_port from API checks

Remove check_port usage from Home Assistant API connection checks.
Simply rely on errors raised from actual connection attempts. During a
Supervisor startup when Home Assistant Core is running (e.g. after a
Supervisor update) we make about 10 successful API checks. The old code
path did a port check and then a connection check, causing two socket
creation. The new code without the separate port check safes 10 socket
creations per startup (the aiohttp connections are reused, hence do not
cause only one socket creation).

* Log API exceptions on call site

Since make_request is no longer logging API exceptions on its own, we
need to log them where we call make_request. This approach gives the
user more context about what Supervisor was trying to do when the error
happened.

* Avoid unnecessary nesting

* Improve error when ingress panel update fails

* Add comment about fast path
This commit is contained in:
Stefan Agner
2025-10-02 08:54:50 +02:00
committed by GitHub
parent 3c5f4920a0
commit 5779b567f1
9 changed files with 96 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
supervisor/addons/addon.py
View File

@@ -72,7 +72,6 @@ from ..exceptions import (
AddonsJobError,
ConfigurationFileError,
DockerError,
HomeAssistantAPIError,
HostAppArmorError,
)
from ..hardware.data import Device
@@ -842,8 +841,7 @@ class Addon(AddonModel):
# Cleanup Ingress panel from sidebar
if self.ingress_panel:
self.ingress_panel = False
with suppress(HomeAssistantAPIError):
await self.sys_ingress.update_hass_panel(self)
await self.sys_ingress.update_hass_panel(self)
# Cleanup Ingress dynamic port assignment
need_ingress_token_cleanup = False

4
supervisor/addons/manager.py
View File

@@ -20,7 +20,6 @@ from ..exceptions import (
CoreDNSError,
DockerError,
HassioError,
HomeAssistantAPIError,
)
from ..jobs.decorator import Job, JobCondition
from ..resolution.const import ContextType, IssueType, SuggestionType
@@ -351,8 +350,7 @@ class AddonManager(CoreSysAttributes):
# Update ingress
if had_ingress != addon.ingress_panel:
await self.sys_ingress.reload()
with suppress(HomeAssistantAPIError):
await self.sys_ingress.update_hass_panel(addon)
await self.sys_ingress.update_hass_panel(addon)
return wait_for_start

8
supervisor/api/proxy.py
View File

@@ -77,10 +77,10 @@ class APIProxy(CoreSysAttributes):
yield resp
return
except HomeAssistantAuthError:
_LOGGER.error("Authenticate error on API for request %s", path)
except HomeAssistantAPIError:
_LOGGER.error("Error on API for request %s", path)
except HomeAssistantAuthError as err:
_LOGGER.error("Authenticate error on API for request %s: %s", path, err)
except HomeAssistantAPIError as err:
_LOGGER.error("Error on API for request %s: %s", path, err)
except aiohttp.ClientError as err:
_LOGGER.error("Client error on API %s request %s", path, err)
except TimeoutError:

8
supervisor/auth.py
View File

@@ -132,8 +132,8 @@ class Auth(FileConfiguration, CoreSysAttributes):
_LOGGER.warning("Unauthorized login for '%s'", username)
await self._dismatch_cache(username, password)
return False
except HomeAssistantAPIError:
_LOGGER.error("Can't request auth on Home Assistant!")
except HomeAssistantAPIError as err:
_LOGGER.error("Can't request auth on Home Assistant: %s", err)
finally:
self._running.pop(username, None)
@@ -152,8 +152,8 @@ class Auth(FileConfiguration, CoreSysAttributes):
return
_LOGGER.warning("The user '%s' is not registered", username)
except HomeAssistantAPIError:
_LOGGER.error("Can't request password reset on Home Assistant!")
except HomeAssistantAPIError as err:
_LOGGER.error("Can't request password reset on Home Assistant: %s", err)
raise AuthPasswordResetError()

7
supervisor/discovery/__init__.py
View File

@@ -2,7 +2,6 @@
from __future__ import annotations
from contextlib import suppress
import logging
from typing import TYPE_CHECKING, Any
from uuid import uuid4
@@ -119,7 +118,7 @@ class Discovery(CoreSysAttributes, FileConfiguration):
data = attr.asdict(message)
data.pop(ATTR_CONFIG)
with suppress(HomeAssistantAPIError):
try:
async with self.sys_homeassistant.api.make_request(
command,
f"api/hassio_push/discovery/{message.uuid}",
@@ -128,5 +127,5 @@ class Discovery(CoreSysAttributes, FileConfiguration):
):
_LOGGER.info("Discovery %s message send", message.uuid)
return
_LOGGER.warning("Discovery %s message fail", message.uuid)
except HomeAssistantAPIError as err:
_LOGGER.error("Discovery %s message failed: %s", message.uuid, err)

96
supervisor/homeassistant/api.py
View File

@@ -2,7 +2,7 @@
import asyncio
from collections.abc import AsyncIterator
from contextlib import asynccontextmanager, suppress
from contextlib import asynccontextmanager
from dataclasses import dataclass
from datetime import UTC, datetime, timedelta
import logging
@@ -15,9 +15,7 @@ from multidict import MultiMapping
from ..coresys import CoreSys, CoreSysAttributes
from ..exceptions import HomeAssistantAPIError, HomeAssistantAuthError
from ..jobs.const import JobConcurrency
from ..jobs.decorator import Job
from ..utils import check_port, version_is_new_enough
from ..utils import version_is_new_enough
from .const import LANDINGPAGE
_LOGGER: logging.Logger = logging.getLogger(__name__)
@@ -43,14 +41,19 @@ class HomeAssistantAPI(CoreSysAttributes):
# We don't persist access tokens. Instead we fetch new ones when needed
self.access_token: str | None = None
self._access_token_expires: datetime | None = None
self._token_lock: asyncio.Lock = asyncio.Lock()
@Job(
name="home_assistant_api_ensure_access_token",
internal=True,
concurrency=JobConcurrency.QUEUE,
)
async def ensure_access_token(self) -> None:
"""Ensure there is an access token."""
"""Ensure there is a valid access token.
Raises:
HomeAssistantAuthError: When we cannot get a valid token
aiohttp.ClientError: On network or connection errors
TimeoutError: On request timeouts
"""
# Fast path check without lock (avoid unnecessary locking
# for the majority of calls).
if (
self.access_token
and self._access_token_expires
@@ -58,7 +61,15 @@ class HomeAssistantAPI(CoreSysAttributes):
):
return
with suppress(asyncio.TimeoutError, aiohttp.ClientError):
async with self._token_lock:
# Double-check after acquiring lock (avoid race condition)
if (
self.access_token
and self._access_token_expires
and self._access_token_expires > datetime.now(tz=UTC)
):
return
async with self.sys_websession.post(
f"{self.sys_homeassistant.api_url}/auth/token",
timeout=aiohttp.ClientTimeout(total=30),
@@ -92,7 +103,36 @@ class HomeAssistantAPI(CoreSysAttributes):
params: MultiMapping[str] | None = None,
headers: dict[str, str] | None = None,
) -> AsyncIterator[aiohttp.ClientResponse]:
"""Async context manager to make a request with right auth."""
"""Async context manager to make authenticated requests to Home Assistant API.
This context manager handles authentication token management automatically,
including token refresh on 401 responses. It yields the HTTP response
for the caller to handle.
Error Handling:
- HTTP error status codes (4xx, 5xx) are preserved in the response
- Authentication is handled transparently with one retry on 401
- Network/connection failures raise HomeAssistantAPIError
- No logging is performed - callers should handle logging as needed
Args:
method: HTTP method (get, post, etc.)
path: API path relative to Home Assistant base URL
json: JSON data to send in request body
content_type: Override content-type header
data: Raw data to send in request body
timeout: Request timeout in seconds
params: URL query parameters
headers: Additional HTTP headers
Yields:
aiohttp.ClientResponse: The HTTP response object
Raises:
HomeAssistantAPIError: When request cannot be completed due to
network errors, timeouts, or connection failures
"""
url = f"{self.sys_homeassistant.api_url}/{path}"
headers = headers or {}
@@ -101,10 +141,9 @@ class HomeAssistantAPI(CoreSysAttributes):
headers[hdrs.CONTENT_TYPE] = content_type
for _ in (1, 2):
await self.ensure_access_token()
headers[hdrs.AUTHORIZATION] = f"Bearer {self.access_token}"
try:
await self.ensure_access_token()
headers[hdrs.AUTHORIZATION] = f"Bearer {self.access_token}"
async with getattr(self.sys_websession, method)(
url,
data=data,
@@ -120,23 +159,19 @@ class HomeAssistantAPI(CoreSysAttributes):
continue
yield resp
return
except TimeoutError:
_LOGGER.error("Timeout on call %s.", url)
break
except TimeoutError as err:
_LOGGER.debug("Timeout on call %s.", url)
raise HomeAssistantAPIError(str(err)) from err
except aiohttp.ClientError as err:
_LOGGER.error("Error on call %s: %s", url, err)
break
raise HomeAssistantAPIError()
_LOGGER.debug("Error on call %s: %s", url, err)
raise HomeAssistantAPIError(str(err)) from err
async def _get_json(self, path: str) -> dict[str, Any]:
"""Return Home Assistant get API."""
async with self.make_request("get", path) as resp:
if resp.status in (200, 201):
return await resp.json()
else:
_LOGGER.debug("Home Assistant API return: %d", resp.status)
raise HomeAssistantAPIError()
raise HomeAssistantAPIError(f"Home Assistant Core API return {resp.status}")
async def get_config(self) -> dict[str, Any]:
"""Return Home Assistant config."""
@@ -155,15 +190,8 @@ class HomeAssistantAPI(CoreSysAttributes):
):
return None
# Check if port is up
if not await check_port(
self.sys_homeassistant.ip_address,
self.sys_homeassistant.api_port,
):
return None
# Check if API is up
with suppress(HomeAssistantAPIError):
try:
# get_core_state is available since 2023.8.0 and preferred
# since it is significantly faster than get_config because
# it does not require serializing the entire config
@@ -181,6 +209,8 @@ class HomeAssistantAPI(CoreSysAttributes):
migrating = recorder_state.get("migration_in_progress", False)
live_migration = recorder_state.get("migration_is_live", False)
return APIState(state, migrating and not live_migration)
except HomeAssistantAPIError as err:
_LOGGER.debug("Can't connect to Home Assistant API: %s", err)
return None

4
supervisor/homeassistant/websocket.py
View File

@@ -3,6 +3,7 @@
from __future__ import annotations
import asyncio
from contextlib import suppress
import logging
from typing import Any, TypeVar, cast
@@ -202,7 +203,8 @@ class HomeAssistantWebSocket(CoreSysAttributes):
if self._client is not None and self._client.connected:
return self._client
await self.sys_homeassistant.api.ensure_access_token()
with suppress(asyncio.TimeoutError, aiohttp.ClientError):
await self.sys_homeassistant.api.ensure_access_token()
client = await WSClient.connect_with_auth(
self.sys_websession,
self.sys_loop,

24
supervisor/ingress.py
View File

@@ -15,6 +15,7 @@ from .const import (
IngressSessionDataDict,
)
from .coresys import CoreSys, CoreSysAttributes
from .exceptions import HomeAssistantAPIError
from .utils import check_port
from .utils.common import FileConfiguration
from .utils.dt import utc_from_timestamp, utcnow
@@ -191,12 +192,17 @@ class Ingress(FileConfiguration, CoreSysAttributes):
# Update UI
method = "post" if addon.ingress_panel else "delete"
async with self.sys_homeassistant.api.make_request(
method, f"api/hassio_push/panel/{addon.slug}"
) as resp:
if resp.status in (200, 201):
_LOGGER.info("Update Ingress as panel for %s", addon.slug)
else:
_LOGGER.warning(
"Fails Ingress panel for %s with %i", addon.slug, resp.status
)
try:
async with self.sys_homeassistant.api.make_request(
method, f"api/hassio_push/panel/{addon.slug}"
) as resp:
if resp.status in (200, 201):
_LOGGER.info("Update Ingress as panel for %s", addon.slug)
else:
_LOGGER.warning(
"Failed to update the Ingress panel for %s with %i",
addon.slug,
resp.status,
)
except HomeAssistantAPIError as err:
_LOGGER.error("Panel update request failed for %s: %s", addon.slug, err)

4
supervisor/resolution/notify.py
View File

@@ -52,5 +52,5 @@ class ResolutionNotify(CoreSysAttributes):
_LOGGER.debug("Successfully created persistent_notification")
else:
_LOGGER.error("Can't create persistant notification")
except HomeAssistantAPIError:
_LOGGER.error("Can't create persistant notification")
except HomeAssistantAPIError as err:
_LOGGER.error("Can't create persistant notification: %s", err)