fix: fix cycle dependency between api and client (#480)

* fix cycle dependency between api and client

Signed-off-by: gruebel <anton.gruebel@gmail.com>

* remove comment

Signed-off-by: gruebel <anton.gruebel@gmail.com>

---------

Signed-off-by: gruebel <anton.gruebel@gmail.com>
Co-authored-by: Michael Beemer <beeme1mr@users.noreply.github.com>

Author: gruebel

openfeature/api.py

@@ -2,19 +2,22 @@
 
 from openfeature import _event_support
 from openfeature.client import OpenFeatureClient
-from openfeature.evaluation_context import EvaluationContext
+from openfeature.evaluation_context import (
+    get_evaluation_context,
+    set_evaluation_context,
+)
 from openfeature.event import (
     EventHandler,
     ProviderEvent,
 )
-from openfeature.exception import GeneralError
-from openfeature.hook import Hook
+from openfeature.hook import add_hooks, clear_hooks, get_hooks
 from openfeature.provider import FeatureProvider
 from openfeature.provider._registry import provider_registry
 from openfeature.provider.metadata import Metadata
-from openfeature.transaction_context import TransactionContextPropagator
-from openfeature.transaction_context.no_op_transaction_context_propagator import (
-    NoOpTransactionContextPropagator,
+from openfeature.transaction_context import (
+    get_transaction_context,
+    set_transaction_context,
+    set_transaction_context_propagator,
 )
 
 __all__ = [
@@ -35,13 +38,6 @@
     "shutdown",
 ]
 
-_evaluation_context = EvaluationContext()
-_evaluation_transaction_context_propagator: TransactionContextPropagator = (
-    NoOpTransactionContextPropagator()
-)
-
-_hooks: list[Hook] = []
-
 
 def get_client(
     domain: typing.Optional[str] = None, version: typing.Optional[str] = None
@@ -67,49 +63,6 @@ def get_provider_metadata(domain: typing.Optional[str] = None) -> Metadata:
     return provider_registry.get_provider(domain).get_metadata()
 
 
-def get_evaluation_context() -> EvaluationContext:
-    return _evaluation_context
-
-
-def set_evaluation_context(evaluation_context: EvaluationContext) -> None:
-    global _evaluation_context
-    if evaluation_context is None:
-        raise GeneralError(error_message="No api level evaluation context")
-    _evaluation_context = evaluation_context
-
-
-def set_transaction_context_propagator(
-    transaction_context_propagator: TransactionContextPropagator,
-) -> None:
-    global _evaluation_transaction_context_propagator
-    _evaluation_transaction_context_propagator = transaction_context_propagator
-
-
-def get_transaction_context() -> EvaluationContext:
-    return _evaluation_transaction_context_propagator.get_transaction_context()
-
-
-def set_transaction_context(evaluation_context: EvaluationContext) -> None:
-    global _evaluation_transaction_context_propagator
-    _evaluation_transaction_context_propagator.set_transaction_context(
-        evaluation_context
-    )
-
-
-def add_hooks(hooks: list[Hook]) -> None:
-    global _hooks
-    _hooks = _hooks + hooks
-
-
-def clear_hooks() -> None:
-    global _hooks
-    _hooks = []
-
-
-def get_hooks() -> list[Hook]:
-    return _hooks
-
-
 def shutdown() -> None:
     provider_registry.shutdown()
 

openfeature/client.py

@@ -3,8 +3,8 @@
 from collections.abc import Awaitable
 from dataclasses import dataclass
 
-from openfeature import _event_support, api
-from openfeature.evaluation_context import EvaluationContext
+from openfeature import _event_support
+from openfeature.evaluation_context import EvaluationContext, get_evaluation_context
 from openfeature.event import EventHandler, ProviderEvent
 from openfeature.exception import (
     ErrorCode,
@@ -21,7 +21,7 @@
     FlagType,
     Reason,
 )
-from openfeature.hook import Hook, HookContext, HookHints
+from openfeature.hook import Hook, HookContext, HookHints, get_hooks
 from openfeature.hook._hook_support import (
     after_all_hooks,
     after_hooks,
@@ -30,6 +30,7 @@
 )
 from openfeature.provider import FeatureProvider, ProviderStatus
 from openfeature.provider._registry import provider_registry
+from openfeature.transaction_context import get_transaction_context
 
 __all__ = [
     "ClientMetadata",
@@ -433,10 +434,7 @@ def _establish_hooks_and_provider(
         # in the flag evaluation
         # before: API, Client, Invocation, Provider
         merged_hooks = (
-            api.get_hooks()
-            + self.hooks
-            + evaluation_hooks
-            + provider.get_provider_hooks()
+            get_hooks() + self.hooks + evaluation_hooks + provider.get_provider_hooks()
         )
         # after, error, finally: Provider, Invocation, Client, API
         reversed_merged_hooks = merged_hooks[:]
@@ -474,8 +472,8 @@ def _before_hooks_and_merge_context(
 
         # Requirement 3.2.2 merge: API.context->transaction.context->client.context->invocation.context
         merged_context = (
-            api.get_evaluation_context()
-            .merge(api.get_transaction_context())
+            get_evaluation_context()
+            .merge(get_transaction_context())
             .merge(self.context)
             .merge(invocation_context)
         )

openfeature/evaluation_context.py

@@ -0,0 +1,38 @@
+from __future__ import annotations
+
+import typing
+from dataclasses import dataclass, field
+
+from openfeature.exception import GeneralError
+
+__all__ = ["EvaluationContext", "get_evaluation_context", "set_evaluation_context"]
+
+
+@dataclass
+class EvaluationContext:
+    targeting_key: typing.Optional[str] = None
+    attributes: dict = field(default_factory=dict)
+
+    def merge(self, ctx2: EvaluationContext) -> EvaluationContext:
+        if not (self and ctx2):
+            return self or ctx2
+
+        attributes = {**self.attributes, **ctx2.attributes}
+        targeting_key = ctx2.targeting_key or self.targeting_key
+
+        return EvaluationContext(targeting_key=targeting_key, attributes=attributes)
+
+
+def get_evaluation_context() -> EvaluationContext:
+    return _evaluation_context
+
+
+def set_evaluation_context(evaluation_context: EvaluationContext) -> None:
+    global _evaluation_context
+    if evaluation_context is None:
+        raise GeneralError(error_message="No api level evaluation context")
+    _evaluation_context = evaluation_context
+
+
+# need to be at the bottom, because of the definition order
+_evaluation_context = EvaluationContext()

openfeature/evaluation_context/__init__.py

@@ -12,7 +12,17 @@
     from openfeature.client import ClientMetadata
     from openfeature.provider.metadata import Metadata
 
-__all__ = ["Hook", "HookContext", "HookHints", "HookType"]
+__all__ = [
+    "Hook",
+    "HookContext",
+    "HookHints",
+    "HookType",
+    "add_hooks",
+    "clear_hooks",
+    "get_hooks",
+]
+
+_hooks: list[Hook] = []
 
 
 class HookType(Enum):
@@ -133,3 +143,17 @@ def supports_flag_value_type(self, flag_type: FlagType) -> bool:
         or not (False)
         """
         return True
+
+
+def add_hooks(hooks: list[Hook]) -> None:
+    global _hooks
+    _hooks = _hooks + hooks
+
+
+def clear_hooks() -> None:
+    global _hooks
+    _hooks = []
+
+
+def get_hooks() -> list[Hook]:
+    return _hooks

openfeature/hook/__init__.py

@@ -1,7 +1,7 @@
 import typing
 
 from openfeature._event_support import run_handlers_for_provider
-from openfeature.evaluation_context import EvaluationContext
+from openfeature.evaluation_context import EvaluationContext, get_evaluation_context
 from openfeature.event import (
     ProviderEvent,
     ProviderEventDetails,
@@ -65,9 +65,6 @@ def shutdown(self) -> None:
             self._shutdown_provider(provider)
 
     def _get_evaluation_context(self) -> EvaluationContext:
-        # imported here to avoid circular imports
-        from openfeature.api import get_evaluation_context
-
         return get_evaluation_context()
 
     def _initialize_provider(self, provider: FeatureProvider) -> None:

openfeature/provider/_registry.py

@@ -1,11 +1,40 @@
+from openfeature.evaluation_context import EvaluationContext
 from openfeature.transaction_context.context_var_transaction_context_propagator import (
     ContextVarsTransactionContextPropagator,
 )
+from openfeature.transaction_context.no_op_transaction_context_propagator import (
+    NoOpTransactionContextPropagator,
+)
 from openfeature.transaction_context.transaction_context_propagator import (
     TransactionContextPropagator,
 )
 
 __all__ = [
     "ContextVarsTransactionContextPropagator",
     "TransactionContextPropagator",
+    "get_transaction_context",
+    "set_transaction_context",
+    "set_transaction_context_propagator",
 ]
+
+_evaluation_transaction_context_propagator: TransactionContextPropagator = (
+    NoOpTransactionContextPropagator()
+)
+
+
+def set_transaction_context_propagator(
+    transaction_context_propagator: TransactionContextPropagator,
+) -> None:
+    global _evaluation_transaction_context_propagator
+    _evaluation_transaction_context_propagator = transaction_context_propagator
+
+
+def get_transaction_context() -> EvaluationContext:
+    return _evaluation_transaction_context_propagator.get_transaction_context()
+
+
+def set_transaction_context(evaluation_context: EvaluationContext) -> None:
+    global _evaluation_transaction_context_propagator
+    _evaluation_transaction_context_propagator.set_transaction_context(
+        evaluation_context
+    )