Some fixes && optimizations

docs/events.rst

@@ -50,7 +50,38 @@ An event listener in a cog.
 
         Called when an audio WebSocket (to Discord) is closed. This can happen for various reasons (normal and abnormal), e.g. when using an expired voice server update.
         4xxx codes are usually bad.
-        See the `Discord Docs <https://discord.com/developers/docs/topics/opcodes-and-status-codes#voice-voice-close-event-codes>`_.
+
+        .. note::
+            See the `Discord Docs <https://discord.com/developers/docs/topics/opcodes-and-status-codes#voice-voice-close-event-codes>`_.
+
+.. function:: on_harmonize_session_no_longer(player: harmonize.Player)
+
+        Called when an audio WebSocket (to Discord) is closed with code 4006.
+
+        .. note::
+            See the `Discord Docs <https://discord.com/developers/docs/topics/opcodes-and-status-codes#voice-voice-close-event-codes>`_.
+
+.. function:: on_harmonize_session_timeout(player: harmonize.Player)
+
+        Called when an audio WebSocket (to Discord) is closed with code 4009.
+
+        .. note::
+            See the `Discord Docs <https://discord.com/developers/docs/topics/opcodes-and-status-codes#voice-voice-close-event-codes>`_.
+
+.. function:: on_harmonize_voice_modification(player: harmonize.Player)
+
+        Called when an audio WebSocket (to Discord) is closed with code 4014.
+        E.g., changed the voice channel or kicked out of the channel
+
+        .. note::
+            See the `Discord Docs <https://discord.com/developers/docs/topics/opcodes-and-status-codes#voice-voice-close-event-codes>`_.
+
+.. function:: on_harmonize_voice_crashed(player: harmonize.Player)
+
+        Called when an audio WebSocket (to Discord) is closed with code 4015.
+
+        .. note::
+            See the `Discord Docs <https://discord.com/developers/docs/topics/opcodes-and-status-codes#voice-voice-close-event-codes>`_.
 
 .. function:: on_harmonize_extra_event(event_type: str, player: harmonize.Player, data: str)
 

harmonize/connection/node.py

@@ -26,7 +26,7 @@
 
 class Node:
     """Represents a lavalink node
-    
+
     Operations
     ----------
         .. describe:: x == y
@@ -40,7 +40,7 @@ class Node:
         .. describe:: hash(x)
 
             Return the node's hash.
-    
+
     Attributes
     ----------
         identifier : str
@@ -77,15 +77,6 @@ class Node:
 
     @classmethod
     def _load_cache(cls, capacity: int) -> None:
-        """
-        Initializes the cache with the specified capacity.
-
-        Args:
-            capacity (int): The capacity of the cache.
-
-        Returns:
-            None
-        """
         if cls.__cache is None:
             cls.__cache = LFUCache(capacity=capacity)
 
@@ -497,7 +488,7 @@ async def get_player(self, guild_id: Union[str, int]) -> dict[str, any]:
 
     async def get_players(self) -> list[dict[str, any]]:
         """|coro|
-        
+
         Retrieves a list of players associated with the session ID.
 
         Returns
@@ -540,9 +531,9 @@ async def update_player(
             **kwargs
     ) -> Optional[dict[str, any]]:
         """|coro|
-        
+
         Updates the state of a player with the given guild ID.
-    
+
         Parameters
         ----------
         guild_id : Union[str, int]
@@ -572,12 +563,12 @@ async def update_player(
             If not specified, no additional user data will be associated.
         **kwargs
             Additional keyword arguments to pass to the request.
-    
+
         Returns
         -------
         Optional[dict[str, any]]
             The updated player information, or None if no update was made.
-    
+
         Raises
         ------
             InvalidSession

harmonize/connection/transport.py

@@ -1,5 +1,6 @@
 from __future__ import annotations
 
+import asyncio
 from asyncio import sleep
 from typing import TYPE_CHECKING, Optional
 
@@ -17,9 +18,10 @@
 from harmonize.abstract.serializable import Serializable
 from harmonize.enums import NodeStatus, EndReason, Severity
 from harmonize.exceptions import AuthorizationError, NodeUnknownError, Forbidden, RequestError
-from harmonize.objects import Stats
+from harmonize.objects import Stats, Track
 
 if TYPE_CHECKING:
+    from harmonize import Player
     from harmonize.connection.node import Node
 
 __all__ = (
@@ -97,9 +99,8 @@ async def _connect_back(self) -> None:
                     f"was success to successfully connect/reconnect to Lavalink V4 after "
                     f'{retries} connection attempts.'
                 )
-                self.dispatch("node_ready", self._node)
 
-                await self._listen()
+                asyncio.run_coroutine_threadsafe(self._listen(), loop=asyncio.get_event_loop())
                 break
 
             if self._retries <= retries:
@@ -125,7 +126,18 @@ async def connect(self) -> None:
 
             await self._connect_back()
         except Exception as e:
-            logger.warning(f"Connection timeout to Lavalink V4: {e}")
+            logger.warning(f"An error ({type(e).__name__}) was thrown when connecting: {e}")
+
+    def _handle_ws_closed_event(self, player: Player, data: dict[any, any]) -> None:
+        match int(data["code"]):
+            case 4006:
+                self.dispatch("session_no_longer", player)
+            case 4009:
+                self.dispatch("session_timeout", player)
+            case 4014:
+                self.dispatch("voice_modification", player)
+            case 4015:
+                self.dispatch("voice_crashed", player)
 
     async def _handle_event(self, data: dict[any, any]) -> None:
         player = self._node.players.get(int(data['guildId']))  # type: ignore
@@ -137,19 +149,23 @@ async def _handle_event(self, data: dict[any, any]) -> None:
 
             return
 
+        try:
+            await player.handle_event(data)
+        except Exception as e:
+            logger.error(f'Player {player.guild.id} threw an error whilst handling event : {e}')
+
         if event_type == 'TrackStartEvent':
             self.dispatch(
                 "track_start",
                 player,
                 player.queue.current
             )
         elif event_type == 'TrackEndEvent':
-            end_reason = EndReason(data['reason'])
             self.dispatch(
                 "track_end",
                 player,
-                player.queue.history[0],
-                end_reason
+                Track.from_dict(data["track"]),
+                EndReason(data["reason"])
             )
         elif event_type == 'TrackExceptionEvent':
             exception = data['exception']
@@ -167,19 +183,43 @@ async def _handle_event(self, data: dict[any, any]) -> None:
             assert player.queue.current is not None
             self.dispatch("track_stuck", player, player.queue.current, int(data['thresholdMs']))
         elif event_type == 'WebSocketClosedEvent':
+            """
+            +------+---------------------------+----------------------------------------------------------+
+            | CODE | DESCRIPTION               | EXPLANATION                                              |
+            +======+===========================+==========================================================+
+            | 4001 | Unknown opcode            | You sent an invalid opcode.                              |
+            +------+---------------------------+----------------------------------------------------------+
+            | 4002 | Failed to decode payload  | You sent an invalid payload in your identifying to the   |
+            |      |                           | Gateway.                                                 |
+            +------+---------------------------+----------------------------------------------------------+
+            | 4003 | Not authenticated         | You sent a payload before identifying with the Gateway.  |
+            +------+---------------------------+----------------------------------------------------------+
+            | 4004 | Authentication failed     | The token you sent in your identify payload is incorrect.|
+            +------+---------------------------+----------------------------------------------------------+
+            | 4005 | Already authenticated     | You sent more than one identify payload. Stahp.          |
+            +------+---------------------------+----------------------------------------------------------+
+            | 4006 | Session no longer valid   | Your session is no longer valid.                         |
+            +------+---------------------------+----------------------------------------------------------+
+            | 4009 | Session timeout           | Your session has timed out.                              |
+            +------+---------------------------+----------------------------------------------------------+
+            | 4011 | Server not found          | We can't find the server you're trying to connect to.    |
+            +------+---------------------------+----------------------------------------------------------+
+            | 4012 | Unknown protocol          | We didn't recognize the protocol you sent.               |
+            +------+---------------------------+----------------------------------------------------------+
+            | 4014 | Disconnected              | Channel was deleted, you were kicked, voice server       |
+            |      |                           | changed, or the main gateway session was dropped.        |
+            |      |                           | Should not reconnect.                                    |
+            +------+---------------------------+----------------------------------------------------------+
+            | 4015 | Voice server crashed      | The server crashed. Our bad! Try resuming.               |
+            +------+---------------------------+----------------------------------------------------------+
+            | 4016 | Unknown encryption mode   | We didn't recognize your encryption.                     |
+            +------+---------------------------+----------------------------------------------------------+
+            """
             self.dispatch("discord_ws_closed", player, int(data['code']), data['reason'], bool(data['byRemote']))
+            self._handle_ws_closed_event(player, data)
         else:
             return self.dispatch("extra_event", event_type, player, data)
 
-        if player and event_type in (
-                'TrackStuckEvent',
-                'TrackEndEvent'
-        ):
-            try:
-                await player.handle_event(EndReason(data['reason']))
-            except Exception as e:
-                logger.error(f'Player {player.guild.id} threw an error whilst handling event : {e}')
-
     async def _handle_message(self, data: dict[any, any] | list[any]) -> None:
         if not isinstance(data, dict) or 'op' not in data:
             return