Improve re-connect logic to be more robust (#80)

Author: postlund

custom_components/remote_homeassistant/__init__.py

@@ -58,7 +58,7 @@
     CONF_REMOTE_INFO,
     DOMAIN,
 )
-from .rest_api import async_get_discovery_info
+from .rest_api import UnsupportedVersion, async_get_discovery_info
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -371,14 +371,20 @@ async def _async_instance_get_info():
                     self._access_token,
                     self._verify_ssl,
                 )
+            except OSError:
+                _LOGGER.exception("failed to connect")
+            except UnsupportedVersion:
+                _LOGGER.error("Unsupported version, at least 0.111 is required.")
             except Exception:
                 _LOGGER.exception("failed to fetch instance info")
-                return None
+            return None
 
         @callback
         def _async_instance_id_match(info):
             """Verify if remote instance id matches the expected id."""
-            if info["uuid"] != self._entry.unique_id:
+            if not info:
+                return False
+            if info and info["uuid"] != self._entry.unique_id:
                 _LOGGER.error(
                     "instance id not matching: %s != %s",
                     info["uuid"],
@@ -395,8 +401,8 @@ def _async_instance_id_match(info):
         while True:
             info = await _async_instance_get_info()
 
-            # If an instance id is set, verify we are talking to correct instance
-            if not (info or _async_instance_id_match(info)):
+            # Verify we are talking to correct instance
+            if not _async_instance_id_match(info):
                 self.set_connection_state(STATE_RECONNECTING)
                 await asyncio.sleep(10)
                 continue
@@ -434,6 +440,7 @@ async def _heartbeat_loop(self):
 
             _LOGGER.debug("Sending ping")
             event = asyncio.Event()
+
             def resp(message):
                 _LOGGER.debug("Got pong: %s", message)
                 event.set()
@@ -477,7 +484,10 @@ async def _disconnected(self):
             self._hass.states.async_remove(entity)
         if self._heartbeat_task is not None:
             self._heartbeat_task.cancel()
-            await self._heartbeat_task
+            try:
+                await self._heartbeat_task
+            except asyncio.CancelledError:
+                pass
         if self._remove_listener is not None:
             self._remove_listener()
 

custom_components/remote_homeassistant/config_flow.py

@@ -25,7 +25,13 @@
 from homeassistant.core import callback
 
 from . import async_yaml_to_config_entry
-from .rest_api import ApiProblem, CannotConnect, InvalidAuth, async_get_discovery_info
+from .rest_api import (
+    ApiProblem,
+    CannotConnect,
+    InvalidAuth,
+    UnsupportedVersion,
+    async_get_discovery_info,
+)
 from .const import (
     CONF_REMOTE_CONNECTION,
     CONF_SECURE,
@@ -100,6 +106,8 @@ async def async_step_user(self, user_input=None):
                 errors["base"] = "cannot_connect"
             except InvalidAuth:
                 errors["base"] = "invalid_auth"
+            except UnsupportedVersion:
+                errors["base"] = "unsupported_version"
             except Exception:  # pylint: disable=broad-except
                 _LOGGER.exception("Unexpected exception")
                 errors["base"] = "unknown"

custom_components/remote_homeassistant/rest_api.py

@@ -21,6 +21,14 @@ class InvalidAuth(exceptions.HomeAssistantError):
     """Error to indicate there is invalid auth."""
 
 
+class BadResponse(exceptions.HomeAssistantError):
+    """Error to indicate a bad response was received."""
+
+
+class UnsupportedVersion(exceptions.HomeAssistantError):
+    """Error to indicate an unsupported version of Home Assistant."""
+
+
 async def async_get_discovery_info(hass, host, port, secure, access_token, verify_ssl):
     """Get discovery information from server."""
     url = API_URL.format(
@@ -45,4 +53,9 @@ async def async_get_discovery_info(hass, host, port, secure, access_token, verif
     async with session.get(url + "discovery_info") as resp:
         if resp.status != 200:
             raise ApiProblem()
-        return await resp.json()
+        json = await resp.json()
+        if not isinstance(json, dict):
+            raise BadResponse(f"Bad response data: {json}")
+        if "uuid" not in json:
+            raise UnsupportedVersion()
+        return json

custom_components/remote_homeassistant/translations/en.json

@@ -17,6 +17,7 @@
       "api_problem": "Bad response from server",
       "cannot_connect": "Failed to connect to server",
       "invalid_auth": "Invalid credentials",
+      "unsupported_version": "Unsupported version. At least version 0.111 is required.",
       "unknown": "An unknown error occurred"
     },
     "abort": {