feat: handle interaction errors (#336)

This PR aims to have better error handling. 

When a `ui.Modal` has an error, it will now properly respond to that
error. The `followup` section closes any open `thinking` portions.
Meaning, you can safely add in `thinking` without it stalling on an
error (message is replaced with note of something going wrong.)

That same `followup` catch is applied to the tree error handler.

For the `ui.View`, I am only informing the user that something went
wrong if the interaction was completed. This ensures that a deferred
message is responded to. But more so, that if an interaction is not
handled in 5 seconds, the built-in failure message is sent (a much
cleaner looking error message)

Ideally, this closes #150

<details><summary>Why new file for errors?</summary>
<p>

To avoid circular imports. If I put that logic in `core.py` it would
cause circular import hell.

</p>
</details> 

## Decision

I don't love the names `ErrorModal` and `ErrorView` ,,, open to much
better suggestions for names!

Author: trag1c

app/__main__.py

@@ -1,6 +1,8 @@
 import sentry_sdk
 
-from app.core import bot, config  # pyright: ignore[reportPrivateLocalImportUsage]
+# Import bot from `core` instead of `setup` as core is otherwise never loaded.
+from app.core import bot  # pyright: ignore[reportPrivateLocalImportUsage]
+from app.setup import config
 
 if config.sentry_dsn is not None:
     sentry_sdk.init(

app/common/hooks.py

@@ -7,6 +7,7 @@
 
 import discord as dc
 
+from app.errors import SafeView
 from app.utils import is_dm, is_mod, safe_edit
 
 
@@ -80,7 +81,7 @@ def is_expired(self, message: dc.Message) -> bool:
         return message.created_at < self.expiry_threshold
 
 
-class ItemActions(dc.ui.View):
+class ItemActions(SafeView):
     linker: ClassVar[MessageLinker]
     action_singular: ClassVar[str]
     action_plural: ClassVar[str]

app/components/autoclose.py

@@ -24,8 +24,12 @@ async def autoclose_solved_posts() -> None:
             continue
         one_day_ago = dt.datetime.now(tz=dt.UTC) - dt.timedelta(hours=24)
         if dc.utils.snowflake_time(post.last_message_id) < one_day_ago:
-            await post.edit(archived=True)
-            closed_posts.append(post)
+            try:
+                await post.edit(archived=True)
+                closed_posts.append(post)
+            except dc.HTTPException:
+                failures.append(post)
+                continue
 
     bot_status.last_scan_results = (
         dt.datetime.now(tz=dt.UTC),

app/components/move_message.py

@@ -15,6 +15,7 @@
     message_can_be_moved,
     move_message_via_webhook,
 )
+from app.errors import SafeModal, SafeView
 from app.setup import bot, config
 from app.utils import (
     MAX_ATTACHMENT_SIZE,
@@ -120,7 +121,7 @@
 
 
 @final
-class DeleteInstead(dc.ui.View):
+class DeleteInstead(SafeView):
     def __init__(self, message: dc.Message) -> None:
         super().__init__()
         self.message = message
@@ -237,7 +238,7 @@ async def _remove_edit_thread_after_timeout(thread: dc.Thread, author: Account)
 
 
 @final
-class SelectChannel(dc.ui.View):
+class SelectChannel(SafeView):
     def __init__(self, message: dc.Message, executor: dc.Member) -> None:
         super().__init__()
         self.message = message
@@ -283,7 +284,7 @@ async def select_channel(
 
 
 @final
-class Ghostping(dc.ui.View):
+class Ghostping(SafeView):
     def __init__(self, author: dc.Member, channel: GuildTextChannel) -> None:
         super().__init__()
         self._author = author
@@ -306,7 +307,7 @@ async def ghostping(
 
 
 @final
-class HelpPostTitle(dc.ui.Modal, title="Turn into #help post"):
+class HelpPostTitle(SafeModal, title="Turn into #help post"):
     title_ = dc.ui.TextInput[Self](
         label="#help post title", style=dc.TextStyle.short, max_length=100
     )
@@ -317,7 +318,7 @@ def __init__(self, message: dc.Message) -> None:
 
     @override
     async def on_submit(self, interaction: dc.Interaction) -> None:
-        await interaction.response.defer(ephemeral=True)
+        await interaction.response.defer(ephemeral=True, thinking=True)
 
         webhook = await get_or_create_webhook(config.help_channel)
         msg = await move_message_via_webhook(
@@ -335,7 +336,7 @@ async def on_submit(self, interaction: dc.Interaction) -> None:
 
 
 @final
-class ChooseMessageAction(dc.ui.View):
+class ChooseMessageAction(SafeView):
     thread_button: dc.ui.Button[Self]
     help_button: dc.ui.Button[Self]
 
@@ -491,7 +492,7 @@ async def show_help(self, interaction: dc.Interaction) -> None:
 
 
 @final
-class EditMessage(dc.ui.Modal, title="Edit Message"):
+class EditMessage(SafeModal, title="Edit Message"):
     new_text = dc.ui.TextInput[Self](
         label="New message content",
         style=dc.TextStyle.long,
@@ -518,7 +519,7 @@ async def on_submit(self, interaction: dc.Interaction) -> None:
 
 
 @final
-class DeleteAttachments(dc.ui.View):
+class DeleteAttachments(SafeView):
     select: dc.ui.Select[Self]
 
     def __init__(
@@ -555,7 +556,7 @@ async def remove_attachments(self, interaction: dc.Interaction) -> None:
 
 
 @final
-class CancelEditing(dc.ui.View):
+class CancelEditing(SafeView):
     def __init__(self, thread: dc.Thread) -> None:
         super().__init__()
         self._thread = thread
@@ -579,7 +580,7 @@ async def cancel_editing(
 
 
 @final
-class ContinueEditing(dc.ui.View):
+class ContinueEditing(SafeView):
     def __init__(self, thread: dc.Thread) -> None:
         super().__init__()
         self._thread = thread
@@ -605,7 +606,7 @@ async def cancel_editing(
 
 
 @final
-class SkipLargeAttachments(dc.ui.View):
+class SkipLargeAttachments(SafeView):
     def __init__(
         self, message: dc.Message, state: ThreadState, new_content: str
     ) -> None:
@@ -641,7 +642,7 @@ async def skip_large_attachments(
 
 
 @final
-class AttachmentChoice(dc.ui.View):
+class AttachmentChoice(SafeView):
     def __init__(self, message: dc.Message, state: ThreadState) -> None:
         super().__init__()
         self._message = message

app/core.py

@@ -1,13 +1,9 @@
 import asyncio
 import datetime as dt
-import sys
-from contextlib import suppress
-from typing import cast
 
 import discord as dc
 from discord.ext import commands
 from loguru import logger
-from sentry_sdk import capture_exception
 
 from app.components.activity_status import randomize_activity_status
 from app.components.autoclose import autoclose_solved_posts
@@ -46,7 +42,8 @@
     zig_codeblock_delete_hook,
     zig_codeblock_edit_hook,
 )
-from app.setup import bot, config
+from app.errors import handle_task_error
+from app.setup import bot
 from app.utils import is_dm, is_mod, try_dm
 
 TASKS = (autoclose_solved_posts, randomize_activity_status, update_recent_mentions)
@@ -70,20 +67,6 @@ async def on_ready() -> None:
     logger.info("logged in as {}", bot.user)
 
 
-@bot.event
-async def on_error(*_: object) -> None:
-    handle_error(cast("BaseException", sys.exc_info()[1]))
-
-
-@bot.tree.error
-async def on_app_command_error(interaction: dc.Interaction, error: Exception) -> None:
-    if not interaction.response.is_done():
-        await interaction.response.send_message(
-            "Something went wrong :(", ephemeral=True
-        )
-    handle_error(error)
-
-
 @bot.event
 async def on_message(message: dc.Message) -> None:
     # Ignore our own messages
@@ -156,20 +139,3 @@ async def sync(bot: commands.Bot, message: dc.Message) -> None:
     refresh_sitemap()
     await bot.tree.sync()
     await try_dm(message.author, "Command tree synced.")
-
-
-def handle_task_error(task: asyncio.Task[None]) -> None:
-    with suppress(asyncio.CancelledError):
-        if exc := task.exception():
-            handle_error(exc)
-
-
-def handle_error(error: BaseException) -> None:
-    if config.sentry_dsn is not None:
-        capture_exception(error)
-        return
-    logger.exception(error)
-    for note in getattr(error, "__notes__", []):
-        logger.error(note)
-    if isinstance(error, dc.app_commands.CommandInvokeError):
-        handle_error(error.original)

app/errors.py

@@ -0,0 +1,66 @@
+import asyncio
+import sys
+from contextlib import suppress
+from typing import Any, cast, override
+
+import discord as dc
+from loguru import logger
+from sentry_sdk import capture_exception
+
+from app.setup import bot, config
+
+
+def handle_task_error(task: asyncio.Task[None]) -> None:
+    with suppress(asyncio.CancelledError):
+        if exc := task.exception():
+            handle_error(exc)
+
+
+def handle_error(error: BaseException) -> None:
+    if config.sentry_dsn is not None:
+        capture_exception(error)
+        return
+    logger.exception(error)
+    for note in getattr(error, "__notes__", []):
+        logger.error(note)
+    if isinstance(error, dc.app_commands.CommandInvokeError):
+        handle_error(error.original)
+
+
+@bot.event
+async def on_error(*_: object) -> None:
+    handle_error(cast("BaseException", sys.exc_info()[1]))
+
+
+async def interaction_error_handler(
+    interaction: dc.Interaction, error: Exception, /
+) -> None:
+    if not interaction.response.is_done():
+        await interaction.response.send_message(
+            "Something went wrong :(", ephemeral=True
+        )
+    else:
+        await interaction.followup.send("Something went wrong :(", ephemeral=True)
+    handle_error(error)
+
+
+bot.tree.on_error = interaction_error_handler
+
+
+class SafeModal(dc.ui.Modal):
+    @override
+    async def on_error(self, interaction: dc.Interaction, error: Exception, /) -> None:
+        return await interaction_error_handler(interaction, error)
+
+
+class SafeView(dc.ui.View):
+    @override
+    async def on_error(
+        self, interaction: dc.Interaction, error: Exception, item: dc.ui.Item[Any], /
+    ) -> None:
+        if interaction.response.is_done():
+            await interaction.followup.send("Something went wrong :(", ephemeral=True)
+        # else: don't complete interaction,
+        # letting discord client send red error message
+
+        handle_error(error)