feat/wire-analytics-pipeline-to-flag-evaluation

Author: Zaimwa9

flagsmith/models.py

@@ -3,7 +3,7 @@
 import typing
 from dataclasses import dataclass, field
 
-from flagsmith.analytics import AnalyticsProcessor
+from flagsmith.analytics import AnalyticsProcessor, PipelineAnalyticsProcessor
 from flagsmith.exceptions import FlagsmithFeatureDoesNotExistError
 from flagsmith.types import SDKEvaluationResult, SDKFlagResult
 
@@ -57,13 +57,19 @@ class Flags:
     flags: typing.Dict[str, Flag] = field(default_factory=dict)
     default_flag_handler: typing.Optional[typing.Callable[[str], DefaultFlag]] = None
     _analytics_processor: typing.Optional[AnalyticsProcessor] = None
+    _pipeline_analytics_processor: typing.Optional[PipelineAnalyticsProcessor] = None
+    _identity_identifier: typing.Optional[str] = None
+    _traits: typing.Optional[typing.Dict[str, typing.Any]] = None
 
     @classmethod
     def from_evaluation_result(
         cls,
         evaluation_result: SDKEvaluationResult,
         analytics_processor: typing.Optional[AnalyticsProcessor],
         default_flag_handler: typing.Optional[typing.Callable[[str], DefaultFlag]],
+        pipeline_analytics_processor: typing.Optional[PipelineAnalyticsProcessor] = None,
+        identity_identifier: typing.Optional[str] = None,
+        traits: typing.Optional[typing.Dict[str, typing.Any]] = None,
     ) -> Flags:
         return cls(
             flags={
@@ -73,6 +79,9 @@ def from_evaluation_result(
             },
             default_flag_handler=default_flag_handler,
             _analytics_processor=analytics_processor,
+            _pipeline_analytics_processor=pipeline_analytics_processor,
+            _identity_identifier=identity_identifier,
+            _traits=traits,
         )
 
     @classmethod
@@ -81,6 +90,9 @@ def from_api_flags(
         api_flags: typing.Sequence[typing.Mapping[str, typing.Any]],
         analytics_processor: typing.Optional[AnalyticsProcessor],
         default_flag_handler: typing.Optional[typing.Callable[[str], DefaultFlag]],
+        pipeline_analytics_processor: typing.Optional[PipelineAnalyticsProcessor] = None,
+        identity_identifier: typing.Optional[str] = None,
+        traits: typing.Optional[typing.Dict[str, typing.Any]] = None,
     ) -> Flags:
         flags = {
             flag_data["feature"]["name"]: Flag.from_api_flag(flag_data)
@@ -91,6 +103,9 @@ def from_api_flags(
             flags=flags,
             default_flag_handler=default_flag_handler,
             _analytics_processor=analytics_processor,
+            _pipeline_analytics_processor=pipeline_analytics_processor,
+            _identity_identifier=identity_identifier,
+            _traits=traits,
         )
 
     def all_flags(self) -> typing.List[Flag]:
@@ -141,6 +156,15 @@ def get_flag(self, feature_name: str) -> typing.Union[DefaultFlag, Flag]:
         if self._analytics_processor and hasattr(flag, "feature_name"):
             self._analytics_processor.track_feature(flag.feature_name)
 
+        if self._pipeline_analytics_processor and hasattr(flag, "feature_name"):
+            self._pipeline_analytics_processor.record_evaluation_event(
+                flag_key=flag.feature_name,
+                enabled=flag.enabled,
+                value=flag.value,
+                identity_identifier=self._identity_identifier,
+                traits=self._traits,
+            )
+
         return flag
 
 

tests/test_models.py

@@ -1,7 +1,9 @@
 import typing
+from unittest import mock
 
 import pytest
 
+from flagsmith.analytics import PipelineAnalyticsProcessor
 from flagsmith.models import Flag, Flags
 from flagsmith.types import SDKEvaluationResult, SDKFlagResult
 
@@ -149,3 +151,33 @@ def test_flag_from_evaluation_result_missing_metadata__raises_expected() -> None
     # When & Then
     with pytest.raises(ValueError):
         Flag.from_evaluation_result(flag_result)
+
+
+def test_get_flag_records_pipeline_evaluation_event(
+    pipeline_analytics_processor: PipelineAnalyticsProcessor,
+) -> None:
+    flags = Flags(
+        flags={"my_feature": Flag(enabled=True, value="v1", feature_name="my_feature", feature_id=1)},
+        _pipeline_analytics_processor=pipeline_analytics_processor,
+        _identity_identifier="user123",
+        _traits={"plan": "premium"},
+    )
+
+    with mock.patch.object(pipeline_analytics_processor, "record_evaluation_event") as mock_record:
+        flags.get_flag("my_feature")
+
+    mock_record.assert_called_once_with(
+        flag_key="my_feature",
+        enabled=True,
+        value="v1",
+        identity_identifier="user123",
+        traits={"plan": "premium"},
+    )
+
+
+def test_get_flag_without_pipeline_processor() -> None:
+    flags = Flags(
+        flags={"my_feature": Flag(enabled=True, value="v1", feature_name="my_feature", feature_id=1)},
+    )
+    flag = flags.get_flag("my_feature")
+    assert flag.enabled is True