Skip to content

fix: send flag id and version on locally evaluated $feature_flag_called #1149

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
andehen wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

fix: send flag id and version on locally evaluated $feature_flag_called #1149

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .sampo/changesets/local-flag-called-id-version.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
pypi/posthog: patch
---

Add `$feature_flag_id` and `$feature_flag_version` to `$feature_flag_called` events for locally evaluated flags in `get_feature_flag()`, `feature_enabled()` and `get_feature_flag_result()`, and `$feature_flag_version` for locally evaluated flags in `evaluate_flags()`, taken from the flag definition. Remotely evaluated flags already sent both.
20 changes: 16 additions & 4 deletions posthog/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4149,12 +4149,18 @@ def _get_feature_flag_result(
# Source the gate the same way as has_experiment above; see
# _capture_feature_flag_called_if_needed for why.
minimal_flag_called_events = self._minimal_flag_called_events
# Remotely-evaluated flags carry id and version in the response metadata;
# locally-evaluated flags read them from the definition that produced the value.
local_flag_id: Optional[int] = None
local_flag_version: Optional[int] = None
if flag_was_locally_evaluated:
local_def = (self.feature_flags_by_key or {}).get(key)
local_def = snapshot["flags_by_key"].get(key)
if isinstance(local_def, dict):
has_experiment = _parse_has_experiment(
local_def.get("has_experiment")
)
local_flag_id = local_def.get("id")
local_flag_version = local_def.get("version")
elif isinstance(flag_details, FeatureFlag):
has_experiment = _metadata_has_experiment(flag_details.metadata)
minimal_flag_called_events = remote_minimal_flag_called_events
Expand All @@ -4173,6 +4179,8 @@ def _get_feature_flag_result(
feature_flag_error,
has_experiment,
minimal_flag_called_events,
local_flag_id=local_flag_id,
local_flag_version=local_flag_version,
)

return flag_result
Expand Down Expand Up @@ -4462,6 +4470,8 @@ def _capture_feature_flag_called(
feature_flag_error: Optional[str] = None,
has_experiment: Optional[bool] = None,
minimal_flag_called_events: bool = False,
local_flag_id: Optional[int] = None,
local_flag_version: Optional[int] = None,
):
properties: dict[str, Any] = {
"$feature_flag": key,
Expand All @@ -4486,6 +4496,10 @@ 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
if local_flag_version:
properties["$feature_flag_version"] = local_flag_version
if local_flag_id:
properties["$feature_flag_id"] = local_flag_id
if feature_flag_error:
properties["$feature_flag_error"] = feature_flag_error

Expand Down Expand Up @@ -4921,9 +4935,7 @@ def evaluate_flags(
variant=value if isinstance(value, str) else None,
payload=_parse_flag_payload(local_payloads.get(key)),
id=flag_def.get("id"),
# The local-evaluation flag definition does not carry a version field;
# only the remote ``/flags`` response does via ``metadata.version``.
version=None,
version=flag_def.get("version"),
reason="Evaluated locally",
locally_evaluated=True,
has_experiment=_parse_has_experiment(flag_def.get("has_experiment")),
Expand Down
32 changes: 32 additions & 0 deletions posthog/test/test_evaluate_flags.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -431,6 +431,38 @@ def test_flag_called_event_carries_parsed_local_payload(
self.assertEqual(properties["$feature_flag_payload"], {"copy": "new"})


class TestEvaluateFlagsLocalFlagIdentity(unittest.TestCase):
"""Locally-evaluated flags report the definition's id and version, the same
properties remote ``/flags`` metadata supplies."""

def setUp(self):
self.client = Client(FAKE_TEST_API_KEY, secret_key="test")
self.client.feature_flags = [
_always_on_flag("local-flag", id=4211, version=7),
_always_on_flag("unversioned-flag", id=4212),
]

def tearDown(self):
self.client.shutdown()

@mock.patch("posthog.client.flags")
@mock.patch.object(Client, "capture")
def test_flag_called_event_carries_definition_id_and_version(
self, patch_capture, patch_flags
):
flags = self.client.evaluate_flags("user-1")
flags.is_enabled("local-flag")
flags.get_flag("unversioned-flag")

patch_flags.assert_not_called()
properties = _flag_called_properties(patch_capture)
self.assertTrue(properties["local-flag"]["locally_evaluated"])
self.assertEqual(properties["local-flag"]["$feature_flag_id"], 4211)
self.assertEqual(properties["local-flag"]["$feature_flag_version"], 7)
self.assertEqual(properties["unversioned-flag"]["$feature_flag_id"], 4212)
self.assertNotIn("$feature_flag_version", properties["unversioned-flag"])


class TestEvaluateFlagsMissingLocalDefinition(unittest.TestCase):
def setUp(self):
self.client = Client(FAKE_TEST_API_KEY, secret_key="test")
Expand Down
1 change: 1 addition & 0 deletions posthog/test/test_feature_flag_called_minimization.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -297,6 +297,7 @@ def test_gated_non_experiment_flag_sends_exactly_the_allowlist(
{
"$feature_flag",
"$feature_flag_response",
"$feature_flag_id",
"$feature_flag_has_experiment",
"locally_evaluated",
"$lib",
Expand Down
3 changes: 3 additions & 0 deletions posthog/test/test_feature_flag_result.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,6 +242,7 @@ def test_get_feature_flag_result_boolean_local_evaluation(self, patch_capture):
"locally_evaluated": True,
"$feature/person-flag": True,
"$feature_flag_payload": 300,
"$feature_flag_id": 1,
},
groups={},
disable_geoip=None,
Expand Down Expand Up @@ -299,6 +300,7 @@ def test_get_feature_flag_result_variant_local_evaluation(self, patch_capture):
"locally_evaluated": True,
"$feature/person-flag": "variant-1",
"$feature_flag_payload": {"some": "value"},
"$feature_flag_id": 1,
},
groups={},
disable_geoip=None,
Expand All @@ -323,6 +325,7 @@ def test_get_feature_flag_result_variant_local_evaluation(self, patch_capture):
"$feature_flag_response": "variant-2",
"locally_evaluated": True,
"$feature/person-flag": "variant-2",
"$feature_flag_id": 1,
},
groups={},
disable_geoip=None,
Expand Down
39 changes: 39 additions & 0 deletions posthog/test/test_feature_flags.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7181,6 +7181,41 @@ def test_year_parsing(self):


class TestCaptureCalls(unittest.TestCase):
@parameterized.expand(
[
("get_feature_flag", lambda c: c.get_feature_flag),
("feature_enabled", lambda c: c.feature_enabled),
("get_feature_flag_result", lambda c: c.get_feature_flag_result),
]
)
@mock.patch.object(Client, "capture")
@mock.patch("posthog.client.flags")
def test_locally_evaluated_flag_called_event_carries_definition_id_and_version(
self, _name, getter, patch_flags, patch_capture
):
client = Client(FAKE_TEST_API_KEY, secret_key=FAKE_TEST_API_KEY)
client.feature_flags = [
{
"id": 4211,
"version": 7,
"name": "Local Feature",
"key": "local-flag",
"active": True,
"filters": {
"groups": [{"properties": [], "rollout_percentage": 100}],
},
}
]

self.assertTrue(getter(client)("local-flag", "some-distinct-id"))

patch_flags.assert_not_called()
patch_capture.assert_called_once()
properties = patch_capture.call_args[1]["properties"]
self.assertTrue(properties["locally_evaluated"])
self.assertEqual(properties["$feature_flag_id"], 4211)
self.assertEqual(properties["$feature_flag_version"], 7)

@mock.patch.object(Client, "capture")
@mock.patch("posthog.client.flags")
def test_capture_is_called(self, patch_flags, patch_capture):
Expand Down Expand Up @@ -7219,6 +7254,7 @@ def test_capture_is_called(self, patch_flags, patch_capture):
"$feature_flag_response": True,
"locally_evaluated": True,
"$feature/complex-flag": True,
"$feature_flag_id": 1,
},
groups={},
disable_geoip=None,
Expand Down Expand Up @@ -7253,6 +7289,7 @@ def test_capture_is_called(self, patch_flags, patch_capture):
"$feature_flag_response": True,
"locally_evaluated": True,
"$feature/complex-flag": True,
"$feature_flag_id": 1,
},
groups={},
disable_geoip=None,
Expand Down Expand Up @@ -7591,6 +7628,7 @@ def test_disable_geoip_get_flag_capture_call(self, patch_flags, patch_capture):
"$feature_flag_response": True,
"locally_evaluated": True,
"$feature/complex-flag": True,
"$feature_flag_id": 1,
},
groups={},
disable_geoip=False,
Expand Down Expand Up @@ -7713,6 +7751,7 @@ def test_capture_multiple_users_doesnt_out_of_memory(
"$feature_flag_response": True,
"locally_evaluated": True,
"$feature/complex-flag": True,
"$feature_flag_id": 1,
},
groups={},
disable_geoip=None,
Expand Down
Loading