Skip to content

feat: MultiInstanceHelpers to use fixed FrameRate by default #893

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
0xFA11 merged 4 commits into from
Jun 9, 2021
Merged

feat: MultiInstanceHelpers to use fixed FrameRate by default #893

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
ab734d5
feat: MultiInstanceHelpers to use fixed FrameRate by default
0xFA11 Jun 8, 2021
87645ad
remove ad-hoc TargetFrameRate fixes from automated tests
0xFA11 Jun 8, 2021
72e2d4c
update default framerate to 60
0xFA11 Jun 9, 2021
6a008de
Merge branch 'develop' into feat/mulinshelper-fixed-fps
0xFA11 Jun 9, 2021
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
8 changes: 7 additions & 1 deletion com.unity.multiplayer.mlapi/Tests/Runtime/MultiInstance/MultiInstanceHelpers.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,15 @@ public static class MultiInstanceHelpers
private static List<NetworkManager> s_NetworkManagerInstances = new List<NetworkManager>();
private static bool s_IsStarted;
private static int s_ClientCount;
private static int s_OriginalTargetFrameRate = -1;

/// <summary>
/// Creates NetworkingManagers and configures them for use in a multi instance setting.
/// </summary>
/// <param name="clientCount">The amount of clients</param>
/// <param name="server">The server NetworkManager</param>
/// <param name="clients">The clients NetworkManagers</param>
public static bool Create(int clientCount, out NetworkManager server, out NetworkManager[] clients)
public static bool Create(int clientCount, out NetworkManager server, out NetworkManager[] clients, int targetFrameRate = 60)
{
s_NetworkManagerInstances = new List<NetworkManager>();

Expand All @@ -49,6 +50,9 @@ public static bool Create(int clientCount, out NetworkManager server, out Networ
};
}

s_OriginalTargetFrameRate = Application.targetFrameRate;
Application.targetFrameRate = targetFrameRate;

return true;
}

Expand Down Expand Up @@ -129,6 +133,8 @@ public static void Destroy()
{
Object.Destroy(s_CoroutineRunner);
}

Application.targetFrameRate = s_OriginalTargetFrameRate;
}

/// <summary>
Expand Down
10 changes: 0 additions & 10 deletions com.unity.multiplayer.mlapi/Tests/Runtime/MultiInstance/RPCTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
using System;
using System.Collections;
using System.Diagnostics;
using System.Linq;
using MLAPI.Messaging;
using NUnit.Framework;
using UnityEditor;
using UnityEngine;
using UnityEngine.TestTools;
using Debug = UnityEngine.Debug;
Expand Down Expand Up @@ -34,10 +31,6 @@ public void MyClientRpc()
[UnityTest]
public IEnumerator TestRPCs()
{
// Set target frameRate to work around ubuntu timings
int targetFrameRate = Application.targetFrameRate;
Application.targetFrameRate = 120;

// Create multiple NetworkManager instances
if (!MultiInstanceHelpers.Create(1, out NetworkManager server, out NetworkManager[] clients))
{
Expand Down Expand Up @@ -134,9 +127,6 @@ public IEnumerator TestRPCs()
Assert.True(hasReceivedClientRPCLocally, "ClientRPC was not locally received on the server");
Assert.True(hasReceivedClientRPCRemotely, "ClientRPC was not remotely received on the client");

// Release frame rate
Application.targetFrameRate = targetFrameRate;

// Cleanup
MultiInstanceHelpers.Destroy();
}
Expand Down
21 changes: 4 additions & 17 deletions com.unity.multiplayer.mlapi/Tests/Runtime/NetworkSpawnManagerTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
using System;
using System.Collections;
using MLAPI.Exceptions;
using NUnit.Framework;
using UnityEngine;
using UnityEngine.TestTools;
using Object = System.Object;

namespace MLAPI.RuntimeTests
{
Expand All @@ -13,7 +11,6 @@ public class NetworkSpawnManagerTests
private NetworkManager m_ServerNetworkManager;
private NetworkManager[] m_ClientNetworkManagers;
private GameObject m_PlayerPrefab;
private int m_OriginalTargetFrameRate;

private ulong serverSideClientId => m_ServerNetworkManager.ServerClientId;
private ulong clientSideClientId => m_ClientNetworkManagers[0].LocalClientId;
Expand All @@ -22,16 +19,6 @@ public class NetworkSpawnManagerTests
[UnitySetUp]
public IEnumerator Setup()
{
// Just always track the current target frame rate (will be re-applied upon TearDown)
m_OriginalTargetFrameRate = Application.targetFrameRate;

// Since we use frame count as a metric, we need to assure it runs at a "common update rate"
// between platforms (i.e. Ubuntu seems to run at much higher FPS when set to -1)
if (Application.targetFrameRate < 0 || Application.targetFrameRate > 120)
{
Application.targetFrameRate = 120;
}

// Create multiple NetworkManager instances
if (!MultiInstanceHelpers.Create(2, out NetworkManager server, out NetworkManager[] clients))
{
Expand Down Expand Up @@ -191,11 +178,11 @@ public IEnumerator Teardown()
{
// Shutdown and clean up both of our NetworkManager instances
MultiInstanceHelpers.Destroy();
UnityEngine.Object.Destroy(m_PlayerPrefab);
Object.Destroy(m_PlayerPrefab);

// Set the application's target frame rate back to its original value
Application.targetFrameRate = m_OriginalTargetFrameRate;
yield return new WaitForSeconds(0); // wait for next frame so everything is destroyed, so following tests can execute from clean environment
// wait for next frame so everything is destroyed, so following tests can execute from clean environment
int nextFrameNumber = Time.frameCount + 1;
yield return new WaitUntil(() => Time.frameCount >= nextFrameNumber);
}
}
}
42 changes: 8 additions & 34 deletions testproject/Assets/Tests/Runtime/MultiClientConnectionApproval.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,22 +20,6 @@ public class MultiClientConnectionApproval
private GameObject m_PlayerPrefab;
private GameObject m_PlayerPrefabOverride;

private int m_OriginalTargetFrameRate;

[SetUp]
public void SetUp()
{
// Just always track the current target frame rate (will be re-applied upon TearDown)
m_OriginalTargetFrameRate = Application.targetFrameRate;

// Since we use frame count as a metric, we need to assure it runs at a "common update rate"
// between platforms (i.e. Ubuntu seems to run at much higher FPS when set to -1)
if (Application.targetFrameRate < 0 || Application.targetFrameRate > 120)
{
Application.targetFrameRate = 120;
}
}

/// <summary>
/// Tests connection approval and connection approval failure
/// </summary>
Expand All @@ -44,7 +28,7 @@ public void SetUp()
public IEnumerator ConnectionApproval()
{
m_ConnectionToken = "ThisIsTheRightPassword";
return ConnectionApprovalHandler(3,1);
return ConnectionApprovalHandler(3, 1);
}

/// <summary>
Expand All @@ -60,28 +44,22 @@ public IEnumerator ConnectionApprovalPrefabOverride()


/// <summary>
/// Allows for several connection approval related configurations
/// Allows for several connection approval related configurations
/// </summary>
/// <param name="numClients">total number of clients (excluding the host)</param>
/// <param name="failureTestCount">how many clients are expected to fail</param>
/// <param name="prefabOverride">if we are also testing player prefab overrides</param>
/// <returns></returns>
private IEnumerator ConnectionApprovalHandler(int numClients, int failureTestCount = 1, bool prefabOverride = false)
{
Debug.Log($"Application.targetFrameRate = {Application.targetFrameRate}");
if (Application.targetFrameRate == -1 || Application.targetFrameRate > 120)
{
Application.targetFrameRate = 120;
}

var startFrameCount = Time.frameCount;
var startTime = Time.realtimeSinceStartup;

m_SuccessfulConnections = 0;
m_FailedConnections = 0;
Assert.IsTrue(numClients >= failureTestCount);
// Create Host and (numClients) clients

// Create Host and (numClients) clients
Assert.True(MultiInstanceHelpers.Create(numClients, out NetworkManager server, out NetworkManager[] clients));

// Create a default player GameObject to use
Expand Down Expand Up @@ -131,7 +109,7 @@ private IEnumerator ConnectionApprovalHandler(int numClients, int failureTestCou
client.NetworkConfig.ConnectionData = Encoding.ASCII.GetBytes(m_ConnectionToken);
clientsAdjustedList.Add(client);
}

}

// Start the instances
Expand All @@ -141,7 +119,7 @@ private IEnumerator ConnectionApprovalHandler(int numClients, int failureTestCou
Assert.Fail("Failed to start instances");
}

// [Client-Side] Wait for a connection to the server
// [Client-Side] Wait for a connection to the server
yield return MultiInstanceHelpers.Run(MultiInstanceHelpers.WaitForClientsConnected(clientsAdjustedList.ToArray(), null, 512));

// [Host-Side] Check to make sure all clients are connected
Expand All @@ -156,7 +134,7 @@ private IEnumerator ConnectionApprovalHandler(int numClients, int failureTestCou
// If we are doing player prefab overrides, then check all of the players to make sure they spawned the appropriate NetworkObject
if (prefabOverride)
{
foreach(var networkClient in server.ConnectedClientsList)
foreach (var networkClient in server.ConnectedClientsList)
{
Assert.IsNotNull(networkClient.PlayerObject);
Assert.AreEqual(networkClient.PlayerObject.GlobalObjectIdHash, m_PrefabOverrideGlobalObjectIdHash);
Expand All @@ -171,7 +149,6 @@ private IEnumerator ConnectionApprovalHandler(int numClients, int failureTestCou
server.ConnectionApprovalCallback -= ConnectionApprovalCallback;
server.StopHost();

Debug.Log($"Application.targetFrameRate = {Application.targetFrameRate}.");
Debug.Log($"Total frames updated = {Time.frameCount - startFrameCount} within {Time.realtimeSinceStartup - startTime} seconds.");
}

Expand All @@ -186,7 +163,7 @@ private void ConnectionApprovalCallback(byte[] connectionData, ulong clientId, N
string approvalToken = Encoding.ASCII.GetString(connectionData);
var isApproved = approvalToken == m_ConnectionToken;

if(isApproved)
if (isApproved)
{
m_SuccessfulConnections++;
}
Expand Down Expand Up @@ -222,9 +199,6 @@ public void TearDown()

// Shutdown and clean up both of our NetworkManager instances
MultiInstanceHelpers.Destroy();

// Set the application's target frame rate back to its original value
Application.targetFrameRate = m_OriginalTargetFrameRate;
}
}
}
35 changes: 8 additions & 27 deletions testproject/Assets/Tests/Runtime/RpcINetworkSerializable.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@ public class RpcINetworkSerializable
{
private GameObject m_PlayerPrefab;

private int m_OriginalTargetFrameRate;

private UserSerializableClass m_UserSerializableClass;
private List<UserSerializableClass> m_UserSerializableClassArray;

Expand All @@ -25,20 +23,6 @@ public class RpcINetworkSerializable
private bool m_IsSendingNull;
private bool m_IsArrayEmpty;

[SetUp]
public void SetUp()
{
// Just always track the current target frame rate (will be re-applied upon TearDown)
m_OriginalTargetFrameRate = Application.targetFrameRate;

// Since we use frame count as a metric, we need to assure it runs at a "common update rate"
// between platforms (i.e. Ubuntu seems to run at much higher FPS when set to -1)
if (Application.targetFrameRate < 0 || Application.targetFrameRate > 120)
{
Application.targetFrameRate = 120;
}
}

/// <summary>
/// Tests that INetworkSerializable can be used through RPCs by a user
/// </summary>
Expand All @@ -50,7 +34,7 @@ public IEnumerator NetworkSerializableTest()
var numClients = 1;
var startTime = Time.realtimeSinceStartup;

// Create Host and (numClients) clients
// Create Host and (numClients) clients
Assert.True(MultiInstanceHelpers.Create(numClients, out NetworkManager server, out NetworkManager[] clients));

// Create a default player GameObject to use
Expand All @@ -76,7 +60,7 @@ public IEnumerator NetworkSerializableTest()
Assert.Fail("Failed to start instances");
}

// [Client-Side] Wait for a connection to the server
// [Client-Side] Wait for a connection to the server
yield return MultiInstanceHelpers.Run(MultiInstanceHelpers.WaitForClientsConnected(clients, null, 512));

// [Host-Side] Check to make sure all clients are connected
Expand Down Expand Up @@ -174,7 +158,7 @@ public IEnumerator NetworkSerializableEmptyArrayTest()
[UnityTest]
public IEnumerator NetworkSerializableNULLArrayTest()
{
return NetworkSerializableArrayTestHandler(0,true);
return NetworkSerializableArrayTestHandler(0, true);
}

/// <summary>
Expand All @@ -197,7 +181,7 @@ public IEnumerator NetworkSerializableArrayTestHandler(int arraySize, bool sendN
var numClients = 1;
var startTime = Time.realtimeSinceStartup;

// Create Host and (numClients) clients
// Create Host and (numClients) clients
Assert.True(MultiInstanceHelpers.Create(numClients, out NetworkManager server, out NetworkManager[] clients));

// Create a default player GameObject to use
Expand All @@ -223,7 +207,7 @@ public IEnumerator NetworkSerializableArrayTestHandler(int arraySize, bool sendN
Assert.Fail("Failed to start instances");
}

// [Client-Side] Wait for a connection to the server
// [Client-Side] Wait for a connection to the server
yield return MultiInstanceHelpers.Run(MultiInstanceHelpers.WaitForClientsConnected(clients, null, 512));

// [Host-Side] Check to make sure all clients are connected
Expand All @@ -245,7 +229,7 @@ public IEnumerator NetworkSerializableArrayTestHandler(int arraySize, bool sendN

if (!m_IsSendingNull)
{
// Create an array of userSerializableClass instances
// Create an array of userSerializableClass instances
for (int i = 0; i < arraySize; i++)
{
var userSerializableClass = new UserSerializableClass();
Expand Down Expand Up @@ -297,7 +281,7 @@ private void ValidateUserSerializableClasses(UserSerializableClass[] userSeriali
}
else if (m_IsArrayEmpty)
{
Assert.AreEqual(userSerializableClass.Length,0);
Assert.AreEqual(userSerializableClass.Length, 0);
}
else
{
Expand Down Expand Up @@ -343,9 +327,6 @@ public void TearDown()

// Shutdown and clean up both of our NetworkManager instances
MultiInstanceHelpers.Destroy();

// Set the application's target frame rate back to its original value
Application.targetFrameRate = m_OriginalTargetFrameRate;
}
}

Expand Down Expand Up @@ -458,7 +439,7 @@ private void SendClientSerializedDataClientRpc(UserSerializableClass[] userSeria
}

/// <summary>
/// The test version of a custom user-defined class that implements INetworkSerializable
/// The test version of a custom user-defined class that implements INetworkSerializable
/// </summary>
public class UserSerializableClass : INetworkSerializable
{
Expand Down
Loading