[CommunityFeed] add logs

Author: Guillaume De Saint Martin

octobot/community/authentication.py

@@ -272,6 +272,8 @@ async def select_bot(self, bot_id):
         if fetched_bot is None:
             raise errors.BotNotFoundError(f"Can't find bot with id: {bot_id}")
         self.user_account.set_selected_bot_raw_data(fetched_bot)
+        bot_name = self.user_account.get_bot_name_or_id(self.user_account.get_selected_bot_raw_data())
+        self.logger.debug(f"Selected bot '{bot_name}'")
         self.user_account.gql_bot_id = bot_id
         self._save_gql_bot_id(self.user_account.gql_bot_id)
         await self.on_new_bot_select()

octobot/community/community_user_account.py

@@ -22,7 +22,6 @@ class CommunityUserAccount:
     BOT_DEVICE = "device"
     NO_SELECTED_BOT_DESC = "No selected bot. Please select a bot to enable your community features."
 
-
     def __init__(self):
         self.gql_user_id = None
         self.gql_bot_id = None
@@ -62,6 +61,12 @@ def get_selected_bot_device_uuid(self):
         except AttributeError:
             raise errors.NoBotDeviceError("No device associated to the select bot")
 
+    def get_selected_bot_device_name(self):
+        try:
+            return self.get_selected_bot_raw_data(raise_on_missing=True).get(self.BOT_DEVICE, {}).get("name", None)
+        except AttributeError:
+            raise errors.NoBotDeviceError("No device associated to the select bot")
+
     @staticmethod
     def get_bot_id(bot):
         return bot["_id"]

octobot/community/feeds/community_mqtt_feed.py

@@ -267,7 +267,8 @@ async def _connect(self):
         self._update_client_config(self._mqtt_client)
         self._register_callbacks(self._mqtt_client)
         self._mqtt_client.set_auth_credentials(self._device_uuid, None)
-        self.logger.debug(f"Connecting client")
+        self.logger.debug(f"Connecting client using device "
+                          f"'{self.authenticator.user_account.get_selected_bot_device_name()}'")
         self._connect_task = asyncio.create_task(
             self._mqtt_client.connect(self.feed_url, self.mqtt_broker_port, version=self.MQTT_VERSION)
         )

tests/unit_tests/community/test_community_mqtt_feed.py

@@ -30,6 +30,7 @@
 
 FEED_URL = "x.y.z"
 TOKEN = "acb1"
+NAME = "name_a"
 
 
 def _build_message(value, identifier):
@@ -65,6 +66,8 @@ async def connected_community_feed(authenticator):
         feed.INIT_TIMEOUT = 1
         with mock.patch.object(authenticator.user_account, "get_selected_bot_device_uuid", mock.Mock(return_value=TOKEN)) \
                 as get_selected_bot_device_uuid_mock, \
+             mock.patch.object(authenticator.user_account, "get_selected_bot_device_name", mock.Mock(return_value=NAME)
+                               ) as _get_selected_bot_device_uuid_mock, \
              mock.patch.object(feed, "_subscribe", mock.AsyncMock()) as _subscribe_mock, \
              mock.patch.object(gmqtt.Client, "connect", mock.AsyncMock()) as _connect_mock:
             await feed.register_feed_callback(commons_enums.CommunityChannelTypes.SIGNAL, mock.AsyncMock())