fix: Fixed a runtime error when passing an array of struct INetworkSerializables to an RPC (#1402) (#1456)

* Fixed a runtime error when passing an array of struct INetworkSerializables to an RPC

Co-authored-by: Jaedyn Draper <[email protected]>
Co-authored-by: Unity Netcode CI <[email protected]>

Author: 3 people

com.unity.netcode.gameobjects/Runtime/Serialization/FastBufferWriter.cs

@@ -428,7 +428,7 @@ public void WriteNetworkSerializable<T>(in T value) where T : INetworkSerializab
         /// <param name="count"></param>
         /// <param name="offset"></param>
         /// <typeparam name="T"></typeparam>
-        public void WriteNetworkSerializable<T>(INetworkSerializable[] array, int count = -1, int offset = 0) where T : INetworkSerializable
+        public void WriteNetworkSerializable<T>(T[] array, int count = -1, int offset = 0) where T : INetworkSerializable
         {
             int sizeInTs = count != -1 ? count : array.Length - offset;
             WriteValueSafe(sizeInTs);

testproject/Assets/Tests/Runtime/RpcUserSerializableTypesTest.cs

@@ -11,9 +11,13 @@ namespace TestProject.RuntimeTests
     public class RpcUserSerializableTypesTest : BaseMultiInstanceTest
     {
         private UserSerializableClass m_UserSerializableClass;
+        private UserSerializableStruct m_UserSerializableStruct;
         private List<UserSerializableClass> m_UserSerializableClassArray;
+        private List<UserSerializableStruct> m_UserSerializableStructArray;
 
         private bool m_FinishedTest;
+        private bool m_FinishedStructTest;
+        private bool m_FinishedClassTest;
 
         private bool m_IsSendingNull;
         private bool m_IsArrayEmpty;
@@ -34,6 +38,8 @@ public override IEnumerator Setup()
         public IEnumerator NetworkSerializableTest()
         {
             m_FinishedTest = false;
+            m_FinishedStructTest = false;
+            m_FinishedClassTest = false;
             var startTime = Time.realtimeSinceStartup;
 
             yield return StartSomeClientsAndServerWithPlayers(true, NbClients, playerPrefab =>
@@ -46,6 +52,7 @@ public IEnumerator NetworkSerializableTest()
             yield return MultiInstanceHelpers.Run(MultiInstanceHelpers.GetNetworkObjectByRepresentation((x => x.IsPlayerObject && x.OwnerClientId == m_ClientNetworkManagers[0].LocalClientId), m_ClientNetworkManagers[0], clientClientPlayerResult));
             var clientSideNetworkBehaviourClass = clientClientPlayerResult.Result.gameObject.GetComponent<TestSerializationComponent>();
             clientSideNetworkBehaviourClass.OnSerializableClassUpdated = OnClientReceivedUserSerializableClassUpdated;
+            clientSideNetworkBehaviourClass.OnSerializableStructUpdated = OnClientReceivedUserSerializableStructUpdated;
 
 
             var userSerializableClass = new UserSerializableClass();
@@ -57,7 +64,13 @@ public IEnumerator NetworkSerializableTest()
             userSerializableClass.MyintValue = 1;
             userSerializableClass.MyulongValue = 100;
 
+            var userSerializableStruct = new UserSerializableStruct();
+
+            userSerializableStruct.MyintValue = 1;
+            userSerializableStruct.MyulongValue = 100;
+
             clientSideNetworkBehaviourClass.ClientStartTest(userSerializableClass);
+            clientSideNetworkBehaviourClass.ClientStartTest(userSerializableStruct);
 
             // Wait until the test has finished or we time out
             var timeOutPeriod = Time.realtimeSinceStartup + 5;
@@ -86,6 +99,9 @@ public IEnumerator NetworkSerializableTest()
                 Assert.AreEqual(m_UserSerializableClass.MyByteListValues[i], i);
             }
 
+            Assert.AreEqual(m_UserSerializableStruct.MyintValue, userSerializableStruct.MyintValue + 1);
+            Assert.AreEqual(m_UserSerializableStruct.MyulongValue, userSerializableStruct.MyulongValue + 1);
+
             // End of test
             m_ClientNetworkManagers[0].Shutdown();
             m_ServerNetworkManager.Shutdown();
@@ -286,7 +302,19 @@ public IEnumerator ExtensionMethodArrayRpcTest()
         private void OnClientReceivedUserSerializableClassUpdated(UserSerializableClass userSerializableClass)
         {
             m_UserSerializableClass = userSerializableClass;
-            m_FinishedTest = true;
+            m_FinishedClassTest = true;
+            m_FinishedTest = m_FinishedClassTest && m_FinishedStructTest;
+        }
+
+        /// <summary>
+        /// Delegate handler invoked towards the end of the when the NetworkSerializableTest
+        /// </summary>
+        /// <param name="userSerializableStruct"></param>
+        private void OnClientReceivedUserSerializableStructUpdated(UserSerializableStruct userSerializableStruct)
+        {
+            m_UserSerializableStruct = userSerializableStruct;
+            m_FinishedStructTest = true;
+            m_FinishedTest = m_FinishedClassTest && m_FinishedStructTest;
         }
 
         /// <summary>
@@ -352,14 +380,17 @@ public IEnumerator NetworkSerializableArrayTestHandler(int arraySize, bool sendN
             yield return MultiInstanceHelpers.Run(MultiInstanceHelpers.GetNetworkObjectByRepresentation((x => x.IsPlayerObject && x.OwnerClientId == m_ClientNetworkManagers[0].LocalClientId), m_ServerNetworkManager, serverClientPlayerResult));
             var serverSideNetworkBehaviourClass = serverClientPlayerResult.Result.gameObject.GetComponent<TestCustomTypesArrayComponent>();
             serverSideNetworkBehaviourClass.OnSerializableClassesUpdatedServerRpc = OnServerReceivedUserSerializableClassesUpdated;
+            serverSideNetworkBehaviourClass.OnSerializableStructsUpdatedServerRpc = OnServerReceivedUserSerializableStructsUpdated;
 
             // [Client-Side] Get the client side Player's NetworkObject so we can grab that instance of the TestCustomTypesArrayComponent
             var clientClientPlayerResult = new MultiInstanceHelpers.CoroutineResultWrapper<NetworkObject>();
             yield return MultiInstanceHelpers.Run(MultiInstanceHelpers.GetNetworkObjectByRepresentation((x => x.IsPlayerObject && x.OwnerClientId == m_ClientNetworkManagers[0].LocalClientId), m_ClientNetworkManagers[0], clientClientPlayerResult));
             var clientSideNetworkBehaviourClass = clientClientPlayerResult.Result.gameObject.GetComponent<TestCustomTypesArrayComponent>();
             clientSideNetworkBehaviourClass.OnSerializableClassesUpdatedClientRpc = OnClientReceivedUserSerializableClassesUpdated;
+            clientSideNetworkBehaviourClass.OnSerializableStructsUpdatedClientRpc = OnClientReceivedUserSerializableStructsUpdated;
 
             m_UserSerializableClassArray = new List<UserSerializableClass>();
+            m_UserSerializableStructArray = new List<UserSerializableStruct>();
 
             if (!m_IsSendingNull)
             {
@@ -370,13 +401,20 @@ public IEnumerator NetworkSerializableArrayTestHandler(int arraySize, bool sendN
                     //Used for testing order of the array
                     userSerializableClass.MyintValue = i;
                     m_UserSerializableClassArray.Add(userSerializableClass);
+
+                    var userSerializableStruct = new UserSerializableStruct();
+                    //Used for testing order of the array
+                    userSerializableStruct.MyintValue = i;
+                    m_UserSerializableStructArray.Add(userSerializableStruct);
                 }
 
                 clientSideNetworkBehaviourClass.ClientStartTest(m_UserSerializableClassArray.ToArray());
+                clientSideNetworkBehaviourClass.ClientStartStructTest(m_UserSerializableStructArray.ToArray());
             }
             else
             {
                 clientSideNetworkBehaviourClass.ClientStartTest(null);
+                clientSideNetworkBehaviourClass.ClientStartStructTest(null);
             }
 
             // Wait until the test has finished or we time out
@@ -437,7 +475,8 @@ private void ValidateUserSerializableClasses(UserSerializableClass[] userSeriali
         private void OnClientReceivedUserSerializableClassesUpdated(UserSerializableClass[] userSerializableClass)
         {
             ValidateUserSerializableClasses(userSerializableClass);
-            m_FinishedTest = true;
+            m_FinishedClassTest = true;
+            m_FinishedTest = m_FinishedClassTest && m_FinishedStructTest;
         }
 
         /// <summary>
@@ -450,6 +489,55 @@ private void OnServerReceivedUserSerializableClassesUpdated(UserSerializableClas
             ValidateUserSerializableClasses(userSerializableClass);
         }
 
+        /// <summary>
+        /// Verifies that the UserSerializableStruct array is in the same order
+        /// that it was sent.
+        /// </summary>
+        /// <param name="userSerializableStruct"></param>
+        private void ValidateUserSerializableStructs(UserSerializableStruct[] userSerializableStruct)
+        {
+            if (m_IsSendingNull)
+            {
+                Assert.IsNull(userSerializableStruct);
+            }
+            else if (m_IsArrayEmpty)
+            {
+                Assert.AreEqual(userSerializableStruct.Length, 0);
+            }
+            else
+            {
+                var indexCount = 0;
+                // Check the order of the array
+                foreach (var customTypeEntry in userSerializableStruct)
+                {
+                    Assert.AreEqual(customTypeEntry.MyintValue, indexCount);
+                    indexCount++;
+                }
+            }
+        }
+
+        /// <summary>
+        /// Delegate handler invoked when the server sends the client
+        /// the UserSerializableStruct array during the NetworkSerializableArrayTest
+        /// </summary>
+        /// <param name="userSerializableStruct"></param>
+        private void OnClientReceivedUserSerializableStructsUpdated(UserSerializableStruct[] userSerializableStruct)
+        {
+            ValidateUserSerializableStructs(userSerializableStruct);
+            m_FinishedStructTest = true;
+            m_FinishedTest = m_FinishedClassTest && m_FinishedStructTest;
+        }
+
+        /// <summary>
+        /// Delegate handler invoked when the client sends the server
+        /// the UserSerializableStruct array during the NetworkSerializableArrayTest
+        /// </summary>
+        /// <param name="userSerializableStruct"></param>
+        private void OnServerReceivedUserSerializableStructsUpdated(UserSerializableStruct[] userSerializableStruct)
+        {
+            ValidateUserSerializableStructs(userSerializableStruct);
+        }
+
     }
 
     /// <summary>
@@ -461,6 +549,9 @@ public class TestSerializationComponent : NetworkBehaviour
         public delegate void OnSerializableClassUpdatedDelgateHandler(UserSerializableClass userSerializableClass);
         public OnSerializableClassUpdatedDelgateHandler OnSerializableClassUpdated;
 
+        public delegate void OnSerializableStructUpdatedDelgateHandler(UserSerializableStruct userSerializableStruct);
+        public OnSerializableStructUpdatedDelgateHandler OnSerializableStructUpdated;
+
         public delegate void OnMySharedObjectReferencedByIdUpdatedDelgateHandler(MySharedObjectReferencedById obj);
         public OnMySharedObjectReferencedByIdUpdatedDelgateHandler OnMySharedObjectReferencedByIdUpdated;
 
@@ -511,6 +602,41 @@ private void SendClientSerializedDataClientRpc(UserSerializableClass userSeriali
             }
         }
 
+        /// <summary>
+        /// Starts the unit test and passes the UserSerializableStruct from the client to the server
+        /// </summary>
+        /// <param name="userSerializableStruct"></param>
+        public void ClientStartTest(UserSerializableStruct userSerializableStruct)
+        {
+            SendServerSerializedDataServerRpc(userSerializableStruct);
+        }
+
+        /// <summary>
+        /// Server receives the UserSerializableStruct, modifies it, and sends it back
+        /// </summary>
+        /// <param name="userSerializableStruct"></param>
+        [ServerRpc(RequireOwnership = false)]
+        private void SendServerSerializedDataServerRpc(UserSerializableStruct userSerializableStruct)
+        {
+            userSerializableStruct.MyintValue++;
+            userSerializableStruct.MyulongValue++;
+
+            SendClientSerializedDataClientRpc(userSerializableStruct);
+        }
+
+        /// <summary>
+        /// Client receives the UserSerializableStruct and then invokes the OnSerializableStructUpdated (if set)
+        /// </summary>
+        /// <param name="userSerializableStruct"></param>
+        [ClientRpc]
+        private void SendClientSerializedDataClientRpc(UserSerializableStruct userSerializableStruct)
+        {
+            if (OnSerializableStructUpdated != null)
+            {
+                OnSerializableStructUpdated.Invoke(userSerializableStruct);
+            }
+        }
+
         [ClientRpc]
         public void SendMyObjectClientRpc(MyObject obj)
         {
@@ -559,6 +685,7 @@ public void SendMySharedObjectReferencedByIdServerRpc(MySharedObjectReferencedBy
     public class TestCustomTypesArrayComponent : NetworkBehaviour
     {
         public delegate void OnSerializableClassesUpdatedDelgateHandler(UserSerializableClass[] userSerializableClasses);
+        public delegate void OnSerializableStructsUpdatedDelgateHandler(UserSerializableStruct[] userSerializableStructs);
 
         public delegate void OnMySharedObjectReferencedByIdUpdatedDelgateHandler(MySharedObjectReferencedById[] obj);
         public OnMySharedObjectReferencedByIdUpdatedDelgateHandler OnMySharedObjectReferencedByIdUpdated;
@@ -568,6 +695,8 @@ public class TestCustomTypesArrayComponent : NetworkBehaviour
 
         public OnSerializableClassesUpdatedDelgateHandler OnSerializableClassesUpdatedServerRpc;
         public OnSerializableClassesUpdatedDelgateHandler OnSerializableClassesUpdatedClientRpc;
+        public OnSerializableStructsUpdatedDelgateHandler OnSerializableStructsUpdatedServerRpc;
+        public OnSerializableStructsUpdatedDelgateHandler OnSerializableStructsUpdatedClientRpc;
 
         /// <summary>
         /// Starts the unit test and passes the userSerializableClasses array
@@ -595,10 +724,10 @@ private void SendServerSerializedDataServerRpc(UserSerializableClass[] userSeria
         }
 
         /// <summary>
-        /// Client receives the UserSerializableClasses array and invokes the callback
+        /// Client receives the UserSerializableClass array and invokes the callback
         /// for verification and signaling the test is complete.
         /// </summary>
-        /// <param name="userSerializableClass"></param>
+        /// <param name="userSerializableClasses"></param>
         [ClientRpc]
         private void SendClientSerializedDataClientRpc(UserSerializableClass[] userSerializableClasses)
         {
@@ -608,6 +737,45 @@ private void SendClientSerializedDataClientRpc(UserSerializableClass[] userSeria
             }
         }
 
+        /// <summary>
+        /// Starts the unit test and passes the userSerializableStructs array
+        /// from the client to the server
+        /// </summary>
+        /// <param name="userSerializableStructs"></param>
+        public void ClientStartStructTest(UserSerializableStruct[] userSerializableStructs)
+        {
+            SendServerSerializedDataServerRpc(userSerializableStructs);
+        }
+
+        /// <summary>
+        /// Server receives the UserSerializableStructs array, invokes the callback
+        /// that checks the order, and then passes it back to the client
+        /// </summary>
+        /// <param name="userSerializableStructs"></param>
+        [ServerRpc(RequireOwnership = false)]
+        private void SendServerSerializedDataServerRpc(UserSerializableStruct[] userSerializableStructs)
+        {
+            if (OnSerializableStructsUpdatedServerRpc != null)
+            {
+                OnSerializableStructsUpdatedServerRpc.Invoke(userSerializableStructs);
+            }
+            SendClientSerializedDataClientRpc(userSerializableStructs);
+        }
+
+        /// <summary>
+        /// Client receives the userSerializableStructs array and invokes the callback
+        /// for verification and signaling the test is complete.
+        /// </summary>
+        /// <param name="userSerializableStructs"></param>
+        [ClientRpc]
+        private void SendClientSerializedDataClientRpc(UserSerializableStruct[] userSerializableStructs)
+        {
+            if (OnSerializableStructsUpdatedClientRpc != null)
+            {
+                OnSerializableStructsUpdatedClientRpc.Invoke(userSerializableStructs);
+            }
+        }
+
         [ClientRpc]
         public void SendMyObjectClientRpc(MyObject[] objs)
         {
@@ -682,6 +850,21 @@ public UserSerializableClass()
         }
     }
 
+    /// <summary>
+    /// The test version of a custom user-defined struct that implements INetworkSerializable
+    /// </summary>
+    public struct UserSerializableStruct : INetworkSerializable
+    {
+        public int MyintValue;
+        public ulong MyulongValue;
+
+        public void NetworkSerialize<T>(BufferSerializer<T> serializer) where T : IReaderWriter
+        {
+            serializer.SerializeValue(ref MyintValue);
+            serializer.SerializeValue(ref MyulongValue);
+        }
+    }
+
     public class MyObject
     {
         public int I;