Release 2.0.2 (#115)

* Release 2.0.2

* fix(traits/float_value): Add custom field to ser/deser trait_value (#114)

* fix(traits/float_value): Add custom field to ser/deser trait_value

Since dynamodb can't understand float(and trait value can be float)
we need to convert it to Decimal in order to store that in dynamodb

* minor review fixes

Author: gagantrivedi

flag_engine/identities/traits/schemas.py

@@ -1,12 +1,30 @@
+import decimal
+
 from marshmallow import fields
 
 from flag_engine.identities.traits.models import TraitModel
 from flag_engine.utils.marshmallow.schemas import LoadToModelSchema
 
 
+class TraitValueField(fields.Field):
+    """Field that serializes float(and only float) to Decimal(because dynamodb can't understand float)
+    and deserializes Decimal(and only decimal) to float
+    """
+
+    def _serialize(self, value, attr, obj, **kwargs):
+        if type(value) is float:
+            value = decimal.Decimal(str(value))
+        return value
+
+    def _deserialize(self, value, attr, data, **kwargs):
+        if isinstance(value, decimal.Decimal):
+            value = float(value)
+        return value
+
+
 class TraitSchema(LoadToModelSchema):
     trait_key = fields.Str()
-    trait_value = fields.Field(allow_none=True)
+    trait_value = TraitValueField(allow_none=True)
 
     class Meta:
         model_class = TraitModel

setup.py

@@ -2,7 +2,7 @@
 
 setup(
     name="flagsmith-flag-engine",
-    version="2.0.1",
+    version="2.0.2",
     author="Flagsmith",
     author_email="support@flagsmith.com",
     packages=find_packages(include=["flag_engine", "flag_engine.*"]),

tests/unit/api/conftest.py

@@ -190,6 +190,10 @@ def django_identity(
     django_enabled_feature_state_with_string_value,
     django_multivariate_feature_state,
     django_environment,
+    django_trait_integer,
+    django_trait_float,
+    django_trait_string,
+    django_trait_boolean,
 ):
     return DjangoIdentity(
         id=1,
@@ -201,4 +205,10 @@ def django_identity(
             django_enabled_feature_state_with_string_value,
             django_multivariate_feature_state,
         ],
+        identity_traits=[
+            django_trait_boolean,
+            django_trait_float,
+            django_trait_integer,
+            django_trait_string,
+        ],
     )

tests/unit/identities/test_trait_schema.py

@@ -1,3 +1,5 @@
+import decimal
+
 import pytest
 
 from flag_engine.identities.traits.models import TraitModel
@@ -28,13 +30,27 @@ def test_trait_schema_load(trait_key, trait_value):
     assert trait_model.trait_value == trait_value
 
 
+def test_trait_schema_load_converts_decimal_to_float():
+    # Given
+    trait_value = 11.9
+    trait_schema = TraitSchema()
+
+    # When
+    trait_model = trait_schema.load(
+        {"trait_key": "key", "trait_value": decimal.Decimal(str(trait_value))}
+    )
+
+    # Then
+    assert trait_model.trait_value == trait_value
+    assert isinstance(trait_model.trait_value, float)
+
+
 @pytest.mark.parametrize(
     "trait_model",
     (
         TraitModel("key", "value"),
         TraitModel("key", 21),
         TraitModel("key1", None),
-        TraitModel("key1", 11.2),
         TraitModel("key1", True),
     ),
 )
@@ -48,3 +64,16 @@ def test_trait_schema_dump(trait_model):
     # Then
     assert trait_data["trait_key"] == trait_model.trait_key
     assert trait_data["trait_value"] == trait_model.trait_value
+
+
+def test_trait_schema_dump_converts_float_to_decimal():
+    # Given
+    trait_model = TraitModel("key1", 12.1)
+    trait_schema = TraitSchema()
+
+    # When
+    trait_data = trait_schema.dump(trait_model)
+
+    # Then
+    assert trait_data["trait_key"] == trait_model.trait_key
+    assert trait_data["trait_value"] == decimal.Decimal(str(trait_model.trait_value))