feat: add support for domains

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

Author: federicobond

Diff for: openfeature/api.py

@@ -14,31 +14,52 @@
 
 _hooks: typing.List[Hook] = []
 
+_providers: typing.Dict[str, FeatureProvider] = {}
+
 
 def get_client(
-    name: typing.Optional[str] = None, version: typing.Optional[str] = None
+    domain: typing.Optional[str] = None, version: typing.Optional[str] = None
 ) -> OpenFeatureClient:
-    return OpenFeatureClient(name=name, version=version, provider=_provider)
+    return OpenFeatureClient(domain=domain, version=version)
 
 
-def set_provider(provider: FeatureProvider) -> None:
-    global _provider
+def set_provider(
+    provider: FeatureProvider, domain: typing.Optional[str] = None
+) -> None:
     if provider is None:
         raise GeneralError(error_message="No provider")
+
+    if domain:
+        _set_domain_provider(domain, provider)
+        return
+
+    global _provider
     if _provider:
         _provider.shutdown()
     _provider = provider
     provider.initialize(_evaluation_context)
 
 
-def get_provider() -> FeatureProvider:
-    global _provider
-    return _provider
+def _set_domain_provider(domain: str, provider: FeatureProvider) -> None:
+    if domain in _providers:
+        old_provider = _providers[domain]
+        del _providers[domain]
+        if old_provider not in _providers.values():
+            old_provider.shutdown()
+    if provider not in _providers.values():
+        provider.initialize(_evaluation_context)
+    _providers[domain] = provider
 
 
-def get_provider_metadata() -> Metadata:
+def get_provider(domain: typing.Optional[str] = None) -> FeatureProvider:
     global _provider
-    return _provider.get_metadata()
+    if domain is None:
+        return _provider
+    return _providers.get(domain, _provider)
+
+
+def get_provider_metadata(domain: typing.Optional[str] = None) -> Metadata:
+    return get_provider(domain).get_metadata()
 
 
 def get_evaluation_context() -> EvaluationContext:

Diff for: openfeature/client.py

@@ -60,26 +60,29 @@
 
 @dataclass
 class ClientMetadata:
-    name: typing.Optional[str]
+    name: typing.Optional[str] = None
+    domain: typing.Optional[str] = None
 
 
 class OpenFeatureClient:
     def __init__(
         self,
-        name: typing.Optional[str],
+        domain: typing.Optional[str],
         version: typing.Optional[str],
-        provider: FeatureProvider,
         context: typing.Optional[EvaluationContext] = None,
         hooks: typing.Optional[typing.List[Hook]] = None,
     ) -> None:
-        self.name = name
+        self.domain = domain
         self.version = version
         self.context = context or EvaluationContext()
         self.hooks = hooks or []
-        self.provider = provider
+
+    @property
+    def provider(self) -> FeatureProvider:
+        return api.get_provider(domain=self.domain)
 
     def get_metadata(self) -> ClientMetadata:
-        return ClientMetadata(name=self.name)
+        return ClientMetadata(domain=self.domain)
 
     def add_hooks(self, hooks: typing.List[Hook]) -> None:
         self.hooks = self.hooks + hooks

Diff for: tests/features/steps/steps.py

@@ -27,15 +27,15 @@ def step_impl(context, flag_type, key, expected_reason):
 @given("a provider is registered with cache disabled")
 def step_impl(context):
     set_provider(InMemoryProvider(IN_MEMORY_FLAGS))
-    context.client = get_client(name="Default Provider", version="1.0")
+    context.client = get_client()
 
 
 @when(
     'a {flag_type} flag with key "{key}" is evaluated with details and default value '
     '"{default_value}"'
 )
 def step_impl(context, flag_type, key, default_value):
-    context.client = get_client(name="Default Provider", version="1.0")
+    context.client = get_client()
     if flag_type == "boolean":
         context.boolean_flag_details = context.client.get_boolean_details(
             key, default_value

Diff for: tests/test_api.py

@@ -26,11 +26,9 @@ def test_should_not_raise_exception_with_noop_client():
     # Given
     # No provider has been set
     # When
-    client = get_client(name="Default Provider", version="1.0")
+    client = get_client()
 
     # Then
-    assert client.name == "Default Provider"
-    assert client.version == "1.0"
     assert isinstance(client.provider, NoOpProvider)
 
 
@@ -39,11 +37,9 @@ def test_should_return_open_feature_client_when_configured_correctly():
     set_provider(NoOpProvider())
 
     # When
-    client = get_client(name="No-op Provider", version="1.0")
+    client = get_client()
 
     # Then
-    assert client.name == "No-op Provider"
-    assert client.version == "1.0"
     assert isinstance(client.provider, NoOpProvider)
 
 
@@ -156,3 +152,57 @@ def test_should_call_provider_shutdown_on_api_shutdown():
 
     # Then
     assert provider.shutdown.called
+
+
+def test_should_provide_a_function_to_bind_provider_through_domain():
+    # Given
+    provider = MagicMock(spec=FeatureProvider)
+    test_client = get_client("test")
+    default_client = get_client()
+
+    # When
+    set_provider(provider, domain="test")
+
+    # Then
+    assert default_client.provider != provider
+    assert default_client.domain is None
+
+    assert test_client.provider == provider
+    assert test_client.domain == "test"
+
+
+def test_should_not_initialize_provider_already_bound_to_another_domain():
+    # Given
+    provider = MagicMock(spec=FeatureProvider)
+    set_provider(provider, "foo")
+
+    # When
+    set_provider(provider, "bar")
+
+    # Then
+    provider.initialize.assert_called_once()
+
+
+def test_should_shutdown_unbound_provider():
+    # Given
+    provider = MagicMock(spec=FeatureProvider)
+    set_provider(provider, "foo")
+
+    # When
+    other_provider = MagicMock(spec=FeatureProvider)
+    set_provider(other_provider, "foo")
+
+    provider.shutdown.assert_called_once()
+
+
+def test_should_not_shutdown_provider_bound_to_another_domain():
+    # Given
+    provider = MagicMock(spec=FeatureProvider)
+    set_provider(provider, "foo")
+    set_provider(provider, "bar")
+
+    # When
+    other_provider = MagicMock(spec=FeatureProvider)
+    set_provider(other_provider, "foo")
+
+    provider.shutdown.assert_not_called()

Diff for: tests/test_client.py

@@ -2,7 +2,7 @@
 
 import pytest
 
-from openfeature.api import add_hooks, clear_hooks
+from openfeature.api import add_hooks, clear_hooks, set_provider
 from openfeature.client import OpenFeatureClient
 from openfeature.exception import ErrorCode, OpenFeatureError
 from openfeature.flag_evaluation import Reason
@@ -109,7 +109,9 @@ def test_should_pass_flag_metadata_from_resolution_to_evaluation_details():
             )
         }
     )
-    client = OpenFeatureClient("my-client", None, provider)
+    set_provider(provider, "my-client")
+
+    client = OpenFeatureClient("my-client", None)
 
     # When
     details = client.get_boolean_details(flag_key="Key", default_value=False)
@@ -158,14 +160,14 @@ def test_should_handle_an_open_feature_exception_thrown_by_a_provider(
     assert flag_details.error_message == "error_message"
 
 
-def test_should_return_client_metadata_with_name():
+def test_should_return_client_metadata_with_domain():
     # Given
     client = OpenFeatureClient("my-client", None, NoOpProvider())
     # When
     metadata = client.get_metadata()
     # Then
     assert metadata is not None
-    assert metadata.name == "my-client"
+    assert metadata.domain == "my-client"
 
 
 def test_should_call_api_level_hooks(no_op_provider_client):