Introduce typed packets (#728)

* Introduce typed packets

Packets are required to be structs to help minimize any overhead

* Typed Server_PlayerList packet

* Typed {Client,Server}_Cursor packet

* Typed {Client,Server}_Command packet

* Typed {Client,Server}_PingLocation packet

* Add packet serialization round trip tests

* Add binary snapshot tests for packet serialization

* Ensure packets are fully consumed

Author: mibac138

Source/Client/Networking/State/ClientPlayingState.cs

@@ -1,9 +1,9 @@
+using System;
+using System.Collections.Generic;
 using Ionic.Zlib;
 using Multiplayer.Common;
+using Multiplayer.Common.Networking.Packet;
 using RimWorld;
-using RimWorld.Planet;
-using System;
-using System.Collections.Generic;
 using UnityEngine;
 using Verse;
 
@@ -17,88 +17,78 @@ public class ClientPlayingState(ConnectionBase connection) : ClientBaseState(con
         [PacketHandler(Packets.Server_TimeControl)]
         public new void HandleTimeControl(ByteReader data) => base.HandleTimeControl(data);
 
-        [PacketHandler(Packets.Server_Command)]
-        public void HandleCommand(ByteReader data)
+        [TypedPacketHandler]
+        public void HandleCommand(ServerCommandPacket packet)
         {
-            ScheduledCommand cmd = ScheduledCommand.Deserialize(data);
-            Session.ScheduleCommand(cmd);
-
+            Session.ScheduleCommand(packet.ToCommand());
             Multiplayer.session.receivedCmds++;
             Multiplayer.session.ProcessTimeControl();
         }
 
-        [PacketHandler(Packets.Server_PlayerList)]
-        public void HandlePlayerList(ByteReader data)
+        [TypedPacketHandler]
+        public void HandlePlayerList(ServerPlayerListPacket packet)
         {
-            var action = data.ReadEnum<PlayerListAction>();
-            if (action == PlayerListAction.Add)
+            if (packet.action == PlayerListAction.Add)
             {
-                var info = PlayerInfo.Read(data);
-                if (!Multiplayer.session.players.Contains(info))
-                {
-                    ServerLog.Log($"PlayerList: Adding player {info.id}:{info.username}");
-                    Multiplayer.session.players.Add(info);
-                }
-                else
+                foreach (var info in packet.players)
                 {
-                    ServerLog.Error($"PlayerList: Adding player {info.id}:{info.username} - player already exists");
+                    if (!Multiplayer.session.players.Any(p => p.id == info.id || p.username == info.username))
+                    {
+                        ServerLog.Log($"PlayerList: Adding player {info.id}:{info.username}");
+                        Multiplayer.session.players.Add(PlayerInfo.FromNet(info));
+                    }
+                    else
+                    {
+                        ServerLog.Error($"PlayerList: Adding player {info.id}:{info.username} - player already exists");
+                    }
                 }
             }
-            else if (action == PlayerListAction.Remove)
+            else if (packet.action == PlayerListAction.Remove)
             {
-                int id = data.ReadInt32();
-                ServerLog.Log($"PlayerList: Removing player with id {id}");
-                var matches = Multiplayer.session.players.RemoveAll(p => p.id == id);
+                ServerLog.Log($"PlayerList: Removing player with id {packet.playerId}");
+                var matches = Multiplayer.session.players.RemoveAll(p => p.id == packet.playerId);
                 if (matches > 1)
                 {
-                    ServerLog.Error($"PlayerList: Removing player with id {id} -- occurred {matches} times. This should not happen");
+                    ServerLog.Error($"PlayerList: Removing player with id {packet.playerId} -- occurred {matches} times. This should not happen");
                 }
             }
-            else if (action == PlayerListAction.List)
+            else if (packet.action == PlayerListAction.List)
             {
-                int count = data.ReadInt32();
-                ServerLog.Log($"PlayerList: Received player list with {count} entries");
+                ServerLog.Log($"PlayerList: Received player list with {packet.players.Length} entries");
 
                 Multiplayer.session.players.Clear();
-                for (int i = 0; i < count; i++)
+                foreach (var info in packet.players)
                 {
-                    var info = PlayerInfo.Read(data);
                     ServerLog.Log($"PlayerList: Adding player from list {info.id}:{info.username}");
-                    Multiplayer.session.players.Add(info);
+                    Multiplayer.session.players.Add(PlayerInfo.FromNet(info));
                 }
             }
-            else if (action == PlayerListAction.Latencies)
+            else if (packet.action == PlayerListAction.Latencies)
             {
-                int count = data.ReadInt32();
-
-                for (int i = 0; i < count; i++)
+                foreach (var latency in packet.latencies)
                 {
-                    var id = data.ReadInt32();
-                    var player = Multiplayer.session.GetPlayerInfo(id);
+                    var player = Multiplayer.session.GetPlayerInfo(latency.playerId);
                     if (player == null)
                     {
-                        ServerLog.Log($"PlayerList: Received latency info for unknown player with id {id}");
+                        ServerLog.Log($"PlayerList: Received latency info for unknown player with id {latency.playerId}");
                         continue;
                     }
-                    player.latency = data.ReadInt32();
-                    player.ticksBehind = data.ReadInt32();
-                    player.simulating = data.ReadBool();
-                    player.frameTime = data.ReadFloat();
+                    player.latency = latency.latency;
+                    player.ticksBehind = latency.ticksBehind;
+                    player.simulating = latency.simulating;
+                    player.frameTime = latency.frameTime;
                 }
             }
-            else if (action == PlayerListAction.Status)
+            else if (packet.action == PlayerListAction.Status)
             {
-                var id = data.ReadInt32();
-                var status = data.ReadEnum<PlayerStatus>();
-                var player = Multiplayer.session.GetPlayerInfo(id);
-
+                var player = Multiplayer.session.GetPlayerInfo(packet.playerId);
                 if (player == null)
                 {
-                    ServerLog.Log($"PlayerList: Received player status ({status}) for unknown player with id {id}");
+                    ServerLog.Log($"PlayerList: Received player status ({packet.status}) for unknown player with id {packet.playerId}");
                 }
                 else
                 {
-                    player.status = status;
+                    player.status = packet.status;
                 }
             }
         }
@@ -110,44 +100,26 @@ public void HandleChat(ByteReader data)
             Multiplayer.session.AddMsg(msg);
         }
 
-        [PacketHandler(Packets.Server_Cursor)]
-        public void HandleCursor(ByteReader data)
+        [TypedPacketHandler]
+        public void HandleCursor(ServerCursorPacket packet)
         {
-            int playerId = data.ReadInt32();
-            var player = Multiplayer.session.GetPlayerInfo(playerId);
+            var player = Multiplayer.session.GetPlayerInfo(packet.playerId);
             if (player == null) return;
 
-            byte seq = data.ReadByte();
-            if (seq < player.cursorSeq && player.cursorSeq - seq < 128) return;
-
-            byte map = data.ReadByte();
-            player.map = map;
-
-            if (map == byte.MaxValue) return;
+            var data = packet.data;
+            if (data.seq < player.cursorSeq && player.cursorSeq - data.seq < 128) return;
 
-            byte icon = data.ReadByte();
-            float x = data.ReadShort() / 10f;
-            float z = data.ReadShort() / 10f;
+            player.map = data.map;
+            if (data.map == byte.MaxValue) return;
 
-            player.cursorSeq = seq;
+            player.cursorSeq = data.seq;
             player.lastCursor = player.cursor;
             player.lastDelta = Multiplayer.clock.ElapsedMillisDouble() - player.updatedAt;
-            player.cursor = new Vector3(x, 0, z);
+            player.cursor = new Vector3(data.x, 0, data.z);
             player.updatedAt = Multiplayer.clock.ElapsedMillisDouble();
-            player.cursorIcon = icon;
+            player.cursorIcon = data.icon;
 
-            short dragXRaw = data.ReadShort();
-            if (dragXRaw != -1)
-            {
-                float dragX = dragXRaw / 10f;
-                float dragZ = data.ReadShort() / 10f;
-
-                player.dragStart = new Vector3(dragX, 0, dragZ);
-            }
-            else
-            {
-                player.dragStart = PlayerInfo.Invalid;
-            }
+            player.dragStart = data.HasDrag ? new Vector3(data.dragX, 0, data.dragZ) : PlayerInfo.Invalid;
         }
 
         [PacketHandler(Packets.Server_Selected)]
@@ -171,16 +143,8 @@ public void HandleSelected(ByteReader data)
                 player.selectedThings.Remove(remove[i]);
         }
 
-        [PacketHandler(Packets.Server_PingLocation)]
-        public void HandlePing(ByteReader data)
-        {
-            int player = data.ReadInt32();
-            int map = data.ReadInt32();
-            PlanetTile planetTile = new(data.ReadInt32(), data.ReadInt32());
-            var loc = new Vector3(data.ReadFloat(), data.ReadFloat(), data.ReadFloat());
-
-            Session.locationPings.ReceivePing(player, map, planetTile, loc);
-        }
+        [TypedPacketHandler]
+        public void HandlePing(ServerPingLocPacket packet) => Session.locationPings.ReceivePing(packet);
 
         [PacketHandler(Packets.Server_MapResponse)]
         public void HandleMapResponse(ByteReader data)

Source/Client/Session/PlayerInfo.cs

@@ -2,6 +2,7 @@
 using Multiplayer.Common;
 using System.Collections.Generic;
 using System.Linq;
+using Multiplayer.Common.Networking.Packet;
 using UnityEngine;
 using Verse;
 
@@ -60,34 +61,23 @@ private PlayerInfo(int id, string username, int latency, PlayerType type)
         this.type = type;
     }
 
-    public static PlayerInfo Read(ByteReader data)
+    public static PlayerInfo FromNet(ServerPlayerListPacket.PlayerInfo info)
     {
-        int id = data.ReadInt32();
-        string username = data.ReadString();
-        int latency = data.ReadInt32();
-        var type = data.ReadEnum<PlayerType>();
-        var status = data.ReadEnum<PlayerStatus>();
-
-        var steamId = data.ReadULong();
-        var steamName = data.ReadString();
-
-        var ticksBehind = data.ReadInt32();
-        var simulating = data.ReadBool();
+        var color = new Color(info.r / 255f, info.g / 255f, info.b / 255f);
+        return new PlayerInfo(id: info.id, username: info.username, latency: info.latency, type: info.type)
+        {
+            status = info.status,
 
-        var color = new Color(data.ReadByte() / 255f, data.ReadByte() / 255f, data.ReadByte() / 255f);
+            steamId = info.steamId,
+            steamPersonaName = info.steamPersonaName,
 
-        int factionId = data.ReadInt32();
+            ticksBehind = info.ticksBehind,
+            simulating = info.simulating,
 
-        return new PlayerInfo(id, username, latency, type)
-        {
-            status = status,
-            steamId = steamId,
-            steamPersonaName = steamName,
             color = color,
             selectionBracketMaterial = MaterialPool.MatFrom("UI/Overlays/SelectionBracket", ShaderDatabase.MetaOverlay, color * new Color(1, 1, 1, 0.5f)),
-            ticksBehind = ticksBehind,
-            simulating = simulating,
-            factionId = factionId
+
+            factionId = info.factionId,
         };
     }
 }

Source/Client/UI/LocationPings.cs

@@ -1,6 +1,6 @@
 using System.Collections.Generic;
 using Multiplayer.Client.Util;
-using Multiplayer.Common;
+using Multiplayer.Common.Networking.Packet;
 using RimWorld;
 using RimWorld.Planet;
 using UnityEngine;
@@ -60,27 +60,25 @@ private static bool KeyDown(KeyCode? keyNullable)
 
     private void PingLocation(int map, PlanetTile tile, Vector3 loc)
     {
-        var writer = new ByteWriter();
-        writer.WriteInt32(map);
-        writer.WriteInt32(tile.tileId);
-        writer.WriteInt32(tile.layerId);
-        writer.WriteFloat(loc.x);
-        writer.WriteFloat(loc.y);
-        writer.WriteFloat(loc.z);
-        Multiplayer.Client.Send(Packets.Client_PingLocation, writer.ToArray());
-
+        Multiplayer.Client.Send(new ClientPingLocPacket(map, tile.tileId, tile.layerId, loc.x, loc.y, loc.z));
         SoundDefOf.TinyBell.PlayOneShotOnCamera();
     }
 
-    public void ReceivePing(int player, int map, PlanetTile tile, Vector3 loc)
+    public void ReceivePing(ServerPingLocPacket packet)
     {
         if (!Multiplayer.settings.enablePings) return;
 
-        pings.RemoveAll(p => p.player == player);
-        pings.Add(new PingInfo { player = player, mapId = map, planetTile = tile, mapLoc = loc });
+        var data = packet.data;
+        pings.RemoveAll(p => p.player == packet.playerId);
+        pings.Add(new PingInfo {
+            player = packet.playerId,
+            mapId = data.mapId,
+            planetTile = new PlanetTile(data.planetTileId, data.planetTileLayer),
+            mapLoc = new Vector3(data.x, data.y, data.z)
+        });
         alertHidden = false;
 
-        if (player != Multiplayer.session.playerId)
+        if (packet.playerId != Multiplayer.session.playerId)
             SoundDefOf.TinyBell.PlayOneShotOnCamera();
     }
 }

Source/Client/UI/PlayerCursors.cs

@@ -1,6 +1,7 @@
 using System.Collections.Generic;
 using System.Linq;
 using Multiplayer.Common;
+using Multiplayer.Common.Networking.Packet;
 using RimWorld.Planet;
 using UnityEngine;
 using Verse;
@@ -33,31 +34,30 @@ public void SendVisuals()
 
     private void SendCursor()
     {
-        var writer = new ByteWriter();
-        writer.WriteByte(cursorSeq++);
+        var packet = new ClientCursorPacket(cursorSeq++);
 
         if (Find.CurrentMap != null && !WorldRendererUtility.WorldSelected)
         {
-            writer.WriteByte((byte)Find.CurrentMap.Index);
+            packet.map = (byte)Find.CurrentMap.Index;
 
             var icon = Find.MapUI?.designatorManager?.SelectedDesignator?.icon;
             int iconId = icon == null ? 0 :
                 !MultiplayerData.icons.Contains(icon) ? 0 : MultiplayerData.icons.IndexOf(icon);
-            writer.WriteByte((byte)iconId);
+            packet.icon = (byte)iconId;
 
-            writer.WriteVectorXZ(UI.MouseMapPosition());
+            var mapPosition = UI.MouseMapPosition();
+            packet.x = mapPosition.x;
+            packet.z = mapPosition.z;
 
             if (Find.Selector.dragBox.IsValidAndActive)
-                writer.WriteVectorXZ(Find.Selector.dragBox.start);
-            else
-                writer.WriteShort(-1);
-        }
-        else
-        {
-            writer.WriteByte(byte.MaxValue);
+            {
+                var dragVec = Find.Selector.dragBox.start;
+                packet.dragX = dragVec.x;
+                packet.dragZ = dragVec.z;
+            }
         }
 
-        Multiplayer.Client.Send(Packets.Client_Cursor, writer.ToArray(), reliable: false);
+        Multiplayer.Client.Send(packet, reliable: false);
     }
 
     private void SendSelected()