feat: 수정 심사 요청 생성 시 슬랙 알림을 보내도록 수정

Author: MU-Software

app/core/const/datetime.py

@@ -0,0 +1,4 @@
+from datetime import timedelta, timezone
+
+UTC = timezone.utc
+KST = timezone(timedelta(hours=9))

app/core/external_apis/slack/blocks.py

@@ -3,16 +3,23 @@
 
 
 class SlackChildBlockType(typing.TypedDict):
-    block_type: typing.Literal["plain_text", "mrkdwn"]
+    type: typing.Literal["plain_text", "mrkdwn"]
     text: str
     emoji: typing.NotRequired[typing.Literal[True]]
     title: typing.NotRequired[str]
 
 
+class SlackAccessoryBlockType(typing.TypedDict):
+    type: str
+    text: typing.NotRequired[SlackChildBlockType]
+    url: typing.NotRequired[str]
+
+
 class SlackParentBlockType(typing.TypedDict):
-    block_type: str
+    type: str
     text: typing.NotRequired[SlackChildBlockType]
     fields: typing.NotRequired[list[SlackChildBlockType]]
+    accessory: typing.NotRequired[SlackAccessoryBlockType]
 
 
 class SlackBlocksType(typing.TypedDict):
@@ -22,23 +29,23 @@ class SlackBlocksType(typing.TypedDict):
 @dataclasses.dataclass
 class SlackChildBlock:
     text: str
-    block_type: typing.Literal["plain_text", "mrkdwn"] = "plain_text"
+    type: typing.Literal["plain_text", "mrkdwn"] = "plain_text"
 
     def to_dict(self) -> SlackChildBlockType:
-        result = SlackChildBlockType(block_type=self.block_type, text=self.text)
-        if self.block_type == "plain_text":
+        result = SlackChildBlockType(type=self.type, text=self.text)
+        if self.type == "plain_text":
             result["emoji"] = True
         return result
 
 
 @dataclasses.dataclass
 class SlackPlainTextChildBlock(SlackChildBlock):
-    block_type: typing.Literal["plain_text"] = "plain_text"
+    type: typing.Literal["plain_text"] = "plain_text"
 
 
 @dataclasses.dataclass
 class SlackMarkDownChildBlock(SlackChildBlock):
-    block_type: typing.Literal["mrkdwn"] = "mrkdwn"
+    type: typing.Literal["mrkdwn"] = "mrkdwn"
 
 
 @dataclasses.dataclass
@@ -50,9 +57,31 @@ def __post_init__(self) -> None:
         self.text = f"{code_title}```{self.text}```"
 
 
+@dataclasses.dataclass
+class SlackAccessoryBlock:
+    type: str
+    text: SlackChildBlock | None = None
+
+    def to_dict(self) -> SlackAccessoryBlockType:
+        result = SlackAccessoryBlockType(type=self.type)
+        if self.text:
+            result["text"] = self.text.to_dict()
+        return result
+
+
+@dataclasses.dataclass
+class SlackURLButtonAccessoryBlock(SlackAccessoryBlock):
+    url: str = ""
+    type: typing.Literal["button"] = "button"
+    text: SlackChildBlock | None = None
+
+    def to_dict(self) -> SlackAccessoryBlockType:
+        return super().to_dict() | {"url": self.url}
+
+
 @dataclasses.dataclass
 class SlackParentBlock:
-    block_type: str
+    type: str
     text: SlackChildBlock | None = None
     fields: list[SlackChildBlock] | None = None
 
@@ -61,7 +90,7 @@ def __post_init__(self) -> None:
             raise ValueError("At least one of text or fields must be set!")
 
     def to_dict(self) -> SlackParentBlockType:
-        result = SlackParentBlockType(block_type=self.block_type)
+        result = SlackParentBlockType(type=self.type)
         if self.text:
             result["text"] = self.text.to_dict()
         if self.fields:
@@ -71,24 +100,31 @@ def to_dict(self) -> SlackParentBlockType:
 
 @dataclasses.dataclass
 class SlackHeaderParentBlock(SlackParentBlock):
-    block_type: str = "header"
+    type: str = "header"
 
     def __post_init__(self) -> None:
         super().__post_init__()
         if self.fields:
             raise ValueError("header block only allows text, not fields!")
-        if self.text.block_type != "plain_text":
+        if self.text.type != "plain_text":
             raise ValueError("header block only allows plain_text text block!")
 
 
 @dataclasses.dataclass
 class SlackSectionParentBlock(SlackParentBlock):
-    block_type: str = "section"
+    type: str = "section"
+    accessory: SlackAccessoryBlock | None = None
+
+    def to_dict(self) -> SlackParentBlockType:
+        result = super().to_dict()
+        if self.accessory:
+            result["accessory"] = self.accessory.to_dict()
+        return result
 
 
 @dataclasses.dataclass
 class SlackBlocks:
     blocks: list[SlackParentBlock]
 
     def to_dict(self) -> SlackBlocksType:
-        return {"blocks": [b.to_dict() for b in self.blocks]}
+        return SlackBlocksType(blocks=[b.to_dict() for b in self.blocks])

app/core/external_apis/slack/client.py

@@ -0,0 +1,19 @@
+from core.util.decorator import retry
+from django.conf import settings
+from httpx import Timeout, post
+
+from .blocks import SlackBlocks
+
+TimeoutTypes = None | float | tuple[float | None, float | None, float | None, float | None] | Timeout
+
+
+class SlackClient:
+    @retry
+    def send_message(self, channel_id: str, text: str, blocks: SlackBlocks = None, timeout: TimeoutTypes = None):
+        return post(
+            "https://www.slack.com/api/chat.postMessage",
+            headers={"Content-type": "application/json", "Authorization": f"Bearer {settings.SLACK.token}"},
+            json={"channel": channel_id, "text": text, "blocks": blocks.to_dict()["blocks"]},
+            timeout=timeout,
+            follow_redirects=True,
+        )

app/core/settings.py

@@ -56,7 +56,11 @@
 
 DEPLOYMENT_RELEASE_VERSION = os.environ.get("DEPLOYMENT_RELEASE_VERSION", "unknown")
 # Loggers
-SLACK = types.SimpleNamespace(token=env("SLACK_LOG_TOKEN", default=""), channel=env("SLACK_LOG_CHANNEL", default=""))
+SLACK = types.SimpleNamespace(
+    token=env("SLACK_LOG_TOKEN", default=""),
+    channel=env("SLACK_LOG_CHANNEL", default=""),
+    modification_audit_notification_channel=env("SLACK_MODIFICATION_AUDIT_NOTIFICATION_CHANNEL", default=""),
+)
 
 LOG_LEVEL = env("LOG_LEVEL")
 LOGGING = {
@@ -341,6 +345,13 @@
     set(env.list("CSRF_TRUSTED_ORIGINS", default=["https://rest-api.pycon.kr"])) | COOKIE_TRUSTED_ORIGIN_SET
 )
 
+# Frontend domain settings
+FRONTEND_DOMAIN = types.SimpleNamespace(
+    main=env("FRONTEND_MAIN_DOMAIN", default="https://pycon.kr"),
+    admin=env("FRONTEND_ADMIN_DOMAIN", default="https://admin.pycon.kr"),
+    participant=env("FRONTEND_PARTICIPANT_DOMAIN", default="https://participant.pycon.kr"),
+)
+
 # Django Rest Framework Settings
 REST_FRAMEWORK = {
     "DEFAULT_VERSIONING_CLASS": "rest_framework.versioning.NamespaceVersioning",

app/core/util/decorator.py

@@ -0,0 +1,26 @@
+import collections.abc
+import functools
+import typing
+
+Param = typing.ParamSpec("Param")
+RetType = typing.TypeVar("RetType")
+
+
+class RetriesFailedException(Exception):
+    pass
+
+
+def retry(func: collections.abc.Callable[Param, RetType]) -> collections.abc.Callable[Param, RetType]:
+    @functools.wraps(wrapped=func)
+    def wrapper(*args: Param.args, **kwargs: Param.kwargs) -> RetType:
+        retry_count: int = getattr(args[0] if args else kwargs["self"], "retry_count", 3)
+        ExceptionClass: type = getattr(args[0] if args else kwargs["self"], "exc_cls", RetriesFailedException)
+        exc: Exception | None = None
+        for _ in range(retry_count):
+            try:
+                return func(*args, **kwargs)
+            except Exception as e:
+                exc = e
+        raise ExceptionClass(f"Failed after {retry_count} times") from exc
+
+    return wrapper

app/participant_portal_api/models.py

@@ -1,20 +1,37 @@
+from __future__ import annotations
+
 import types
 import typing
 
+from core.const.datetime import KST
+from core.external_apis.slack.blocks import (
+    SlackBlocks,
+    SlackHeaderParentBlock,
+    SlackMarkDownChildBlock,
+    SlackPlainTextChildBlock,
+    SlackSectionParentBlock,
+    SlackURLButtonAccessoryBlock,
+)
+from core.external_apis.slack.client import SlackClient
 from core.models import BaseAbstractModel, BaseAbstractModelQuerySet
 from core.util.django_orm import (
     apply_diff_to_jsonized_models,
     apply_diff_to_model,
     json_to_simplenamespace,
     model_to_identifier,
 )
+from django.conf import settings
 from django.contrib.contenttypes.fields import GenericForeignKey
 from django.contrib.contenttypes.models import ContentType
 from django.db import models
 from event.presentation.models import Presentation, PresentationSpeaker
 from user.models import UserExt
 
 T = typing.TypeVar("T", bound=models.Model)
+AUDIT_TYPE: dict[models.Model, str] = {
+    Presentation: "발표",
+    UserExt: "프로필",
+}
 
 
 class ModificationAuditQuerySet(BaseAbstractModelQuerySet):
@@ -88,6 +105,37 @@ def apply_modification(self) -> models.Model:
         self.instance.refresh_from_db()
         return self.instance
 
+    def notify_creation_to_slack(self) -> None:
+        if not (audit_noti_channel := settings.SLACK.modification_audit_notification_channel):
+            return
+
+        created_at_kst_str = self.created_at.astimezone(KST).strftime("%y년 %m월 %d일 %H시 %M분")
+        audit_instance_type_str = AUDIT_TYPE.get(self.instance_type.model_class(), "알 수 없음")
+        blocks = SlackBlocks(
+            blocks=[
+                SlackHeaderParentBlock(text=SlackPlainTextChildBlock(text=":pencil: 수정 요청이 들어왔어요!")),
+                SlackSectionParentBlock(
+                    fields=[
+                        SlackMarkDownChildBlock(text=f"*수정 유형*\n{audit_instance_type_str}"),
+                        SlackMarkDownChildBlock(text=f"*요청 시간*\n{created_at_kst_str}"),
+                        SlackMarkDownChildBlock(text=f"*요청자*\n{self.created_by.nickname}"),
+                        SlackMarkDownChildBlock(text=f"*요청 ID*\n{self.id}"),
+                    ]
+                ),
+                SlackSectionParentBlock(
+                    text=SlackMarkDownChildBlock(text="어드민에서 수정 내역을 확인 후 승인 또는 반려해주세요."),
+                    accessory=SlackURLButtonAccessoryBlock(
+                        text=SlackPlainTextChildBlock(text="수정 심사 페이지 열기"),
+                        url=f"{settings.FRONTEND_DOMAIN.admin}/modification-audit/{self.id}",
+                    ),
+                ),
+            ]
+        )
+
+        SlackClient().send_message(
+            channel_id=audit_noti_channel, text="새로운 수정 요청이 도착했습니다.", blocks=blocks
+        )
+
 
 class ModificationAuditComment(BaseAbstractModel):
     audit = models.ForeignKey(ModificationAudit, on_delete=models.PROTECT, related_name="comments")

app/participant_portal_api/serializers/modification_audit.py

@@ -141,12 +141,14 @@ def save(self, **kwargs: dict) -> types.SimpleNamespace:
         if not (diff_data := get_diff_data_from_jsonized_models(original_data, updated_data)):
             raise serializers.ValidationError("변경된 데이터가 없습니다.\nNo modification data provided.")
 
-        return ModificationAudit.objects.create(
+        audit: ModificationAudit = ModificationAudit.objects.create(
             instance_type=instance_type,
             instance_id=instance_key,
             original_data=original_data,
             modification_data=diff_data,
-        ).fake_modified_instance
+        )
+        audit.notify_creation_to_slack()
+        return audit.fake_modified_instance
 
 
 class ModificationAuditCancelPortalSerializer(serializers.ModelSerializer):