add safe home assistant error handling

.env.example

@@ -1,3 +0,0 @@
-# Home Assistant Zugriff
-SILLYHOME_HA_URL=http://localhost:8123
-SILLYHOME_HA_TOKEN=dein_long_lived_access_token

README.md

@@ -12,34 +12,3 @@ TheSillyHome zeigte die Idee: statt statischer Regeln das Zuhause aus Verhaltens
 - Automationen vorschlagen und direkt generieren
 - Lokal-first ohne Cloudpflicht
 - Erweiterbar, testbar, dokumentiert
-
-## Quickstart (lokaler Betrieb)
-
-1. **Voraussetzungen**
-   - Python 3.11+
-   - Home Assistant mit REST-API erreichbar
-   - `pip install -e .[dev]`
-
-2. **Umgebungsvariablen** (`.env` im Projektroot)
-   ```
-   SILLYHOME_HA_URL=http://localhost:8123
-   SILLYHOME_HA_TOKEN=dein_long_lived_access_token
-   ```
-   Tipp: `.env.example` kopieren und anpassen. Tokens niemals committen!
-
-3. **Server starten**
-   ```
-   uvicorn app.main:app --reload
-   ```
-
-4. **Prüfen**
-   - OpenAPI-Docs: http://localhost:8000/docs
-   - Health: http://localhost:8000/health
-   - Entities: http://localhost:8000/v1/entities (benötigt gültige HA-Konfiguration)
-
-5. **Tests**
-   ```
-   pytest -q
-   ruff check .
-   mypy app tests
-   ```

app/__init__.py

@@ -0,0 +1 @@
+"""SillyHome Next application package."""

app/api/__init__.py

@@ -0,0 +1 @@
+"""API package."""

app/api/v1/__init__.py

@@ -0,0 +1 @@
+"""Version 1 API package."""

app/api/v1/entities.py

@@ -1,10 +1,12 @@
 from __future__ import annotations
 
-from typing import List, Sequence
+from collections.abc import Sequence
 
-from fastapi import APIRouter
+from fastapi import APIRouter, Depends
 
+from app.dependencies import get_ha_reader
 from app.ha.models import HaEntitySummary
+from app.ha.reader import HaReader
 
 router = APIRouter(prefix="/v1", tags=["entities"])
 
@@ -13,7 +15,7 @@ router = APIRouter(prefix="/v1", tags=["entities"])
     "/entities",
     summary="Home-Assistant-Entities auflisten",
     description="Gibt eine kompakte Zusammenfassung aller erreichbaren HA-Entitäten zurück.",
-    response_model=List[HaEntitySummary],
+    response_model=list[HaEntitySummary],
 )
-def list_entities() -> Sequence[HaEntitySummary]:
+def list_entities(reader: HaReader = Depends(get_ha_reader)) -> Sequence[HaEntitySummary]:
-    raise NotImplementedError("Integration mit dem HA-Client folgt in separatem Issue.")
+    return reader.read_entities()

app/config.py

@@ -0,0 +1,21 @@
+from __future__ import annotations
+
+import os
+from dataclasses import dataclass
+
+
+@dataclass(frozen=True)
+class Settings:
+    ha_url: str | None = None
+    ha_token: str | None = None
+
+    @property
+    def ha_configured(self) -> bool:
+        return bool(self.ha_url and self.ha_token)
+
+
+def load_settings() -> Settings:
+    return Settings(
+        ha_url=os.getenv("SILLYHOME_HA_URL") or os.getenv("HA_URL"),
+        ha_token=os.getenv("SILLYHOME_HA_TOKEN") or os.getenv("HA_TOKEN"),
+    )

app/core/__init__.py

@@ -0,0 +1 @@
+"""Core application helpers."""

app/core/exception_handlers.py

@@ -0,0 +1,23 @@
+from __future__ import annotations
+
+from fastapi import FastAPI, Request, status
+from fastapi.responses import JSONResponse
+
+from app.ha.exceptions import HaAuthError, HaClientError, HaHttpError, HaTimeoutError
+
+
+def register_exception_handlers(app: FastAPI) -> None:
+    @app.exception_handler(HaClientError)
+    async def handle_ha_client_error(_: Request, exc: HaClientError) -> JSONResponse:
+        return JSONResponse(
+            status_code=_status_code_for_ha_error(exc),
+            content={"detail": exc.public_detail},
+        )
+
+
+def _status_code_for_ha_error(exc: HaClientError) -> int:
+    if isinstance(exc, HaTimeoutError):
+        return status.HTTP_504_GATEWAY_TIMEOUT
+    if isinstance(exc, (HaAuthError, HaHttpError)):
+        return status.HTTP_502_BAD_GATEWAY
+    return status.HTTP_502_BAD_GATEWAY

app/dependencies.py

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from fastapi import HTTPException, Request, status
+
+from app.ha.reader import HaReader
+
+
+def get_ha_reader(request: Request) -> HaReader:
+    reader = getattr(request.app.state, "ha_reader", None)
+    if not isinstance(reader, HaReader):
+        raise HTTPException(
+            status_code=status.HTTP_503_SERVICE_UNAVAILABLE,
+            detail="Home Assistant is not configured.",
+        )
+    return reader

app/ha/client.py

@@ -2,9 +2,17 @@ from __future__ import annotations
 
 import logging
 from dataclasses import dataclass
+from typing import Any
 
 import requests
 
+from app.ha.exceptions import (
+    HaAuthError,
+    HaHttpError,
+    HaTimeoutError,
+    HaUnexpectedPayloadError,
+)
+
 logger = logging.getLogger(__name__)
 
 
@@ -24,10 +32,36 @@ class HaClient:
             "Content-Type": "application/json",
         })
 
-    def list_entities(self) -> list[dict[str, object]]:
+    def list_entities(self) -> list[dict[str, Any]]:
+        try:
             response = self._session.get(
                 f"{self._settings.url}/api/states",
                 timeout=self._settings.timeout_seconds,
             )
+        except requests.Timeout as exc:
+            raise HaTimeoutError("Home Assistant request timed out.") from exc
+        except requests.RequestException as exc:
+            raise HaHttpError(status_code=502, message="Home Assistant request failed.") from exc
+
+        if response.status_code in {401, 403}:
+            raise HaAuthError(
+                status_code=response.status_code,
+                message="Home Assistant authentication failed.",
+            )
+
+        try:
             response.raise_for_status()
-        return response.json()
+        except requests.HTTPError as exc:
+            raise HaHttpError(
+                status_code=response.status_code,
+                message="Home Assistant returned an HTTP error.",
+            ) from exc
+
+        try:
+            payload = response.json()
+        except ValueError as exc:
+            raise HaUnexpectedPayloadError("Home Assistant returned invalid JSON.") from exc
+
+        if not isinstance(payload, list):
+            raise HaUnexpectedPayloadError("Home Assistant states response must be a list.")
+        return payload

app/ha/exceptions.py

@@ -0,0 +1,27 @@
+from __future__ import annotations
+
+
+class HaClientError(Exception):
+    """Base class for Home Assistant integration failures."""
+
+    public_detail = "Home Assistant is currently unavailable."
+
+
+class HaTimeoutError(HaClientError):
+    public_detail = "Home Assistant request timed out."
+
+
+class HaHttpError(HaClientError):
+    public_detail = "Home Assistant returned an error."
+
+    def __init__(self, status_code: int, message: str | None = None) -> None:
+        super().__init__(message or self.public_detail)
+        self.status_code = status_code
+
+
+class HaAuthError(HaHttpError):
+    public_detail = "Home Assistant authentication failed."
+
+
+class HaUnexpectedPayloadError(HaClientError):
+    public_detail = "Home Assistant returned an unexpected response."

app/ha/reader.py

@@ -1,9 +1,10 @@
 from __future__ import annotations
 
 from collections.abc import Sequence
+from typing import Any
 
 from app.ha.client import HaClient
-from app.ha.models import HaEntitySummary, HaState
+from app.ha.models import HaEntitySummary
 
 
 class HaReader:
@@ -18,14 +19,21 @@ class HaReader:
             if "." not in entity_id:
                 continue
             domain = entity_id.split(".", 1)[0]
-            attributes = item.get("attributes") or {}
+            raw_attributes = item.get("attributes") or {}
+            attributes: dict[str, Any] = raw_attributes if isinstance(raw_attributes, dict) else {}
             summaries.append(
                 HaEntitySummary(
                     entity_id=entity_id,
                     domain=domain,
-                    state_class=str(attributes.get("state_class") or ""),
+                    state_class=_optional_str(attributes.get("state_class")),
-                    device_class=str(attributes.get("device_class") or ""),
+                    device_class=_optional_str(attributes.get("device_class")),
-                    unit_of_measurement=str(attributes.get("unit_of_measurement") or ""),
+                    unit_of_measurement=_optional_str(attributes.get("unit_of_measurement")),
                 )
             )
         return summaries
+
+
+def _optional_str(value: object) -> str | None:
+    if value is None or value == "":
+        return None
+    return str(value)

app/main.py

@@ -1,19 +1,26 @@
+from collections.abc import AsyncIterator
 from contextlib import asynccontextmanager
 
-from fastapi import FastAPI, Depends
+from fastapi import FastAPI
 
 from app.api.v1.entities import router as entities_router
+from app.config import load_settings
+from app.core.exception_handlers import register_exception_handlers
 from app.ha.client import HaClient, HaClientSettings
 from app.ha.reader import HaReader
 
 
 @asynccontextmanager
-async def lifespan(app: FastAPI):
+async def lifespan(app: FastAPI) -> AsyncIterator[None]:
-    settings = HaClientSettings(
+    settings = load_settings()
-        url=app.state.settings.ha_url,
+    app.state.settings = settings
-        token=app.state.settings.ha_token,
+    if settings.ha_configured:
+        client = HaClient(
+            settings=HaClientSettings(
+                url=settings.ha_url or "",
+                token=settings.ha_token or "",
+            )
         )
-    client = HaClient(settings=settings)
         app.state.ha_reader = HaReader(client=client)
     yield
 
@@ -25,20 +32,9 @@ app = FastAPI(
     lifespan=lifespan,
 )
 
+register_exception_handlers(app)
 
-class Settings:
+app.include_router(entities_router)
-    ha_url: str
-    ha_token: str
-
-
-app.state.settings = Settings()
-
-
-def get_ha_reader() -> HaReader:
-    return app.state.ha_reader
-
-
-app.include_router(entities_router, dependencies=[Depends(get_ha_reader)])
 
 
 @app.get("/health")

pyproject.toml

@@ -7,10 +7,12 @@ dependencies = [
   "fastapi>=0.110.0",
   "uvicorn[standard]>=0.29.0",
   "pydantic>=2.6.0",
+  "requests>=2.31.0",
 ]
 
 [project.optional-dependencies]
 dev = [
+  "httpx2>=2.3.0",
   "pytest>=8.0.0",
   "ruff>=0.4.0",
   "mypy>=1.9.0",

scripts/gitea_setup.py

@@ -1,5 +1,4 @@
 import requests
-import json
 from pathlib import Path
 
 p = Path('/root/.openclaw/secrets/gitea.env')

tests/api/test_entities.py

@@ -1,10 +1,63 @@
+from collections.abc import Sequence
+
 from fastapi.testclient import TestClient
+
+from app.ha.exceptions import HaTimeoutError
+from app.ha.models import HaEntitySummary
+from app.ha.reader import HaReader
 from app.main import app
 
-client = TestClient(app)
+
+class FakeHaReader(HaReader):
+    def __init__(self) -> None:
+        pass
+
+    def read_entities(self) -> Sequence[HaEntitySummary]:
+        return [HaEntitySummary(entity_id="sensor.temperature", domain="sensor")]
+
+
+class TimeoutHaReader(HaReader):
+    def __init__(self) -> None:
+        pass
+
+    def read_entities(self) -> Sequence[HaEntitySummary]:
+        raise HaTimeoutError("contains internal details that must not leak")
 
 
 def test_openapi_docs_are_available() -> None:
+    with TestClient(app) as client:
         response = client.get("/docs")
     assert response.status_code == 200
     assert "SillyHome Next API" in response.text
+
+
+def test_entities_returns_reader_data() -> None:
+    with TestClient(app) as client:
+        app.state.ha_reader = FakeHaReader()
+        response = client.get("/v1/entities")
+    assert response.status_code == 200
+    assert response.json() == [
+        {
+            "entity_id": "sensor.temperature",
+            "domain": "sensor",
+            "state_class": None,
+            "device_class": None,
+            "unit_of_measurement": None,
+        }
+    ]
+
+
+def test_entities_returns_503_without_home_assistant_config() -> None:
+    with TestClient(app) as client:
+        if hasattr(app.state, "ha_reader"):
+            delattr(app.state, "ha_reader")
+        response = client.get("/v1/entities")
+    assert response.status_code == 503
+
+
+def test_entities_maps_ha_errors_without_leaking_details() -> None:
+    with TestClient(app) as client:
+        app.state.ha_reader = TimeoutHaReader()
+        response = client.get("/v1/entities")
+    assert response.status_code == 504
+    assert response.json() == {"detail": "Home Assistant request timed out."}

tests/ha/test_ha_client.py

@@ -0,0 +1,79 @@
+from __future__ import annotations
+
+from unittest.mock import Mock
+
+import pytest
+import requests
+
+from app.ha.client import HaClient, HaClientSettings
+from app.ha.exceptions import (
+    HaAuthError,
+    HaHttpError,
+    HaTimeoutError,
+    HaUnexpectedPayloadError,
+)
+
+
+def _client_with_response(response: Mock) -> HaClient:
+    client = HaClient(HaClientSettings(url="http://ha.local", token="secret-token"))
+    client._session.get = Mock(return_value=response)  # type: ignore[method-assign]
+    return client
+
+
+def _response(status_code: int = 200, payload: object | None = None) -> Mock:
+    response = Mock()
+    response.status_code = status_code
+    response.json.return_value = [] if payload is None else payload
+    if status_code >= 400:
+        response.raise_for_status.side_effect = requests.HTTPError("upstream failed")
+    return response
+
+
+def test_list_entities_returns_home_assistant_payload() -> None:
+    payload = [{"entity_id": "sensor.temperature", "state": "21"}]
+    client = _client_with_response(_response(payload=payload))
+
+    assert client.list_entities() == payload
+
+
+def test_list_entities_maps_timeout() -> None:
+    client = HaClient(HaClientSettings(url="http://ha.local", token="secret-token"))
+    client._session.get = Mock(side_effect=requests.Timeout("secret-token"))  # type: ignore[method-assign]
+
+    with pytest.raises(HaTimeoutError):
+        client.list_entities()
+
+
+@pytest.mark.parametrize("status_code", [401, 403])
+def test_list_entities_maps_auth_errors(status_code: int) -> None:
+    client = _client_with_response(_response(status_code=status_code))
+
+    with pytest.raises(HaAuthError) as exc_info:
+        client.list_entities()
+
+    assert exc_info.value.status_code == status_code
+
+
+def test_list_entities_maps_http_errors() -> None:
+    client = _client_with_response(_response(status_code=500))
+
+    with pytest.raises(HaHttpError) as exc_info:
+        client.list_entities()
+
+    assert exc_info.value.status_code == 500
+
+
+def test_list_entities_rejects_invalid_json() -> None:
+    response = _response()
+    response.json.side_effect = ValueError("not json")
+    client = _client_with_response(response)
+
+    with pytest.raises(HaUnexpectedPayloadError):
+        client.list_entities()
+
+
+def test_list_entities_rejects_non_list_payload() -> None:
+    client = _client_with_response(_response(payload={"entity_id": "sensor.temperature"}))
+
+    with pytest.raises(HaUnexpectedPayloadError):
+        client.list_entities()

tests/ha/test_ha_reader.py

@@ -1,7 +1,6 @@
 from __future__ import annotations
 
 from app.ha.client import HaClient, HaClientSettings
-from app.ha.models import HaEntitySummary, HaState
 from app.ha.reader import HaReader
 
 

tests/test_health.py

@@ -1,10 +1,10 @@
 from fastapi.testclient import TestClient
-from app.main import app
 
-client = TestClient(app)
+from app.main import app
 
 
 def test_health_returns_ok() -> None:
+    with TestClient(app) as client:
         response = client.get("/health")
     assert response.status_code == 200
     assert response.json() == {"status": "ok"}