Merge branch 'develop' into fix/test-roject-runtimetests-standalone-testrunner-build

Author: NoelStephensUnity

com.unity.netcode.gameobjects/CHANGELOG.md

@@ -23,6 +23,7 @@ Additional documentation and release notes are available at [Multiplayer Documen
 - Fixed The NetworkConfig's checksum hash includes the NetworkTick so that clients with a different tickrate than the server are identified and not allowed to connect. (#1513)
 - Fixed OwnedObjects not being properly modified when using ChangeOwnership. (#1572)
 - Fixed When the LogLevel is set to developer NetworkBehaviour generates warning messages when it should not (#1631)
+- Fixed client-side exception from being thrown in NetworkSceneManager when migrating NetworkObjects to or from the DDOL scene. (#1633)
 
 ### Changed
 

com.unity.netcode.gameobjects/Runtime/SceneManagement/NetworkSceneManager.cs

@@ -1802,6 +1802,11 @@ internal void MoveObjectsToDontDestroyOnLoad()
             var objectsToKeep = new HashSet<NetworkObject>(m_NetworkManager.SpawnManager.SpawnedObjectsList);
             foreach (var sobj in objectsToKeep)
             {
+                if (sobj == null)
+                {
+                    continue;
+                }
+
                 if (!sobj.DestroyWithScene || sobj.gameObject.scene == DontDestroyOnLoadScene)
                 {
                     // Only move dynamically spawned network objects with no parent as child objects will follow
@@ -1877,6 +1882,10 @@ internal void MoveObjectsFromDontDestroyOnLoadToScene(Scene scene)
 
             foreach (var sobj in objectsToKeep)
             {
+                if (sobj == null)
+                {
+                    continue;
+                }
                 // If it is in the DDOL then
                 if (sobj.gameObject.scene == DontDestroyOnLoadScene)
                 {

testproject/Assets/Tests/Manual/Scripts/NetworkPrefabPool.cs

@@ -238,6 +238,10 @@ public override void OnNetworkDespawn()
 
             foreach (var obj in m_ObjectPool)
             {
+                if (obj == null)
+                {
+                    continue;
+                }
                 var networkObject = obj.GetComponent<NetworkObject>();
                 var genericBehaviour = obj.GetComponent<GenericNetworkObjectBehaviour>();
                 if (networkObject.IsSpawned)

testproject/Assets/Tests/Runtime/NetworkSceneManagerTests.cs

@@ -919,6 +919,7 @@ private void Server_OnLoad(ulong clientId, string sceneName, LoadSceneMode loadS
             ClientProcessedNotification(clientId, SceneEventType.Load, true);
         }
         #endregion
+
     }
 
     /// <summary>
@@ -1103,4 +1104,66 @@ public void SetInScene(bool isInScene)
 
     }
 
+
+    public class NetworkSceneManagerFixValidationTests : BaseMultiInstanceTest
+    {
+        protected override int NbClients => 0;
+
+        public override IEnumerator Setup()
+        {
+            m_BypassStartAndWaitForClients = true;
+            return base.Setup();
+        }
+
+        /// <summary>
+        /// This validation test verifies that the NetworkSceneManager will not crash if
+        /// the SpawnManager.SpawnedObjectsList contains destroyed and invalid NetworkObjects.
+        /// </summary>
+        [Test]
+        public void DDOLPopulateWithNullNetworkObjectsValidation([Values] bool useHost)
+        {
+            var gameObject = new GameObject();
+            var networkObject = gameObject.AddComponent<NetworkObject>();
+            MultiInstanceHelpers.MakeNetworkObjectTestPrefab(networkObject);
+
+            m_ServerNetworkManager.NetworkConfig.NetworkPrefabs.Add(new NetworkPrefab() { Prefab = gameObject });
+
+            foreach (var clientNetworkManager in m_ClientNetworkManagers)
+            {
+                clientNetworkManager.NetworkConfig.NetworkPrefabs.Add(new NetworkPrefab() { Prefab = gameObject });
+            }
+
+            // Start the host and clients
+            if (!MultiInstanceHelpers.Start(useHost, m_ServerNetworkManager, m_ClientNetworkManagers))
+            {
+                Debug.LogError("Failed to start instances");
+                Assert.Fail("Failed to start instances");
+            }
+
+            // Spawn some NetworkObjects
+            var spawnedNetworkObjects = new List<GameObject>();
+            for (int i = 0; i < 10; i++)
+            {
+                var instance = Object.Instantiate(gameObject);
+                var instanceNetworkObject = instance.GetComponent<NetworkObject>();
+                instanceNetworkObject.NetworkManagerOwner = m_ServerNetworkManager;
+                instanceNetworkObject.Spawn();
+                spawnedNetworkObjects.Add(instance);
+            }
+
+            // Add a bogus entry to the SpawnManager
+            m_ServerNetworkManager.SpawnManager.SpawnedObjectsList.Add(null);
+
+            // Verify moving all NetworkObjects into the DDOL when some might be invalid will not crash
+            m_ServerNetworkManager.SceneManager.MoveObjectsToDontDestroyOnLoad();
+
+            // Verify moving all NetworkObjects from DDOL back into the active scene will not crash even if some are invalid
+            m_ServerNetworkManager.SceneManager.MoveObjectsFromDontDestroyOnLoadToScene(SceneManager.GetActiveScene());
+
+            // Now remove the invalid object
+            m_ServerNetworkManager.SpawnManager.SpawnedObjectsList.Remove(null);
+
+            // As long as there are no exceptions this test passes
+        }
+    }
 }