chore: context values are now coerced to JSON representable strings before being passed to Yggdrasil (#329)

sighphyre · web-flow · commit c657db35f361 · 2024-11-18T09:41:50.000+02:00
diff --git a/UnleashClient/__init__.py b/UnleashClient/__init__.py
@@ -5,7 +5,7 @@
 import warnings
 from dataclasses import asdict
 from datetime import datetime, timezone
-from typing import Callable, Optional
+from typing import Any, Callable, Dict, Optional
 
 from apscheduler.executors.pool import ThreadPoolExecutor
 from apscheduler.job import Job
@@ -348,13 +348,7 @@ def is_enabled(
         :param fallback_function: Allows users to provide a custom function to set default value.
         :return: Feature flag result
         """
-        context = context or {}
-
-        base_context = self.unleash_static_context.copy()
-        # Update context with static values and allow context to override environment
-        base_context.update(context)
-        context = base_context
-
+        context = self._safe_context(context)
         feature_enabled = self.engine.is_enabled(feature_name, context)
 
         if feature_enabled is None:
@@ -399,9 +393,7 @@ def get_variant(self, feature_name: str, context: Optional[dict] = None) -> dict
         :param context: Dictionary with context (e.g. IPs, email) for feature toggle.
         :return: Variant and feature flag status.
         """
-        context = context or {}
-        context.update(self.unleash_static_context)
-
+        context = self._safe_context(context)
         variant = self._resolve_variant(feature_name, context)
 
         if not variant:
@@ -439,6 +431,34 @@ def get_variant(self, feature_name: str, context: Optional[dict] = None) -> dict
 
         return variant
 
+    def _safe_context(self, context) -> dict:
+        new_context: Dict[str, Any] = self.unleash_static_context.copy()
+        new_context.update(context or {})
+
+        if "currentTime" not in new_context:
+            new_context["currentTime"] = datetime.now(timezone.utc).isoformat()
+
+        safe_properties = new_context.get("properties", {})
+        safe_properties = {
+            k: self._safe_context_value(v) for k, v in safe_properties.items()
+        }
+        safe_context = {
+            k: self._safe_context_value(v)
+            for k, v in new_context.items()
+            if k != "properties"
+        }
+
+        safe_context["properties"] = safe_properties
+
+        return safe_context
+
+    def _safe_context_value(self, value):
+        if isinstance(value, datetime):
+            return value.isoformat()
+        if isinstance(value, (int, float)):
+            return str(value)
+        return value
+
     def _resolve_variant(self, feature_name: str, context: dict) -> dict:
         """
         Resolves a feature variant.
diff --git a/tests/unit_tests/test_client.py b/tests/unit_tests/test_client.py
@@ -1,5 +1,6 @@
 import time
 import warnings
+from datetime import datetime, timezone
 from pathlib import Path
 
 import pytest
@@ -13,7 +14,9 @@
     MOCK_FEATURE_ENABLED_NO_VARIANTS_RESPONSE,
     MOCK_FEATURE_RESPONSE,
     MOCK_FEATURE_RESPONSE_PROJECT,
+    MOCK_FEATURE_WITH_DATE_AFTER_CONSTRAINT,
     MOCK_FEATURE_WITH_DEPENDENCIES_RESPONSE,
+    MOCK_FEATURE_WITH_NUMERIC_CONSTRAINT,
 )
 from tests.utilities.testing_constants import (
     APP_NAME,
@@ -920,3 +923,56 @@ def example_callback(event: UnleashEvent):
     assert unleash_client.is_enabled("testFlag")
     variant = unleash_client.get_variant("testVariations", context={"userId": "2"})
     assert variant["name"] == "VarA"
+
+
+def test_context_handles_numerics():
+    cache = FileCache("MOCK_CACHE")
+    cache.bootstrap_from_dict(MOCK_FEATURE_WITH_NUMERIC_CONSTRAINT)
+
+    unleash_client = UnleashClient(
+        url=URL,
+        app_name=APP_NAME,
+        disable_metrics=True,
+        disable_registration=True,
+        cache=cache,
+        environment="default",
+    )
+
+    context = {"userId": 99999}
+
+    assert unleash_client.is_enabled("NumericConstraint", context)
+
+
+def test_context_handles_datetimes():
+    cache = FileCache("MOCK_CACHE")
+    cache.bootstrap_from_dict(MOCK_FEATURE_RESPONSE)
+
+    unleash_client = UnleashClient(
+        url=URL,
+        app_name=APP_NAME,
+        disable_metrics=True,
+        disable_registration=True,
+        cache=cache,
+        environment="default",
+    )
+
+    current_time = datetime.fromisoformat("1834-02-20").replace(tzinfo=timezone.utc)
+    context = {"currentTime": current_time}
+
+    assert unleash_client.is_enabled("testConstraintFlag", context)
+
+
+def test_context_adds_current_time_if_not_set():
+    cache = FileCache("MOCK_CACHE")
+    cache.bootstrap_from_dict(MOCK_FEATURE_WITH_DATE_AFTER_CONSTRAINT)
+
+    unleash_client = UnleashClient(
+        url=URL,
+        app_name=APP_NAME,
+        disable_metrics=True,
+        disable_registration=True,
+        cache=cache,
+        environment="default",
+    )
+
+    assert unleash_client.is_enabled("DateConstraint")
diff --git a/tests/utilities/mocks/mock_features.py b/tests/utilities/mocks/mock_features.py
@@ -298,3 +298,57 @@
         },
     ],
 }
+
+MOCK_FEATURE_WITH_NUMERIC_CONSTRAINT = {
+    "version": 1,
+    "features": [
+        {
+            "name": "NumericConstraint",
+            "description": "Feature toggle with numeric constraint",
+            "enabled": True,
+            "strategies": [
+                {
+                    "name": "default",
+                    "parameters": {},
+                    "constraints": [
+                        {
+                            "contextName": "userId",
+                            "operator": "NUM_GT",
+                            "value": "10",
+                            "inverted": False,
+                        }
+                    ],
+                }
+            ],
+            "createdAt": "2018-10-09T06:04:05.667Z",
+            "impressionData": False,
+        },
+    ],
+}
+
+MOCK_FEATURE_WITH_DATE_AFTER_CONSTRAINT = {
+    "version": 1,
+    "features": [
+        {
+            "name": "DateConstraint",
+            "description": "Feature toggle with numeric constraint",
+            "enabled": True,
+            "strategies": [
+                {
+                    "name": "default",
+                    "parameters": {},
+                    "constraints": [
+                        {
+                            "contextName": "currentTime",
+                            "operator": "DATE_AFTER",
+                            "value": "1988-06-15T06:40:17.766Z",
+                            "inverted": False,
+                        }
+                    ],
+                }
+            ],
+            "createdAt": "2018-10-09T06:04:05.667Z",
+            "impressionData": False,
+        },
+    ],
+}
