feat: count NGO and hybrid spawns per session in editor analytics

NetworkSpawnManager counts local spawns (editor only) and the hybrid ones
among them. NetcodeAnalytics reads both when the session stops and adds
NgoSpawnCount and HybridSpawnCount to the NGO_NetworkManager event.

Author: NoelStephensUnity

com.unity.netcode.gameobjects/Editor/Analytics/NetcodeAnalytics.cs

@@ -18,6 +18,8 @@ internal struct NetworkSessionInfo
         public bool UsedCMBService;
         public string Transport;
         public NetworkConfig NetworkConfig;
+        public int NgoSpawnCount;
+        public int HybridSpawnCount;
     }
 
     /// <summary>
@@ -124,6 +126,12 @@ internal override void SessionStopped(NetworkManager networkManager)
                 return;
             }
             recentSession.UsedCMBService = networkManager.CMBServiceConnection;
+            var spawnManager = networkManager.SpawnManager;
+            if (spawnManager != null)
+            {
+                recentSession.HybridSpawnCount = spawnManager.HybridSpawnCount;
+                recentSession.NgoSpawnCount = spawnManager.SpawnCount - spawnManager.HybridSpawnCount;
+            }
             recentSession.SessionStopped = true;
             RecentSessions[lastIndex] = recentSession;
         }
@@ -220,6 +228,8 @@ private NetworkManagerAnalytics GetNetworkManagerAnalytics(NetworkSessionInfo ne
                 NetworkTransport = networkSession.Transport,
                 EnableSceneManagement = networkSession.NetworkConfig.EnableSceneManagement,
                 TickRate = (int)networkSession.NetworkConfig.TickRate,
+                NgoSpawnCount = networkSession.NgoSpawnCount,
+                HybridSpawnCount = networkSession.HybridSpawnCount,
             };
             return networkManagerAnalytics;
         }

com.unity.netcode.gameobjects/Editor/Analytics/NetworkManagerAnalytics.cs

@@ -17,6 +17,8 @@ internal struct NetworkManagerAnalytics : IAnalytic.IData, IEquatable<NetworkMan
         public string NetworkTransport;
         public bool EnableSceneManagement;
         public int TickRate;
+        public int NgoSpawnCount;
+        public int HybridSpawnCount;
         public override string ToString()
         {
             var message = new StringBuilder();
@@ -28,6 +30,8 @@ public override string ToString()
             message.AppendLine($"{nameof(NetworkTransport)}: {NetworkTransport}");
             message.AppendLine($"{nameof(EnableSceneManagement)}: {EnableSceneManagement}");
             message.AppendLine($"{nameof(TickRate)}: {TickRate}");
+            message.AppendLine($"{nameof(NgoSpawnCount)}: {NgoSpawnCount}");
+            message.AppendLine($"{nameof(HybridSpawnCount)}: {HybridSpawnCount}");
             return message.ToString();
         }
 
@@ -40,6 +44,7 @@ public bool Equals(NetworkManagerAnalytics other)
             return IsDistributedAuthority == other.IsDistributedAuthority && WasServer == other.WasServer && WasClient == other.WasClient
                 && UsedCMBService == other.UsedCMBService && IsUsingMultiplayerSDK == other.IsUsingMultiplayerSDK
                 && EnableSceneManagement == other.EnableSceneManagement && TickRate == other.TickRate
+                && NgoSpawnCount == other.NgoSpawnCount && HybridSpawnCount == other.HybridSpawnCount
                 && NetworkTransport.Equals(other.NetworkTransport);
         }
     }

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

@@ -34,6 +34,12 @@ public class NetworkSpawnManager
         /// </summary>
         public readonly HashSet<NetworkObject> SpawnedObjectsList = new HashSet<NetworkObject>();
 
+#if UNITY_EDITOR
+        // Spawns this peer made or received during the session, reported by the editor analytics.
+        internal int SpawnCount;
+        internal int HybridSpawnCount;
+#endif
+
         /// <summary>
         /// Use to get all NetworkObjects owned by a client
         /// Ownership to Objects Table Format:
@@ -1313,11 +1319,17 @@ internal bool SpawnNetworkObjectLocallyCommon(NetworkObject networkObject, ulong
             if (networkObject.HasGhost)
             {
                 networkObject.NetworkObjectBridge.UpdateGhostOwner(NetworkManager, ownerClientId);
+#if UNITY_EDITOR
+                HybridSpawnCount++;
+#endif
             }
 #endif
 
             SpawnedObjects.Add(networkObject.NetworkObjectId, networkObject);
             SpawnedObjectsList.Add(networkObject);
+#if UNITY_EDITOR
+            SpawnCount++;
+#endif
             networkObject.ApplyNetworkParenting();
 
             NetworkObject.CheckOrphanChildren();

com.unity.netcode.gameobjects/Tests/Runtime/NetworkObject/SpawnCountAnalyticsTests.cs

@@ -0,0 +1,80 @@
+#if UNITY_EDITOR
+using System.Collections;
+using NUnit.Framework;
+using Unity.Netcode.TestHelpers.Runtime;
+using UnityEngine;
+using UnityEngine.TestTools;
+
+namespace Unity.Netcode.RuntimeTests
+{
+    /// <summary>
+    /// Validates the spawn counts the editor analytics reads from <see cref="NetworkSpawnManager"/>:<br />
+    /// - Every peer counts each instance it spawns locally, whether it is the authority or received the spawn.<br />
+    /// - Hybrid instances are also counted on their own.<br />
+    /// </summary>
+    [TestFixture(HostOrServer.Host)]
+    [TestFixture(HostOrServer.UnifiedHost)]
+    internal class SpawnCountAnalyticsTests : NetcodeIntegrationTest
+    {
+        private const int k_DefaultInstances = 3;
+        private const int k_NgoInstances = 2;
+
+        protected override int NumberOfClients => 2;
+
+        // Hybrid during a unified test pass.
+        private GameObject m_DefaultPrefab;
+        private GameObject m_NgoPrefab;
+
+        public SpawnCountAnalyticsTests(HostOrServer hostOrServer) : base(hostOrServer)
+        {
+        }
+
+        protected override bool UseUnifiedTests()
+        {
+            return true;
+        }
+
+        protected override void OnServerAndClientsCreated()
+        {
+            m_DefaultPrefab = CreateNetworkObjectPrefab("SpawnCountDefault");
+#if UNIFIED_NETCODE
+            m_NgoPrefab = CreateNetworkObjectPrefab("SpawnCountNgo", false);
+#else
+            m_NgoPrefab = CreateNetworkObjectPrefab("SpawnCountNgo");
+#endif
+            base.OnServerAndClientsCreated();
+        }
+
+        [UnityTest]
+        public IEnumerator SpawnsAreCountedOnEveryPeer()
+        {
+            // Player objects are already spawned, so only the increase is checked.
+            var spawnCounts = new int[m_NetworkManagers.Length];
+            var hybridSpawnCounts = new int[m_NetworkManagers.Length];
+            for (int i = 0; i < m_NetworkManagers.Length; i++)
+            {
+                spawnCounts[i] = m_NetworkManagers[i].SpawnManager.SpawnCount;
+                hybridSpawnCounts[i] = m_NetworkManagers[i].SpawnManager.HybridSpawnCount;
+            }
+
+            var authority = GetAuthorityNetworkManager();
+            var instances = SpawnObjects(m_DefaultPrefab, authority, k_DefaultInstances);
+            instances.AddRange(SpawnObjects(m_NgoPrefab, authority, k_NgoInstances));
+            foreach (var instance in instances)
+            {
+                yield return WaitForSpawnedOnAllOrTimeOut(instance.GetComponent<NetworkObject>());
+                AssertOnTimeout($"Failed to spawn {instance.name} on all clients!");
+            }
+
+            var expectedHybridSpawns = m_UseUnifiedTests ? k_DefaultInstances : 0;
+            for (int i = 0; i < m_NetworkManagers.Length; i++)
+            {
+                var spawnManager = m_NetworkManagers[i].SpawnManager;
+                var clientId = m_NetworkManagers[i].LocalClientId;
+                Assert.AreEqual(k_DefaultInstances + k_NgoInstances, spawnManager.SpawnCount - spawnCounts[i], $"Client-{clientId} counted the wrong number of spawns!");
+                Assert.AreEqual(expectedHybridSpawns, spawnManager.HybridSpawnCount - hybridSpawnCounts[i], $"Client-{clientId} counted the wrong number of hybrid spawns!");
+            }
+        }
+    }
+}
+#endif