Fix #209 (#322)

* Fix #209

* Added changelog and docs

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

Author: Commaster

docs/changelog.rst

@@ -4,12 +4,16 @@ Master
 ======
 - TwitchIO
     - Additions
+        - Added :func:`~twitchio.Client.event_channel_join_failure` event:
+            - This is dispatched when the bot fails to join a channel
+            - This also makes the channel join error message in logs optional
+    - Bug fixes
+        - Fix channel join failures causing `ValueError: list.remove(x): x not in list` when joining channels after the initial start
         - Added :attr:`~twitchio.Chatter.is_vip` property to Chatter
         - New PartialUser methods
             - :func:`~twitchio.PartialUser.fetch_follower_count` to fetch total follower count of a User
             - :func:`~twitchio.PartialUser.fetch_following_count` to fetch total following count of a User
 
-    - Bug fixes
         - Fix whispers that were not able to be parsed
         - Fix USERSTATE parsing incorrect user
 

docs/twitchio.rst

@@ -18,7 +18,8 @@ Client
     :members:
     :exclude-members: event_ready, event_raw_data, event_message,
                       event_join, event_part, event_mode, event_userstate,
-                      event_raw_usernotice, event_usernotice_subscription, event_error
+                      event_raw_usernotice, event_usernotice_subscription, event_error,
+                      event_channel_join_failure
 
 Event Reference
 -----------------
@@ -34,6 +35,7 @@ Event Reference
 .. automethod:: Client.event_raw_usernotice(channel: Channel, tags: dict)
 .. automethod:: Client.event_usernotice_subscription(metadata)
 .. automethod:: Client.event_error(error: Exception, data: Optional[str] = None)
+.. automethod:: Client.event_channel_join_failure(channel: str)
 
 Exceptions
 ------------

twitchio/client.py

@@ -1007,3 +1007,16 @@ async def event_channel_joined(self, channel: Channel):
         channel: :class:`.Channel`
             The channel that was joined.
         """
+        pass
+
+    async def event_channel_join_failure(self, channel: str):
+        """|coro|
+
+        Event called when the bot fails to join a channel.
+
+        Parameters
+        ----------
+        channel: `str`
+            The channel name that was attempted to be joined.
+        """
+        logger.error(f'The channel "{channel}" was unable to be joined. Check the channel is valid.')

twitchio/websocket.py

@@ -294,7 +294,7 @@ async def _join_future_handle(self, fut: asyncio.Future, channel: str, timeout:
         try:
             await asyncio.wait_for(fut, timeout=timeout)
         except asyncio.TimeoutError:
-            log.error(f'The channel "{channel}" was unable to be joined. Check the channel is valid.')
+            self.dispatch("channel_join_failure", channel)
             self._join_pending.pop(channel)
 
             data = (
@@ -343,7 +343,7 @@ async def _code(self, parsed, code: int):
             self.dispatch("ready")
             self._init = True
         elif code == 353:
-            if parsed["channel"] == "TWITCHIOFAILURE":
+            if parsed["channel"] == "TWITCHIOFAILURE" and parsed["batches"][0] in self._initial_channels:
                 self._initial_channels.remove(parsed["batches"][0])
             if parsed["channel"] in [c.lower().lstrip("#") for c in self._initial_channels] and not self._init:
                 self._join_load[parsed["channel"]] = None