feat: introduce list for fatal status codes

Signed-off-by: Konvalinka <lea.konvalinka@dynatrace.com>

Author: leakonvalinka

providers/openfeature-provider-flagd/src/openfeature/contrib/provider/flagd/provider.py

@@ -65,6 +65,7 @@ def __init__(  # noqa: PLR0913
         default_authority: typing.Optional[str] = None,
         channel_credentials: typing.Optional[grpc.ChannelCredentials] = None,
         sync_metadata_disabled: typing.Optional[bool] = None,
+        fatal_status_codes: typing.Optional[list[str]] = None,
     ):
         """
         Create an instance of the FlagdProvider
@@ -111,6 +112,7 @@ def __init__(  # noqa: PLR0913
             default_authority=default_authority,
             channel_credentials=channel_credentials,
             sync_metadata_disabled=sync_metadata_disabled,
+            fatal_status_codes=fatal_status_codes,
         )
         self.enriched_context: dict = {}
 

providers/openfeature-provider-flagd/src/openfeature/contrib/provider/flagd/resolvers/grpc.py

@@ -18,6 +18,7 @@
     GeneralError,
     InvalidContextError,
     ParseError,
+    ProviderFatalError,
     ProviderNotReadyError,
     TypeMismatchError,
 )
@@ -61,6 +62,7 @@ def __init__(
             if self.config.cache == CacheType.LRU
             else None
         )
+        logger.debug(self.config.fatal_status_codes)
 
         self.retry_grace_period = config.retry_grace_period
         self.streamline_deadline_seconds = config.stream_deadline_ms * 0.001
@@ -235,6 +237,8 @@ def listen(self) -> None:
             except grpc.RpcError as e:  # noqa: PERF203
                 # although it seems like this error log is not interesting, without it, the retry is not working as expected
                 logger.debug(f"SyncFlags stream error, {e.code()=} {e.details()=}")
+                if e.code().name in self.config.fatal_status_codes:
+                    raise ProviderFatalError("fatal error") from e
             except ParseError:
                 logger.exception(
                     f"Could not parse flag data using flagd syntax: {message=}"
@@ -399,8 +403,11 @@ def _resolve(  # noqa: PLR0915 C901
         except grpc.RpcError as e:
             code = e.code()
             message = f"received grpc status code {code}"
+            logger.debug(message)
 
-            if code == grpc.StatusCode.NOT_FOUND:
+            if code.name in self.config.fatal_status_codes:
+                raise ProviderFatalError(message) from e
+            elif code == grpc.StatusCode.NOT_FOUND:
                 raise FlagNotFoundError(message) from e
             elif code == grpc.StatusCode.INVALID_ARGUMENT:
                 raise TypeMismatchError(message) from e

providers/openfeature-provider-flagd/src/openfeature/contrib/provider/flagd/resolvers/process/connector/grpc_watcher.py

@@ -10,7 +10,12 @@
 
 from openfeature.evaluation_context import EvaluationContext
 from openfeature.event import ProviderEventDetails
-from openfeature.exception import ErrorCode, ParseError, ProviderNotReadyError
+from openfeature.exception import (
+    ErrorCode,
+    ParseError,
+    ProviderFatalError,
+    ProviderNotReadyError,
+)
 from openfeature.schemas.protobuf.flagd.sync.v1 import (
     sync_pb2,
     sync_pb2_grpc,
@@ -268,7 +273,8 @@ def listen(self) -> None:
                         logger.debug("Terminating gRPC sync thread")
                         return
             except grpc.RpcError as e:  # noqa: PERF203
-                logger.debug(f"SyncFlags stream error, {e.code()=} {e.details()=}")
+                logger.warning(f"SyncFlags stream error, {e.code()=} {e.details()=}")
+                self._raise_on_fatal_status_code(e)
             except json.JSONDecodeError:
                 logger.exception(
                     f"Could not parse JSON flag data from SyncFlags endpoint: {flag_str=}"
@@ -287,3 +293,8 @@ def generate_grpc_call_args(self) -> GrpcMultiCallableArgs:
         if metadata is not None:
             call_args["metadata"] = metadata
         return call_args
+
+    def _raise_on_fatal_status_code(self, e: grpc.RpcError) -> None:
+        if e.code().name in self.config.fatal_status_codes:
+            logger.error(f"Fatal gRPC status code received: {e.code()}")
+            raise ProviderFatalError(f"Fatal gRPC status code: {e.code()}") from e

providers/openfeature-provider-flagd/tests/e2e/flagd_container.py

@@ -12,6 +12,7 @@
 
 HEALTH_CHECK = 8014
 LAUNCHPAD = 8080
+FORBIDDEN = 9212
 
 
 class FlagdContainer(DockerContainer):
@@ -30,7 +31,7 @@ def __init__(
         self.ipr = 8015
         self.flagDir = Path("./flags")
         self.flagDir.mkdir(parents=True, exist_ok=True)
-        self.with_exposed_ports(self.rpc, self.ipr, HEALTH_CHECK, LAUNCHPAD)
+        self.with_exposed_ports(self.rpc, self.ipr, HEALTH_CHECK, LAUNCHPAD, FORBIDDEN)
         self.with_volume_mapping(os.path.abspath(self.flagDir.name), "/flags", "rw")
         self.waiting_for(LogMessageWaitStrategy("listening").with_startup_timeout(5))
 

providers/openfeature-provider-flagd/tests/e2e/inprocess/conftest.py

@@ -4,7 +4,7 @@
 from tests.e2e.testfilter import TestFilter
 
 resolver = ResolverType.IN_PROCESS
-feature_list = ["~targetURI", "~unixsocket", "~deprecated", "~forbidden"]
+feature_list = ["~targetURI", "~unixsocket", "~deprecated"]
 
 
 def pytest_collection_modifyitems(config, items):

providers/openfeature-provider-flagd/tests/e2e/rpc/conftest.py

@@ -10,7 +10,6 @@
     "~sync",
     "~metadata",
     "~deprecated",
-    "~forbidden",
 ]
 
 

providers/openfeature-provider-flagd/tests/e2e/step/config_steps.py

@@ -46,8 +46,8 @@ def option_values() -> dict:
 
 
 @given(
-    parsers.cfparse(
-        'an option "{option}" of type "{type_info}" with value "{value}"',
+    parsers.re(
+        r'an option "(?P<option>[^"]+)" of type "(?P<type_info>[^"]+)" with value "(?P<value>[^"]*)"',
     ),
 )
 def option_with_value(option: str, value: str, type_info: str, option_values: dict):
@@ -91,8 +91,8 @@ def initialize_config_for(resolver_type: str, option_values: dict):
 
 
 @then(
-    parsers.cfparse(
-        'the option "{option}" of type "{type_info}" should have the value "{value}"',
+    parsers.re(
+        r'the option "(?P<option>[^"]+)" of type "(?P<type_info>[^"]+)" should have the value "(?P<value>[^"]*)"',
     )
 )
 def check_option_value(option, value, type_info, config_or_error):

providers/openfeature-provider-flagd/tests/e2e/step/provider_steps.py

@@ -6,7 +6,8 @@
 
 import pytest
 import requests
-from pytest_bdd import given, parsers, when
+from asserts import assert_equal
+from pytest_bdd import given, parsers, then, when
 from tests.e2e.flagd_container import FlagdContainer
 from tests.e2e.step._utils import wait_for
 
@@ -58,6 +59,7 @@ def get_default_options_for_provider(
         "retry_grace_period": 3,
         "port": container.get_port(resolver_type),
     }
+    wait: bool = True
 
     if t == TestProviderType.UNAVAILABLE:
         return {}, False
@@ -70,11 +72,10 @@ def get_default_options_for_provider(
         options["tls"] = True
         launchpad = "ssl"
     elif t == TestProviderType.FORBIDDEN:
-        launchpad = "forbidden"
-        options["port"] = container.get_port(9212)
-        options["fatal_status_codes"] = ["FORBIDDEN"]
+        options["port"] = container.get_exposed_port(9212)
+        wait = False
     elif t == TestProviderType.SOCKET:
-        return options, True
+        return options, wait
     elif t == TestProviderType.METADATA:
         launchpad = "metadata"
     elif t == TestProviderType.SYNCPAYLOAD:
@@ -96,7 +97,7 @@ def get_default_options_for_provider(
         f"{container.get_launchpad_url()}/start?config={launchpad}", timeout=1
     )
     time.sleep(0.1)
-    return options, True
+    return options, wait
 
 
 @given(
@@ -144,6 +145,16 @@ def flagd_restart(
     pass
 
 
+@then(parsers.cfparse("the client should be in {status} state"))
+def client_state(status, client: OpenFeatureClient):
+    expected_status = ProviderStatus[status.upper()]
+    # wait_for(
+    #     lambda: client.get_provider_status() == expected_status,
+    #     timeout_sec=2,
+    # )
+    assert_equal(client.get_provider_status(), expected_status)
+
+
 @pytest.fixture(autouse=True, scope="package")
 def container(request):
     container = FlagdContainer()