audit-logs: add discord integration

Author: rr-

backend/trcustoms/audit_logs/mixins.py

@@ -9,18 +9,18 @@ class AuditLogAdminMixin:
     def log_addition(self, request, obj, message):
         super().log_addition(request, obj, message)
         obj = self.get_audit_log_obj(obj)
-        track_model_creation(obj, request=request)
+        track_model_creation(obj, request=request, notify=True)
 
     def log_change(self, request, obj, message):
         super().log_change(request, obj, message)
         obj = self.get_audit_log_obj(obj)
         # TODO: figure out a way to track more detailed changes
-        track_model_update(obj, request=request, force=True)
+        track_model_update(obj, request=request, force=True, notify=False)
 
     def log_deletion(self, request, obj, object_repr):
         super().log_deletion(request, obj, object_repr)
         obj = self.get_audit_log_obj(obj)
-        track_model_deletion(obj, request=request)
+        track_model_deletion(obj, request=request, notify=True)
 
     def get_audit_log_obj(self, obj):
         return obj

backend/trcustoms/audit_logs/tests/factories.py

@@ -0,0 +1,22 @@
+import factory
+from django.contrib.contenttypes.models import ContentType
+
+from trcustoms.audit_logs.consts import ChangeType
+from trcustoms.audit_logs.models import AuditLog
+from trcustoms.users.models import User
+
+
+class AuditLogFactory(factory.django.DjangoModelFactory):
+    class Meta:
+        model = AuditLog
+
+    object_id = factory.Faker("pystr", max_chars=6)
+    object_name = factory.Faker("word")
+    object_type = factory.LazyFunction(
+        lambda: ContentType.objects.get_for_model(User)
+    )
+    change_type = ChangeType.CREATE
+    change_author = None
+    is_action_required = True
+    changes = factory.LazyFunction(lambda: ["created"])
+    meta = factory.LazyFunction(dict)

backend/trcustoms/audit_logs/tests/test_utils_discord.py

@@ -0,0 +1,69 @@
+from unittest.mock import patch
+
+import pytest
+import requests
+from django.test import override_settings
+
+from trcustoms.audit_logs.consts import ChangeType
+from trcustoms.audit_logs.tests.factories import AuditLogFactory
+from trcustoms.audit_logs.utils import notify_discord
+from trcustoms.users.tests.factories import UserFactory
+
+
+@pytest.mark.django_db
+@override_settings(DISCORD_WEBHOOK_URL=None)
+def test_no_webhook(settings):
+    audit_log = AuditLogFactory(is_action_required=True)
+    with patch("requests.post") as mock_post:
+        notify_discord(audit_log)
+    mock_post.assert_not_called()
+
+
+@pytest.mark.django_db
+@override_settings(DISCORD_WEBHOOK_URL="http://example.com")
+def test_no_action_required(settings):
+    audit_log = AuditLogFactory(is_action_required=False)
+    with patch("requests.post") as mock_post:
+        notify_discord(audit_log)
+    mock_post.assert_not_called()
+
+
+@pytest.mark.django_db
+@override_settings(
+    DISCORD_WEBHOOK_URL="http://example.com",
+    DISCORD_WEBHOOK_USERNAME="Bot",
+    DISCORD_WEBHOOK_AVATAR="https://example.com/av.jpg",
+)
+def test_posts_notification(settings):
+    user = UserFactory(username="alice")
+    audit_log = AuditLogFactory(
+        change_type=ChangeType.UPDATE,
+        change_author=user,
+        changes=["field1", "field2"],
+        is_action_required=True,
+    )
+    expected_desc = (
+        f"**{str(audit_log.change_type).title()}** of "
+        f"**{audit_log.object_type.model.title()}**"
+        f" #{audit_log.object_id} ({audit_log.object_name})"
+        f"\n**Author:** {user.username}"
+        f"\n**Changes:** {', '.join(audit_log.changes)}"
+    )
+    with patch("requests.post") as mock_post:
+        notify_discord(audit_log)
+    mock_post.assert_called_once_with(
+        "http://example.com",
+        json={
+            "username": "Bot",
+            "avatar_url": "https://example.com/av.jpg",
+            "embeds": [{"description": expected_desc}],
+        },
+    )
+
+
+@pytest.mark.django_db
+@override_settings(DISCORD_WEBHOOK_URL="http://example.com")
+def test_exception_swallowed(settings):
+    audit_log = AuditLogFactory(is_action_required=True)
+    with patch("requests.post", side_effect=requests.RequestException):
+        notify_discord(audit_log)

backend/trcustoms/audit_logs/utils.py

@@ -1,6 +1,8 @@
 import contextlib
 from typing import Any
 
+import requests
+from django.conf import settings
 from django.contrib.contenttypes.models import ContentType
 from django.db import models
 from rest_framework.request import Request
@@ -11,13 +13,41 @@
 from trcustoms.users.models import User
 
 
+def notify_discord(audit_log: AuditLog) -> None:
+    """Send audit log notification to Discord if webhook is configured."""
+    url: str | None = settings.DISCORD_WEBHOOK_URL
+    if not audit_log.is_action_required or not url:
+        return
+
+    model_name = audit_log.object_type.model.title()
+    description = (
+        f"**{audit_log.change_type.title()}** of **{model_name}**"
+        f" #{audit_log.object_id} ({audit_log.object_name})"
+    )
+    if audit_log.change_author:
+        description += f"\n**Author:** {audit_log.change_author.username}"
+    if audit_log.changes:
+        description += f"\n**Changes:** {', '.join(audit_log.changes)}"
+
+    payload = {
+        "username": settings.DISCORD_WEBHOOK_USERNAME,
+        "avatar_url": settings.DISCORD_WEBHOOK_AVATAR,
+        "embeds": [{"description": description}],
+    }
+    try:
+        requests.post(url, json=payload)
+    except requests.RequestException:
+        pass
+
+
 def make_audit_log(
     obj: models.Model,
     request: Request | None,
     change_type: ChangeType,
     changes: list[str],
     change_author: User | None = None,
     is_action_required: bool = False,
+    notify: bool = False,
     meta: Any = None,
 ) -> None:
     info = get_registered_model_info(obj)
@@ -32,7 +62,7 @@ def make_audit_log(
     if not changes:
         return
 
-    AuditLog.objects.create(
+    log = AuditLog.objects.create(
         object_id=object_id,
         object_name=object_name,
         object_type=object_type,
@@ -49,6 +79,8 @@ def make_audit_log(
         changes=changes,
         meta=meta,
     )
+    if log.is_action_required or notify:
+        notify_discord(log)
 
 
 def track_model_creation(

backend/trcustoms/conftest.py

@@ -136,5 +136,7 @@ def fixture_clear_caches() -> None:
 
 @pytest.fixture(name="use_tmp_media_dir", autouse=True, scope="session")
 def fixture_use_tmp_media_dir() -> None:
-    with override_settings(MEDIA_ROOT=tempfile.gettempdir()):
+    with override_settings(
+        MEDIA_ROOT=tempfile.gettempdir(), DISCORD_WEBHOOK_URL=None
+    ):
         yield

backend/trcustoms/levels/logic.py

@@ -18,7 +18,9 @@
 
 
 def approve_level(level: Level, request: Request | None) -> None:
-    with track_model_update(obj=level, request=request, changes=["Approved"]):
+    with track_model_update(
+        obj=level, request=request, changes=["Approved"], notify=True
+    ):
         send_mail = not level.is_approved
         level.is_pending_approval = False
         level.is_approved = True
@@ -38,6 +40,7 @@ def reject_level(level: Level, request: Request | None, reason: str) -> None:
         request=request,
         changes=[f"Rejected (reason: {reason})"],
         is_action_required=True,
+        notify=True,
     ):
         if level.is_approved or reason != level.rejection_reason:
             send_level_rejected_mail(level, reason)

backend/trcustoms/mixins.py

@@ -72,6 +72,7 @@ def perform_create(self, serializer: serializers.Serializer) -> None:
             serializer.instance,
             request=self.request,
             is_action_required=self.audit_log_review_create,
+            notify=self.audit_log_review_create,
         )
 
 
@@ -84,14 +85,15 @@ def perform_update(self, serializer: serializers.Serializer) -> None:
             instance,
             request=self.request,
             is_action_required=self.audit_log_review_update,
+            notify=False,
         ):
             super().perform_update(serializer)
 
 
 class AuditLogModelWatcherDestroyMixin:
     def perform_destroy(self, instance) -> None:
         clear_audit_log_action_flags(obj=instance)
-        track_model_deletion(instance, request=self.request)
+        track_model_deletion(instance, request=self.request, notify=True)
         super().perform_destroy(instance)
 
 

backend/trcustoms/settings.py

@@ -292,6 +292,10 @@ def get_bool_setting(name: str, **kwargs) -> bool:
     "SCHEMA_PATH_PREFIX": r"/api",
 }
 
+DISCORD_WEBHOOK_URL = get_setting("DISCORD_WEBHOOK_URL", allow_null=True)
+DISCORD_WEBHOOK_USERNAME = "Winston"
+DISCORD_WEBHOOK_AVATAR = "https://winston.wind.garden/static/avatar.jpg"
+
 if TESTING:
     del REST_FRAMEWORK["DEFAULT_THROTTLE_CLASSES"]
     del REST_FRAMEWORK["DEFAULT_THROTTLE_RATES"]

backend/trcustoms/tags/logic.py

@@ -13,6 +13,7 @@ def split_tag(
         obj=source_tag,
         request=request,
         changes=[f"Split to {', '.join(targets)}"],
+        notify=True,
     ):
         existing_tags = Tag.objects.filter(name__in=targets)
         missing_tags = [
@@ -35,6 +36,7 @@ def merge_tags(source: str, target: str, request: Request | None) -> None:
         obj=source_tag,
         request=request,
         changes=[f"Merged to {target_tag.name}"],
+        notify=True,
     ):
         levels = (
             Level.objects.filter(tags=source_tag)

backend/trcustoms/tasks/delete_stalled_drafts.py

@@ -15,5 +15,5 @@ def delete_stalled_drafts() -> None:
         last_updated__lte=timezone.now() - timedelta(days=7),
     ):
         logger.info("deleting old walkthrough draft", walkthrough.level.name)
-        track_model_deletion(walkthrough, request=None)
+        track_model_deletion(walkthrough, request=None, notify=False)
         walkthrough.delete()