replacing custom messaging with new disconnect reason (v2)

LPLafontaineB · LPLafontaineB · commit b4e5da82fbb8 · 2022-12-07T11:25:16.000-05:00
diff --git a/Assets/Scripts/ConnectionManagement/ConnectionManager.cs b/Assets/Scripts/ConnectionManagement/ConnectionManager.cs
@@ -172,43 +172,5 @@ 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 void SendServerToAllClientsSetDisconnectReason(ConnectStatus status)
-        {
-            var writer = new FastBufferWriter(sizeof(ConnectStatus), Allocator.Temp);
-            writer.WriteValueSafe(status);
-            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 void SendServerToClientSetDisconnectReason(ulong clientID, ConnectStatus status)
-        {
-            var writer = new FastBufferWriter(sizeof(ConnectStatus), Allocator.Temp);
-            writer.WriteValueSafe(status);
-            NetworkManager.CustomMessagingManager.SendNamedMessage(nameof(ReceiveServerToClientSetDisconnectReason_CustomMessage), clientID, writer);
-        }
     }
 }
diff --git a/Assets/Scripts/ConnectionManagement/ConnectionState/ClientConnectedState.cs b/Assets/Scripts/ConnectionManagement/ConnectionState/ClientConnectedState.cs
@@ -26,20 +26,24 @@ public override void Exit() { }
 
         public override void OnClientDisconnect(ulong _)
         {
-            m_ConnectStatusPublisher.Publish(ConnectStatus.Reconnecting);
-            m_ConnectionManager.ChangeState(m_ConnectionManager.m_ClientReconnecting);
+            var disconnectReason = m_ConnectionManager.NetworkManager.DisconnectReason;
+            if (string.IsNullOrEmpty(disconnectReason))
+            {
+                m_ConnectStatusPublisher.Publish(ConnectStatus.Reconnecting);
+                m_ConnectionManager.ChangeState(m_ConnectionManager.m_ClientReconnecting);
+            }
+            else
+            {
+                var connectStatus = JsonUtility.FromJson<ConnectStatus>(disconnectReason);
+                m_ConnectStatusPublisher.Publish(connectStatus);
+                m_ConnectionManager.ChangeState(m_ConnectionManager.m_Offline);
+            }
         }
 
         public override void OnUserRequestedShutdown()
         {
             m_ConnectStatusPublisher.Publish(ConnectStatus.UserRequestedDisconnect);
             m_ConnectionManager.ChangeState(m_ConnectionManager.m_Offline);
         }
-
-        public override void OnDisconnectReasonReceived(ConnectStatus disconnectReason)
-        {
-            m_ConnectStatusPublisher.Publish(disconnectReason);
-            m_ConnectionManager.ChangeState(m_ConnectionManager.m_DisconnectingWithReason);
-        }
     }
 }
diff --git a/Assets/Scripts/ConnectionManagement/ConnectionState/ClientConnectingState.cs b/Assets/Scripts/ConnectionManagement/ConnectionState/ClientConnectingState.cs
@@ -49,16 +49,19 @@ public override void OnClientDisconnect(ulong _)
 
         protected void StartingClientFailedAsync()
         {
-            m_ConnectStatusPublisher.Publish(ConnectStatus.StartClientFailed);
+            var disconnectReason = m_ConnectionManager.NetworkManager.DisconnectReason;
+            if (string.IsNullOrEmpty(disconnectReason))
+            {
+                m_ConnectStatusPublisher.Publish(ConnectStatus.StartClientFailed);
+            }
+            else
+            {
+                var connectStatus = JsonUtility.FromJson<ConnectStatus>(disconnectReason);
+                m_ConnectStatusPublisher.Publish(connectStatus);
+            }
             m_ConnectionManager.ChangeState(m_ConnectionManager.m_Offline);
         }
 
-        public override void OnDisconnectReasonReceived(ConnectStatus disconnectReason)
-        {
-            m_ConnectStatusPublisher.Publish(disconnectReason);
-            m_ConnectionManager.ChangeState(m_ConnectionManager.m_DisconnectingWithReason);
-        }
-
 
         internal async Task ConnectClientAsync()
         {
@@ -74,7 +77,6 @@ internal async Task ConnectClientAsync()
                 }
 
                 SceneLoaderWrapper.Instance.AddOnSceneEventCallback();
-                m_ConnectionManager.RegisterCustomMessages();
             }
             catch (Exception e)
             {
diff --git a/Assets/Scripts/ConnectionManagement/ConnectionState/ClientReconnectingState.cs b/Assets/Scripts/ConnectionManagement/ConnectionState/ClientReconnectingState.cs
@@ -47,27 +47,35 @@ public override void OnClientConnected(ulong _)
 
         public override void OnClientDisconnect(ulong _)
         {
-            if (m_NbAttempts < m_ConnectionManager.NbReconnectAttempts)
+            var disconnectReason = m_ConnectionManager.NetworkManager.DisconnectReason;
+            if (string.IsNullOrEmpty(disconnectReason))
             {
-                m_ReconnectCoroutine = m_ConnectionManager.StartCoroutine(ReconnectCoroutine());
+                if (m_NbAttempts < m_ConnectionManager.NbReconnectAttempts)
+                {
+                    m_ReconnectCoroutine = m_ConnectionManager.StartCoroutine(ReconnectCoroutine());
+                }
+                else
+                {
+                    m_ConnectStatusPublisher.Publish(ConnectStatus.GenericDisconnect);
+                    m_ConnectionManager.ChangeState(m_ConnectionManager.m_Offline);
+                }
             }
             else
             {
-                m_ConnectStatusPublisher.Publish(ConnectStatus.GenericDisconnect);
-                m_ConnectionManager.ChangeState(m_ConnectionManager.m_Offline);
-            }
-        }
-
-        public override void OnDisconnectReasonReceived(ConnectStatus disconnectReason)
-        {
-            m_ConnectStatusPublisher.Publish(disconnectReason);
-            switch (disconnectReason)
-            {
-                case ConnectStatus.UserRequestedDisconnect:
-                case ConnectStatus.HostEndedSession:
-                case ConnectStatus.ServerFull:
-                    m_ConnectionManager.ChangeState(m_ConnectionManager.m_DisconnectingWithReason);
-                    break;
+                var connectStatus = JsonUtility.FromJson<ConnectStatus>(disconnectReason);
+                m_ConnectStatusPublisher.Publish(connectStatus);
+                switch (connectStatus)
+                {
+                    case ConnectStatus.UserRequestedDisconnect:
+                    case ConnectStatus.HostEndedSession:
+                    case ConnectStatus.ServerFull:
+                    case ConnectStatus.IncompatibleBuildType:
+                        m_ConnectionManager.ChangeState(m_ConnectionManager.m_Offline);
+                        break;
+                    default:
+                        m_ReconnectCoroutine = m_ConnectionManager.StartCoroutine(ReconnectCoroutine());
+                        break;
+                }
             }
         }
 
diff --git a/Assets/Scripts/ConnectionManagement/ConnectionState/ConnectionState.cs b/Assets/Scripts/ConnectionManagement/ConnectionState/ConnectionState.cs
@@ -36,8 +36,6 @@ public virtual void StartHostLobby(string playerName) { }
 
         public virtual void OnUserRequestedShutdown() { }
 
-        public virtual void OnDisconnectReasonReceived(ConnectStatus disconnectReason) { }
-
         public virtual void ApprovalCheck(NetworkManager.ConnectionApprovalRequest request, NetworkManager.ConnectionApprovalResponse response) { }
 
         public virtual void OnTransportFailure() { }
diff --git a/Assets/Scripts/ConnectionManagement/ConnectionState/HostingState.cs b/Assets/Scripts/ConnectionManagement/ConnectionState/HostingState.cs
@@ -71,9 +71,19 @@ public override void OnClientDisconnect(ulong clientId)
 
         public override void OnUserRequestedShutdown()
         {
-            m_ConnectionManager.SendServerToAllClientsSetDisconnectReason(ConnectStatus.HostEndedSession);
-            // Wait before shutting down to make sure clients receive that message before they are disconnected
-            m_ConnectionManager.StartCoroutine(WaitToShutdown());
+            ulong[] clientIds = new ulong[m_ConnectionManager.NetworkManager.ConnectedClientsIds.Count];
+            var i = 0;
+            foreach (var id in m_ConnectionManager.NetworkManager.ConnectedClientsIds)
+            {
+                clientIds[i] = id;
+                i++;
+            }
+
+            foreach (var id in clientIds)
+            {
+                m_ConnectionManager.NetworkManager.DisconnectClient(id, JsonUtility.ToJson(ConnectStatus.HostEndedSession));
+            }
+            m_ConnectionManager.ChangeState(m_ConnectionManager.m_Offline);
         }
 
         /// <summary>
@@ -119,21 +129,8 @@ public override void ApprovalCheck(NetworkManager.ConnectionApprovalRequest requ
                 return;
             }
 
-            // In order for clients to not just get disconnected with no feedback, the server needs to tell the client why it disconnected it.
-            // This could happen after an auth check on a service or because of gameplay reasons (server full, wrong build version, etc)
-            // Since network objects haven't synced yet (still in the approval process), we need to send a custom message to clients, wait for
-            // UTP to update a frame and flush that message, then give our response to NetworkManager's connection approval process, with a denied approval.
-            IEnumerator WaitToDenyApproval()
-            {
-                response.Pending = true; // give some time for server to send connection status message to clients
-                response.Approved = false;
-                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.
-            }
-
-            m_ConnectionManager.SendServerToClientSetDisconnectReason(clientId, gameReturnStatus);
-            m_ConnectionManager.StartCoroutine(WaitToDenyApproval());
+            response.Approved = false;
+            response.Reason = JsonUtility.ToJson(gameReturnStatus);
             if (m_LobbyServiceFacade.CurrentUnityLobby != null)
             {
                 m_LobbyServiceFacade.RemovePlayerFromLobbyAsync(connectionPayload.playerId, m_LobbyServiceFacade.CurrentUnityLobby.Id);
@@ -155,11 +152,5 @@ ConnectStatus GetConnectStatus(ConnectionPayload connectionPayload)
             return SessionManager<SessionPlayerData>.Instance.IsDuplicateConnection(connectionPayload.playerId) ?
                 ConnectStatus.LoggedInAgain : ConnectStatus.Success;
         }
-
-        IEnumerator WaitToShutdown()
-        {
-            yield return null;
-            m_ConnectionManager.ChangeState(m_ConnectionManager.m_Offline);
-        }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -26,20 +26,24 @@ public override void Exit() { }`
`26`	`26`
`27`	`27`	`public override void OnClientDisconnect(ulong _)`
`28`	`28`	`{`
`29`		`- m_ConnectStatusPublisher.Publish(ConnectStatus.Reconnecting);`
`30`		`- m_ConnectionManager.ChangeState(m_ConnectionManager.m_ClientReconnecting);`
	`29`	`+ var disconnectReason = m_ConnectionManager.NetworkManager.DisconnectReason;`
	`30`	`+ if (string.IsNullOrEmpty(disconnectReason))`
	`31`	`+ {`
	`32`	`+ m_ConnectStatusPublisher.Publish(ConnectStatus.Reconnecting);`
	`33`	`+ m_ConnectionManager.ChangeState(m_ConnectionManager.m_ClientReconnecting);`
	`34`	`+ }`
	`35`	`+ else`
	`36`	`+ {`
	`37`	`+ var connectStatus = JsonUtility.FromJson<ConnectStatus>(disconnectReason);`
	`38`	`+ m_ConnectStatusPublisher.Publish(connectStatus);`
	`39`	`+ m_ConnectionManager.ChangeState(m_ConnectionManager.m_Offline);`
	`40`	`+ }`
`31`	`41`	`}`
`32`	`42`
`33`	`43`	`public override void OnUserRequestedShutdown()`
`34`	`44`	`{`
`35`	`45`	`m_ConnectStatusPublisher.Publish(ConnectStatus.UserRequestedDisconnect);`
`36`	`46`	`m_ConnectionManager.ChangeState(m_ConnectionManager.m_Offline);`
`37`	`47`	`}`
`38`		`-`
`39`		`- public override void OnDisconnectReasonReceived(ConnectStatus disconnectReason)`
`40`		`- {`
`41`		`- m_ConnectStatusPublisher.Publish(disconnectReason);`
`42`		`- m_ConnectionManager.ChangeState(m_ConnectionManager.m_DisconnectingWithReason);`
`43`		`- }`
`44`	`48`	`}`
`45`	`49`	`}`
Original file line number	Diff line number	Diff line change
`@@ -49,16 +49,19 @@ public override void OnClientDisconnect(ulong _)`
`49`	`49`
`50`	`50`	`protected void StartingClientFailedAsync()`
`51`	`51`	`{`
`52`		`- m_ConnectStatusPublisher.Publish(ConnectStatus.StartClientFailed);`
	`52`	`+ var disconnectReason = m_ConnectionManager.NetworkManager.DisconnectReason;`
	`53`	`+ if (string.IsNullOrEmpty(disconnectReason))`
	`54`	`+ {`
	`55`	`+ m_ConnectStatusPublisher.Publish(ConnectStatus.StartClientFailed);`
	`56`	`+ }`
	`57`	`+ else`
	`58`	`+ {`
	`59`	`+ var connectStatus = JsonUtility.FromJson<ConnectStatus>(disconnectReason);`
	`60`	`+ m_ConnectStatusPublisher.Publish(connectStatus);`
	`61`	`+ }`
`53`	`62`	`m_ConnectionManager.ChangeState(m_ConnectionManager.m_Offline);`
`54`	`63`	`}`
`55`	`64`
`56`		`- public override void OnDisconnectReasonReceived(ConnectStatus disconnectReason)`
`57`		`- {`
`58`		`- m_ConnectStatusPublisher.Publish(disconnectReason);`
`59`		`- m_ConnectionManager.ChangeState(m_ConnectionManager.m_DisconnectingWithReason);`
`60`		`- }`
`61`		`-`
`62`	`65`
`63`	`66`	`internal async Task ConnectClientAsync()`
`64`	`67`	`{`
`@@ -74,7 +77,6 @@ internal async Task ConnectClientAsync()`
`74`	`77`	`}`
`75`	`78`
`76`	`79`	`SceneLoaderWrapper.Instance.AddOnSceneEventCallback();`
`77`		`- m_ConnectionManager.RegisterCustomMessages();`
`78`	`80`	`}`
`79`	`81`	`catch (Exception e)`
`80`	`82`	`{`