Include extra details in $feature_flag_called events

Author: haacked

posthog/client.py

@@ -847,16 +847,10 @@ def get_feature_flag(
         flag_was_locally_evaluated = response is not None
         if not flag_was_locally_evaluated and not only_evaluate_locally:
             try:
-                feature_flags = self.get_feature_variants(
-                    distinct_id,
-                    groups=groups,
-                    person_properties=person_properties,
-                    group_properties=group_properties,
-                    disable_geoip=disable_geoip,
+                flag_details, request_id = self._get_feature_flag_details_from_decide(
+                    key, distinct_id, groups, person_properties, group_properties, disable_geoip
                 )
-                response = feature_flags.get(key)
-                if response is None:
-                    response = False
+                response = flag_details.get_value() if flag_details else False
                 self.log.debug(f"Successfully computed flag remotely: #{key} -> #{response}")
             except Exception as e:
                 self.log.exception(f"[FEATURE FLAGS] Unable to get flag remotely: {e}")
@@ -871,7 +865,7 @@ def get_feature_flag(
                 groups,
                 disable_geoip,
                 request_id,
-                flag_details
+                flag_details,
             )
 
         return response
@@ -943,20 +937,15 @@ def get_feature_flag_payload(
         flag_was_locally_evaluated = payload is not None
         if not flag_was_locally_evaluated and not only_evaluate_locally:
             try:
-                responses_and_payloads = self.get_feature_flags_and_payloads(
-                    distinct_id, groups, person_properties, group_properties, disable_geoip
+                flag_details, request_id = self._get_feature_flag_details_from_decide(
+                    key, distinct_id, groups, person_properties, group_properties, disable_geoip
                 )
-                featureFlags = responses_and_payloads["featureFlags"]
-                if featureFlags is not None:
-                    response = featureFlags.get(key, None)
-
-                featureFlagPayloads = responses_and_payloads["featureFlagPayloads"]
-                if featureFlagPayloads is not None:
-                    payload = featureFlagPayloads.get(str(key), None)
+                payload = flag_details.metadata.payload if flag_details else None
+                response = flag_details.get_value() if flag_details else False
             except Exception as e:
                 self.log.exception(f"[FEATURE FLAGS] Unable to get feature flags and payloads: {e}")
 
-        if (send_feature_flag_events):
+        if send_feature_flag_events:
             self._capture_feature_flag_called(
                 distinct_id,
                 key,
@@ -966,11 +955,29 @@ def get_feature_flag_payload(
                 groups,
                 disable_geoip,
                 request_id,
-                flag_details
+                flag_details,
             )
 
         return payload
 
+    def _get_feature_flag_details_from_decide(
+        self,
+        key: str,
+        distinct_id: str,
+        groups: dict[str, str],
+        person_properties: dict[str, str],
+        group_properties: dict[str, str],
+        disable_geoip: bool | None,
+    ) -> tuple[FeatureFlag | None, str]:
+        """
+        Calls /decide and returns the flag details and request id
+        """
+        resp_data = self.get_decide(distinct_id, groups, person_properties, group_properties, disable_geoip)
+        request_id = resp_data.get("requestId")
+        flags = resp_data.get("flags")
+        flag_details = flags.get(key)
+        return flag_details, request_id
+
     def _capture_feature_flag_called(
         self,
         distinct_id: str,
@@ -1006,7 +1013,7 @@ def _capture_feature_flag_called(
                         properties["$feature_flag_version"] = flag_details.metadata.version
                     if flag_details.metadata.id:
                         properties["$feature_flag_id"] = flag_details.metadata.id
-                
+
             self.capture(
                 distinct_id,
                 "$feature_flag_called",

posthog/test/test_feature_flags.py

@@ -2393,6 +2393,8 @@ def test_capture_is_called_with_flag_details_and_payload(self, patch_decide, pat
                     "enabled": True,
                     "variant": None,
                     "reason": {
+                        "code": "matched_condition",
+                        "condition_index": 0,
                         "description": "Matched condition set 1",
                     },
                     "metadata": {
@@ -2413,9 +2415,9 @@ def test_capture_is_called_with_flag_details_and_payload(self, patch_decide, pat
             "$feature_flag_called",
             {
                 "$feature_flag": "decide-flag-with-payload",
-                "$feature_flag_response": None,
+                "$feature_flag_response": True,
                 "locally_evaluated": False,
-                "$feature/decide-flag-with-payload": None,
+                "$feature/decide-flag-with-payload": True,
                 "$feature_flag_reason": "Matched condition set 1",
                 "$feature_flag_id": 23,
                 "$feature_flag_version": 42,

posthog/types.py

@@ -9,6 +9,16 @@ class FlagReason:
     condition_index: int
     description: str
 
+    @classmethod
+    def from_json(cls, resp: Any) -> "FlagReason":
+        if not resp:
+            return None
+        return cls(
+            code=resp.get("code", ""),
+            condition_index=resp.get("condition_index", 0),
+            description=resp.get("description", "")
+        )
+
 
 @dataclass(frozen=True)
 class FlagMetadata:
@@ -17,6 +27,16 @@ class FlagMetadata:
     version: int
     description: str
 
+    @classmethod
+    def from_json(cls, resp: Any) -> "FlagMetadata":
+        if not resp:
+            return None
+        return cls(
+            id=resp.get("id", 0),
+            payload=resp.get("payload"),
+            version=resp.get("version", 0),
+            description=resp.get("description", "")
+        )
 
 @dataclass(frozen=True)
 class LegacyFlagMetadata:
@@ -39,26 +59,17 @@ def get_value(self) -> FlagValue:
     def from_json(cls, resp: Any) -> "FeatureFlag":
         reason = None
         if resp.get("reason"):
-            reason = FlagReason(
-                code=resp["reason"].get("code", ""),
-                condition_index=resp["reason"].get("condition_index", 0),
-                description=resp["reason"].get("description", "")
-            )
+            reason = FlagReason.from_json(resp.get("reason"))
 
         metadata = None
         if resp.get("metadata"):
-            metadata = FlagMetadata(
-                id=resp["metadata"].get("id", 0),
-                payload=resp["metadata"].get("payload"),
-                version=resp["metadata"].get("version", 0),
-                description=resp["metadata"].get("description", "")
-            )
+            metadata = FlagMetadata.from_json(resp.get("metadata"))
         else:
             metadata = LegacyFlagMetadata(payload=None)
 
         return cls(
-            key=resp["key"],
-            enabled=resp["enabled"],
+            key=resp.get("key"),
+            enabled=resp.get("enabled"),
             variant=resp.get("variant"),
             reason=reason,
             metadata=metadata