feat: custom message_filter_passed dispatch (#416)

Author: trag1c

app/bot.py

@@ -171,23 +171,15 @@ def is_ghostty_mod(self, user: Account) -> bool:
         member = self.ghostty_guild.get_member(user.id)
         return member is not None and is_mod(member)
 
-    def fails_message_filters(self, message: dc.Message) -> bool:
+    def _fails_message_filters(self, message: dc.Message) -> bool:
         # This can't be the MessageFilter cog type because that would cause an import
         # cycle.
         message_filter: Any = self.get_cog("MessageFilter")
         return message_filter and message_filter.check(message)
 
-    def on_message_preconditions_fail(self, message: dc.Message) -> bool:
-        return (
-            message.author.bot
-            or message.type not in REGULAR_MESSAGE_TYPES
-            or self.fails_message_filters(message)
-        )
-
     @override
     async def on_message(self, message: dc.Message, /) -> None:
-        # Ignore our own messages
-        if message.author == self.user:
+        if message.author.bot or message.type not in REGULAR_MESSAGE_TYPES:
             return
 
         # Simple test
@@ -196,11 +188,8 @@ async def on_message(self, message: dc.Message, /) -> None:
             await try_dm(message.author, "pong")
             return
 
-        # Don't continue if the message would be deleted by a message filter.
-        if self.fails_message_filters(message):
-            return
-
-        await self.process_commands(message)
+        if not self._fails_message_filters(message):
+            self.dispatch("message_filter_passed", message)
 
     @classmethod
     def get_component_extension_names(cls) -> frozenset[str]:

app/common/linker.py

@@ -121,6 +121,9 @@ async def edit(  # noqa: PLR0913
         view_type: Callable[[dc.Message, int], dc.ui.View],
         view_timeout: float = 30.0,
     ) -> None:
+        if before.author.bot:
+            logger.trace("ignoring bot message edit")
+            return
         if before.content == after.content:
             logger.trace("content did not change")
             return

app/components/developer.py

@@ -32,14 +32,13 @@ async def existing_extension_autocomplete(
             ),
         )
 
-    @commands.Cog.listener()
-    async def on_message(self, message: dc.Message) -> None:
+    @commands.Cog.listener("on_message_filter_passed")
+    async def sync_handler(self, message: dc.Message) -> None:
         # Handle !sync command. This can't be a slash command because this command is
-        # the one that actually adds the slash commands in the first place.
-        if (
-            self.bot.on_message_preconditions_fail(message)
-            or message.content.strip() != "!sync"
-        ):
+        # the one that actually adds the slash commands in the first place. This does
+        # not use discord.py's command framework because the bot only supports slash
+        # commands.
+        if message.content.strip() != "!sync":
             return
 
         if not self.bot.is_ghostty_mod(message.author):

app/components/fixup_embeds.py

@@ -88,9 +88,7 @@ async def process(self, message: dc.Message) -> ProcessedMessage:
         )
 
     @commands.Cog.listener()
-    async def on_message(self, message: dc.Message) -> None:
-        if self.bot.on_message_preconditions_fail(message):
-            return
+    async def on_message_filter_passed(self, message: dc.Message) -> None:
         output = await self.process(message)
         if not output.item_count:
             return
@@ -117,7 +115,7 @@ async def on_message_edit(self, before: dc.Message, after: dc.Message) -> None:
             before,
             after,
             message_processor=self.process,
-            interactor=self.on_message,
+            interactor=self.on_message_filter_passed,
             view_type=FixUpActions,
         )
 

app/components/github_integration/code_links.py

@@ -174,10 +174,8 @@ async def process(self, message: dc.Message) -> ProcessedMessage:
             blobs.append("-# Some snippets were omitted")
         return ProcessedMessage(content="\n".join(blobs), item_count=len(snippets))
 
-    @commands.Cog.listener("on_message")
+    @commands.Cog.listener("on_message_filter_passed")
     async def reply_with_code(self, message: dc.Message) -> None:
-        if self.bot.on_message_preconditions_fail(message):
-            return
         output = await self.process(message)
         if output.item_count != 0:
             await message.edit(suppress=True)

app/components/github_integration/comments/integration.py

@@ -76,10 +76,8 @@ def comment_to_embed(self, comment: Comment) -> dc.Embed:
             )
         return embed
 
-    @commands.Cog.listener("on_message")
+    @commands.Cog.listener("on_message_filter_passed")
     async def reply_with_comments(self, message: dc.Message) -> None:
-        if self.bot.on_message_preconditions_fail(message):
-            return
         embeds = [
             self.comment_to_embed(comment)
             async for comment in get_comments(message.content)

app/components/github_integration/commit_links.py

@@ -125,10 +125,8 @@ async def process(self, message: dc.Message) -> ProcessedMessage:
         content = "\n\n".join(map(self._format, valid_shas))
         return ProcessedMessage(item_count=len(valid_shas), content=content)
 
-    @commands.Cog.listener("on_message")
+    @commands.Cog.listener("on_message_filter_passed")
     async def reply_with_commit_details(self, message: dc.Message) -> None:
-        if self.bot.on_message_preconditions_fail(message):
-            return
         output = await self.process(message)
         if not output.item_count:
             return

app/components/github_integration/entities/integration.py

@@ -78,11 +78,9 @@ async def update_recent_mentions(self) -> None:
     async def before_update_recent_mentions(self) -> None:
         await self.bot.wait_until_ready()
 
-    @commands.Cog.listener("on_message")
+    @commands.Cog.listener("on_message_filter_passed")
     async def reply_with_entities(self, message: dc.Message) -> None:
-        if self.bot.on_message_preconditions_fail(message) or not ENTITY_REGEX.search(
-            message.content
-        ):
+        if not ENTITY_REGEX.search(message.content):
             return
 
         if is_dm(message.author):

app/components/xkcd_mentions.py

@@ -139,10 +139,8 @@ async def process(self, message: dc.Message) -> ProcessedMessage:
             embeds = [*embeds[:9], omitted]
         return ProcessedMessage(embeds=embeds, item_count=len(embeds))
 
-    @commands.Cog.listener("on_message")
+    @commands.Cog.listener("on_message_filter_passed")
     async def handle_mentions(self, message: dc.Message) -> None:
-        if self.bot.on_message_preconditions_fail(message):
-            return
         output = await self.process(message)
         if output.item_count < 1:
             return

app/components/zig_codeblocks.py

@@ -205,10 +205,8 @@ async def process(self, message: dc.Message) -> ProcessedMessage:
             item_count=len(highlighted_codeblocks) + len(attachments),
         )
 
-    @commands.Cog.listener("on_message")
+    @commands.Cog.listener("on_message_filter_passed")
     async def check_for_zig_code(self, message: dc.Message) -> None:
-        if self.bot.on_message_preconditions_fail(message):
-            return
         output = await self.process(message)
         if not output.item_count:
             return