feat(feature-health): Backend for health event dismissal (#5845)

Author: khvn26

api/features/feature_health/constants.py

@@ -8,5 +8,7 @@
 FEATURE_HEALTH_EVENT_CREATED_PROVIDER_MESSAGE = "\n\nProvided by %s"
 FEATURE_HEALTH_EVENT_CREATED_REASON_MESSAGE = "\n\nReason:\n%s"
 
+FEATURE_HEALTH_EVENT_MANUALLY_DISMISSED_MESSAGE = "Manually dismissed by %s"
+
 UNHEALTHY_TAG_LABEL = "Unhealthy"
 UNHEALTHY_TAG_COLOUR = "#FFC0CB"

api/features/feature_health/serializers.py

@@ -56,6 +56,7 @@ class FeatureHealthEventSerializer(serializers.ModelSerializer[FeatureHealthEven
     class Meta:
         model = FeatureHealthEvent
         fields = read_only_fields = (
+            "id",
             "created_at",
             "environment",
             "feature",

api/features/feature_health/services.py

@@ -1,9 +1,12 @@
+import json
 import typing
 
 import structlog
 
+from api_keys.user import APIKeyUser
 from environments.models import Environment
 from features.feature_health.constants import (
+    FEATURE_HEALTH_EVENT_MANUALLY_DISMISSED_MESSAGE,
     UNHEALTHY_TAG_COLOUR,
     UNHEALTHY_TAG_LABEL,
 )
@@ -17,8 +20,10 @@
     FeatureHealthProviderName,
 )
 from features.feature_health.providers import grafana, sample
+from features.feature_health.types import FeatureHealthEventReason
 from features.models import Feature
 from projects.tags.models import Tag, TagType
+from users.models import FFAdminUser
 
 if typing.TYPE_CHECKING:
     from features.feature_health.types import FeatureHealthProviderResponse
@@ -107,3 +112,45 @@ def update_feature_unhealthy_tag(feature: "Feature") -> None:
         else:
             feature.tags.remove(unhealthy_tag)
         feature.save()
+
+
+def dismiss_feature_health_event(
+    feature_health_event: FeatureHealthEvent,
+    dismissed_by: FFAdminUser | APIKeyUser,
+) -> None:
+    from features.feature_health import tasks
+
+    if (
+        FeatureHealthEventType(feature_health_event.type)
+        != FeatureHealthEventType.UNHEALTHY
+    ):
+        logger.warning(
+            "feature-health-event-dismissal-not-supported",
+            feature_health_event_id=feature_health_event.id,
+            feature_health_event_external_id=feature_health_event.external_id,
+            feature_health_event_type=feature_health_event.type,
+            provider_name=feature_health_event.provider_name,
+        )
+        return
+
+    reason: FeatureHealthEventReason = {
+        "text_blocks": [
+            {
+                "text": FEATURE_HEALTH_EVENT_MANUALLY_DISMISSED_MESSAGE % dismissed_by,
+            }
+        ],
+        "url_blocks": [],
+    }
+
+    FeatureHealthEvent.objects.create(
+        feature=feature_health_event.feature,
+        environment=feature_health_event.environment,
+        type=FeatureHealthEventType.HEALTHY,
+        reason=json.dumps(reason),
+        provider_name=feature_health_event.provider_name,
+        external_id=feature_health_event.external_id,
+    )
+
+    tasks.update_feature_unhealthy_tag.delay(
+        args=(feature_health_event.feature.id,),
+    )

api/features/feature_health/views.py

@@ -1,10 +1,14 @@
 import typing
 
+from common.projects.permissions import (
+    EDIT_FEATURE,
+    VIEW_PROJECT,
+)
 from django.db.models import QuerySet
 from django.shortcuts import get_object_or_404
 from drf_yasg.utils import swagger_auto_schema  # type: ignore[import-untyped]
 from rest_framework import mixins, status, viewsets
-from rest_framework.decorators import api_view, permission_classes
+from rest_framework.decorators import action, api_view, permission_classes
 from rest_framework.permissions import AllowAny, BasePermission
 from rest_framework.request import Request
 from rest_framework.response import Response
@@ -23,6 +27,7 @@
 )
 from features.feature_health.services import (
     create_feature_health_events_from_provider,
+    dismiss_feature_health_event,
 )
 from projects.models import Project
 from projects.permissions import NestedProjectPermissions
@@ -31,28 +36,44 @@
 
 class FeatureHealthEventViewSet(
     mixins.ListModelMixin,
-    viewsets.GenericViewSet,  # type: ignore[type-arg]
+    viewsets.GenericViewSet[FeatureHealthEvent],
 ):
     serializer_class = FeatureHealthEventSerializer
     pagination_class = None  # set here to ensure documentation is correct
     model_class = FeatureHealthEvent
 
     def get_permissions(self) -> list[BasePermission]:
-        return [NestedProjectPermissions()]
-
-    def get_queryset(self) -> QuerySet[FeatureHealthProvider]:
+        return [
+            NestedProjectPermissions(
+                action_permission_map={
+                    "list": VIEW_PROJECT,
+                    "dismiss": EDIT_FEATURE,
+                },
+                get_project_from_object_callable=FeatureHealthEvent._get_project,  # type: ignore[arg-type]
+            ),
+        ]
+
+    def get_queryset(self) -> QuerySet[FeatureHealthEvent]:
         if getattr(self, "swagger_fake_view", False):
             return self.model_class.objects.none()
 
         project = get_object_or_404(Project, pk=self.kwargs["project_pk"])
         return self.model_class.objects.get_latest_by_project(project)
 
+    @action(detail=True, methods=["POST"], url_path="dismiss")
+    def dismiss(self, *args: typing.Any, **kwargs: typing.Any) -> Response:
+        dismiss_feature_health_event(
+            feature_health_event=self.get_object(),
+            dismissed_by=self.request.user,  # type: ignore[arg-type]
+        )
+        return Response(status=status.HTTP_204_NO_CONTENT)
+
 
 class FeatureHealthProviderViewSet(
     mixins.DestroyModelMixin,
     mixins.CreateModelMixin,
     mixins.ListModelMixin,
-    viewsets.GenericViewSet,  # type: ignore[type-arg]
+    viewsets.GenericViewSet[FeatureHealthProvider],
 ):
     serializer_class = FeatureHealthProviderSerializer
     pagination_class = None  # set here to ensure documentation is correct
@@ -80,7 +101,12 @@ def get_object(self) -> FeatureHealthProvider:
         request_body=CreateFeatureHealthProviderSerializer,
         responses={status.HTTP_201_CREATED: FeatureHealthProviderSerializer()},
     )
-    def create(self, request: Request, *args, **kwargs) -> Response:  # type: ignore[no-untyped-def]
+    def create(
+        self,
+        request: Request,
+        *args: typing.Any,
+        **kwargs: typing.Any,
+    ) -> Response:
         request_serializer = CreateFeatureHealthProviderSerializer(data=request.data)
         request_serializer.is_valid(raise_exception=True)
 
@@ -108,9 +134,9 @@ def create(self, request: Request, *args, **kwargs) -> Response:  # type: ignore
         )
 
 
-@api_view(["POST"])  # type: ignore[arg-type]
+@api_view(["POST"])
 @permission_classes([AllowAny])
-def feature_health_webhook(request: Request, **kwargs: typing.Any) -> Response:
+def feature_health_webhook(request: Request, /, **kwargs: typing.Any) -> Response:
     path = kwargs["path"]
     if not (provider := get_provider_from_webhook_path(path)):
         return Response(status=status.HTTP_404_NOT_FOUND)

api/tests/integration/features/feature_health/conftest.py

@@ -41,6 +41,21 @@ def unhealthy_feature(
     return feature
 
 
+@pytest.fixture
+def unhealthy_feature_health_event(
+    project: int,
+    unhealthy_feature: int,
+    admin_client_new: APIClient,
+) -> int:
+    url = reverse(
+        "api-v1:projects:feature-health-events-list",
+        args=[project],
+    )
+    response = admin_client_new.get(url)
+    unhealthy_feature_health_event_id: int = response.json()[0]["id"]
+    return unhealthy_feature_health_event_id
+
+
 @pytest.fixture
 def grafana_feature_health_provider_webhook_url(
     project: int, admin_client_new: APIClient

api/tests/integration/features/feature_health/test_views.py

@@ -20,6 +20,16 @@ def expected_created_by(
     return None
 
 
+@pytest.fixture
+def expected_dismissed_by(
+    admin_client_auth_type: AdminClientAuthType,
+    admin_user_email: str,
+) -> str:
+    if admin_client_auth_type == "user":
+        return admin_user_email
+    return "test_key"
+
+
 def test_feature_health_providers__get__expected_response(
     project: int,
     admin_client_new: APIClient,
@@ -76,6 +86,70 @@ def test_feature_health_providers__delete__expected_response(
     assert response.json() == []
 
 
+def test_feature_health_events__dismiss__unauthorized__expected_response(
+    project: int,
+    unhealthy_feature_health_event: int,
+    test_user_client: APIClient,
+) -> None:
+    # Given
+    feature_health_events_dismiss_url = reverse(
+        "api-v1:projects:feature-health-events-dismiss",
+        args=[project, unhealthy_feature_health_event],
+    )
+
+    # When
+    response = test_user_client.post(feature_health_events_dismiss_url)
+
+    # Then
+    assert response.status_code == 403
+    assert response.json() == {
+        "detail": "You do not have permission to perform this action."
+    }
+
+
+@pytest.mark.freeze_time("2023-01-19T09:09:47.325132+00:00")
+def test_feature_health_events__dismiss__expected_response(
+    project: int,
+    unhealthy_feature: int,
+    unhealthy_feature_health_event: int,
+    admin_client_new: APIClient,
+    expected_dismissed_by: str,
+    mocker: MockerFixture,
+) -> None:
+    # Given
+    feature_health_events_url = reverse(
+        "api-v1:projects:feature-health-events-list", args=[project]
+    )
+    feature_health_events_dismiss_url = reverse(
+        "api-v1:projects:feature-health-events-dismiss",
+        args=[project, unhealthy_feature_health_event],
+    )
+
+    # When
+    with freeze_time("2023-01-19T10:09:47.325132+00:00"):
+        response = admin_client_new.post(feature_health_events_dismiss_url)
+
+    # Then
+    assert response.status_code == 204
+    response = admin_client_new.get(feature_health_events_url)
+    assert response.json() == [
+        {
+            "created_at": "2023-01-19T10:09:47.325132Z",
+            "environment": None,
+            "feature": unhealthy_feature,
+            "id": mocker.ANY,
+            "provider_name": "Sample",
+            "reason": {
+                "text_blocks": [
+                    {"text": f"Manually dismissed by {expected_dismissed_by}"}
+                ],
+                "url_blocks": [],
+            },
+            "type": "HEALTHY",
+        },
+    ]
+
+
 def test_webhook__invalid_path__expected_response(
     api_client: APIClient,
 ) -> None:
@@ -97,6 +171,7 @@ def test_webhook__sample_provider__post__expected_feature_health_event_created__
     sample_feature_health_provider_webhook_url: str,
     api_client: APIClient,
     admin_client_new: APIClient,
+    mocker: MockerFixture,
 ) -> None:
     # Given
     feature_health_events_url = reverse(
@@ -121,6 +196,7 @@ def test_webhook__sample_provider__post__expected_feature_health_event_created__
     response = admin_client_new.get(feature_health_events_url)
     assert response.json() == [
         {
+            "id": mocker.ANY,
             "created_at": "2023-01-19T09:09:47.325132Z",
             "environment": None,
             "feature": feature,
@@ -156,6 +232,7 @@ def test_webhook__sample_provider__post_with_environment_expected_feature_health
     sample_feature_health_provider_webhook_url: str,
     api_client: APIClient,
     admin_client_new: APIClient,
+    mocker: MockerFixture,
 ) -> None:
     # Given
     feature_health_events_url = reverse(
@@ -179,6 +256,7 @@ def test_webhook__sample_provider__post_with_environment_expected_feature_health
     response = admin_client_new.get(feature_health_events_url)
     assert response.json() == [
         {
+            "id": mocker.ANY,
             "created_at": "2023-01-19T09:09:47.325132Z",
             "environment": environment,
             "feature": feature,
@@ -197,6 +275,7 @@ def test_webhook__unhealthy_feature__post__expected_feature_health_event_created
     sample_feature_health_provider_webhook_url: str,
     api_client: APIClient,
     admin_client_new: APIClient,
+    mocker: MockerFixture,
 ) -> None:
     # Given
     feature_health_events_url = reverse(
@@ -222,6 +301,7 @@ def test_webhook__unhealthy_feature__post__expected_feature_health_event_created
     response = admin_client_new.get(feature_health_events_url)
     assert response.json() == [
         {
+            "id": mocker.ANY,
             "created_at": "2023-01-19T09:09:48.325132Z",
             "environment": None,
             "feature": unhealthy_feature,
@@ -273,6 +353,7 @@ def test_webhook__grafana_provider__post__expected_feature_health_event_created(
     grafana_feature_health_provider_webhook_url: str,
     api_client: APIClient,
     admin_client_new: APIClient,
+    mocker: MockerFixture,
 ) -> None:
     # Given
     feature_health_events_url = reverse(
@@ -335,6 +416,7 @@ def test_webhook__grafana_provider__post__expected_feature_health_event_created(
     response = admin_client_new.get(feature_health_events_url)
     assert response.json() == [
         {
+            "id": mocker.ANY,
             "created_at": "2025-02-12T21:06:50Z",
             "environment": None,
             "feature": feature,
@@ -354,6 +436,7 @@ def test_webhook__grafana_provider__post__multiple__expected_feature_health_even
     grafana_feature_health_provider_webhook_url: str,
     api_client: APIClient,
     admin_client_new: APIClient,
+    mocker: MockerFixture,
 ) -> None:
     # Given
     feature_health_events_url = reverse(
@@ -502,6 +585,7 @@ def test_webhook__grafana_provider__post__multiple__expected_feature_health_even
         # second firing alert has not been resolved
         # and provided an environment label
         {
+            "id": mocker.ANY,
             "created_at": "2025-02-12T21:07:50Z",
             "environment": environment,
             "feature": feature,
@@ -511,6 +595,7 @@ def test_webhook__grafana_provider__post__multiple__expected_feature_health_even
         },
         # first firing alert has been resolved
         {
+            "id": mocker.ANY,
             "created_at": "2025-02-12T21:12:50Z",
             "environment": None,
             "feature": feature,