Merge pull request #66 from Flagsmith/release/1.4.3

Release 1.4.3

Author: Matthew Elwell

flag_engine/django_transform/schemas.py

@@ -25,6 +25,8 @@ class DjangoFeatureStateSchema(BaseFeatureStateSchema):
         fields.Nested(MultivariateFeatureStateValueSchema), dump_only=True
     )
 
+    django_id = fields.Int(attribute="id")
+
     def serialize_feature_state_value(self, instance) -> typing.Any:
         return instance.get_feature_state_value()
 

flag_engine/features/models.py

@@ -1,4 +1,5 @@
 import typing
+import uuid
 from dataclasses import dataclass, field
 
 from flag_engine.utils.hashing import get_hashed_percentage_for_object_ids
@@ -31,9 +32,10 @@ class MultivariateFeatureStateValueModel:
 
 @dataclass
 class FeatureStateModel:
-    id: int
     feature: FeatureModel
     enabled: bool
+    django_id: int = None
+    featurestate_uuid: str = field(default_factory=uuid.uuid4)
     _value: typing.Any = field(default=None, init=False)
     multivariate_feature_state_values: typing.List[
         MultivariateFeatureStateValueModel
@@ -52,7 +54,9 @@ def get_feature_state_value(self):
         return self.get_value()
 
     def _get_multivariate_value(self, identity_id: int) -> typing.Any:
-        percentage_value = get_hashed_percentage_for_object_ids([self.id, identity_id])
+        percentage_value = get_hashed_percentage_for_object_ids(
+            [self.django_id or self.featurestate_uuid, identity_id]
+        )
 
         # 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

flag_engine/features/schemas.py

@@ -1,3 +1,5 @@
+import uuid
+
 from marshmallow import EXCLUDE, Schema, fields, post_load, validate
 
 from flag_engine.features.models import (
@@ -35,10 +37,13 @@ class Meta:
 
 
 class BaseFeatureStateSchema(Schema):
-    id = fields.Int()
+    featurestate_uuid = fields.Str(dump_default=uuid.uuid4)
     feature = fields.Nested(FeatureSchema)
     enabled = fields.Bool()
 
+    class Meta:
+        unknown = EXCLUDE
+
 
 class FeatureStateSchema(BaseFeatureStateSchema):
     feature_state_value = fields.Field(allow_none=True, required=False)

flag_engine/identities/builders.py

@@ -1,11 +1,15 @@
+from marshmallow import Schema
+
 from flag_engine.identities.models import IdentityModel
 from flag_engine.identities.schemas import IdentitySchema
 
 identity_schema = IdentitySchema()
 
 
-def build_identity_dict(identity_model: IdentityModel) -> dict:
-    return identity_schema.dump(identity_model)
+def build_identity_dict(
+    identity_model: IdentityModel, schema: Schema = identity_schema
+) -> dict:
+    return schema.dump(identity_model)
 
 
 def build_identity_model(identity_dict: dict) -> IdentityModel:

flag_engine/identities/models.py

@@ -3,16 +3,18 @@
 import uuid
 from dataclasses import dataclass, field
 
-from flag_engine.features.models import FeatureStateModel
 from flag_engine.identities.traits.models import TraitModel
+from flag_engine.utils.collections import IdentityFeaturesList
 
 
 @dataclass
 class IdentityModel:
     identifier: str
     environment_api_key: str
     created_date: datetime = field(default_factory=datetime.datetime.now)
-    identity_features: typing.List[FeatureStateModel] = field(default_factory=list)
+    identity_features: IdentityFeaturesList = field(
+        default_factory=IdentityFeaturesList
+    )
     identity_traits: typing.List[TraitModel] = field(default_factory=list)
     identity_uuid: str = field(default_factory=uuid.uuid4)
     django_id: int = None

flag_engine/identities/schemas.py

@@ -13,7 +13,7 @@
 class BaseIdentitySchema(Schema):
     identifier = fields.Str()
     created_date = fields.DateTime()
-    identity_uuid = fields.UUID(default=uuid.uuid4)
+    identity_uuid = fields.UUID(dump_default=uuid.uuid4)
     environment_api_key = fields.Str()
 
     @post_dump

flag_engine/utils/collections.py

@@ -0,0 +1,12 @@
+from collections import UserList
+
+from flag_engine.features.models import FeatureStateModel
+from flag_engine.utils.exceptions import DuplicateFeatureState
+
+
+class IdentityFeaturesList(UserList):
+    def append(self, feature_state: FeatureStateModel):
+        if [fs for fs in self.data if fs.feature.id == feature_state.feature.id]:
+            raise DuplicateFeatureState("feature state for this feature already exists")
+
+        super().append(feature_state)

flag_engine/utils/exceptions.py

@@ -1,2 +1,6 @@
 class FeatureStateNotFound(Exception):
     pass
+
+
+class DuplicateFeatureState(Exception):
+    pass

setup.py

@@ -2,7 +2,7 @@
 
 setup(
     name="flagsmith-flag-engine",
-    version="1.4.2",
+    version="1.4.3",
     author="Flagsmith",
     author_email="[email protected]",
     packages=find_packages(include=["flag_engine", "flag_engine.*"]),

tests/unit/conftest.py

@@ -4,7 +4,12 @@
 
 from flag_engine.environments.models import EnvironmentModel
 from flag_engine.features.constants import STANDARD
-from flag_engine.features.models import FeatureModel, FeatureStateModel
+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
 from flag_engine.organisations.models import OrganisationModel
@@ -78,8 +83,8 @@ def environment(feature_1, feature_2, project):
         api_key="api-key",
         project=project,
         feature_states=[
-            FeatureStateModel(id=1, feature=feature_1, enabled=True),
-            FeatureStateModel(id=2, feature=feature_2, enabled=False),
+            FeatureStateModel(django_id=1, feature=feature_1, enabled=True),
+            FeatureStateModel(django_id=2, feature=feature_2, enabled=False),
         ],
     )
 
@@ -112,14 +117,23 @@ def identity_in_segment(trait_matching_segment, environment):
 @pytest.fixture()
 def segment_override_fs(segment, feature_1):
     fs = FeatureStateModel(
-        id=4,
+        django_id=4,
         feature=feature_1,
         enabled=False,
     )
     fs.set_value("segment_override")
     return fs
 
 
+@pytest.fixture()
+def mv_feature_state_value():
+    return MultivariateFeatureStateValueModel(
+        id=1,
+        multivariate_feature_option=MultivariateFeatureOptionModel(value="test_value"),
+        percentage_allocation=100,
+    )
+
+
 @pytest.fixture()
 def environment_with_segment_override(environment, segment_override_fs, segment):
     segment.feature_states.append(segment_override_fs)