Merge pull request #172 from kyb3r/queue

Enhance thread creation performance

Author: kyb3r

CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+# [Unreleased]
+
+### Fixed
+- `thread.create` is now synchronous so that the first message sent can be queued to be sent as soon as a thread is created. 
+    - This fixes a problem where if multiple messages are sent in quick succession, the first message sent (which triggers the thread creation) is not sent in order.
+
 # v2.13.4
 
 ### Changed
@@ -41,7 +47,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - `config del` command will now work properly on self-hosted db bots.
 
-
 # v2.12.4
 
 ### Added

core/thread.py

@@ -8,17 +8,16 @@
 from discord.ext.commands import UserInputError, CommandError
 
 from core.models import Bot, ThreadManagerABC, ThreadABC
-from core.utils import is_image_url, days, match_user_id, truncate
+from core.utils import is_image_url, days, match_user_id, truncate, ignore
 
 
 class Thread(ThreadABC):
     """Represents a discord Modmail thread"""
 
     def __init__(self, manager: 'ThreadManager',
-                 recipient: typing.Union[discord.Member, discord.User,
-                                         int],
+                 recipient: typing.Union[discord.Member, discord.User, int],
                  channel: typing.Union[discord.DMChannel,
-                                       discord.TextChannel]):
+                                       discord.TextChannel] = None):
         self.manager = manager
         self.bot = manager.bot
         if isinstance(recipient, int):
@@ -72,6 +71,75 @@ def ready(self, flag):
         else:
             self._ready_event.clear()
 
+    async def setup(self, *, creator=None, category=None):
+        """Create the thread channel and other io related initialisation tasks"""
+
+        recipient = self.recipient
+
+        # in case it creates a channel outside of category
+        overwrites = {
+            self.bot.modmail_guild.default_role:
+                discord.PermissionOverwrite(read_messages=False)
+        }
+
+        category = category or self.bot.main_category
+
+        if category is not None:
+            overwrites = None
+
+        channel = await self.bot.modmail_guild.create_text_channel(
+            name=self.manager._format_channel_name(recipient),
+            category=category,
+            overwrites=overwrites,
+            reason='Creating a thread channel'
+        )
+
+        self._channel = channel
+
+        log_url, log_data = await asyncio.gather(
+            self.bot.api.create_log_entry(recipient, channel,
+                                          creator or recipient),
+            self.bot.api.get_user_logs(recipient.id)
+        )
+
+        log_count = sum(1 for log in log_data if not log['open'])
+        info_embed = self.manager._format_info_embed(recipient, log_url,
+                                                     log_count,
+                                                     discord.Color.green())
+
+        topic = f'User ID: {recipient.id}'
+        if creator:
+            mention = None
+        else:
+            mention = self.bot.config.get('mention', '@here')
+
+        _, msg = await asyncio.gather(
+            channel.edit(topic=topic),
+            channel.send(mention, embed=info_embed)
+        )
+
+        self.ready = True
+
+        # Once thread is ready, tell the recipient.
+        thread_creation_response = self.bot.config.get(
+            'thread_creation_response',
+            'The moderation team will get back to you as soon as possible!'
+        )
+
+        embed = discord.Embed(
+            color=self.bot.mod_color,
+            description=thread_creation_response,
+            timestamp=datetime.utcnow(),
+        )
+        embed.set_footer(text='Your message has been sent',
+                         icon_url=self.bot.guild.icon_url)
+        embed.set_author(name='Thread Created')
+
+        if creator is None:
+            self.bot.loop.create_task(recipient.send(embed=embed))
+
+        await msg.pin()
+
     def _close_after(self, closer, silent, delete_channel, message):
         return self.bot.loop.create_task(
             self._close(closer, silent, delete_channel, message, True)
@@ -144,7 +212,7 @@ async def _close(self, closer, silent=False, delete_channel=True,
                 sneak_peak = 'No content'
 
             desc = f"[`{log_data['key']}`]({log_url}): "
-            desc += truncate(sneak_peak, max=75-13)
+            desc += truncate(sneak_peak, max=75 - 13)
         else:
             desc = "Could not resolve log url."
 
@@ -231,33 +299,45 @@ async def reply(self, message, anonymous=False):
         if not message.content and not message.attachments:
             raise UserInputError
         if all(not g.get_member(self.id) for g in self.bot.guilds):
-            await message.channel.send(
+            return await message.channel.send(
                 embed=discord.Embed(
                     color=discord.Color.red(),
-                    description='This user shares no servers with '
-                                'me and is thus unreachable.'
+                    description='Your message could not be delivered since'
+                                'the recipient shares no servers with the bot'
+                ))
+
+        tasks = []
+
+        try:
+            await self.send(message,
+                            destination=self.recipient,
+                            from_mod=True,
+                            anonymous=anonymous)
+        except Exception as e:
+            print(e)
+            tasks.append(message.channel.send(
+                embed=discord.Embed(
+                    color=discord.Color.red(),
+                    description='Your message could not be delivered because '
+                                'the recipient is only accepting direct '
+                                'messages from friends, or the bot was '
+                                'blocked by the recipient.'
                 )
+            ))
+        else:
+            # Send the same thing in the thread channel.
+            tasks.append(
+                self.send(message,
+                          destination=self.channel,
+                          from_mod=True,
+                          anonymous=anonymous)
             )
-            return
 
-        tasks = [
-            # in thread channel
-            self.send(message,
-                      destination=self.channel,
-                      from_mod=True,
-                      anonymous=anonymous),
-            # to user
-            self.send(message,
-                      destination=self.recipient,
-                      from_mod=True,
-                      anonymous=anonymous)
-        ]
-
-        await self.bot.api.append_log(
-            message,
-            self.channel.id,
-            type_='anonymous' if anonymous else 'thread_message'
-        )
+            tasks.append(
+                self.bot.api.append_log(message,
+                                        self.channel.id,
+                                        type_='anonymous' if anonymous else 'thread_message'
+                                        ))
 
         if self.close_task is not None:
             # cancel closing if a thread message is sent.
@@ -277,14 +357,18 @@ async def send(self, message, destination=None,
                    from_mod=False, note=False, anonymous=False):
         if self.close_task is not None:
             # cancel closing if a thread message is sent.
-            await self.cancel_closure()
-            await self.channel.send(embed=discord.Embed(
-                color=discord.Color.red(),
-                description='Scheduled close has been cancelled.'
-            ))
+            tasks = asyncio.gather(
+                self.cancel_closure(),
+                self.channel.send(embed=discord.Embed(
+                    color=discord.Color.red(),
+                    description='Scheduled close has been cancelled.'
+                )))
+            self.bot.loop.create_task(tasks)
 
         if not from_mod and not note:
-            await self.bot.api.append_log(message, self.channel.id)
+            self.bot.loop.create_task(
+                self.bot.api.append_log(message, self.channel.id)
+            )
 
         if not self.ready:
             await self.wait_until_ready()
@@ -410,17 +494,13 @@ async def send(self, message, destination=None,
             mentions = None
 
         await destination.send(mentions, embed=embed)
-
         if additional_images:
-            self.ready = False
-            await asyncio.gather(*additional_images)
             self.ready = True
+            await asyncio.gather(*additional_images)
+            self.ready = False
 
         if delete_message:
-            try:
-                await message.delete()
-            except discord.HTTPException:
-                pass
+            self.bot.loop.create_task(ignore(message.delete()))
 
     def get_notifications(self):
         config = self.bot.config
@@ -519,75 +599,21 @@ async def _find_from_channel(self, channel):
 
             return thread
 
-    async def create(self, recipient, *, creator=None, category=None):
+    def create(self, recipient, *, creator=None, category=None):
         """Creates a Modmail thread"""
-
-        thread_creation_response = self.bot.config.get(
-            'thread_creation_response',
-            'The moderation team will get back to you as soon as possible!'
-        )
-
-        embed = discord.Embed(
-            color=self.bot.mod_color,
-            description=thread_creation_response,
-            timestamp=datetime.utcnow(),
-        )
-        embed.set_footer(text='Your message has been sent',
-                         icon_url=self.bot.guild.icon_url)
-        embed.set_author(name='Thread Created')
-
-        if creator is None:
-            self.bot.loop.create_task(recipient.send(embed=embed))
-
-        # in case it creates a channel outside of category
-        overwrites = {
-            self.bot.modmail_guild.default_role:
-                discord.PermissionOverwrite(read_messages=False)
-        }
-
-        category = category or self.bot.main_category
-
-        if category is not None:
-            overwrites = None
-
-        channel = await self.bot.modmail_guild.create_text_channel(
-            name=self._format_channel_name(recipient),
-            category=category,
-            overwrites=overwrites,
-            reason='Creating a thread channel'
-        )
-
-        thread = Thread(self, recipient, channel)
+        # create thread immediately so messages can be processed
+        thread = Thread(self, recipient)
         self.cache[recipient.id] = thread
 
-        log_url, log_data = await asyncio.gather(
-            self.bot.api.create_log_entry(recipient, channel,
-                                          creator or recipient),
-            self.bot.api.get_user_logs(recipient.id)
-        )
-
-        log_count = sum(1 for log in log_data if not log['open'])
-        info_embed = self._format_info_embed(recipient, log_url, log_count,
-                                             discord.Color.green())
-
-        topic = f'User ID: {recipient.id}'
-        if creator:
-            mention = None
-        else:
-            mention = self.bot.config.get('mention', '@here')
-
-        _, msg = await asyncio.gather(
-            channel.edit(topic=topic),
-            channel.send(mention, embed=info_embed)
-        )
-
-        thread.ready = True
-        await msg.pin()
+        # Schedule thread setup for later
+        self.bot.loop.create_task(thread.setup(
+            creator=creator,
+            category=category
+        ))
         return thread
 
     async def find_or_create(self, recipient):
-        return await self.find(recipient=recipient) or \
-               await self.create(recipient)
+        return await self.find(recipient=recipient) or self.create(recipient)
 
     def _format_channel_name(self, author):
         """Sanitises a username for use with text channel names"""

core/utils.py

@@ -185,3 +185,10 @@ def match_user_id(text: str) -> int:
     if match is not None:
         return int(match.group(1))
     return -1
+
+
+async def ignore(coro):
+    try:
+        await coro
+    except Exception:
+        pass