Create an admin task when votes are 2 weeks old

bot/constants.py

@@ -697,6 +697,14 @@ class VideoPermission(metaclass=YAMLGetter):
     default_permission_duration: int
 
 
+class GithubAdminRepo(metaclass=YAMLGetter):
+    section = "github_admin_repo"
+
+    owner: str
+    name: str
+    token: str
+
+
 class ThreadArchiveTimes(Enum):
     HOUR = 60
     DAY = 1440

bot/exts/recruitment/talentpool/_api.py

@@ -23,6 +23,7 @@ class Nomination(BaseModel):
     ended_at: datetime | None
     entries: list[NominationEntry]
     reviewed: bool
+    thread_id: int | None
 
 
 class NominationAPI:
@@ -65,6 +66,7 @@ async def edit_nomination(
         end_reason: str | None = None,
         active: bool | None = None,
         reviewed: bool | None = None,
+        thread_id: int | None = None,
     ) -> Nomination:
         """
         Edit a nomination.
@@ -78,6 +80,8 @@ async def edit_nomination(
             data["active"] = active
         if reviewed is not None:
             data["reviewed"] = reviewed
+        if thread_id is not None:
+            data["thread_id"] = thread_id
 
         result = await self.site_api.patch(f"bot/nominations/{nomination_id}", json=data)
         return Nomination.parse_obj(result)

bot/exts/recruitment/talentpool/_cog.py

@@ -1,8 +1,9 @@
 import asyncio
 import textwrap
 from io import StringIO
-from typing import Optional, Union
+from typing import List, Optional, Tuple, Union
 
+import arrow
 import discord
 from async_rediscache import RedisCache
 from botcore.site_api import ResponseCodeError
@@ -11,18 +12,23 @@
 from discord.ext.commands import BadArgument, Cog, Context, group, has_any_role
 
 from bot.bot import Bot
-from bot.constants import Bot as BotConfig, Channels, Emojis, Guild, MODERATION_ROLES, Roles, STAFF_ROLES
+from bot.constants import (
+    Bot as BotConfig, Channels, Emojis, GithubAdminRepo, Guild, MODERATION_ROLES, Roles, STAFF_ROLES
+)
 from bot.converters import MemberOrUser, UnambiguousMemberOrUser
 from bot.exts.recruitment.talentpool._review import Reviewer
 from bot.log import get_logger
 from bot.pagination import LinePaginator
 from bot.utils import time
+from bot.utils.channel import get_or_fetch_channel
 from bot.utils.members import get_or_fetch_member
 
 from ._api import Nomination, NominationAPI
 
 AUTOREVIEW_ENABLED_KEY = "autoreview_enabled"
+FLAG_EMOJI = "🎫"
 REASON_MAX_CHARS = 1000
+OLD_NOMINATIONS_THRESHOLD_IN_DAYS = 14
 
 log = get_logger(__name__)
 
@@ -43,6 +49,7 @@ def __init__(self, bot: Bot) -> None:
 
     async def cog_load(self) -> None:
         """Start autoreview loop if enabled."""
+        self.track_forgotten_nominations.start()
         if await self.autoreview_enabled():
             self.autoreview_loop.start()
 
@@ -111,6 +118,81 @@ async def autoreview_status(self, ctx: Context) -> None:
         else:
             await ctx.send("Autoreview is currently disabled.")
 
+    @tasks.loop(hours=72)
+    async def track_forgotten_nominations(self) -> None:
+        """Track active nominations who are more than 2 weeks old."""
+        old_nominations = await self._get_forgotten_nominations()
+        nomination_details = await self._filter_out_tracked_nominations(old_nominations)
+        for nomination, nomination_vote_message in nomination_details:
+            issue_created = await self._track_vote_in_github(nomination)
+            if issue_created:
+                await nomination_vote_message.add_reaction(FLAG_EMOJI)
+
+    async def _get_forgotten_nominations(self) -> List[Nomination]:
+        """Get active nominations that are more than 2 weeks old."""
+        now = arrow.utcnow()
+        nominations = [
+            nomination
+            for nomination in await self.api.get_nominations(active=True)
+            if (now - nomination.inserted_at).days >= OLD_NOMINATIONS_THRESHOLD_IN_DAYS
+        ]
+        return nominations
+
+    async def _filter_out_tracked_nominations(
+            self,
+            nominations: List[Nomination]
+    ) -> List[Tuple[Nomination, discord.Message]]:
+        """Filter the forgotten nominations that are still untracked in GitHub."""
+        untracked_nominations = []
+
+        for nomination in nominations:
+            # We avoid the scenario of this task run & nomination created at the same time
+            if not nomination.thread_id:
+                continue
+
+            thread = await get_or_fetch_channel(nomination.thread_id)
+            if not thread:
+                # Thread was deleted
+                continue
+
+            starter_message = thread.starter_message
+            if not starter_message:
+                # Starter message will be null if it's not cached
+                starter_message = await self.bot.get_channel(Channels.nomination_voting).fetch_message(thread.id)
+
+            if not starter_message:
+                # Starter message deleted
+                continue
+
+            if FLAG_EMOJI in [reaction.emoji for reaction in starter_message.reactions]:
+                # Nomination has been already tracked in GitHub
+                continue
+
+            untracked_nominations.append((nomination, starter_message))
+        return untracked_nominations
+
+    async def _track_vote_in_github(self, nomination: Nomination) -> bool:
+        """
+        Adds an issue in GitHub to track dormant vote.
+
+        Returns True when the issue has been created, False otherwise.
+        """
+        if not GithubAdminRepo.token:
+            log.warn(f"No token for the {GithubAdminRepo.name} repository was provided, skipping issue creation.")
+            return False
+
+        url = f"https://api.github.com/repos/{GithubAdminRepo.owner}/{GithubAdminRepo.name}/issues"
+        headers = {
+            "Accept": "application/vnd.github.v3+json",
+            "Authorization": f"Bearer {GithubAdminRepo.token}"
+        }
+        member = await get_or_fetch_member(self.bot.get_guild(Guild.id), nomination.user_id)
+        data = {"title": f"Nomination review needed. Id: {nomination.id}. User: {member.name}"}
+
+        async with self.bot.http_session.post(url=url, raise_for_status=True, headers=headers, json=data) as response:
+            # REVIEW: Might be useful to add logs here ?
+            return response.status == 201
+
     @tasks.loop(hours=1)
     async def autoreview_loop(self) -> None:
         """Send request to `reviewer` to send a nomination if ready."""
@@ -489,13 +571,22 @@ async def _nomination_to_string(self, nomination: Nomination) -> str:
         entries_string = "\n\n".join(entries)
 
         start_date = time.discord_timestamp(nomination.inserted_at)
+
+        thread = None
+
+        if nomination.thread_id:
+            thread = await get_or_fetch_channel(nomination.thread_id)
+
+        thread_jump_url = f'[Jump to thread!]({thread.jump_url})' if thread else "*Not created*"
+
         if nomination.active:
             lines = textwrap.dedent(
                 f"""
                 ===============
                 Status: **Active**
                 Date: {start_date}
                 Nomination ID: `{nomination.id}`
+                Nomination vote thread: {thread_jump_url}
 
                 {entries_string}
                 ===============
@@ -509,6 +600,7 @@ async def _nomination_to_string(self, nomination: Nomination) -> str:
                 Status: Inactive
                 Date: {start_date}
                 Nomination ID: `{nomination.id}`
+                Nomination vote thread: {thread_jump_url}
 
                 {entries_string}
 

bot/exts/recruitment/talentpool/_review.py

@@ -16,6 +16,7 @@
 from bot.exts.recruitment.talentpool._api import Nomination, NominationAPI
 from bot.log import get_logger
 from bot.utils import time
+from bot.utils.channel import get_or_fetch_channel
 from bot.utils.members import get_or_fetch_member
 from bot.utils.messages import count_unique_users_reaction, pin_no_system_message
 
@@ -180,7 +181,7 @@ async def post_review(self, nomination: Nomination) -> None:
         )
         message = await thread.send(f"<@&{Roles.mod_team}> <@&{Roles.admins}>")
 
-        await self.api.edit_nomination(nomination.id, reviewed=True)
+        await self.api.edit_nomination(nomination.id, reviewed=True, thread_id=thread.id)
 
         bump_cog: ThreadBumper = self.bot.get_cog("ThreadBumper")
         if bump_cog:
@@ -433,11 +434,20 @@ async def _previous_nominations_review(self, member: Member) -> Optional[str]:
 
         nomination_times = f"{num_entries} times" if num_entries > 1 else "once"
         rejection_times = f"{len(history)} times" if len(history) > 1 else "once"
+        threads = [await get_or_fetch_channel(nomination.thread_id) for nomination in history]
+
+        nomination_vote_threads = ", ".join(
+            [
+                f"[Thread-{thread_number}]({thread.jump_url})" if thread else ''
+                for thread_number, thread in enumerate(threads, start=1)
+            ]
+        )
         end_time = time.format_relative(history[0].ended_at)
 
         review = (
             f"They were nominated **{nomination_times}** before"
             f", but their nomination was called off **{rejection_times}**."
+            f"\nList of all of their nomination threads: {nomination_vote_threads}"
             f"\nThe last one ended {end_time} with the reason: {history[0].end_reason}"
         )
 

config-default.yml

@@ -574,7 +574,7 @@ voice_gate:
 
 
 branding:
-    cycle_frequency: 3  # How many days bot wait before refreshing server icon
+    cycle_frequency: 3  # How many days the bot waits before refreshing server icon
 
 
 config:
@@ -583,3 +583,9 @@ config:
 
 video_permission:
     default_permission_duration: 5  # Default duration for stream command in minutes
+
+
+github_admin_repo:
+    owner: 'python-discord'
+    name: 'admin'
+    token: !ENV ["ADMIN_GITHUB_REPO_TOKEN", ""]