CatStation/Content.Benchmarks/DeviceNetworkingBenchmark.cs

using System.Collections.Generic;
using System.IO;
using System.Threading.Tasks;
using BenchmarkDotNet.Attributes;
using Content.IntegrationTests;
using Content.IntegrationTests.Pair;
using Content.IntegrationTests.Tests.DeviceNetwork;
using Content.Server.DeviceNetwork.Systems;
using Robust.Shared;
using Robust.Shared.Analyzers;
using Robust.Shared.GameObjects;
using Robust.Shared.Map;

namespace Content.Benchmarks;

[Virtual]
[MemoryDiagnoser]
public class DeviceNetworkingBenchmark
{
    private TestPair _pair = default!;
    private DeviceNetworkTestSystem _deviceNetTestSystem = default!;
    private DeviceNetworkSystem _deviceNetworkSystem = default!;
    private EntityUid _sourceEntity;
    private EntityUid _sourceWirelessEntity;
    private readonly List<EntityUid> _targetEntities = new();
    private readonly List<EntityUid> _targetWirelessEntities = new();

    [TestPrototypes]
    private const string Prototypes = @"
- type: entity
  name: DummyNetworkDevicePrivate
  id: DummyNetworkDevicePrivate
  components:
    - type: DeviceNetwork
      transmitFrequency: 100
      receiveFrequency: 100
      deviceNetId: Private
- type: entity
  name: DummyWirelessNetworkDevice
  id: DummyWirelessNetworkDevice
  components:
    - type: DeviceNetwork
      transmitFrequency: 100
      receiveFrequency: 100
      deviceNetId: Wireless
    - type: WirelessNetworkConnection
      range: 100
        ";

    //public static IEnumerable<int> EntityCountSource { get; set; }

    //[ParamsSource(nameof(EntityCountSource))]
    public int EntityCount = 1000;

    [GlobalSetup]
    public async Task SetupAsync()
    {
        ProgramShared.PathOffset = "../../../../";
        PoolManager.Startup(typeof(DeviceNetworkingBenchmark).Assembly);
        _pair = await PoolManager.GetServerClient(testContext: new ExternalTestContext("Benchmark", StreamWriter.Null));
        var server = _pair.Server;

        await server.WaitPost(() =>
        {
            var entityManager = server.InstanceDependencyCollection.Resolve<IEntityManager>();
            _deviceNetworkSystem = entityManager.EntitySysManager.GetEntitySystem<DeviceNetworkSystem>();
            _deviceNetTestSystem = entityManager.EntitySysManager.GetEntitySystem<DeviceNetworkTestSystem>();

            _sourceEntity = entityManager.SpawnEntity("DummyNetworkDevicePrivate", MapCoordinates.Nullspace);
            _sourceWirelessEntity = entityManager.SpawnEntity("DummyWirelessNetworkDevice", MapCoordinates.Nullspace);

            for (var i = 0; i < EntityCount; i++)
            {
                _targetEntities.Add(entityManager.SpawnEntity("DummyNetworkDevicePrivate", MapCoordinates.Nullspace));
                _targetWirelessEntities.Add(entityManager.SpawnEntity("DummyWirelessNetworkDevice", MapCoordinates.Nullspace));
            }
        });
    }

    [GlobalCleanup]
    public async Task Cleanup()
    {
        await _pair.DisposeAsync();
        PoolManager.Shutdown();
    }

    [Benchmark(Baseline = true, Description = "Entity Events")]
    public async Task EventSentBaseline()
    {
        var server = _pair.Server;

        _pair.Server.Post(() =>
        {
            foreach (var entity in _targetEntities)
            {
                _deviceNetTestSystem.SendBaselineTestEvent(entity);
            }
        });

        await server.WaitRunTicks(1);
        await server.WaitIdleAsync();
    }

    [Benchmark(Description = "Device Net Broadcast No Connection Checks")]
    public async Task DeviceNetworkBroadcastNoConnectionChecks()
    {
        var server = _pair.Server;

        _pair.Server.Post(() =>
        {
            var payload = new TestPayload
            {
                TestString = "test",
                TestNumber = 1,
                TestBool = true,
            };
            _deviceNetworkSystem.SendPacket(_sourceEntity, null, ref payload, 100);
        });

        await server.WaitRunTicks(1);
        await server.WaitIdleAsync();
    }

    [Benchmark(Description = "Device Net Broadcast Wireless Connection Checks")]
    public async Task DeviceNetworkBroadcastWirelessConnectionChecks()
    {
        var server = _pair.Server;

        _pair.Server.Post(() =>
        {
            var payload = new TestPayload
            {
                TestString = "test",
                TestNumber = 1,
                TestBool = true,
            };
            _deviceNetworkSystem.SendPacket(_sourceWirelessEntity, null, ref payload, 100);
        });

        await server.WaitRunTicks(1);
        await server.WaitIdleAsync();
    }

    [Benchmark(Description = "Device Net Broadcast No Connection Checks (Class payload)")]
    public async Task DeviceNetworkBroadcastNoConnectionChecksClass()
    {
        var server = _pair.Server;

        _pair.Server.Post(() =>
        {
            var payload = new TestPayloadClass
            {
                TestString = "test",
                TestNumber = 1,
                TestBool = true,
            };
            _deviceNetworkSystem.SendPacket(_sourceEntity, null, ref payload, 100);
        });

        await server.WaitRunTicks(1);
        await server.WaitIdleAsync();
    }

    [Benchmark(Description = "Device Net Broadcast Wireless Connection Checks (Class payload)")]
    public async Task DeviceNetworkBroadcastWirelessConnectionChecksClass()
    {
        var server = _pair.Server;

        _pair.Server.Post(() =>
        {
            var payload = new TestPayloadClass
            {
                TestString = "test",
                TestNumber = 1,
                TestBool = true,
            };
            _deviceNetworkSystem.SendPacket(_sourceWirelessEntity, null, ref payload, 100);
        });

        await server.WaitRunTicks(1);
        await server.WaitIdleAsync();
    }
}