feat: connection management tests [MTT-3969] (#692)

* Adding tests for connection management

* Passing NetworkManager through DI directly instead of as a serialized field of ConnectionManager

* Renaming GameNetPortal prefab

* Adding more verbosity to ConnectionManager's debug log on state changed

* Exposing number of reconnection attempts as serialized field and property of ConnectionManager

Author: LPLafontaineB

Assets/Prefabs/GameNetPortal.prefab renamed to Assets/Prefabs/ConnectionManager.prefab

@@ -11,8 +11,8 @@ GameObject:
   - component: {fileID: 5062837533140207352}
   - component: {fileID: 1984353324962460586}
   m_Layer: 0
-  m_Name: GameNetPortal
-  m_TagString: GameNetPortal
+  m_Name: ConnectionManager
+  m_TagString: Untagged
   m_Icon: {fileID: 0}
   m_NavMeshLayer: 0
   m_StaticEditorFlags: 0
@@ -44,6 +44,8 @@ MonoBehaviour:
   m_Script: {fileID: 11500000, guid: bf51ea31bbc84cc3aa883cc5f1caae06, type: 3}
   m_Name: 
   m_EditorClassIdentifier: 
-  m_NetworkManager: {fileID: 0}
-  m_AvatarRegistry: {fileID: 11400000, guid: 48d17d764bff6c643a3dc035fb71c979, type: 2}
-  m_GameState: {fileID: 7151198093957655792, guid: 3af96a32a84bcf74d9538fa7af973c97, type: 3}
+  m_NetworkObjectsToSpawnWhenServerStarted:
+  - {fileID: 7151198093957655792, guid: 3af96a32a84bcf74d9538fa7af973c97, type: 3}
+  MaxConnectedPlayers: 8
+  m_OfflineScene: MainMenu
+  m_StartScene: CharSelect

Assets/Prefabs/GameNetPortal.prefab.meta renamed to Assets/Prefabs/ConnectionManager.prefab.meta

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:48a24b280794a53ab92b88c560dba8dddc996e910e534a952e60fa0bad85a1cc
-size 45753
+oid sha256:acddfdd76ba86ff45c5ee2c70038ee5a32336953be4735bfba3b740f1145d324
+size 45803

Assets/Scenes/Startup.unity

@@ -5,6 +5,7 @@
 using Unity.Multiplayer.Samples.BossRoom.Shared.Infrastructure;
 using Unity.Multiplayer.Samples.BossRoom.Shared.Net.UnityServices.Infrastructure;
 using Unity.Multiplayer.Samples.BossRoom.Shared.Net.UnityServices.Lobbies;
+using Unity.Netcode;
 using UnityEngine;
 using UnityEngine.SceneManagement;
 using VContainer;
@@ -20,6 +21,7 @@ public class ApplicationController : LifetimeScope
     {
         [SerializeField] UpdateRunner m_UpdateRunner;
         [SerializeField] ConnectionManager m_ConnectionManager;
+        [SerializeField] NetworkManager m_NetworkManager;
 
         LocalLobby m_LocalLobby;
         LobbyServiceFacade m_LobbyServiceFacade;
@@ -30,8 +32,8 @@ protected override void Configure(IContainerBuilder builder)
         {
             base.Configure(builder);
             builder.RegisterComponent(m_UpdateRunner);
-            builder.RegisterComponent(m_ConnectionManager.NetworkManager);
             builder.RegisterComponent(m_ConnectionManager);
+            builder.RegisterComponent(m_NetworkManager);
 
             //the following singletons represent the local representations of the lobby that we're in and the user that we are
             //they can persist longer than the lifetime of the UI in MainMenu where we set up the lobby that we create or join

Assets/Scripts/ApplicationLifecycle/ApplicationController.cs

@@ -56,10 +56,15 @@ public class ConnectionManager : MonoBehaviour
     {
         ConnectionState m_CurrentState;
 
-        [SerializeField]
+        [Inject]
         NetworkManager m_NetworkManager;
         public NetworkManager NetworkManager => m_NetworkManager;
 
+        [SerializeField]
+        int m_NbReconnectAttempts = 2;
+
+        public int NbReconnectAttempts => m_NbReconnectAttempts;
+
         [Inject]
         IObjectResolver m_Resolver;
 
@@ -106,7 +111,7 @@ void OnDestroy()
 
         internal void ChangeState(ConnectionState nextState)
         {
-            Debug.Log($"Changed connection state from {m_CurrentState.GetType().Name} to {nextState.GetType().Name}.");
+            Debug.Log($"{name}: Changed connection state from {m_CurrentState.GetType().Name} to {nextState.GetType().Name}.");
 
             if (m_CurrentState != null)
             {
@@ -185,23 +190,23 @@ void ReceiveServerToClientSetDisconnectReason_CustomMessage(ulong clientID, Fast
         /// Sends a DisconnectReason to all connected clients. This should only be done on the server, prior to disconnecting the clients.
         /// </summary>
         /// <param name="status"> The reason for the upcoming disconnect.</param>
-        public static void SendServerToAllClientsSetDisconnectReason(ConnectStatus status)
+        public void SendServerToAllClientsSetDisconnectReason(ConnectStatus status)
         {
             var writer = new FastBufferWriter(sizeof(ConnectStatus), Allocator.Temp);
             writer.WriteValueSafe(status);
-            NetworkManager.Singleton.CustomMessagingManager.SendNamedMessageToAll(nameof(ReceiveServerToClientSetDisconnectReason_CustomMessage), writer);
+            NetworkManager.CustomMessagingManager.SendNamedMessageToAll(nameof(ReceiveServerToClientSetDisconnectReason_CustomMessage), writer);
         }
 
         /// <summary>
         /// Sends a DisconnectReason to the indicated client. This should only be done on the server, prior to disconnecting the client.
         /// </summary>
         /// <param name="clientID"> id of the client to send to </param>
         /// <param name="status"> The reason for the upcoming disconnect.</param>
-        public static void SendServerToClientSetDisconnectReason(ulong clientID, ConnectStatus status)
+        public void SendServerToClientSetDisconnectReason(ulong clientID, ConnectStatus status)
         {
             var writer = new FastBufferWriter(sizeof(ConnectStatus), Allocator.Temp);
             writer.WriteValueSafe(status);
-            NetworkManager.Singleton.CustomMessagingManager.SendNamedMessage(nameof(ReceiveServerToClientSetDisconnectReason_CustomMessage), clientID, writer);
+            NetworkManager.CustomMessagingManager.SendNamedMessage(nameof(ReceiveServerToClientSetDisconnectReason_CustomMessage), clientID, writer);
         }
     }
 }

Assets/Scripts/ConnectionManagement/ConnectionManager.cs

@@ -1,7 +1,6 @@
 using System;
 using System.Collections;
 using Unity.Multiplayer.Samples.BossRoom.Shared.Infrastructure;
-using Unity.Netcode;
 using UnityEngine;
 using VContainer;
 
@@ -15,8 +14,6 @@ namespace Unity.Multiplayer.Samples.BossRoom
     /// </summary>
     class ClientReconnectingState : ClientConnectingState
     {
-        const int k_NbReconnectAttempts = 2;
-
         [Inject]
         IPublisher<ReconnectMessage> m_ReconnectMessagePublisher;
 
@@ -38,7 +35,7 @@ public override void Exit()
                 m_ConnectionManager.StopCoroutine(m_ReconnectCoroutine);
                 m_ReconnectCoroutine = null;
             }
-            m_ReconnectMessagePublisher.Publish(new ReconnectMessage(k_NbReconnectAttempts, k_NbReconnectAttempts));
+            m_ReconnectMessagePublisher.Publish(new ReconnectMessage(m_ConnectionManager.NbReconnectAttempts, m_ConnectionManager.NbReconnectAttempts));
         }
 
         public override void OnClientConnected(ulong _)
@@ -48,7 +45,7 @@ public override void OnClientConnected(ulong _)
 
         public override void OnClientDisconnect(ulong _)
         {
-            if (m_NbAttempts < k_NbReconnectAttempts)
+            if (m_NbAttempts < m_ConnectionManager.NbReconnectAttempts)
             {
                 m_ReconnectCoroutine = m_ConnectionManager.StartCoroutine(ReconnectCoroutine());
             }
@@ -76,11 +73,11 @@ IEnumerator ReconnectCoroutine()
         {
             Debug.Log("Lost connection to host, trying to reconnect...");
 
-            NetworkManager.Singleton.Shutdown();
+            m_ConnectionManager.NetworkManager.Shutdown();
 
-            yield return new WaitWhile(() => NetworkManager.Singleton.ShutdownInProgress); // wait until NetworkManager completes shutting down
-            Debug.Log($"Reconnecting attempt {m_NbAttempts + 1}/{k_NbReconnectAttempts}...");
-            m_ReconnectMessagePublisher.Publish(new ReconnectMessage(m_NbAttempts, k_NbReconnectAttempts));
+            yield return new WaitWhile(() => m_ConnectionManager.NetworkManager.ShutdownInProgress); // wait until NetworkManager completes shutting down
+            Debug.Log($"Reconnecting attempt {m_NbAttempts + 1}/{m_ConnectionManager.NbReconnectAttempts}...");
+            m_ReconnectMessagePublisher.Publish(new ReconnectMessage(m_NbAttempts, m_ConnectionManager.NbReconnectAttempts));
             m_NbAttempts++;
             if (!string.IsNullOrEmpty(m_LobbyCode))
             {

Assets/Scripts/ConnectionManagement/ConnectionState/ClientReconnectingState.cs

@@ -75,7 +75,7 @@ public override void OnClientDisconnect(ulong clientId)
 
         public override void OnUserRequestedShutdown()
         {
-            ConnectionManager.SendServerToAllClientsSetDisconnectReason(ConnectStatus.HostEndedSession);
+            m_ConnectionManager.SendServerToAllClientsSetDisconnectReason(ConnectStatus.HostEndedSession);
             // Wait before shutting down to make sure clients receive that message before they are disconnected
             m_ConnectionManager.StartCoroutine(WaitToShutdown());
         }
@@ -129,12 +129,12 @@ IEnumerator WaitToDenyApproval()
             {
                 response.Pending = true; // give some time for server to send connection status message to clients
                 response.Approved = false;
-                ConnectionManager.SendServerToClientSetDisconnectReason(clientId, gameReturnStatus);
+                m_ConnectionManager.SendServerToClientSetDisconnectReason(clientId, gameReturnStatus);
                 yield return null; // wait a frame so UTP can flush it's messages on next update
                 response.Pending = false; // connection approval process can be finished.
             }
 
-            ConnectionManager.SendServerToClientSetDisconnectReason(clientId, gameReturnStatus);
+            m_ConnectionManager.SendServerToClientSetDisconnectReason(clientId, gameReturnStatus);
             m_ConnectionManager.StartCoroutine(WaitToDenyApproval());
             if (m_LobbyServiceFacade.CurrentUnityLobby != null)
             {

Assets/Scripts/ConnectionManagement/ConnectionState/HostingState.cs

@@ -54,7 +54,7 @@ public override void StartClientLobby(string playerName)
 
         public override void StartHostIP(string playerName, string ipaddress, int port)
         {
-            var utp = (UnityTransport)NetworkManager.Singleton.NetworkConfig.NetworkTransport;
+            var utp = (UnityTransport)m_ConnectionManager.NetworkManager.NetworkConfig.NetworkTransport;
             utp.SetConnectionData(ipaddress, (ushort)port);
 
             SetConnectionPayload(GetPlayerId(), playerName);