fix: Command Auto Syncing

[Icebluewolf]

Summary

This is very much a draft and needs lots of testing. I just want to put it somewhere public so that I can get eyes on it.
This is something I am not quite sure how to cleanly fix at the moment.

TODO: Change the below default if needed to use the correct default integration types and contexts

I also need to check what the behavior is for undocumented fields in the payload from discord that may be added in the future. I believe the best option is to ignore those fields.
This gist (https://gist.github.com/Icebluewolf/1842ea5f7234ba40e5df18191bb135a0) contains 2 files. The first is where I developed the fix so that I did not have to make real API calls and is here for reference if someone wants to do the same. The second is unit tests for the new system. Both are very rough and messy sorry 🙃. This change needs to be tested extensively, so if someone sees test cases I missed or more test cases that should be added please let me know.

This PR attempts to fix the long running issue with the application command auto-syncing system. Currently the system is over eager and preforms upserts on commands that do not need to be updated. The main culprit is incorrect default value checking. This PR implements a more robust and easily extendable comparison system for commands.

Information

• This PR fixes an issue.
• This PR adds something new (e.g. new method or parameters).
• This PR is a breaking change (e.g. methods or parameters removed/renamed).
• This PR is not a code change (e.g. documentation, README, typehinting,
  examples, ...).

Checklist

• I have searched the open pull requests for duplicates.
• If code changes were made then they have been tested.
  • I have updated the documentation to reflect the changes.
• If type: ignore comments were used, a comment is also left explaining why.
• I have updated the changelog to include these changes.

[pycord-app]

Thanks for opening this pull request!
Please make sure you have read the Contributing Guidelines and Code of Conduct.

This pull request can be checked-out with:

git fetch origin pull/2990/head:pr-2990
git checkout pr-2990

This pull request can be installed with:

pip install git+https://github.com/Pycord-Development/pycord@refs/pull/2990/head

[Paillat-dev]

Have had this bug where commands are not being upserted when an option goes from required to non required:

bot = discord.Bot()

my_group = bot.create_group(name="my_group")


@my_group.command(name="my_command")
async def my_command(ctx: discord.ApplicationContext):
    await ctx.respond("Hello world!")


@my_group.command(name="hello", description="Say hello to a user")
async def hello(ctx: discord.ApplicationContext, user: discord.User | None = None):
    user = user or ctx.user
    await ctx.respond(f"Hello {user.mention}!")


@my_group.command(name="hello2", description="Say hello to a user")
async def hello2(ctx: discord.ApplicationContext, user: discord.User | None = None):
    user = user or ctx.user
    await ctx.respond(f"Hello {user.mention}!")


@bot.slash_command()
async def ping(ctx: discord.ApplicationContext):
    await ctx.respond("Pong!")

# Start the bot
# -> DEBUG:discord.bot:Bulk updating commands {'my_group': 'upsert', 'ping': 'upsert'} for guild None
# /my_group hello2 requires user, /my_group hello does not
# Make /my_group hello2 user not required
# Restart the bot
# should re-sync, yet
# DEBUG:discord.bot:Skipping bulk command update: Commands are up to date

[Icebluewolf]

That was actually an issue with sub command checking. I was returning if the first sub commands was or was not the same and never checking the other sub commands. Added tests to cover this case as well now.

[Paillat-dev]

@Icebluewolf I think you forgot to push

[Lulalaby]

oh so its not me wondering where the damn commit is