unify removed command handling

Author: adamgauthier

src/TaylorBot.Net/Core/src/TaylorBot.Net.Commands.Infrastructure/DisabledCommandPostgresRepository.cs

@@ -12,17 +12,15 @@ public async ValueTask<string> InsertOrGetCommandDisabledMessageAsync(CommandMet
 
         return await connection.QuerySingleAsync<string>(
             """
-            INSERT INTO commands.commands (name, aliases, module_name) VALUES (@CommandName, @Aliases, @ModuleName)
+            INSERT INTO commands.commands (name, aliases, module_name) VALUES (@CommandName, @Aliases, '')
             ON CONFLICT (name) DO UPDATE SET
-                aliases = excluded.aliases,
-                module_name = excluded.module_name
+                aliases = excluded.aliases
             RETURNING disabled_message;
             """,
             new
             {
                 CommandName = command.Name,
                 Aliases = command.Aliases ?? [],
-                ModuleName = command.ModuleName ?? string.Empty,
             }
         );
     }

src/TaylorBot.Net/Core/src/TaylorBot.Net.Commands/CommandRunner.cs

@@ -8,6 +8,7 @@
 using TaylorBot.Net.Core.Snowflake;
 using TaylorBot.Net.Core.User;
 using TaylorBot.Net.EntityTracker.Domain.TextChannel;
+using static TaylorBot.Net.Commands.RunContext;
 
 namespace TaylorBot.Net.Commands;
 
@@ -27,14 +28,20 @@ public record RunContext(
     CommandGuild? Guild,
     GuildTextChannel? GuildTextChannel,
     IDiscordClient Client,
-    RunContext.SlashCommandInfo? SlashCommand,
-    RunContext.OnGoingState OnGoing,
+    SlashCommandInfo? SlashCommand,
+    OnGoingState OnGoing,
     CommandActivity Activity,
-    bool WasAcknowledged = true
+    bool WasAcknowledged = true,
+    PrefixCommandInfo? PrefixCommand = null
 )
 {
     public record SlashCommandInfo(string Id, string Name);
 
+    public record PrefixCommandInfo(IReadOnlyList<string>? ReplacementSlashCommands, bool IsRemoved = false, string? RemovedMessage = null)
+    {
+        public PrefixCommandInfo(string? ReplacementSlashCommand = null, bool IsRemoved = false, string? RemovedMessage = null) : this(ReplacementSlashCommand != null ? [ReplacementSlashCommand] : null, IsRemoved, RemovedMessage) { }
+    }
+
     public class OnGoingState { public string? OnGoingCommandAddedToPool { get; set; } }
 }
 
@@ -102,7 +109,7 @@ public RunContext BuildContext(ParsedInteraction interaction, CommandActivity ac
 
 public record Command(CommandMetadata Metadata, Func<ValueTask<ICommandResult>> RunAsync, IList<ICommandPrecondition>? Preconditions = null);
 
-public record CommandMetadata(string Name, string? ModuleName = null, IReadOnlyList<string>? Aliases = null, bool IsSlashCommand = true);
+public record CommandMetadata(string Name, IReadOnlyList<string>? Aliases = null, bool IsSlashCommand = true);
 
 public interface ICommandRunner
 {
@@ -117,10 +124,11 @@ public class CommandRunner(
     UserNotIgnoredPrecondition userNotIgnored,
     MemberTrackedPrecondition memberTracked,
     TextChannelTrackedPrecondition textChannelTracked,
-    UserNoOngoingCommandPrecondition userNoOngoingCommand
+    UserNoOngoingCommandPrecondition userNoOngoingCommand,
+    NotRemovedPrecondition notRemoved
     ) : ICommandRunner
 {
-    private readonly List<ICommandPrecondition> slashCommandsPreconditions = [notDisabled, notGuildDisabled, notGuildChannelDisabled, userNotIgnored, memberTracked, textChannelTracked, userNoOngoingCommand];
+    private readonly List<ICommandPrecondition> slashCommandsPreconditions = [notDisabled, notGuildDisabled, notGuildChannelDisabled, userNotIgnored, memberTracked, textChannelTracked, userNoOngoingCommand, notRemoved];
 
     public async ValueTask<ICommandResult> RunSlashCommandAsync(Command command, RunContext context)
     {

src/TaylorBot.Net/Core/src/TaylorBot.Net.Commands/DiscordNet/CommandExecutedHandler.cs

@@ -92,7 +92,7 @@ await context.Channel.SendMessageAsync(
                             await context.Channel.SendMessageAsync(
                                 messageReference: new(context.Message.Id),
                                 allowedMentions: new AllowedMentions { MentionRepliedUser = false },
-                                embed: EmbedFactory.CreateError($"{context.User.Mention} {failed.UserReason.Reason}"));
+                                embed: EmbedFactory.CreateError(failed.UserReason.Reason));
                         }
                         break;
 
@@ -131,7 +131,7 @@ await context.Channel.SendMessageAsync(
                         // Preconditions have not been executed, we must make sure the user is not ignored.
                         var runResult = await userNotIgnoredPrecondition.CanRunAsync(
                             new Command(DiscordNetContextMapper.MapToCommandMetadata(commandContext), () => new()),
-                            DiscordNetContextMapper.MapToRunContext(commandContext)
+                            DiscordNetContextMapper.MapToRunContext(commandContext, new())
                         );
 
                         if (runResult is not PreconditionFailed failed || !failed.UserReason.HideInPrefixCommands)

src/TaylorBot.Net/Core/src/TaylorBot.Net.Commands/DiscordNet/DiscordNetContextMapper.cs

@@ -1,11 +1,12 @@
 using Discord;
 using TaylorBot.Net.Core.Channel;
+using static TaylorBot.Net.Commands.RunContext;
 
 namespace TaylorBot.Net.Commands.DiscordNet;
 
 public static class DiscordNetContextMapper
 {
-    public static RunContext MapToRunContext(ITaylorBotCommandContext context)
+    public static RunContext MapToRunContext(ITaylorBotCommandContext context, PrefixCommandInfo? prefixInfo)
     {
         var channelType = context.Channel.GetChannelType();
         if (!channelType.HasValue)
@@ -25,9 +26,10 @@ public static RunContext MapToRunContext(ITaylorBotCommandContext context)
             guild,
             GuildTextChannel: guild != null ? new(channel.Id, guild.Id, channel.Type) : null,
             context.Client,
-            new(string.Empty, string.Empty),
-            new(),
-            context.Activity.Value
+            SlashCommand: null,
+            OnGoing: new(),
+            context.Activity.Value,
+            PrefixCommand: prefixInfo ?? new()
         );
         context.RunContext = runContext;
         return runContext;
@@ -37,11 +39,11 @@ public static CommandMetadata MapToCommandMetadata(ITaylorBotCommandContext cont
     {
         if (context.IsTestEnv)
         {
-            return new CommandMetadata(null!, IsSlashCommand: false);
+            return new(null!, IsSlashCommand: false);
         }
 
         var commandInfo = context.CommandInfos.OrderByDescending(c => c.Priority).First();
 
-        return new(commandInfo.Aliases[0], commandInfo.Module.Name, commandInfo.Aliases, IsSlashCommand: false);
+        return new(commandInfo.Aliases[0], commandInfo.Aliases, IsSlashCommand: false);
     }
 }

src/TaylorBot.Net/Core/src/TaylorBot.Net.Commands/DiscordNet/PrefixedCommandRunner.cs

@@ -0,0 +1,20 @@
+using static TaylorBot.Net.Commands.RunContext;
+
+namespace TaylorBot.Net.Commands.DiscordNet;
+
+public class PrefixedCommandRunner(ICommandRunner commandRunner)
+{
+    public async Task<TaylorBotResult> RunAsync(
+        ITaylorBotCommandContext context,
+        PrefixCommandInfo commandInfo)
+    {
+        var command = new Command(
+            DiscordNetContextMapper.MapToCommandMetadata(context),
+            () => throw new InvalidOperationException());
+        var runContext = DiscordNetContextMapper.MapToRunContext(context, commandInfo);
+
+        var result = await commandRunner.RunSlashCommandAsync(command, runContext);
+
+        return new TaylorBotResult(result, runContext);
+    }
+}

src/TaylorBot.Net/Core/src/TaylorBot.Net.Commands/Events/ShardReadyHandler.cs

@@ -9,7 +9,7 @@ public class ShardReadyHandler(SingletonTaskRunner commandMentionCacheRunner, IA
     public Task ShardReadyAsync(DiscordSocketClient shardClient)
     {
         // Cache command ids for mentions
-        _ = commandMentionCacheRunner.StartTaskIfNotStarted(
+        _ = commandMentionCacheRunner.RunTaskIfNotRan(
             commandRepository.CacheCommandsAsync,
             nameof(IApplicationCommandsRepository.CacheCommandsAsync)
         );

src/TaylorBot.Net/Core/src/TaylorBot.Net.Commands/Extensions/ServiceCollectionExtensions.cs

@@ -61,6 +61,7 @@ public static IServiceCollection AddCommandApplication(this IServiceCollection s
             .AddTransient<IReactionAddedHandler>(c => c.GetRequiredService<PageMessageReactionsHandler>())
             .AddTransient<IReactionRemovedHandler>(c => c.GetRequiredService<PageMessageReactionsHandler>())
             .AddTransient<CommandExecutedHandler>()
+            .AddTransient<PrefixedCommandRunner>()
             .AddTransient<CommandServiceLogger>()
             .AddTransient<IRateLimiter, CommandRateLimiter>()
             .AddTransient<IUserTracker, UserTracker>()
@@ -86,6 +87,7 @@ public static IServiceCollection AddCommandApplication(this IServiceCollection s
             .AddTransient<MemberTrackedPrecondition>()
             .AddTransient<TextChannelTrackedPrecondition>()
             .AddTransient<UserNoOngoingCommandPrecondition>()
+            .AddTransient<NotRemovedPrecondition>()
             .AddTransient<UserHasPermissionOrOwnerPrecondition.Factory>()
             .AddTransient<TaylorBotHasPermissionPrecondition.Factory>()
             .AddTransient<TaylorBotOwnerPrecondition>()

src/TaylorBot.Net/Core/src/TaylorBot.Net.Commands/Preconditions/NotGuildChannelDisabledPrecondition.cs

@@ -28,7 +28,7 @@ public async ValueTask<ICommandResult> CanRunAsync(Command command, RunContext c
                     $"""
                     You can't use {mention.Command(command, context)} because it is disabled in {context.Channel.Mention} 🚫
                     {(canRun is PreconditionPassed
-                        ? $"You can re-enable it by typing </command channel-enable:909694280703016991> {command.Metadata.Name} ✅"
+                        ? $"You can re-enable it by typing {mention.SlashCommand("command channel-enable")} {command.Metadata.Name} ✅"
                         : "Ask a moderator to re-enable it 🙏")}
                     """
                 )

src/TaylorBot.Net/Core/src/TaylorBot.Net.Commands/Preconditions/NotRemovedPrecondition.cs

@@ -0,0 +1,31 @@
+namespace TaylorBot.Net.Commands.Preconditions;
+
+public class NotRemovedPrecondition(CommandMentioner mention) : ICommandPrecondition
+{
+    public ValueTask<ICommandResult> CanRunAsync(Command command, RunContext context)
+    {
+        if (context.PrefixCommand?.IsRemoved == true)
+        {
+            var userReason = context.PrefixCommand.ReplacementSlashCommands != null ?
+                context.PrefixCommand.ReplacementSlashCommands.Count > 1 ?
+                    $"""
+                    This command has been moved to:
+                    {string.Join('\n', context.PrefixCommand.ReplacementSlashCommands.Select(c => $"👉 {mention.SlashCommand(c)} 👈"))}
+                    Please use them instead! 😊
+                    """ :
+                    $"""
+                    This command has been moved to 👉 {mention.SlashCommand(context.PrefixCommand.ReplacementSlashCommands[0])} 👈
+                    Please use it instead! 😊
+                    """ :
+                    $"""
+                    This command has been removed, sorry! 😕
+                    {context.PrefixCommand.RemovedMessage}
+                    """;
+
+            return new(new PreconditionFailed(
+                PrivateReason: $"{command.Metadata.Name} is removed",
+                UserReason: new(userReason)));
+        }
+        return new(new PreconditionPassed());
+    }
+}

src/TaylorBot.Net/Core/src/TaylorBot.Net.Commands/Preconditions/PlusPrecondition.cs

@@ -74,12 +74,12 @@ private async Task<bool> IsPlusGuildAsync(RunContext context)
         return context.Guild != null && await plusRepository.IsActivePlusGuildAsync(context.Guild);
     }
 
-    private static string PlusInfo()
+    private string PlusInfo()
     {
         return
             $"""
             TaylorBot is free and {"supported by the community on Patreon".DiscordMdLink("https://www.patreon.com/taylorbot")} 💖
-            Some features are exclusive to **TaylorBot Plus**, learn more with </plus show:1246970937321066608> 💎
+            Some features are exclusive to **TaylorBot Plus**, learn more with {mention.SlashCommand("plus show")} 💎
             """;
     }
 }