Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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/canonical-group-key-bucketing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
posthog: patch
---

Use canonical numeric group keys for local feature-flag bucketing and fall back to remote evaluation for unsupported key types.
3 changes: 2 additions & 1 deletion posthog/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,7 @@
InconclusiveMatchError,
RequiresServerEvaluation,
_get_definition_unresolved_reason,
_group_key_to_string,
match_feature_flag_properties,
resolve_bucketing_value,
)
Expand Down Expand Up @@ -4638,7 +4639,7 @@ def _compute_flag_locally(
reason=UnresolvedFlagReason.MISSING_CONTEXT,
)
focused_group_properties = group_properties[group_name]
group_key = groups[group_name]
group_key = _group_key_to_string(groups[group_name])
return match_feature_flag_properties(
feature_flag,
group_key,
Expand Down
16 changes: 15 additions & 1 deletion posthog/feature_flags.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
import json
import logging
import math
import numbers
import re
import warnings
from decimal import Decimal
Expand Down Expand Up @@ -692,7 +693,7 @@ def _get_condition_context(
reason=UnresolvedFlagReason.MISSING_CONTEXT,
)
effective_properties = group_properties[group_name]
effective_bucketing = groups[group_name]
effective_bucketing = _group_key_to_string(groups[group_name])
else:
effective_properties = properties
effective_bucketing = bucketing_value
Expand Down Expand Up @@ -1010,6 +1011,19 @@ def _json_object_to_string(value: dict, reason: UnresolvedFlagReason) -> str:
return "{" + ",".join(items) + "}"


def _group_key_to_string(value) -> str:
if isinstance(value, str):
return value
if not isinstance(value, bool) and isinstance(value, numbers.Integral):
return str(int(value))
if isinstance(value, float):
return _json_value_to_string(value, UnresolvedFlagReason.MISSING_CONTEXT)
raise InconclusiveMatchError(
"Group keys must be strings or finite numbers",
reason=UnresolvedFlagReason.MISSING_CONTEXT,
)


def _value_to_string(value, reason: UnresolvedFlagReason) -> str:
if isinstance(value, str):
return value
Expand Down
95 changes: 95 additions & 0 deletions posthog/test/test_feature_flags.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import datetime
import hashlib
import numbers
import threading
import unittest

Expand Down Expand Up @@ -122,6 +123,100 @@ def test_missing_nested_cohort_always_requires_server_evaluation(self):
)


class _NumpyLikeInt:
def __init__(self, value):
self.value = value

def __int__(self):
return self.value

def __str__(self):
return f"np.int64({self.value})"


numbers.Integral.register(_NumpyLikeInt)


class TestGroupKeyBucketing(unittest.TestCase):
def setUp(self):
self.client = Client(FAKE_TEST_API_KEY, send=False)
self.client.group_type_mapping = {"0": "company"}

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

def set_group_flag(self, mixed=False, rollout=50):
condition = {"properties": [], "rollout_percentage": rollout}
filters = {"groups": [condition]}
if mixed:
condition["aggregation_group_type_index"] = 0
else:
filters["aggregation_group_type_index"] = 0
self.client.feature_flags = [
{"id": 1, "key": "group-beta", "active": True, "filters": filters}
]

@parameterized.expand([(False,), (True,)])
@mock.patch("posthog.client.flags")
def test_numeric_group_keys_use_server_representation(self, mixed, patch_flags):
self.set_group_flag(mixed)
# For this flag, "0.00001" hashes below 50%, but Python's "1e-05"
# hashes above it. Integer keys should keep their existing bucketing.
for group_key in (0.00001, "0.00001", 42, "42", _NumpyLikeInt(42)):
with self.subTest(group_key=group_key):
self.assertTrue(
self.client.get_feature_flag(
"group-beta",
"user-1",
groups={"company": group_key},
only_evaluate_locally=True,
send_feature_flag_events=False,
)
)
flags = self.client.evaluate_flags(
"user-1",
groups={"company": group_key},
only_evaluate_locally=True,
)
self.assertTrue(flags.get_flag("group-beta"))
patch_flags.assert_not_called()

@parameterized.expand([(False,), (True,)])
@mock.patch("posthog.client.flags")
def test_unsupported_group_keys_require_remote_evaluation(self, mixed, patch_flags):
self.set_group_flag(mixed, rollout=100)
patch_flags.return_value = {"featureFlags": {"group-beta": "remote"}}
for group_key in (True, False, None, [], {}, float("inf"), float("nan")):
with self.subTest(group_key=group_key):
self.assertIsNone(
self.client.get_feature_flag(
"group-beta",
"user-1",
groups={"company": group_key},
only_evaluate_locally=True,
send_feature_flag_events=False,
)
)
flags = self.client.evaluate_flags(
"user-1",
groups={"company": group_key},
only_evaluate_locally=True,
)
self.assertNotIn("group-beta", flags.keys)
patch_flags.assert_not_called()
self.assertEqual(
self.client.get_feature_flag(
"group-beta",
"user-1",
groups={"company": group_key},
send_feature_flag_events=False,
),
"remote",
)
patch_flags.assert_called_once()
patch_flags.reset_mock()


class TestNumericOrderingLocalEvaluation(unittest.TestCase):
def setUp(self):
self.client = Client(FAKE_TEST_API_KEY)
Expand Down
Loading