【Discord API】Interactionの応答のタイムアウトを考えて実装する（pycord使用）

はじまり#

リサちゃん

あ〜、ガッデムガッデム〜〜

135ml

どうしたんだ？

何が起こっているんだ#

pycordで実装したボタンを押したときに「インタラクションに失敗しました」と出る。 Discord APIの仕様でタイムアウトになっているっぽいです。

再現したソース：その1#

まず、再現した環境は、ubuntu：20.04.3、Python：3.8.10、py-cord：2.0.0b1です。

先程のエラーが再現したコードは以下になります。await interaction.response.edit_messageの部分で起きます。

src/helpers.py:

1
class ButtonView(View):
2
    def __init__(self, viewKey : str, msg : str, bot : discord.Bot):
3
        super().__init__()
4
        if viewKey == "viewForReply_buttons01":
5
            buttonList = self.getButtonList(msg, bot)
6
            for item in buttonList:
7
                self.add_item(item)
8

9
    def getButtonList(self, msg : str, bot : discord.Bot):
10
        gofer = Gofer()
11
        configFileFullName = gofer.getSrcPathFromTestPath(configFileName)
12
        configObj = gofer.getObjFromYaml(configFileFullName)
13
        buttonYes = YesButton(
14
            label=configObj["viewForReply_buttons01_yes"],
15
            style=discord.ButtonStyle.primary,
16
            msg=msg,
17
            bot=bot
18
        )
19
        buttonNo = NoButton(
20
            label=configObj["viewForReply_buttons01_no"],
21
            style=discord.ButtonStyle.secondary
22
        )
23
        return [buttonYes, buttonNo]
24

25
class YesButton(Button):
26
    def __init__(self, label : str, style, msg : str, bot : discord.Bot):
27
        super().__init__(label=label, style=style)
28
        self._registeringMsg = msg
29
        self._bot = bot
30

31
    async def callback(self, interaction: discord.Interaction):
32
        gofer = Gofer()
33
        configFileFullName = gofer.getSrcPathFromTestPath(configFileName)
34
        configObj = gofer.getObjFromYaml(configFileFullName)
35

36
        judge = Judge()
37
        jsonKeyFleName = gofer.getSrcPathFromTestPath(configObj["jsonKeyFleName"])
38
        worksheet = judge.authorizeGSSToGetWorksheet(
39
            jsonKeyFleName,
40
            configObj["gssId"],
41
            configObj["sheetName"]
42
        )
43
        sheetEditor = SheetEditor()
44
        # Googleスプレッドシートを編集する
45
        sheetEditor.writeInfoToGss(worksheet, self._registeringMsg)
46
        await interaction.response.edit_message(
47
            content="{}\n{}".format(
48
                configObj["msgForReply_urlYet"],
49
                configObj["viewForReply_buttons01_registered"]
50
            ),
51
            view=None
52
        )

エラーメッセージはこんな感じ。

1
Ignoring exception in view <ButtonView timeout=180.0 children=2> for item <YesButton style=<ButtonStyle.primary: 1> url=None disabled=False label='よろしく' emoji=None row=None>:
2
Traceback (most recent call last):
3
  File "/usr/local/lib/python3.8/dist-packages/discord/ui/view.py", line 365, in _scheduled_task
4
    await item.callback(interaction)
5
  File "/usr/src/app/src/helpers.py", line 79, in callback
6
    await interaction.response.edit_message(
7
  File "/usr/local/lib/python3.8/dist-packages/discord/interactions.py", line 721, in edit_message
8
    await adapter.create_interaction_response(
9
  File "/usr/local/lib/python3.8/dist-packages/discord/webhook/async_.py", line 192, in request
10
    raise NotFound(response, data)
11
discord.errors.NotFound: 404 Not Found (error code: 10062): Unknown interaction

再現したソース：その2#

そして、以下のソースでも同じことが起きます。

src/helpers.py:

1
class ButtonView(View):
2
    def __init__(self, viewKey : str, msg : str, bot : discord.Bot):
3
        super().__init__()
4
        if viewKey == "viewForReply_buttons01":
5
            buttonList = self.getButtonList(msg, bot)
6
            for item in buttonList:
7
                self.add_item(item)
8

9
    def getButtonList(self, msg : str, bot : discord.Bot):
10
        gofer = Gofer()
11
        configFileFullName = gofer.getSrcPathFromTestPath(configFileName)
12
        configObj = gofer.getObjFromYaml(configFileFullName)
13
        buttonYes = YesButton(
14
            label=configObj["viewForReply_buttons01_yes"],
15
            style=discord.ButtonStyle.primary,
16
            msg=msg,
17
            bot=bot
18
        )
19
        buttonNo = NoButton(
20
            label=configObj["viewForReply_buttons01_no"],
21
            style=discord.ButtonStyle.secondary
22
        )
23
        return [buttonYes, buttonNo]
24

25
class YesButton(Button):
26
    def __init__(self, label : str, style, msg : str, bot : discord.Bot):
27
        super().__init__(label=label, style=style)
28
        self._registeringMsg = msg
29
        self._bot = bot
30

31
    async def callback(self, interaction: discord.Interaction):
32
        gofer = Gofer()
33
        configFileFullName = gofer.getSrcPathFromTestPath(configFileName)
34
        configObj = gofer.getObjFromYaml(configFileFullName)
35

36
        judge = Judge()
37
        jsonKeyFleName = gofer.getSrcPathFromTestPath(configObj["jsonKeyFleName"])
38
        worksheet = judge.authorizeGSSToGetWorksheet(
39
            jsonKeyFleName,
40
            configObj["gssId"],
41
            configObj["sheetName"]
42
        )
43
        sheetEditor = SheetEditor()
44
        # Googleスプレッドシートを編集する→sleepに置き換え
45
        time.sleep(3)
46
        await interaction.response.edit_message(
47
            content="{}\n{}".format(
48
                configObj["msgForReply_urlYet"],
49
                configObj["viewForReply_buttons01_registered"]
50
            ),
51
            view=None
52
        )

原因はどうやらタイムアウトみたい#

その2のソースで再現したので、どうやらinteractionがtimeoutしたことが原因だと思われます。

実際に何秒でタイムアウトするのかは分からなかったのですが、時間がかかる処理を排除して再度実行したら再現しませんでした。

試してみたこと1：botにwait_forさせている間に処理をさせる#

最初に試してみたのが、discord.Bot型で生成したインスタンスをYesButtonクラスに持ってきて、wait_forさせる方法です。wait_forしている間に、時間がかかる処理を行わせようと考えたのです。

しかし、以下のソースで実行しましたが、「Interaction failed」になってしまい、wait_forの結果はasyncio.exceptions.TimeoutErrorが出ました。

Interactionとbotは、特に噛み合っているわけではないようです。

src/helpers.py:

1
class ButtonView(View):
2
    def __init__(self, viewKey : str, msg : str, bot : discord.Bot):
3
        super().__init__()
4
        if viewKey == "viewForReply_buttons01":
5
            buttonList = self.getButtonList(msg, bot)
6
            for item in buttonList:
7
                self.add_item(item)
8

9
    def getButtonList(self, msg : str, bot : discord.Bot):
10
        gofer = Gofer()
11
        configFileFullName = gofer.getSrcPathFromTestPath(configFileName)
12
        configObj = gofer.getObjFromYaml(configFileFullName)
13
        buttonYes = YesButton(
14
            label=configObj["viewForReply_buttons01_yes"],
15
            style=discord.ButtonStyle.primary,
16
            msg=msg,
17
            bot=bot
18
        )
19
        buttonNo = NoButton(
20
            label=configObj["viewForReply_buttons01_no"],
21
            style=discord.ButtonStyle.secondary
22
        )
23
        return [buttonYes, buttonNo]
24

25
class YesButton(Button):
26
    def __init__(self, label : str, style, msg : str, bot : discord.Bot):
27
        super().__init__(label=label, style=style)
28
        self._registeringMsg = msg
29
        self._bot = bot
30

31
    async def callback(self, interaction: discord.Interaction):
32
        gofer = Gofer()
33
        configFileFullName = gofer.getSrcPathFromTestPath(configFileName)
34
        configObj = gofer.getObjFromYaml(configFileFullName)
35

36
        judge = Judge()
37
        jsonKeyFleName = gofer.getSrcPathFromTestPath(configObj["jsonKeyFleName"])
38
        worksheet = judge.authorizeGSSToGetWorksheet(
39
            jsonKeyFleName,
40
            configObj["gssId"],
41
            configObj["sheetName"]
42
        )
43
        sheetEditor = SheetEditor()
44
        # Googleスプレッドシートを編集する
45
        # sheetEditor.writeInfoToGss(worksheet, self._registeringMsg)
46
        time.sleep(3)
47
        # wait_for処理
48
        testMsg = await self._bot.wait_for('message', check=None, timeout=5)
49

50
        await interaction.response.edit_message(
51
            content="{}\n{}".format(
52
                configObj["msgForReply_urlYet"],
53
                configObj["viewForReply_buttons01_registered"]
54
            ),
55
            view=None
56
        )

試してみたこと2：viewのtimeout値を設定する#

次に試したことは、viewのtimeout値を大きい数値で記述することです。

以下のようなソースです。これも効果はありませんでした・・・

1
class ButtonView(View):
2
    def __init__(self, viewKey : str, msg : str):
3
        super().__init__(timeout=100)
4
        if viewKey == "viewForReply_buttons01":
5
            buttonList = self.getButtonList(msg)
6
            for item in buttonList:
7
                self.add_item(item)
8

9
    def getButtonList(self, msg : str):
10
        gofer = Gofer()
11
        configFileFullName = gofer.getSrcPathFromTestPath(configFileName)
12
        configObj = gofer.getObjFromYaml(configFileFullName)
13
        buttonYes = YesButton(
14
            label=configObj["viewForReply_buttons01_yes"],
15
            style=discord.ButtonStyle.primary,
16
            msg=msg
17
        )
18
        buttonNo = NoButton(
19
            label=configObj["viewForReply_buttons01_no"],
20
            style=discord.ButtonStyle.secondary
21
        )
22
        return [buttonYes, buttonNo]
23

24
class YesButton(Button):
25
    def __init__(self, label : str, style, msg : str):
26
        super().__init__(label=label, style=style)
27
        self._registeringMsg = msg
28

29
    async def callback(self, interaction: discord.Interaction):
30
        gofer = Gofer()
31
        configFileFullName = gofer.getSrcPathFromTestPath(configFileName)
32
        configObj = gofer.getObjFromYaml(configFileFullName)
33

34
        judge = Judge()
35
        jsonKeyFleName = gofer.getSrcPathFromTestPath(configObj["jsonKeyFleName"])
36
        worksheet = judge.authorizeGSSToGetWorksheet(
37
            jsonKeyFleName,
38
            configObj["gssId"],
39
            configObj["sheetName"]
40
        )
41
        # Googleスプレッドシートを編集する
42
        # sheetEditor.writeInfoToGss(worksheet, self._registeringMsg)
43

44
        sheetEditor = SheetEditor()
45
        sheetEditor.writeInfoToGss(worksheet, self._registeringMsg)
46
        await interaction.response.edit_message(
47
            content="{}\n{}".format(
48
                configObj["msgForReply_urlYet"],
49
                configObj["viewForReply_buttons01_registered"]
50
            ),
51
            view=None
52
        )

解消したこと：interactionへの反応後に、時間がかかる処理を行う#

結局、この方法に落ち着きました。反応した際にはまだ目的の処理は行っておらず、反応した後に行わせました。

イメージとしては、お母さんに「食器運んでおいてー！」と言われて、「はーい！」と返事して１分くらい経ったら運ぶ。みたいな感じです。

src/helpers.py:

1
class ButtonView(View):
2
    def __init__(self, viewKey : str, msg : str, bot : discord.Bot):
3
        super().__init__()
4
        if viewKey == "viewForReply_buttons01":
5
            buttonList = self.getButtonList(msg, bot)
6
            for item in buttonList:
7
                self.add_item(item)
8

9
    def getButtonList(self, msg : str, bot : discord.Bot):
10
        gofer = Gofer()
11
        configFileFullName = gofer.getSrcPathFromTestPath(configFileName)
12
        configObj = gofer.getObjFromYaml(configFileFullName)
13
        buttonYes = YesButton(
14
            label=configObj["viewForReply_buttons01_yes"],
15
            style=discord.ButtonStyle.primary,
16
            msg=msg,
17
            bot=bot
18
        )
19
        buttonNo = NoButton(
20
            label=configObj["viewForReply_buttons01_no"],
21
            style=discord.ButtonStyle.secondary
22
        )
23
        return [buttonYes, buttonNo]
24

25
class YesButton(Button):
26
    def __init__(self, label : str, style, msg : str, bot : discord.Bot):
27
        super().__init__(label=label, style=style)
28
        self._registeringMsg = msg
29
        self._bot = bot
30

31
    async def callback(self, interaction: discord.Interaction):
32
        gofer = Gofer()
33
        configFileFullName = gofer.getSrcPathFromTestPath(configFileName)
34
        configObj = gofer.getObjFromYaml(configFileFullName)
35

36
        judge = Judge()
37
        jsonKeyFleName = gofer.getSrcPathFromTestPath(configObj["jsonKeyFleName"])
38
        worksheet = judge.authorizeGSSToGetWorksheet(
39
            jsonKeyFleName,
40
            configObj["gssId"],
41
            configObj["sheetName"]
42
        )
43
        sheetEditor = SheetEditor()
44

45
        # Googleスプレッドシートを編集する
46
        # sheetEditor.writeInfoToGss(worksheet, self._registeringMsg)
47
        # time.sleep(3)
48
        # testMsg = await self._bot.wait_for('message', check=None, timeout=5)
49

50
        await interaction.response.edit_message(
51
            content="{}\n{}".format(
52
                configObj["msgForReply_urlYet"],
53
                configObj["viewForReply_buttons01_registered"]
54
            ),
55
            view=None
56
        )
57
        # 「Googleスプレッドシートを編集する」をこちらに移動
58
        sheetEditor.writeInfoToGss(worksheet, self._registeringMsg)

「インタラクションに失敗しました」エラーは発生しませんでした。

おしまい#

リサちゃん

まあ、仕様っぽいから仕様がないねえ・・・

135ml

上手く避けよう・・・。

以上になります！

音楽

音楽

はじまり#

何が起こっているんだ#

再現したソース：その1#

再現したソース：その2#

原因はどうやらタイムアウトみたい#

試してみたこと1：botにwait_forさせている間に処理をさせる#

試してみたこと2：viewのtimeout値を設定する#

解消したこと：interactionへの反応後に、時間がかかる処理を行う#

おしまい#

記事を共有

音楽

目次