[SFW-81] bug: application command comparison failing causing command with no actual changes to get re-registered on every launch

[favna]

Is there an existing issue for this?

• I have searched the existing issues

Description of the bug

Given a specific configuration for registering a command, the deep comparison is failing causing the command to get updated on the Discord API at every boot of the bot.

Steps To Reproduce

1. Copy this code into a command file:

import { Subcommand } from '@sapphire/plugin-subcommands';
import { ChannelType, PermissionFlagsBits } from 'discord.js';

export class UserCommand extends Subcommand {
  public constructor(context: Subcommand.Context) {
    super(context, {
      name: 'sub',
      description: 'Chat Input Command with some subcommand groups',
      requiredUserPermissions: ['ManageGuild'],
      requiredClientPermissions: ['ManageGuild'],
      runIn: 'GUILD_ANY',
      subcommands: [
        { name: 'list', chatInputRun: 'chatInputList' },
        {
          name: 'set',
          type: 'group',
          entries: [
            { name: 'modlog', chatInputRun: 'chatInputSetModlog' },
            { name: 'auditlog', chatInputRun: 'chatInputSetAuditlog' },
            { name: 'welcome', chatInputRun: 'chatInputSetWelcome' }
          ]
        }
      ]
    });
  }

  public override registerApplicationCommands(registry: Subcommand.Registry) {
    registry.registerChatInputCommand(
      (builder) =>
        builder
          .setName(this.name)
          .setDescription(this.description)
          .addSubcommand((command) => command.setName('list').setDescription('list the current settings of the bot for the current server ⚙️'))
          .addSubcommandGroup((group) =>
            group
              .setName('set')
              .setDescription('set the settings of the bot for the current server ⚙️')
              .addSubcommand((command) =>
                command
                  .setName('modlog')
                  .setDescription('change the modlog channel for the current server ⚙️')
                  .addChannelOption((option) =>
                    option
                      .setName('channel')
                      .setDescription("the channel to set the modlog to, don't input a channel to disable")
                      .setRequired(false)
                      .addChannelTypes(ChannelType.GuildText)
                  )
              )
              .addSubcommand((command) =>
                command
                  .setName('auditlog')
                  .setDescription('change the auditlog channel for the current server ⚙️')
                  .addChannelOption((option) =>
                    option
                      .setName('channel')
                      .setDescription("the channel to set the auditlog to, don't input a channel to disable")
                      .setRequired(false)
                      .addChannelTypes(ChannelType.GuildText)
                  )
              )
              .addSubcommand((command) =>
                command
                  .setName('welcome')
                  .setDescription('change the welcome channel for the current server ⚙️')
                  .addChannelOption((option) =>
                    option
                      .setName('channel')
                      .setDescription("the channel to set the welcome to, don't input a channel to disable")
                      .setRequired(false)
                      .addChannelTypes(ChannelType.GuildText)
                  )
              )
          )
          .setDefaultMemberPermissions(PermissionFlagsBits.ManageGuild),
      { idHints: undefined }
    );
  }

  public async chatInputList(interaction: Subcommand.ChatInputCommandInteraction) {
    return interaction.reply({ content: 'Not implemented yet', ephemeral: true });
  }

  public async chatInputSetModlog(interaction: Subcommand.ChatInputCommandInteraction) {
    return interaction.reply({ content: 'Not implemented yet', ephemeral: true });
  }

  public async chatInputSetAuditlog(interaction: Subcommand.ChatInputCommandInteraction) {
    return interaction.reply({ content: 'Not implemented yet', ephemeral: true });
  }

  public async chatInputSetWelcome(interaction: Subcommand.ChatInputCommandInteraction) {
    return interaction.reply({ content: 'Not implemented yet', ephemeral: true });
  }
}

2. Start the bot once to get the command id and replace idHints: undefined with the proper data
3. Start the bot twice more, you'll see how despite the code going unchanged the following lines are logged:

2023-11-18 23:13:35 - DEBUG - ApplicationCommandRegistry[sub] Preparing to process 1 possible command registrations / updates...
2023-11-18 23:13:35 - DEBUG - ApplicationCommandRegistry[sub] Registering id "1175559217650876477" to internal chat input map
2023-11-18 23:13:35 - DEBUG - ApplicationCommandRegistry[sub] Checking if command "sub" is identical with global chat input command with id "1175559217650876477"
2023-11-18 23:13:35 - DEBUG - ApplicationCommandRegistry[sub] Took 1ms to process differences via fast compute differences
2023-11-18 23:13:35 - DEBUG - ApplicationCommandRegistry[sub] Found differences for command "sub" (1175559217650876477) versus provided api data.
2023-11-18 23:13:36 - DEBUG - ApplicationCommandRegistry[sub] Updated command sub (1175559217650876477) with new api data

Expected behavior

The command doesn't get updated on the API side because the comparison concludes that they are identical.

Screenshots

No response

Additional context

Link to #sapphire-support thread: https://discord.com/channels/737141877803057244/1175555875180658698

_SFW-81

[favna]

Assigned @vladfrangu on this because he's the mastermind behind the deep comparison for application commands

[vladfrangu]

Closing as this is not a bug with Sapphire, but rather the description used for the command. See https://canary.discord.com/channels/737141877803057244/1175555875180658698/1175936448722116638 in the Discord server for context.