refactor: replacing GameNetPortal with state machine [MTT-1742] [MTT-3501] [MTT-3502] (#666)

* Removing GameNetPortal

* Adding ConnectionManager and ConnectionStates

* Moving connection management to new assembly

* Simplifying initial player spawn flow in ServerBossRoomScene

Co-authored-by: Sam Bellomo <71790295+SamuelBellomo@users.noreply.github.com>

Author: LPLafontaineB

Assets/Prefabs/GameNetPortal.prefab

@@ -9,9 +9,7 @@ GameObject:
   serializedVersion: 6
   m_Component:
   - component: {fileID: 5062837533140207352}
-  - component: {fileID: 5062837533140207350}
-  - component: {fileID: 5062837533140207353}
-  - component: {fileID: 5062837533140207351}
+  - component: {fileID: 1984353324962460586}
   m_Layer: 0
   m_Name: GameNetPortal
   m_TagString: GameNetPortal
@@ -29,11 +27,12 @@ Transform:
   m_LocalRotation: {x: 0, y: 0, z: 0, w: 1}
   m_LocalPosition: {x: 0, y: 0, z: 0}
   m_LocalScale: {x: 1, y: 1, z: 1}
+  m_ConstrainProportionsScale: 0
   m_Children: []
   m_Father: {fileID: 0}
   m_RootOrder: 0
   m_LocalEulerAnglesHint: {x: 0, y: 0, z: 0}
---- !u!114 &5062837533140207350
+--- !u!114 &1984353324962460586
 MonoBehaviour:
   m_ObjectHideFlags: 0
   m_CorrespondingSourceObject: {fileID: 0}
@@ -42,34 +41,9 @@ MonoBehaviour:
   m_GameObject: {fileID: 5062837533140207349}
   m_Enabled: 1
   m_EditorHideFlags: 0
-  m_Script: {fileID: 11500000, guid: 7ba4a1d598313d94a81a08ceae147b57, type: 3}
+  m_Script: {fileID: 11500000, guid: bf51ea31bbc84cc3aa883cc5f1caae06, type: 3}
   m_Name: 
   m_EditorClassIdentifier: 
   m_NetworkManager: {fileID: 0}
   m_AvatarRegistry: {fileID: 11400000, guid: 48d17d764bff6c643a3dc035fb71c979, type: 2}
-  PlayerName: 
---- !u!114 &5062837533140207353
-MonoBehaviour:
-  m_ObjectHideFlags: 0
-  m_CorrespondingSourceObject: {fileID: 0}
-  m_PrefabInstance: {fileID: 0}
-  m_PrefabAsset: {fileID: 0}
-  m_GameObject: {fileID: 5062837533140207349}
-  m_Enabled: 1
-  m_EditorHideFlags: 0
-  m_Script: {fileID: 11500000, guid: 5bd31edc1b1fd1342b3bf8193a5a03b2, type: 3}
-  m_Name: 
-  m_EditorClassIdentifier: 
---- !u!114 &5062837533140207351
-MonoBehaviour:
-  m_ObjectHideFlags: 0
-  m_CorrespondingSourceObject: {fileID: 0}
-  m_PrefabInstance: {fileID: 0}
-  m_PrefabAsset: {fileID: 0}
-  m_GameObject: {fileID: 5062837533140207349}
-  m_Enabled: 1
-  m_EditorHideFlags: 0
-  m_Script: {fileID: 11500000, guid: 54b0859a1da930541adf0b2d1bb8d977, type: 3}
-  m_Name: 
-  m_EditorClassIdentifier: 
   m_GameState: {fileID: 7151198093957655792, guid: 3af96a32a84bcf74d9538fa7af973c97, type: 3}

Assets/Scenes/Startup.unity

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

Assets/Scripts/ApplicationLifecycle/ApplicationController.cs

@@ -2,12 +2,9 @@
 using System.Collections;
 using BossRoom.Scripts.Shared.Net.UnityServices.Auth;
 using Unity.Multiplayer.Samples.BossRoom.ApplicationLifecycle.Messages;
-using Unity.Multiplayer.Samples.BossRoom.Client;
-using Unity.Multiplayer.Samples.BossRoom.Server;
 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.Multiplayer.Samples.Utilities;
 using UnityEngine;
 using UnityEngine.SceneManagement;
 using VContainer;
@@ -22,9 +19,7 @@ namespace Unity.Multiplayer.Samples.BossRoom.Shared
     public class ApplicationController : LifetimeScope
     {
         [SerializeField] UpdateRunner m_UpdateRunner;
-        [SerializeField] GameNetPortal m_GameNetPortal;
-        [SerializeField] ClientGameNetPortal m_ClientNetPortal;
-        [SerializeField] ServerGameNetPortal m_ServerGameNetPortal;
+        [SerializeField] ConnectionManager m_ConnectionManager;
 
         LocalLobby m_LocalLobby;
         LobbyServiceFacade m_LobbyServiceFacade;
@@ -35,9 +30,7 @@ protected override void Configure(IContainerBuilder builder)
         {
             base.Configure(builder);
             builder.RegisterComponent(m_UpdateRunner);
-            builder.RegisterComponent(m_GameNetPortal);
-            builder.RegisterComponent(m_ClientNetPortal);
-            builder.RegisterComponent(m_ServerGameNetPortal);
+            builder.RegisterComponent(m_ConnectionManager);
 
             //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
@@ -48,7 +41,6 @@ protected override void Configure(IContainerBuilder builder)
 
             //these message channels are essential and persist for the lifetime of the lobby and relay services
             // Registering as instance to prevent code stripping on iOS
-            builder.RegisterInstance(new MessageChannel<QuitGameSessionMessage>()).AsImplementedInterfaces();
             builder.RegisterInstance(new MessageChannel<QuitApplicationMessage>()).AsImplementedInterfaces();
             builder.RegisterInstance(new MessageChannel<UnityServiceErrorMessage>()).AsImplementedInterfaces();
             builder.RegisterInstance(new MessageChannel<ConnectStatus>()).AsImplementedInterfaces();
@@ -80,11 +72,9 @@ private void Start()
             m_LocalLobby = Container.Resolve<LocalLobby>();
             m_LobbyServiceFacade = Container.Resolve<LobbyServiceFacade>();
 
-            var quitGameSessionSub = Container.Resolve<ISubscriber<QuitGameSessionMessage>>();
             var quitApplicationSub = Container.Resolve<ISubscriber<QuitApplicationMessage>>();
 
             var subHandles = new DisposableGroup();
-            subHandles.Add(quitGameSessionSub.Subscribe(LeaveSession));
             subHandles.Add(quitApplicationSub.Subscribe(QuitGame));
             m_Subscriptions = subHandles;
 
@@ -131,22 +121,6 @@ private bool OnWantToQuit()
             return canQuit;
         }
 
-        private void LeaveSession(QuitGameSessionMessage msg)
-        {
-            m_LobbyServiceFacade.EndTracking();
-
-            if (msg.UserRequested)
-            {
-                // first disconnect then return to menu
-                var gameNetPortal = GameNetPortal.Instance;
-                if (gameNetPortal != null)
-                {
-                    gameNetPortal.RequestDisconnect();
-                }
-            }
-            SceneLoaderWrapper.Instance.LoadScene("MainMenu", useNetworkSceneManager: false);
-        }
-
         private void QuitGame(QuitApplicationMessage msg)
         {
 #if UNITY_EDITOR

Assets/Scripts/ApplicationLifecycle/Messages/QuitGameSessionMessage.cs

@@ -10,6 +10,7 @@
         "Unity.Collections",
         "Unity.Multiplayer.Samples.Utilities",
         "Unity.BossRoom.Utils",
+        "Unity.BossRoom.ConnectionManagement",
         "VContainer",
         "VContainer.EnableCodeGen"
     ],

Assets/Scripts/ApplicationLifecycle/Messages/QuitGameSessionMessage.cs.meta

@@ -0,0 +1,205 @@
+using System;
+using System.Collections.Generic;
+using Unity.Collections;
+using Unity.Netcode;
+using UnityEngine;
+using VContainer;
+
+namespace Unity.Multiplayer.Samples.BossRoom
+{
+    public enum ConnectStatus
+    {
+        Undefined,
+        Success,                  //client successfully connected. This may also be a successful reconnect.
+        ServerFull,               //can't join, server is already at capacity.
+        LoggedInAgain,            //logged in on a separate client, causing this one to be kicked out.
+        UserRequestedDisconnect,  //Intentional Disconnect triggered by the user.
+        GenericDisconnect,        //server disconnected, but no specific reason given.
+        Reconnecting,             //client lost connection and is attempting to reconnect.
+        IncompatibleBuildType,    //client build type is incompatible with server.
+        HostEndedSession,         //host intentionally ended the session.
+        StartHostFailed,          // server failed to bind
+        StartClientFailed         // failed to connect to server and/or invalid network endpoint
+    }
+
+    public struct ReconnectMessage
+    {
+        public int CurrentAttempt;
+        public int MaxAttempt;
+
+        public ReconnectMessage(int currentAttempt, int maxAttempt)
+        {
+            CurrentAttempt = currentAttempt;
+            MaxAttempt = maxAttempt;
+        }
+    }
+
+    public struct ConnectionEventMessage : INetworkSerializeByMemcpy
+    {
+        public ConnectStatus ConnectStatus;
+        public FixedPlayerName PlayerName;
+    }
+
+    [Serializable]
+    public class ConnectionPayload
+    {
+        public string playerId;
+        public string playerName;
+        public bool isDebug;
+    }
+
+    /// <summary>
+    /// This state machine handles connection through the NetworkManager. It is responsible for listening to
+    /// NetworkManger callbacks and other outside calls and redirecting them to the current ConnectionState object.
+    /// </summary>
+    public class ConnectionManager : MonoBehaviour
+    {
+        ConnectionState m_CurrentState;
+
+        [SerializeField]
+        NetworkManager m_NetworkManager;
+        public NetworkManager NetworkManager => m_NetworkManager;
+
+        [SerializeField]
+        NetworkObject m_GameState;
+        public NetworkObject GameState => m_GameState;
+
+        [Inject]
+        IObjectResolver m_Resolver;
+
+        public int MaxConnectedPlayers = 8;
+
+        internal readonly OfflineState m_Offline = new OfflineState();
+        internal readonly ClientConnectingState m_ClientConnecting = new ClientConnectingState();
+        internal readonly ClientConnectedState m_ClientConnected = new ClientConnectedState();
+        internal readonly ClientReconnectingState m_ClientReconnecting = new ClientReconnectingState();
+        internal readonly DisconnectingWithReasonState m_DisconnectingWithReason = new DisconnectingWithReasonState();
+        internal readonly StartingHostState m_StartingHost = new StartingHostState();
+        internal readonly HostingState m_Hosting = new HostingState();
+
+        void Awake()
+        {
+            DontDestroyOnLoad(gameObject);
+        }
+
+        void Start()
+        {
+            List<ConnectionState> states = new() { m_Offline, m_ClientConnecting, m_ClientConnected, m_ClientReconnecting, m_DisconnectingWithReason, m_StartingHost, m_Hosting };
+            foreach (var connectionState in states)
+            {
+                m_Resolver.Inject(connectionState);
+            }
+
+            m_CurrentState = m_Offline;
+
+            NetworkManager.OnClientConnectedCallback += OnClientConnectedCallback;
+            NetworkManager.OnClientDisconnectCallback += OnClientDisconnectCallback;
+            NetworkManager.OnServerStarted += OnServerStarted;
+            NetworkManager.ConnectionApprovalCallback += ApprovalCheck;
+        }
+
+        void OnDestroy()
+        {
+            NetworkManager.OnClientConnectedCallback -= OnClientConnectedCallback;
+            NetworkManager.OnClientDisconnectCallback -= OnClientDisconnectCallback;
+            NetworkManager.OnServerStarted -= OnServerStarted;
+            NetworkManager.ConnectionApprovalCallback -= ApprovalCheck;
+
+        }
+
+        internal void ChangeState(ConnectionState nextState)
+        {
+            Debug.Log($"Changed connection state from {m_CurrentState.GetType().Name} to {nextState.GetType().Name}.");
+
+            if (m_CurrentState != null)
+            {
+                m_CurrentState.Exit();
+            }
+            m_CurrentState = nextState;
+            m_CurrentState.Enter();
+        }
+
+        void OnClientDisconnectCallback(ulong clientId)
+        {
+            m_CurrentState.OnClientDisconnect(clientId);
+        }
+
+        void OnClientConnectedCallback(ulong clientId)
+        {
+            m_CurrentState.OnClientConnected(clientId);
+        }
+
+        void OnServerStarted()
+        {
+            m_CurrentState.OnServerStarted();
+        }
+
+        void ApprovalCheck(NetworkManager.ConnectionApprovalRequest request, NetworkManager.ConnectionApprovalResponse response)
+        {
+            m_CurrentState.ApprovalCheck(request, response);
+        }
+
+        public void StartClientLobby(string playerName)
+        {
+            m_CurrentState.StartClientLobby(playerName);
+        }
+
+        public void StartClientIp(string playerName, string ipaddress, int port)
+        {
+            m_CurrentState.StartClientIP(playerName, ipaddress, port);
+        }
+
+        public void StartHostLobby(string playerName)
+        {
+            m_CurrentState.StartHostLobby(playerName);
+        }
+
+        public void StartHostIp(string playerName, string ipaddress, int port)
+        {
+            m_CurrentState.StartHostIP(playerName, ipaddress, port);
+        }
+
+        public void RequestShutdown()
+        {
+            m_CurrentState.OnUserRequestedShutdown();
+        }
+
+        /// <summary>
+        /// Registers the message handler for custom named messages. This should only be done once StartClient has been
+        /// called (start client will initialize NetworkSceneManager and CustomMessagingManager)
+        /// </summary>
+        public void RegisterCustomMessages()
+        {
+            NetworkManager.CustomMessagingManager.RegisterNamedMessageHandler(nameof(ReceiveServerToClientSetDisconnectReason_CustomMessage), ReceiveServerToClientSetDisconnectReason_CustomMessage);
+        }
+
+        void ReceiveServerToClientSetDisconnectReason_CustomMessage(ulong clientID, FastBufferReader reader)
+        {
+            reader.ReadValueSafe(out ConnectStatus status);
+            m_CurrentState.OnDisconnectReasonReceived(status);
+        }
+
+        /// <summary>
+        /// 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)
+        {
+            var writer = new FastBufferWriter(sizeof(ConnectStatus), Allocator.Temp);
+            writer.WriteValueSafe(status);
+            NetworkManager.Singleton.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)
+        {
+            var writer = new FastBufferWriter(sizeof(ConnectStatus), Allocator.Temp);
+            writer.WriteValueSafe(status);
+            NetworkManager.Singleton.CustomMessagingManager.SendNamedMessage(nameof(ReceiveServerToClientSetDisconnectReason_CustomMessage), clientID, writer);
+        }
+    }
+}