add support for metadata in flagd

Signed-off-by: christian.lutnik <[email protected]>

Author: chrfwow

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

@@ -17,6 +17,22 @@
 T = typing.TypeVar("T")
 
 
+def _merge_metadata(
+    flag_metadata: typing.Mapping[str, typing.Union[float, int, str, bool]],
+    flag_set_metadata: typing.Mapping[str, typing.Union[float, int, str, bool]]
+) -> typing.Mapping[str, typing.Union[float, int, str, bool]]:
+    metadata = {}
+    if flag_set_metadata is not None:
+        for key, value in flag_set_metadata.items():
+            metadata[key] = value
+
+    if flag_metadata is not None:
+        for key, value in flag_metadata.items():
+            metadata[key] = value
+
+    return metadata
+
+
 class InProcessResolver:
     def __init__(
         self,
@@ -103,18 +119,20 @@ def _resolve(
         if not flag:
             raise FlagNotFoundError(f"Flag with key {key} not present in flag store.")
 
+        metadata = _merge_metadata(flag.metadata, self.flag_store.flag_set_metadata)
+
         if flag.state == "DISABLED":
-            return FlagResolutionDetails(default_value, reason=Reason.DISABLED)
+            return FlagResolutionDetails(default_value, flag_metadata=metadata, reason=Reason.DISABLED)
 
         if not flag.targeting:
             variant, value = flag.default
-            return FlagResolutionDetails(value, variant=variant, reason=Reason.STATIC)
+            return FlagResolutionDetails(value, variant=variant, flag_metadata=metadata, reason=Reason.STATIC)
 
         variant = targeting(flag.key, flag.targeting, evaluation_context)
 
         if variant is None:
             variant, value = flag.default
-            return FlagResolutionDetails(value, variant=variant, reason=Reason.DEFAULT)
+            return FlagResolutionDetails(value, variant=variant, flag_metadata=metadata, reason=Reason.DEFAULT)
         if not isinstance(variant, (str, bool)):
             raise ParseError(
                 "Parsed JSONLogic targeting did not return a string or bool"
@@ -128,4 +146,5 @@ def _resolve(
             value,
             variant=variant,
             reason=Reason.TARGETING_MATCH,
+            flag_metadata=metadata
         )

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

@@ -14,7 +14,7 @@
 from openfeature.contrib.provider.flagd.resolvers.process.flags import FlagStore
 from openfeature.evaluation_context import EvaluationContext
 from openfeature.event import ProviderEventDetails
-from openfeature.exception import ParseError, ProviderNotReadyError
+from openfeature.exception import ParseError, ProviderNotReadyError, ErrorCode
 
 logger = logging.getLogger("openfeature.contrib")
 
@@ -76,8 +76,9 @@ def safe_load_data(self) -> None:
             self.handle_error("Could not parse JSON flag data from file")
         except yaml.error.YAMLError:
             self.handle_error("Could not parse YAML flag data from file")
-        except ParseError:
-            self.handle_error("Could not parse flag data using flagd syntax")
+        except ParseError as e:
+            self.handle_error("Could not parse flag data using flagd syntax: " + (
+                "no error message provided" if e is None or e.error_message is None else e.error_message))
         except Exception:
             self.handle_error("Could not read flags from file")
 
@@ -104,4 +105,4 @@ def _load_data(self, modified_time: typing.Optional[float] = None) -> None:
     def handle_error(self, error_message: str) -> None:
         logger.exception(error_message)
         self.should_emit_ready_on_success = True
-        self.emit_provider_error(ProviderEventDetails(message=error_message))
+        self.emit_provider_error(ProviderEventDetails(message=error_message, error_code=ErrorCode.PARSE_ERROR))

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

@@ -7,6 +7,19 @@
 from openfeature.exception import ParseError
 
 
+def _validate_metadata(key, value):
+    if key is None:
+        raise ParseError("Metadata key must be set")
+    elif not isinstance(key, str):
+        raise ParseError("Metadata key " + str(key) + " must be of type str, but is " + str(type(key)))
+    if value is None:
+        raise ParseError("Metadata value for key " + str(key) + " must be set")
+    elif not isinstance(value, typing.Union[float, int, str, bool]):
+        raise ParseError("Metadata value " + str(value) +
+                         " for key " + str(key) +
+                         " must be of type float, int, str or bool, but is " + str(type(value)))
+
+
 class FlagStore:
     def __init__(
         self,
@@ -16,12 +29,14 @@ def __init__(
     ):
         self.emit_provider_configuration_changed = emit_provider_configuration_changed
         self.flags: typing.Mapping[str, Flag] = {}
+        self.flag_set_metadata: typing.Mapping[str, typing.Union[float, int, str, bool]] = {}
 
     def get_flag(self, key: str) -> typing.Optional["Flag"]:
         return self.flags.get(key)
 
     def update(self, flags_data: dict) -> None:
         flags = flags_data.get("flags", {})
+        metadata = flags_data.get("metadata", {})
         evaluators: typing.Optional[dict] = flags_data.get("$evaluators")
         if evaluators:
             transposed = json.dumps(flags)
@@ -33,10 +48,16 @@ def update(self, flags_data: dict) -> None:
 
         if not isinstance(flags, dict):
             raise ParseError("`flags` key of configuration must be a dictionary")
+        if not isinstance(metadata, dict):
+            raise ParseError("`metadata` key of configuration must be a dictionary")
+        for key, value in metadata.items():
+            _validate_metadata(key, value)
+
         self.flags = {key: Flag.from_dict(key, data) for key, data in flags.items()}
+        self.flag_set_metadata = metadata
 
         self.emit_provider_configuration_changed(
-            ProviderEventDetails(flags_changed=list(self.flags.keys()))
+            ProviderEventDetails(flags_changed=list(self.flags.keys()), metadata=metadata)
         )
 
 
@@ -47,6 +68,7 @@ class Flag:
     variants: typing.Mapping[str, typing.Any]
     default_variant: typing.Union[bool, str]
     targeting: typing.Optional[dict] = None
+    metadata: typing.Optional[typing.Mapping[str, typing.Union[float, int, str, bool]]] = None
 
     def __post_init__(self) -> None:
         if not self.state or not isinstance(self.state, str):
@@ -66,6 +88,13 @@ def __post_init__(self) -> None:
         if self.default_variant not in self.variants:
             raise ParseError("Default variant does not match set of variants")
 
+        if self.metadata:
+            if not isinstance(self.metadata, dict):
+                raise ParseError("Flag metadata is not a valid json object")
+            for key, value in self.metadata.items():
+                _validate_metadata(key, value)
+
+
     @classmethod
     def from_dict(cls, key: str, data: dict) -> "Flag":
         if "defaultVariant" in data:
@@ -79,6 +108,8 @@ def from_dict(cls, key: str, data: dict) -> "Flag":
         try:
             flag = cls(key=key, **data)
             return flag
+        except ParseError as parseError:
+            raise parseError
         except Exception as err:
             raise ParseError from err
 

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

@@ -94,3 +94,18 @@ def resolve_details_reason(
     reason: str,
 ):
     assert_equal(details.reason, Reason(reason))
+
+
+@then(
+    parsers.cfparse("the resolved metadata should contain")
+)
+def step_impl(details: FlagEvaluationDetails[JsonPrimitive], datatable):
+    assert_equal(len(details.flag_metadata), len(datatable) - 1) # skip table header
+    for i in range(1, len(datatable)):
+        key, metadata_type, expected = datatable[i]
+        assert_equal(details.flag_metadata[key], type_cast[metadata_type](expected))
+
+
+@then("the resolved metadata is empty")
+def step_impl(details: FlagEvaluationDetails[JsonPrimitive]):
+    assert_equal(len(details.flag_metadata), 0)

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

@@ -41,7 +41,7 @@ def setup_provider_old(
 
 
 def get_default_options_for_provider(
-    provider_type: str, resolver_type: ResolverType, container
+    provider_type: str, resolver_type: ResolverType, container, option_values: dict
 ) -> tuple[dict, bool]:
     launchpad = "default"
     t = TestProviderType(provider_type)
@@ -68,9 +68,16 @@ def get_default_options_for_provider(
         return options, True
 
     if resolver_type == ResolverType.FILE:
-        options["offline_flag_source_path"] = os.path.join(
-            container.flagDir.name, "allFlags.json"
-        )
+        if "selector" in option_values:
+            path = option_values["selector"]
+            path = path.replace("rawflags/", "")
+            options["offline_flag_source_path"] = os.path.join(
+                "..", "openfeature", "test-harness", "flags", path
+            )
+        else:
+            options["offline_flag_source_path"] = os.path.join(
+                container.flagDir.name, "allFlags.json"
+            )
 
     requests.post(
         f"{container.get_launchpad_url()}/start?config={launchpad}", timeout=1
@@ -89,7 +96,7 @@ def setup_provider(
     option_values: dict,
 ) -> OpenFeatureClient:
     default_options, wait = get_default_options_for_provider(
-        provider_type, resolver_type, container
+        provider_type, resolver_type, container, option_values
     )
 
     combined_options = {**default_options, **option_values}

providers/openfeature-provider-flagd/tests/flags/basic-flag-combined-metadata.json

@@ -0,0 +1,29 @@
+{
+  "flags": {
+    "basic-flag": {
+      "state": "ENABLED",
+      "variants": {
+        "true": true,
+        "false": false
+      },
+      "defaultVariant": "false",
+      "targeting": {},
+      "metadata": {
+        "string": "a",
+        "integer": 1,
+        "float": 1.2,
+        "bool": true
+      }
+    }
+  },
+  "metadata": {
+    "string": "b",
+    "integer": 2,
+    "float": 2.2,
+    "bool": false,
+    "flag-set-string": "c",
+    "flag-set-integer": 3,
+    "flag-set-float": 3.2,
+    "flag-set-bool": false
+  }
+}

providers/openfeature-provider-flagd/tests/flags/basic-flag-metadata.json

@@ -0,0 +1,19 @@
+{
+  "flags": {
+    "basic-flag": {
+      "state": "ENABLED",
+      "variants": {
+        "true": true,
+        "false": false
+      },
+      "defaultVariant": "false",
+      "targeting": {},
+      "metadata": {
+        "string": "a",
+        "integer": 1,
+        "float": 1.2,
+        "bool": true
+      }
+    }
+  }
+}

providers/openfeature-provider-flagd/tests/flags/basic-flag-set-metadata.json

@@ -0,0 +1,19 @@
+{
+  "flags": {
+    "basic-flag": {
+      "state": "ENABLED",
+      "variants": {
+        "true": true,
+        "false": false
+      },
+      "defaultVariant": "false",
+      "targeting": {}
+    }
+  },
+  "metadata": {
+    "string": "a",
+    "integer": 1,
+    "float": 1.2,
+    "bool": true
+  }
+}

providers/openfeature-provider-flagd/tests/flags/invalid-flag-metadata-list.json

@@ -0,0 +1,14 @@
+{
+  "flags": {
+    "basic-flag": {
+      "state": "ENABLED",
+      "variants": {
+        "true": true,
+        "false": false
+      },
+      "defaultVariant": "false",
+      "targeting": {},
+      "metadata": ["a"]
+    }
+  }
+}

providers/openfeature-provider-flagd/tests/flags/invalid-flag-metadata.json

@@ -0,0 +1,24 @@
+{
+  "flags": {
+    "basic-flag": {
+      "state": "ENABLED",
+      "variants": {
+        "true": true,
+        "false": false
+      },
+      "defaultVariant": "false",
+      "targeting": {},
+      "metadata": {
+        "string": {
+          "a": "a"
+        },
+        "integer": 1,
+        "float": 1.2,
+        "bool": true
+      }
+    }
+  },
+  "metadata": {
+    "bool": true
+  }
+}