feat: add notification type,message and suggestion id in api response

Signed-off-by: Viena <169875752+devnchill@users.noreply.github.com>

Author: devnchill

src/api/notifications/views.py

@@ -1,21 +1,54 @@
+from enum import StrEnum
+
 from django.db.models import QuerySet
 from rest_framework import serializers, viewsets
 from rest_framework.pagination import PageNumberPagination
 from rest_framework.permissions import IsAuthenticated
 
-from webview.models import Notification
+from webview.models import Notification, SuggestionNotification, TextNotification
+
+
+class NotificationType(StrEnum):
+    TEXT = "text"
+    SUGGESTION = "suggestion"
 
 
 class NotificationSerializer(serializers.ModelSerializer):
+    type = serializers.SerializerMethodField()
     title = serializers.SerializerMethodField()
+    message = serializers.SerializerMethodField()
+    suggestion_id = serializers.SerializerMethodField()
 
     class Meta:
         model = Notification
-        fields = ["id", "title", "is_read", "created_at"]
+        fields = [
+            "id",
+            "type",
+            "title",
+            "message",
+            "suggestion_id",
+            "is_read",
+            "created_at",
+        ]
+
+    def get_type(self, obj: Notification) -> NotificationType:
+        if isinstance(obj, TextNotification):
+            return NotificationType.TEXT
+        return NotificationType.SUGGESTION
 
     def get_title(self, obj: Notification) -> str:
         return obj.title
 
+    def get_message(self, obj: Notification) -> str | None:
+        if isinstance(obj, TextNotification):
+            return obj.message
+        return None
+
+    def get_suggestion_id(self, obj: Notification) -> int | None:
+        if isinstance(obj, SuggestionNotification):
+            return obj.suggestion_id
+        return None
+
 
 class NotificationPagination(PageNumberPagination):
     page_size = 20

src/api/tests/test_notifications.py

@@ -5,6 +5,7 @@
 from rest_framework.reverse import reverse
 from rest_framework.test import APIClient
 
+from api.notifications.views import NotificationType
 from webview.models import Notification
 
 
@@ -13,21 +14,24 @@ def test_list_notifications_authenticated(
     user: User,
     make_maintainer_notification: Callable[..., list[Notification]],
 ) -> None:
-    make_maintainer_notification(user)
+    db_notifications = make_maintainer_notification(user)
 
     url = reverse("notification-list")
     response = client.get(url)
 
     assert response.status_code == status.HTTP_200_OK
     assert response.data["count"] == 1
 
-    api_data = response.data["results"]
-    assert api_data[0]["title"] == (
+    results = response.data["results"]
+    assert results[0]["title"] == (
         "CVE-2025-0001 was automatically matched to packages you subscribed to"
     )
-    assert api_data[0]["is_read"] is False
-    assert "id" in api_data[0]
-    assert "created_at" in api_data[0]
+    assert results[0]["is_read"] is False
+    assert "id" in results[0]
+    assert "created_at" in results[0]
+    assert results[0]["type"] == NotificationType.SUGGESTION
+    assert results[0]["message"] is None
+    assert results[0]["suggestion_id"] == db_notifications[0].suggestion_id
 
 
 def test_list_notifications_are_paginated(
@@ -94,8 +98,11 @@ def test_list_notifications_includes_text_notifications(
     assert response.data["count"] == 1
 
     api_data = response.data["results"]
+    assert api_data[0]["type"] == NotificationType.TEXT
     assert api_data[0]["title"] == "Hello"
     assert api_data[0]["is_read"] is False
+    assert api_data[0]["message"] == "World"
+    assert api_data[0]["suggestion_id"] is None
 
 
 def test_list_notifications_shows_both_types(
@@ -104,10 +111,28 @@ def test_list_notifications_shows_both_types(
     make_maintainer_notification: Callable[..., list[Notification]],
 ) -> None:
     user.profile.create_text_notification("Hello", "World")
-    make_maintainer_notification(user)
+    db_suggestion_notifications = make_maintainer_notification(user)
 
     url = reverse("notification-list")
     response = client.get(url)
 
     assert response.status_code == status.HTTP_200_OK
     assert response.data["count"] == 2
+
+    results = response.data["results"]
+    text_result = next(r for r in results if r["type"] == NotificationType.TEXT)
+    suggestion_result = next(
+        r for r in results if r["type"] == NotificationType.SUGGESTION
+    )
+
+    assert text_result["type"] == NotificationType.TEXT
+    assert text_result["title"] == "Hello"
+    assert text_result["message"] == "World"
+    assert text_result["suggestion_id"] is None
+
+    assert suggestion_result["type"] == NotificationType.SUGGESTION
+    assert (
+        suggestion_result["suggestion_id"]
+        == db_suggestion_notifications[0].suggestion_id
+    )
+    assert suggestion_result["message"] is None