feat(provider): proper Unleash lifecycle event handling

Signed-off-by: Kiki L Hakiem <[email protected]>

Author: kikihakiem

providers/openfeature-provider-unleash/src/openfeature/contrib/provider/unleash/__init__.py

@@ -3,7 +3,7 @@
 
 from UnleashClient import UnleashClient
 from UnleashClient.cache import BaseCache
-from UnleashClient.events import BaseEvent, UnleashReadyEvent
+from UnleashClient.events import BaseEvent, UnleashEventType
 
 from openfeature.evaluation_context import EvaluationContext
 from openfeature.event import ProviderEvent
@@ -44,8 +44,16 @@ def __init__(
         self.api_token = api_token
         self.environment = environment
         self.cache = cache
-        self.client: Optional[UnleashClient] = None
         self._status = ProviderStatus.NOT_READY
+
+        self.client: UnleashClient = UnleashClient(
+            url=self.url,
+            app_name=self.app_name,
+            environment=self.environment,
+            custom_headers={"Authorization": self.api_token},
+            event_callback=self._unleash_event_callback,
+            cache=self.cache,
+        )
         self._last_context: Optional[EvaluationContext] = None
         self._event_handlers: dict[ProviderEvent, list[Callable]] = {
             ProviderEvent.PROVIDER_READY: [],
@@ -67,17 +75,7 @@ def initialize(
             evaluation_context: Optional evaluation context (not used for initialization)
         """
         try:
-            self.client = UnleashClient(
-                url=self.url,
-                app_name=self.app_name,
-                environment=self.environment,
-                custom_headers={"Authorization": self.api_token},
-                event_callback=self._unleash_event_callback,
-                cache=self.cache,
-            )
             self.client.initialize_client(fetch_toggles=self.fetch_toggles)
-            self._status = ProviderStatus.READY
-            self._event_manager.emit_event(ProviderEvent.PROVIDER_READY)
         except Exception as e:
             self._status = ProviderStatus.ERROR
             self._event_manager.emit_event(
@@ -101,19 +99,18 @@ def get_provider_hooks(self) -> list[Hook]:
 
     def shutdown(self) -> None:
         """Shutdown the Unleash client."""
-        if self.client:
-            try:
+        try:
+            if self.client.is_initialized:
                 self.client.destroy()
-                self.client = None
-                self._status = ProviderStatus.NOT_READY
-            except Exception as e:
-                self._status = ProviderStatus.ERROR
-                self._event_manager.emit_event(
-                    ProviderEvent.PROVIDER_ERROR,
-                    error_message=str(e),
-                    error_code=ErrorCode.GENERAL,
-                )
-                raise GeneralError(f"Failed to shutdown Unleash provider: {e}") from e
+            self._status = ProviderStatus.NOT_READY
+        except Exception as e:
+            self._status = ProviderStatus.ERROR
+            self._event_manager.emit_event(
+                ProviderEvent.PROVIDER_ERROR,
+                error_message=str(e),
+                error_code=ErrorCode.GENERAL,
+            )
+            raise GeneralError(f"Failed to shutdown Unleash provider: {e}") from e
 
     def on_context_changed(
         self,
@@ -152,7 +149,7 @@ def _unleash_event_callback(self, event: BaseEvent) -> None:
         Args:
             event: The Unleash event
         """
-        if isinstance(event, UnleashReadyEvent):
+        if event.event_type == UnleashEventType.READY:
             self._status = ProviderStatus.READY
         self._event_manager.handle_unleash_event(event)
 

providers/openfeature-provider-unleash/src/openfeature/contrib/provider/unleash/flag_evaluation.py

@@ -18,7 +18,7 @@ class UnleashProvider(Protocol):
     """Protocol defining the interface needed by FlagEvaluator."""
 
     @property
-    def client(self) -> Optional[UnleashClient]: ...
+    def client(self) -> UnleashClient: ...
 
     @property
     def app_name(self) -> str: ...
@@ -55,9 +55,6 @@ def resolve_boolean_details(
         Returns:
             FlagResolutionDetails with the resolved boolean value
         """
-        if not self._provider.client:
-            raise GeneralError("Provider not initialized. Call initialize() first.")
-
         try:
             context = self._provider._build_unleash_context(evaluation_context)
             is_enabled = self._provider.client.is_enabled(flag_key, context=context)
@@ -177,9 +174,6 @@ def _resolve_variant_flag(
         Returns:
             FlagResolutionDetails with the resolved value
         """
-        if not self._provider.client:
-            raise GeneralError("Provider not initialized. Call initialize() first.")
-
         try:
             context = self._provider._build_unleash_context(evaluation_context)
             variant = self._provider.client.get_variant(flag_key, context=context)

providers/openfeature-provider-unleash/tests/test_events.py

@@ -50,8 +50,12 @@ def on_config_changed(event_details):
             ProviderEvent.PROVIDER_CONFIGURATION_CHANGED, on_config_changed
         )
 
-        # Initialize should emit PROVIDER_READY
         provider.initialize()
+
+        # Simulate the READY event from UnleashClient
+        event_callback = mock_unleash_client.call_args[1]["event_callback"]
+        event_callback(UnleashReadyEvent(UnleashEventType.READY, uuid.uuid4()))
+
         assert len(ready_events) == 1
         assert ready_events[0]["provider_name"] == "Unleash Provider"
 
@@ -112,6 +116,7 @@ def test_unleash_event_callback():
 
         # Create a mock UnleashFetchedEvent with features
         mock_event = Mock(spec=UnleashFetchedEvent)
+        mock_event.event_type = UnleashEventType.FETCHED
         mock_event.features = {"flag1": {}, "flag2": {}}
 
         event_callback(mock_event)

providers/openfeature-provider-unleash/tests/test_provider.py

@@ -1,4 +1,6 @@
+import uuid
 from unittest.mock import Mock, patch
+from UnleashClient.events import UnleashEventType, UnleashReadyEvent
 
 from openfeature.contrib.provider.unleash import UnleashProvider
 from openfeature.evaluation_context import EvaluationContext
@@ -73,10 +75,13 @@ def test_unleash_provider_initialization():
         # Should start as NOT_READY
         assert provider.get_status() == ProviderStatus.NOT_READY
 
-        # Initialize the provider
         provider.initialize()
 
-        # Should be READY after initialization
+        # Simulate the READY event from UnleashClient
+        event_callback = mock_unleash_client.call_args[1]["event_callback"]
+        event_callback(UnleashReadyEvent(UnleashEventType.READY, uuid.uuid4()))
+
+        # Should be READY after receiving the READY event
         assert provider.get_status() == ProviderStatus.READY
         assert provider.client is not None