Use tasks

Author: Taaku18

CHANGELOG.md

@@ -43,6 +43,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Dynamic attribute for configs are removed, must use `config['key']` or `config.get('key')`.
 - Removed helper functions `info()` and `error()` for formatting logging, it's formatted automatically now.
 - Bumped discord.py version to 1.2.3.
+- Use discord tasks for metadata loop.
 
 # v3.0.3
 

bot.py

@@ -11,7 +11,7 @@
 from types import SimpleNamespace
 
 import discord
-from discord.ext import commands
+from discord.ext import commands, tasks
 from discord.ext.commands.view import StringView
 
 import isodate
@@ -70,6 +70,7 @@ def __init__(self):
 
         self.config = ConfigManager(self)
         self.config.populate_cache()
+
         self.threads = ThreadManager(self)
 
         self._configure_logging()
@@ -81,7 +82,8 @@ def __init__(self):
         self.db = AsyncIOMotorClient(mongo_uri).modmail_bot
         self.plugin_db = PluginDatabaseClient(self)
 
-        self.metadata_task = self.loop.create_task(self.metadata_loop())
+        self.metadata_loop = None
+
         self._load_extensions()
 
     @property
@@ -183,12 +185,6 @@ def run(self, *args, **kwargs):
         except Exception:
             logger.critical("Fatal exception", exc_info=True)
         finally:
-            try:
-                self.metadata_task.cancel()
-                self.loop.run_until_complete(self.metadata_task)
-            except asyncio.CancelledError:
-                logger.debug("metadata_task has been cancelled.")
-
             self.loop.run_until_complete(self.logout())
             for task in asyncio.all_tasks(self.loop):
                 task.cancel()
@@ -437,6 +433,19 @@ async def on_ready(self):
 
         logger.line()
 
+        self.metadata_loop = tasks.Loop(
+            self.post_metadata,
+            seconds=0,
+            minutes=0,
+            hours=1,
+            count=None,
+            reconnect=True,
+            loop=None,
+        )
+        self.metadata_loop.before_loop(self.before_post_metadata)
+        self.metadata_loop.after_loop(self.after_post_metadata)
+        self.metadata_loop.start()
+
     async def convert_emoji(self, name: str) -> str:
         ctx = SimpleNamespace(bot=self, guild=self.modmail_guild)
         converter = commands.EmojiConverter()
@@ -958,7 +967,7 @@ async def validate_database_connection(self):
         try:
             await self.db.command("buildinfo")
         except Exception as exc:
-            logger.critical("Something went wrong " "while connecting to the database.")
+            logger.critical("Something went wrong while connecting to the database.")
             message = f"{type(exc).__name__}: {str(exc)}"
             logger.critical(message)
 
@@ -981,43 +990,44 @@ async def validate_database_connection(self):
         else:
             logger.info("Successfully connected to the database.")
 
-    async def metadata_loop(self):
+    async def post_metadata(self):
+        owner = (await self.application_info()).owner
+        data = {
+            "owner_name": str(owner),
+            "owner_id": owner.id,
+            "bot_id": self.user.id,
+            "bot_name": str(self.user),
+            "avatar_url": str(self.user.avatar_url),
+            "guild_id": self.guild_id,
+            "guild_name": self.guild.name,
+            "member_count": len(self.guild.members),
+            "uptime": (datetime.utcnow() - self.start_time).total_seconds(),
+            "latency": f"{self.ws.latency * 1000:.4f}",
+            "version": self.version,
+            "selfhosted": True,
+            "last_updated": str(datetime.utcnow()),
+        }
+
+        async with self.session.post("https://api.modmail.tk/metadata", json=data):
+            logger.debug("Uploading metadata to Modmail server.")
+
+    async def before_post_metadata(self):
+        logger.info("Starting metadata loop.")
         await self.wait_for_connected()
         if not self.guild:
-            return
-
-        owner = (await self.application_info()).owner
+            self.metadata_loop.cancel()
 
-        while not self.is_closed():
-            data = {
-                "owner_name": str(owner),
-                "owner_id": owner.id,
-                "bot_id": self.user.id,
-                "bot_name": str(self.user),
-                "avatar_url": str(self.user.avatar_url),
-                "guild_id": self.guild_id,
-                "guild_name": self.guild.name,
-                "member_count": len(self.guild.members),
-                "uptime": (datetime.utcnow() - self.start_time).total_seconds(),
-                "latency": f"{self.ws.latency * 1000:.4f}",
-                "version": self.version,
-                "selfhosted": True,
-                "last_updated": str(datetime.utcnow()),
-            }
-
-            async with self.session.post("https://api.modmail.tk/metadata", json=data):
-                logger.debug("Uploading metadata to Modmail server.")
-
-            await asyncio.sleep(3600)
+    async def after_post_metadata(self):
+        logger.info("Metadata loop has been cancelled.")
 
 
 if __name__ == "__main__":
-    if os.name != "nt":
-        try:
-            import uvloop
+    try:
+        import uvloop
+
+        uvloop.install()
+    except ImportError:
+        pass
 
-            uvloop.install()
-        except ImportError:
-            pass
     bot = ModmailBot()
     bot.run()

cogs/utility.py

@@ -227,7 +227,7 @@ def cog_unload(self):
     @commands.command()
     @checks.has_permissions(PermissionLevel.REGULAR)
     @trigger_typing
-    async def changelog(self, ctx, version: str.lower = ''):
+    async def changelog(self, ctx, version: str.lower = ""):
         """Shows the changelog of the Modmail."""
         changelog = await Changelog.from_url(self.bot)
         version = version.lstrip("vV") if version else changelog.latest_version.version

core/thread.py

@@ -319,7 +319,9 @@ async def _close(
             else:
                 message = self.bot.config["thread_close_response"]
 
-        message = message.format(closer=closer, loglink=log_url, logkey=log_data["key"] if log_data else None)
+        message = message.format(
+            closer=closer, loglink=log_url, logkey=log_data["key"] if log_data else None
+        )
 
         embed.description = message
         footer = self.bot.config["thread_close_footer"]
@@ -764,9 +766,12 @@ async def find(
         if recipient is None and channel is not None:
             thread = self._find_from_channel(channel)
             if thread is None:
-                id, thread = next(((k, v) for k, v in self.cache.items() if v.channel == channel), (-1, None))
+                id, thread = next(
+                    ((k, v) for k, v in self.cache.items() if v.channel == channel),
+                    (-1, None),
+                )
                 if thread is not None:
-                    logger.debug('Found thread with tempered ID.')
+                    logger.debug("Found thread with tempered ID.")
                     await channel.edit(topic=f"User ID: {id}")
             return thread