fix coverage

Author: khvn26

flag_engine/features/models.py

@@ -1,14 +1,13 @@
-import math
 import typing
 import uuid
+import warnings
 
-from annotated_types import Ge, Le, SupportsLt
+from annotated_types import Ge, Le
 from pydantic import UUID4, BaseModel, Field, model_validator
 from pydantic_collections import BaseCollectionModel
 from typing_extensions import Annotated
 
 from flag_engine.utils.exceptions import InvalidPercentageAllocation
-from flag_engine.utils.hashing import get_hashed_percentage_for_object_ids
 
 
 class FeatureModel(BaseModel):
@@ -19,9 +18,6 @@ class FeatureModel(BaseModel):
     def __eq__(self, other: object) -> bool:
         return isinstance(other, FeatureModel) and self.id == other.id
 
-    def __hash__(self) -> int:
-        return hash(self.id)
-
 
 class MultivariateFeatureOptionModel(BaseModel):
     value: typing.Any
@@ -88,72 +84,15 @@ def set_value(self, value: typing.Any) -> None:
 
     def get_value(self, identity_id: typing.Union[None, int, str] = None) -> typing.Any:
         """
-        Get the value of the feature state.
+        DEPRECATED: Get the value of the feature state.
+        Use the `feature_state_value` field directly instead.
 
         :param identity_id: a unique identifier for the identity, can be either a
             numeric id or a string but must be unique for the identity.
         :return: the value of the feature state.
         """
-        if identity_id and len(self.multivariate_feature_state_values) > 0:
-            return self._get_multivariate_value(identity_id)
-        return self.feature_state_value
-
-    def is_higher_segment_priority(self, other: "FeatureStateModel") -> bool:
-        """
-        Returns `True` if `self` is higher segment priority than `other`
-        (i.e. has lower value for feature_segment.priority)
-
-        NOTE:
-            A segment will be considered higher priority only if:
-            1. `other` does not have a feature segment(i.e: it is an environment feature state or it's a
-            feature state with feature segment but from an old document that does not have `feature_segment.priority`)
-            but `self` does.
-
-            2. `other` have a feature segment with high priority
-
-        """
-
-        if other_feature_segment := other.feature_segment:
-            if (
-                other_feature_segment_priority := other_feature_segment.priority
-            ) is not None:
-                return (
-                    getattr(
-                        self.feature_segment,
-                        "priority",
-                        math.inf,
-                    )
-                    < other_feature_segment_priority
-                )
-        return False
-
-    def _get_multivariate_value(
-        self, identity_id: typing.Union[int, str]
-    ) -> typing.Any:
-        percentage_value = get_hashed_percentage_for_object_ids(
-            [self.django_id or self.featurestate_uuid, identity_id]
+        warnings.warn(
+            "get_value is deprecated, use feature_state_value directly.",
+            DeprecationWarning,
         )
-
-        # Iterate over the mv options in order of id (so we get the same value each
-        # time) to determine the correct value to return to the identity based on
-        # the percentage allocations of the multivariate options. This gives us a
-        # way to ensure that the same value is returned every time we use the same
-        # percentage value.
-        start_percentage = 0.0
-
-        def _mv_fs_sort_key(mv_value: MultivariateFeatureStateValueModel) -> SupportsLt:
-            return mv_value.id or mv_value.mv_fs_value_uuid
-
-        for mv_value in sorted(
-            self.multivariate_feature_state_values,
-            key=_mv_fs_sort_key,
-        ):
-            limit = mv_value.percentage_allocation + start_percentage
-            if start_percentage <= percentage_value < limit:
-                return mv_value.multivariate_feature_option.value
-
-            start_percentage = limit
-
-        # default to return the control value if no MV values found, although this
-        # should never happen
         return self.feature_state_value

flag_engine/segments/evaluator.py

@@ -296,7 +296,7 @@ def _evaluate_modulo(
     if not isinstance(context_value, (int, float)):
         return False
 
-    if segment_value is None:
+    if not segment_value:
         return False
 
     try:

tests/unit/conftest.py

@@ -9,8 +9,6 @@
 from flag_engine.features.models import (
     FeatureModel,
     FeatureStateModel,
-    MultivariateFeatureOptionModel,
-    MultivariateFeatureStateValueModel,
 )
 from flag_engine.identities.models import IdentityModel
 from flag_engine.identities.traits.models import TraitModel
@@ -185,17 +183,6 @@ def segment_override_fs(
     return fs
 
 
-@pytest.fixture()
-def mv_feature_state_value() -> MultivariateFeatureStateValueModel:
-    return MultivariateFeatureStateValueModel(
-        id=1,
-        multivariate_feature_option=MultivariateFeatureOptionModel(
-            id=1, value="test_value"
-        ),
-        percentage_allocation=100,
-    )
-
-
 @pytest.fixture()
 def environment_with_segment_override(
     environment: EnvironmentModel,

tests/unit/features/test_features_models.py

@@ -1,10 +1,6 @@
-from unittest import mock
-
 import pytest
 from pydantic import ValidationError
-from pytest_mock import MockerFixture
 
-from flag_engine.features.constants import STANDARD
 from flag_engine.features.models import (
     FeatureModel,
     FeatureStateModel,
@@ -135,108 +131,3 @@ def test_feature_state_get_value_no_mv_values(feature_1: FeatureModel) -> None:
     # Then
     # the default value is always returned, even if an identity id is provided
     assert feature_state.get_value() == feature_state.get_value(1) == value
-
-
-mv_feature_control_value = "control"
-mv_feature_value_1 = "foo"
-mv_feature_value_2 = "bar"
-
-
-@pytest.mark.parametrize(
-    "percentage_value, expected_value",
-    (
-        (10, mv_feature_value_1),
-        (40, mv_feature_value_2),
-        (70, mv_feature_control_value),
-    ),
-)
-@mock.patch("flag_engine.features.models.get_hashed_percentage_for_object_ids")
-def test_feature_state_get_value_mv_values(
-    mock_get_hashed_percentage: mock.Mock,
-    percentage_value: int,
-    expected_value: str,
-) -> None:
-    # Given
-    # a feature
-    my_feature = FeatureModel(id=1, name="mv_feature", type=STANDARD)
-
-    # with some multivariate feature options
-    mv_feature_option_1 = MultivariateFeatureOptionModel(id=1, value=mv_feature_value_1)
-    mv_feature_option_2 = MultivariateFeatureOptionModel(id=2, value=mv_feature_value_2)
-
-    # and associated values
-    mv_feature_state_value_1 = MultivariateFeatureStateValueModel(
-        id=1, multivariate_feature_option=mv_feature_option_1, percentage_allocation=30
-    )
-    mv_feature_state_value_2 = MultivariateFeatureStateValueModel(
-        id=2, multivariate_feature_option=mv_feature_option_2, percentage_allocation=30
-    )
-
-    # and we assign the above to a feature state
-    mv_feature_state = FeatureStateModel(
-        django_id=1,
-        feature=my_feature,
-        enabled=True,
-        multivariate_feature_state_values=[
-            mv_feature_state_value_1,
-            mv_feature_state_value_2,
-        ],
-    )
-    mv_feature_state.set_value(mv_feature_control_value)
-
-    # and we mock the function which gets the percentage value for an identity to
-    # return a deterministic value so we know which value to expect
-    mock_get_hashed_percentage.return_value = percentage_value
-
-    # Then
-    # the value of the feature state is correct based on the percentage value returned
-    assert mv_feature_state.get_value(identity_id=1) == expected_value
-
-
-def test_get_value_uses_django_id_for_multivariate_value_calculation_if_not_none(
-    feature_1: FeatureModel,
-    mv_feature_state_value: MultivariateFeatureStateValueModel,
-    mocker: MockerFixture,
-) -> None:
-    # Given
-    mocked_get_hashed_percentage = mocker.patch(
-        "flag_engine.features.models.get_hashed_percentage_for_object_ids",
-        return_value=10,
-    )
-    identity_id = 1
-    feature_state = FeatureStateModel(
-        django_id=1,
-        feature=feature_1,
-        enabled=True,
-        multivariate_feature_state_values=[mv_feature_state_value],
-    )
-    # When
-    feature_state.get_value(identity_id=identity_id)
-    # Then
-    mocked_get_hashed_percentage.assert_called_with(
-        [feature_state.django_id, identity_id]
-    )
-
-
-def test_get_value_uses_featuestate_uuid_for_multivariate_value_calculation_if_django_id_is_not_present(
-    feature_1: FeatureModel,
-    mv_feature_state_value: MultivariateFeatureStateValueModel,
-    mocker: MockerFixture,
-) -> None:
-    # Given
-    mocked_get_hashed_percentage = mocker.patch(
-        "flag_engine.features.models.get_hashed_percentage_for_object_ids",
-        return_value=10,
-    )
-    identity_id = 1
-    feature_state = FeatureStateModel(
-        feature=feature_1,
-        enabled=True,
-        multivariate_feature_state_values=[mv_feature_state_value],
-    )
-    # When
-    feature_state.get_value(identity_id=identity_id)
-    # Then
-    mocked_get_hashed_percentage.assert_called_with(
-        [feature_state.featurestate_uuid, identity_id]
-    )