Quieter but more useful logs for API errors

.pre-commit-config.yaml

@@ -36,6 +36,7 @@ repos:
     rev: v0.7.0
     hooks:
       - id: python-typing-update
+        stages: [manual]
         args:
           - --py312-plus
           - --force

custom_components/bestway/bestway/api.py

@@ -47,7 +47,7 @@ class BestwayOfflineException(BestwayException):
 
     def __init__(self) -> None:
         """Construct the exception."""
-        super().__init__("Device is offline")
+        super().__init__("Server reports device is offline")
 
 
 class BestwayAuthException(BestwayException):
@@ -57,37 +57,47 @@ class BestwayAuthException(BestwayException):
 class BestwayTokenInvalidException(BestwayAuthException):
     """Auth token is invalid or expired."""
 
+    def __init__(self) -> None:
+        super().__init__("Server reports auth token is invalid or expired")
+
 
 class BestwayUserDoesNotExistException(BestwayAuthException):
     """User does not exist."""
 
+    def __init__(self) -> None:
+        super().__init__("Server reports user does not exist")
+
 
 class BestwayIncorrectPasswordException(BestwayAuthException):
     """Password is incorrect."""
 
+    def __init__(self) -> None:
+        super().__init__("Server reports password is incorrect")
+
 
 async def _raise_for_status(response: ClientResponse) -> None:
     """Raise an exception based on the response."""
     if response.ok:
         return
 
-    # Try to parse out the bestway error code
-    try:
-        api_error = await response.json()
-    except Exception:  # pylint: disable=broad-except
-        response.raise_for_status()
-
-    error_code = api_error.get("error_code", 0)
-    if error_code == 9004:
-        raise BestwayTokenInvalidException()
-    if error_code == 9005:
-        raise BestwayUserDoesNotExistException()
-    if error_code == 9042:
-        raise BestwayOfflineException()
-    if error_code == 9020:
-        raise BestwayIncorrectPasswordException()
-
-    # If we don't understand the error code, provide more detail for debugging
+    # The API often provides useful error descriptions in JSON format
+    if response.content_type == "application/json":
+        try:
+            api_error = await response.json()
+        except Exception:  # pylint: disable=broad-except
+            response.raise_for_status()
+
+        error_code = api_error.get("error_code", 0)
+        if error_code == 9004:
+            raise BestwayTokenInvalidException()
+        if error_code == 9005:
+            raise BestwayUserDoesNotExistException()
+        if error_code == 9042:
+            raise BestwayOfflineException()
+        if error_code == 9020:
+            raise BestwayIncorrectPasswordException()
+
+    # If we can't pull out a Bestway error code, provide more detail for debugging
     response.raise_for_status()
 
 

custom_components/bestway/binary_sensor.py

@@ -140,7 +140,7 @@ def is_on(self) -> bool | None:
     @property
     def available(self) -> bool:
         """Return True, as the connectivity sensor is always available."""
-        return True
+        return self.coordinator.last_update_success
 
 
 class DeviceErrorsSensor(BestwayEntity, BinarySensorEntity):

custom_components/bestway/coordinator.py

@@ -5,7 +5,7 @@
 from logging import getLogger
 
 from homeassistant.core import HomeAssistant
-from homeassistant.helpers.update_coordinator import DataUpdateCoordinator, UpdateFailed
+from homeassistant.helpers.update_coordinator import DataUpdateCoordinator
 
 from .bestway.api import BestwayApi, BestwayApiResults
 
@@ -31,10 +31,6 @@ async def _async_update_data(self) -> BestwayApiResults:
         This is the place to pre-process the data to lookup tables
         so entities can quickly look up their data.
         """
-        try:
-            async with asyncio.timeout(10):
-                await self.api.refresh_bindings()
-                return await self.api.fetch_data()
-        except Exception as err:
-            _LOGGER.exception("Data update failed")
-            raise UpdateFailed(f"Error communicating with API: {err}") from err
+        async with asyncio.timeout(10):
+            await self.api.refresh_bindings()
+            return await self.api.fetch_data()

custom_components/bestway/entity.py

@@ -55,4 +55,8 @@ def status(self) -> BestwayDeviceStatus | None:
     @property
     def available(self) -> bool:
         """Return True if entity is available."""
-        return self.bestway_device is not None and self.bestway_device.is_online
+        return (
+            self.coordinator.last_update_success
+            and self.bestway_device is not None
+            and self.bestway_device.is_online
+        )