Skip to content

fix: Rework packet loss metric tests to work with UTP 2.0 [MTT-4535] #2174

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.

Sign up for GitHub

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

Merged
simon-lemay-unity merged 4 commits into from
Sep 6, 2022
Merged

fix: Rework packet loss metric tests to work with UTP 2.0 [MTT-4535] #2174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
337669a
Allow fixing the simulator RNG seed
simon-lemay-unity Aug 31, 2022
7546144
Fix packet loss test for UTP 2.0
simon-lemay-unity Aug 31, 2022
1c87c78
Add comment about random seed in packet loss test
simon-lemay-unity Sep 1, 2022
3a7acad
Merge branch 'develop' into fix/packet-loss-test
simon-lemay-unity Sep 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion com.unity.netcode.gameobjects/Runtime/Transports/UTP/UnityTransport.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -337,6 +337,8 @@ public struct SimulatorParameters
PacketDropRate = 0
};

internal uint DebugSimulatorRandomSeed { get; set; } = 0;

private struct PacketLossCache
{
public int PacketsReceived;
Expand Down Expand Up @@ -1322,7 +1324,8 @@ private void ConfigureSimulator()
maxPacketSize: NetworkParameterConstants.MTU,
packetDelayMs: DebugSimulator.PacketDelayMS,
packetJitterMs: DebugSimulator.PacketJitterMS,
packetDropPercentage: DebugSimulator.PacketDropRate
packetDropPercentage: DebugSimulator.PacketDropRate,
randomSeed: DebugSimulatorRandomSeed
#if UTP_TRANSPORT_2_0_ABOVE
, mode: ApplyMode.AllPackets
#endif
Expand Down
20 changes: 12 additions & 8 deletions com.unity.netcode.gameobjects/Tests/Runtime/Metrics/PacketLossMetricsTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ public class PacketLossMetricsTests : NetcodeIntegrationTest
{
protected override int NumberOfClients => 1;
private readonly int m_PacketLossRate = 25;
private readonly int m_PacketLossRangeDelta = 5;
private readonly int m_PacketLossRangeDelta = 3;
private readonly int m_MessageSize = 200;

public PacketLossMetricsTests()
: base(HostOrServer.Server)
Expand All @@ -27,6 +28,12 @@ protected override void OnServerAndClientsCreated()
var clientTransport = (UnityTransport)m_ClientNetworkManagers[0].NetworkConfig.NetworkTransport;
clientTransport.SetDebugSimulatorParameters(0, 0, m_PacketLossRate);

// Determined through trial and error. With both UTP 1.2 and 2.0, this random seed
// results in an effective packet loss percentage between 22% and 28%. Future UTP
// updates may change the RNG call patterns and cause this test to fail, in which
// case the value should be modified again.
clientTransport.DebugSimulatorRandomSeed = 4;

base.OnServerAndClientsCreated();
}

Expand All @@ -39,8 +46,8 @@ public IEnumerator TrackPacketLossAsServer()

for (int i = 0; i < 1000; ++i)
{
using var writer = new FastBufferWriter(sizeof(byte), Allocator.Persistent);
writer.WriteByteSafe(42);
using var writer = new FastBufferWriter(m_MessageSize, Allocator.Persistent);
writer.WriteBytesSafe(new byte[m_MessageSize]);
m_ServerNetworkManager.CustomMessagingManager.SendNamedMessage("Test", m_ServerNetworkManager.ConnectedClientsIds, writer);
}

Expand All @@ -51,9 +58,6 @@ public IEnumerator TrackPacketLossAsServer()
}

[UnityTest]
#if UTP_TRANSPORT_2_0_ABOVE
[Ignore("Pending adjustment for UTP 2.0")]
#endif
public IEnumerator TrackPacketLossAsClient()
{
double packetLossRateMinRange = (m_PacketLossRate - m_PacketLossRangeDelta) / 100d;
Expand All @@ -65,8 +69,8 @@ public IEnumerator TrackPacketLossAsClient()

for (int i = 0; i < 1000; ++i)
{
using var writer = new FastBufferWriter(sizeof(byte), Allocator.Persistent);
writer.WriteByteSafe(42);
using var writer = new FastBufferWriter(m_MessageSize, Allocator.Persistent);
writer.WriteBytesSafe(new byte[m_MessageSize]);
m_ServerNetworkManager.CustomMessagingManager.SendNamedMessage("Test", m_ServerNetworkManager.ConnectedClientsIds, writer);
}

Expand Down