Update in-process resolver to support flag metadata #305

Signed-off-by: christian.lutnik <christian.lutnik@dynatrace.com>

src/OpenFeature.Contrib.Providers.Flagd/Resolver/InProcess/JsonEvaluator.cs

@@ -2,14 +2,14 @@
 using System.Collections.Generic;
 using System.Collections.Immutable;
 using System.Linq;
+using System.Text.RegularExpressions;
 using JsonLogic.Net;
 using Newtonsoft.Json;
 using Newtonsoft.Json.Linq;
 using OpenFeature.Constant;
 using OpenFeature.Contrib.Providers.Flagd.Resolver.InProcess.CustomEvaluators;
 using OpenFeature.Error;
 using OpenFeature.Model;
-using System.Text.RegularExpressions;
 
 namespace OpenFeature.Contrib.Providers.Flagd.Resolver.InProcess
 {
@@ -26,6 +26,8 @@ internal class FlagConfiguration
         internal object Targeting { get; set; }
         [JsonProperty("source")]
         internal string Source { get; set; }
+        [JsonProperty("metadata")]
+        internal Dictionary<string, object> Metadata { get; set; }
     }
 
     internal class FlagSyncData
@@ -34,6 +36,8 @@ internal class FlagSyncData
         internal Dictionary<string, FlagConfiguration> Flags { get; set; }
         [JsonProperty("$evaluators")]
         internal Dictionary<string, object> Evaluators { get; set; }
+        [JsonProperty("metadata")]
+        internal Dictionary<string, object> Metadata { get; set; }
     }
 
     internal class FlagConfigurationSync
@@ -53,6 +57,7 @@ internal enum FlagConfigurationUpdateType
     internal class JsonEvaluator
     {
         private Dictionary<string, FlagConfiguration> _flags = new Dictionary<string, FlagConfiguration>();
+        private Dictionary<string, object> _flagSetMetadata = new Dictionary<string, object>();
 
         private string _selector;
 
@@ -99,26 +104,29 @@ internal void Sync(FlagConfigurationUpdateType updateType, string flagConfigurat
             {
                 case FlagConfigurationUpdateType.ALL:
                     _flags = flagConfigsMap.Flags;
+                    _flagSetMetadata = flagConfigsMap.Metadata;
                     break;
                 case FlagConfigurationUpdateType.ADD:
+                case FlagConfigurationUpdateType.UPDATE:
                     foreach (var keyAndValue in flagConfigsMap.Flags)
                     {
                         _flags[keyAndValue.Key] = keyAndValue.Value;
                     }
-                    break;
-                case FlagConfigurationUpdateType.UPDATE:
-                    foreach (var keyAndValue in flagConfigsMap.Flags)
+                    foreach (var metadata in flagConfigsMap.Metadata)
                     {
-                        _flags[keyAndValue.Key] = keyAndValue.Value;
+                        _flagSetMetadata[metadata.Key] = metadata.Value;
                     }
                     break;
                 case FlagConfigurationUpdateType.DELETE:
                     foreach (var keyAndValue in flagConfigsMap.Flags)
                     {
                         _flags.Remove(keyAndValue.Key);
                     }
+                    foreach (var keyValuePair in flagConfigsMap.Metadata)
+                    {
+                        _flagSetMetadata.Remove(keyValuePair.Key);
+                    }
                     break;
-
             }
         }
 
@@ -157,6 +165,16 @@ private ResolutionDetails<T> ResolveValue<T>(string flagKey, T defaultValue, Eva
                 {
                     throw new FeatureProviderException(ErrorType.FlagNotFound, "FLAG_NOT_FOUND: flag '" + flagKey + "' is disabled");
                 }
+                Dictionary<string, object> combinedMetadata = new Dictionary<string, object>(_flagSetMetadata);
+                if(flagConfiguration.Metadata != null)
+                {
+                    foreach (var (key,value) in flagConfiguration.Metadata)
+                    {
+                        combinedMetadata[key] = value;
+                    }
+                }
+
+                var flagMetadata = new ImmutableMetadata(combinedMetadata);
                 var variant = flagConfiguration.DefaultVariant;
                 if (flagConfiguration.Targeting != null && !String.IsNullOrEmpty(flagConfiguration.Targeting.ToString()) && flagConfiguration.Targeting.ToString() != "{}")
                 {
@@ -212,7 +230,8 @@ private ResolutionDetails<T> ResolveValue<T>(string flagKey, T defaultValue, Eva
                             flagKey: flagKey,
                             value,
                             reason: reason,
-                            variant: variant
+                            variant: variant,
+                            flagMetadata: flagMetadata
                             );
                 }
                 else if (flagConfiguration.Variants.TryGetValue(variant, out var foundVariantValue))
@@ -223,7 +242,8 @@ private ResolutionDetails<T> ResolveValue<T>(string flagKey, T defaultValue, Eva
                             flagKey: flagKey,
                             value,
                             reason: reason,
-                            variant: variant
+                            variant: variant,
+                            flagMetadata: flagMetadata
                             );
                 }
             }

test/OpenFeature.Contrib.Providers.Flagd.Test/JsonEvaluatorTest.cs

@@ -1,3 +1,4 @@
+using System;
 using System.Collections.Immutable;
 using AutoFixture;
 using OpenFeature.Constant;
@@ -10,7 +11,6 @@ namespace OpenFeature.Contrib.Providers.Flagd.Test
 {
     public class UnitTestJsonEvaluator
     {
-
         [Fact]
         public void TestJsonEvaluatorAddFlagConfig()
         {
@@ -23,7 +23,6 @@ public void TestJsonEvaluatorAddFlagConfig()
             var result = jsonEvaluator.ResolveBooleanValueAsync("validFlag", false);
 
             Assert.True(result.Value);
-
         }
 
         [Fact]
@@ -40,7 +39,6 @@ public void TestJsonEvaluatorAddStaticStringEvaluation()
             Assert.Equal("#CC0000", result.Value);
             Assert.Equal("red", result.Variant);
             Assert.Equal(Reason.Static, result.Reason);
-
         }
 
         [Fact]
@@ -57,7 +55,7 @@ public void TestJsonEvaluatorDynamicBoolEvaluation()
 
             var builder = EvaluationContext.Builder();
             builder
-              .Set("color", "yellow");
+                .Set("color", "yellow");
 
             var result = jsonEvaluator.ResolveBooleanValueAsync("targetingBoolFlag", false, builder.Build());
 
@@ -80,7 +78,8 @@ public void TestJsonEvaluatorDynamicBoolEvaluationUsingFlagdPropertyFlagKey()
 
             var builder = EvaluationContext.Builder();
 
-            var result = jsonEvaluator.ResolveBooleanValueAsync("targetingBoolFlagUsingFlagdProperty", false, builder.Build());
+            var result =
+                jsonEvaluator.ResolveBooleanValueAsync("targetingBoolFlagUsingFlagdProperty", false, builder.Build());
 
             Assert.True(result.Value);
             Assert.Equal("bool1", result.Variant);
@@ -101,7 +100,8 @@ public void TestJsonEvaluatorDynamicBoolEvaluationUsingFlagdPropertyTimestamp()
 
             var builder = EvaluationContext.Builder();
 
-            var result = jsonEvaluator.ResolveBooleanValueAsync("targetingBoolFlagUsingFlagdPropertyTimestamp", false, builder.Build());
+            var result = jsonEvaluator.ResolveBooleanValueAsync("targetingBoolFlagUsingFlagdPropertyTimestamp", false,
+                builder.Build());
 
             Assert.True(result.Value);
             Assert.Equal("bool1", result.Variant);
@@ -119,7 +119,8 @@ public void TestJsonEvaluatorDynamicBoolEvaluationSharedEvaluator()
 
             var builder = EvaluationContext.Builder().Set("email", "test@faas.com");
 
-            var result = jsonEvaluator.ResolveBooleanValueAsync("targetingBoolFlagUsingSharedEvaluator", false, builder.Build());
+            var result =
+                jsonEvaluator.ResolveBooleanValueAsync("targetingBoolFlagUsingSharedEvaluator", false, builder.Build());
 
             Assert.True(result.Value);
             Assert.Equal("bool1", result.Variant);
@@ -137,7 +138,9 @@ public void TestJsonEvaluatorDynamicBoolEvaluationSharedEvaluatorReturningBoolTy
 
             var builder = EvaluationContext.Builder().Set("email", "test@faas.com");
 
-            var result = jsonEvaluator.ResolveBooleanValueAsync("targetingBoolFlagUsingSharedEvaluatorReturningBoolType", false, builder.Build());
+            var result =
+                jsonEvaluator.ResolveBooleanValueAsync("targetingBoolFlagUsingSharedEvaluatorReturningBoolType", false,
+                    builder.Build());
 
             Assert.True(result.Value);
             Assert.Equal("true", result.Variant);
@@ -155,7 +158,9 @@ public void TestJsonEvaluatorDynamicBoolEvaluationWithMissingDefaultVariant()
 
             var builder = EvaluationContext.Builder();
 
-            Assert.Throws<FeatureProviderException>(() => jsonEvaluator.ResolveBooleanValueAsync("targetingBoolFlagWithMissingDefaultVariant", false, builder.Build()));
+            Assert.Throws<FeatureProviderException>(() =>
+                jsonEvaluator.ResolveBooleanValueAsync("targetingBoolFlagWithMissingDefaultVariant", false,
+                    builder.Build()));
         }
 
         [Fact]
@@ -169,7 +174,9 @@ public void TestJsonEvaluatorDynamicBoolEvaluationWithUnexpectedVariantType()
 
             var builder = EvaluationContext.Builder();
 
-            Assert.Throws<FeatureProviderException>(() => jsonEvaluator.ResolveBooleanValueAsync("targetingBoolFlagWithUnexpectedVariantType", false, builder.Build()));
+            Assert.Throws<FeatureProviderException>(() =>
+                jsonEvaluator.ResolveBooleanValueAsync("targetingBoolFlagWithUnexpectedVariantType", false,
+                    builder.Build()));
         }
 
         [Fact]
@@ -186,7 +193,7 @@ public void TestJsonEvaluatorDynamicStringEvaluation()
 
             var builder = EvaluationContext.Builder();
             builder
-              .Set("color", "yellow");
+                .Set("color", "yellow");
 
             var result = jsonEvaluator.ResolveStringValueAsync("targetingStringFlag", "", builder.Build());
 
@@ -209,7 +216,7 @@ public void TestJsonEvaluatorDynamicFloatEvaluation()
 
             var builder = EvaluationContext.Builder();
             builder
-              .Set("color", "yellow");
+                .Set("color", "yellow");
 
             var result = jsonEvaluator.ResolveDoubleValueAsync("targetingFloatFlag", 0, builder.Build());
 
@@ -232,7 +239,7 @@ public void TestJsonEvaluatorDynamicIntEvaluation()
 
             var builder = EvaluationContext.Builder();
             builder
-              .Set("color", "yellow");
+                .Set("color", "yellow");
 
             var result = jsonEvaluator.ResolveIntegerValueAsync("targetingNumberFlag", 0, builder.Build());
 
@@ -255,7 +262,7 @@ public void TestJsonEvaluatorDynamicObjectEvaluation()
 
             var builder = EvaluationContext.Builder();
             builder
-              .Set("color", "yellow");
+                .Set("color", "yellow");
 
             var result = jsonEvaluator.ResolveStructureValueAsync("targetingObjectFlag", null, builder.Build());
 
@@ -280,7 +287,8 @@ public void TestJsonEvaluatorDisabledBoolEvaluation()
             builder
                 .Set("color", "yellow");
 
-            Assert.Throws<FeatureProviderException>(() => jsonEvaluator.ResolveBooleanValueAsync("disabledFlag", false, builder.Build()));
+            Assert.Throws<FeatureProviderException>(() =>
+                jsonEvaluator.ResolveBooleanValueAsync("disabledFlag", false, builder.Build()));
         }
 
         [Fact]
@@ -299,7 +307,8 @@ public void TestJsonEvaluatorFlagNotFoundEvaluation()
             builder
                 .Set("color", "yellow");
 
-            Assert.Throws<FeatureProviderException>(() => jsonEvaluator.ResolveBooleanValueAsync("missingFlag", false, builder.Build()));
+            Assert.Throws<FeatureProviderException>(() =>
+                jsonEvaluator.ResolveBooleanValueAsync("missingFlag", false, builder.Build()));
         }
 
         [Fact]
@@ -318,7 +327,79 @@ public void TestJsonEvaluatorWrongTypeEvaluation()
             builder
                 .Set("color", "yellow");
 
-            Assert.Throws<FeatureProviderException>(() => jsonEvaluator.ResolveBooleanValueAsync("staticStringFlag", false, builder.Build()));
+            Assert.Throws<FeatureProviderException>(() =>
+                jsonEvaluator.ResolveBooleanValueAsync("staticStringFlag", false, builder.Build()));
+        }
+
+        [Fact]
+        public void TestJsonEvaluatorReturnsFlagMetadata()
+        {
+            var fixture = new Fixture();
+
+            var jsonEvaluator = new JsonEvaluator(fixture.Create<string>());
+
+            jsonEvaluator.Sync(FlagConfigurationUpdateType.ALL, Utils.flags);
+
+            var result = jsonEvaluator.ResolveBooleanValueAsync("metadata-flag", false);
+            Assert.NotNull(result.FlagMetadata);
+            Assert.Equal("1.0.2", result.FlagMetadata.GetString("string"));
+            Assert.Equal(2, result.FlagMetadata.GetInt("integer"));
+            Assert.Equal(true, result.FlagMetadata.GetBool("boolean"));
+            Assert.Equal(.1, result.FlagMetadata.GetDouble("float"));
+        }
+
+        [Fact]
+        public void TestJsonEvaluatorAddsFlagSetMetadataToFlagWithoutMetdata()
+        {
+            var fixture = new Fixture();
+
+            var jsonEvaluator = new JsonEvaluator(fixture.Create<string>());
+
+            jsonEvaluator.Sync(FlagConfigurationUpdateType.ALL, Utils.metadataFlags);
+
+            var result = jsonEvaluator.ResolveBooleanValueAsync("without-metadata-flag", false);
+            Assert.NotNull(result.FlagMetadata);
+            Assert.Equal("1.0.3", result.FlagMetadata.GetString("string"));
+            Assert.Equal(3, result.FlagMetadata.GetInt("integer"));
+            Assert.Equal(false, result.FlagMetadata.GetBool("boolean"));
+            Assert.Equal(.2, result.FlagMetadata.GetDouble("float"));
+        }
+
+        [Fact]
+        public void TestJsonEvaluatorFlagMetadataOverwritesFlagSetMetadata()
+        {
+            var fixture = new Fixture();
+
+            var jsonEvaluator = new JsonEvaluator(fixture.Create<string>());
+
+            jsonEvaluator.Sync(FlagConfigurationUpdateType.ALL, Utils.metadataFlags);
+
+            var result = jsonEvaluator.ResolveBooleanValueAsync("metadata-flag", false);
+            Assert.NotNull(result.FlagMetadata);
+            Assert.Equal("1.0.2", result.FlagMetadata.GetString("string"));
+            Assert.Equal(2, result.FlagMetadata.GetInt("integer"));
+            Assert.Equal(true, result.FlagMetadata.GetBool("boolean"));
+            Assert.Equal(.1, result.FlagMetadata.GetDouble("float"));
+        }
+
+        [Fact]
+        public void TestJsonEvaluatorThrowsOnInvalidFlagSetMetadata()
+        {
+            var fixture = new Fixture();
+
+            var jsonEvaluator = new JsonEvaluator(fixture.Create<string>());
+
+            Assert.Throws<NullReferenceException>(() => jsonEvaluator.Sync(FlagConfigurationUpdateType.ALL, Utils.invalidFlagSetMetadata));
+        }
+
+        [Fact]
+        public void TestJsonEvaluatorThrowsOnInvalidFlagMetadata()
+        {
+            var fixture = new Fixture();
+
+            var jsonEvaluator = new JsonEvaluator(fixture.Create<string>());
+
+            Assert.Throws<NullReferenceException>(() => jsonEvaluator.Sync(FlagConfigurationUpdateType.ALL, Utils.invalidFlagMetadata));
         }
     }
 }