Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion providers/openfeature-provider-flagd/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ keywords = []
dependencies = [
"openfeature-sdk>=0.8.2",
"openfeature-flagd-core>=1.0.0,<2",
"grpcio>=1.80.0",
"grpcio>=1.81.0",
"protobuf>=6.30.0,<7.0.0",
"pyyaml>=6.0.1",
"cachebox>=5.1.0,<6.0.0",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@
from ..flag_type import FlagType
from .types import GrpcMultiCallableArgs

FLAGD_SELECTOR_HEADER = "flagd-selector"

if typing.TYPE_CHECKING:
from google.protobuf.message import Message

Expand Down Expand Up @@ -71,6 +73,9 @@ def __init__(
self._is_fatal = False
self.channel = self._generate_channel(config)
self.stub = evaluation_pb2_grpc.ServiceStub(self.channel)
self.selector_metadata: tuple[tuple[str, str], ...] | None = (
((FLAGD_SELECTOR_HEADER, config.selector),) if config.selector else None
)
Comment thread
toddbaert marked this conversation as resolved.

self.thread: threading.Thread | None = None
self.timer: threading.Timer | None = None
Expand Down Expand Up @@ -215,11 +220,17 @@ def emit_error(self) -> None:
)
)

def listen(self) -> None:
logger.debug("gRPC starting listener thread")
def _stream_call_args(self) -> GrpcMultiCallableArgs:
call_args: GrpcMultiCallableArgs = {"wait_for_ready": True}
if self.streamline_deadline_seconds > 0:
call_args["timeout"] = self.streamline_deadline_seconds
if self.selector_metadata is not None:
call_args["metadata"] = self.selector_metadata
return call_args

def listen(self) -> None:
logger.debug("gRPC starting listener thread")
call_args = self._stream_call_args()
request = evaluation_pb2.EventStreamRequest()

# defining a never ending loop to recreate the stream
Expand Down Expand Up @@ -377,6 +388,8 @@ def _resolve( # noqa: PLR0915 C901
"timeout": self.deadline,
"wait_for_ready": True,
}
if self.selector_metadata is not None:
call_args["metadata"] = self.selector_metadata
try:
request: Message
if flag_type == FlagType.BOOLEAN:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@
class GrpcMultiCallableArgs(typing.TypedDict, total=False):
timeout: float | None
wait_for_ready: bool | None
metadata: tuple[tuple[str, str]] | None
metadata: tuple[tuple[str, str], ...] | None
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
from contextlib import suppress
from unittest.mock import MagicMock, Mock

from openfeature.contrib.provider.flagd.config import Config
from openfeature.contrib.provider.flagd.flag_type import FlagType
from openfeature.contrib.provider.flagd.resolvers.grpc import (
FLAGD_SELECTOR_HEADER,
GrpcResolver,
)
from openfeature.schemas.protobuf.flagd.evaluation.v2 import evaluation_pb2
Comment thread
toddbaert marked this conversation as resolved.


def _make_resolver(selector):
config = Config(host="localhost", port=8013, tls=False)
config.selector = selector
resolver = GrpcResolver(
config=config,
emit_provider_ready=Mock(),
emit_provider_error=Mock(),
emit_provider_stale=Mock(),
emit_provider_configuration_changed=Mock(),
)
return resolver


def test_unary_call_includes_selector_metadata_when_configured():
resolver = _make_resolver("test-selector")
mock_stub = MagicMock()
mock_stub.ResolveBoolean = Mock(
return_value=evaluation_pb2.ResolveBooleanResponse(value=True, reason="STATIC")
)
resolver.stub = mock_stub

resolver._resolve("flag", FlagType.BOOLEAN, False, None)

kwargs = mock_stub.ResolveBoolean.call_args.kwargs
assert kwargs.get("metadata") == ((FLAGD_SELECTOR_HEADER, "test-selector"),)


def test_unary_call_omits_metadata_when_no_selector():
resolver = _make_resolver(None)
mock_stub = MagicMock()
mock_stub.ResolveBoolean = Mock(
return_value=evaluation_pb2.ResolveBooleanResponse(value=True, reason="STATIC")
)
resolver.stub = mock_stub

resolver._resolve("flag", FlagType.BOOLEAN, False, None)

kwargs = mock_stub.ResolveBoolean.call_args.kwargs
assert "metadata" not in kwargs
Comment thread
toddbaert marked this conversation as resolved.


def test_event_stream_includes_selector_metadata_when_configured():
resolver = _make_resolver("test-selector")
mock_stub = MagicMock()
mock_stub.EventStream = Mock(side_effect=Exception("break loop"))
resolver.stub = mock_stub
resolver.active = True

with suppress(Exception):
resolver.listen()

kwargs = mock_stub.EventStream.call_args.kwargs
assert kwargs.get("metadata") == ((FLAGD_SELECTOR_HEADER, "test-selector"),)


def test_event_stream_omits_metadata_when_no_selector():
resolver = _make_resolver(None)
mock_stub = MagicMock()
mock_stub.EventStream = Mock(side_effect=Exception("break loop"))
resolver.stub = mock_stub
resolver.active = True

with suppress(Exception):
resolver.listen()

kwargs = mock_stub.EventStream.call_args.kwargs
assert "metadata" not in kwargs
Loading
Loading