fix: Added recursion checks to buffering to ensure we only buffer once (rare)

Author: TwoTenPvP

MLAPI/Core/NetworkingManager.cs

@@ -849,7 +849,7 @@ private void HandleRawTransportPoll(NetEventType eventType, ulong clientId, stri
                 case NetEventType.Data:
                     if (LogHelper.CurrentLogLevel <= LogLevel.Developer) LogHelper.LogInfo($"Incoming Data From {clientId} : {payload.Count} bytes");
 
-                    HandleIncomingData(clientId, channelName, payload, receiveTime);
+                    HandleIncomingData(clientId, channelName, payload, receiveTime, true);
                     break;
                 case NetEventType.Disconnect:
                     NetworkProfiler.StartEvent(TickType.Receive, 0, "NONE", "TRANSPORT_DISCONNECT");
@@ -871,7 +871,7 @@ private void HandleRawTransportPoll(NetEventType eventType, ulong clientId, stri
             }
         }
 
-        internal void HandleIncomingData(ulong clientId, string channelName, ArraySegment<byte> data, float receiveTime)
+        internal void HandleIncomingData(ulong clientId, string channelName, ArraySegment<byte> data, float receiveTime, bool allowBuffer)
         {
             if (LogHelper.CurrentLogLevel <= LogLevel.Developer) LogHelper.LogInfo("Unwrapping Data Header");
 
@@ -910,6 +910,13 @@ internal void HandleIncomingData(ulong clientId, string channelName, ArraySegmen
 
                     void bufferCallback(ulong networkId)
                     {
+                        if (!allowBuffer)
+                        {
+                            // This is to prevent recursive buffering
+                            if (LogHelper.CurrentLogLevel <= LogLevel.Error) LogHelper.LogError("A message of type " + MLAPIConstants.MESSAGE_NAMES[messageType] + " was recursivley buffered. It has been dropped.");
+                            return;
+                        }
+
                         if (!NetworkConfig.EnableMessageBuffering)
                         {
                             throw new InvalidOperationException("Cannot buffer with buffering disabled.");
@@ -927,12 +934,10 @@ void bufferCallback(ulong networkId)
                     switch (messageType)
                     {
                         case MLAPIConstants.MLAPI_CONNECTION_REQUEST:
-                            if (IsServer)
-                                InternalMessageHandler.HandleConnectionRequest(clientId, messageStream);
+                            if (IsServer) InternalMessageHandler.HandleConnectionRequest(clientId, messageStream);
                             break;
                         case MLAPIConstants.MLAPI_CONNECTION_APPROVED:
-                            if (IsClient)
-                                InternalMessageHandler.HandleConnectionApproved(clientId, messageStream, receiveTime);
+                            if (IsClient) InternalMessageHandler.HandleConnectionApproved(clientId, messageStream, receiveTime);
                             break;
                         case MLAPIConstants.MLAPI_ADD_OBJECT:
                             if (IsClient) InternalMessageHandler.HandleAddObject(clientId, messageStream);

MLAPI/Messaging/InternalMessageHandler.cs

@@ -379,7 +379,7 @@ internal static void HandleAddObject(ulong clientId, Stream stream)
                     {
                         BufferManager.BufferedMessage message = bufferQueue.Dequeue();
 
-                        NetworkingManager.Singleton.HandleIncomingData(message.sender, message.channelName, new ArraySegment<byte>(message.payload.GetBuffer(), (int)message.payload.Position, (int)message.payload.Length), message.receiveTime);
+                        NetworkingManager.Singleton.HandleIncomingData(message.sender, message.channelName, new ArraySegment<byte>(message.payload.GetBuffer(), (int)message.payload.Position, (int)message.payload.Length), message.receiveTime, false);
 
                         BufferManager.RecycleConsumedBufferedMessage(message);
                     }

MLAPI/SceneManagement/NetworkSceneManager.cs

@@ -356,7 +356,7 @@ private static void OnSceneUnloadClient(Guid switchSceneGuid, Stream objectStrea
                             {
                                 BufferManager.BufferedMessage message = bufferQueue.Dequeue();
 
-                                NetworkingManager.Singleton.HandleIncomingData(message.sender, message.channelName, new ArraySegment<byte>(message.payload.GetBuffer(), (int)message.payload.Position, (int)message.payload.Length), message.receiveTime);
+                                NetworkingManager.Singleton.HandleIncomingData(message.sender, message.channelName, new ArraySegment<byte>(message.payload.GetBuffer(), (int)message.payload.Position, (int)message.payload.Length), message.receiveTime, false);
 
                                 BufferManager.RecycleConsumedBufferedMessage(message);
                             }
@@ -401,7 +401,7 @@ private static void OnSceneUnloadClient(Guid switchSceneGuid, Stream objectStrea
                             {
                                 BufferManager.BufferedMessage message = bufferQueue.Dequeue();
 
-                                NetworkingManager.Singleton.HandleIncomingData(message.sender, message.channelName, new ArraySegment<byte>(message.payload.GetBuffer(), (int)message.payload.Position, (int)message.payload.Length), message.receiveTime);
+                                NetworkingManager.Singleton.HandleIncomingData(message.sender, message.channelName, new ArraySegment<byte>(message.payload.GetBuffer(), (int)message.payload.Position, (int)message.payload.Length), message.receiveTime, false);
 
                                 BufferManager.RecycleConsumedBufferedMessage(message);
                             }