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
11 changes: 11 additions & 0 deletions flagsmith/api/types.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,13 +49,24 @@ class MultivariateFeatureStateValueModel(typing.TypedDict):
percentage_allocation: float


class ExperimentModel(typing.TypedDict):
id: int
name: str
in_experiment: bool


class FeatureStateMetadataModel(typing.TypedDict):
experiment: NotRequired[ExperimentModel]


class FeatureStateModel(typing.TypedDict):
enabled: bool
feature_segment: NotRequired[typing.Optional[FeatureSegmentModel]]
feature_state_value: object
feature: FeatureModel
featurestate_uuid: str
multivariate_feature_state_values: list[MultivariateFeatureStateValueModel]
metadata: NotRequired[typing.Optional[FeatureStateMetadataModel]]


class IdentityModel(typing.TypedDict):
Expand Down
8 changes: 6 additions & 2 deletions flagsmith/local_evaluation.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
from __future__ import annotations

import dataclasses
import typing
from collections import ChainMap
from functools import cached_property
Expand Down Expand Up @@ -77,7 +78,8 @@ def environment_flags(self) -> typing.Dict[str, Flag]:
"""Environment flags, which depend on the environment document only.

Evaluated without an identity, so segments reading traits or identity
context are left out.
context are left out, and flags carry no experiment: only an identity
is enrolled in one, as with remote evaluation.
"""
environment_context = self.context.copy()
if segments := environment_context.get("segments"):
Expand All @@ -90,7 +92,9 @@ def environment_flags(self) -> typing.Dict[str, Flag]:
context=environment_context,
)
return {
feature_name: Flag.from_evaluation_result(flag_result)
feature_name: dataclasses.replace(
Flag.from_evaluation_result(flag_result), experiment=None
)
for feature_name, flag_result in evaluation_result["flags"].items()
}

Expand Down
2 changes: 2 additions & 0 deletions flagsmith/mappers.py
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,8 @@ def _map_environment_document_feature_states_to_feature_contexts(
) -> typing.Iterable[FeatureContext[FeatureMetadata]]:
for feature_state in feature_states:
metadata: FeatureMetadata = {"id": feature_state["feature"]["id"]}
if experiment := (feature_state.get("metadata") or {}).get("experiment"):
metadata["experiment"] = experiment
feature_context = FeatureContext[FeatureMetadata](
key=str(
feature_state.get("django_id") or feature_state["featurestate_uuid"]
Expand Down
1 change: 1 addition & 0 deletions flagsmith/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,7 @@ def from_evaluation_result(
feature_id=metadata["id"],
variant=flag_result.get("variant"),
reason=flag_result["reason"],
experiment=ExperimentMetadata.from_api_metadata(metadata),
)
raise ValueError(
"FlagResult metadata is missing. Cannot create Flag instance. "
Expand Down
4 changes: 4 additions & 0 deletions flagsmith/types.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
from flag_engine.result.types import EvaluationResult, FlagResult
from typing_extensions import NotRequired, TypeAlias

from flagsmith.api.types import ExperimentModel

_JsonScalarType: TypeAlias = typing.Union[
int,
str,
Expand Down Expand Up @@ -47,6 +49,8 @@ class SegmentMetadata(typing.TypedDict):
class FeatureMetadata(typing.TypedDict):
id: int
"""The ID of the feature used in Flagsmith API."""
experiment: NotRequired[ExperimentModel]
"""The running experiment the feature state belongs to, if any."""


SDKEvaluationContext = EvaluationContext[SegmentMetadata, FeatureMetadata]
Expand Down
8 changes: 4 additions & 4 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ documentation = "https://docs.flagsmith.com"
packages = [{ include = "flagsmith" }]

[tool.poetry.dependencies]
flagsmith-flag-engine = "^11.1.1"
flagsmith-flag-engine = "^11.1.2"
iso8601 = { version = "^2.1.0", python = "<3.11" }
python = ">=3.10,<4"
requests = "^2.32.3"
Expand Down
119 changes: 119 additions & 0 deletions tests/conftest.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
EventProcessorConfig,
)
from flagsmith.api.types import EnvironmentModel
from flagsmith.local_evaluation import LocalEvaluation
from flagsmith.mappers import map_environment_document_to_context
from flagsmith.types import SDKEvaluationContext

Expand Down Expand Up @@ -307,3 +308,121 @@ def flag_dependency_context() -> SDKEvaluationContext:
},
},
}


@pytest.fixture
def experiment_environment() -> EnvironmentModel:
"""An environment document with a running experiment.

`checkout` has a running experiment (id 42). Its rollout segment is
identities on the premium plan, who are served the `treatment` variant.
`user_overridden` has an identity override for `checkout`, and `plain` has
no experiment.
"""
return {
"api_key": "test-key",
"name": "Test",
"project": {
"segments": [
{
"id": 7,
"name": "Checkout experiment rollout",
"rules": [
{
"type": "ALL",
"rules": [],
"conditions": [
{
"operator": "EQUAL",
"property_": "plan",
"value": "premium",
}
],
}
],
"feature_states": [
{
"enabled": True,
"feature": {"id": 1, "name": "checkout"},
"feature_state_value": "control",
"featurestate_uuid": "00000000-0000-0000-0000-000000000003",
"feature_segment": {"priority": 0},
"multivariate_feature_state_values": [
{
"id": 10,
"mv_fs_value_uuid": "00000000-0000-0000-0000-000000000010",
"percentage_allocation": 100,
"multivariate_feature_option": {
"value": "hello treatment",
"key": "treatment",
},
}
],
"metadata": {
"experiment": {
"id": 42,
"name": "Checkout experiment",
"in_experiment": True,
}
},
}
],
}
]
},
"identity_overrides": [
{
"identifier": "user_overridden",
"identity_features": [
{
"enabled": True,
"feature": {"id": 1, "name": "checkout"},
"feature_state_value": "hello override",
"featurestate_uuid": "00000000-0000-0000-0000-000000000004",
"multivariate_feature_state_values": [],
}
],
}
],
"feature_states": [
{
"enabled": True,
"feature": {"id": 1, "name": "checkout"},
"feature_state_value": "control",
"featurestate_uuid": "00000000-0000-0000-0000-000000000001",
"multivariate_feature_state_values": [],
"metadata": {
"experiment": {
"id": 42,
"name": "Checkout experiment",
"in_experiment": False,
}
},
},
{
"enabled": True,
"feature": {"id": 2, "name": "plain"},
"feature_state_value": "hello",
"featurestate_uuid": "00000000-0000-0000-0000-000000000002",
"multivariate_feature_state_values": [],
},
],
}


@pytest.fixture
def local_experiment_flagsmith(
api_key: str,
event_processor_config: EventProcessorConfig,
experiment_environment: EnvironmentModel,
) -> Flagsmith:
flagsmith = Flagsmith(
environment_key=api_key,
enable_events=True,
event_processor_config=event_processor_config,
)
flagsmith._local_evaluation = LocalEvaluation.from_environment_document(
experiment_environment
)
flagsmith.enable_local_evaluation = True
return flagsmith
17 changes: 15 additions & 2 deletions tests/test_engine_test_data.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
import pytest

from flagsmith.models import (
ExperimentMetadata,
Flag,
Flags,
build_segment_overrides_index,
Expand Down Expand Up @@ -65,12 +66,24 @@ def test_engine_test_data__lazy_flags__match_expected_result(
# Then
assert all(isinstance(flag, Flag) for flag in actual_flags.values())
actual = {
feature_name: (flag.enabled, flag.value, flag.reason)
feature_name: (
flag.enabled,
flag.value,
flag.reason,
flag.variant,
flag.experiment,
)
for feature_name, flag in actual_flags.items()
if isinstance(flag, Flag)
}
assert actual == {
feature_name: (expected["enabled"], expected["value"], expected["reason"])
feature_name: (
expected["enabled"],
expected["value"],
expected["reason"],
expected["variant"],
ExperimentMetadata.from_api_metadata(expected.get("metadata")),
)
for feature_name, expected in test_case["result"]["flags"].items()
}

Expand Down
98 changes: 98 additions & 0 deletions tests/test_flagsmith.py
Original file line number Diff line number Diff line change
Expand Up @@ -1471,3 +1471,101 @@ def test_get_experiment_flag__disabled_feature__skips_exposure(
"Not sending $flag_exposure for feature checkout_v2: feature is disabled."
in caplog.messages
)


def test_get_experiment_flag__local_evaluation__enrolled__tracks_exposure(
mocker: MockerFixture, local_experiment_flagsmith: Flagsmith
) -> None:
# Given
assert local_experiment_flagsmith._event_processor
mock_track = mocker.patch.object(
local_experiment_flagsmith._event_processor, "track_exposure_event"
)

# When
flag = local_experiment_flagsmith.get_experiment_flag(
feature_name="checkout", identifier="user_123", traits={"plan": "premium"}
)

# Then
assert isinstance(flag, Flag)
assert flag.value == "hello treatment"
assert flag.variant == "treatment"
assert flag.experiment == ExperimentMetadata(
id=42, name="Checkout experiment", in_experiment=True
)
mock_track.assert_called_once_with(
feature_name="checkout",
identifier="user_123",
value="treatment",
traits={"plan": "premium"},
metadata={"experiment_id": 42},
)


@pytest.mark.parametrize(
"feature_name, identifier, traits, expected_value, expected_experiment",
[
pytest.param(
"checkout",
"user_123",
{"plan": "free"},
"control",
ExperimentMetadata(id=42, name="Checkout experiment", in_experiment=False),
id="not-enrolled",
),
pytest.param(
"checkout",
"user_overridden",
{"plan": "premium"},
"hello override",
None,
id="identity-override",
),
pytest.param(
"plain",
"user_123",
{"plan": "premium"},
"hello",
None,
id="no-experiment",
),
],
)
def test_get_experiment_flag__local_evaluation__not_enrolled__skips_exposure(
mocker: MockerFixture,
local_experiment_flagsmith: Flagsmith,
feature_name: str,
identifier: str,
traits: typing.Dict[str, typing.Any],
expected_value: str,
expected_experiment: typing.Optional[ExperimentMetadata],
) -> None:
# Given
assert local_experiment_flagsmith._event_processor
mock_track = mocker.patch.object(
local_experiment_flagsmith._event_processor, "track_exposure_event"
)

# When
flag = local_experiment_flagsmith.get_experiment_flag(
feature_name=feature_name, identifier=identifier, traits=traits
)

# Then
assert isinstance(flag, Flag)
assert flag.value == expected_value
assert flag.experiment == expected_experiment
mock_track.assert_not_called()


def test_get_environment_flags__local_evaluation__running_experiment__no_experiment(
local_experiment_flagsmith: Flagsmith,
) -> None:
# When
flag = local_experiment_flagsmith.get_environment_flags().get_flag("checkout")

# Then - as with remote evaluation, only an identity is enrolled in one
assert isinstance(flag, Flag)
assert flag.value == "control"
assert flag.experiment is None
Loading
Loading