Merge branch 'main' into hook-no-abstractmethod

Author: beeme1mr

openfeature/api.py

@@ -25,7 +25,10 @@ def set_provider(provider: AbstractProvider):
     global _provider
     if provider is None:
         raise GeneralError(error_message="No provider")
+    if _provider:
+        _provider.shutdown()
     _provider = provider
+    provider.initialize(_evaluation_context)
 
 
 def get_provider() -> typing.Optional[AbstractProvider]:
@@ -63,3 +66,7 @@ def clear_hooks():
 def get_hooks() -> typing.List[Hook]:
     global _hooks
     return _hooks
+
+
+def shutdown():
+    _provider.shutdown()

openfeature/client.py

@@ -377,6 +377,7 @@ def _create_provider_evaluation(
             flag_key=flag_key,
             value=resolution.value,
             variant=resolution.variant,
+            flag_metadata=resolution.flag_metadata or {},
             reason=resolution.reason,
             error_code=resolution.error_code,
             error_message=resolution.error_message,

openfeature/flag_evaluation.py

@@ -29,6 +29,8 @@ class Reason(StrEnum):
     UNKNOWN = "UNKNOWN"
 
 
+FlagMetadata = typing.Mapping[str, typing.Any]
+
 T = typing.TypeVar("T", covariant=True)
 
 
@@ -37,6 +39,7 @@ class FlagEvaluationDetails(typing.Generic[T]):
     flag_key: str
     value: T
     variant: typing.Optional[str] = None
+    flag_metadata: FlagMetadata = field(default_factory=dict)
     reason: typing.Optional[Reason] = None
     error_code: typing.Optional[ErrorCode] = None
     error_message: typing.Optional[str] = None
@@ -58,4 +61,4 @@ class FlagResolutionDetails(typing.Generic[U]):
     error_message: typing.Optional[str] = None
     reason: typing.Optional[Reason] = None
     variant: typing.Optional[str] = None
-    flag_metadata: typing.Optional[str] = None
+    flag_metadata: FlagMetadata = field(default_factory=dict)

openfeature/provider/in_memory_provider.py

@@ -1,10 +1,10 @@
 import typing
-from dataclasses import dataclass
+from dataclasses import dataclass, field
 
 from openfeature._backports.strenum import StrEnum
 from openfeature.evaluation_context import EvaluationContext
 from openfeature.exception import ErrorCode
-from openfeature.flag_evaluation import FlagResolutionDetails, Reason
+from openfeature.flag_evaluation import FlagMetadata, FlagResolutionDetails, Reason
 from openfeature.hook import Hook
 from openfeature.provider.metadata import Metadata
 from openfeature.provider.provider import AbstractProvider
@@ -29,6 +29,7 @@ class State(StrEnum):
     flag_key: str
     default_variant: str
     variants: typing.Dict[str, T]
+    flag_metadata: FlagMetadata = field(default_factory=dict)
     state: State = State.ENABLED
     context_evaluator: typing.Optional[
         typing.Callable[["InMemoryFlag", EvaluationContext], FlagResolutionDetails[T]]
@@ -46,6 +47,7 @@ def resolve(
             value=self.variants[self.default_variant],
             reason=Reason.STATIC,
             variant=self.default_variant,
+            flag_metadata=self.flag_metadata,
         )
 
 

openfeature/provider/provider.py

@@ -8,6 +8,12 @@
 
 
 class AbstractProvider:
+    def initialize(self, evaluation_context: EvaluationContext):
+        pass
+
+    def shutdown(self):
+        pass
+
     @abstractmethod
     def get_metadata(self) -> Metadata:
         pass

tests/test_api.py

@@ -12,12 +12,14 @@
     get_provider_metadata,
     set_evaluation_context,
     set_provider,
+    shutdown,
 )
 from openfeature.evaluation_context import EvaluationContext
 from openfeature.exception import ErrorCode, GeneralError
 from openfeature.hook import Hook
 from openfeature.provider.metadata import Metadata
 from openfeature.provider.no_op_provider import NoOpProvider
+from openfeature.provider.provider import AbstractProvider
 
 
 def test_should_not_raise_exception_with_noop_client():
@@ -56,6 +58,32 @@ def test_should_try_set_provider_and_fail_if_none_provided():
     assert ge.value.error_code == ErrorCode.GENERAL
 
 
+def test_should_invoke_provider_initialize_function_on_newly_registered_provider():
+    # Given
+    evaluation_context = EvaluationContext("targeting_key", {"attr1": "val1"})
+    provider = MagicMock(spec=AbstractProvider)
+
+    # When
+    set_evaluation_context(evaluation_context)
+    set_provider(provider)
+
+    # Then
+    provider.initialize.assert_called_with(evaluation_context)
+
+
+def test_should_invoke_provider_shutdown_function_once_provider_is_no_longer_in_use():
+    # Given
+    provider_1 = MagicMock(spec=AbstractProvider)
+    provider_2 = MagicMock(spec=AbstractProvider)
+
+    # When
+    set_provider(provider_1)
+    set_provider(provider_2)
+
+    # Then
+    assert provider_1.shutdown.called
+
+
 def test_should_return_a_provider_if_setup_correctly():
     # Given
     set_provider(NoOpProvider())
@@ -116,3 +144,15 @@ def test_should_add_hooks_to_api_hooks():
 
     # Then
     assert get_hooks() == [hook_1, hook_2]
+
+
+def test_should_call_provider_shutdown_on_api_shutdown():
+    # Given
+    provider = MagicMock(spec=AbstractProvider)
+    set_provider(provider)
+
+    # When
+    shutdown()
+
+    # Then
+    assert provider.shutdown.called

tests/test_client.py

@@ -7,6 +7,7 @@
 from openfeature.exception import ErrorCode, OpenFeatureError
 from openfeature.flag_evaluation import Reason
 from openfeature.hook import Hook
+from openfeature.provider.in_memory_provider import InMemoryFlag, InMemoryProvider
 from openfeature.provider.no_op_provider import NoOpProvider
 
 
@@ -97,6 +98,28 @@ def test_should_raise_exception_when_invalid_flag_type_provided(no_op_provider_c
     assert flag.reason == Reason.ERROR
 
 
+def test_should_pass_flag_metadata_from_resolution_to_evaluation_details():
+    # Given
+    provider = InMemoryProvider(
+        {
+            "Key": InMemoryFlag(
+                "Key",
+                "true",
+                {"true": True, "false": False},
+                flag_metadata={"foo": "bar"},
+            )
+        }
+    )
+    client = OpenFeatureClient("my-client", None, provider)
+
+    # When
+    details = client.get_boolean_details(flag_key="Key", default_value=False)
+
+    # Then
+    assert details is not None
+    assert details.flag_metadata == {"foo": "bar"}
+
+
 def test_should_handle_a_generic_exception_thrown_by_a_provider(no_op_provider_client):
     # Given
     exception_hook = MagicMock(spec=Hook)

tests/test_flag_evaluation.py

@@ -2,11 +2,12 @@
 from openfeature.flag_evaluation import FlagEvaluationDetails, Reason
 
 
-def test_evaulation_details_reason_should_be_a_string():
+def test_evaluation_details_reason_should_be_a_string():
     # Given
     flag_key = "my-flag"
     flag_value = 100
     variant = "1-hundred"
+    flag_metadata = {}
     reason = Reason.DEFAULT
     error_code = ErrorCode.GENERAL
     error_message = "message"
@@ -16,6 +17,7 @@ def test_evaulation_details_reason_should_be_a_string():
         flag_key,
         flag_value,
         variant,
+        flag_metadata,
         reason,
         error_code,
         error_message,
@@ -30,7 +32,7 @@ def test_evaulation_details_reason_should_be_a_string():
     assert reason == flag_details.reason
 
 
-def test_evaulation_details_reason_should_be_a_string_when_set():
+def test_evaluation_details_reason_should_be_a_string_when_set():
     # Given
     flag_key = "my-flag"
     flag_value = 100