WIP: Add TypedDict definitions for all server messages

Author: Askaholic

server/lobbyconnection.py

@@ -64,6 +64,7 @@
 from .rating_service import RatingService
 from .types import Address, GameLaunchOptions
 from .types.messages import client
+from .types.messages.server import ServerMessage
 
 
 def ice_only(func):
@@ -790,7 +791,7 @@ async def on_player_login(
             "me": self.player.to_dict(),
             "current_time": datetime_now().isoformat(),
 
-            # For backwards compatibility for old clients. For now.
+            # DEPRECATED: Use attributes in `me` instead.
             "id": self.player.id,
             "login": username
         })
@@ -1426,14 +1427,14 @@ def write_warning(
         if fatal:
             asyncio.create_task(self.abort(message))
 
-    async def send(self, message):
+    async def send(self, message: ServerMessage) -> None:
         """Send a message and wait for it to be sent."""
         assert self.protocol is not None
 
         self.write(message)
         await self.protocol.drain()
 
-    def write(self, message):
+    def write(self, message: ServerMessage) -> None:
         """Write a message into the send buffer."""
         assert self.protocol is not None
 

server/matchmaker/matchmaker_queue.py

@@ -7,6 +7,7 @@
 from typing import TYPE_CHECKING, Any, Callable, ClassVar, Iterable, Optional
 
 import server.metrics as metrics
+from server.types.messages.server import MatchmakerInfoQueue
 
 from ..asyncio_extensions import SpinLock, synchronized
 from ..decorators import with_logger
@@ -282,7 +283,7 @@ def shutdown(self):
         self._is_running = False
         self.timer.cancel()
 
-    def to_dict(self):
+    def to_dict(self) -> MatchmakerInfoQueue:
         """
         Return a fuzzy representation of the searches currently in the queue
         """

server/players.py

@@ -10,6 +10,7 @@
 from .factions import Faction
 from .protocol import DisconnectedError
 from .rating import Leaderboard, PlayerRatings, RatingType
+from .types.messages.server import PlayerInfoPlayer, ServerMessage
 from .weakattr import WeakAttribute
 
 if TYPE_CHECKING:
@@ -112,7 +113,7 @@ def is_admin(self) -> bool:
     def is_moderator(self) -> bool:
         return "faf_moderators_global" in self.user_groups
 
-    async def send_message(self, message: dict) -> None:
+    async def send_message(self, message: ServerMessage) -> None:
         """
         Try to send a message to this player.
 
@@ -124,7 +125,7 @@ async def send_message(self, message: dict) -> None:
 
         await self.lobby_connection.send(message)
 
-    def write_message(self, message: dict) -> None:
+    def write_message(self, message: ServerMessage) -> None:
         """
         Try to queue a message to be sent to this player.
 
@@ -136,7 +137,7 @@ def write_message(self, message: dict) -> None:
         with suppress(DisconnectedError):
             self.lobby_connection.write(message)
 
-    def to_dict(self) -> dict:
+    def to_dict(self) -> PlayerInfoPlayer:
         """
         Return a dictionary representing this player object
         """

server/protocol/protocol.py

@@ -4,6 +4,8 @@
 import json
 from abc import ABCMeta, abstractmethod
 from asyncio import StreamReader, StreamWriter
+from collections.abc import Mapping, Sequence
+from typing import Any
 
 import server.metrics as metrics
 
@@ -25,15 +27,15 @@ def __init__(self, reader: StreamReader, writer: StreamWriter):
 
     @staticmethod
     @abstractmethod
-    def encode_message(message: dict) -> bytes:
+    def encode_message(message: Mapping[str, Any]) -> bytes:
         """
         Encode a message as raw bytes. Can be used along with `*_raw` methods.
         """
         pass  # pragma: no cover
 
     @staticmethod
     @abstractmethod
-    def decode_message(data: bytes) -> dict:
+    def decode_message(data: bytes) -> dict[str, Any]:
         """
         Decode a message from raw bytes.
         """
@@ -46,7 +48,7 @@ def is_connected(self) -> bool:
         return not self.writer.is_closing()
 
     @abstractmethod
-    async def read_message(self) -> dict:
+    async def read_message(self) -> dict[str, Any]:
         """
         Asynchronously read a message from the stream
 
@@ -58,7 +60,7 @@ async def read_message(self) -> dict:
         """
         pass  # pragma: no cover
 
-    async def send_message(self, message: dict) -> None:
+    async def send_message(self, message: Mapping[str, Any]) -> None:
         """
         Send a single message in the form of a dictionary
 
@@ -67,7 +69,7 @@ async def send_message(self, message: dict) -> None:
         """
         await self.send_raw(self.encode_message(message))
 
-    async def send_messages(self, messages: list[dict]) -> None:
+    async def send_messages(self, messages: Sequence[Mapping[str, Any]]) -> None:
         """
         Send multiple messages in the form of a list of dictionaries.
 
@@ -89,7 +91,7 @@ async def send_raw(self, data: bytes) -> None:
         self.write_raw(data)
         await self.drain()
 
-    def write_message(self, message: dict) -> None:
+    def write_message(self, message: Mapping[str, Any]) -> None:
         """
         Write a single message into the message buffer. Should be used when
         sending broadcasts or when sending messages that are triggered by
@@ -103,7 +105,7 @@ def write_message(self, message: dict) -> None:
 
         self.write_raw(self.encode_message(message))
 
-    def write_messages(self, messages: list[dict]) -> None:
+    def write_messages(self, messages: Sequence[Mapping[str, Any]]) -> None:
         """
         Write multiple message into the message buffer.
 

server/protocol/qdatastream.py

@@ -24,7 +24,8 @@
 import logging
 import struct
 from asyncio import IncompleteReadError
-from typing import ClassVar
+from collections.abc import Mapping
+from typing import Any, ClassVar
 
 from server.decorators import with_logger
 
@@ -95,7 +96,7 @@ def pack_message(*args: str) -> bytes:
         return QDataStreamProtocol.pack_block(msg)
 
     @staticmethod
-    def encode_message(message: dict) -> bytes:
+    def encode_message(message: Mapping[str, Any]) -> bytes:
         """
         Encodes a python object as a block of QStrings
         """
@@ -108,7 +109,7 @@ def encode_message(message: dict) -> bytes:
         return QDataStreamProtocol.pack_message(json_encoder.encode(message))
 
     @staticmethod
-    def decode_message(data: bytes) -> dict:
+    def decode_message(data: bytes) -> dict[str, Any]:
         _, action = QDataStreamProtocol.read_qstring(data)
         if action in ("PING", "PONG"):
             return {"command": action.lower()}
@@ -128,7 +129,7 @@ def decode_message(data: bytes) -> dict:
             pass
         return message
 
-    async def read_message(self):
+    async def read_message(self) -> dict[str, Any]:
         """
         Read a message from the stream
 

server/protocol/simple_json.py

@@ -9,20 +9,22 @@
 """
 
 import json
+from collections.abc import Mapping
+from typing import Any
 
 from .protocol import DisconnectedError, Protocol, json_encoder
 
 
 class SimpleJsonProtocol(Protocol):
     @staticmethod
-    def encode_message(message: dict) -> bytes:
+    def encode_message(message: Mapping[str, Any]) -> bytes:
         return (json_encoder.encode(message) + "\n").encode()
 
     @staticmethod
-    def decode_message(data: bytes) -> dict:
+    def decode_message(data: bytes) -> dict[str, Any]:
         return json.loads(data.strip())
 
-    async def read_message(self) -> dict:
+    async def read_message(self) -> dict[str, Any]:
         line = await self.reader.readline()
         if not line:
             raise DisconnectedError()

server/types/messages/client.py

@@ -213,6 +213,9 @@ class AvatarSelect(TypedDict):
 class CoopList(TypedDict):
     """Request a list of available coop missions.
 
+    Responds with a `server.types.messages.server.CoopInfo` message for each
+    coop mission.
+
     **Example**
     ```json
     {
@@ -430,6 +433,9 @@ class LeaveParty(TypedDict):
 class MatchmakerInfo(TypedDict):
     """Request a list of available matchmaker queues.
 
+    Responds with a `server.types.messages.server.MatchmakerInfo` message
+    describing the currently available matchmaker queues.
+
     **Example**
     ```json
     {