feat: RPC Event Net stat reporting #954
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,138 @@ | ||
| using System; | ||
| using System.Collections; | ||
| using System.Collections.Generic; | ||
| using System.Linq; | ||
| using MLAPI.Metrics; | ||
| using NUnit.Framework; | ||
| using Unity.Multiplayer.NetworkProfiler; | ||
| using Unity.Multiplayer.NetworkProfiler.Models; | ||
| using UnityEngine; | ||
| using UnityEngine.TestTools; | ||
|
|
||
| namespace MLAPI.RuntimeTests.Metrics.RPC | ||
| { | ||
| public class NetworkMetricsRpcTests | ||
| { | ||
| NetworkManager m_Server; | ||
| NetworkManager m_Client; | ||
| NetworkMetrics m_ClientMetrics; | ||
| NetworkMetrics m_ServerMetrics; | ||
|
|
||
| [UnitySetUp] | ||
| public IEnumerator SetUp() | ||
| { | ||
| if (!MultiInstanceHelpers.Create(1, out m_Server, out NetworkManager[] clients)) | ||
| { | ||
| Assert.Fail("Failed to create instances"); | ||
| } | ||
|
|
||
| var playerPrefab = new GameObject("Player"); | ||
| NetworkObject networkObject = playerPrefab.AddComponent<NetworkObject>(); | ||
| playerPrefab.AddComponent<RpcTestComponent>(); | ||
|
|
||
| MultiInstanceHelpers.MakeNetworkedObjectTestPrefab(networkObject); | ||
|
|
||
| m_Server.NetworkConfig.PlayerPrefab = playerPrefab; | ||
| m_Client = clients.First(); | ||
|
|
||
| m_Client.NetworkConfig.PlayerPrefab = playerPrefab; | ||
|
|
||
| if (!MultiInstanceHelpers.Start(true, m_Server, clients)) | ||
| { | ||
| Assert.Fail("Failed to start instances"); | ||
| } | ||
|
|
||
| yield return MultiInstanceHelpers.Run(MultiInstanceHelpers.WaitForClientsConnected(clients)); | ||
| yield return MultiInstanceHelpers.Run(MultiInstanceHelpers.WaitForClientConnectedToServer(m_Server)); | ||
|
|
||
| m_ClientMetrics = m_Client.NetworkMetrics as NetworkMetrics; | ||
| m_ServerMetrics = m_Server.NetworkMetrics as NetworkMetrics; | ||
| } | ||
|
|
||
| [TearDown] | ||
| public void TearDown() | ||
| { | ||
| MultiInstanceHelpers.Destroy(); | ||
| } | ||
|
|
||
| [UnityTest] | ||
| public IEnumerator TrackServerRpcMetrics() | ||
| { | ||
| var waitForClientMetricsValues = new WaitForMetricValues<RpcEvent>(m_ClientMetrics.Dispatcher, MetricNames.RpcSent); | ||
| var waitForServerMetricsValues = new WaitForMetricValues<RpcEvent>(m_ServerMetrics.Dispatcher, MetricNames.RpcReceived); | ||
|
|
||
| var serverClientPlayerResult = new MultiInstanceHelpers.CoroutineResultWrapper<NetworkObject>(); | ||
| yield return MultiInstanceHelpers.Run(MultiInstanceHelpers.GetNetworkObjectByRepresentation((x => x.IsPlayerObject && x.OwnerClientId == m_Client.LocalClientId), m_Server, serverClientPlayerResult)); | ||
|
|
||
| var clientClientPlayerResult = new MultiInstanceHelpers.CoroutineResultWrapper<NetworkObject>(); | ||
| yield return MultiInstanceHelpers.Run(MultiInstanceHelpers.GetNetworkObjectByRepresentation((x => x.IsPlayerObject && x.OwnerClientId == m_Client.LocalClientId), m_Client, clientClientPlayerResult)); | ||
|
|
||
| bool hasReceivedServerRpc = false; | ||
| serverClientPlayerResult.Result.GetComponent<RpcTestComponent>().OnServerRpcAction += () => | ||
| { | ||
| hasReceivedServerRpc = true; | ||
| }; | ||
|
|
||
| clientClientPlayerResult.Result.GetComponent<RpcTestComponent>().MyServerRpc(); | ||
|
|
||
| yield return MultiInstanceHelpers.Run(MultiInstanceHelpers.WaitForCondition(() => hasReceivedServerRpc)); | ||
|
|
||
| // Client Check | ||
| yield return waitForClientMetricsValues.WaitForAFewFrames(); | ||
|
|
||
| var clientMetricSentValues = waitForClientMetricsValues.EnsureMetricValuesHaveBeenFound(); | ||
| Assert.AreEqual(1, clientMetricSentValues.Count); | ||
|
|
||
| var clientMetric = clientMetricSentValues.First(); | ||
| Assert.AreEqual(m_Server.LocalClientId, clientMetric.Connection.Id); | ||
| Assert.AreEqual("MyServerRpc", clientMetric.Name); | ||
|
Contributor
There was a problem hiding this comment. Nit, would recommend using |
||
|
|
||
| // Server Check | ||
| yield return waitForServerMetricsValues.WaitForAFewFrames(); | ||
|
|
||
| var serverMetricReceivedValues = waitForServerMetricsValues.EnsureMetricValuesHaveBeenFound(); | ||
| Assert.AreEqual(1, serverMetricReceivedValues.Count); | ||
|
|
||
| var serverMetric = serverMetricReceivedValues.First(); | ||
| Assert.AreEqual(m_Client.LocalClientId, serverMetric.Connection.Id); | ||
| Assert.AreEqual("MyServerRpc", serverMetric.Name); | ||
| } | ||
|
|
||
| [UnityTest] | ||
| public IEnumerator TrackClientRpcMetrics() | ||
| { | ||
| var waitForServerMetricsValues = new WaitForMetricValues<RpcEvent>(m_ServerMetrics.Dispatcher, MetricNames.RpcReceived); | ||
|
|
||
| var serverClientPlayerResult = new MultiInstanceHelpers.CoroutineResultWrapper<NetworkObject>(); | ||
| yield return MultiInstanceHelpers.Run(MultiInstanceHelpers.GetNetworkObjectByRepresentation((x => x.IsPlayerObject && x.OwnerClientId == m_Client.LocalClientId), m_Server, serverClientPlayerResult)); | ||
|
|
||
| var clientClientPlayerResult = new MultiInstanceHelpers.CoroutineResultWrapper<NetworkObject>(); | ||
| yield return MultiInstanceHelpers.Run(MultiInstanceHelpers.GetNetworkObjectByRepresentation((x => x.IsPlayerObject && x.OwnerClientId == m_Client.LocalClientId), m_Client, clientClientPlayerResult)); | ||
|
|
||
| bool hasReceivedClientRpcOnServer = false; | ||
| bool hasReceivedClientRpcRemotely = false; | ||
| serverClientPlayerResult.Result.GetComponent<RpcTestComponent>().OnClientRpcAction += () => | ||
| { | ||
| hasReceivedClientRpcOnServer = true; | ||
| }; | ||
| clientClientPlayerResult.Result.GetComponent<RpcTestComponent>().OnClientRpcAction += () => | ||
| { | ||
| Debug.Log("ClientRpc received on client object"); | ||
| hasReceivedClientRpcRemotely = true; | ||
| }; | ||
|
|
||
| serverClientPlayerResult.Result.GetComponent<RpcTestComponent>().MyClientRpc(); | ||
|
|
||
| yield return MultiInstanceHelpers.Run(MultiInstanceHelpers.WaitForCondition(() => hasReceivedClientRpcOnServer && hasReceivedClientRpcRemotely)); | ||
|
|
||
| yield return waitForServerMetricsValues.WaitForAFewFrames(); | ||
|
|
||
| var serverMetricReceivedValues = waitForServerMetricsValues.EnsureMetricValuesHaveBeenFound(); | ||
| Assert.AreEqual(1, serverMetricReceivedValues.Count); | ||
|
|
||
| var serverMetric = serverMetricReceivedValues.First(); | ||
| Assert.AreEqual(m_Server.LocalClientId, serverMetric.Connection.Id); | ||
| Assert.AreEqual("MyClientRpc", serverMetric.Name); | ||
| } | ||
| } | ||
| } | ||
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,23 @@ | ||
| using System; | ||
| using MLAPI.Messaging; | ||
|
|
||
| namespace MLAPI.RuntimeTests.Metrics.RPC | ||
| { | ||
| public class RpcTestComponent : NetworkBehaviour | ||
| { | ||
| public event Action OnServerRpcAction; | ||
| public event Action OnClientRpcAction; | ||
|
|
||
| [ServerRpc] | ||
| public void MyServerRpc() | ||
| { | ||
| OnServerRpcAction?.Invoke(); | ||
| } | ||
|
|
||
| [ClientRpc] | ||
| public void MyClientRpc() | ||
| { | ||
| OnClientRpcAction?.Invoke(); | ||
| } | ||
| } | ||
| } |
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same about logging here