more review feedback

Author: artcz

intbot/conftest.py

@@ -5,7 +5,8 @@
 
 
 @pytest.fixture(scope="session")
-def gh_data():
+def github_data():
+    """Pytest fixture with examples of webhooks from github"""
     base_path = settings.BASE_DIR / "tests" / "test_integrations" / "github"
 
     return {

intbot/core/bot/channel_router.py

@@ -19,7 +19,7 @@ class DiscordChannel:
     channel_name: str
 
 
-dont_send_it = DiscordChannel(channel_id="0", channel_name="/dev/null")
+dont_send_it = DiscordChannel(channel_id="0", channel_name="DONT_SEND_IT")
 
 
 class Channels:
@@ -67,28 +67,27 @@ def github_router(wh: Webhook) -> DiscordChannel:
 
     # We have three github projects, that we want to route to three different
     # channels - one for ep2025, one for EM, and one for the board.
-    if project.id == GithubProjects.board_project:
-        return Channels.board_channel
+    PROJECTS = {
+        GithubProjects.board_project: Channels.board_channel,
+        GithubProjects.ep2025_project: Channels.ep2025_channel,
+        GithubProjects.em_project: Channels.em_channel,
+    }
 
-    elif project.id == GithubProjects.ep2025_project:
-        return Channels.ep2025_channel
-
-    elif project.id == GithubProjects.em_project:
-        return Channels.em_channel
+    if channel := PROJECTS.get(project.id):
+        return channel
 
     # Then we have our open source repositories, like website, this bot, and
     # some others, that we also might want to route to different channels
-    if repository == GithubRepositories.website_repo:
-        return Channels.website_channel
-
-    elif repository == GithubRepositories.bot_repo:
-        return Channels.bot_channel
+    REPOSITORIES = {
+        GithubRepositories.website_repo: Channels.website_channel,
+        GithubRepositories.bot_repo: Channels.bot_channel,
+    }
 
-    elif repository == ...:
-        ...
+    if channel := REPOSITORIES.get(repository.id):
+        return channel
 
     # Finally, we can use this to drop notifications that we don't want to
-    # support, by routing them to /dev/null
+    # support, by not sending them.
     return dont_send_it
 
 

intbot/core/integrations/github.py

@@ -63,6 +63,11 @@ class GithubProject(BaseModel):
     url: str
 
 
+class GithubRepository(BaseModel):
+    id: str
+    name: str
+
+
 class GithubSender(BaseModel):
     login: str
     html_url: str
@@ -84,13 +89,14 @@ class GithubDraftIssue(BaseModel):
     def as_discord_message(self):
         return self.title
 
+JsonType = dict[str, Any]
 
 class GithubWebhook:
     """
     Base class for all the other specific types of webhooks.
     """
 
-    def __init__(self, action: str, headers: dict, content: dict, extra: dict):
+    def __init__(self, action: str, headers: JsonType, content: JsonType, extra: JsonType):
         self.action = action
         self.headers = headers
         self.content = content
@@ -143,9 +149,9 @@ def github_object(self) -> GithubDraftIssue | GithubIssue:
     def get_project(self) -> GithubProject:
         return GithubProject.model_validate(self.extra["project"])
 
-    def get_repository(self):
+    def get_repository(self) -> GithubRepository:
         # Not relevant at the moment
-        return ...
+        return GithubRepository(name="Placeholder", id="placeholder-repo")
 
     def changes(self) -> dict:
 
@@ -158,6 +164,9 @@ def changes(self) -> dict:
         field_name = fv["field_name"]
         field_type = fv["field_type"]
 
+        changed_from: str
+        changed_to: str
+
         if field_type == "date":
             changed_from = (
                 fv["from"].split("T")[0] if fv["from"] is not None else "None"

intbot/core/tasks.py

@@ -1,14 +1,15 @@
 import logging
 
 from core.integrations.github import parse_github_webhook, prep_github_webhook
-from core.bot.channel_router import discord_channel_router
+from core.bot.channel_router import discord_channel_router, dont_send_it
 from core.models import DiscordMessage, Webhook
 from django.utils import timezone
 from django_tasks import task
 
 logger = logging.getLogger()
 
 
+
 @task
 def process_webhook(wh_uuid: str):
     wh = Webhook.objects.get(uuid=wh_uuid)
@@ -56,11 +57,14 @@ def process_github_webhook(wh: Webhook):
     parsed = parse_github_webhook(wh)
     channel = discord_channel_router(wh)
 
+    if channel == dont_send_it:
+        wh.processed_at = timezone.now()
+        wh.save()
+        return
+
     DiscordMessage.objects.create(
         channel_id=channel.channel_id,
         channel_name=channel.channel_name,
-        # channel_id=settings.DISCORD_TEST_CHANNEL_ID,
-        # channel_name=settings.DISCORD_TEST_CHANNEL_NAME,
         content=f"GitHub: {parsed.message}",
         # Mark as unsend - to be sent with the next batch
         sent_at=None,

intbot/tests/test_integrations/test_github.py

@@ -250,11 +250,11 @@ def test_changes_for_unsupported_format(self):
         }
 
 
-    def test_get_project_parses_project_correctly(self, gh_data):
+    def test_get_project_parses_project_correctly(self, github_data):
         wh = Webhook(
             meta={"X-Github-Event": "projects_v2_item"},
-            content=gh_data["project_v2_item.edited"],
-            extra=gh_data["query_result"],
+            content=github_data["project_v2_item.edited"],
+            extra=github_data["query_result"],
         )
         gwh = parse_github_webhook(wh)
 
@@ -263,11 +263,11 @@ def test_get_project_parses_project_correctly(self, gh_data):
         assert ghp.title == "Board Project"
         assert ghp.url == "https://github.com/orgs/EuroPython/projects/1337"
 
-    def test_get_sender_parses_sender_correctly(self, gh_data):
+    def test_get_sender_parses_sender_correctly(self, github_data):
         wh = Webhook(
             meta={"X-Github-Event": "projects_v2_item"},
-            content=gh_data["project_v2_item.edited"],
-            extra=gh_data["query_result"],
+            content=github_data["project_v2_item.edited"],
+            extra=github_data["query_result"],
         )
         gwh = parse_github_webhook(wh)
 
@@ -277,11 +277,11 @@ def test_get_sender_parses_sender_correctly(self, gh_data):
         assert sender.login == "github-project-automation[bot]"
         assert sender.html_url == "https://github.com/apps/github-project-automation"
 
-    def test_sender_formats_sender_correctly(self, gh_data):
+    def test_sender_formats_sender_correctly(self, github_data):
         wh = Webhook(
             meta={"X-Github-Event": "projects_v2_item"},
-            content=gh_data["project_v2_item.edited"],
-            extra=gh_data["query_result"],
+            content=github_data["project_v2_item.edited"],
+            extra=github_data["query_result"],
         )
         gwh = parse_github_webhook(wh)