Skip to content

Commit e24100b

Browse files
authored
fix: send flag id and version on locally evaluated $feature_flag_called (#1149)
Locally evaluated flags in get_feature_flag(), feature_enabled() and get_feature_flag_result() sent $feature_flag_called without $feature_flag_id or $feature_flag_version, because both were read only from remote /flags metadata. Read them from the local flag definition that produced the value. evaluate_flags() already sent the id for local flags but dropped the definition's version; send it too.
1 parent b10c38a commit e24100b

6 files changed

Lines changed: 96 additions & 4 deletions

File tree

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
pypi/posthog: patch
3+
---
4+
5+
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.

‎posthog/client.py‎

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4211,12 +4211,18 @@ def _get_feature_flag_result(
42114211
# Source the gate the same way as has_experiment above; see
42124212
# _capture_feature_flag_called_if_needed for why.
42134213
minimal_flag_called_events = self._minimal_flag_called_events
4214+
# Remotely-evaluated flags carry id and version in the response metadata;
4215+
# locally-evaluated flags read them from the definition that produced the value.
4216+
local_flag_id: Optional[int] = None
4217+
local_flag_version: Optional[int] = None
42144218
if flag_was_locally_evaluated:
4215-
local_def = (self.feature_flags_by_key or {}).get(key)
4219+
local_def = snapshot["flags_by_key"].get(key)
42164220
if isinstance(local_def, dict):
42174221
has_experiment = _parse_has_experiment(
42184222
local_def.get("has_experiment")
42194223
)
4224+
local_flag_id = local_def.get("id")
4225+
local_flag_version = local_def.get("version")
42204226
elif isinstance(flag_details, FeatureFlag):
42214227
has_experiment = _metadata_has_experiment(flag_details.metadata)
42224228
minimal_flag_called_events = remote_minimal_flag_called_events
@@ -4235,6 +4241,8 @@ def _get_feature_flag_result(
42354241
feature_flag_error,
42364242
has_experiment,
42374243
minimal_flag_called_events,
4244+
local_flag_id=local_flag_id,
4245+
local_flag_version=local_flag_version,
42384246
)
42394247

42404248
return flag_result
@@ -4524,6 +4532,8 @@ def _capture_feature_flag_called(
45244532
feature_flag_error: Optional[str] = None,
45254533
has_experiment: Optional[bool] = None,
45264534
minimal_flag_called_events: bool = False,
4535+
local_flag_id: Optional[int] = None,
4536+
local_flag_version: Optional[int] = None,
45274537
):
45284538
properties: dict[str, Any] = {
45294539
"$feature_flag": key,
@@ -4548,6 +4558,10 @@ def _capture_feature_flag_called(
45484558
properties["$feature_flag_version"] = flag_details.metadata.version
45494559
if flag_details.metadata.id:
45504560
properties["$feature_flag_id"] = flag_details.metadata.id
4561+
if local_flag_version:
4562+
properties["$feature_flag_version"] = local_flag_version
4563+
if local_flag_id:
4564+
properties["$feature_flag_id"] = local_flag_id
45514565
if feature_flag_error:
45524566
properties["$feature_flag_error"] = feature_flag_error
45534567

@@ -4983,9 +4997,7 @@ def evaluate_flags(
49834997
variant=value if isinstance(value, str) else None,
49844998
payload=_parse_flag_payload(local_payloads.get(key)),
49854999
id=flag_def.get("id"),
4986-
# The local-evaluation flag definition does not carry a version field;
4987-
# only the remote ``/flags`` response does via ``metadata.version``.
4988-
version=None,
5000+
version=flag_def.get("version"),
49895001
reason="Evaluated locally",
49905002
locally_evaluated=True,
49915003
has_experiment=_parse_has_experiment(flag_def.get("has_experiment")),

‎posthog/test/test_evaluate_flags.py‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -431,6 +431,38 @@ def test_flag_called_event_carries_parsed_local_payload(
431431
self.assertEqual(properties["$feature_flag_payload"], {"copy": "new"})
432432

433433

434+
class TestEvaluateFlagsLocalFlagIdentity(unittest.TestCase):
435+
"""Locally-evaluated flags report the definition's id and version, the same
436+
properties remote ``/flags`` metadata supplies."""
437+
438+
def setUp(self):
439+
self.client = Client(FAKE_TEST_API_KEY, secret_key="test")
440+
self.client.feature_flags = [
441+
_always_on_flag("local-flag", id=4211, version=7),
442+
_always_on_flag("unversioned-flag", id=4212),
443+
]
444+
445+
def tearDown(self):
446+
self.client.shutdown()
447+
448+
@mock.patch("posthog.client.flags")
449+
@mock.patch.object(Client, "capture")
450+
def test_flag_called_event_carries_definition_id_and_version(
451+
self, patch_capture, patch_flags
452+
):
453+
flags = self.client.evaluate_flags("user-1")
454+
flags.is_enabled("local-flag")
455+
flags.get_flag("unversioned-flag")
456+
457+
patch_flags.assert_not_called()
458+
properties = _flag_called_properties(patch_capture)
459+
self.assertTrue(properties["local-flag"]["locally_evaluated"])
460+
self.assertEqual(properties["local-flag"]["$feature_flag_id"], 4211)
461+
self.assertEqual(properties["local-flag"]["$feature_flag_version"], 7)
462+
self.assertEqual(properties["unversioned-flag"]["$feature_flag_id"], 4212)
463+
self.assertNotIn("$feature_flag_version", properties["unversioned-flag"])
464+
465+
434466
class TestEvaluateFlagsMissingLocalDefinition(unittest.TestCase):
435467
def setUp(self):
436468
self.client = Client(FAKE_TEST_API_KEY, secret_key="test")

‎posthog/test/test_feature_flag_called_minimization.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -297,6 +297,7 @@ def test_gated_non_experiment_flag_sends_exactly_the_allowlist(
297297
{
298298
"$feature_flag",
299299
"$feature_flag_response",
300+
"$feature_flag_id",
300301
"$feature_flag_has_experiment",
301302
"locally_evaluated",
302303
"$lib",

‎posthog/test/test_feature_flag_result.py‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -242,6 +242,7 @@ def test_get_feature_flag_result_boolean_local_evaluation(self, patch_capture):
242242
"locally_evaluated": True,
243243
"$feature/person-flag": True,
244244
"$feature_flag_payload": 300,
245+
"$feature_flag_id": 1,
245246
},
246247
groups={},
247248
disable_geoip=None,
@@ -299,6 +300,7 @@ def test_get_feature_flag_result_variant_local_evaluation(self, patch_capture):
299300
"locally_evaluated": True,
300301
"$feature/person-flag": "variant-1",
301302
"$feature_flag_payload": {"some": "value"},
303+
"$feature_flag_id": 1,
302304
},
303305
groups={},
304306
disable_geoip=None,
@@ -323,6 +325,7 @@ def test_get_feature_flag_result_variant_local_evaluation(self, patch_capture):
323325
"$feature_flag_response": "variant-2",
324326
"locally_evaluated": True,
325327
"$feature/person-flag": "variant-2",
328+
"$feature_flag_id": 1,
326329
},
327330
groups={},
328331
disable_geoip=None,

‎posthog/test/test_feature_flags.py‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7181,6 +7181,41 @@ def test_year_parsing(self):
71817181

71827182

71837183
class TestCaptureCalls(unittest.TestCase):
7184+
@parameterized.expand(
7185+
[
7186+
("get_feature_flag", lambda c: c.get_feature_flag),
7187+
("feature_enabled", lambda c: c.feature_enabled),
7188+
("get_feature_flag_result", lambda c: c.get_feature_flag_result),
7189+
]
7190+
)
7191+
@mock.patch.object(Client, "capture")
7192+
@mock.patch("posthog.client.flags")
7193+
def test_locally_evaluated_flag_called_event_carries_definition_id_and_version(
7194+
self, _name, getter, patch_flags, patch_capture
7195+
):
7196+
client = Client(FAKE_TEST_API_KEY, secret_key=FAKE_TEST_API_KEY)
7197+
client.feature_flags = [
7198+
{
7199+
"id": 4211,
7200+
"version": 7,
7201+
"name": "Local Feature",
7202+
"key": "local-flag",
7203+
"active": True,
7204+
"filters": {
7205+
"groups": [{"properties": [], "rollout_percentage": 100}],
7206+
},
7207+
}
7208+
]
7209+
7210+
self.assertTrue(getter(client)("local-flag", "some-distinct-id"))
7211+
7212+
patch_flags.assert_not_called()
7213+
patch_capture.assert_called_once()
7214+
properties = patch_capture.call_args[1]["properties"]
7215+
self.assertTrue(properties["locally_evaluated"])
7216+
self.assertEqual(properties["$feature_flag_id"], 4211)
7217+
self.assertEqual(properties["$feature_flag_version"], 7)
7218+
71847219
@mock.patch.object(Client, "capture")
71857220
@mock.patch("posthog.client.flags")
71867221
def test_capture_is_called(self, patch_flags, patch_capture):
@@ -7219,6 +7254,7 @@ def test_capture_is_called(self, patch_flags, patch_capture):
72197254
"$feature_flag_response": True,
72207255
"locally_evaluated": True,
72217256
"$feature/complex-flag": True,
7257+
"$feature_flag_id": 1,
72227258
},
72237259
groups={},
72247260
disable_geoip=None,
@@ -7253,6 +7289,7 @@ def test_capture_is_called(self, patch_flags, patch_capture):
72537289
"$feature_flag_response": True,
72547290
"locally_evaluated": True,
72557291
"$feature/complex-flag": True,
7292+
"$feature_flag_id": 1,
72567293
},
72577294
groups={},
72587295
disable_geoip=None,
@@ -7591,6 +7628,7 @@ def test_disable_geoip_get_flag_capture_call(self, patch_flags, patch_capture):
75917628
"$feature_flag_response": True,
75927629
"locally_evaluated": True,
75937630
"$feature/complex-flag": True,
7631+
"$feature_flag_id": 1,
75947632
},
75957633
groups={},
75967634
disable_geoip=False,
@@ -7713,6 +7751,7 @@ def test_capture_multiple_users_doesnt_out_of_memory(
77137751
"$feature_flag_response": True,
77147752
"locally_evaluated": True,
77157753
"$feature/complex-flag": True,
7754+
"$feature_flag_id": 1,
77167755
},
77177756
groups={},
77187757
disable_geoip=None,

0 commit comments

Comments
 (0)