Fix accidental restoration of initial presence

Author: dolfies

discord/client.py

@@ -449,15 +449,24 @@ def _handle_ready(self) -> None:
         self._ready.set()
 
     def _handle_connect(self) -> None:
-        state = self._connection
+        if self.ws._has_sent_presence:
+            _log.debug('Skipping initial presence as one has already been sent.')
+            return
+
         activities = self.initial_activities
         status = self.initial_status
-        if status or activities:
+        afk = self.initial_afk
+        since = self.initial_idle_since
+        if status or activities or afk or since:
             if status is None:
-                status = getattr(state.settings, 'status', None) or Status.unknown
-            _log.debug('Setting initial presence to %s %s', status, activities)
+                status = getattr(self._connection.settings, 'status', None) or Status.unknown
+            _log.debug(
+                'Setting initial presence to (status=%s, activities=%s, afk=%s, since=%s)', status, activities, afk, since
+            )
             self.loop.create_task(
-                self.change_presence(activities=activities, status=status, edit_settings=self._sync_presences)
+                self.change_presence(
+                    activities=activities, status=status, afk=afk, idle_since=since, edit_settings=self._sync_presences
+                )
             )
 
     @property
@@ -1024,7 +1033,7 @@ async def connect(self, *, reconnect: bool = True) -> None:
             except ReconnectWebSocket as e:
                 _log.debug('Got a request to %s the websocket.', e.op)
                 self.dispatch('disconnect')
-                ws_params.update(sequence=self.ws.sequence, resume=e.resume, session=self.ws.session_id)
+                ws_params.update(sequence=self.ws.sequence, resume=e.resume, session=self.ws.session_id, old_ws=self.ws)
                 if e.resume:
                     ws_params['gateway'] = self.ws.gateway
                 continue
@@ -1056,6 +1065,7 @@ async def connect(self, *, reconnect: bool = True) -> None:
                         initial=False,
                         resume=True,
                         session=self.ws.session_id,
+                        old_ws=self.ws,
                     )
                     continue
 
@@ -1079,6 +1089,7 @@ async def connect(self, *, reconnect: bool = True) -> None:
                     gateway=self.ws.gateway,
                     resume=True,
                     session=self.ws.session_id,
+                    old_ws=self.ws,
                 )
 
     async def close(self) -> None:
@@ -1305,6 +1316,34 @@ def initial_status(self, value: Status):
         else:
             raise TypeError('status must derive from Status')
 
+    @property
+    def initial_afk(self) -> bool:
+        """:class:`bool`: Whether the client is set to AFK upon logging in.
+
+        .. versionadded:: 2.2
+        """
+        return self._connection._afk
+
+    @initial_afk.setter
+    def initial_afk(self, value: bool):
+        self._connection._afk = bool(value)
+
+    @property
+    def initial_idle_since(self) -> Optional[datetime]:
+        """Optional[:class:`datetime.datetime`]: When the client is set to go idle upon logging in.
+
+        .. versionadded:: 2.2
+        """
+        idle_since = self._connection._idle_since
+        if idle_since is not None:
+            return utils.parse_timestamp(idle_since)
+
+    @initial_idle_since.setter
+    def initial_idle_since(self, value: Optional[datetime]):
+        if value is not None and not isinstance(value, datetime):
+            raise TypeError('idle_since must be a datetime.datetime or None')
+        self._connection._idle_since = int(value.timestamp() * 1000) if value else 0
+
     @property
     def status(self) -> Status:
         """:class:`.Status`: The user's overall status.
@@ -1835,7 +1874,7 @@ async def change_presence(
 
         .. code-block:: python3
 
-            game = discord.Game("with the API")
+            game = discord.Activity(name="with the API")
             await client.change_presence(status=discord.Status.idle, activity=game)
 
         Parameters

discord/gateway.py

@@ -334,6 +334,7 @@ def __init__(self, socket: AsyncWebSocket, *, loop: asyncio.AbstractEventLoop) -
         self.activities: List[ActivityPayload] = []
         self.afk: bool = False
         self.idle_since: int = 0
+        self._has_sent_presence: bool = False
 
     @property
     def open(self) -> bool:
@@ -364,6 +365,7 @@ async def from_client(
         resume: bool = False,
         encoding: str = 'json',
         compress: bool = True,
+        old_ws: Optional[Self] = None,
     ) -> Self:
         """Creates a main websocket for Discord from a :class:`Client`.
 
@@ -400,6 +402,15 @@ async def from_client(
         ws.afk = client._connection._afk
         ws.idle_since = client._connection._idle_since
 
+        if old_ws is not None:
+            # Copy over the presence state from the old websocket
+            ws.status = old_ws.status
+            ws.activities = old_ws.activities
+            ws.afk = old_ws.afk
+            ws.idle_since = old_ws.idle_since
+            # Avoids resetting to initial presence on reconnect
+            ws._has_sent_presence = old_ws._has_sent_presence
+
         if client._enable_debug_events:
             ws.send = ws.debug_send
             ws.log_receive = ws.debug_log_receive
@@ -452,22 +463,13 @@ async def identify(self) -> None:
         # This payload is only sometimes respected; usually the gateway tells
         # us our presence through the READY packet's sessions key
         # However, when reidentifying, we should send our last known presence
-        # initial_status and initial_activities could probably also be sent here
-        # but that needs more testing...
+        # This is what the client does to ensure RPC is persisted across reconnects
         presence = {
-            'status': 'unknown',
-            'since': self.idle_since,
-            'activities': [],
+            'status': self.status,
+            'activities': self.activities,
             'afk': self.afk,
+            'since': self.idle_since,
         }
-        existing = self._connection.current_session
-        if existing is not None:
-            presence['status'] = str(existing.status) if existing.status is not Status.offline else 'invisible'
-            presence['activities'] = [a.to_dict() for a in existing.activities]
-        # else:
-        #     presence['status'] = self._connection._status or 'unknown'
-        #     presence['activities'] = self._connection._activities
-
         properties = self._headers.gateway_properties
 
         payload = {
@@ -744,6 +746,7 @@ async def change_presence(
         self.activities = list(activities or [])
         self.afk = afk
         self.idle_since = since
+        self._has_sent_presence = True
 
     async def guild_subscribe(
         self,