feat(commands): in-game !afk command over IAfkState

Author: HandyS11

src/RustPlusBot.Features.Commands/CommandServiceCollectionExtensions.cs

@@ -37,6 +37,7 @@ public static IServiceCollection AddCommands(this IServiceCollection services)
         services.AddScoped<ICommandHandler, TeamCommandHandler>();
         services.AddScoped<ICommandHandler, SteamIdCommandHandler>();
         services.AddScoped<ICommandHandler, AliveCommandHandler>();
+        services.AddScoped<ICommandHandler, AfkCommandHandler>();
         services.AddScoped<ICommandHandler, ProxCommandHandler>();
         services.AddScoped<ICommandHandler, CargoCommandHandler>();
         services.AddScoped<ICommandHandler, HeliCommandHandler>();

src/RustPlusBot.Features.Commands/Handlers/AfkCommandHandler.cs

@@ -0,0 +1,38 @@
+using RustPlusBot.Features.Commands.Dispatching;
+using RustPlusBot.Features.Commands.Formatting;
+using RustPlusBot.Features.Commands.Localization;
+using RustPlusBot.Features.Connections.Listening;
+
+namespace RustPlusBot.Features.Commands.Handlers;
+
+/// <summary>!afk — lists team members who have been still (online + alive) past the AFK threshold.</summary>
+/// <param name="afk">The live AFK state.</param>
+/// <param name="localizer">The reply localizer.</param>
+internal sealed class AfkCommandHandler(IAfkState afk, ICommandLocalizer localizer) : ICommandHandler
+{
+    /// <inheritdoc />
+    public string Name => "afk";
+
+    /// <inheritdoc />
+    public async Task<string?> ExecuteAsync(CommandContext context, CancellationToken cancellationToken)
+    {
+        ArgumentNullException.ThrowIfNull(context);
+        var members = await afk.GetAfkMembersAsync(context.GuildId, context.ServerId, cancellationToken)
+            .ConfigureAwait(false);
+        if (members is null)
+        {
+            return localizer.Get("command.notconnected", context.Culture);
+        }
+
+        if (members.Count == 0)
+        {
+            return localizer.Get("command.afk.none", context.Culture);
+        }
+
+        var parts = members
+            .OrderByDescending(m => m.StillFor)
+            .Select(m => localizer.Get(
+                "command.afk.member", context.Culture, m.Name, DurationFormat.Compact(m.StillFor)));
+        return localizer.Get("command.afk.ok", context.Culture, string.Join(", ", parts));
+    }
+}

src/RustPlusBot.Features.Commands/Localization/CommandLocalizationCatalog.cs

@@ -31,6 +31,9 @@ internal sealed class CommandLocalizationCatalog
                 ["command.team.none"] = "No team members.",
                 ["command.team.nomatch"] = "No teammate matches '{0}'.",
                 ["command.steamid.ok"] = "{0}",
+                ["command.afk.ok"] = "AFK: {0}",
+                ["command.afk.none"] = "Nobody is AFK.",
+                ["command.afk.member"] = "{0} ({1})",
                 ["command.alive.ok"] = "Alive: {0}",
                 ["command.alive.dead"] = "{0} dead",
                 ["command.alive.member"] = "{0} {1}",
@@ -111,6 +114,9 @@ internal sealed class CommandLocalizationCatalog
                 ["command.team.none"] = "Aucun membre d'équipe.",
                 ["command.team.nomatch"] = "Aucun coéquipier ne correspond à « {0} ».",
                 ["command.steamid.ok"] = "{0}",
+                ["command.afk.ok"] = "AFK : {0}",
+                ["command.afk.none"] = "Personne n'est AFK.",
+                ["command.afk.member"] = "{0} ({1})",
                 ["command.alive.ok"] = "En vie : {0}",
                 ["command.alive.dead"] = "{0} mort",
                 ["command.alive.member"] = "{0} {1}",

tests/RustPlusBot.Features.Commands.Tests/AfkCommandHandlerTests.cs

@@ -0,0 +1,45 @@
+using NSubstitute;
+using RustPlusBot.Features.Commands.Dispatching;
+using RustPlusBot.Features.Commands.Handlers;
+using RustPlusBot.Features.Commands.Localization;
+using RustPlusBot.Features.Connections.Listening;
+
+namespace RustPlusBot.Features.Commands.Tests;
+
+public sealed class AfkCommandHandlerTests
+{
+    private readonly IAfkState _afk = Substitute.For<IAfkState>();
+    private readonly ICommandLocalizer _localizer = new CommandLocalizer(CommandLocalizationCatalog.Default);
+
+    private static CommandContext Ctx() => new(1, Guid.NewGuid(), "en", 99, "Caller", []);
+
+    [Fact]
+    public async Task Name_is_afk() => Assert.Equal("afk", new AfkCommandHandler(_afk, _localizer).Name);
+
+    [Fact]
+    public async Task Reports_not_connected_when_state_null()
+    {
+        _afk.GetAfkMembersAsync(Arg.Any<ulong>(), Arg.Any<Guid>(), Arg.Any<CancellationToken>())
+            .Returns((IReadOnlyList<AfkMember>?)null);
+        var reply = await new AfkCommandHandler(_afk, _localizer).ExecuteAsync(Ctx(), CancellationToken.None);
+        Assert.Equal(_localizer.Get("command.notconnected", "en"), reply);
+    }
+
+    [Fact]
+    public async Task Reports_none_when_empty()
+    {
+        _afk.GetAfkMembersAsync(Arg.Any<ulong>(), Arg.Any<Guid>(), Arg.Any<CancellationToken>())
+            .Returns([]);
+        var reply = await new AfkCommandHandler(_afk, _localizer).ExecuteAsync(Ctx(), CancellationToken.None);
+        Assert.Equal(_localizer.Get("command.afk.none", "en"), reply);
+    }
+
+    [Fact]
+    public async Task Lists_afk_members_with_durations()
+    {
+        _afk.GetAfkMembersAsync(Arg.Any<ulong>(), Arg.Any<Guid>(), Arg.Any<CancellationToken>())
+            .Returns(new List<AfkMember> { new(1, "Bob", TimeSpan.FromMinutes(6)) });
+        var reply = await new AfkCommandHandler(_afk, _localizer).ExecuteAsync(Ctx(), CancellationToken.None);
+        Assert.Contains("Bob", reply, StringComparison.Ordinal);
+    }
+}

tests/RustPlusBot.Features.Commands.Tests/CommandRegistrationTests.cs

@@ -29,6 +29,7 @@ public void Dispatcher_and_handlers_resolve()
         services.AddSingleton<IRustServerQuery>(Substitute.For<IRustServerQuery>());
         services.AddSingleton<IEventState>(_ => Substitute.For<IEventState>());
         services.AddSingleton<IRigState>(_ => Substitute.For<IRigState>());
+        services.AddSingleton<IAfkState>(_ => Substitute.For<IAfkState>());
         services.AddScoped<IMuteStore>(_ => Substitute.For<IMuteStore>());
         services.AddScoped<IWorkspaceStore>(_ => Substitute.For<IWorkspaceStore>());
         services.AddScoped<IServerService>(_ => Substitute.For<IServerService>());
@@ -47,7 +48,7 @@ public void Dispatcher_and_handlers_resolve()
         using var scope = provider.CreateScope();
         Assert.NotNull(scope.ServiceProvider.GetRequiredService<CommandDispatcher>());
         var handlers = scope.ServiceProvider.GetServices<ICommandHandler>().ToList();
-        Assert.Equal(18, handlers.Count);
+        Assert.Equal(19, handlers.Count);
         Assert.Contains(handlers, h => h.Name == "mute");
         Assert.Contains(handlers, h => h.Name == "pop");
         Assert.Contains(handlers, h => h.Name == "time");
@@ -64,6 +65,7 @@ public void Dispatcher_and_handlers_resolve()
         Assert.Contains(handlers, h => h.Name == "events");
         Assert.Contains(handlers, h => h.Name == "small");
         Assert.Contains(handlers, h => h.Name == "large");
+        Assert.Contains(handlers, h => h.Name == "afk");
         Assert.NotNull(scope.ServiceProvider.GetRequiredService<ServerResolver>());
         Assert.NotNull(scope.ServiceProvider.GetRequiredService<ServerQueryService>());
     }
@@ -79,6 +81,7 @@ public void Commands_contribute_an_interaction_module_assembly()
         services.AddSingleton<IRustServerQuery>(Substitute.For<IRustServerQuery>());
         services.AddSingleton<IEventState>(_ => Substitute.For<IEventState>());
         services.AddSingleton<IRigState>(_ => Substitute.For<IRigState>());
+        services.AddSingleton<IAfkState>(_ => Substitute.For<IAfkState>());
         services.AddScoped<IMuteStore>(_ => Substitute.For<IMuteStore>());
         services.AddScoped<IWorkspaceStore>(_ => Substitute.For<IWorkspaceStore>());
         services.AddScoped<IServerService>(_ => Substitute.For<IServerService>());