feat: add variable metadata in after and finally hooks

Author: suthar26

devcycle_python_sdk/api/local_bucketing.py

@@ -5,7 +5,7 @@
 
 from pathlib import Path
 from threading import Lock
-from typing import Any, cast, Optional, List
+from typing import Any, cast, Optional, List, Tuple
 
 import wasmtime
 from wasmtime import (
@@ -300,7 +300,7 @@ def init_event_queue(self, client_uuid, options_json: str) -> None:
 
     def get_variable_for_user_protobuf(
         self, user: DevCycleUser, key: str, default_value: Any
-    ) -> Optional[Variable]:
+    ) -> Tuple[Optional[Variable], Optional[str]]:
         var_type = determine_variable_type(default_value)
         pb_variable_type = pb_utils.convert_type_enum_to_variable_type(var_type)
 
@@ -325,7 +325,7 @@ def get_variable_for_user_protobuf(
                 sdk_variable = pb2.SDKVariable_PB()
                 sdk_variable.ParseFromString(var_bytes)
 
-                return pb_utils.create_variable(sdk_variable, default_value)
+                return pb_utils.create_variable(sdk_variable, default_value), sdk_variable._feature.value
 
     def generate_bucketed_config(self, user: DevCycleUser) -> BucketedConfig:
         user_json = json.dumps(user.to_json())

devcycle_python_sdk/local_client.py

@@ -26,6 +26,7 @@
 from devcycle_python_sdk.models.platform_data import default_platform_data
 from devcycle_python_sdk.models.user import DevCycleUser
 from devcycle_python_sdk.models.variable import Variable
+from devcycle_python_sdk.models.variable_metadata import VariableMetadata
 from devcycle_python_sdk.open_feature_provider.provider import DevCycleProvider
 from openfeature.provider import AbstractProvider
 
@@ -151,6 +152,7 @@ def variable(self, user: DevCycleUser, key: str, default_value: Any) -> Variable
             )
 
         config_metadata = self.local_bucketing.get_config_metadata()
+        variable_metadata = None
 
         context = HookContext(key, user, default_value, config_metadata)
         variable = Variable.create_default_variable(
@@ -165,9 +167,11 @@ def variable(self, user: DevCycleUser, key: str, default_value: Any) -> Variable
                     context = changed_context
             except BeforeHookError as e:
                 before_hook_error = e
-            bucketed_variable = self.local_bucketing.get_variable_for_user_protobuf(
+            bucketed_variable, feature_id = self.local_bucketing.get_variable_for_user_protobuf(
                 user, key, default_value
             )
+            if feature_id is not None:
+                variable_metadata = VariableMetadata(feature_id=feature_id)
             if bucketed_variable is not None:
                 variable = bucketed_variable
             else:
@@ -177,7 +181,7 @@ def variable(self, user: DevCycleUser, key: str, default_value: Any) -> Variable
                 )
 
             if before_hook_error is None:
-                self.eval_hooks_manager.run_after(context, variable)
+                self.eval_hooks_manager.run_after(context, variable, variable_metadata)
             else:
                 raise before_hook_error
         except Exception as e:
@@ -194,7 +198,7 @@ def variable(self, user: DevCycleUser, key: str, default_value: Any) -> Variable
 
             return variable
         finally:
-            self.eval_hooks_manager.run_finally(context, variable)
+            self.eval_hooks_manager.run_finally(context, variable, variable_metadata)
         return variable
 
     def _generate_bucketed_config(self, user: DevCycleUser) -> BucketedConfig:

devcycle_python_sdk/managers/eval_hooks_manager.py

@@ -3,6 +3,7 @@
 from devcycle_python_sdk.models.eval_hook import EvalHook
 from devcycle_python_sdk.models.eval_hook_context import HookContext
 from devcycle_python_sdk.models.variable import Variable
+from devcycle_python_sdk.models.variable_metadata import VariableMetadata
 from devcycle_python_sdk.options import logger
 
 
@@ -48,19 +49,19 @@ def run_before(self, context: HookContext) -> Optional[HookContext]:
                 raise BeforeHookError(f"Before hook failed: {e}", e)
         return modified_context
 
-    def run_after(self, context: HookContext, variable: Variable) -> None:
+    def run_after(self, context: HookContext, variable: Variable, variable_metadata: Optional[VariableMetadata]) -> None:
         """Run after hooks with the evaluation result"""
         for hook in self.hooks:
             try:
-                hook.after(context, variable)
+                hook.after(context, variable, variable_metadata)
             except Exception as e:
                 raise AfterHookError(f"After hook failed: {e}", e)
 
-    def run_finally(self, context: HookContext, variable: Optional[Variable]) -> None:
+    def run_finally(self, context: HookContext, variable: Optional[Variable], variable_metadata: Optional[VariableMetadata]) -> None:
         """Run finally hooks after evaluation completes"""
         for hook in self.hooks:
             try:
-                hook.on_finally(context, variable)
+                hook.on_finally(context, variable, variable_metadata)
             except Exception as e:
                 logger.error(f"Error running finally hook: {e}")
 

devcycle_python_sdk/models/config_metadata.py

@@ -1,20 +1,27 @@
 from devcycle_python_sdk.models.environment_metadata import EnvironmentMetadata
 from devcycle_python_sdk.models.project_metadata import ProjectMetadata
 from typing import Dict, Any, Optional
+from dataclasses import dataclass
 import json
 
 
+@dataclass
 class ConfigMetadata:
-    def __init__(
-        self,
-        project: ProjectMetadata,
-        environment: EnvironmentMetadata,
-    ):
-        self.project = project
-        self.environment = environment
+    project: ProjectMetadata
+    environment: EnvironmentMetadata
 
-    def to_json(self) -> str:
-        return json.dumps(self, default=lambda o: o.__dict__)
+    def to_json(self):
+        result = {}
+        for field_name in self.__dataclass_fields__:
+            value = getattr(self, field_name)
+            if value is not None:
+                if field_name == "project" and isinstance(value, ProjectMetadata):
+                    result[field_name] = value.to_json()
+                elif field_name == "environment" and isinstance(value, EnvironmentMetadata):
+                    result[field_name] = value.to_json()
+                else:
+                    result[field_name] = value
+        return result
 
     @staticmethod
     def from_json(json_obj: Optional[Dict[str, Any]]) -> Optional["ConfigMetadata"]:

devcycle_python_sdk/models/environment_metadata.py

@@ -1,14 +1,11 @@
 from typing import Dict, Any, Optional
+from dataclasses import dataclass
 
 
+@dataclass
 class EnvironmentMetadata:
-    def __init__(
-        self,
-        id: str,
-        key: str,
-    ):
-        self.id = id
-        self.key = key
+    id: str
+    key: str
 
     @staticmethod
     def from_json(
@@ -20,3 +17,10 @@ def from_json(
             id=json_obj["id"],
             key=json_obj["key"],
         )
+
+    def to_json(self):
+        result = {}
+        for field_name in self.__dataclass_fields__:
+            value = getattr(self, field_name)
+            result[field_name] = value
+        return result

devcycle_python_sdk/models/eval_hook.py

@@ -2,14 +2,15 @@
 
 from devcycle_python_sdk.models.eval_hook_context import HookContext
 from devcycle_python_sdk.models.variable import Variable
+from devcycle_python_sdk.models.variable_metadata import VariableMetadata
 
 
 class EvalHook:
     def __init__(
         self,
         before: Callable[[HookContext], Optional[HookContext]],
-        after: Callable[[HookContext, Variable], None],
-        on_finally: Callable[[HookContext, Optional[Variable]], None],
+        after: Callable[[HookContext, Variable, Optional[VariableMetadata]], None],
+        on_finally: Callable[[HookContext, Optional[Variable], Optional[VariableMetadata]], None],
         error: Callable[[HookContext, Exception], None],
     ):
         self.before = before

devcycle_python_sdk/models/eval_hook_context.py

@@ -1,18 +1,32 @@
 from typing import Any, Optional
+from dataclasses import dataclass
 
 from devcycle_python_sdk.models.user import DevCycleUser
 from devcycle_python_sdk.models.config_metadata import ConfigMetadata
 
 
+@dataclass
 class HookContext:
-    def __init__(
-        self,
-        key: str,
-        user: DevCycleUser,
-        default_value: Any,
-        config_metadata: Optional[ConfigMetadata] = None,
-    ):
-        self.key = key
-        self.default_value = default_value
-        self.user = user
-        self.config_metadata = config_metadata
+    key: str
+    user: DevCycleUser
+    default_value: Any
+    config_metadata: Optional[ConfigMetadata] = None
+
+    def to_json(self):
+        result = {}
+        for field_name in self.__dataclass_fields__:
+            value = getattr(self, field_name)
+            if value is not None:
+                if field_name == "config_metadata" and isinstance(value, ConfigMetadata):
+                    result[field_name] = value.to_json()
+                elif field_name == "user" and isinstance(value, DevCycleUser):
+                    result[field_name] = value.to_json()
+                else:
+                    result[field_name] = value
+        return result
+
+    def __str__(self):
+        return f"HookContext(key={self.key}, user={self.user}, default_value={self.default_value}, config_metadata={self.config_metadata})"
+
+    def __repr__(self):
+        return self.__str__()

devcycle_python_sdk/models/project_metadata.py

@@ -1,14 +1,11 @@
 from typing import Dict, Any, Optional
+from dataclasses import dataclass
 
 
+@dataclass
 class ProjectMetadata:
-    def __init__(
-        self,
-        id: str,
-        key: str,
-    ):
-        self.id = id
-        self.key = key
+    id: str
+    key: str
 
     @staticmethod
     def from_json(json_obj: Optional[Dict[str, Any]]) -> Optional["ProjectMetadata"]:
@@ -18,3 +15,10 @@ def from_json(json_obj: Optional[Dict[str, Any]]) -> Optional["ProjectMetadata"]
             id=json_obj["id"],
             key=json_obj["key"],
         )
+
+    def to_json(self):
+        result = {}
+        for field_name in self.__dataclass_fields__:
+            value = getattr(self, field_name)
+            result[field_name] = value
+        return result

devcycle_python_sdk/models/variable_metadata.py

@@ -0,0 +1,22 @@
+from typing import Dict, Any, Optional
+from dataclasses import dataclass
+
+
+@dataclass
+class VariableMetadata:
+    feature_id: str
+
+    @staticmethod
+    def from_json(json_obj: Optional[Dict[str, Any]]) -> Optional["VariableMetadata"]:
+        if json_obj is None:
+            return None
+        return VariableMetadata(
+            feature_id=json_obj["feature_id"],
+        )
+
+    def to_json(self):
+        result = {}
+        for field_name in self.__dataclass_fields__:
+            value = getattr(self, field_name)
+            result[field_name] = value
+        return result

example/django-app/requirements.txt

@@ -1,2 +1,2 @@
 django >= 4.2
-devcycle-python-server-sdk >= 3.0.1
+-e ../../