Add serializers to support frontend (ui) views

Author: spalmurray

src/firetower/auth/serializers.py

@@ -0,0 +1,22 @@
+from django.contrib.auth.models import User
+from rest_framework import serializers
+
+
+class UserSerializer(serializers.ModelSerializer):
+    """
+    Basic User serializer for nested representations.
+
+    Minimal user info for API responses: name and avatar only.
+    """
+
+    name = serializers.SerializerMethodField()
+    avatar_url = serializers.CharField(source="userprofile.avatar_url", read_only=True)
+
+    class Meta:
+        model = User
+        fields = ["name", "avatar_url"]
+        read_only_fields = []
+
+    def get_name(self, obj):
+        """Get user's full name or email as fallback"""
+        return obj.get_full_name() or obj.email

src/firetower/auth/tests/test_serializers.py

@@ -0,0 +1,41 @@
+import pytest
+from django.contrib.auth.models import User
+
+from firetower.auth.serializers import UserSerializer
+
+
+@pytest.mark.django_db
+class TestUserSerializer:
+    def test_user_serialization(self):
+        """Test User serialization"""
+        user = User.objects.create_user(
+            username="[email protected]",
+            email="[email protected]",
+            first_name="Test",
+            last_name="User",
+        )
+
+        serializer = UserSerializer(user)
+        data = serializer.data
+
+        # Minimal fields only
+        assert data["name"] == "Test User"
+        assert "avatar_url" in data
+
+        # Should not include these
+        assert "id" not in data
+        assert "email" not in data
+        assert "username" not in data
+        assert "first_name" not in data
+        assert "last_name" not in data
+
+    def test_user_serialization_no_full_name(self):
+        """Test User serialization when no first/last name"""
+        user = User.objects.create_user(
+            username="[email protected]", email="[email protected]"
+        )
+
+        serializer = UserSerializer(user)
+        data = serializer.data
+
+        assert data["name"] == "[email protected]"  # Falls back to email

src/firetower/incidents/serializers.py

@@ -0,0 +1,140 @@
+from rest_framework import serializers
+
+from firetower.auth.serializers import UserSerializer
+
+from .models import Incident
+
+
+class IncidentListSerializer(serializers.ModelSerializer):
+    """
+    Serializer for listing incidents.
+
+    Minimal fields for list views - just core incident data.
+    """
+
+    # Use incident_number as "id" field for frontend
+    id = serializers.CharField(source="incident_number", read_only=True)
+
+    class Meta:
+        model = Incident
+        fields = [
+            "id",
+            "title",
+            "description",
+            "impact",
+            "status",
+            "severity",
+            "is_private",
+            "created_at",
+            "updated_at",
+        ]
+        read_only_fields = ["id", "created_at", "updated_at"]
+
+
+class ParticipantSerializer(serializers.Serializer):
+    """
+    Serializer for participants in incident detail view.
+
+    Matches frontend expectation: {name, avatar_url, role}
+    """
+
+    name = serializers.SerializerMethodField()
+    avatar_url = serializers.CharField(source="userprofile.avatar_url", read_only=True)
+    role = serializers.SerializerMethodField()
+
+    def get_name(self, obj):
+        """Get user's full name or username"""
+        return obj.get_full_name() or obj.username
+
+    def get_role(self, obj):
+        """Determine role based on incident context"""
+        incident = self.context.get("incident")
+        if not incident:
+            return "Participant"
+
+        if incident.captain == obj:
+            return "Captain"
+        elif incident.reporter == obj:
+            return "Reporter"
+        return "Participant"
+
+
+class IncidentDetailSerializer(serializers.ModelSerializer):
+    """
+    Serializer for incident detail view.
+
+    Matches frontend expectations from transformers.py
+    """
+
+    # Use incident_number as "id" field for frontend compatibility
+    id = serializers.CharField(source="incident_number", read_only=True)
+
+    # Full nested user data for captain/reporter
+    captain = UserSerializer(read_only=True)
+    reporter = UserSerializer(read_only=True)
+
+    # Participants with role information
+    participants = serializers.SerializerMethodField()
+
+    # Tags as arrays of strings (not full objects)
+    affected_areas = serializers.ListField(
+        child=serializers.CharField(), read_only=True
+    )
+    root_causes = serializers.ListField(child=serializers.CharField(), read_only=True)
+
+    # External links as dict for easy frontend access
+    external_links = serializers.DictField(source="external_links_dict", read_only=True)
+
+    class Meta:
+        model = Incident
+        fields = [
+            "id",
+            "title",
+            "description",
+            "impact",
+            "status",
+            "severity",
+            "is_private",
+            "captain",
+            "reporter",
+            "participants",
+            "affected_areas",
+            "root_causes",
+            "external_links",
+            "created_at",
+            "updated_at",
+        ]
+        read_only_fields = ["id", "created_at", "updated_at"]
+
+    def get_participants(self, obj):
+        """
+        Get all participants with their roles.
+
+        Combines captain, reporter, and participants into one list
+        matching frontend expectation.
+        """
+        participants_list = []
+        seen_users = set()
+
+        # Add captain
+        if obj.captain and obj.captain.id not in seen_users:
+            serializer = ParticipantSerializer(obj.captain, context={"incident": obj})
+            participants_list.append(serializer.data)
+            seen_users.add(obj.captain.id)
+
+        # Add reporter
+        if obj.reporter and obj.reporter.id not in seen_users:
+            serializer = ParticipantSerializer(obj.reporter, context={"incident": obj})
+            participants_list.append(serializer.data)
+            seen_users.add(obj.reporter.id)
+
+        # Add other participants
+        for participant in obj.participants.all():
+            if participant.id not in seen_users:
+                serializer = ParticipantSerializer(
+                    participant, context={"incident": obj}
+                )
+                participants_list.append(serializer.data)
+                seen_users.add(participant.id)
+
+        return participants_list

src/firetower/incidents/tests/test_serializers.py

@@ -0,0 +1,160 @@
+import pytest
+from django.contrib.auth.models import User
+
+from firetower.incidents.models import (
+    ExternalLink,
+    ExternalLinkType,
+    Incident,
+    IncidentSeverity,
+    IncidentStatus,
+    Tag,
+    TagType,
+)
+from firetower.incidents.serializers import (
+    IncidentDetailSerializer,
+    IncidentListSerializer,
+)
+
+
+@pytest.mark.django_db
+class TestIncidentListSerializer:
+    def test_incident_list_serialization(self):
+        """Test incident serialization for list view"""
+        captain = User.objects.create_user(
+            username="[email protected]",
+            email="[email protected]",
+            first_name="Jane",
+            last_name="Captain",
+        )
+        reporter = User.objects.create_user(
+            username="[email protected]",
+            email="[email protected]",
+            first_name="John",
+            last_name="Reporter",
+        )
+
+        incident = Incident.objects.create(
+            title="Test Incident",
+            description="Test description",
+            impact="Test impact",
+            status=IncidentStatus.ACTIVE,
+            severity=IncidentSeverity.P1,
+            is_private=False,
+            captain=captain,
+            reporter=reporter,
+        )
+
+        # Add tags
+        area_tag = Tag.objects.create(name="API", type=TagType.AFFECTED_AREA)
+        cause_tag = Tag.objects.create(name="Database", type=TagType.ROOT_CAUSE)
+        incident.affected_area_tags.add(area_tag)
+        incident.root_cause_tags.add(cause_tag)
+
+        serializer = IncidentListSerializer(incident)
+        data = serializer.data
+
+        # Check id is incident_number string (frontend compatibility)
+        assert data["id"] == f"INC-{incident.id}"
+        assert data["title"] == "Test Incident"
+        assert data["status"] == IncidentStatus.ACTIVE
+        assert data["severity"] == IncidentSeverity.P1
+
+        # List view should not include captain/reporter/tags
+        assert "captain" not in data
+        assert "reporter" not in data
+        assert "affected_areas" not in data
+        assert "root_causes" not in data
+
+
+@pytest.mark.django_db
+class TestIncidentDetailSerializer:
+    def test_incident_detail_serialization(self):
+        """Test incident serialization for detail view (matches frontend expectations)"""
+        captain = User.objects.create_user(
+            username="[email protected]",
+            email="[email protected]",
+            first_name="Jane",
+            last_name="Captain",
+        )
+        reporter = User.objects.create_user(
+            username="[email protected]",
+            email="[email protected]",
+            first_name="John",
+            last_name="Reporter",
+        )
+        participant = User.objects.create_user(
+            username="[email protected]",
+            email="[email protected]",
+            first_name="Alice",
+            last_name="Participant",
+        )
+
+        incident = Incident.objects.create(
+            title="Test Incident",
+            description="Test description",
+            status=IncidentStatus.MITIGATED,
+            severity=IncidentSeverity.P2,
+            captain=captain,
+            reporter=reporter,
+        )
+        incident.participants.add(participant)
+
+        # Add tags
+        area_tag = Tag.objects.create(name="API", type=TagType.AFFECTED_AREA)
+        cause_tag = Tag.objects.create(name="Database", type=TagType.ROOT_CAUSE)
+        incident.affected_area_tags.add(area_tag)
+        incident.root_cause_tags.add(cause_tag)
+
+        # Add external links
+        ExternalLink.objects.create(
+            incident=incident,
+            type=ExternalLinkType.SLACK,
+            url="https://slack.com/channels/incident-123",
+        )
+
+        serializer = IncidentDetailSerializer(incident)
+        data = serializer.data
+
+        # Check id is incident_number string (frontend compatibility)
+        assert data["id"] == f"INC-{incident.id}"
+        assert data["title"] == "Test Incident"
+
+        # Check nested users for captain/reporter (name and avatar only)
+        assert data["captain"]["name"] == "Jane Captain"
+        assert "avatar_url" in data["captain"]
+        assert "email" not in data["captain"]
+
+        assert data["reporter"]["name"] == "John Reporter"
+        assert "avatar_url" in data["reporter"]
+        assert "email" not in data["reporter"]
+
+        # Check participants structure (matches frontend expectation)
+        assert len(data["participants"]) == 3  # captain, reporter, participant
+
+        # Find each participant
+        captain_participant = next(
+            p for p in data["participants"] if p["role"] == "Captain"
+        )
+        assert captain_participant["name"] == "Jane Captain"
+        assert "avatar_url" in captain_participant
+
+        reporter_participant = next(
+            p for p in data["participants"] if p["role"] == "Reporter"
+        )
+        assert reporter_participant["name"] == "John Reporter"
+
+        other_participant = next(
+            p for p in data["participants"] if p["role"] == "Participant"
+        )
+        assert other_participant["name"] == "Alice Participant"
+
+        # Check affected_areas and root_causes as arrays of strings
+        assert "API" in data["affected_areas"]
+        assert "Database" in data["root_causes"]
+
+        # Check external links (dict format for frontend compatibility)
+        assert "slack" in data["external_links"]
+        assert (
+            data["external_links"]["slack"] == "https://slack.com/channels/incident-123"
+        )
+        assert data["external_links"]["jira"] is None  # Not set