Defering UI component interactions

[lexicalunit]

I'm playing around with the new components UI. I added a "join" and "leave" button to a message:

Then for handling clicks I am doing:

    async def on_interaction(self, interaction: discord.interactions.Interaction) -> None:
        print(interaction.data)

        if not interaction.data:
            assert False
        custom_id: Optional[str] = interaction.data.get("custom_id", None)
        if custom_id not in {"join", "leave"}:
            assert False

        try:
            await interaction.response.defer()
        except Exception as e:
            logger.exception("error: %s", e)

        join_was_clicked = custom_id == "join"
        author = interaction.user
        message = interaction.message
        guild_id = interaction.guild_id
        channel_id = interaction.channel_id
        if not author or not message or not guild_id or not channel_id:
            return

        [... process the click ...]

Now sometimes this seems to work fine. But other times I get 404 Not Found errors on the defer() call:

Traceback (most recent call last):
  File "/source/spellbot/src/spellbot/__init__.py", line 940, in on_interaction
    await interaction.response.defer()
  File "/Library/Caches/pypoetry/virtualenvs/spellbot-IQfhdu4x-py3.8/lib/python3.8/site-packages/discord/interactions.py", line 213, in defer
    await adapter.create_interaction_response(
  File "/Library/Caches/pypoetry/virtualenvs/spellbot-IQfhdu4x-py3.8/lib/python3.8/site-packages/discord/webhook/async_.py", line 183, in request
    raise NotFound(response, data)
discord.errors.NotFound: 404 Not Found (error code: 10062): Unknown interaction

Not really sure what I'm doing wrong here. 😕

[Zomatree]

Interactions only last for 15 mins before becoming invalid, make sure you are not clicking on the interaction after the 15 mins are up.

[lexicalunit]

Yeah I get 404 on the very first click of a button, directly after making the message.

[lexicalunit]

What's interesting is that everything actually works fine as long as I catch and ignore it. Like, clicking on the button triggers the on_interaction method just fine 🤷🏻‍♀️

And if I remove the await interaction.response.defer() call, I get this when clicking on a button:

So even when the defer() triggers a 404... it seems to still be working?

[lexicalunit]

I've got some more information. I enabled debug logging and found this:

[2021-05-30 08:35:27][discord.client][DEBUG] - Dispatching event socket_raw_receive
[2021-05-30 08:35:27][discord.gateway][DEBUG] - For Shard ID None: WebSocket Event: {'t': 'INTERACTION_CREATE', 's': 8, 'op': 0, 'd': {'version': 1, 'type': 3, 'token': 'aW50ZXJhY3Rpb246ODQ4NTg1NDA5MzM5MzI2NDc0OjV3VFRzaFFpZHB4andWaE1qOHBmc1NSWTZNU1E4T2t2UHR0T1laVVZocWZURWZGS0VaYXR6MzlOa3gwTjh3MHBaT3dZM3VGR3UwQzFYakp3UGdZYWJUVHUzdk1aSUhoVmhJN2NrOVRETnoyWDNUTVowOTgzY2xoaFFEUXh4SDlk', 'message': {'type': 0, 'tts': False, 'timestamp': '2021-05-30T15:34:56.864000+00:00', 'pinned': False, 'mentions': [], 'mention_roles': [], 'mention_everyone': False, 'id': '848585280671580160', 'flags': 0, 'embeds': [{'type': 'rich', 'title': '**Waiting for 3 more players to join...**', 'thumbnail': {'width': 420, 'url': 'https://raw.githubusercontent.com/lexicalunit/spellbot/master/spellbot.png?2021-05-30', 'proxy_url': 'https://images-ext-1.discordapp.net/external/TBbAofNNHJyZVypvX5xDaunwVD09GRW_d1oqoSTDWto/%3F2021-05-30/https/raw.githubusercontent.com/lexicalunit/spellbot/master/spellbot.png', 'height': 415}, 'footer': {'text': 'SpellBot Reference #SB1'}, 'fields': [{'value': '<@82174992933986304>', 'name': 'Players', 'inline': False}], 'description': '_A SpellTable link will be created when all players have joined._\n\nLooking for more players to join you? Just run `!lfg` again.', 'color': 5914365}], 'edited_timestamp': '2021-05-30T15:34:57.020000+00:00', 'content': '', 'components': [{'type': 1, 'components': [{'type': 2, 'style': 1, 'label': 'Join this game!', 'emoji': {'name': '✋'}, 'custom_id': 'join'}, {'type': 2, 'style': 2, 'label': 'Leave', 'emoji': {'name': '🚫'}, 'custom_id': 'leave'}]}], 'channel_id': '766372639526617098', 'author': {'username': 'SpellBotDev', 'public_flags': 0, 'id': '727735010114666578', 'discriminator': '5429', 'bot': True, 'avatar': 'f44b751405d41aa73a538aec6caff3bb'}, 'attachments': []}, 'member': {'user': {'username': 'lexicalunit', 'public_flags': 0, 'id': '82174992933986304', 'discriminator': '4189', 'avatar': '17fd2c1c44e90eab9059b2c3be29f79d'}, 'roles': ['702308438679486494', '728361224122662953', '817928502920740865', '837146564853366785', '837146585469157411'], 'premium_since': None, 'permissions': '17179869183', 'pending': False, 'nick': 'lexical unit', 'mute': False, 'joined_at': '2020-04-15T00:17:39.090000+00:00', 'is_pending': False, 'deaf': False, 'avatar': None}, 'id': '848585409339326474', 'guild_id': '699775410082414733', 'data': {'custom_id': 'leave', 'component_type': 2}, 'channel_id': '766372639526617098', 'application_id': '727735010114666578'}}
[2021-05-30 08:35:27][discord.client][DEBUG] - Dispatching event socket_response
[2021-05-30 08:35:27][discord.client][DEBUG] - Dispatching event interaction
{'custom_id': 'leave', 'component_type': 2}
[2021-05-30 08:35:27][discord.webhook.async_][DEBUG] - Webhook ID 848585409339326474 with POST https://discord.com/api/v8/interactions/848585409339326474/aW50ZXJhY3Rpb246ODQ4NTg1NDA5MzM5MzI2NDc0OjV3VFRzaFFpZHB4andWaE1qOHBmc1NSWTZNU1E4T2t2UHR0T1laVVZocWZURWZGS0VaYXR6MzlOa3gwTjh3MHBaT3dZM3VGR3UwQzFYakp3UGdZYWJUVHUzdk1aSUhoVmhJN2NrOVRETnoyWDNUTVowOTgzY2xoaFFEUXh4SDlk/callback has returned status code 204
[2021-05-30 08:35:27][discord.webhook.async_][DEBUG] - Webhook ID 848585409339326474 with POST https://discord.com/api/v8/interactions/848585409339326474/aW50ZXJhY3Rpb246ODQ4NTg1NDA5MzM5MzI2NDc0OjV3VFRzaFFpZHB4andWaE1qOHBmc1NSWTZNU1E4T2t2UHR0T1laVVZocWZURWZGS0VaYXR6MzlOa3gwTjh3MHBaT3dZM3VGR3UwQzFYakp3UGdZYWJUVHUzdk1aSUhoVmhJN2NrOVRETnoyWDNUTVowOTgzY2xoaFFEUXh4SDlk/callback has returned status code 404
[2021-05-30 08:35:27][spellbot][ERROR] - error: 404 Not Found (error code: 10062): Unknown interaction
Traceback (most recent call last):
  File "/source/spellbot/src/spellbot/__init__.py", line 940, in on_interaction
    await interaction.response.defer()
  File "/Library/Caches/pypoetry/virtualenvs/spellbot-IQfhdu4x-py3.8/lib/python3.8/site-packages/discord/interactions.py", line 213, in defer
    await adapter.create_interaction_response(
  File "/Library/Caches/pypoetry/virtualenvs/spellbot-IQfhdu4x-py3.8/lib/python3.8/site-packages/discord/webhook/async_.py", line 183, in request
    raise NotFound(response, data)
discord.errors.NotFound: 404 Not Found (error code: 10062): Unknown interaction

So it looks like the await interaction.response.defer() is trying to make a POST request twice. The first works, which is why removing await interaction.response.defer() breaks things. But the second request is the one that is causing the 404.

[lexicalunit]

I added some code to: /users/me/library/caches/pypoetry/virtualenvs/spellbot-iqfhdu4x-py3.8/lib/python3.8/site-packages/discord/interactions.py:

    async def defer(self, *, ephemeral: bool = False) -> None:
        print("defer called")
        [I left the rest the same]

And when I click on the button I see:

defer called
{'custom_id': 'leave', 'component_type': 2}
defer called

So it seems like the defer() is being called from somewhere unknown just before my code in on_interaction() is called. Then my code in on_interaction() does the defer() call itself, which I guess is the second time that defer() has been called for that interaction. Which causes the 404.

Am I not acknowledging the interaction correctly?

[lexicalunit]

Added a bit more logging, showing the token, just to be sure. Here's my log:

defer called for interaction: aW50ZXJhY3Rpb246ODQ4NTkxODI3NDYzNDM4MzM2OjNlT1VBSGVLVUlnUnlldUR4MFlhQUtsNFVjMDZzUVJLUGJXUUJxSDRTdHAzSW9aUUJsNEp4UUlDeWQ0akt5NmNBOXo0Zmt5RGtJTDVpZkJzZ1pva2RkcGpYeTBOcHVXSXhNRVJlQ2lLR0FJOUxsSm0xMm85RjZxa0U4Q3ROajlk

on_interaction for: aW50ZXJhY3Rpb246ODQ4NTkxODI3NDYzNDM4MzM2OjNlT1VBSGVLVUlnUnlldUR4MFlhQUtsNFVjMDZzUVJLUGJXUUJxSDRTdHAzSW9aUUJsNEp4UUlDeWQ0akt5NmNBOXo0Zmt5RGtJTDVpZkJzZ1pva2RkcGpYeTBOcHVXSXhNRVJlQ2lLR0FJOUxsSm0xMm85RjZxa0U4Q3ROajlk

calling interaction.response.defer() !

defer called for interaction: aW50ZXJhY3Rpb246ODQ4NTkxODI3NDYzNDM4MzM2OjNlT1VBSGVLVUlnUnlldUR4MFlhQUtsNFVjMDZzUVJLUGJXUUJxSDRTdHAzSW9aUUJsNEp4UUlDeWQ0akt5NmNBOXo0Zmt5RGtJTDVpZkJzZ1pva2RkcGpYeTBOcHVXSXhNRVJlQ2lLR0FJOUxsSm0xMm85RjZxa0U4Q3ROajlk

So yeah... something is calling defer() on my behalf I guess?

But if I kill my bot process, and then restart it, I am able to press the buttons and they work as intended. Without any 404. So I guess there my be some kind of state that gets blown away when the process is killed. And blowing away that state fixes things.

[lexicalunit]

Figured it out! In my View I needed to override interaction_check() such that it always returns False:

class GameUI(View):
    def __init__(self):
        super().__init__()
        self.join = Button(
            style=ButtonStyle.primary,
            label="Join this game!",
            custom_id="join",
            emoji=EMOJI_JOIN_GAME,
        )
        self.leave = Button(
            style=ButtonStyle.secondary,
            label="Leave",
            custom_id="leave",
            emoji=EMOJI_DROP_GAME,
        )
        self.children = [self.join, self.leave]

    async def interaction_check(
        self, interaction: discord.interactions.Interaction
    ) -> bool:
        return False

This prevents the View from automatically calling defer() on my behalf.

[Rapptz]

If you're using a view why are you not using the callbacks rather than using on_interaction?

[lexicalunit]

The callbacks don't seem to work anymore if the bot is killed and restarted. I also have long lived messages that stick around up to 45 minutes. In my testing the only solution that worked well for me was on_interaction().

I may also be doing something totally wrong! Not trying to say there's anything wrong with the library itself <3

[lexicalunit]

I'm only using the View because that was the only way I could figure out for getting the buttons to show up. I don't think I need any of the other stuff that View provides. I wasn't sure how to get buttons without using View.

[Rapptz]

You can add a persistent View by setting the timeout to None and then using Client.add_view to register it for dispatching.

Note that v2.0 is still in development. If you want to receive help for it and the like you might be better off joining the official server since there's more eyes looking at it. Unfortunately GitHub webhooks do not give me notifications when someone opens a discussion. I know there isn't a lot of documentation for this stuff so it's bound to be a bit confusing but that's mainly cause this is really bleeding edge development stuff.

[UltimateSppy765]

Btw why were you trying to defer a button? Is type 6 response also sent using defer?

[lexicalunit]

Cause if you don't defer it this happens:

I literally have no idea what deferment does. All I know is that you, apparently, absolutely must do it. 🤷🏻‍♀️

[Rapptz]

This isn't true.

You have a 3 second window to respond with either a send_message or an edit_message interaction response. If you think it'll take more than 3 seconds then you can defer it and do it later (using something other than interaction.response, those are single use). If you do neither of these in 3 seconds then you get that interaction failed message.

[lexicalunit]

In my code I don't do either send_message or edit_message. I just do defer and then process the request (which takes a couple milliseconds). If I don't defer, I get the interaction failure.

Edit: Ah, I do (sometimes, not always) do an edit_message but not via interaction.response. But there are still times where a user hits the button and literally all I do is defer it and never edit/send anything. In those cases the defer seems to be the thing that prevents interaction failure errors.

[UltimateSppy765]

So basically you just want to make the button do nothing but at the same time not get interaction failed?

[lexicalunit]

Yes. If the user has already joined the game then hitting "Join this game!" should have no effect. A game doesn't fire until four people have joined. So joining a game that you're already in would be a no-op. There would be no reason to edit the message in that case. Same for if a user clicks "Leave" when they're not in the game, it's a no-op.