Add max_message_size configuration option (#227)

* Add `max_message_size` configuration option

* Let's proactively increase the default value to better catch some errors, I think there is no harm in that

---------

Co-authored-by: Lukas <[email protected]>

Author: Zen3515

README.md

@@ -168,6 +168,10 @@ access_token:
   description: Access token of the remote instance, if set.
   required: false
   type: string
+max_message_size:
+  description: Maximum message size, you can expand size limit in case of an error.
+  required: false
+  type: int
 entity_prefix:
   description: Prefix for all entities of the remote instance.
   required: false

custom_components/remote_homeassistant/__init__.py

@@ -53,6 +53,7 @@
 CONF_SUBSCRIBE_EVENTS = "subscribe_events"
 CONF_ENTITY_PREFIX = "entity_prefix"
 CONF_FILTER = "filter"
+CONF_MAX_MSG_SIZE = "max_message_size"
 
 STATE_INIT = "initializing"
 STATE_CONNECTING = "connecting"
@@ -71,6 +72,7 @@
         vol.Optional(CONF_SECURE, default=False): cv.boolean,
         vol.Optional(CONF_VERIFY_SSL, default=True): cv.boolean,
         vol.Required(CONF_ACCESS_TOKEN): cv.string,
+        vol.Optional(CONF_MAX_MSG_SIZE, default=16*1024*1024): vol.Coerce(int),
         vol.Optional(CONF_EXCLUDE, default={}): vol.Schema(
             {
                 vol.Optional(CONF_ENTITIES, default=[]): cv.entity_ids,
@@ -300,6 +302,7 @@ def __init__(self, hass, config_entry):
         self._secure = config_entry.data.get(CONF_SECURE, False)
         self._verify_ssl = config_entry.data.get(CONF_VERIFY_SSL, False)
         self._access_token = config_entry.data.get(CONF_ACCESS_TOKEN)
+        self._max_msg_size = config_entry.data.get(CONF_MAX_MSG_SIZE)
 
         # see homeassistant/components/influxdb/__init__.py
         # for include/exclude logic
@@ -416,7 +419,7 @@ def _async_instance_id_match(info):
 
             try:
                 _LOGGER.info("Connecting to %s", url)
-                self._connection = await session.ws_connect(url)
+                self._connection = await session.ws_connect(url, max_msg_size = self._max_msg_size)
             except aiohttp.client_exceptions.ClientError:
                 _LOGGER.error("Could not connect to %s, retry in 10 seconds...", url)
                 self.set_connection_state(STATE_RECONNECTING)
@@ -528,6 +531,8 @@ async def _recv(self):
 
             if data.type == aiohttp.WSMsgType.ERROR:
                 _LOGGER.error("websocket connection had an error")
+                if data.data.code == aiohttp.WSCloseCode.MESSAGE_TOO_BIG:
+                    _LOGGER.error(f"please consider increasing message size with `{CONF_MAX_MSG_SIZE}`")
                 break
 
             try:

custom_components/remote_homeassistant/config_flow.py

@@ -19,7 +19,7 @@
                     CONF_EXCLUDE_DOMAINS, CONF_EXCLUDE_ENTITIES, CONF_FILTER,
                     CONF_INCLUDE_DOMAINS, CONF_INCLUDE_ENTITIES,
                     CONF_LOAD_COMPONENTS, CONF_MAIN, CONF_OPTIONS, CONF_REMOTE, CONF_REMOTE_CONNECTION,
-                    CONF_SECURE, CONF_SERVICE_PREFIX, CONF_SERVICES,
+                    CONF_SECURE, CONF_SERVICE_PREFIX, CONF_SERVICES, CONF_MAX_MSG_SIZE,
                     CONF_SUBSCRIBE_EVENTS, DOMAIN, REMOTE_ID)
 from .rest_api import (ApiProblem, CannotConnect, EndpointMissing, InvalidAuth,
                        UnsupportedVersion, async_get_discovery_info)
@@ -71,7 +71,7 @@ class ConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
 
     def __init__(self):
         """Initialize a new ConfigFlow."""
-        self.prefill = {CONF_PORT: 8123, CONF_SECURE: True}
+        self.prefill = {CONF_PORT: 8123, CONF_SECURE: True, CONF_MAX_MSG_SIZE: 16*1024*1024}
 
     @staticmethod
     @callback
@@ -133,13 +133,15 @@ async def async_step_connection_details(self, user_input=None):
         host = user_input.get(CONF_HOST, self.prefill.get(CONF_HOST) or vol.UNDEFINED)
         port = user_input.get(CONF_PORT, self.prefill.get(CONF_PORT) or vol.UNDEFINED)
         secure = user_input.get(CONF_SECURE, self.prefill.get(CONF_SECURE) or vol.UNDEFINED)
+        max_msg_size = user_input.get(CONF_MAX_MSG_SIZE, self.prefill.get(CONF_MAX_MSG_SIZE) or vol.UNDEFINED)
         return self.async_show_form(
             step_id="connection_details",
             data_schema=vol.Schema(
                 {
                     vol.Required(CONF_HOST, default=host): str,
                     vol.Required(CONF_PORT, default=port): int,
                     vol.Required(CONF_ACCESS_TOKEN, default=user_input.get(CONF_ACCESS_TOKEN, vol.UNDEFINED)): str,
+                    vol.Required(CONF_MAX_MSG_SIZE, default=max_msg_size): int,
                     vol.Optional(CONF_SECURE, default=secure): bool,
                     vol.Optional(CONF_VERIFY_SSL, default=user_input.get(CONF_VERIFY_SSL, True)): bool,
                 }

custom_components/remote_homeassistant/const.py

@@ -13,6 +13,7 @@
 CONF_API_PASSWORD = "api_password"
 CONF_SUBSCRIBE_EVENTS = "subscribe_events"
 CONF_ENTITY_PREFIX = "entity_prefix"
+CONF_MAX_MSG_SIZE = "max_message_size"
 
 CONF_INCLUDE_DOMAINS = "include_domains"
 CONF_INCLUDE_ENTITIES = "include_entities"

custom_components/remote_homeassistant/sensor.py

@@ -3,7 +3,7 @@
 from homeassistant.helpers.dispatcher import async_dispatcher_connect
 from homeassistant.helpers.entity import DeviceInfo, Entity
 
-from .const import DOMAIN, CONF_ENTITY_PREFIX, CONF_SECURE
+from .const import DOMAIN, CONF_ENTITY_PREFIX, CONF_SECURE, CONF_MAX_MSG_SIZE
 
 
 async def async_setup_entry(hass, config_entry, async_add_entities):
@@ -44,6 +44,7 @@ def extra_state_attributes(self):
             "port": self._entry.data[CONF_PORT],
             "secure": self._entry.data.get(CONF_SECURE, False),
             "verify_ssl": self._entry.data.get(CONF_VERIFY_SSL, False),
+            "max_msg_size": self._entry.data[CONF_MAX_MSG_SIZE],
             "entity_prefix": self._entry.options.get(CONF_ENTITY_PREFIX, ""),
             "uuid": self.unique_id,
         }

custom_components/remote_homeassistant/translations/de.json

@@ -13,7 +13,8 @@
           "port": "Port",
           "secure": "Sicher",
           "verify_ssl": "SSL verifizieren",
-          "access_token": "Verbindungstoken"
+          "access_token": "Verbindungstoken",
+          "max_message_size": "Maximale Nachrichtengröße"
         }
       }
     },
@@ -44,10 +45,10 @@
       "init": {
         "title": "Basis-Einstellungen (Schritt 1/4)",
         "data": {
-            "entity_prefix": "Entitätspräfix (optional)",
-            "load_components": "Komponente laden (wenn nicht geladen)",
-            "service_prefix": "Servicepräfix",
-            "services": "Remote Services"
+          "entity_prefix": "Entitätspräfix (optional)",
+          "load_components": "Komponente laden (wenn nicht geladen)",
+          "service_prefix": "Servicepräfix",
+          "services": "Remote Services"
         }
       },
       "domain_entity_filters": {
@@ -74,10 +75,10 @@
         "title": "Abonnierte Events (Schritt 4/4)",
         "description": "Fügen Sie neue abonnierte Events hinzu, indem Sie ihren Namen in „Neue Events hinzufügen“ eingeben und auf „Absenden“ klicken. Deaktivieren Sie vorhandene Events, indem Sie sie unter „Events“ entfernen.\n\nLassen Sie „Neue Events hinzufügen“ leer und klicken Sie auf „Absenden“, um keine weiteren Änderungen vorzunehmen.",
         "data": {
-            "subscribe_events": "Events",
-            "add_new_event": "Neue Events hinzufügen"
+          "subscribe_events": "Events",
+          "add_new_event": "Neue Events hinzufügen"
         }
       }
     }
   }
-}
+}

custom_components/remote_homeassistant/translations/en.json

@@ -13,7 +13,8 @@
           "port": "Port",
           "secure": "Secure",
           "verify_ssl": "Verify SSL",
-          "access_token": "Access token"
+          "access_token": "Access token",
+          "max_message_size": "Maximum Message Size"
         }
       }
     },
@@ -44,10 +45,10 @@
       "init": {
         "title": "Basic Options (step 1/4)",
         "data": {
-            "entity_prefix": "Entity prefix (optional)",
-            "load_components": "Load component (if not loaded)",
-            "service_prefix": "Service prefix",
-            "services": "Remote Services"
+          "entity_prefix": "Entity prefix (optional)",
+          "load_components": "Load component (if not loaded)",
+          "service_prefix": "Service prefix",
+          "services": "Remote Services"
         }
       },
       "domain_entity_filters": {
@@ -74,13 +75,13 @@
         "title": "Subscribed events (step 4/4)",
         "description": "Add a new subscribed event by entering its name in `Add new event` and press `Submit`. Remove existing events by unticking them in `Events`.\n\nLeave `Add new event` and press `Submit` to make no further changes.",
         "data": {
-            "subscribe_events": "Events",
-            "add_new_event": "Add new event"
+          "subscribe_events": "Events",
+          "add_new_event": "Add new event"
         }
       }
     },
     "abort": {
       "not_supported": "No configuration options supported for a remote node"
     }
   }
-}
+}

custom_components/remote_homeassistant/translations/pt-BR.json

@@ -13,7 +13,8 @@
           "port": "Porta",
           "secure": "Protegido",
           "verify_ssl": "Verificar SSL",
-          "access_token": "Token de acesso"
+          "access_token": "Token de acesso",
+          "max_message_size": "Tamanho máximo da mensagem"
         }
       }
     },
@@ -44,10 +45,10 @@
       "init": {
         "title": "Opções básicas (passo 1/4)",
         "data": {
-            "entity_prefix": "Prefixo da entidade (opcional)",
-            "load_components": "Carregar componente (se não estiver carregado)",
-            "service_prefix": "Prefixo do serviço",
-            "services": "Serviços remotos"
+          "entity_prefix": "Prefixo da entidade (opcional)",
+          "load_components": "Carregar componente (se não estiver carregado)",
+          "service_prefix": "Prefixo do serviço",
+          "services": "Serviços remotos"
         }
       },
       "domain_entity_filters": {
@@ -74,10 +75,10 @@
         "title": "Eventos inscritos (passo 4/4)",
         "description": "Adicione um novo evento inscrito digitando seu nome em `Adicionar novo evento` e pressione `Enviar`. Remova os eventos existentes desmarcando-os em `Eventos`.\n\nDeixe `Adicionar novo evento` e pressione `Enviar` para não fazer mais alterações.",
         "data": {
-            "subscribe_events": "Eventos",
-            "add_new_event": "Adicionar novo evento"
+          "subscribe_events": "Eventos",
+          "add_new_event": "Adicionar novo evento"
         }
       }
     }
   }
-}
+}