openfeature-provider-flagd 0.1.3__py3-none-any.whl → 0.1.4__py3-none-any.whl

openfeature/contrib/provider/flagd/config.py

@@ -0,0 +1,35 @@
+import os
+import typing
+
+T = typing.TypeVar("T")
+
+
+def str_to_bool(val: str) -> bool:
+    return val.lower() == "true"
+
+
+def env_or_default(
+    env_var: str, default: T, cast: typing.Optional[typing.Callable[[str], T]] = None
+) -> typing.Union[str, T]:
+    val = os.environ.get(env_var)
+    if val is None:
+        return default
+    return val if cast is None else cast(val)
+
+
+class Config:
+    def __init__(
+        self,
+        host: typing.Optional[str] = None,
+        port: typing.Optional[int] = None,
+        tls: typing.Optional[bool] = None,
+        timeout: typing.Optional[int] = None,
+    ):
+        self.host = env_or_default("FLAGD_HOST", "localhost") if host is None else host
+        self.port = (
+            env_or_default("FLAGD_PORT", 8013, cast=int) if port is None else port
+        )
+        self.tls = (
+            env_or_default("FLAGD_TLS", False, cast=str_to_bool) if tls is None else tls
+        )
+        self.timeout = 5 if timeout is None else timeout

openfeature/contrib/provider/flagd/provider.py

@@ -22,7 +22,6 @@
 """
 
 import typing
-from numbers import Number
 
 import grpc
 from google.protobuf.struct_pb2 import Struct
@@ -35,137 +34,128 @@ from openfeature.exception import (
     ParseError,
     TypeMismatchError,
 )
-from openfeature.flag_evaluation import FlagEvaluationDetails
+from openfeature.flag_evaluation import FlagResolutionDetails
+from openfeature.provider.metadata import Metadata
 from openfeature.provider.provider import AbstractProvider
 
-from .defaults import Defaults
+from .config import Config
 from .flag_type import FlagType
 from .proto.schema.v1 import schema_pb2, schema_pb2_grpc
 
+T = typing.TypeVar("T")
+
 
 class FlagdProvider(AbstractProvider):
     """Flagd OpenFeature Provider"""
 
     def __init__(
         self,
-        name: str = "flagd",
-        schema: str = Defaults.SCHEMA,
-        host: str = Defaults.HOST,
-        port: int = Defaults.PORT,
-        timeout: int = Defaults.TIMEOUT,
+        host: typing.Optional[str] = None,
+        port: typing.Optional[int] = None,
+        tls: typing.Optional[bool] = None,
+        timeout: typing.Optional[int] = None,
     ):
         """
         Create an instance of the FlagdProvider
 
-        :param name: the name of the provider to be stored in metadata
-        :param schema: the schema for the transport protocol, e.g. 'http', 'https'
         :param host: the host to make requests to
         :param port: the port the flagd service is available on
+        :param tls: enable/disable secure TLS connectivity
         :param timeout: the maximum to wait before a request times out
         """
-        self.provider_name = name
-        self.schema = schema
-        self.host = host
-        self.port = port
-        self.timeout = timeout
-
-        channel_factory = (
-            grpc.insecure_channel if schema == "http" else grpc.secure_channel
+        self.config = Config(
+            host=host,
+            port=port,
+            tls=tls,
+            timeout=timeout,
         )
-        self.channel = channel_factory(f"{self.host}:{self.port}")
+
+        channel_factory = grpc.secure_channel if tls else grpc.insecure_channel
+        self.channel = channel_factory(f"{self.config.host}:{self.config.port}")
         self.stub = schema_pb2_grpc.ServiceStub(self.channel)
 
-    def shutdown(self):
+    def shutdown(self) -> None:
         self.channel.close()
 
-    def get_metadata(self):
+    def get_metadata(self) -> Metadata:
         """Returns provider metadata"""
-        return {
-            "name": self.get_name(),
-            "schema": self.schema,
-            "host": self.host,
-            "port": self.port,
-            "timeout": self.timeout,
-        }
-
-    def get_name(self) -> str:
-        """Returns provider name"""
-        return self.provider_name
+        return Metadata(name="FlagdProvider")
 
     def resolve_boolean_details(
         self,
         key: str,
         default_value: bool,
-        evaluation_context: EvaluationContext = None,
-    ):
+        evaluation_context: typing.Optional[EvaluationContext] = None,
+    ) -> FlagResolutionDetails[bool]:
         return self._resolve(key, FlagType.BOOLEAN, default_value, evaluation_context)
 
     def resolve_string_details(
         self,
         key: str,
         default_value: str,
-        evaluation_context: EvaluationContext = None,
-    ):
+        evaluation_context: typing.Optional[EvaluationContext] = None,
+    ) -> FlagResolutionDetails[str]:
         return self._resolve(key, FlagType.STRING, default_value, evaluation_context)
 
     def resolve_float_details(
         self,
         key: str,
-        default_value: Number,
-        evaluation_context: EvaluationContext = None,
-    ):
+        default_value: float,
+        evaluation_context: typing.Optional[EvaluationContext] = None,
+    ) -> FlagResolutionDetails[float]:
         return self._resolve(key, FlagType.FLOAT, default_value, evaluation_context)
 
     def resolve_integer_details(
         self,
         key: str,
-        default_value: Number,
-        evaluation_context: EvaluationContext = None,
-    ):
+        default_value: int,
+        evaluation_context: typing.Optional[EvaluationContext] = None,
+    ) -> FlagResolutionDetails[int]:
         return self._resolve(key, FlagType.INTEGER, default_value, evaluation_context)
 
     def resolve_object_details(
         self,
         key: str,
         default_value: typing.Union[dict, list],
-        evaluation_context: EvaluationContext = None,
-    ):
+        evaluation_context: typing.Optional[EvaluationContext] = None,
+    ) -> FlagResolutionDetails[typing.Union[dict, list]]:
         return self._resolve(key, FlagType.OBJECT, default_value, evaluation_context)
 
     def _resolve(
         self,
         flag_key: str,
         flag_type: FlagType,
-        default_value: typing.Any,
-        evaluation_context: EvaluationContext,
-    ):
+        default_value: T,
+        evaluation_context: typing.Optional[EvaluationContext],
+    ) -> FlagResolutionDetails[T]:
         context = self._convert_context(evaluation_context)
+        call_args = {"timeout": self.config.timeout}
         try:
             if flag_type == FlagType.BOOLEAN:
-                request = schema_pb2.ResolveBooleanRequest(
+                request = schema_pb2.ResolveBooleanRequest(  # type:ignore[attr-defined]
                     flag_key=flag_key, context=context
                 )
-                response = self.stub.ResolveBoolean(request)
+                response = self.stub.ResolveBoolean(request, **call_args)
             elif flag_type == FlagType.STRING:
-                request = schema_pb2.ResolveStringRequest(
+                request = schema_pb2.ResolveStringRequest(  # type:ignore[attr-defined]
                     flag_key=flag_key, context=context
                 )
-                response = self.stub.ResolveString(request)
+                response = self.stub.ResolveString(request, **call_args)
             elif flag_type == FlagType.OBJECT:
-                request = schema_pb2.ResolveObjectRequest(
+                request = schema_pb2.ResolveObjectRequest(  # type:ignore[attr-defined]
                     flag_key=flag_key, context=context
                 )
-                response = self.stub.ResolveObject(request)
+                response = self.stub.ResolveObject(request, **call_args)
             elif flag_type == FlagType.FLOAT:
-                request = schema_pb2.ResolveFloatRequest(
+                request = schema_pb2.ResolveFloatRequest(  # type:ignore[attr-defined]
                     flag_key=flag_key, context=context
                 )
-                response = self.stub.ResolveFloat(request)
+                response = self.stub.ResolveFloat(request, **call_args)
             elif flag_type == FlagType.INTEGER:
-                request = schema_pb2.ResolveIntRequest(
+                request = schema_pb2.ResolveIntRequest(  # type:ignore[attr-defined]
                     flag_key=flag_key, context=context
                 )
-                response = self.stub.ResolveInt(request)
+                response = self.stub.ResolveInt(request, **call_args)
             else:
                 raise ValueError(f"Unknown flag type: {flag_type}")
 
@@ -182,17 +172,19 @@ class FlagdProvider(AbstractProvider):
             raise GeneralError(message) from e
 
         # Got a valid flag and valid type. Return it.
-        return FlagEvaluationDetails(
-            flag_key=flag_key,
+        return FlagResolutionDetails(
             value=response.value,
             reason=response.reason,
             variant=response.variant,
         )
 
-    def _convert_context(self, evaluation_context: EvaluationContext):
+    def _convert_context(
+        self, evaluation_context: typing.Optional[EvaluationContext]
+    ) -> Struct:
         s = Struct()
         if evaluation_context:
             try:
+                s["targetingKey"] = evaluation_context.targeting_key
                 s.update(evaluation_context.attributes)
             except ValueError as exc:
                 message = (

{openfeature_provider_flagd-0.1.3.dist-info → openfeature_provider_flagd-0.1.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: openfeature-provider-flagd
-Version: 0.1.3
+Version: 0.1.4
 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.1.3.dist-info → openfeature_provider_flagd-0.1.4.dist-info}/RECORD

@@ -1,7 +1,7 @@
 openfeature/contrib/provider/flagd/__init__.py,sha256=WlrcPaCH31dEG1IvrvpeuhAaQ8Ni8LEzDpNM_x-qKOA,65
-openfeature/contrib/provider/flagd/defaults.py,sha256=OeTt08wp_GUzpUetEJQvhSBGk9u4gTzACILQVqicbUw,102
+openfeature/contrib/provider/flagd/config.py,sha256=8Oguwoe4V6FffdNNBfhWev2G8UjKsNYCuc_j3SGEb0Y,987
 openfeature/contrib/provider/flagd/flag_type.py,sha256=rZYfmqQEmtqVVTb8e-d8Wt8ZCnHtf7xPSmYxyU8w0R0,158
-openfeature/contrib/provider/flagd/provider.py,sha256=2CZxQNJfcP8S5UJgDfwp6Q-znHRRaBpP7W7sGNS5lqk,6779
+openfeature/contrib/provider/flagd/provider.py,sha256=0hXxolWFUVue-6OgrC1kXa64B-bbmvc6ZtqAyexDHIc,7093
 openfeature/contrib/provider/flagd/proto/flagd/evaluation/v1/evaluation_pb2.py,sha256=W0Vgg8z7nEg_HTlAJkO6pu5nBcR8Ls3yoIykboavLRI,7704
 openfeature/contrib/provider/flagd/proto/flagd/evaluation/v1/evaluation_pb2_grpc.py,sha256=GTKQXbUfRrquUG5o11N7ymhFnOuzh9_hcToZ9-cjOtA,13339
 openfeature/contrib/provider/flagd/proto/flagd/sync/v1/sync_pb2.py,sha256=zUu_-V6DhHH5ZekWVsxKjGkUwkJrRrhqyXj8oX-Jo_g,3205
@@ -10,7 +10,7 @@ openfeature/contrib/provider/flagd/proto/schema/v1/schema_pb2.py,sha256=onIastnV
 openfeature/contrib/provider/flagd/proto/schema/v1/schema_pb2_grpc.py,sha256=nllthJYfwhDBZHH_eGfSHesNbO6rJEZ0vXKyTFFy4AA,12393
 openfeature/contrib/provider/flagd/proto/sync/v1/sync_service_pb2.py,sha256=uKBjB_lpfHN3r8wsjmqnQEBLtN9gw8zPmvWfWKsOYAE,2954
 openfeature/contrib/provider/flagd/proto/sync/v1/sync_service_pb2_grpc.py,sha256=v5MSyyIOpE68EYWjsbdAq677gnD4jdNeLhMAB7EveNQ,4424
-openfeature_provider_flagd-0.1.3.dist-info/METADATA,sha256=HCF4wFfmAKKkyOoHg_I3-1IHvAtbvnWhYkSbZUI1PRo,14518
-openfeature_provider_flagd-0.1.3.dist-info/WHEEL,sha256=TJPnKdtrSue7xZ_AVGkp9YXcvDrobsjBds1du3Nx6dc,87
-openfeature_provider_flagd-0.1.3.dist-info/licenses/LICENSE,sha256=h8jwqxShIeVkc8vOo9ynxGYW16f4fVPxLhZKZs0H5U8,11350
-openfeature_provider_flagd-0.1.3.dist-info/RECORD,,
+openfeature_provider_flagd-0.1.4.dist-info/METADATA,sha256=wtW6iavradbR6Y1d66M-SFcsMv8zjwQ5ylY4udCd8fs,14518
+openfeature_provider_flagd-0.1.4.dist-info/WHEEL,sha256=uNdcs2TADwSd5pVaP0Z_kcjcvvTUklh2S7bxZMF8Uj0,87
+openfeature_provider_flagd-0.1.4.dist-info/licenses/LICENSE,sha256=h8jwqxShIeVkc8vOo9ynxGYW16f4fVPxLhZKZs0H5U8,11350
+openfeature_provider_flagd-0.1.4.dist-info/RECORD,,

{openfeature_provider_flagd-0.1.3.dist-info → openfeature_provider_flagd-0.1.4.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.21.1
+Generator: hatchling 1.22.4
 Root-Is-Purelib: true
 Tag: py3-none-any

openfeature/contrib/provider/flagd/defaults.py

@@ -1,5 +0,0 @@
-class Defaults:
-    HOST = "localhost"
-    PORT = 8013
-    SCHEMA = "http"
-    TIMEOUT = 2  # seconds