FFM-7360 Log error if default variation returned (#58)

* FFM-7360 Implement default error log for returning default variation

* FFM-7360 Lint

* FFM-7360 Dependabot alert

* FFM-7360 Dependabot alert

* FFM-7360 Fix testcases

* FFM-7360 Linting

Author: erdirowlands

featureflags/client.py

@@ -138,7 +138,7 @@ def bool_variation(self, identifier: str, target: Target,
         # an empty identifier.
         if self._config.enable_analytics and variation.identifier != "":
             self._analytics.enqueue(target, identifier, variation)
-        return variation.bool(default)
+        return variation.bool(target, identifier, default)
 
     def int_variation(self, identifier: str, target: Target,
                       default: int) -> int:
@@ -149,7 +149,7 @@ def int_variation(self, identifier: str, target: Target,
         # an empty identifier.
         if self._config.enable_analytics and variation.identifier != "":
             self._analytics.enqueue(target, identifier, variation)
-        return variation.int(default)
+        return variation.int(target, identifier, default)
 
     def number_variation(self, identifier: str, target: Target,
                          default: float) -> float:
@@ -161,7 +161,7 @@ def number_variation(self, identifier: str, target: Target,
         # an empty identifier.
         if self._config.enable_analytics and variation.identifier != "":
             self._analytics.enqueue(target, identifier, variation)
-        return variation.number(default)
+        return variation.number(target, identifier, default)
 
     def string_variation(self, identifier: str, target: Target,
                          default: str) -> str:
@@ -173,7 +173,7 @@ def string_variation(self, identifier: str, target: Target,
         # an empty identifier.
         if self._config.enable_analytics and variation.identifier != "":
             self._analytics.enqueue(target, identifier, variation)
-        return variation.string(default)
+        return variation.string(target, identifier, default)
 
     def json_variation(self, identifier: str, target: Target,
                        default: Dict[str, Any]) -> Dict[str, Any]:
@@ -184,7 +184,7 @@ def json_variation(self, identifier: str, target: Target,
         # an empty identifier.
         if self._config.enable_analytics and variation.identifier != "":
             self._analytics.enqueue(target, identifier, variation)
-        return variation.json(default)
+        return variation.json(target, identifier, default)
 
     def close(self):
         log.info('closing sdk client')

featureflags/evaluations/variation.py

@@ -4,7 +4,9 @@
 
 import attr
 
+from featureflags.evaluations.auth_target import Target
 from featureflags.models import UNSET, Unset
+from featureflags.util import log
 
 T = TypeVar("T", bound="Variation")
 
@@ -17,27 +19,54 @@ class Variation(object):
     description: Union[Unset, str] = UNSET
     additional_properties: Dict[str, Any] = attr.ib(init=False, factory=dict)
 
-    def bool(self, default: bool = False) -> bool:
+    def bool(self, target: Target, flag_identifier: str,
+             default: bool = False) -> bool:
         if self.value:
             return self.value.lower() == "true"
+        log.error(
+            "Failed to evaluate bool variation for %s and the "
+            "default variation '%s' is being returned",
+            {"target": target.identifier, "flag": flag_identifier}, default)
         return default
 
-    def string(self, default: str) -> str:
-        return self.value or default
+    def string(self, target: Target, flag_identifier: str,
+               default: str) -> str:
+        if self.value:
+            return self.value
+        log.error(
+            "Failed to evaluate string variation for %s and the "
+            "default variation '%s' is being returned",
+            {"target": target.identifier, "flag": flag_identifier}, default)
+        return default
 
-    def number(self, default: float) -> float:
+    def number(self, target: Target, flag_identifier: str,
+               default: float) -> float:
         if self.value:
             return float(self.value)
+        log.error(
+            "Failed to evaluate number variation for %s and the "
+            "default variation '%s' is being returned",
+            {"target": target.identifier, "flag": flag_identifier}, default)
         return default
 
-    def int(self, default: int) -> int:
+    def int(self, target: Target, flag_identifier: str,
+            default: int) -> int:
         if self.value:
             return int(self.value)
+        log.error(
+            "Failed to evaluate int variation for %s and the "
+            "default variation '%s' is being returned",
+            {"target": target.identifier, "flag": flag_identifier}, default)
         return default
 
-    def json(self, default: dict) -> dict:
+    def json(self, target: Target, flag_identifier: str,
+             default: dict) -> dict:
         if self.value:
             return json.loads(self.value)
+        log.error(
+            "Failed to evaluate json variation for %s and the "
+            "default variation '%s' is being returned",
+            {"target": target.identifier, "flag": flag_identifier}, default)
         return default
 
     def to_dict(self) -> Dict[str, Any]:

requirements_dev.txt

@@ -14,8 +14,8 @@ twine==3.4.1
 pytest==5.1
 pytest-runner==5.1
 pytest-mock==3.6.1
-setuptools~=54.2.0
-httpx~=0.16.1
+setuptools~=65.5.1
+httpx~=0.23.0
 attrs~=21.2.0
 
 pyjwt==2.4.0

tests/integration/test_evaluator.py

@@ -128,14 +128,18 @@ def test_evaluator(tc: TestCase):
 
     switch_kind = {
         FeatureConfigKind.BOOLEAN:
-            lambda: evaluator.evaluate(tc.flag, target).bool(default=False),
+            lambda: evaluator.evaluate(tc.flag, target)
+            .bool(target, tc.flag, default=False),
         FeatureConfigKind.STRING:
             lambda: evaluator.evaluate(tc.flag, target).string(
+                target, tc.flag,
                 default="failed"),
         FeatureConfigKind.INT:
-            lambda: evaluator.evaluate(tc.flag, target).number(default=0.100),
+            lambda: evaluator.evaluate(tc.flag, target)
+            .number(target, tc.flag, default=0.100),
         FeatureConfigKind.JSON:
-            lambda: evaluator.evaluate(tc.flag, target).json(default={}),
+            lambda: evaluator.evaluate(tc.flag, target)
+            .json(target, tc.flag, default={}),
     }
 
     kind = repository.get_flag(tc.flag).kind

tests/unit/test_variation.py

@@ -2,61 +2,73 @@
 
 import pytest
 
+from featureflags.evaluations.auth_target import Target
 from featureflags.evaluations.variation import Variation
 
 
 @pytest.mark.parametrize(
-    "test_input,default,expected",
+    "test_input, target, flag_identifier, default,expected",
     [
-        ("true", False, True),
-        ("false", False, False),
-        ("", False, False),
+        ("true", Target(identifier='harness'), "flag1", False, True),
+        ("false", Target(identifier='harness'), "flag1", False, False),
+        ("", Target(identifier='harness'), "flag1", False, False),
     ],
 )
-def test_variation_bool(test_input, default, expected):
+def test_variation_bool(test_input, target, flag_identifier,
+                        default, expected):
     variation = Variation(identifier="test", value=test_input)
 
-    got = variation.bool(default=default)
+    got = variation.bool(target, flag_identifier, default=default)
 
     assert got == expected
 
 
 @pytest.mark.parametrize(
-    "test_input,default,expected",
+    "test_input, target, flag_identifier, default,expected",
     [
-        ("test", "test_default", "test"),
-        (None, "test_default", "test_default"),
+        ("test", Target(identifier='harness'), "flag1", "test_default",
+         "test"),
+        (None, Target(identifier='harness'), "flag1", "test_default",
+         "test_default"),
     ],
 )
-def test_variation_string(test_input, default, expected):
+def test_variation_string(test_input, target, flag_identifier,
+                          default, expected):
     variation = Variation(identifier="test", value=test_input)
 
-    got = variation.string(default=default)
+    got = variation.string(target, flag_identifier, default=default)
 
     assert got == expected
 
 
 @pytest.mark.parametrize(
-    "test_input,default,expected", [(1.1, 1.0, 1.1), (None, 1.0, 1.0)]
+    "test_input,target,flag_identifier,default,expected", [
+        (1.1, Target(identifier='harness'), "flag1", 1.0, 1.1),
+        (None, Target(identifier='harness'), "flag1", 1.0, 1.0)
+    ]
 )
-def test_variation_number(test_input, default, expected):
+def test_variation_number(test_input, target, flag_identifier,
+                          default, expected):
     variation = Variation(identifier="test", value=test_input)
 
-    got = variation.number(default=default)
+    got = variation.number(target, flag_identifier, default=default)
 
     assert got == expected
 
 
 @pytest.mark.parametrize(
-    "test_input,expected",
+    "test_input,target,flag_identifier,expected",
     [
-        (json.dumps({"field": "value"}), json.dumps({"field": "value"})),
-        (None, json.dumps({"field": "value2"})),
+        (json.dumps({"field": "value"}), Target(identifier='harness'),
+         "flag1", json.dumps({"field": "value"})),
+        (None, Target(identifier='harness'), "flag1",
+         json.dumps({"field": "value2"})),
     ],
 )
-def test_variation_json(test_input, expected):
+def test_variation_json(test_input, target,
+                        flag_identifier, expected):
     variation = Variation(identifier="test", value=test_input)
 
-    got = variation.json(default={"field": "value2"})
+    got = variation.json(target, flag_identifier, default={"field": "value2"})
 
     assert got == json.loads(expected)