Move plugins to use cog_load for startup

Author: ChrisLovering

ban_appeals/ban_appeals.py

@@ -9,7 +9,7 @@
 from core import checks
 from core.models import PermissionLevel, getLogger
 from core.thread import Thread
-from .utils import async_tasks, get_or_fetch
+from .utils import get_or_fetch
 
 PYDIS_NO_KICK_ROLE_IDS = (
     267627879762755584,  # Owners in PyDis
@@ -41,12 +41,10 @@ def __init__(self, bot: ModmailBot):
 
         self.db = self.bot.plugin_db.get_partition(self)
 
-        self.init_task = async_tasks.create_task(self.init_plugin(), self.bot.loop)
-
         self.user_locks: weakref.WeakValueDictionary[int, asyncio.Lock] = weakref.WeakValueDictionary()
         self.ignore_next_remove_event: set[int] = set()
 
-    async def init_plugin(self) -> None:
+    async def cog_load(self) -> None:
         """Initialise the plugin's configuration."""
         self.pydis_guild = self.bot.guild
         self.appeals_guild = self.bot.get_guild(APPEAL_GUILD_ID)
@@ -58,10 +56,11 @@ async def init_plugin(self) -> None:
         self.logs_channel = discord.utils.get(self.appeals_guild.channels, name="logs")
 
         log.info("Plugin loaded, checking if there are people to kick.")
-        await self._sync_kicks()
+        await asyncio.create_task(self._sync_kicks())
 
     async def _sync_kicks(self) -> None:
         """Iter through all members in appeals guild, kick them if they meet criteria."""
+        await asyncio.sleep(5)
         for member in self.appeals_guild.members:
             await self._maybe_kick_user(member)
 
@@ -127,8 +126,6 @@ async def _handle_join(self, member: discord.Member) -> None:
         If a member rejoins while appealing, it's notified in their
         thread.
         """
-        await self.init_task
-
         if member.guild == self.pydis_guild:
             # Join event from PyDis
             # Kick them from appeals guild now they're back in PyDis
@@ -175,8 +172,6 @@ async def _handle_remove(self, member: discord.Member) -> None:
 
         An embed is sent in the thread once they leave.
         """
-        await self.init_task
-
         if not member.guild == self.appeals_guild:
             return
 
@@ -230,7 +225,6 @@ async def appeal_category_management(self, ctx: commands.Context) -> None:
     @appeal_category_management.command(name="get")
     async def get_categories(self, ctx: commands.Context) -> None:
         """Get the list of appeal categories of commands for managing appeal categories."""
-        await self.init_task
         category_str = ", ".join(map(str, self.appeal_categories)) if self.appeal_categories else "None"
 
         await ctx.send(f"Currently configured appeal categories are: {category_str}")
@@ -239,8 +233,6 @@ async def get_categories(self, ctx: commands.Context) -> None:
     @appeal_category_management.command(name="add")
     async def add_category(self, ctx: commands.Context, appeal_category: discord.CategoryChannel) -> None:
         """Add a category to the list of ignored categories."""
-        await self.init_task
-
         if appeal_category.id in self.appeal_categories:
             await ctx.send(f":x: {appeal_category} already in the appeal category list.")
             return
@@ -258,8 +250,6 @@ async def add_category(self, ctx: commands.Context, appeal_category: discord.Cat
     @appeal_category_management.command(name="delete", aliases=("remove", "del", "rem"))
     async def del_category(self, ctx: commands.Context, category_to_remove: discord.CategoryChannel) -> None:
         """Remove a category from the list of appeal categories."""
-        await self.init_task
-
         if category_to_remove.id not in self.appeal_categories:
             await ctx.send(f":x: {category_to_remove} isn't in the appeal categories list.")
             return
@@ -282,8 +272,6 @@ async def get_useable_appeal_category(self) -> t.Optional[discord.CategoryChanne
     @commands.Cog.listener()
     async def on_thread_ready(self, thread: Thread, *args) -> None:
         """If the new thread is for an appeal, move it to the appeals category."""
-        await self.init_task
-
         if await self._is_banned_pydis(thread.recipient):
             category = await self.get_useable_appeal_category()
             if category:

ping_manager/ping_manager.py

@@ -10,7 +10,6 @@
 from core import checks
 from core.models import PermissionLevel, getLogger
 from core.thread import Thread
-from .utils import async_tasks
 
 # Remove view perms from this role while pining, so only on-duty mods get the ping.
 MOD_TEAM_ROLE_ID = 267629731250176001
@@ -49,9 +48,7 @@ def __init__(self, bot: ModmailBot):
         self.ping_tasks: list[PingTask] = None
         self.db = bot.api.get_plugin_partition(self)
 
-        self.init_task = async_tasks.create_task(self.init_plugin(), self.bot.loop)
-
-    async def init_plugin(self) -> None:
+    async def cog_load(self) -> None:
         """Fetch the current config from the db."""
         db_config = await self.db.find_one({"_id": "ping-delay-config"})
         db_config = db_config or {}
@@ -66,7 +63,7 @@ async def init_plugin(self) -> None:
         log.info("Loaded config: %s", self.config)
         log.info("Loaded %d ping tasks", len(self.ping_tasks))
         for task in self.ping_tasks:
-            async_tasks.create_task(self.maybe_ping_later(task), self.bot.loop)
+            asyncio.create_task(self.maybe_ping_later(task))
 
     @commands.group(invoke_without_command=True)
     @checks.has_permissions(PermissionLevel.SUPPORTER)
@@ -84,8 +81,6 @@ async def set_delay(self, ctx: commands.Context) -> None:
     @checks.has_permissions(PermissionLevel.OWNER)
     async def set_initial(self, ctx: commands.Context, wait_duration: int) -> None:
         """Set the number of seconds to wait after a thread is opened to ping."""
-        await self.init_task
-
         await self.db.find_one_and_update(
             {"_id": "ping-delay-config"},
             {"$set": {"initial_wait_duration": wait_duration}},
@@ -98,8 +93,6 @@ async def set_initial(self, ctx: commands.Context, wait_duration: int) -> None:
     @checks.has_permissions(PermissionLevel.OWNER)
     async def set_delayed(self, ctx: commands.Context, wait_duration: int) -> None:
         """Set the number of seconds to wait after a thread is opened to ping."""
-        await self.init_task
-
         await self.db.find_one_and_update(
             {"_id": "ping-delay-config"},
             {"$set": {"delayed_wait_duration": wait_duration}},
@@ -127,8 +120,6 @@ async def ping_string(self, ctx: commands.Context) -> None:
     @ping_string.command(name="set")
     async def set_ping(self, ctx: commands.Context, ping_string: str) -> None:
         """Set what to send after a waiting for a thread to be responded to."""
-        await self.init_task
-
         await self.db.find_one_and_update(
             {"_id": "ping-delay-config"},
             {"$set": {"ping_string": ping_string}},
@@ -153,8 +144,6 @@ async def ping_ignore_categories(self, ctx: commands.Context) -> None:
     @ping_ignore_categories.command(name="add", aliases=("set",))
     async def set_category(self, ctx: commands.Context, category_to_ignore: discord.CategoryChannel) -> None:
         """Add a category to the list of ignored categories."""
-        await self.init_task
-
         if category_to_ignore.id in self.config.ignored_categories:
             await ctx.send(f":x: {category_to_ignore} already in the ignored categories.")
             return
@@ -172,8 +161,6 @@ async def set_category(self, ctx: commands.Context, category_to_ignore: discord.
     @ping_ignore_categories.command(name="get")
     async def get_category(self, ctx: commands.Context) -> None:
         """Get the list of ignored categories."""
-        await self.init_task
-
         if not self.config.ignored_categories:
             await ctx.send("There are currently no ignored categories.")
             return
@@ -185,8 +172,6 @@ async def get_category(self, ctx: commands.Context) -> None:
     @ping_ignore_categories.command(name="delete", aliases=("remove", "del", "rem"))
     async def del_category(self, ctx: commands.Context, category_to_ignore: discord.CategoryChannel) -> None:
         """Remove a category from the list of ignored categories."""
-        await self.init_task
-
         if category_to_ignore.id not in self.config.ignored_categories:
             await ctx.send(f":x: {category_to_ignore} isn't in the ignored categories list.")
             return
@@ -208,7 +193,7 @@ async def add_ping_task(self, task: PingTask) -> None:
             upsert=True,
         )
 
-        async_tasks.create_task(self.maybe_ping_later(task), self.bot.loop)
+        asyncio.create_task(self.maybe_ping_later(task))
 
     async def remove_ping_task(self, task: PingTask) -> None:
         """Removes a ping task to the internal cache and to the db."""
@@ -289,7 +274,6 @@ async def maybe_ping_later(self, ping_task: PingTask) -> None:
     @commands.Cog.listener()
     async def on_thread_ready(self, thread: Thread, *args) -> None:
         """Schedule a task to check if the bot should ping in the thread after the defined wait duration."""
-        await self.init_task
         now = datetime.utcnow()
         ping_task = PingTask(
             when_to_ping=(now + timedelta(seconds=self.config.initial_wait_duration)).isoformat(),