|
| 1 | +using System; |
| 2 | +using System.Collections; |
| 3 | +using System.Collections.Generic; |
| 4 | +using System.IO; |
| 5 | +using System.Linq; |
| 6 | +using MLAPI.Metrics; |
| 7 | +using NUnit.Framework; |
| 8 | +using Unity.Multiplayer.NetStats.Dispatch; |
| 9 | +using Unity.Multiplayer.NetStats.Metrics; |
| 10 | +using Unity.Multiplayer.NetworkProfiler; |
| 11 | +using Unity.Multiplayer.NetworkProfiler.Models; |
| 12 | +using UnityEngine; |
| 13 | +using UnityEngine.TestTools; |
| 14 | + |
| 15 | +namespace MLAPI.RuntimeTests.Metrics |
| 16 | +{ |
| 17 | +#if true |
| 18 | + public class NetworkMetricsTests |
| 19 | + { |
| 20 | + [UnityTest] |
| 21 | + public IEnumerator NetworkMetrics_WhenNamedMessageSent_TracksNamedMessageSentMetric() |
| 22 | + { |
| 23 | + NetworkManagerHelper.StartNetworkManager(out var networkManager); |
| 24 | + var networkMetrics = networkManager.NetworkMetrics as NetworkMetrics; |
| 25 | + var messageName = Guid.NewGuid().ToString(); |
| 26 | + |
| 27 | + var clientId = 100UL; |
| 28 | + networkMetrics.Dispatcher.RegisterObserver(new TestObserver(collection => |
| 29 | + { |
| 30 | + var namedMessageSentMetric = AssertSingleMetricEventOfType<NamedMessageEvent>(collection, MetricNames.NamedMessageSent); |
| 31 | + Assert.AreEqual(1, namedMessageSentMetric.Values.Count); |
| 32 | + |
| 33 | + var namedMessageSent = namedMessageSentMetric.Values.First(); |
| 34 | + Assert.AreEqual(messageName, namedMessageSent.Name); |
| 35 | + Assert.AreEqual(clientId, namedMessageSent.Connection.Id); |
| 36 | + })); |
| 37 | + |
| 38 | + networkManager.CustomMessagingManager.SendNamedMessage(messageName, clientId, Stream.Null); |
| 39 | + |
| 40 | + yield return WaitForMetricsDispatch(); |
| 41 | + |
| 42 | + NetworkManagerHelper.ShutdownNetworkManager(); |
| 43 | + } |
| 44 | + |
| 45 | + [UnityTest] |
| 46 | + public IEnumerator NetworkMetrics_WhenNamedMessageSentToMultipleClients_TracksNamedMessageSentMetric() |
| 47 | + { |
| 48 | + NetworkManagerHelper.StartNetworkManager(out var networkManager); |
| 49 | + var networkMetrics = networkManager.NetworkMetrics as NetworkMetrics; |
| 50 | + var messageName = Guid.NewGuid().ToString(); |
| 51 | + |
| 52 | + networkMetrics.Dispatcher.RegisterObserver(new TestObserver(collection => |
| 53 | + { |
| 54 | + var namedMessageSentMetric = AssertSingleMetricEventOfType<NamedMessageEvent>(collection, MetricNames.NamedMessageSent); |
| 55 | + Assert.AreEqual(3, namedMessageSentMetric.Values.Count); |
| 56 | + |
| 57 | + var clientIds = namedMessageSentMetric.Values.Select(x => x.Connection.Id).ToList(); |
| 58 | + Assert.Contains(100UL, clientIds); |
| 59 | + Assert.Contains(200UL, clientIds); |
| 60 | + Assert.Contains(300UL, clientIds); |
| 61 | + })); |
| 62 | + |
| 63 | + networkManager.CustomMessagingManager.SendNamedMessage(messageName, new List<ulong> { 100, 200, 300 }, Stream.Null); |
| 64 | + |
| 65 | + yield return WaitForMetricsDispatch(); |
| 66 | + |
| 67 | + NetworkManagerHelper.ShutdownNetworkManager(); |
| 68 | + } |
| 69 | + |
| 70 | + [UnityTest] |
| 71 | + public IEnumerator NetworkMetrics_WhenNamedMessageReceived_TracksNamedMessageReceivedMetric() |
| 72 | + { |
| 73 | + var createServerAndSingleClient = new CreateServerAndSingleClient(); |
| 74 | + yield return createServerAndSingleClient.Run(); |
| 75 | + var server = createServerAndSingleClient.Server; |
| 76 | + var client = createServerAndSingleClient.Client; |
| 77 | + var clientMetrics = client.NetworkMetrics as NetworkMetrics; |
| 78 | + |
| 79 | + var messageName = Guid.NewGuid().ToString(); |
| 80 | + LogAssert.Expect(LogType.Log, $"Received from {server.LocalClientId}"); |
| 81 | + client.CustomMessagingManager.RegisterNamedMessageHandler(messageName, (sender, payload) => |
| 82 | + { |
| 83 | + Debug.Log($"Received from {sender}"); |
| 84 | + }); |
| 85 | + |
| 86 | + var found = false; |
| 87 | + clientMetrics.Dispatcher.RegisterObserver(new TestObserver(collection => |
| 88 | + { |
| 89 | + var namedMessageSentMetric = collection.Metrics.SingleOrDefault(x => x.Name == MetricNames.NamedMessageReceived); |
| 90 | + Assert.NotNull(namedMessageSentMetric); |
| 91 | + |
| 92 | + var typedMetric = namedMessageSentMetric as IEventMetric<NamedMessageEvent>; |
| 93 | + Assert.NotNull(typedMetric); |
| 94 | + if (typedMetric.Values.Any()) // We always get the metric, but when it has values, something has been tracked |
| 95 | + { |
| 96 | + Assert.AreEqual(1, typedMetric.Values.Count); |
| 97 | + |
| 98 | + var namedMessageSent = typedMetric.Values.First(); |
| 99 | + Assert.AreEqual(messageName, namedMessageSent.Name); |
| 100 | + Assert.AreEqual(server.LocalClientId, namedMessageSent.Connection.Id); |
| 101 | + |
| 102 | + found = true; |
| 103 | + } |
| 104 | + })); |
| 105 | + |
| 106 | + server.CustomMessagingManager.SendNamedMessage(messageName, client.LocalClientId, Stream.Null); |
| 107 | + |
| 108 | + yield return WaitForAFewFrames(); // Client does not receive message synchronously |
| 109 | + |
| 110 | + MultiInstanceHelpers.Destroy(); |
| 111 | + |
| 112 | + Assert.True(found); |
| 113 | + } |
| 114 | + |
| 115 | + private IEnumerator WaitForMetricsDispatch() |
| 116 | + { |
| 117 | + yield return new WaitForEndOfFrame(); |
| 118 | + yield return new WaitForEndOfFrame(); |
| 119 | + } |
| 120 | + |
| 121 | + private IEnumerator WaitForAFewFrames() |
| 122 | + { |
| 123 | + yield return new WaitForSeconds(0.5f); |
| 124 | + } |
| 125 | + |
| 126 | + private IEventMetric<TEvent> AssertSingleMetricEventOfType<TEvent>(MetricCollection collection, string name) |
| 127 | + { |
| 128 | + var metric = collection.Metrics.SingleOrDefault(x => x.Name == name); |
| 129 | + Assert.NotNull(metric); |
| 130 | + |
| 131 | + var typedMetric = metric as IEventMetric<TEvent>; |
| 132 | + Assert.NotNull(typedMetric); |
| 133 | + Assert.IsNotEmpty(typedMetric.Values); |
| 134 | + |
| 135 | + return typedMetric; |
| 136 | + } |
| 137 | + |
| 138 | + private class TestObserver : IMetricObserver |
| 139 | + { |
| 140 | + private readonly Action<MetricCollection> m_Assertion; |
| 141 | + |
| 142 | + public TestObserver(Action<MetricCollection> assertion) |
| 143 | + { |
| 144 | + m_Assertion = assertion; |
| 145 | + } |
| 146 | + |
| 147 | + public void Observe(MetricCollection collection) |
| 148 | + { |
| 149 | + m_Assertion.Invoke(collection); |
| 150 | + } |
| 151 | + } |
| 152 | + |
| 153 | + public class CreateServerAndSingleClient |
| 154 | + { |
| 155 | + public NetworkManager Server { get; private set; } |
| 156 | + |
| 157 | + public NetworkManager Client { get; private set; } |
| 158 | + |
| 159 | + public IEnumerator Run() |
| 160 | + { |
| 161 | + if (!MultiInstanceHelpers.Create(1, out var server, out NetworkManager[] clients)) |
| 162 | + { |
| 163 | + Debug.LogError("Failed to create instances"); |
| 164 | + Assert.Fail("Failed to create instances"); |
| 165 | + } |
| 166 | + |
| 167 | + if (!MultiInstanceHelpers.Start(true, server, clients)) |
| 168 | + { |
| 169 | + Debug.LogError("Failed to start instances"); |
| 170 | + Assert.Fail("Failed to start instances"); |
| 171 | + } |
| 172 | + |
| 173 | + yield return MultiInstanceHelpers.Run(MultiInstanceHelpers.WaitForClientsConnected(clients)); |
| 174 | + yield return MultiInstanceHelpers.Run(MultiInstanceHelpers.WaitForClientConnectedToServer(server)); |
| 175 | + |
| 176 | + Server = server; |
| 177 | + Client = clients.SingleOrDefault(); |
| 178 | + } |
| 179 | + } |
| 180 | + } |
| 181 | +#endif |
| 182 | +} |
0 commit comments