openfeature-provider-flagd 0.2.0__tar.gz → 0.2.1__tar.gz

{openfeature_provider_flagd-0.2.0 → openfeature_provider_flagd-0.2.1}/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [0.2.1](https://github.com/open-feature/python-sdk-contrib/compare/openfeature-provider-flagd/v0.2.0...openfeature-provider-flagd/v0.2.1) (2025-03-10)
+
+
+### ✨ New Features
+
+* **flagd:** Add features to customize auth to Sync API servers ([#203](https://github.com/open-feature/python-sdk-contrib/issues/203)) ([5151e94](https://github.com/open-feature/python-sdk-contrib/commit/5151e941d229101bdbcc5b40f570f69d77ddda7b))
+* **flagd:** Context value hydration ([#195](https://github.com/open-feature/python-sdk-contrib/issues/195)) ([4fa619b](https://github.com/open-feature/python-sdk-contrib/commit/4fa619b93faf1d1f62a9ead99f33baa21c04e267))
+
 ## [0.2.0](https://github.com/open-feature/python-sdk-contrib/compare/openfeature-provider-flagd/v0.1.5...openfeature-provider-flagd/v0.2.0) (2025-02-18)
 
 

{openfeature_provider_flagd-0.2.0 → openfeature_provider_flagd-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: openfeature-provider-flagd
-Version: 0.2.0
+Version: 0.2.1
 Summary: OpenFeature provider for the flagd flag evaluation engine
 Project-URL: Homepage, https://github.com/open-feature/python-sdk-contrib
 Author-email: OpenFeature <openfeature-core@groups.io>

{openfeature_provider_flagd-0.2.0 → openfeature_provider_flagd-0.2.1}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "openfeature-provider-flagd"
-version = "0.2.0"
+version = "0.2.1"
 description = "OpenFeature provider for the flagd flag evaluation engine"
 readme = "README.md"
 authors = [{ name = "OpenFeature", email = "openfeature-core@groups.io" }]

{openfeature_provider_flagd-0.2.0 → openfeature_provider_flagd-0.2.1}/src/openfeature/contrib/provider/flagd/config.py

@@ -3,6 +3,8 @@ import os
 import typing
 from enum import Enum
 
+import grpc
+
 
 class ResolverType(Enum):
     RPC = "rpc"
@@ -45,9 +47,11 @@ ENV_VAR_RETRY_BACKOFF_MS = "FLAGD_RETRY_BACKOFF_MS"
 ENV_VAR_RETRY_BACKOFF_MAX_MS = "FLAGD_RETRY_BACKOFF_MAX_MS"
 ENV_VAR_RETRY_GRACE_PERIOD_SECONDS = "FLAGD_RETRY_GRACE_PERIOD"
 ENV_VAR_SELECTOR = "FLAGD_SOURCE_SELECTOR"
+ENV_VAR_PROVIDER_ID = "FLAGD_SOURCE_PROVIDER_ID"
 ENV_VAR_STREAM_DEADLINE_MS = "FLAGD_STREAM_DEADLINE_MS"
 ENV_VAR_TLS = "FLAGD_TLS"
 ENV_VAR_TLS_CERT = "FLAGD_SERVER_CERT_PATH"
+ENV_VAR_DEFAULT_AUTHORITY = "FLAGD_DEFAULT_AUTHORITY"
 
 T = typing.TypeVar("T")
 
@@ -81,6 +85,7 @@ class Config:
         port: typing.Optional[int] = None,
         tls: typing.Optional[bool] = None,
         selector: typing.Optional[str] = None,
+        provider_id: typing.Optional[str] = None,
         resolver: typing.Optional[ResolverType] = None,
         offline_flag_source_path: typing.Optional[str] = None,
         offline_poll_interval_ms: typing.Optional[int] = None,
@@ -93,6 +98,8 @@ class Config:
         cache: typing.Optional[CacheType] = None,
         max_cache_size: typing.Optional[int] = None,
         cert_path: typing.Optional[str] = None,
+        default_authority: typing.Optional[str] = None,
+        channel_credentials: typing.Optional[grpc.ChannelCredentials] = None,
     ):
         self.host = env_or_default(ENV_VAR_HOST, DEFAULT_HOST) if host is None else host
 
@@ -227,3 +234,17 @@ class Config:
         self.selector = (
             env_or_default(ENV_VAR_SELECTOR, None) if selector is None else selector
         )
+
+        self.provider_id = (
+            env_or_default(ENV_VAR_PROVIDER_ID, None)
+            if provider_id is None
+            else provider_id
+        )
+
+        self.default_authority = (
+            env_or_default(ENV_VAR_DEFAULT_AUTHORITY, None)
+            if default_authority is None
+            else default_authority
+        )
+
+        self.channel_credentials = channel_credentials

{openfeature_provider_flagd-0.2.0 → openfeature_provider_flagd-0.2.1}/src/openfeature/contrib/provider/flagd/provider.py

@@ -24,13 +24,18 @@
 import typing
 import warnings
 
+import grpc
+
 from openfeature.evaluation_context import EvaluationContext
+from openfeature.event import ProviderEventDetails
 from openfeature.flag_evaluation import FlagResolutionDetails
+from openfeature.hook import Hook
 from openfeature.provider import AbstractProvider
 from openfeature.provider.metadata import Metadata
 
 from .config import CacheType, Config, ResolverType
 from .resolvers import AbstractResolver, GrpcResolver, InProcessResolver
+from .sync_metadata_hook import SyncMetadataHook
 
 T = typing.TypeVar("T")
 
@@ -47,6 +52,7 @@ class FlagdProvider(AbstractProvider):
         timeout: typing.Optional[int] = None,
         retry_backoff_ms: typing.Optional[int] = None,
         selector: typing.Optional[str] = None,
+        provider_id: typing.Optional[str] = None,
         resolver_type: typing.Optional[ResolverType] = None,
         offline_flag_source_path: typing.Optional[str] = None,
         stream_deadline_ms: typing.Optional[int] = None,
@@ -56,6 +62,8 @@ class FlagdProvider(AbstractProvider):
         retry_backoff_max_ms: typing.Optional[int] = None,
         retry_grace_period: typing.Optional[int] = None,
         cert_path: typing.Optional[str] = None,
+        default_authority: typing.Optional[str] = None,
+        channel_credentials: typing.Optional[grpc.ChannelCredentials] = None,
     ):
         """
         Create an instance of the FlagdProvider
@@ -88,6 +96,7 @@ class FlagdProvider(AbstractProvider):
             retry_backoff_max_ms=retry_backoff_max_ms,
             retry_grace_period=retry_grace_period,
             selector=selector,
+            provider_id=provider_id,
             resolver=resolver_type,
             offline_flag_source_path=offline_flag_source_path,
             stream_deadline_ms=stream_deadline_ms,
@@ -95,9 +104,19 @@ class FlagdProvider(AbstractProvider):
             cache=cache,
             max_cache_size=max_cache_size,
             cert_path=cert_path,
+            default_authority=default_authority,
+            channel_credentials=channel_credentials,
         )
+        self.enriched_context: dict = {}
 
         self.resolver = self.setup_resolver()
+        self.hooks: list[Hook] = [SyncMetadataHook(self.get_enriched_context)]
+
+    def get_enriched_context(self) -> EvaluationContext:
+        return EvaluationContext(attributes=self.enriched_context)
+
+    def get_provider_hooks(self) -> list[Hook]:
+        return self.hooks
 
     def setup_resolver(self) -> AbstractResolver:
         if self.config.resolver == ResolverType.RPC:
@@ -114,7 +133,7 @@ class FlagdProvider(AbstractProvider):
         ):
             return InProcessResolver(
                 self.config,
-                self.emit_provider_ready,
+                self.emit_provider_ready_with_context,
                 self.emit_provider_error,
                 self.emit_provider_stale,
                 self.emit_provider_configuration_changed,
@@ -184,3 +203,10 @@ class FlagdProvider(AbstractProvider):
         return self.resolver.resolve_object_details(
             key, default_value, evaluation_context
         )
+
+    def emit_provider_ready_with_context(
+        self, details: ProviderEventDetails, context: dict
+    ) -> None:
+        self.enriched_context = context
+        self.emit_provider_ready(details)
+        pass

{openfeature_provider_flagd-0.2.0 → openfeature_provider_flagd-0.2.1}/src/openfeature/contrib/provider/flagd/resolvers/grpc.py

@@ -137,7 +137,10 @@ class GrpcResolver:
 
     def _state_change_callback(self, new_state: ChannelConnectivity) -> None:
         logger.debug(f"gRPC state change: {new_state}")
-        if new_state == ChannelConnectivity.READY:
+        if (
+            new_state == grpc.ChannelConnectivity.READY
+            or new_state == grpc.ChannelConnectivity.IDLE
+        ):
             if not self.thread or not self.thread.is_alive():
                 self.thread = threading.Thread(
                     target=self.listen,
@@ -276,7 +279,7 @@ class GrpcResolver:
             return cached_flag
 
         context = self._convert_context(evaluation_context)
-        call_args = {"timeout": self.deadline}
+        call_args = {"timeout": self.deadline, "wait_for_ready": True}
         try:
             request: Message
             if flag_type == FlagType.BOOLEAN:

{openfeature_provider_flagd-0.2.0 → openfeature_provider_flagd-0.2.1}/src/openfeature/contrib/provider/flagd/resolvers/in_process.py

@@ -21,7 +21,7 @@ class InProcessResolver:
     def __init__(
         self,
         config: Config,
-        emit_provider_ready: typing.Callable[[ProviderEventDetails], None],
+        emit_provider_ready: typing.Callable[[ProviderEventDetails, dict], None],
         emit_provider_error: typing.Callable[[ProviderEventDetails], None],
         emit_provider_stale: typing.Callable[[ProviderEventDetails], None],
         emit_provider_configuration_changed: typing.Callable[

{openfeature_provider_flagd-0.2.0 → openfeature_provider_flagd-0.2.1}/src/openfeature/contrib/provider/flagd/resolvers/process/connector/file_watcher.py

@@ -24,7 +24,7 @@ class FileWatcher(FlagStateConnector):
         self,
         config: Config,
         flag_store: FlagStore,
-        emit_provider_ready: typing.Callable[[ProviderEventDetails], None],
+        emit_provider_ready: typing.Callable[[ProviderEventDetails, dict], None],
         emit_provider_error: typing.Callable[[ProviderEventDetails], None],
     ):
         if config.offline_flag_source_path is None:
@@ -94,7 +94,8 @@ class FileWatcher(FlagStateConnector):
                 self.emit_provider_ready(
                     ProviderEventDetails(
                         message="Reloading file contents recovered from error state"
-                    )
+                    ),
+                    {},
                 )
                 self.should_emit_ready_on_success = False
 

{openfeature_provider_flagd-0.2.0 → openfeature_provider_flagd-0.2.1}/src/openfeature/contrib/provider/flagd/resolvers/process/connector/grpc_watcher.py

@@ -5,6 +5,7 @@ import time
 import typing
 
 import grpc
+from google.protobuf.json_format import MessageToDict
 
 from openfeature.evaluation_context import EvaluationContext
 from openfeature.event import ProviderEventDetails
@@ -26,7 +27,7 @@ class GrpcWatcher(FlagStateConnector):
         self,
         config: Config,
         flag_store: FlagStore,
-        emit_provider_ready: typing.Callable[[ProviderEventDetails], None],
+        emit_provider_ready: typing.Callable[[ProviderEventDetails, dict], None],
         emit_provider_error: typing.Callable[[ProviderEventDetails], None],
         emit_provider_stale: typing.Callable[[ProviderEventDetails], None],
     ):
@@ -41,6 +42,7 @@ class GrpcWatcher(FlagStateConnector):
         self.streamline_deadline_seconds = config.stream_deadline_ms * 0.001
         self.deadline = config.deadline_ms * 0.001
         self.selector = config.selector
+        self.provider_id = config.provider_id
         self.emit_provider_ready = emit_provider_ready
         self.emit_provider_error = emit_provider_error
         self.emit_provider_stale = emit_provider_stale
@@ -54,13 +56,23 @@ class GrpcWatcher(FlagStateConnector):
     def _generate_channel(self, config: Config) -> grpc.Channel:
         target = f"{config.host}:{config.port}"
         # Create the channel with the service config
-        options = [
+        options: list[tuple[str, typing.Any]] = [
             ("grpc.keepalive_time_ms", config.keep_alive_time),
             ("grpc.initial_reconnect_backoff_ms", config.retry_backoff_ms),
             ("grpc.max_reconnect_backoff_ms", config.retry_backoff_max_ms),
             ("grpc.min_reconnect_backoff_ms", config.stream_deadline_ms),
         ]
-        if config.tls:
+        if config.default_authority is not None:
+            options.append(("grpc.default_authority", config.default_authority))
+
+        if config.channel_credentials is not None:
+            channel_args = {
+                "options": options,
+                "credentials": config.channel_credentials,
+            }
+            channel = grpc.secure_channel(target, **channel_args)
+
+        elif config.tls:
             channel_args = {
                 "options": options,
                 "credentials": grpc.ssl_channel_credentials(),
@@ -106,7 +118,10 @@ class GrpcWatcher(FlagStateConnector):
 
     def _state_change_callback(self, new_state: grpc.ChannelConnectivity) -> None:
         logger.debug(f"gRPC state change: {new_state}")
-        if new_state == grpc.ChannelConnectivity.READY:
+        if (
+            new_state == grpc.ChannelConnectivity.READY
+            or new_state == grpc.ChannelConnectivity.IDLE
+        ):
             if not self.thread or not self.thread.is_alive():
                 self.thread = threading.Thread(
                     target=self.listen,
@@ -153,10 +168,20 @@ class GrpcWatcher(FlagStateConnector):
             if self.streamline_deadline_seconds > 0
             else {}
         )
-        request_args = {"selector": self.selector} if self.selector is not None else {}
+        request_args = {}
+        if self.selector is not None:
+            request_args["selector"] = self.selector
+        if self.provider_id is not None:
+            request_args["provider_id"] = self.provider_id
 
         while self.active:
             try:
+                context_values_request = sync_pb2.GetMetadataRequest()
+                context_values_response: sync_pb2.GetMetadataResponse = (
+                    self.stub.GetMetadata(context_values_request, wait_for_ready=True)
+                )
+                context_values = MessageToDict(context_values_response)
+
                 request = sync_pb2.SyncFlagsRequest(**request_args)
 
                 logger.debug("Setting up gRPC sync flags connection")
@@ -173,7 +198,8 @@ class GrpcWatcher(FlagStateConnector):
                         self.emit_provider_ready(
                             ProviderEventDetails(
                                 message="gRPC sync connection established"
-                            )
+                            ),
+                            context_values["metadata"],
                         )
                         self.connected = True
 

openfeature_provider_flagd-0.2.1/src/openfeature/contrib/provider/flagd/sync_metadata_hook.py

@@ -0,0 +1,14 @@
+import typing
+
+from openfeature.evaluation_context import EvaluationContext
+from openfeature.hook import Hook, HookContext, HookHints
+
+
+class SyncMetadataHook(Hook):
+    def __init__(self, context_supplier: typing.Callable[[], EvaluationContext]):
+        self.context_supplier = context_supplier
+
+    def before(
+        self, hook_context: HookContext, hints: HookHints
+    ) -> typing.Optional[EvaluationContext]:
+        return self.context_supplier()

{openfeature_provider_flagd-0.2.0 → openfeature_provider_flagd-0.2.1}/tests/e2e/file/conftest.py

@@ -12,6 +12,7 @@ feature_list = {
     "~sync",
     "~caching",
     "~grace",
+    "~contextEnrichment",
 }