Merge branch 'develop' into fix/console-tests-failing

Author: NoelStephensUnity

com.unity.netcode.gameobjects/CHANGELOG.md

@@ -22,6 +22,7 @@ Additional documentation and release notes are available at [Multiplayer Documen
 - Fixed error when serializing ConnectionApprovalMessage with scene management disabled when one or more objects is hidden via the CheckObjectVisibility delegate (#1509)
 - 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)
 
 ### Changed
 

com.unity.netcode.gameobjects/Runtime/Core/NetworkBehaviour.cs

@@ -304,10 +304,14 @@ public NetworkObject NetworkObject
                     m_NetworkObject = GetComponentInParent<NetworkObject>();
                 }
 
-                if (m_NetworkObject == null || NetworkManager.Singleton == null ||
-                    (NetworkManager.Singleton != null && !NetworkManager.Singleton.ShutdownInProgress))
+                // ShutdownInProgress check:
+                // This prevents an edge case scenario where the NetworkManager is shutting down but user code
+                // in Update and/or in FixedUpdate could still be checking NetworkBehaviour.NetworkObject directly (i.e. does it exist?)
+                // or NetworkBehaviour.IsSpawned (i.e. to early exit if not spawned) which, in turn, could generate several Warning messages
+                // per spawned NetworkObject.  Checking for ShutdownInProgress prevents these unnecessary LogWarning messages.
+                if (m_NetworkObject == null && (NetworkManager.Singleton == null || !NetworkManager.Singleton.ShutdownInProgress))
                 {
-                    if (NetworkLog.CurrentLogLevel < LogLevel.Normal)
+                    if (NetworkLog.CurrentLogLevel <= LogLevel.Normal)
                     {
                         NetworkLog.LogWarning($"Could not get {nameof(NetworkObject)} for the {nameof(NetworkBehaviour)}. Are you missing a {nameof(NetworkObject)} component?");
                     }

com.unity.netcode.gameobjects/Tests/Runtime/NetworkBehaviourGenericTests.cs

@@ -0,0 +1,60 @@
+using System.Collections;
+using NUnit.Framework;
+using UnityEngine;
+using UnityEngine.TestTools;
+
+namespace Unity.Netcode.RuntimeTests
+{
+    /// <summary>
+    /// This class is for testing general fixes or functionality of NetworkBehaviours
+    /// </summary>
+    public class NetworkBehaviourGenericTests : BaseMultiInstanceTest
+    {
+        protected override int NbClients => 0;
+        public override IEnumerator Setup()
+        {
+            // Make sure we don't automatically start
+            m_BypassStartAndWaitForClients = true;
+
+            // Create the Host and add the SimpleNetworkBehaviour component
+            yield return base.Setup();
+        }
+
+        public class SimpleNetworkBehaviour : NetworkBehaviour
+        {
+        }
+
+        /// <summary>
+        /// This test validates a fix to NetworkBehaviour.NetworkObject when
+        /// the NetworkManager.LogLevel is set to Developer
+        /// Note: This test does not require any clients, but should not impact this
+        /// particular test if new tests are added to this class that do require clients
+        /// </summary>
+        [Test]
+        public void ValidateNoSpam()
+        {
+            var objectToTest = new GameObject();
+            var simpleNetworkBehaviour = objectToTest.AddComponent<SimpleNetworkBehaviour>();
+
+            // Now just start the Host
+            Assert.True(MultiInstanceHelpers.Start(true, m_ServerNetworkManager, new NetworkManager[] { }), "Failed to start the host!");
+
+            // set the log level to developer
+            m_ServerNetworkManager.LogLevel = LogLevel.Developer;
+
+            // Verify the warning gets logged under normal conditions
+            var isNull = simpleNetworkBehaviour.NetworkObject == null;
+            LogAssert.Expect(LogType.Warning, $"[Netcode] Could not get {nameof(NetworkObject)} for the {nameof(NetworkBehaviour)}. Are you missing a {nameof(NetworkObject)} component?");
+
+            var networkObjectToTest = objectToTest.AddComponent<NetworkObject>();
+            networkObjectToTest.Spawn();
+
+            // Assure no log messages are logged when they should not be logged
+            isNull = simpleNetworkBehaviour.NetworkObject != null;
+            LogAssert.NoUnexpectedReceived();
+
+            networkObjectToTest.Despawn();
+            Object.Destroy(networkObjectToTest);
+        }
+    }
+}