openfeature-provider-flagd 0.1.3__tar.gz → 0.1.4__tar.gz

openfeature_provider_flagd-0.1.4/CHANGELOG.md

@@ -0,0 +1,53 @@
+# Changelog
+
+## [0.1.4](https://github.com/open-feature/python-sdk-contrib/compare/openfeature-provider-flagd/v0.1.3...openfeature-provider-flagd/v0.1.4) (2024-03-26)
+
+
+### 🐛 Bug Fixes
+
+* include targetingKey in flagd serialized evaluation context ([#58](https://github.com/open-feature/python-sdk-contrib/issues/58)) ([ddd79a4](https://github.com/open-feature/python-sdk-contrib/commit/ddd79a49b765aa0679a2c1938447c61b37b6d0fe))
+* respect timeout setting in grpc method calls ([#60](https://github.com/open-feature/python-sdk-contrib/issues/60)) ([0149cf7](https://github.com/open-feature/python-sdk-contrib/commit/0149cf7ced8116f54a9b220549834a1970460bd9))
+* return proper metadata object in FlagdProvider ([#59](https://github.com/open-feature/python-sdk-contrib/issues/59)) ([6508234](https://github.com/open-feature/python-sdk-contrib/commit/6508234486ba0b650e849cbee22505988233131a))
+
+
+### ✨ New Features
+
+* implement environment-variable based config ([#62](https://github.com/open-feature/python-sdk-contrib/issues/62)) ([a8b78b2](https://github.com/open-feature/python-sdk-contrib/commit/a8b78b28fe44ca712b00db04ac1a23a9c9bc6d9b))
+* replace schema with tls argument in FlagdProvider constructor ([#61](https://github.com/open-feature/python-sdk-contrib/issues/61)) ([7a7210f](https://github.com/open-feature/python-sdk-contrib/commit/7a7210f6f63a9cba886f4d512c01ebac39d910a9))
+
+
+### 🧹 Chore
+
+* exclude generated protobuf files from coverage report ([#51](https://github.com/open-feature/python-sdk-contrib/issues/51)) ([660a0cb](https://github.com/open-feature/python-sdk-contrib/commit/660a0cbc9bb932ac0dd9cb09f1d75177b161601b))
+
+
+### 🔄 Refactoring
+
+* add mypy and fix typing issues ([#72](https://github.com/open-feature/python-sdk-contrib/issues/72)) ([b405925](https://github.com/open-feature/python-sdk-contrib/commit/b4059255045cdb7054a35bc338207e23c42ce068))
+
+## [0.1.3](https://github.com/open-feature/python-sdk-contrib/compare/openfeature-provider-flagd/v0.1.2...openfeature-provider-flagd/v0.1.3) (2024-02-23)
+
+
+### 🐛 Bug Fixes
+
+* include proto file in build for openfeature-provider-flagd ([#45](https://github.com/open-feature/python-sdk-contrib/issues/45)) ([7783cc8](https://github.com/open-feature/python-sdk-contrib/commit/7783cc8e7fb8fe0f9b812938efcd1f4c07e3ff68))
+
+## [0.1.2](https://github.com/open-feature/python-sdk-contrib/compare/openfeature-provider-flagd-v0.1.1...openfeature-provider-flagd/v0.1.2) (2024-02-22)
+
+
+### 🐛 Bug Fixes
+
+* remove mention of local eval in readme ([41df80e](https://github.com/open-feature/python-sdk-contrib/commit/41df80e1b3044356e3b228a484f3a13c92068d91))
+* remove setup from flagd tests ([#39](https://github.com/open-feature/python-sdk-contrib/issues/39)) ([85661ff](https://github.com/open-feature/python-sdk-contrib/commit/85661ff170b378d37b0a3d5d0a955dad3417f538))
+
+
+### 🧹 Chore
+
+* **main:** release providers/flagd 0.1.1 ([#40](https://github.com/open-feature/python-sdk-contrib/issues/40)) ([d42ee1e](https://github.com/open-feature/python-sdk-contrib/commit/d42ee1e531249e0023456dbe46db2f4f0c52a5c5))
+
+## [0.1.1](https://github.com/open-feature/python-sdk-contrib/compare/providers/flagd-v0.1.0...providers/flagd/v0.1.1) (2024-02-22)
+
+
+### 🐛 Bug Fixes
+
+* remove setup from flagd tests ([#39](https://github.com/open-feature/python-sdk-contrib/issues/39)) ([85661ff](https://github.com/open-feature/python-sdk-contrib/commit/85661ff170b378d37b0a3d5d0a955dad3417f538))

{openfeature_provider_flagd-0.1.3 → openfeature_provider_flagd-0.1.4}/PKG-INFO

@@ -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 → openfeature_provider_flagd-0.1.4}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "openfeature-provider-flagd"
-version = "0.1.3"
+version = "0.1.4"
 description = "OpenFeature provider for the flagd flag evaluation engine"
 readme = "README.md"
 authors = [{ name = "OpenFeature", email = "openfeature-core@groups.io" }]
@@ -56,3 +56,9 @@ exclude = [
 
 [tool.hatch.build.targets.wheel]
 packages = ["src/openfeature"]
+
+[tool.coverage.run]
+omit = [
+  # exclude generated files
+  "src/openfeature/contrib/provider/flagd/proto/*",
+]

openfeature_provider_flagd-0.1.4/src/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_provider_flagd-0.1.3 → openfeature_provider_flagd-0.1.4}/src/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.4/tests/test_config.py

@@ -0,0 +1,29 @@
+from openfeature.contrib.provider.flagd.config import Config
+
+
+def test_return_default_values():
+    config = Config()
+    assert config.host == "localhost"
+    assert config.port == 8013
+    assert config.tls is False
+    assert config.timeout == 5
+
+
+def test_overrides_defaults_with_environment(monkeypatch):
+    monkeypatch.setenv("FLAGD_HOST", "flagd")
+    monkeypatch.setenv("FLAGD_PORT", "1234")
+    monkeypatch.setenv("FLAGD_TLS", "true")
+
+    config = Config()
+    assert config.host == "flagd"
+    assert config.port == 1234
+    assert config.tls is True
+
+
+def test_uses_arguments_over_environments_and_defaults(monkeypatch):
+    monkeypatch.setenv("FLAGD_HOST", "flagd")
+
+    config = Config(host="flagd2", port=12345, tls=True)
+    assert config.host == "flagd2"
+    assert config.port == 12345
+    assert config.tls is True

{openfeature_provider_flagd-0.1.3 → openfeature_provider_flagd-0.1.4}/tests/test_flagd.py

@@ -1,5 +1,7 @@
 from numbers import Number
 
+from openfeature.contrib.provider.flagd import FlagdProvider
+
 
 def test_should_get_boolean_flag_from_flagd(flagd_provider_client):
     # Given
@@ -69,3 +71,9 @@ def test_should_get_object_flag_from_flagd(flagd_provider_client):
     assert flag is not None
     assert flag.value == return_value
     assert isinstance(flag.value, dict)
+
+
+def test_get_metadata_returns_metadata_object_with_name():
+    provider = FlagdProvider()
+    metadata = provider.get_metadata()
+    assert metadata.name == "FlagdProvider"

openfeature_provider_flagd-0.1.3/CHANGELOG.md

@@ -1,28 +0,0 @@
-# Changelog
-
-## [0.1.3](https://github.com/open-feature/python-sdk-contrib/compare/openfeature-provider-flagd/v0.1.2...openfeature-provider-flagd/v0.1.3) (2024-02-23)
-
-
-### 🐛 Bug Fixes
-
-* include proto file in build for openfeature-provider-flagd ([#45](https://github.com/open-feature/python-sdk-contrib/issues/45)) ([7783cc8](https://github.com/open-feature/python-sdk-contrib/commit/7783cc8e7fb8fe0f9b812938efcd1f4c07e3ff68))
-
-## [0.1.2](https://github.com/open-feature/python-sdk-contrib/compare/openfeature-provider-flagd-v0.1.1...openfeature-provider-flagd/v0.1.2) (2024-02-22)
-
-
-### 🐛 Bug Fixes
-
-* remove mention of local eval in readme ([41df80e](https://github.com/open-feature/python-sdk-contrib/commit/41df80e1b3044356e3b228a484f3a13c92068d91))
-* remove setup from flagd tests ([#39](https://github.com/open-feature/python-sdk-contrib/issues/39)) ([85661ff](https://github.com/open-feature/python-sdk-contrib/commit/85661ff170b378d37b0a3d5d0a955dad3417f538))
-
-
-### 🧹 Chore
-
-* **main:** release providers/flagd 0.1.1 ([#40](https://github.com/open-feature/python-sdk-contrib/issues/40)) ([d42ee1e](https://github.com/open-feature/python-sdk-contrib/commit/d42ee1e531249e0023456dbe46db2f4f0c52a5c5))
-
-## [0.1.1](https://github.com/open-feature/python-sdk-contrib/compare/providers/flagd-v0.1.0...providers/flagd/v0.1.1) (2024-02-22)
-
-
-### 🐛 Bug Fixes
-
-* remove setup from flagd tests ([#39](https://github.com/open-feature/python-sdk-contrib/issues/39)) ([85661ff](https://github.com/open-feature/python-sdk-contrib/commit/85661ff170b378d37b0a3d5d0a955dad3417f538))

openfeature_provider_flagd-0.1.3/src/openfeature/contrib/provider/flagd/defaults.py

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