revert to TextField for FeatureHealthEvent.reason, fix typing

Author: khvn26

api/features/feature_health/mappers.py

@@ -1,3 +1,4 @@
+import json
 import typing
 
 from features.feature_health.models import FeatureHealthEvent
@@ -14,11 +15,15 @@ def map_feature_health_event_data_to_feature_health_event(
     feature: "Feature",
     environment: "Environment | None",
 ) -> FeatureHealthEvent:
+    if reason := feature_health_event_data.reason:
+        instance_reason = json.dumps(reason)
+    else:
+        instance_reason = None
     instance = FeatureHealthEvent(
         feature=feature,
         environment=environment,
-        type=feature_health_event_data.type,
-        reason=feature_health_event_data.reason,
+        type=feature_health_event_data.type.value,
+        reason=instance_reason,
         external_id=feature_health_event_data.external_id,
         provider_name=feature_health_event_data.provider_name,
     )

api/features/feature_health/migrations/0002_alter_featurehealthevent_external_id_and_more_squashed_0003_alter_featurehealthevent_reason_and_more.py

@@ -1,4 +1,4 @@
-# Generated by Django 4.2.18 on 2025-02-13 05:58
+# Generated by Django 4.2.18 on 2025-02-17 15:13
 
 from django.db import migrations, models
 import django.utils.timezone

api/features/feature_health/migrations/0002_alter_featurehealthevent_external_id_and_more.py api/features/feature_health/migrations/0002_featurehealthevent_add_external_id_alter_created_at.py

@@ -148,7 +148,7 @@ class FeatureHealthEvent(
     created_at = models.DateTimeField(default=timezone.now, editable=False, blank=True)
     type = models.CharField(max_length=50, choices=FeatureHealthEventType.choices)
     provider_name = models.CharField(max_length=255, null=True, blank=True)
-    reason = models.JSONField(null=True, blank=True)
+    reason = models.TextField(null=True, blank=True)
     external_id = models.CharField(max_length=255, null=True, blank=True)
 
     def get_create_log_message(

api/features/feature_health/migrations/0003_alter_featurehealthevent_reason_and_more.py

@@ -39,9 +39,7 @@ def map_payload_to_provider_response(
                 type=map_sample_event_status_to_feature_health_event_type(
                     event_data["status"]
                 ),
-                reason=(
-                    event_data.get("reason") or {"text_blocks": [], "url_blocks": []}
-                ),
+                reason=event_data.get("reason"),
                 provider_name=FeatureHealthProviderName.SAMPLE.value,
             ),
         ],

api/features/feature_health/models.py

@@ -1,3 +1,6 @@
+import json
+import typing
+
 from rest_framework import serializers
 
 from features.feature_health.models import (
@@ -8,29 +11,47 @@
 from features.feature_health.providers.services import (
     get_webhook_path_from_provider,
 )
+from features.feature_health.types import (
+    FeatureHealthEventReasonTextBlock,
+    FeatureHealthEventReasonUrlBlock,
+)
 
+FeatureHealthEventReasonStr: typing.TypeAlias = str
 
-class FeatureHealthEventReasonTextBlockSerializer(serializers.Serializer):
+
+class FeatureHealthEventReasonTextBlockSerializer(
+    serializers.Serializer[FeatureHealthEventReasonTextBlock]
+):
     text = serializers.CharField()
     title = serializers.CharField(required=False)
 
 
-class FeatureHealthEventReasonUrlBlockSerializer(serializers.Serializer):
+class FeatureHealthEventReasonUrlBlockSerializer(
+    serializers.Serializer[FeatureHealthEventReasonUrlBlock]
+):
     url = serializers.CharField()
     title = serializers.CharField(required=False)
 
 
-class FeatureHealthEventReasonSerializer(serializers.Serializer):
+class FeatureHealthEventReasonSerializer(
+    serializers.Serializer[FeatureHealthEventReasonStr]
+):
     text_blocks = serializers.ListField(
         child=FeatureHealthEventReasonTextBlockSerializer(),
     )
     url_blocks = serializers.ListField(
         child=FeatureHealthEventReasonUrlBlockSerializer(),
     )
 
+    def to_representation(
+        self,
+        instance: FeatureHealthEventReasonStr,
+    ) -> dict[str, typing.Any]:
+        return super().to_representation(json.loads(instance))
+
 
-class FeatureHealthEventSerializer(serializers.ModelSerializer):
-    reason = FeatureHealthEventReasonSerializer()
+class FeatureHealthEventSerializer(serializers.ModelSerializer[FeatureHealthEvent]):
+    reason = FeatureHealthEventReasonSerializer(allow_null=True)
 
     class Meta:
         model = FeatureHealthEvent

api/features/feature_health/providers/sample/mappers.py

@@ -4,7 +4,8 @@
 
 from typing_extensions import TypedDict
 
-from features.feature_health.models import FeatureHealthEventType
+if typing.TYPE_CHECKING:
+    from features.feature_health.models import FeatureHealthEventType
 
 
 class FeatureHealthEventReasonTextBlock(TypedDict):
@@ -25,9 +26,9 @@ class FeatureHealthEventReason(TypedDict):
 @dataclass
 class FeatureHealthEventData:
     feature_name: str
-    type: FeatureHealthEventType
-    reason: FeatureHealthEventReason
+    type: "FeatureHealthEventType"
     provider_name: str
+    reason: FeatureHealthEventReason | None = None
     environment_name: str | None = None
     external_id: str | None = None
     created_at: datetime | None = None

api/features/feature_health/serializers.py

@@ -11,7 +11,8 @@ def _get_feature_health_provider_webhook_url(
     feature_health_provider_data = {"name": name}
     url = reverse("api-v1:projects:feature-health-providers-list", args=[project])
     response = api_client.post(url, data=feature_health_provider_data)
-    return response.json()["webhook_url"]
+    webhook_url: str = response.json()["webhook_url"]
+    return webhook_url
 
 
 @pytest.fixture

api/features/feature_health/types.py

@@ -125,7 +125,7 @@ def test_webhook__sample_provider__post__expected_feature_health_event_created__
             "environment": None,
             "feature": feature,
             "provider_name": "Sample",
-            "reason": {"text_blocks": [], "url_blocks": []},
+            "reason": None,
             "type": "UNHEALTHY",
         }
     ]
@@ -183,7 +183,7 @@ def test_webhook__sample_provider__post_with_environment_expected_feature_health
             "environment": environment,
             "feature": feature,
             "provider_name": "Sample",
-            "reason": {"text_blocks": [], "url_blocks": []},
+            "reason": None,
             "type": "UNHEALTHY",
         }
     ]
@@ -226,7 +226,7 @@ def test_webhook__unhealthy_feature__post__expected_feature_health_event_created
             "environment": None,
             "feature": unhealthy_feature,
             "provider_name": "Sample",
-            "reason": {"text_blocks": [], "url_blocks": []},
+            "reason": None,
             "type": "HEALTHY",
         }
     ]