[Community] handle missing devices

Author: Guillaume De Saint Martin

octobot/community/authentication.py

@@ -39,6 +39,7 @@ class CommunityAuthentication(authentication.Authenticator):
     """
     ALLOWED_TIME_DELAY = 1 * commons_constants.MINUTE_TO_SECONDS
     LOGIN_TIMEOUT = 20
+    DEVICE_NOT_FOUND_RETRY_DELAY = 1
     AUTHORIZATION_HEADER = "authorization"
     SESSION_HEADER = "X-Session"
     GQL_AUTHORIZATION_HEADER = "Authorization"
@@ -234,20 +235,31 @@ async def update_selected_device(self):
     async def _load_device_if_selected(self):
         # 1. use user selected device id if any
         if saved_uuid := self._get_saved_gql_device_id():
-            await self.select_device(saved_uuid)
-        else:
-            # 2. fetch all user devices and create one if none, otherwise ask use for which one to use
-            await self.load_user_devices()
-            if len(self.user_account.get_all_user_devices_raw_data()) == 0:
-                await self.select_device(
-                    self.user_account.get_device_id(
-                        await self.create_new_device()
-                    )
+            try:
+                await self.select_device(saved_uuid)
+                return
+            except errors.DeviceNotFoundError:
+                # proceed to 2.
+                pass
+        # 2. fetch all user devices and create one if none, otherwise ask use for which one to use
+        await self.load_user_devices()
+        if len(self.user_account.get_all_user_devices_raw_data()) == 0:
+            await self.select_device(
+                self.user_account.get_device_id(
+                    await self.create_new_device()
                 )
-            # more than one possible device, can't auto-select one
+            )
+        # more than one possible device, can't auto-select one
 
     async def select_device(self, device_id):
-        self.user_account.set_selected_device_raw_data(await self.fetch_device(device_id))
+        fetched_device = await self.fetch_device(device_id)
+        if fetched_device is None:
+            # retry after some time, if still None, there is an issue
+            await asyncio.sleep(self.DEVICE_NOT_FOUND_RETRY_DELAY)
+            fetched_device = await self.fetch_device(device_id)
+        if fetched_device is None:
+            raise errors.DeviceNotFoundError(f"Can't find device with id: {device_id}")
+        self.user_account.set_selected_device_raw_data(fetched_device)
         self.user_account.gql_device_id = device_id
         self._save_gql_device_id(self.user_account.gql_device_id)
         await self.on_new_device_select()

octobot/community/errors.py

@@ -26,3 +26,7 @@ class StatusCodeRequestError(RequestError):
 
 class DeviceError(commons_authentication.UnavailableError):
     pass
+
+
+class DeviceNotFoundError(DeviceError):
+    pass

octobot/community/feeds/community_mqtt_feed.py

@@ -228,20 +228,21 @@ def _on_subscribe(self, client, mid, qos, properties):
         for subscription, granted_qos in zip(subscriptions, qos):
             # in case of bad suback code, we can resend  subscription
             if granted_qos >= gmqtt.constants.SubAckReasonCode.UNSPECIFIED_ERROR.value:
-                self.logger.warning(f"Retrying subscribe, client_id: {client._client_id}, mid: {mid}, "
+                self.logger.warning(f"Retrying subscribe to {[s.topic for s in subscriptions]}, "
+                                    f"client_id: {client._client_id}, mid: {mid}, "
                                     f"reason code: {granted_qos}, properties {properties}")
                 if self._subscription_attempts < self.MAX_SUBSCRIPTION_ATTEMPTS * len(subscriptions):
                     self._subscription_attempts += 1
                     client.resubscribe(subscription)
                 else:
                     self.logger.error(f"Max subscription attempts reached, stopping subscription "
-                                      f"to {[s.topic for s in subscriptions]}. Are you copying this "
+                                      f"to {[s.topic for s in subscriptions]}. Are you subscribing to this "
                                       f"strategy on your OctoBot account ?")
                     return
             else:
                 self._subscription_attempts = 0
-            self.logger.info(f"Subscribed, client_id: {client._client_id}, mid {mid}, QOS: {granted_qos}, "
-                             f"properties {properties}")
+                self.logger.info(f"Subscribed, client_id: {client._client_id}, mid {mid}, QOS: {granted_qos}, "
+                                 f"properties {properties}")
 
     def _register_callbacks(self, client):
         client.on_connect = self._on_connect