refactor!: CustomMessageManager is no longer static (#737)

BREAKING CHANGE: Access CustomMessageManager with NetworkManager.Singleton.CustomMessageManager

Author: TwoTenPvP

com.unity.multiplayer.mlapi/Runtime/Core/NetworkManager.cs

@@ -95,6 +95,8 @@ public class NetworkManager : MonoBehaviour, INetworkUpdateSystem, IProfilableTr
         /// </summary>
         public NetworkSpawnManager SpawnManager { get; private set; }
 
+        public CustomMessagingManager CustomMessagingManager { get; private set; }
+
         internal BufferManager BufferManager { get; private set; }
 
         // Has to have setter for tests
@@ -207,7 +209,7 @@ public ulong LocalClientId
 
 #if UNITY_EDITOR
         internal static bool IsTestRun = false;
-        
+
         private void OnValidate()
         {
             if (NetworkConfig == null)
@@ -298,6 +300,8 @@ private void Init(bool server)
             // Create spawn manager instance
             SpawnManager = new NetworkSpawnManager(this);
 
+            CustomMessagingManager = new CustomMessagingManager(this);
+
             BufferManager = new BufferManager();
 
             if (MessageHandler == null)
@@ -700,6 +704,11 @@ public void Shutdown()
                 MessageHandler = null;
             }
 
+            if (CustomMessagingManager != null)
+            {
+                CustomMessagingManager = null;
+            }
+
             //The Transport is set during Init time, thus it is possible for the Transport to be null
             NetworkConfig?.NetworkTransport?.Shutdown();
         }

com.unity.multiplayer.mlapi/Runtime/Messaging/CustomMessageManager.cs

@@ -14,8 +14,15 @@ namespace MLAPI.Messaging
     /// The manager class to manage custom messages, note that this is different from the NetworkManager custom messages.
     /// These are named and are much easier to use.
     /// </summary>
-    public static class CustomMessagingManager
+    public class CustomMessagingManager
     {
+        private NetworkManager m_NetworkManager { get; }
+
+        internal CustomMessagingManager(NetworkManager networkManager)
+        {
+            m_NetworkManager = networkManager;
+        }
+
         #region Unnamed
 
         /// <summary>
@@ -28,19 +35,19 @@ public static class CustomMessagingManager
         /// <summary>
         /// Event invoked when unnamed messages arrive
         /// </summary>
-        public static event UnnamedMessageDelegate OnUnnamedMessage;
+        public event UnnamedMessageDelegate OnUnnamedMessage;
 
-        internal static void InvokeUnnamedMessage(ulong clientId, Stream stream) => OnUnnamedMessage?.Invoke(clientId, stream);
+        internal void InvokeUnnamedMessage(ulong clientId, Stream stream) => OnUnnamedMessage?.Invoke(clientId, stream);
 
         /// <summary>
         /// Sends unnamed message to a list of clients
         /// </summary>
         /// <param name="clientIds">The clients to send to, sends to everyone if null</param>
         /// <param name="buffer">The message stream containing the data</param>
         /// <param name="networkChannel">The channel to send the data on</param>
-        public static void SendUnnamedMessage(List<ulong> clientIds, NetworkBuffer buffer, NetworkChannel networkChannel = NetworkChannel.Internal)
+        public void SendUnnamedMessage(List<ulong> clientIds, NetworkBuffer buffer, NetworkChannel networkChannel = NetworkChannel.Internal)
         {
-            if (!NetworkManager.Singleton.IsServer)
+            if (!m_NetworkManager.IsServer)
             {
                 if (NetworkLog.CurrentLogLevel <= LogLevel.Error)
                 {
@@ -60,7 +67,7 @@ public static void SendUnnamedMessage(List<ulong> clientIds, NetworkBuffer buffe
         /// <param name="clientId">The client to send the message to</param>
         /// <param name="buffer">The message stream containing the data</param>
         /// <param name="networkChannel">The channel tos end the data on</param>
-        public static void SendUnnamedMessage(ulong clientId, NetworkBuffer buffer, NetworkChannel networkChannel = NetworkChannel.Internal)
+        public void SendUnnamedMessage(ulong clientId, NetworkBuffer buffer, NetworkChannel networkChannel = NetworkChannel.Internal)
         {
             InternalMessageSender.Send(clientId, NetworkConstants.UNNAMED_MESSAGE, networkChannel, buffer);
             PerformanceDataManager.Increment(ProfilerConstants.UnnamedMessageSent);
@@ -75,12 +82,12 @@ public static void SendUnnamedMessage(ulong clientId, NetworkBuffer buffer, Netw
         /// </summary>
         public delegate void HandleNamedMessageDelegate(ulong sender, Stream payload);
 
-        private static Dictionary<ulong, HandleNamedMessageDelegate> s_NamedMessageHandlers32 = new Dictionary<ulong, HandleNamedMessageDelegate>();
-        private static Dictionary<ulong, HandleNamedMessageDelegate> s_NamedMessageHandlers64 = new Dictionary<ulong, HandleNamedMessageDelegate>();
+        private Dictionary<ulong, HandleNamedMessageDelegate> s_NamedMessageHandlers32 = new Dictionary<ulong, HandleNamedMessageDelegate>();
+        private Dictionary<ulong, HandleNamedMessageDelegate> s_NamedMessageHandlers64 = new Dictionary<ulong, HandleNamedMessageDelegate>();
 
-        internal static void InvokeNamedMessage(ulong hash, ulong sender, Stream stream)
+        internal void InvokeNamedMessage(ulong hash, ulong sender, Stream stream)
         {
-            if (NetworkManager.Singleton == null)
+            if (m_NetworkManager == null)
             {
                 // We dont know what size to use. Try every (more collision prone)
                 if (s_NamedMessageHandlers32.ContainsKey(hash))
@@ -96,7 +103,7 @@ internal static void InvokeNamedMessage(ulong hash, ulong sender, Stream stream)
             else
             {
                 // Only check the right size.
-                switch (NetworkManager.Singleton.NetworkConfig.RpcHashSize)
+                switch (m_NetworkManager.NetworkConfig.RpcHashSize)
                 {
                     case HashSize.VarIntFourBytes:
                         if (s_NamedMessageHandlers32.ContainsKey(hash))
@@ -119,7 +126,7 @@ internal static void InvokeNamedMessage(ulong hash, ulong sender, Stream stream)
         /// </summary>
         /// <param name="name">Name of the message.</param>
         /// <param name="callback">The callback to run when a named message is received.</param>
-        public static void RegisterNamedMessageHandler(string name, HandleNamedMessageDelegate callback)
+        public void RegisterNamedMessageHandler(string name, HandleNamedMessageDelegate callback)
         {
             s_NamedMessageHandlers32[XXHash.Hash32(name)] = callback;
             s_NamedMessageHandlers64[XXHash.Hash64(name)] = callback;
@@ -129,7 +136,7 @@ public static void RegisterNamedMessageHandler(string name, HandleNamedMessageDe
         /// Unregisters a named message handler.
         /// </summary>
         /// <param name="name">The name of the message.</param>
-        public static void UnregisterNamedMessageHandler(string name)
+        public void UnregisterNamedMessageHandler(string name)
         {
             s_NamedMessageHandlers32.Remove(XXHash.Hash32(name));
             s_NamedMessageHandlers64.Remove(XXHash.Hash64(name));
@@ -142,10 +149,10 @@ public static void UnregisterNamedMessageHandler(string name)
         /// <param name="clientId">The client to send the message to</param>
         /// <param name="stream">The message stream containing the data</param>
         /// <param name="networkChannel">The channel to send the data on</param>
-        public static void SendNamedMessage(string name, ulong clientId, Stream stream, NetworkChannel networkChannel = NetworkChannel.Internal)
+        public void SendNamedMessage(string name, ulong clientId, Stream stream, NetworkChannel networkChannel = NetworkChannel.Internal)
         {
             ulong hash = 0;
-            switch (NetworkManager.Singleton.NetworkConfig.RpcHashSize)
+            switch (m_NetworkManager.NetworkConfig.RpcHashSize)
             {
                 case HashSize.VarIntFourBytes:
                     hash = XXHash.Hash32(name);
@@ -174,10 +181,10 @@ public static void SendNamedMessage(string name, ulong clientId, Stream stream,
         /// <param name="clientIds">The clients to send to, sends to everyone if null</param>
         /// <param name="stream">The message stream containing the data</param>
         /// <param name="networkChannel">The channel to send the data on</param>
-        public static void SendNamedMessage(string name, List<ulong> clientIds, Stream stream, NetworkChannel networkChannel = NetworkChannel.Internal)
+        public void SendNamedMessage(string name, List<ulong> clientIds, Stream stream, NetworkChannel networkChannel = NetworkChannel.Internal)
         {
             ulong hash = 0;
-            switch (NetworkManager.Singleton.NetworkConfig.RpcHashSize)
+            switch (m_NetworkManager.NetworkConfig.RpcHashSize)
             {
                 case HashSize.VarIntFourBytes:
                     hash = XXHash.Hash32(name);
@@ -194,7 +201,7 @@ public static void SendNamedMessage(string name, List<ulong> clientIds, Stream s
 
                 messageBuffer.CopyFrom(stream);
 
-                if (!NetworkManager.Singleton.IsServer)
+                if (!m_NetworkManager.IsServer)
                 {
                     if (NetworkLog.CurrentLogLevel <= LogLevel.Error)
                     {

com.unity.multiplayer.mlapi/Runtime/Messaging/InternalMessageHandler.cs

@@ -557,7 +557,7 @@ public void HandleUnnamedMessage(ulong clientId, Stream stream)
 #if DEVELOPMENT_BUILD || UNITY_EDITOR
             s_HandleUnnamedMessage.Begin();
 #endif
-            CustomMessagingManager.InvokeUnnamedMessage(clientId, stream);
+            NetworkManager.CustomMessagingManager.InvokeUnnamedMessage(clientId, stream);
 #if DEVELOPMENT_BUILD || UNITY_EDITOR
             s_HandleUnnamedMessage.End();
 #endif
@@ -574,7 +574,7 @@ public void HandleNamedMessage(ulong clientId, Stream stream)
             {
                 ulong hash = reader.ReadUInt64Packed();
 
-                CustomMessagingManager.InvokeNamedMessage(hash, clientId, stream);
+                NetworkManager.CustomMessagingManager.InvokeNamedMessage(hash, clientId, stream);
             }
 #if DEVELOPMENT_BUILD || UNITY_EDITOR
             s_HandleNamedMessage.End();

com.unity.multiplayer.mlapi/Tests/Editor/NetworkManagerCustomMessageManagerTests.cs

@@ -0,0 +1,40 @@
+using System.Collections.Generic;
+using MLAPI.Configuration;
+using MLAPI.Messaging;
+using NUnit.Framework;
+using UnityEngine;
+using UnityEngine.SceneManagement;
+
+namespace MLAPI.EditorTests
+{
+    public class NetworkManagerCustomMessageManagerTests
+    {
+        [Test]
+        public void CustomMessageManagerAssigned()
+        {
+            var gameObject = new GameObject(nameof(CustomMessageManagerAssigned));
+            var networkManager = gameObject.AddComponent<NetworkManager>();
+            var transport = gameObject.AddComponent<DummyTransport>();
+
+            // MLAPI sets this in validate
+            networkManager.NetworkConfig = new NetworkConfig()
+            {
+                // Set the current scene to prevent unexpected log messages which would trigger a failure
+                RegisteredScenes = new List<string>() {SceneManager.GetActiveScene().name}
+            };
+
+            // Set dummy transport that does nothing
+            networkManager.NetworkConfig.NetworkTransport = transport;
+
+            CustomMessagingManager preManager = networkManager.CustomMessagingManager;
+
+            // Start server to cause init
+            networkManager.StartServer();
+
+            Debug.Assert(preManager == null);
+            Debug.Assert(networkManager.CustomMessagingManager != null);
+
+            Object.DestroyImmediate(gameObject);
+        }
+    }
+}