Merge pull request #97 from Flagsmith/release/1.6.5

Release 1.6.5

Author: matthewelwell

flag_engine/django_transform/fields.py

@@ -1,4 +1,5 @@
 import typing
+from datetime import datetime
 
 from marshmallow import fields
 
@@ -8,14 +9,29 @@ def __init__(self, *args, filter_func: typing.Callable = None, **kwargs):
         super().__init__(*args, **kwargs)
         self.filter_func = filter_func
 
-    def _serialize(
-        self, value, *args, **kwargs
-    ) -> typing.Optional[typing.List[typing.Any]]:
+    def get_value(self, obj, attr, **kwargs) -> typing.List[typing.Any]:
         # indicates that the object was passed from django and the 'list' is
         # actually a related manager field, so grab all of the related objects
         # and filter them as necessary (this is done outside of the django ORM to
         # allow for prefetch related optimisations).
-        value = list(value.all())
+        value = list(getattr(obj, attr).all())
         if self.filter_func:
             value = list(filter(self.filter_func, value))
-        return super(DjangoRelatedManagerField, self)._serialize(value, *args, **kwargs)
+        return value
+
+
+class DjangoFeatureStatesRelatedManagerField(DjangoRelatedManagerField):
+    def get_value(self, obj, attr, **kwargs):
+        now = datetime.now()
+        features_map = {}
+        for fs in getattr(obj, attr).all():
+            if self.filter_func and not self.filter_func(fs):
+                continue
+
+            existing_feature_state = features_map.get(fs.feature_id)
+            if not existing_feature_state or (
+                fs.live_from < now and fs.version > existing_feature_state.version
+            ):
+                features_map[fs.feature_id] = fs
+
+        return list(features_map.values())

flag_engine/django_transform/schemas.py

@@ -1,8 +1,12 @@
 import typing
+from datetime import datetime
 
 from marshmallow import fields, post_dump, pre_dump
 
-from flag_engine.django_transform.fields import DjangoRelatedManagerField
+from flag_engine.django_transform.fields import (
+    DjangoFeatureStatesRelatedManagerField,
+    DjangoRelatedManagerField,
+)
 from flag_engine.django_transform.filters import sort_and_filter_feature_segments
 from flag_engine.environments.schemas import (
     BaseEnvironmentAPIKeySchema,
@@ -59,26 +63,34 @@ def __init__(self, *args, **kwargs):
         self.feature_state_schema = DjangoFeatureStateSchema()
 
     def serialize_feature_states(self, instance: typing.Any) -> typing.List[dict]:
+        # TODO: move this logic to Django so we can optimise queries
         # api key is set in the context using a pre_dump method on EnvironmentSchema.
         environment_api_key = self.context.get("environment_api_key")
         feature_segments = sort_and_filter_feature_segments(
             instance.feature_segments.all(), environment_api_key
         )
 
-        # Django datamodel incorrectly uses a foreign key for the
-        # FeatureState -> FeatureSegment relationship so we have to recursively
-        # build the list like this
-        feature_states = []
+        # iterate over the feature segments and related feature states to end up with
+        # a list consisting of the latest version feature state for each feature
+        feature_states = {}
+        now = datetime.now()
         for feature_segment in feature_segments:
-            feature_states.extend(feature_segment.feature_states.all())
-        return self.feature_state_schema.dump(feature_states, many=True)
+            for feature_state in feature_segment.feature_states.all():
+                existing_feature_state = feature_states.get(feature_state.feature_id)
+                if not existing_feature_state or (
+                    feature_state.version > existing_feature_state.version
+                    and feature_state.live_from < now
+                ):
+                    feature_states[feature_state.feature_id] = feature_state
+
+        return self.feature_state_schema.dump(list(feature_states.values()), many=True)
 
 
 class DjangoIdentitySchema(BaseIdentitySchema):
     identity_traits = DjangoRelatedManagerField(
         fields.Nested(TraitSchema), required=False
     )
-    identity_features = DjangoRelatedManagerField(
+    identity_features = DjangoFeatureStatesRelatedManagerField(
         fields.Nested(DjangoFeatureStateSchema), required=False
     )
     django_id = fields.Int(attribute="id")
@@ -105,7 +117,7 @@ class DjangoProjectSchema(BaseProjectSchema):
 
 
 class DjangoEnvironmentSchema(BaseEnvironmentSchema):
-    feature_states = DjangoRelatedManagerField(
+    feature_states = DjangoFeatureStatesRelatedManagerField(
         fields.Nested(DjangoFeatureStateSchema),
         filter_func=lambda e: e.feature_segment_id is None and e.identity_id is None,
         dump_only=True,

flag_engine/environments/models.py

@@ -5,6 +5,7 @@
 from flag_engine.environments.integrations.models import IntegrationModel
 from flag_engine.features.models import FeatureStateModel
 from flag_engine.projects.models import ProjectModel
+from flag_engine.utils.datetime import utcnow_with_tz
 
 
 @dataclass
@@ -19,7 +20,9 @@ class EnvironmentAPIKeyModel:
 
     @property
     def is_valid(self):
-        return self.active and (not self.expires_at or self.expires_at > datetime.now())
+        return self.active and (
+            not self.expires_at or self.expires_at > utcnow_with_tz()
+        )
 
 
 @dataclass

flag_engine/features/models.py

@@ -58,10 +58,6 @@ def get_value(self, identity_id: typing.Union[int, str] = None) -> typing.Any:
             return self._get_multivariate_value(identity_id)
         return self._value
 
-    def get_feature_state_value(self):
-        """Mimick django method name to simplify serialization logic"""
-        return self.get_value()
-
     def _get_multivariate_value(
         self, identity_id: typing.Union[int, str]
     ) -> typing.Any:

flag_engine/identities/models.py

@@ -5,13 +5,14 @@
 
 from flag_engine.identities.traits.models import TraitModel
 from flag_engine.utils.collections import IdentityFeaturesList
+from flag_engine.utils.datetime import utcnow_with_tz
 
 
 @dataclass
 class IdentityModel:
     identifier: str
     environment_api_key: str
-    created_date: datetime = field(default_factory=datetime.datetime.now)
+    created_date: datetime = field(default_factory=utcnow_with_tz)
     identity_features: IdentityFeaturesList = field(
         default_factory=IdentityFeaturesList
     )

flag_engine/segments/evaluator.py

@@ -41,7 +41,7 @@ def evaluate_identity_in_segment(
             override_traits or identity.identity_traits,
             rule,
             segment.id,
-            identity.composite_key,
+            identity.django_id or identity.composite_key,
         )
         for rule in segment.rules
     )

flag_engine/utils/datetime.py

@@ -0,0 +1,5 @@
+from datetime import datetime, timezone
+
+
+def utcnow_with_tz() -> datetime:
+    return datetime.now(tz=timezone.utc)

flag_engine/utils/hashing.py

@@ -6,11 +6,11 @@ def get_hashed_percentage_for_object_ids(
     object_ids: typing.Iterable[typing.Any], iterations: int = 1
 ) -> float:
     """
-    Given a list of object ids, get a floating point number between 0 and 1 based on
-    the hash of those ids. This should give the same value every time for any
-    list of ids.
+    Given a list of object ids, get a floating point number between 0 (inclusive) and
+    100 (exclusive) based on the hash of those ids. This should give the same value
+    every time for any list of ids.
 
-    :param object_ids: list of object ids to calculate the has for
+    :param object_ids: list of object ids to calculate the hash for
     :param iterations: num times to include each id in the generated string to hash
     :return: (float) number between 0 (inclusive) and 100 (exclusive)
     """
@@ -21,8 +21,8 @@ def get_hashed_percentage_for_object_ids(
     value = ((hashed_value_as_int % 9999) / 9998) * 100
 
     if value == 100:
-        # since we want a number between 0 (inclusive) and 1 (exclusive), in the
-        # unlikely case that we get the exact number 1, we call the method again
+        # since we want a number between 0 (inclusive) and 100 (exclusive), in the
+        # unlikely case that we get the exact number 100, we call the method again
         # and increase the number of iterations to ensure we get a different result
         return get_hashed_percentage_for_object_ids(
             object_ids=object_ids, iterations=iterations + 1

setup.py

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

tests/end_to_end/test_flag_engine_end_to_end.py

@@ -29,7 +29,7 @@ def test_environment_end_to_end(mock_django_environment):
     # and the feature states should be correct
     assert len(feature_states) == 1
     assert feature_states[0].enabled is True
-    assert feature_states[0].get_feature_state_value() == "foobar"
+    assert feature_states[0].get_value() == "foobar"
 
 
 def test_identity_end_to_end(mock_django_environment, mock_django_feature):
@@ -79,4 +79,4 @@ def test_identity_end_to_end(mock_django_environment, mock_django_feature):
     )
     assert feature_states
     assert len(feature_states) == 1
-    assert feature_states[0].get_feature_state_value() == identity_feature_state_value
+    assert feature_states[0].get_value() == identity_feature_state_value