fix: Fix Sentry Change Tracking response handling (#5573)

Author: emyller

api/integrations/sentry/change_tracking.py

@@ -1,8 +1,8 @@
 import json
-import logging
 from typing import Any
 
 import requests
+import structlog
 from django.core.serializers.json import DjangoJSONEncoder
 
 from audit.models import AuditLog
@@ -11,7 +11,7 @@
 from features.models import FeatureState
 from integrations.common.wrapper import AbstractBaseEventIntegrationWrapper
 
-logger = logging.getLogger(__name__)
+logger = structlog.get_logger("sentry_change_tracking")
 
 
 class SentryChangeTracking(AbstractBaseEventIntegrationWrapper):
@@ -59,17 +59,19 @@ def generate_event_data(audit_log_record: AuditLog) -> dict[str, Any]:
                 "id": getattr(audit_log_record.author, "email", "app@flagsmith.com"),
                 "type": "email",
             },
+            "change_id": str(feature_state.pk),
         }
 
-        if action == "updated":
-            inner_payload["change_id"] = str(feature_state.pk)
-
         return inner_payload
 
     def _track_event(self, event: dict[str, Any]) -> None:
         action = event["action"]
         feature_name = event["flag"]
-        logger.debug("Sending '%s' (%s) to Sentry...", feature_name, action)
+
+        log = logger.bind(
+            sentry_action=action,
+            feature_name=feature_name,
+        )
 
         payload = {
             "data": [event],
@@ -82,21 +84,33 @@ def _track_event(self, event: dict[str, Any]) -> None:
             "X-Sentry-Signature": sign_payload(json_payload, self.secret),
         }
 
-        response = requests.post(
+        log.debug(
+            "sending",
             url=self.webhook_url,
             headers=headers,
-            data=json_payload,
+            payload=payload,
         )
 
         try:
-            response.raise_for_status()
+            response = requests.post(
+                url=self.webhook_url,
+                headers=headers,
+                data=json_payload,
+            )
+            response.raise_for_status()  # NOTE: This is for future-proofing, as Sentry won't respond 4xx.
         except requests.exceptions.RequestException as error:
-            # TODO: Should we retry, or ultimately notify the admin of a persisting issue?
-            logger.error(
-                "Error sending '%s' (%s) to Sentry: %s",
-                feature_name,
-                action,
-                repr(error),
+            log.warning(
+                "request-failure",
+                error=error,
             )
-        else:
-            logger.debug("Sent '%s' (%s) to Sentry", feature_name, action)
+            return
+
+        if not response.text:  # This is fragile and undocumented. ¯\_(ツ)_/¯
+            log.info("success")
+            return
+
+        log.warning(
+            "integration-error",
+            sentry_response_status=response.status_code,
+            sentry_response_body=response.text,
+        )

api/poetry.lock

@@ -236,6 +236,7 @@ types-python-dateutil = "^2.9.0.20241206"
 types-pytz = "^2025.1.0.20250204"
 ruff = "^0.9.7"
 flagsmith-common = { version = "*", extras = ["test-tools"] }
+pytest-responses = "^0.5.1"
 
 [build-system]
 requires = ["poetry>=2.0.0"]