diff --git a/build/Version.props b/build/Version.props index 2b9c5d5073..a6365b35ad 100644 --- a/build/Version.props +++ b/build/Version.props @@ -9,8 +9,8 @@ 7.0.0 13.7.0 16.0.0 - 7.2.1 - 5.9.0 + 7.3.0 + 5.10.0 1.5.0 1.2.1 2.0.0 diff --git a/src/DMAPI/tgs.dm b/src/DMAPI/tgs.dm index 4766b3dfe6..42f2d5fc31 100644 --- a/src/DMAPI/tgs.dm +++ b/src/DMAPI/tgs.dm @@ -1,7 +1,7 @@ // tgstation-server DMAPI // The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in IETF RFC 2119. -#define TGS_DMAPI_VERSION "7.2.1" +#define TGS_DMAPI_VERSION "7.3.0" // All functions and datums outside this document are subject to change with any version and should not be relied on. diff --git a/src/DMAPI/tgs/v5/__interop_version.dm b/src/DMAPI/tgs/v5/__interop_version.dm index f4806f7adb..29ea239ad8 100644 --- a/src/DMAPI/tgs/v5/__interop_version.dm +++ b/src/DMAPI/tgs/v5/__interop_version.dm @@ -1 +1 @@ -"5.9.0" +"5.10.0" diff --git a/src/DMAPI/tgs/v5/_defines.dm b/src/DMAPI/tgs/v5/_defines.dm index 92c7a8388a..a47bfd7800 100644 --- a/src/DMAPI/tgs/v5/_defines.dm +++ b/src/DMAPI/tgs/v5/_defines.dm @@ -95,6 +95,7 @@ #define DMAPI5_TOPIC_PARAMETER_NEW_SERVER_VERSION "newServerVersion" #define DMAPI5_TOPIC_PARAMETER_BROADCAST_MESSAGE "broadcastMessage" +#define DMAPI5_TOPIC_RESPONSE_CLIENT_COUNT "clientCount" #define DMAPI5_TOPIC_RESPONSE_COMMAND_RESPONSE "commandResponse" #define DMAPI5_TOPIC_RESPONSE_COMMAND_RESPONSE_MESSAGE "commandResponseMessage" #define DMAPI5_TOPIC_RESPONSE_CHAT_RESPONSES "chatResponses" diff --git a/src/DMAPI/tgs/v5/topic.dm b/src/DMAPI/tgs/v5/topic.dm index e1f2cb6385..59e5e63e5c 100644 --- a/src/DMAPI/tgs/v5/topic.dm +++ b/src/DMAPI/tgs/v5/topic.dm @@ -149,7 +149,9 @@ if(DMAPI5_TOPIC_COMMAND_HEALTHCHECK) if(event_handler && event_handler.receive_health_checks) event_handler.HandleEvent(TGS_EVENT_HEALTH_CHECK) - return TopicResponse() + var/list/health_check_response = TopicResponse() + health_check_response[DMAPI5_TOPIC_RESPONSE_CLIENT_COUNT] = TGS_CLIENT_COUNT + return health_check_response; if(DMAPI5_TOPIC_COMMAND_WATCHDOG_REATTACH) detached = FALSE diff --git a/src/DMAPI/tgs/v5/undefs.dm b/src/DMAPI/tgs/v5/undefs.dm index 237207fdfd..d8dbf7a781 100644 --- a/src/DMAPI/tgs/v5/undefs.dm +++ b/src/DMAPI/tgs/v5/undefs.dm @@ -17,8 +17,8 @@ #undef DMAPI5_BRIDGE_COMMAND_EVENT #undef DMAPI5_PARAMETER_ACCESS_IDENTIFIER +#undef DMAPI5_PARAMETER_CLIENT_COUNT #undef DMAPI5_PARAMETER_CUSTOM_COMMANDS -#undef DMAPI5_PARAMETER_TOPIC_PORT #undef DMAPI5_CHUNK #undef DMAPI5_CHUNK_PAYLOAD @@ -95,6 +95,7 @@ #undef DMAPI5_TOPIC_PARAMETER_NEW_SERVER_VERSION #undef DMAPI5_TOPIC_PARAMETER_BROADCAST_MESSAGE +#undef DMAPI5_TOPIC_RESPONSE_CLIENT_COUNT #undef DMAPI5_TOPIC_RESPONSE_COMMAND_RESPONSE #undef DMAPI5_TOPIC_RESPONSE_COMMAND_RESPONSE_MESSAGE #undef DMAPI5_TOPIC_RESPONSE_CHAT_RESPONSES diff --git a/src/Tgstation.Server.Api/Models/Internal/DreamDaemonApiBase.cs b/src/Tgstation.Server.Api/Models/Internal/DreamDaemonApiBase.cs index ea5c16bc15..e3411b8115 100644 --- a/src/Tgstation.Server.Api/Models/Internal/DreamDaemonApiBase.cs +++ b/src/Tgstation.Server.Api/Models/Internal/DreamDaemonApiBase.cs @@ -19,6 +19,12 @@ namespace Tgstation.Server.Api.Models.Internal [ResponseOptions] public DateTimeOffset? LaunchTime { get; set; } + /// + /// The last known count of connected players. Requires to not be 0 and a game server interop version >= 5.10.0 to populate. + /// + [ResponseOptions] + public int? ClientCount { get; set; } + /// /// If the server is undergoing a soft reset. This may be automatically set by changes to other fields. /// diff --git a/src/Tgstation.Server.Host/Components/Interop/Topic/TopicResponse.cs b/src/Tgstation.Server.Host/Components/Interop/Topic/TopicResponse.cs index 12db6f3ef1..e5b30150de 100644 --- a/src/Tgstation.Server.Host/Components/Interop/Topic/TopicResponse.cs +++ b/src/Tgstation.Server.Host/Components/Interop/Topic/TopicResponse.cs @@ -36,5 +36,10 @@ namespace Tgstation.Server.Host.Components.Interop.Topic /// public IReadOnlyCollection? MissingChunks { get; set; } + + /// + /// The number of connected clients to the game. Added in Interop 5.10.0. + /// + public int? ClientCount { get; } } } diff --git a/src/Tgstation.Server.Host/Components/Watchdog/IWatchdog.cs b/src/Tgstation.Server.Host/Components/Watchdog/IWatchdog.cs index 38ab770d33..35da1504f8 100644 --- a/src/Tgstation.Server.Host/Components/Watchdog/IWatchdog.cs +++ b/src/Tgstation.Server.Host/Components/Watchdog/IWatchdog.cs @@ -24,6 +24,11 @@ namespace Tgstation.Server.Host.Components.Watchdog /// DateTimeOffset? LaunchTime { get; } + /// + /// Last known client count queried from the DMAPI. Requires health checks to be enabled to populate. + /// + int? ClientCount { get; } + /// /// The current . /// diff --git a/src/Tgstation.Server.Host/Components/Watchdog/WatchdogBase.cs b/src/Tgstation.Server.Host/Components/Watchdog/WatchdogBase.cs index 21871a680c..3c67ca495c 100644 --- a/src/Tgstation.Server.Host/Components/Watchdog/WatchdogBase.cs +++ b/src/Tgstation.Server.Host/Components/Watchdog/WatchdogBase.cs @@ -38,6 +38,9 @@ namespace Tgstation.Server.Host.Components.Watchdog /// public long? SessionId => GetActiveController()?.ReattachInformation.Id; + /// + public int? ClientCount { get; private set; } + /// public DateTimeOffset? LaunchTime => GetActiveController()?.LaunchTime; @@ -570,6 +573,7 @@ namespace Tgstation.Server.Host.Components.Watchdog // since neither server is running, this is safe to do LastLaunchParameters = ActiveLaunchParameters; healthChecksMissed = 0; + ClientCount = null; try { @@ -667,6 +671,7 @@ namespace Tgstation.Server.Host.Components.Watchdog // we lost the server, just restart entirely // DCT: Operation must always run await DisposeAndNullControllers(CancellationToken.None); + ClientCount = null; const string FailReattachMessage = "Unable to properly reattach to server! Restarting watchdog..."; Logger.LogWarning(FailReattachMessage); @@ -1183,7 +1188,10 @@ namespace Tgstation.Server.Host.Components.Watchdog } } else + { healthChecksMissed = 0; + ClientCount = response.ClientCount; + } return MonitorAction.Continue; } diff --git a/src/Tgstation.Server.Host/Controllers/DreamDaemonController.cs b/src/Tgstation.Server.Host/Controllers/DreamDaemonController.cs index 6b4ceb1a85..e6760f0f17 100644 --- a/src/Tgstation.Server.Host/Controllers/DreamDaemonController.cs +++ b/src/Tgstation.Server.Host/Controllers/DreamDaemonController.cs @@ -367,6 +367,7 @@ namespace Tgstation.Server.Host.Controllers result.Status = dd.Status; result.SessionId = dd.SessionId; result.LaunchTime = dd.LaunchTime; + result.ClientCount = dd.ClientCount; } while (result.Status == WatchdogStatus.Online && !result.SessionId.HasValue); // this is the one invalid combo, it's not that racy diff --git a/tests/Tgstation.Server.Tests/Live/Instance/WatchdogTest.cs b/tests/Tgstation.Server.Tests/Live/Instance/WatchdogTest.cs index 241c156dba..d7930e0cc6 100644 --- a/tests/Tgstation.Server.Tests/Live/Instance/WatchdogTest.cs +++ b/tests/Tgstation.Server.Tests/Live/Instance/WatchdogTest.cs @@ -753,6 +753,9 @@ namespace Tgstation.Server.Tests.Live.Instance Assert.IsTrue(daemonStatus.LaunchTime.HasValue); Assert.IsTrue(daemonStatus.LaunchTime.Value >= DateTimeOffset.UtcNow.AddHours(-1)); + if (daemonStatus.ClientCount.HasValue) + Assert.AreEqual(0, daemonStatus.ClientCount.Value); + if (sessionIdTracker.HasValue) if (knownIncrease.HasValue) if (knownIncrease.Value) @@ -861,6 +864,8 @@ namespace Tgstation.Server.Tests.Live.Instance // Ensure it's responding to health checks await Task.WhenAny(Task.Delay(7000, cancellationToken), ourProcessHandler.Lifetime); Assert.IsFalse(ddProc.HasExited); + var daemonStatus = await instanceClient.DreamDaemon.Read(cancellationToken); + Assert.AreEqual(0, daemonStatus.ClientCount); // check DD agrees var topicRequestResult = await SendTestTopic(