refactor!: move api evaluation context methods to api module (#164)

* refactor: move api evaluation_context methods to api module

Signed-off-by: Federico Bond <[email protected]>

* refactor: rename api_evaluation_context and set_api_evaluation_context

Signed-off-by: Federico Bond <[email protected]>

---------

Signed-off-by: Federico Bond <[email protected]>

Author: federicobond

open_feature/open_feature_api.py

@@ -1,5 +1,6 @@
 import typing
 
+from open_feature.evaluation_context.evaluation_context import EvaluationContext
 from open_feature.exception.exceptions import GeneralError
 from open_feature.open_feature_client import OpenFeatureClient
 from open_feature.provider.metadata import Metadata
@@ -8,6 +9,8 @@
 
 _provider: AbstractProvider = NoOpProvider()
 
+_evaluation_context = EvaluationContext()
+
 
 def get_client(
     name: typing.Optional[str] = None, version: typing.Optional[str] = None
@@ -30,3 +33,15 @@ def get_provider() -> typing.Optional[AbstractProvider]:
 def get_provider_metadata() -> typing.Optional[Metadata]:
     global _provider
     return _provider.get_metadata()
+
+
+def get_evaluation_context() -> EvaluationContext:
+    global _evaluation_context
+    return _evaluation_context
+
+
+def set_evaluation_context(evaluation_context: EvaluationContext):
+    global _evaluation_context
+    if evaluation_context is None:
+        raise GeneralError(error_message="No api level evaluation context")
+    _evaluation_context = evaluation_context

open_feature/open_feature_client.py

@@ -2,6 +2,7 @@
 import typing
 from dataclasses import dataclass
 
+from open_feature import open_feature_api as api
 from open_feature.evaluation_context.evaluation_context import EvaluationContext
 from open_feature.exception.error_code import ErrorCode
 from open_feature.exception.exceptions import (
@@ -23,7 +24,6 @@
     before_hooks,
     error_hooks,
 )
-from open_feature.open_feature_evaluation_context import api_evaluation_context
 from open_feature.provider.no_op_provider import NoOpProvider
 from open_feature.provider.provider import AbstractProvider
 
@@ -280,7 +280,9 @@ def evaluate_flag_details(
 
             # Requirement 3.2.2 merge: API.context->client.context->invocation.context
             merged_context = (
-                api_evaluation_context().merge(self.context).merge(invocation_context)
+                api.get_evaluation_context()
+                .merge(self.context)
+                .merge(invocation_context)
             )
 
             flag_evaluation = self._create_provider_evaluation(

open_feature/open_feature_evaluation_context.py

@@ -103,10 +103,12 @@ In OpenFeature, we refer to this as [`targeting`](https://openfeature.dev/specif
 If the flag system you're using supports targeting, you can provide the input data using the `EvaluationContext`.
 
 ```python
-from open_feature.open_feature_api import get_client, get_provider, set_provider
-from open_feature.open_feature_evaluation_context import (
-    api_evaluation_context,
-    set_api_evaluation_context,
+from open_feature.open_feature_api import (
+    get_client,
+    get_provider,
+    set_provider
+    get_evaluation_context,
+    set_evaluation_context,
 )
 
 global_context = EvaluationContext(
@@ -117,7 +119,7 @@ request_context = EvaluationContext(
 )
 
 ## set global context
-set_api_evaluation_context(first_context)
+set_evaluation_context(first_context)
 
 # merge second context
 client = get_client(name="No-op Provider", version="0.5.2")

readme.md

@@ -1,12 +1,15 @@
 import pytest
 
+from open_feature.evaluation_context.evaluation_context import EvaluationContext
 from open_feature.exception.error_code import ErrorCode
 from open_feature.exception.exceptions import GeneralError
 from open_feature.open_feature_api import (
     get_client,
     get_provider,
     set_provider,
     get_provider_metadata,
+    get_evaluation_context,
+    set_evaluation_context,
 )
 from open_feature.provider.metadata import Metadata
 from open_feature.provider.no_op_provider import NoOpProvider
@@ -70,3 +73,27 @@ def test_should_retrieve_metadata_for_configured_provider():
     # Then
     assert isinstance(metadata, Metadata)
     assert metadata.name == "No-op Provider"
+
+
+def test_should_raise_an_exception_if_no_evaluation_context_set():
+    # Given
+    with pytest.raises(GeneralError) as ge:
+        set_evaluation_context(evaluation_context=None)
+    # Then
+    assert ge.value
+    assert ge.value.error_message == "No api level evaluation context"
+    assert ge.value.error_code == ErrorCode.GENERAL
+
+
+def test_should_successfully_set_evaluation_context_for_api():
+    # Given
+    evaluation_context = EvaluationContext("targeting_key", {"attr1": "val1"})
+
+    # When
+    set_evaluation_context(evaluation_context)
+    global_evaluation_context = get_evaluation_context()
+
+    # Then
+    assert global_evaluation_context
+    assert global_evaluation_context.targeting_key == evaluation_context.targeting_key
+    assert global_evaluation_context.attributes == evaluation_context.attributes