Client Connection Ids and Game Object registration (#863)

Jean-Sébastien Fauteux · web-flow · commit 103cd521588a · 2021-06-03T14:30:07.000-04:00
* Client Connection Ids and Game Object registration

* Fixing connection to use local and avoid allocation at every new metrics

* Fixed client id connections to point to other clients

* Using IReadOnlyCollection instead of explicit List

* Changing variable name to sender and receiver
diff --git a/com.unity.multiplayer.mlapi/Runtime/Messaging/CustomMessageManager.cs b/com.unity.multiplayer.mlapi/Runtime/Messaging/CustomMessageManager.cs
@@ -96,13 +96,13 @@ internal void InvokeNamedMessage(ulong hash, ulong sender, Stream stream)
                 if (m_NamedMessageHandlers32.TryGetValue(hash, out HandleNamedMessageDelegate messageHandler32))
                 {
                     messageHandler32(sender, stream);
-                    m_NetworkManager.NetworkMetrics.TrackNamedMessageReceived(m_MessageHandlerNameLookup32[hash], bytesCount);
+                    m_NetworkManager.NetworkMetrics.TrackNamedMessageReceived(sender, m_MessageHandlerNameLookup32[hash], bytesCount);
                 }
 
                 if (m_NamedMessageHandlers64.TryGetValue(hash, out HandleNamedMessageDelegate messageHandler64))
                 {
                     messageHandler64(sender, stream);
-                    m_NetworkManager.NetworkMetrics.TrackNamedMessageReceived(m_MessageHandlerNameLookup64[hash], bytesCount);
+                    m_NetworkManager.NetworkMetrics.TrackNamedMessageReceived(sender, m_MessageHandlerNameLookup64[hash], bytesCount);
                 }
             }
             else
@@ -114,14 +114,14 @@ internal void InvokeNamedMessage(ulong hash, ulong sender, Stream stream)
                         if (m_NamedMessageHandlers32.TryGetValue(hash, out HandleNamedMessageDelegate messageHandler32))
                         {
                             messageHandler32(sender, stream);
-                            m_NetworkManager.NetworkMetrics.TrackNamedMessageReceived(m_MessageHandlerNameLookup32[hash], bytesCount);
+                            m_NetworkManager.NetworkMetrics.TrackNamedMessageReceived(sender, m_MessageHandlerNameLookup32[hash], bytesCount);
                         }
                         break;
                     case HashSize.VarIntEightBytes:
                         if (m_NamedMessageHandlers64.TryGetValue(hash, out HandleNamedMessageDelegate messageHandler64))
                         {
                             messageHandler64(sender, stream);
-                            m_NetworkManager.NetworkMetrics.TrackNamedMessageReceived(m_MessageHandlerNameLookup64[hash], bytesCount);
+                            m_NetworkManager.NetworkMetrics.TrackNamedMessageReceived(sender, m_MessageHandlerNameLookup64[hash], bytesCount);
                         }
                         break;
                 }
@@ -190,8 +190,8 @@ public void SendNamedMessage(string name, ulong clientId, Stream stream, Network
 
                 m_NetworkManager.MessageSender.Send(clientId, NetworkConstants.NAMED_MESSAGE, networkChannel, messageBuffer);
                 PerformanceDataManager.Increment(ProfilerConstants.NamedMessageSent);
-                
-                m_NetworkManager.NetworkMetrics.TrackNamedMessageSent(name, (ulong)messageBuffer.Length);
+
+                m_NetworkManager.NetworkMetrics.TrackNamedMessageSent(clientId, name, (ulong)messageBuffer.Length);
             }
         }
 
@@ -235,7 +235,7 @@ public void SendNamedMessage(string name, List<ulong> clientIds, Stream stream,
                 m_NetworkManager.MessageSender.Send(NetworkConstants.NAMED_MESSAGE, networkChannel, clientIds, messageBuffer);
                 PerformanceDataManager.Increment(ProfilerConstants.NamedMessageSent);
 
-                m_NetworkManager.NetworkMetrics.TrackNamedMessageSent(name, (ulong)messageBuffer.Length);
+                m_NetworkManager.NetworkMetrics.TrackNamedMessageSent(clientIds, name, (ulong)messageBuffer.Length);
             }
         }
     }
diff --git a/com.unity.multiplayer.mlapi/Runtime/Messaging/InternalMessageHandler.cs b/com.unity.multiplayer.mlapi/Runtime/Messaging/InternalMessageHandler.cs
@@ -83,7 +83,6 @@ public void HandleConnectionApproved(ulong clientId, Stream stream, float receiv
 
                 NetworkManager.ConnectedClients.Add(NetworkManager.LocalClientId, new NetworkClient { ClientId = NetworkManager.LocalClientId });
 
-
                 void DelayedSpawnAction(Stream continuationStream)
                 {
                     using (var continuationReader = PooledNetworkReader.Get(continuationStream))
@@ -408,7 +407,7 @@ public void HandleNamedMessage(ulong clientId, Stream stream)
         {
             PerformanceDataManager.Increment(ProfilerConstants.NamedMessageReceived);
             ProfilerStatManager.NamedMessage.Record();
-            
+
             using (var reader = PooledNetworkReader.Get(stream))
             {
                 ulong hash = reader.ReadUInt64Packed();
diff --git a/com.unity.multiplayer.mlapi/Runtime/Metrics/NetworkMetrics.cs b/com.unity.multiplayer.mlapi/Runtime/Metrics/NetworkMetrics.cs
@@ -1,4 +1,6 @@
-﻿using Unity.Multiplayer.NetStats.Dispatch;
+﻿using System.Collections.Generic;
+using MLAPI.Connection;
+using Unity.Multiplayer.NetStats.Dispatch;
 using Unity.Multiplayer.NetStats.Metrics;
 using Unity.Multiplayer.NetworkProfiler;
 using Unity.Multiplayer.NetworkProfiler.Models;
@@ -7,28 +9,40 @@ namespace MLAPI.Metrics
 {
     public interface INetworkMetrics
     {
-        void TrackNamedMessageSent(string messageName, ulong bytesCount);
+        void TrackNetworkObject(NetworkObject networkObject);
 
-        void TrackNamedMessageReceived(string messageName, ulong bytesCount);
+        void TrackNamedMessageSent(ulong receiver, string messageName, ulong bytesCount);
+
+        void TrackNamedMessageSent(IReadOnlyCollection<ulong> receivers, string messageName, ulong bytesCount);
+
+        void TrackNamedMessageReceived(ulong sender, string messageName, ulong bytesCount);
 
         void DispatchFrame();
     }
 
     public class NullNetworkMetrics : INetworkMetrics
     {
-        public void TrackNamedMessageSent(string messageName, ulong bytesCount)
+        public void TrackNetworkObject(NetworkObject networkObject)
+        {
+        }
+
+        public void TrackNamedMessageSent(ulong receiver, string messageName, ulong bytesCount)
         {
         }
 
-        public void TrackNamedMessageReceived(string messageName, ulong bytesCount)
+        public void TrackNamedMessageSent(IReadOnlyCollection<ulong> receivers, string messageName, ulong bytesCount)
+        {
+        }
+
+        public void TrackNamedMessageReceived(ulong sender, string messageName, ulong bytesCount)
         {
         }
 
         public void DispatchFrame()
         {
         }
     }
-    
+
 #if true
     public class NetworkMetrics : INetworkMetrics
     {
@@ -38,24 +52,42 @@ public class NetworkMetrics : INetworkMetrics
         private EventMetric<NamedMessageEvent> m_NamedMessageSentEvent = new EventMetric<NamedMessageEvent>("Named Message Sent");
         private EventMetric<NamedMessageEvent> m_NamedMessageReceivedEvent = new EventMetric<NamedMessageEvent>("Named Message Received");
 
+        private Dictionary<ulong, NetworkObjectIdentifier> m_NetworkGameObjects = new Dictionary<ulong, NetworkObjectIdentifier>();
+
         public NetworkMetrics(NetworkManager networkManager)
         {
             m_NetworkManager = networkManager;
             m_Dispatcher = new MetricDispatcherBuilder()
                 .WithMetricEvents(m_NamedMessageSentEvent, m_NamedMessageReceivedEvent)
                 .Build();
-            
+
             m_Dispatcher.RegisterObserver(MLAPIObserver.Observer);
         }
 
-        public void TrackNamedMessageSent(string messageName, ulong bytesCount)
+        public void TrackNetworkObject(NetworkObject networkObject)
+        {
+            if (!m_NetworkGameObjects.ContainsKey(networkObject.NetworkObjectId))
+            {
+                m_NetworkGameObjects[networkObject.NetworkObjectId] = new NetworkObjectIdentifier(networkObject.name, networkObject.NetworkObjectId);
+            }
+        }
+
+        public void TrackNamedMessageSent(ulong receiver, string messageName, ulong bytesCount)
+        {
+            m_NamedMessageSentEvent.Mark(new NamedMessageEvent(new ConnectionInfo(receiver), messageName, bytesCount));
+        }
+
+        public void TrackNamedMessageSent(IReadOnlyCollection<ulong> receivers, string messageName, ulong bytesCount)
         {
-            m_NamedMessageSentEvent.Mark(new NamedMessageEvent(new ConnectionInfo(m_NetworkManager.LocalClientId), messageName, bytesCount));
+            foreach (var receiver in receivers)
+            {
+                TrackNamedMessageSent(receiver, messageName, bytesCount);
+            }
         }
 
-        public void TrackNamedMessageReceived(string messageName, ulong bytesCount)
+        public void TrackNamedMessageReceived(ulong sender, string messageName, ulong bytesCount)
         {
-            m_NamedMessageReceivedEvent.Mark(new NamedMessageEvent(new ConnectionInfo(m_NetworkManager.LocalClientId), messageName, bytesCount));
+            m_NamedMessageReceivedEvent.Mark(new NamedMessageEvent(new ConnectionInfo(sender), messageName, bytesCount));
         }
 
         public void DispatchFrame()
@@ -74,4 +106,4 @@ static MLAPIObserver()
         }
     }
 #endif
-}
+}
diff --git a/com.unity.multiplayer.mlapi/Runtime/Spawning/NetworkSpawnManager.cs b/com.unity.multiplayer.mlapi/Runtime/Spawning/NetworkSpawnManager.cs
@@ -302,6 +302,8 @@ internal void SpawnNetworkObjectLocally(NetworkObject networkObject, ulong netwo
             SpawnedObjects.Add(networkObject.NetworkObjectId, networkObject);
             SpawnedObjectsList.Add(networkObject);
 
+            NetworkManager.Singleton.NetworkMetrics.TrackNetworkObject(networkObject);
+
             if (ownerClientId != null)
             {
                 if (NetworkManager.IsServer)

Original file line number	Diff line number	Diff line change
`@@ -96,13 +96,13 @@ internal void InvokeNamedMessage(ulong hash, ulong sender, Stream stream)`
`96`	`96`	`if (m_NamedMessageHandlers32.TryGetValue(hash, out HandleNamedMessageDelegate messageHandler32))`
`97`	`97`	`{`
`98`	`98`	`messageHandler32(sender, stream);`
`99`		`- m_NetworkManager.NetworkMetrics.TrackNamedMessageReceived(m_MessageHandlerNameLookup32[hash], bytesCount);`
	`99`	`+ m_NetworkManager.NetworkMetrics.TrackNamedMessageReceived(sender, m_MessageHandlerNameLookup32[hash], bytesCount);`
`100`	`100`	`}`
`101`	`101`
`102`	`102`	`if (m_NamedMessageHandlers64.TryGetValue(hash, out HandleNamedMessageDelegate messageHandler64))`
`103`	`103`	`{`
`104`	`104`	`messageHandler64(sender, stream);`
`105`		`- m_NetworkManager.NetworkMetrics.TrackNamedMessageReceived(m_MessageHandlerNameLookup64[hash], bytesCount);`
	`105`	`+ m_NetworkManager.NetworkMetrics.TrackNamedMessageReceived(sender, m_MessageHandlerNameLookup64[hash], bytesCount);`
`106`	`106`	`}`
`107`	`107`	`}`
`108`	`108`	`else`
`@@ -114,14 +114,14 @@ internal void InvokeNamedMessage(ulong hash, ulong sender, Stream stream)`
`114`	`114`	`if (m_NamedMessageHandlers32.TryGetValue(hash, out HandleNamedMessageDelegate messageHandler32))`
`115`	`115`	`{`
`116`	`116`	`messageHandler32(sender, stream);`
`117`		`- m_NetworkManager.NetworkMetrics.TrackNamedMessageReceived(m_MessageHandlerNameLookup32[hash], bytesCount);`
	`117`	`+ m_NetworkManager.NetworkMetrics.TrackNamedMessageReceived(sender, m_MessageHandlerNameLookup32[hash], bytesCount);`
`118`	`118`	`}`
`119`	`119`	`break;`
`120`	`120`	`case HashSize.VarIntEightBytes:`
`121`	`121`	`if (m_NamedMessageHandlers64.TryGetValue(hash, out HandleNamedMessageDelegate messageHandler64))`
`122`	`122`	`{`
`123`	`123`	`messageHandler64(sender, stream);`
`124`		`- m_NetworkManager.NetworkMetrics.TrackNamedMessageReceived(m_MessageHandlerNameLookup64[hash], bytesCount);`
	`124`	`+ m_NetworkManager.NetworkMetrics.TrackNamedMessageReceived(sender, m_MessageHandlerNameLookup64[hash], bytesCount);`
`125`	`125`	`}`
`126`	`126`	`break;`
`127`	`127`	`}`
`@@ -190,8 +190,8 @@ public void SendNamedMessage(string name, ulong clientId, Stream stream, Network`
`190`	`190`
`191`	`191`	`m_NetworkManager.MessageSender.Send(clientId, NetworkConstants.NAMED_MESSAGE, networkChannel, messageBuffer);`
`192`	`192`	`PerformanceDataManager.Increment(ProfilerConstants.NamedMessageSent);`
`193`		`-`
`194`		`- m_NetworkManager.NetworkMetrics.TrackNamedMessageSent(name, (ulong)messageBuffer.Length);`
	`193`	`+`
	`194`	`+ m_NetworkManager.NetworkMetrics.TrackNamedMessageSent(clientId, name, (ulong)messageBuffer.Length);`
`195`	`195`	`}`
`196`	`196`	`}`
`197`	`197`
`@@ -235,7 +235,7 @@ public void SendNamedMessage(string name, List<ulong> clientIds, Stream stream,`
`235`	`235`	`m_NetworkManager.MessageSender.Send(NetworkConstants.NAMED_MESSAGE, networkChannel, clientIds, messageBuffer);`
`236`	`236`	`PerformanceDataManager.Increment(ProfilerConstants.NamedMessageSent);`
`237`	`237`
`238`		`- m_NetworkManager.NetworkMetrics.TrackNamedMessageSent(name, (ulong)messageBuffer.Length);`
	`238`	`+ m_NetworkManager.NetworkMetrics.TrackNamedMessageSent(clientIds, name, (ulong)messageBuffer.Length);`
`239`	`239`	`}`
`240`	`240`	`}`
`241`	`241`	`}`
Original file line number	Diff line number	Diff line change
`@@ -83,7 +83,6 @@ public void HandleConnectionApproved(ulong clientId, Stream stream, float receiv`
`83`	`83`
`84`	`84`	`NetworkManager.ConnectedClients.Add(NetworkManager.LocalClientId, new NetworkClient { ClientId = NetworkManager.LocalClientId });`
`85`	`85`
`86`		`-`
`87`	`86`	`void DelayedSpawnAction(Stream continuationStream)`
`88`	`87`	`{`
`89`	`88`	`using (var continuationReader = PooledNetworkReader.Get(continuationStream))`
`@@ -408,7 +407,7 @@ public void HandleNamedMessage(ulong clientId, Stream stream)`
`408`	`407`	`{`
`409`	`408`	`PerformanceDataManager.Increment(ProfilerConstants.NamedMessageReceived);`
`410`	`409`	`ProfilerStatManager.NamedMessage.Record();`
`411`		`-`
	`410`	`+`
`412`	`411`	`using (var reader = PooledNetworkReader.Get(stream))`
`413`	`412`	`{`
`414`	`413`	`ulong hash = reader.ReadUInt64Packed();`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,6 @@`
`1`		`-using Unity.Multiplayer.NetStats.Dispatch;`
	`1`	`+using System.Collections.Generic;`
	`2`	`+using MLAPI.Connection;`
	`3`	`+using Unity.Multiplayer.NetStats.Dispatch;`
`2`	`4`	`using Unity.Multiplayer.NetStats.Metrics;`
`3`	`5`	`using Unity.Multiplayer.NetworkProfiler;`
`4`	`6`	`using Unity.Multiplayer.NetworkProfiler.Models;`
`@@ -7,28 +9,40 @@ namespace MLAPI.Metrics`
`7`	`9`	`{`
`8`	`10`	`public interface INetworkMetrics`
`9`	`11`	`{`
`10`		`- void TrackNamedMessageSent(string messageName, ulong bytesCount);`
	`12`	`+ void TrackNetworkObject(NetworkObject networkObject);`
`11`	`13`
`12`		`- void TrackNamedMessageReceived(string messageName, ulong bytesCount);`
	`14`	`+ void TrackNamedMessageSent(ulong receiver, string messageName, ulong bytesCount);`
	`15`	`+`
	`16`	`+ void TrackNamedMessageSent(IReadOnlyCollection<ulong> receivers, string messageName, ulong bytesCount);`
	`17`	`+`
	`18`	`+ void TrackNamedMessageReceived(ulong sender, string messageName, ulong bytesCount);`
`13`	`19`
`14`	`20`	`void DispatchFrame();`
`15`	`21`	`}`
`16`	`22`
`17`	`23`	`public class NullNetworkMetrics : INetworkMetrics`
`18`	`24`	`{`
`19`		`- public void TrackNamedMessageSent(string messageName, ulong bytesCount)`
	`25`	`+ public void TrackNetworkObject(NetworkObject networkObject)`
	`26`	`+ {`
	`27`	`+ }`
	`28`	`+`
	`29`	`+ public void TrackNamedMessageSent(ulong receiver, string messageName, ulong bytesCount)`
`20`	`30`	`{`
`21`	`31`	`}`
`22`	`32`
`23`		`- public void TrackNamedMessageReceived(string messageName, ulong bytesCount)`
	`33`	`+ public void TrackNamedMessageSent(IReadOnlyCollection<ulong> receivers, string messageName, ulong bytesCount)`
	`34`	`+ {`
	`35`	`+ }`
	`36`	`+`
	`37`	`+ public void TrackNamedMessageReceived(ulong sender, string messageName, ulong bytesCount)`
`24`	`38`	`{`
`25`	`39`	`}`
`26`	`40`
`27`	`41`	`public void DispatchFrame()`
`28`	`42`	`{`
`29`	`43`	`}`
`30`	`44`	`}`
`31`		`-`
	`45`	`+`
`32`	`46`	`#if true`
`33`	`47`	`public class NetworkMetrics : INetworkMetrics`
`34`	`48`	`{`
`@@ -38,24 +52,42 @@ public class NetworkMetrics : INetworkMetrics`
`38`	`52`	`private EventMetric<NamedMessageEvent> m_NamedMessageSentEvent = new EventMetric<NamedMessageEvent>("Named Message Sent");`
`39`	`53`	`private EventMetric<NamedMessageEvent> m_NamedMessageReceivedEvent = new EventMetric<NamedMessageEvent>("Named Message Received");`
`40`	`54`
	`55`	`+ private Dictionary<ulong, NetworkObjectIdentifier> m_NetworkGameObjects = new Dictionary<ulong, NetworkObjectIdentifier>();`
	`56`	`+`
`41`	`57`	`public NetworkMetrics(NetworkManager networkManager)`
`42`	`58`	`{`
`43`	`59`	`m_NetworkManager = networkManager;`
`44`	`60`	`m_Dispatcher = new MetricDispatcherBuilder()`
`45`	`61`	`.WithMetricEvents(m_NamedMessageSentEvent, m_NamedMessageReceivedEvent)`
`46`	`62`	`.Build();`
`47`		`-`
	`63`	`+`
`48`	`64`	`m_Dispatcher.RegisterObserver(MLAPIObserver.Observer);`
`49`	`65`	`}`
`50`	`66`
`51`		`- public void TrackNamedMessageSent(string messageName, ulong bytesCount)`
	`67`	`+ public void TrackNetworkObject(NetworkObject networkObject)`
	`68`	`+ {`
	`69`	`+ if (!m_NetworkGameObjects.ContainsKey(networkObject.NetworkObjectId))`
	`70`	`+ {`
	`71`	`+ m_NetworkGameObjects[networkObject.NetworkObjectId] = new NetworkObjectIdentifier(networkObject.name, networkObject.NetworkObjectId);`
	`72`	`+ }`
	`73`	`+ }`
	`74`	`+`
	`75`	`+ public void TrackNamedMessageSent(ulong receiver, string messageName, ulong bytesCount)`
	`76`	`+ {`
	`77`	`+ m_NamedMessageSentEvent.Mark(new NamedMessageEvent(new ConnectionInfo(receiver), messageName, bytesCount));`
	`78`	`+ }`
	`79`	`+`
	`80`	`+ public void TrackNamedMessageSent(IReadOnlyCollection<ulong> receivers, string messageName, ulong bytesCount)`
`52`	`81`	`{`
`53`		`- m_NamedMessageSentEvent.Mark(new NamedMessageEvent(new ConnectionInfo(m_NetworkManager.LocalClientId), messageName, bytesCount));`
	`82`	`+ foreach (var receiver in receivers)`
	`83`	`+ {`
	`84`	`+ TrackNamedMessageSent(receiver, messageName, bytesCount);`
	`85`	`+ }`
`54`	`86`	`}`
`55`	`87`
`56`		`- public void TrackNamedMessageReceived(string messageName, ulong bytesCount)`
	`88`	`+ public void TrackNamedMessageReceived(ulong sender, string messageName, ulong bytesCount)`
`57`	`89`	`{`
`58`		`- m_NamedMessageReceivedEvent.Mark(new NamedMessageEvent(new ConnectionInfo(m_NetworkManager.LocalClientId), messageName, bytesCount));`
	`90`	`+ m_NamedMessageReceivedEvent.Mark(new NamedMessageEvent(new ConnectionInfo(sender), messageName, bytesCount));`
`59`	`91`	`}`
`60`	`92`
`61`	`93`	`public void DispatchFrame()`
`@@ -74,4 +106,4 @@ static MLAPIObserver()`
`74`	`106`	`}`
`75`	`107`	`}`
`76`	`108`	`#endif`
`77`		`-}`
	`109`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -302,6 +302,8 @@ internal void SpawnNetworkObjectLocally(NetworkObject networkObject, ulong netwo`
`302`	`302`	`SpawnedObjects.Add(networkObject.NetworkObjectId, networkObject);`
`303`	`303`	`SpawnedObjectsList.Add(networkObject);`
`304`	`304`
	`305`	`+ NetworkManager.Singleton.NetworkMetrics.TrackNetworkObject(networkObject);`
	`306`	`+`
`305`	`307`	`if (ownerClientId != null)`
`306`	`308`	`{`
`307`	`309`	`if (NetworkManager.IsServer)`