Repository navigation
feat: hybrid and NGO spawn counts in editor analytics #4205
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
NoelStephensUnity
wants to merge
5
commits into
develop-3.x.x
Choose a base branch
from
feat/hybrid-spawn-analytics
base: develop-3.x.x
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+135
−0
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
d1bc02c
feat: count NGO and hybrid spawns per session in editor analytics
NoelStephensUnity b461ed1
feat: report whether the session was hybrid in editor analytics
NoelStephensUnity 3f145d9
Merge branch 'develop-3.x.x' into feat/hybrid-spawn-analytics
NoelStephensUnity 54c9386
fix: guard the unified cases in SpawnCountAnalyticsTests
NoelStephensUnity 2f0ade5
Merge remote-tracking branch 'origin/feat/hybrid-spawn-analytics' int…
NoelStephensUnity File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
90 changes: 90 additions & 0 deletions
90
com.unity.netcode.gameobjects/Tests/Runtime/NetworkObject/SpawnCountAnalyticsTests.cs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| #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)] | ||
| #if UNIFIED_NETCODE | ||
| [TestFixture(HostOrServer.UnifiedHost)] | ||
| #endif | ||
| 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) | ||
| { | ||
| } | ||
|
|
||
| #if UNIFIED_NETCODE | ||
| protected override bool UseUnifiedTests() | ||
| { | ||
| return true; | ||
| } | ||
| #endif | ||
|
|
||
| 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 = 0; | ||
| #if UNIFIED_NETCODE | ||
| if (m_UseUnifiedTests) | ||
| { | ||
| expectedHybridSpawns = k_DefaultInstances; | ||
| } | ||
| #endif | ||
| 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 | ||
11 changes: 11 additions & 0 deletions
11
com.unity.netcode.gameobjects/Tests/Runtime/NetworkObject/SpawnCountAnalyticsTests.cs.meta
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.