refactor: remove channel from handler (#824)

BREAKING CHANGE: NetworkDiagnostics no longer tracks channel

Assets/Mirage/Runtime/NetworkDiagnostics.cs

@@ -19,10 +19,6 @@ public static class NetworkDiagnostics
             /// </summary>
             public readonly object message;
             /// <summary>
-            /// channel through which the message was sent
-            /// </summary>
-            public readonly int channel;
-            /// <summary>
             /// how big was the message (does not include transport headers)
             /// </summary>
             public readonly int bytes;
@@ -32,10 +28,9 @@ public static class NetworkDiagnostics
             /// </summary>
             public readonly int count;
 
-            internal MessageInfo(object message, int channel, int bytes, int count)
+            internal MessageInfo(object message, int bytes, int count)
             {
                 this.message = message;
-                this.channel = channel;
                 this.bytes = bytes;
                 this.count = count;
             }
@@ -48,11 +43,11 @@ internal MessageInfo(object message, int channel, int bytes, int count)
         /// </summary>
         public static event Action<MessageInfo> OutMessageEvent;
 
-        internal static void OnSend<T>(T message, int channel, int bytes, int count)
+        internal static void OnSend<T>(T message, int bytes, int count)
         {
             if (count > 0 && OutMessageEvent != null)
             {
-                var outMessage = new MessageInfo(message, channel, bytes, count);
+                var outMessage = new MessageInfo(message, bytes, count);
                 OutMessageEvent.Invoke(outMessage);
             }
         }
@@ -66,11 +61,11 @@ internal static void OnSend<T>(T message, int channel, int bytes, int count)
         /// </summary>
         public static event Action<MessageInfo> InMessageEvent;
 
-        internal static void OnReceive<T>(T message, int channel, int bytes)
+        internal static void OnReceive<T>(T message, int bytes)
         {
             if (InMessageEvent != null)
             {
-                var inMessage = new MessageInfo(message, channel, bytes, 1);
+                var inMessage = new MessageInfo(message, bytes, 1);
                 InMessageEvent.Invoke(inMessage);
             }
         }

Assets/Mirage/Runtime/NetworkPlayer.cs

@@ -25,7 +25,7 @@ public sealed class NetworkPlayer : INetworkPlayer
         static readonly ILogger logger = LogFactory.GetLogger(typeof(NetworkPlayer));
 
         // Handles network messages on client and server
-        internal delegate void NetworkMessageDelegate(INetworkPlayer player, NetworkReader reader, int channelId);
+        internal delegate void NetworkMessageDelegate(INetworkPlayer player, NetworkReader reader);
 
         // internal so it can be tested
         private readonly HashSet<NetworkIdentity> visList = new HashSet<NetworkIdentity>();
@@ -120,7 +120,7 @@ public NetworkPlayer(SocketLayer.IConnection connection)
 
         private static NetworkMessageDelegate MessageHandler<T>(Action<INetworkPlayer, T> handler)
         {
-            void AdapterFunction(INetworkPlayer player, NetworkReader reader, int channelId)
+            void AdapterFunction(INetworkPlayer player, NetworkReader reader)
             {
                 // protect against DOS attacks if attackers try to send invalid
                 // data packets to crash the server/client. there are a thousand
@@ -145,7 +145,7 @@ void AdapterFunction(INetworkPlayer player, NetworkReader reader, int channelId)
                 finally
                 {
                     int endPos = reader.Position;
-                    NetworkDiagnostics.OnReceive(message, channelId, endPos - startPos);
+                    NetworkDiagnostics.OnReceive(message, endPos - startPos);
                 }
 
                 handler(player, message);
@@ -213,7 +213,7 @@ public void Send<T>(T message, int channelId = Channel.Reliable)
             {
                 // pack message and send allocation free
                 MessagePacker.Pack(message, writer);
-                NetworkDiagnostics.OnSend(message, channelId, writer.Length, 1);
+                NetworkDiagnostics.OnSend(message, writer.Length, 1);
                 Send(writer.ToArraySegment(), channelId);
             }
         }
@@ -261,11 +261,11 @@ public void RemoveObservers()
             visList.Clear();
         }
 
-        internal void InvokeHandler(int msgType, NetworkReader reader, int channelId)
+        internal void InvokeHandler(int msgType, NetworkReader reader)
         {
             if (messageHandlers.TryGetValue(msgType, out NetworkMessageDelegate msgDelegate))
             {
-                msgDelegate(this, reader, channelId);
+                msgDelegate(this, reader);
             }
             else
             {
@@ -289,10 +289,7 @@ void IMessageHandler.HandleMessage(ArraySegment<byte> packet)
                 try
                 {
                     int msgType = MessagePacker.UnpackId(networkReader);
-
-                    // todo remove channel from handler
-                    const int channelId = 0;
-                    InvokeHandler(msgType, networkReader, channelId);
+                    InvokeHandler(msgType, networkReader);
                 }
                 catch (InvalidDataException ex)
                 {

Assets/Mirage/Runtime/NetworkServer.cs

@@ -375,7 +375,7 @@ public static void SendToMany<T>(IEnumerable<INetworkPlayer> players, T msg, int
                     count++;
                 }
 
-                NetworkDiagnostics.OnSend(msg, channelId, segment.Count, count);
+                NetworkDiagnostics.OnSend(msg, segment.Count, count);
             }
         }
 

Assets/Tests/Runtime/NetworkDiagnosticsTests.cs

@@ -14,8 +14,8 @@ public void TestOnSendEvent()
             NetworkDiagnostics.OutMessageEvent += outMessageCallback;
 
             var message = new TestMessage();
-            NetworkDiagnostics.OnSend(message, Channel.Reliable, 10, 5);
-            var expected = new NetworkDiagnostics.MessageInfo(message, Channel.Reliable, 10, 5);
+            NetworkDiagnostics.OnSend(message, 10, 5);
+            var expected = new NetworkDiagnostics.MessageInfo(message, 10, 5);
             outMessageCallback.Received(1).Invoke(Arg.Is(expected));
 
             NetworkDiagnostics.OutMessageEvent -= outMessageCallback;
@@ -28,7 +28,7 @@ public void TestOnSendZeroCountEvent()
             NetworkDiagnostics.OutMessageEvent += outMessageCallback;
 
             var message = new TestMessage();
-            NetworkDiagnostics.OnSend(message, Channel.Reliable, 10, 0);
+            NetworkDiagnostics.OnSend(message, 10, 0);
             outMessageCallback.DidNotReceive();
 
             NetworkDiagnostics.OutMessageEvent -= outMessageCallback;
@@ -41,8 +41,8 @@ public void TestOnReceiveEvent()
             NetworkDiagnostics.InMessageEvent += outMessageCallback;
 
             var message = new TestMessage();
-            NetworkDiagnostics.OnReceive(message, Channel.Reliable, 10);
-            var expected = new NetworkDiagnostics.MessageInfo(message, Channel.Reliable, 10, 1);
+            NetworkDiagnostics.OnReceive(message, 10);
+            var expected = new NetworkDiagnostics.MessageInfo(message, 10, 1);
             outMessageCallback.Received(1).Invoke(Arg.Is(expected));
 
             NetworkDiagnostics.InMessageEvent -= outMessageCallback;

Assets/Tests/Runtime/Serializers/NetworkPlayerTest.cs

@@ -93,7 +93,7 @@ public void ThrowsWhenNoHandlerIsFound()
             var reader = new NetworkReader(new byte[] { 1, 2, 3, 4 });
             InvalidDataException exception = Assert.Throws<InvalidDataException>(() =>
             {
-                player.InvokeHandler(messageId, reader, 0);
+                player.InvokeHandler(messageId, reader);
             });
 
             Assert.That(exception.Message, Does.StartWith("Unexpected message Mirage.SceneMessage received"));
@@ -107,7 +107,7 @@ public void ThrowsWhenUnknownMessage()
             InvalidDataException exception = Assert.Throws<InvalidDataException>(() =>
             {
                 // some random id with no message
-                player.InvokeHandler(1234, reader, 0);
+                player.InvokeHandler(1234, reader);
             });
 
             Assert.That(exception.Message, Does.StartWith("Unexpected message ID 1234 received"));