update & test

This resolves an issue discovered after peer review where  using just `HasAuthority` as part of the check within `NetworkList.OnSpawned` while using a distributed authority topology and spawning with ownership (i.e. Client-A spawns with ownership where Client-B is the owner) would result in any changes made on the authority side during spawn would not be synchronized.

The solution was to add `NetworkObject.IsSpawnAuthority` (internal) that is only set on the spawn authority side (i.e. the side that generates the `CreateObjectMessage`).

Author: NoelStephensUnity

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

@@ -76,6 +76,16 @@ public uint PrefabIdHash
         /// </remarks>
         public List<NetworkTransform> NetworkTransforms { get; private set; }
 
+        /// <summary>
+        /// Set to true if this instance is the original/first instance created and spawned which
+        /// means the <see cref="CreateObjectMessage"/> was generated from this instance and sent
+        /// to all other clients.
+        /// 
+        /// Client-Server: This will be true for all instances on the server or host.
+        /// Distributed Authority: This will be true on the client that created the first instance
+        /// and spawned it (even if spawning with ownership being assigned to a different client).
+        /// </summary>
+        internal bool IsSpawnAuthority;
 
 #if COM_UNITY_MODULES_PHYSICS || COM_UNITY_MODULES_PHYSICS2D
         /// <summary>
@@ -2008,6 +2018,7 @@ internal void ResetOnDespawn()
         {
             // Always clear out the observers list when despawned
             Observers.Clear();
+            IsSpawnAuthority = false;
             IsSpawned = false;
             DeferredDespawnTick = 0;
             m_LatestParent = null;

com.unity.netcode.gameobjects/Runtime/NetworkVariable/Collections/NetworkList.cs

@@ -71,7 +71,7 @@ internal override void OnSpawned()
             // the dirty related properties and last sent time to prevent duplicate entries from
             // being sent (i.e. CreateObjectMessage will contain the changes so we don't need to
             // send a proceeding NetworkVariableDeltaMessage).
-            if (IsDirty() && CanSend() && m_NetworkBehaviour.HasAuthority)
+            if (IsDirty() && CanSend() && m_NetworkObject.IsSpawnAuthority)
             {
                 UpdateLastSentTime();
                 ResetDirty();

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

@@ -1054,6 +1054,9 @@ internal void AuthorityLocalSpawn([NotNull] NetworkObject networkObject, ulong n
                     Debug.LogError("Spawning NetworkObjects with nested NetworkObjects is only supported for scene objects. Child NetworkObjects will not be spawned over the network!");
                 }
             }
+
+            networkObject.IsSpawnAuthority = true;
+
             // Invoke NetworkBehaviour.OnPreSpawn methods
             networkObject.NetworkManagerOwner = NetworkManager;
             networkObject.InvokeBehaviourNetworkPreSpawn();

com.unity.netcode.gameobjects/Tests/Runtime/NetworkVariable/NetworkListTests.cs

@@ -293,9 +293,10 @@ private int[] Shuffle(List<int> list)
         }
 
         private List<NetworkObject> m_SpawnedObjects = new List<NetworkObject>();
-        internal const int SpawnCount = 10;
+        internal const int ValueCount = 10;
         internal bool IsOwnerWriteTest;
         internal NetworkManager LateJoinedClient;
+        internal static List<int> OwnerWriteExpectedValues = new List<int>();
 
         protected override void OnNewClientCreated(NetworkManager networkManager)
         {
@@ -314,13 +315,13 @@ protected override void OnNewClientCreated(NetworkManager networkManager)
         public IEnumerator OwnerWriteTests()
         {
             IsOwnerWriteTest = true;
-            var authorityBetworkManager = GetAuthorityNetworkManager();
+            var authorityNetworkManager = GetAuthorityNetworkManager();
             m_SpawnedObjects.Clear();
-            m_ExpectedValues.Clear();
+            OwnerWriteExpectedValues.Clear();
             // Set our initial expected values as 0 - 9
-            for (int i = 0; i < SpawnCount; i++)
+            for (int i = 0; i < ValueCount; i++)
             {
-                m_ExpectedValues.Add(i);
+                OwnerWriteExpectedValues.Add(i);
             }
 
             // Each spawned instance will be owned by each NetworkManager instance in order
@@ -354,16 +355,40 @@ public IEnumerator OwnerWriteTests()
 
             // Now have all of the clients update their list values to randomly assigned values
             // in order to verify changes to owner write NetworkLists are synchronized properly.
-            m_ExpectedValues.Clear();
-            for (int i = 0; i < SpawnCount; i++)
+            OwnerWriteExpectedValues.Clear();
+            for (int i = 0; i < ValueCount; i++)
             {
-                m_ExpectedValues.Add(Random.Range(10, 100));
+                OwnerWriteExpectedValues.Add(Random.Range(10, 100));
             }
             UpdateOwnerWriteValues();
 
             // Verify all spawned object instances have the expected owner write NetworkList values
             yield return WaitForConditionOrTimeOut(OnVerifyOwnerWriteData);
             AssertOnTimeout("Detected invalid count or value on one of the spawned instances!");
+
+            // Verifies that spawning with ownership in distributed authority mode work properly.
+            // Where:
+            // Client-A spawns with ownership assigned to Client-B
+            // Client-B applies values at spawn.
+            // All clients then should be updated with those new values applied.
+            if (m_DistributedAuthority)
+            {
+                var prefabNetworkObject = m_ListObjectPrefab.GetComponent<NetworkObject>();
+                foreach (var networkManager in m_NetworkManagers)
+                {
+                    var instance = Object.Instantiate(m_ListObjectPrefab).GetComponent<NetworkObject>();
+                    SpawnInstanceWithOwnership(instance, authorityNetworkManager, networkManager.LocalClientId);
+                    m_SpawnedObjects.Add(instance);
+                }
+
+                // Verify all NetworkManager instances spawned the objects
+                yield return WaitForSpawnedOnAllOrTimeOut(m_SpawnedObjects);
+                AssertOnTimeout("Not all instances were spawned on all clients!");
+
+                // Verify all spawned object instances have the expected owner write NetworkList values
+                yield return WaitForConditionOrTimeOut(OnVerifyOwnerWriteData);
+                AssertOnTimeout("Detected invalid count or value on one of the spawned instances!");
+            }
         }
 
         private void UpdateOwnerWriteValues()
@@ -373,9 +398,9 @@ private void UpdateOwnerWriteValues()
                 var owningNetworkManager = m_NetworkManagers.Where((c) => c.LocalClientId == spawnedObject.OwnerClientId).First();
                 var networkObjectId = spawnedObject.NetworkObjectId;
                 var listComponent = owningNetworkManager.SpawnManager.SpawnedObjects[networkObjectId].GetComponent<NetworkListTest>();
-                for (int i = 0; i < SpawnCount; i++)
+                for (int i = 0; i < ValueCount; i++)
                 {
-                    listComponent.OwnerWriteList[i] = m_ExpectedValues[i];
+                    listComponent.OwnerWriteList[i] = OwnerWriteExpectedValues[i];
                 }
             }
         }
@@ -400,16 +425,16 @@ private bool OnVerifyOwnerWriteData(StringBuilder errorLog)
                         return false;
                     }
 
-                    if (listComponent.OwnerWriteList.Count != SpawnCount)
+                    if (listComponent.OwnerWriteList.Count != ValueCount)
                     {
-                        errorLog.Append($"[Client-{networkManager.LocalClientId}] List component has the incorrect number of items. Expected: {SpawnCount}, Have: {listComponent.TheList.Count}");
+                        errorLog.Append($"[Client-{networkManager.LocalClientId}] List component has the incorrect number of items. Expected: {ValueCount}, Have: {listComponent.TheList.Count}");
                         return false;
                     }
 
-                    for (int i = 0; i < SpawnCount; i++)
+                    for (int i = 0; i < ValueCount; i++)
                     {
                         var actual = listComponent.OwnerWriteList[i];
-                        var expected = m_ExpectedValues[i];
+                        var expected = OwnerWriteExpectedValues[i];
                         if (expected != actual)
                         {
                             errorLog.Append($"[Client-{networkManager.LocalClientId}] Incorrect value at index {i}, expected: {expected}, actual: {actual}");
@@ -450,9 +475,9 @@ public override void OnNetworkSpawn()
         {
             if (IsOwner)
             {
-                for (int i = 0; i < NetworkListTests.SpawnCount; i++)
+                for (int i = 0; i < NetworkListTests.ValueCount; i++)
                 {
-                    OwnerWriteList.Add(i);
+                    OwnerWriteList.Add(NetworkListTests.OwnerWriteExpectedValues[i]);
                 }
             }
             base.OnNetworkSpawn();
@@ -474,8 +499,6 @@ internal class NetworkListTestPredicate : ConditionalPredicateBase
 
         private readonly NetworkListTest m_NonAuthorityInstance;
 
-        private string m_TestStageFailedMessage;
-
         /// <summary>
         /// Determines if the condition has been reached for the current NetworkListTestState
         /// </summary>