feat: message to clients when host ends game session intentionally [MTT-3202] (#594)

* Adding message for when host ends session voluntarily

* Also makes sure that RequestDisconnect is only called when a disconnect is actually requested

Author: LPLafontaineB

Assets/BossRoom/Scripts/Client/UI/ConnectionStatusMessageUIManager.cs

@@ -48,6 +48,9 @@ void OnConnectStatus(ConnectStatus status)
                 case ConnectStatus.GenericDisconnect:
                     PopupManager.ShowPopupPanel("Disconnected From Host", "The connection to the host was lost.");
                     break;
+                case ConnectStatus.HostEndedSession:
+                    PopupManager.ShowPopupPanel("Disconnected From Host", "The host has ended the game session.");
+                    break;
                 default:
                     Debug.LogWarning($"New ConnectStatus {status} has been added, but no connect message defined for it.");
                     break;

Assets/BossRoom/Scripts/Client/UI/UIQuitPanel.cs

@@ -30,7 +30,7 @@ public void Quit()
             switch (m_QuitMode)
             {
                 case QuitMode.ReturnToMenu:
-                    m_ApplicationController.LeaveSession();
+                    m_ApplicationController.LeaveSession(true);
                     break;
                 case QuitMode.QuitApplication:
                     m_ApplicationController.QuitGame();

Assets/BossRoom/Scripts/Shared/ApplicationController.cs

@@ -113,15 +113,18 @@ private bool OnWantToQuit()
             return canQuit;
         }
 
-        public void LeaveSession()
+        public void LeaveSession(bool UserRequested)
         {
             m_LobbyServiceFacade.EndTracking();
 
-            // first disconnect then return to menu
-            var gameNetPortal = GameNetPortal.Instance;
-            if (gameNetPortal != null)
+            if (UserRequested)
             {
-                gameNetPortal.RequestDisconnect();
+                // first disconnect then return to menu
+                var gameNetPortal = GameNetPortal.Instance;
+                if (gameNetPortal != null)
+                {
+                    gameNetPortal.RequestDisconnect();
+                }
             }
             SceneLoaderWrapper.Instance.LoadScene("MainMenu");
         }

Assets/BossRoom/Scripts/Shared/Net/ConnectionManagement/ClientGameNetPortal.cs

@@ -97,6 +97,11 @@ public void OnUserDisconnectRequest()
             if (m_Portal.NetManager.IsClient)
             {
                 DisconnectReason.SetDisconnectReason(ConnectStatus.UserRequestedDisconnect);
+                // If we are the server, shutdown will be handled by ServerGameNetPortal
+                if (!m_Portal.NetManager.IsServer)
+                {
+                    m_Portal.NetManager.Shutdown();
+                }
             }
         }
 
@@ -132,12 +137,6 @@ private void OnDisconnectOrTimeout(ulong clientID)
             // not a host (in which case we know this is about us) or that the clientID is the same as ours if we are the host.
             if (!NetworkManager.Singleton.IsHost || NetworkManager.Singleton.IsHost && NetworkManager.Singleton.LocalClientId == clientID)
             {
-                var lobbyCode = "";
-                if (m_LobbyServiceFacade.CurrentUnityLobby != null)
-                {
-                    lobbyCode = m_LobbyServiceFacade.CurrentUnityLobby.LobbyCode;
-                }
-
                 //On a client disconnect we want to take them back to the main menu.
                 //We have to check here in SceneManager if our active scene is the main menu, as if it is, it means we timed out rather than a raw disconnect;
                 if (SceneManager.GetActiveScene().name != "MainMenu")
@@ -149,7 +148,7 @@ private void OnDisconnectOrTimeout(ulong clientID)
                         //disconnect that happened for some other reason than user UI interaction--should display a message.
                         DisconnectReason.SetDisconnectReason(ConnectStatus.GenericDisconnect);
                     }
-                    m_ApplicationController.LeaveSession();
+                    m_ApplicationController.LeaveSession(false);
                 }
                 else
                 {

Assets/BossRoom/Scripts/Shared/Net/ConnectionManagement/GameNetPortal.cs

@@ -21,7 +21,8 @@ public enum ConnectStatus
         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.
-        IncompatibleBuildType,      //client build type is incompatible with server.
+        IncompatibleBuildType,    //client build type is incompatible with server.
+        HostEndedSession,         //host intentionally ended the session.
     }
 
     public enum OnlineMode
@@ -244,7 +245,6 @@ public void RequestDisconnect()
             }
             m_ClientPortal.OnUserDisconnectRequest();
             m_ServerPortal.OnUserDisconnectRequest();
-            NetManager.Shutdown();
         }
 
         public string GetPlayerId()

Assets/BossRoom/Scripts/Shared/Net/ConnectionManagement/ServerGameNetPortal.cs

@@ -126,6 +126,12 @@ public void OnClientSceneChanged(ulong clientId, int sceneIndex)
         /// </summary>
         public void OnUserDisconnectRequest()
         {
+            if (m_Portal.NetManager.IsHost)
+            {
+                SendServerToAllClientsSetDisconnectReason(ConnectStatus.HostEndedSession);
+                // Wait before shutting down to make sure clients receive that message before they are disconnected
+                StartCoroutine(WaitToShutdown());
+            }
             Clear();
         }
 
@@ -233,6 +239,24 @@ static IEnumerator WaitToDenyApproval(NetworkManager.ConnectionApprovedDelegate
             connectionApprovedCallback(false, 0, false, null, null);
         }
 
+        IEnumerator WaitToShutdown()
+        {
+            yield return null;
+            m_Portal.NetManager.Shutdown();
+            SessionManager<SessionPlayerData>.Instance.OnServerEnded();
+        }
+
+        /// <summary>
+        /// Sends a DisconnectReason to all connected clients. This should only be done on the server, prior to disconnecting the client.
+        /// </summary>
+        /// <param name="status"> The reason for the upcoming disconnect.</param>
+        static void SendServerToAllClientsSetDisconnectReason(ConnectStatus status)
+        {
+            var writer = new FastBufferWriter(sizeof(ConnectStatus), Allocator.Temp);
+            writer.WriteValueSafe(status);
+            NetworkManager.Singleton.CustomMessagingManager.SendNamedMessageToAll(nameof(ClientGameNetPortal.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>