fix and update

Fixing some issues with getting the session owner prior to actually starting and connecting to a service.
Added a better log message that includes the actual name of the NetworkManager when a prefab cannot be found.

Author: NoelStephensUnity

com.unity.netcode.gameobjects/Runtime/Spawning/NetworkSpawnManager.cs

@@ -831,7 +831,7 @@ internal NetworkObject GetNetworkObjectToSpawn(uint globalObjectIdHash, ulong ow
                 {
                     if (NetworkLog.CurrentLogLevel <= LogLevel.Error)
                     {
-                        NetworkLog.LogError($"Failed to create object locally. [{nameof(globalObjectIdHash)}={globalObjectIdHash}]. {nameof(NetworkPrefab)} could not be found. Is the prefab registered with {nameof(NetworkManager)}?");
+                        NetworkLog.LogError($"Failed to create object locally. [{nameof(globalObjectIdHash)}={globalObjectIdHash}]. {nameof(NetworkPrefab)} could not be found. Is the prefab registered with {NetworkManager.name}?");
                     }
                 }
                 else

com.unity.netcode.gameobjects/TestHelpers/Runtime/NetcodeIntegrationTest.cs

@@ -162,10 +162,23 @@ protected NetworkManager GetAuthorityNetworkManager()
         {
             if (m_UseCmbService)
             {
+                // TODO: Because we start the NetworkManagers back-to-back, the service can make a NetworkManager
+                // (other than the very first one) the session owner. This could lead to test instabilities and
+                // we need to add additional code during the start process that will start the very 1st instance
+                // and wait for it to be approved and assigned the session owner before we assume anything.
+                // Otherwise, any pick from the m_NetworkManagers could result in that specific instance not being
+                // the first session owner.
+                // If we haven't even started any NetworkManager, then just return the first
+                // instance until we resolve the above issue.
+                if (!NetcodeIntegrationTestHelpers.IsStarted)
+                {
+                    return m_NetworkManagers[0];
+                }
+
                 foreach (var client in m_NetworkManagers)
                 {
-                    // If client isn't approved we are still in setup and want to return the first client
-                    // otherwise look for the session owner
+                    // See above notes.
+                    // TODO: Once the above is resolved, just check for client.LocalClient.IsSessionOwner
                     if (!client.LocalClient.IsApproved || client.LocalClient.IsSessionOwner)
                     {
                         return client;
@@ -203,7 +216,7 @@ protected NetworkManager GetNonAuthorityNetworkManager()
         /// Indicates whether the currently running tests are targeting the hosted CMB Service
         /// </summary>
         /// <remarks>Can only be true if <see cref="UseCMBService"/> returns true.</remarks>
-        protected bool m_UseCmbService;
+        protected bool m_UseCmbService { get; private set; }
 
         /// <summary>
         /// Indicates whether a hosted CMB service is available.
@@ -419,6 +432,9 @@ protected virtual void OnInlineSetup()
         [UnitySetUp]
         public IEnumerator SetUp()
         {
+            // In addition to setting the number of clients in the OneTimeSetup, we need to re-apply the number of clients for each unique test
+            // in the event that a previous test stopped a client.
+            m_NumberOfClients = NumberOfClients;
             VerboseDebugLog.Clear();
             VerboseDebug($"Entering {nameof(SetUp)}");
             NetcodeLogAssert = new NetcodeLogAssert();
@@ -521,7 +537,7 @@ protected void CreateServerAndClients()
         {
             // If we are connecting to a CMB server and we have a zero client count,
             // then we must make m_NumberOfClients = 1 for the session owner.
-            if (UseCMBService() && NumberOfClients == 0 && m_NumberOfClients == 0)
+            if (m_UseCmbService && NumberOfClients == 0 && m_NumberOfClients == 0)
             {
                 m_NumberOfClients = 1;
             }
@@ -816,7 +832,7 @@ protected void CreateServerAndClients(int numberOfClients)
             // In the event this is invoked within a derived integration test and
             // the number of clients is 0, then we need to have at least 1 client
             // to be the session owner.
-            if (UseCMBService() && numberOfClients == 0)
+            if (m_UseCmbService && numberOfClients == 0)
             {
                 numberOfClients = 1;
                 // If m_NumberOfCleints == 0, then we should increment it.
@@ -995,7 +1011,6 @@ protected virtual bool ShouldCheckForSpawnedPlayers()
             return true;
         }
 
-
         /// <summary>
         /// This starts the server and clients as long as <see cref="CanStartServerAndClients"/>
         /// returns true.
@@ -1009,16 +1024,16 @@ protected IEnumerator StartServerAndClients()
                 // Start the instances and pass in our SceneManagerInitialization action that is invoked immediately after host-server
                 // is started and after each client is started.
 
-                // When using the CMBService, we don't have a server, so get the appropriate authority network manager
-                var authorityManager = GetAuthorityNetworkManager();
-
                 VerboseDebug($"Starting with useCmbService: {m_UseCmbService}");
                 if (!NetcodeIntegrationTestHelpers.Start(m_UseHost, !m_UseCmbService, m_ServerNetworkManager, m_ClientNetworkManagers))
                 {
                     Debug.LogError("Failed to start instances");
                     Assert.Fail("Failed to start instances");
                 }
 
+                // When using the CMBService, we don't have a server, so get the appropriate authority network manager
+                var authorityManager = GetAuthorityNetworkManager();
+
                 // When scene management is enabled, we need to re-apply the scenes populated list since we have overriden the ISceneManagerHandler
                 // imeplementation at this point. This assures any pre-loaded scenes will be automatically assigned to the server and force clients
                 // to load their own scenes.
@@ -1382,9 +1397,11 @@ private void DestroyNetworkManagers()
             var networkManagers = Object.FindObjectsByType<NetworkManager>(FindObjectsSortMode.None);
             foreach (var networkManager in networkManagers)
             {
-
                 Object.DestroyImmediate(networkManager.gameObject);
             }
+            m_NetworkManagers = null;
+            m_ClientNetworkManagers = null;
+            m_ServerNetworkManager = null;
         }
 
         /// <summary>
@@ -1949,7 +1966,6 @@ private void InitializeTestConfiguration(NetworkTopologyTypes networkTopologyTyp
             if (UseCMBService())
             {
                 m_UseCmbService = m_DistributedAuthority && hostOrServer == HostOrServer.DAHost;
-
             }
         }
 

com.unity.netcode.gameobjects/TestHelpers/Runtime/NetcodeIntegrationTestHelpers.cs

@@ -21,6 +21,7 @@ public static class NetcodeIntegrationTestHelpers
         private static List<NetworkManager> s_NetworkManagerInstances = new List<NetworkManager>();
         private static Dictionary<NetworkManager, MultiInstanceHooks> s_Hooks = new Dictionary<NetworkManager, MultiInstanceHooks>();
         private static bool s_IsStarted;
+        internal static bool IsStarted => s_IsStarted;
         private static int s_ClientCount;
         private static int s_OriginalTargetFrameRate = -1;
 
@@ -643,11 +644,6 @@ internal static GameObject CreateNetworkObject(string baseName, NetworkManager o
         /// <returns>The prefab's root <see cref="GameObject"/></returns>
         public static GameObject CreateNetworkObjectPrefab(string baseName, NetworkManager authorityNetworkManager, params NetworkManager[] clients)
         {
-            void AddNetworkPrefab(NetworkConfig config, NetworkPrefab prefab)
-            {
-                config.Prefabs.Add(prefab);
-            }
-
             var prefabCreateAssertError = $"You can only invoke this method before starting the network manager(s)!";
             Assert.IsNotNull(authorityNetworkManager, prefabCreateAssertError);
             Assert.IsFalse(authorityNetworkManager.IsListening, prefabCreateAssertError);
@@ -657,14 +653,14 @@ void AddNetworkPrefab(NetworkConfig config, NetworkPrefab prefab)
 
             // We could refactor this test framework to share a NetworkPrefabList instance, but at this point it's
             // probably more trouble than it's worth to verify these lists stay in sync across all tests...
-            AddNetworkPrefab(authorityNetworkManager.NetworkConfig, networkPrefab);
+            authorityNetworkManager.NetworkConfig.Prefabs.Add(networkPrefab);
             foreach (var clientNetworkManager in clients)
             {
                 if (clientNetworkManager == authorityNetworkManager)
                 {
                     continue;
                 }
-                AddNetworkPrefab(clientNetworkManager.NetworkConfig, networkPrefab);
+                clientNetworkManager.NetworkConfig.Prefabs.Add(new NetworkPrefab() { Prefab = gameObject });
             }
             return gameObject;
         }