Refactor AuditAction into Target & Action

Refactor AuditAction into AuditTarget & AuditAction

Author: x753

django/thunderstore/community/models/package_listing.py

@@ -22,6 +22,7 @@
     AuditAction,
     AuditEvent,
     AuditEventField,
+    AuditTarget,
     fire_audit_event,
 )
 
@@ -168,6 +169,7 @@ def get_full_url(self):
     def build_audit_event(
         self,
         *,
+        target: AuditTarget,
         action: AuditAction,
         user_id: Optional[int],
         message: Optional[str] = None,
@@ -176,6 +178,7 @@ def build_audit_event(
             timestamp=timezone.now(),
             user_id=user_id,
             community_id=self.community.pk,
+            target=target,
             action=action,
             message=message,
             related_url=self.get_full_url(),
@@ -223,7 +226,8 @@ def reject(
             message = "\n\n".join(filter(bool, (rejection_reason, internal_notes)))
             fire_audit_event(
                 self.build_audit_event(
-                    action=AuditAction.PACKAGE_REJECTED,
+                    target=AuditTarget.LISTING,
+                    action=AuditAction.REJECTED,
                     user_id=agent.pk if agent else None,
                     message=message,
                 )
@@ -249,7 +253,8 @@ def approve(
             )
             fire_audit_event(
                 self.build_audit_event(
-                    action=AuditAction.PACKAGE_APPROVED,
+                    target=AuditTarget.LISTING,
+                    action=AuditAction.APPROVED,
                     user_id=agent.pk if agent else None,
                     message=internal_notes,
                 )

django/thunderstore/repository/models/package_version.py

@@ -26,6 +26,7 @@
     AuditAction,
     AuditEvent,
     AuditEventField,
+    AuditTarget,
     fire_audit_event,
 )
 from thunderstore.webhooks.models.release import Webhook
@@ -329,13 +330,15 @@ def log_download_event(version_id: int, client_ip: Optional[str]):
     def build_audit_event(
         self,
         *,
+        target: AuditTarget,
         action: AuditAction,
         user_id: Optional[int],
         message: Optional[str] = None,
     ) -> AuditEvent:
         return AuditEvent(
             timestamp=timezone.now(),
             user_id=user_id,
+            target=target,
             action=action,
             message=message,
             related_url=self.package.get_view_on_site_url(),
@@ -363,7 +366,8 @@ def reject(
 
             fire_audit_event(
                 self.build_audit_event(
-                    action=AuditAction.VERSION_REJECTED,
+                    target=AuditTarget.VERSION,
+                    action=AuditAction.REJECTED,
                     user_id=agent.pk if agent else None,
                     message=message,
                 )
@@ -387,7 +391,8 @@ def approve(
 
             fire_audit_event(
                 self.build_audit_event(
-                    action=AuditAction.VERSION_APPROVED,
+                    target=AuditTarget.VERSION,
+                    action=AuditAction.APPROVED,
                     user_id=agent.pk if agent else None,
                     message=message,
                 )

django/thunderstore/webhooks/audit.py

@@ -6,16 +6,16 @@
 from pydantic import BaseModel
 
 
+class AuditTarget(str, Enum):
+    PACKAGE = "PACKAGE"
+    LISTING = "LISTING"
+    VERSION = "VERSION"
+
+
 class AuditAction(str, Enum):
-    PACKAGE_REJECTED = "PACKAGE_REJECTED"
-    PACKAGE_APPROVED = "PACKAGE_APPROVED"
-    PACKAGE_WARNING = "PACKAGE_WARNING"
-    LISTING_REJECTED = "LISTING_REJECTED"
-    LISTING_APPROVED = "LISTING_APPROVED"
-    LISTING_WARNING = "LISTING_WARNING"
-    VERSION_REJECTED = "VERSION_REJECTED"
-    VERSION_APPROVED = "VERSION_APPROVED"
-    VERSION_WARNING = "VERSION_WARNING"
+    REJECTED = "REJECTED"
+    APPROVED = "APPROVED"
+    WARNING = "WARNING"
 
 
 class AuditEventField(BaseModel):
@@ -27,6 +27,7 @@ class AuditEvent(BaseModel):
     timestamp: datetime
     user_id: Optional[int]
     community_id: Optional[int]
+    target: AuditTarget
     action: AuditAction
     message: Optional[str]
     related_url: Optional[str]

django/thunderstore/webhooks/models/audit.py

@@ -40,12 +40,11 @@ def get_for_event(cls, event: AuditEvent) -> QuerySet["AuditWebhook"]:
 
     @staticmethod
     def get_event_color(action: AuditAction) -> int:
-        action_str = str(action).lower()
-        if "approve" in action_str:
+        if action == AuditAction.APPROVED:
             return 5763719
-        if "reject" in action_str:
+        if action == AuditAction.REJECTED:
             return 15548997
-        if "warning" in action_str:
+        if action == AuditAction.WARNING:
             return 16705372
         return 9807270
 
@@ -64,7 +63,7 @@ def render_event(event: AuditEvent) -> DiscordPayload:
         return DiscordPayload(
             embeds=[
                 DiscordEmbed(
-                    title=event.action,
+                    title=event.target + "_" + event.action,
                     description=event.message,
                     url=event.related_url,
                     color=AuditWebhook.get_event_color(event.action),

django/thunderstore/webhooks/tasks/tests/test_audit.py

@@ -1,33 +1,30 @@
+import itertools
 from typing import Optional
 
 import pytest
 
 from thunderstore.community.models import PackageListing
 from thunderstore.core.types import UserType
-from thunderstore.webhooks.audit import AuditAction
+from thunderstore.webhooks.audit import AuditAction, AuditTarget
 from thunderstore.webhooks.models import AuditWebhook
 from thunderstore.webhooks.tasks import process_audit_event
 
 
 @pytest.mark.django_db
 @pytest.mark.parametrize(
-    "action",
-    (
-        AuditAction.PACKAGE_APPROVED,
-        AuditAction.PACKAGE_REJECTED,
-        AuditAction.PACKAGE_WARNING,
-        AuditAction.LISTING_REJECTED,
-        AuditAction.LISTING_APPROVED,
-        AuditAction.LISTING_WARNING,
-        AuditAction.VERSION_REJECTED,
-        AuditAction.VERSION_APPROVED,
-        AuditAction.VERSION_WARNING,
+    ("target", "action"),
+    list(
+        itertools.product(
+            [AuditTarget.PACKAGE, AuditTarget.LISTING, AuditTarget.VERSION],
+            [AuditAction.APPROVED, AuditAction.REJECTED, AuditAction.WARNING],
+        )
     ),
 )
 @pytest.mark.parametrize("message", (None, "Test message"))
 def test_process_audit_event(
     active_package_listing: PackageListing,
     user: UserType,
+    target: AuditTarget,
     action: AuditAction,
     message: Optional[str],
     mocker,
@@ -41,6 +38,7 @@ def test_process_audit_event(
     )
     webhook.match_communities.set([active_package_listing.community])
     event = active_package_listing.build_audit_event(
+        target=target,
         action=action,
         user_id=user.pk,
         message=message,