test: snapshot unit tests (#1472)

* fix: issue #1151 - client RPCs invoked in OnNetworkSpawn being dropped

* standards.py --fix

* Removed debug log that accidentally got left in.

* Revert "fix: issue #1151 - client RPCs invoked in OnNetworkSpawn being dropped"

This reverts commit d7d7bd7.

# Conflicts:
#	com.unity.netcode.gameobjects/Runtime/Core/NetworkObject.cs
#	testproject/Assets/Tests/Runtime/MessageOrdering.cs
#	testproject/Assets/Tests/Runtime/Support/SpawnRpcDespawn.cs

* New approach to fixing the issue by deferring things that are received before the object is spawned.

* Address review feedback.

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

Co-authored-by: M. Fatih MAR <[email protected]>

* Fix bad merge.

* Another merge error

* wip

* wip

* wip, refactored SnapshotSystem to allow unit-testing, without SDK going snapshot-enabled

* bit further, adding NativeList to test assembly, testing that one spawn is received

* test: having the sent snapshot immediately applied locally. Currently causes exception

* refactor: made SnapshotDataMessage handle systemOwners of different types, NetworkManager or not

* improved coverage: spawns and despawns

* starting on a 'lost messages' test

* Fixed memory deallocation in mock snapshot sendmessage

* improved snapshot test coverage

* post-merge adjustment

* post-merge adjustment

* style: applying standards.py

* chore: update PR template to include checklist and info about backports (#1315)

* chore: update PR template to include checklist and info about backports

* Update pull_request_template.md

* test: add checking for ServerRPCParams (#1319)

* chore: adding dry-run promotion job (#1321)

* style: renaming SnapshotRTT to SnapshotRtt (#1252)

* revert unnecessary changes

Co-authored-by: Jaedyn Draper <[email protected]>
Co-authored-by: Jaedyn Draper <[email protected]>
Co-authored-by: Jeffrey Rainy <[email protected]>
Co-authored-by: Andrew Spiering <[email protected]>
Co-authored-by: Matt Walsh <[email protected]>

Author: 5 people

com.unity.netcode.gameobjects/Runtime/Configuration/NetworkConfig.cs

@@ -141,15 +141,15 @@ public class NetworkConfig
         /// <summary>
         /// Whether or not to enable Snapshot System for variable updates. Not supported in this version.
         /// </summary>
-        public bool UseSnapshotDelta { get; } = false;
+        public bool UseSnapshotDelta { get; internal set; } = false;
         /// <summary>
         /// Whether or not to enable Snapshot System for spawn and despawn commands. Not supported in this version.
         /// </summary>
-        public bool UseSnapshotSpawn { get; } = false;
+        public bool UseSnapshotSpawn { get; internal set; } = false;
         /// <summary>
         /// When Snapshot System spawn is enabled: max size of Snapshot Messages. Meant to fit MTU.
         /// </summary>
-        public int SnapshotMaxSpawnUsage { get; } = 1200;
+        public int SnapshotMaxSpawnUsage { get; } = 1000;
 
         public const int RttAverageSamples = 5; // number of RTT to keep an average of (plus one)
         public const int RttWindowSize = 64; // number of slots to use for RTT computations (max number of in-flight packets)

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

@@ -554,8 +554,6 @@ private void Initialize(bool server)
                 SnapshotSystem = null;
             }
 
-            SnapshotSystem = new SnapshotSystem(this);
-
             if (server)
             {
                 NetworkTimeSystem = NetworkTimeSystem.ServerTimeSystem();
@@ -568,6 +566,8 @@ private void Initialize(bool server)
             NetworkTickSystem = new NetworkTickSystem(NetworkConfig.TickRate, 0, 0);
             NetworkTickSystem.Tick += OnNetworkManagerTick;
 
+            SnapshotSystem = new SnapshotSystem(this, NetworkConfig, NetworkTickSystem);
+
             this.RegisterNetworkUpdate(NetworkUpdateStage.PreUpdate);
 
             // This is used to remove entries not needed or invalid

com.unity.netcode.gameobjects/Runtime/Core/SnapshotRTT.cs renamed to com.unity.netcode.gameobjects/Runtime/Core/SnapshotRtt.cs

@@ -104,7 +104,6 @@ public unsafe void Serialize(FastBufferWriter writer)
 
         public static unsafe void Receive(FastBufferReader reader, in NetworkContext context)
         {
-            var networkManager = (NetworkManager)context.SystemOwner;
             var message = new SnapshotDataMessage();
             if (!reader.TryBeginRead(
                 FastBufferWriter.GetWriteSize(message.CurrentTick) +
@@ -142,20 +141,32 @@ public static unsafe void Receive(FastBufferReader reader, in NetworkContext con
             using (message.Spawns)
             using (message.Despawns)
             {
-                message.Handle(context.SenderId, networkManager);
+                message.Handle(context.SenderId, context.SystemOwner);
             }
         }
 
-        public void Handle(ulong senderId, NetworkManager networkManager)
+        public void Handle(ulong senderId, object systemOwner)
         {
-            // todo: temporary hack around bug
-            if (!networkManager.IsServer)
+            if (systemOwner is NetworkManager)
             {
-                senderId = networkManager.ServerClientId;
-            }
+                var networkManager = (NetworkManager)systemOwner;
+
+                // todo: temporary hack around bug
+                if (!networkManager.IsServer)
+                {
+                    senderId = networkManager.ServerClientId;
+                }
 
-            var snapshotSystem = networkManager.SnapshotSystem;
-            snapshotSystem.HandleSnapshot(senderId, this);
+                var snapshotSystem = networkManager.SnapshotSystem;
+                snapshotSystem.HandleSnapshot(senderId, this);
+            }
+            else
+            {
+                var ownerData = (Tuple<SnapshotSystem, ulong>)systemOwner;
+                var snapshotSystem = ownerData.Item1;
+                snapshotSystem.HandleSnapshot(ownerData.Item2, this);
+                return;
+            }
         }
     }
 }

com.unity.netcode.gameobjects/Runtime/Core/SnapshotRTT.cs.meta renamed to com.unity.netcode.gameobjects/Runtime/Core/SnapshotRtt.cs.meta

@@ -9,7 +9,7 @@ public class SnapshotRttTests
         [Test]
         public void TestBasicRtt()
         {
-            var snapshot = new SnapshotSystem(default);
+            var snapshot = new SnapshotSystem(null, new NetworkConfig(), null);
             var client1 = snapshot.GetConnectionRtt(0);
 
             client1.NotifySend(0, 0.0);
@@ -40,7 +40,7 @@ public void TestBasicRtt()
         [Test]
         public void TestEdgeCasesRtt()
         {
-            var snapshot = new SnapshotSystem(NetworkManager.Singleton);
+            var snapshot = new SnapshotSystem(null, new NetworkConfig(), null);
             var client1 = snapshot.GetConnectionRtt(0);
             var iterationCount = NetworkConfig.RttWindowSize * 3;
             var extraCount = NetworkConfig.RttWindowSize * 2;