fix: correctly reset api state on shutdown (#589)

correctly reset api state on shutdown

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

Author: gruebel

openfeature/api.py

@@ -1,6 +1,7 @@
 from openfeature import _event_support
 from openfeature.client import OpenFeatureClient
 from openfeature.evaluation_context import (
+    clear_evaluation_context,
     get_evaluation_context,
     set_evaluation_context,
 )
@@ -13,6 +14,7 @@
 from openfeature.provider._registry import provider_registry
 from openfeature.provider.metadata import Metadata
 from openfeature.transaction_context import (
+    clear_transaction_context_propagator,
     get_transaction_context,
     set_transaction_context,
     set_transaction_context_propagator,
@@ -60,7 +62,14 @@ def get_provider_metadata(domain: str | None = None) -> Metadata:
 
 
 def shutdown() -> None:
-    provider_registry.shutdown()
+    # shutdown -> remove providers -> set default provider to NoOp -> remove event handlers
+    clear_providers()
+    # remove hooks
+    clear_hooks()
+    # set evaluation context to default
+    clear_evaluation_context()
+    # set propagator to NoOp
+    clear_transaction_context_propagator()
 
 
 def add_handler(event: ProviderEvent, handler: EventHandler) -> None:

openfeature/evaluation_context/__init__.py

@@ -7,7 +7,12 @@
 
 from openfeature.exception import GeneralError
 
-__all__ = ["EvaluationContext", "get_evaluation_context", "set_evaluation_context"]
+__all__ = [
+    "EvaluationContext",
+    "clear_evaluation_context",
+    "get_evaluation_context",
+    "set_evaluation_context",
+]
 
 # https://openfeature.dev/specification/sections/evaluation-context#requirement-312
 EvaluationContextAttribute: typing.TypeAlias = (
@@ -47,5 +52,9 @@ def set_evaluation_context(evaluation_context: EvaluationContext) -> None:
     _evaluation_context = evaluation_context
 
 
+def clear_evaluation_context() -> None:
+    set_evaluation_context(EvaluationContext())
+
+
 # need to be at the bottom, because of the definition order
 _evaluation_context = EvaluationContext()

openfeature/transaction_context/__init__.py

@@ -12,6 +12,7 @@
 __all__ = [
     "ContextVarsTransactionContextPropagator",
     "TransactionContextPropagator",
+    "clear_transaction_context_propagator",
     "get_transaction_context",
     "set_transaction_context",
     "set_transaction_context_propagator",
@@ -29,6 +30,10 @@ def set_transaction_context_propagator(
     _evaluation_transaction_context_propagator = transaction_context_propagator
 
 
+def clear_transaction_context_propagator() -> None:
+    set_transaction_context_propagator(NoOpTransactionContextPropagator())
+
+
 def get_transaction_context() -> EvaluationContext:
     return _evaluation_transaction_context_propagator.get_transaction_context()
 

tests/test_api.py

@@ -21,7 +21,13 @@
 from openfeature.exception import ErrorCode, GeneralError, ProviderFatalError
 from openfeature.hook import Hook
 from openfeature.provider import FeatureProvider, Metadata, ProviderStatus
+from openfeature.provider._registry import provider_registry
 from openfeature.provider.no_op_provider import NoOpProvider
+from openfeature.transaction_context import (
+    ContextVarsTransactionContextPropagator,
+    get_transaction_context,
+    set_transaction_context_propagator,
+)
 
 
 def test_should_not_raise_exception_with_noop_client():
@@ -198,6 +204,7 @@ def test_should_not_shutdown_provider_bound_to_another_domain():
     provider.shutdown.assert_not_called()
 
 
+# Requirement 1.6.1
 def test_shutdown_should_shutdown_every_registered_provider_once():
     # Given
     provider_1 = MagicMock(spec=FeatureProvider)
@@ -215,6 +222,35 @@ def test_shutdown_should_shutdown_every_registered_provider_once():
     provider_2.shutdown.assert_called_once()
 
 
+# Requirement 1.6.2
+def test_shutdown_should_reset_api_state():
+    # Given
+    set_provider(MagicMock(spec=FeatureProvider))
+    add_hooks([MagicMock(spec=Hook)])
+    set_evaluation_context(EvaluationContext("targeting_key", {"attr1": "val1"}))
+    set_transaction_context_propagator(ContextVarsTransactionContextPropagator())
+
+    # When
+    shutdown()
+
+    # Then
+    provider = provider_registry.get_default_provider()
+    assert isinstance(provider, NoOpProvider)
+
+    hooks = get_hooks()
+    assert not hooks
+
+    evaluation_context = get_evaluation_context()
+    assert evaluation_context.targeting_key is None
+    assert not evaluation_context.attributes
+
+    transaction_context = (
+        get_transaction_context()
+    )  # NoOpTransactionContextPropagator returns a default context
+    assert transaction_context.targeting_key is None
+    assert not transaction_context.attributes
+
+
 def test_clear_providers_shutdowns_every_provider_and_resets_default_provider():
     # Given
     provider_1 = MagicMock(spec=FeatureProvider)

tests/test_client.py

@@ -23,6 +23,7 @@
 from openfeature.flag_evaluation import FlagResolutionDetails, FlagType, Reason
 from openfeature.hook import Hook
 from openfeature.provider import FeatureProvider, ProviderStatus
+from openfeature.provider._registry import provider_registry
 from openfeature.provider.in_memory_provider import InMemoryFlag, InMemoryProvider
 from openfeature.provider.no_op_provider import NoOpProvider
 from openfeature.transaction_context import ContextVarsTransactionContextPropagator
@@ -348,7 +349,7 @@ def _shutdown(self) -> None:
     monkeypatch.setattr(provider, "shutdown", types.MethodType(_shutdown, provider))
 
     # When
-    api.shutdown()
+    provider_registry.shutdown()
 
     status = client.get_provider_status()