feat: add eval reasons support

DevCycle.SDK.Server.Common/Model/EvalReason.cs

@@ -0,0 +1,126 @@
+using System;
+using System.Runtime.Serialization;
+using System.Text;
+using Newtonsoft.Json;
+
+namespace DevCycle.SDK.Server.Common.Model
+{
+    [DataContract]
+    public class EvalReason : IEquatable<EvalReason>
+    {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="EvalReason" /> class.
+        /// </summary>
+        /// <param name="reason">The evaluation reason (required).</param>
+        /// <param name="details">Additional details about the evaluation.</param>
+        /// <param name="targetId">Target identifier for the evaluation.</param>
+        public EvalReason(string reason = default, string details = default, string targetId = default)
+        {
+            Reason = reason ?? throw new ArgumentException("reason is a required property for EvalReason and cannot be null");
+            Details = details;
+            TargetId = targetId;
+        }
+
+        /// <summary>
+        /// The evaluation reason
+        /// </summary>
+        /// <value>The evaluation reason</value>
+        [DataMember(Name = "reason", EmitDefaultValue = false)]
+        [JsonProperty("reason")]
+        public string Reason { get; set; }
+
+        /// <summary>
+        /// Additional details about the evaluation
+        /// </summary>
+        /// <value>Additional details about the evaluation</value>
+        [DataMember(Name = "details", EmitDefaultValue = false)]
+        [JsonProperty("details")]
+        public string Details { get; set; }
+
+        /// <summary>
+        /// Target identifier for the evaluation
+        /// </summary>
+        /// <value>Target identifier for the evaluation</value>
+        [DataMember(Name = "targetId", EmitDefaultValue = false)]
+        [JsonProperty("targetId")]
+        public string TargetId { get; set; }
+
+        /// <summary>
+        /// Returns the string presentation of the object
+        /// </summary>
+        /// <returns>String presentation of the object</returns>
+        public override string ToString()
+        {
+            var sb = new StringBuilder();
+            sb.Append("class EvalReason {\n");
+            sb.Append("  Reason: ").Append(Reason).Append("\n");
+            sb.Append("  Details: ").Append(Details).Append("\n");
+            sb.Append("  TargetId: ").Append(TargetId).Append("\n");
+            sb.Append("}\n");
+            return sb.ToString();
+        }
+
+        /// <summary>
+        /// Returns the JSON string presentation of the object
+        /// </summary>
+        /// <returns>JSON string presentation of the object</returns>
+        public virtual string ToJson()
+        {
+            return JsonConvert.SerializeObject(this, Formatting.Indented);
+        }
+
+        /// <summary>
+        /// Returns true if objects are equal
+        /// </summary>
+        /// <param name="input">Object to be compared</param>
+        /// <returns>Boolean</returns>
+        public override bool Equals(object input)
+        {
+            return Equals(input as EvalReason);
+        }
+
+        /// <summary>
+        /// Returns true if EvalReason instances are equal
+        /// </summary>
+        /// <param name="input">Instance of EvalReason to be compared</param>
+        /// <returns>Boolean</returns>
+        public bool Equals(EvalReason input)
+        {
+            if (input == null)
+                return false;
+
+            return
+                (
+                    Reason == input.Reason ||
+                    (Reason != null && Reason.Equals(input.Reason))
+                ) &&
+                (
+                    Details == input.Details ||
+                    (Details != null && Details.Equals(input.Details))
+                ) &&
+                (
+                    TargetId == input.TargetId ||
+                    (TargetId != null && TargetId.Equals(input.TargetId))
+                );
+        }
+
+        /// <summary>
+        /// Gets the hash code
+        /// </summary>
+        /// <returns>Hash code</returns>
+        public override int GetHashCode()
+        {
+            unchecked // Overflow is fine, just wrap
+            {
+                int hashCode = 41;
+                if (Reason != null)
+                    hashCode = hashCode * 59 + Reason.GetHashCode();
+                if (Details != null)
+                    hashCode = hashCode * 59 + Details.GetHashCode();
+                if (TargetId != null)
+                    hashCode = hashCode * 59 + TargetId.GetHashCode();
+                return hashCode;
+            }
+        }
+    }
+}

DevCycle.SDK.Server.Common/Model/IVariable.cs

@@ -42,21 +42,23 @@ public interface IVariable
         public TypeEnum Type { get; set; }
 
         public string Key { get; set; }
-        
+
         public bool IsDefaulted { get; set; }
 
         public string EvalReason { get; set; }
 
+        public EvalReason Eval { get; set; }
+
     }
-    
+
     public static class VariableHelper
     {
         public static Variable<T> Convert<T>(this Variable<object> variable)
         {
             var defaultValue = variable.DefaultValue;
             var value = variable.Value;
 
-            return new Variable<T>(variable.Key, (T) value, (T) defaultValue)
+            return new Variable<T>(variable.Key, (T)value, (T)defaultValue)
             {
                 IsDefaulted = variable.IsDefaulted,
             };

DevCycle.SDK.Server.Common/Model/ReadOnlyVariable.cs

@@ -14,7 +14,7 @@ public class ReadOnlyVariable<T>
         [DataMember(Name = "_id")]
         [JsonProperty("_id")]
         public string Id { get; set; }
-        
+
         /// <summary>
         /// Variable value can be a string, number, boolean, or JSON
         /// </summary>
@@ -27,7 +27,7 @@ public class ReadOnlyVariable<T>
         /// Variable type
         /// </summary>
         /// <value>Variable type</value>
-        [DataMember(Name="type")]
+        [DataMember(Name = "type")]
         [JsonProperty("type")]
         public string Type { get; set; }
 
@@ -38,9 +38,17 @@ public class ReadOnlyVariable<T>
         [DataMember(Name = "key")]
         [JsonProperty("key")]
         public string Key { get; set; }
-        
+
         public string EvalReason { get; set; }
 
+        /// <summary>
+        /// Evaluation details
+        /// </summary>
+        /// <value>Evaluation details</value>
+        [DataMember(Name = "eval", EmitDefaultValue = false)]
+        [JsonProperty("eval")]
+        public EvalReason Eval { get; set; }
+
         /// <summary>
         /// Returns the string presentation of the object
         /// </summary>

DevCycle.SDK.Server.Common/Model/Variable.cs

@@ -69,6 +69,7 @@ public static Variable<T> InitializeFromVariable(Variable<T> variable, string ke
                 returnVariable.DefaultValue = defaultValue;
                 returnVariable.Type = variable.Type;
                 returnVariable.EvalReason = variable.EvalReason;
+                returnVariable.Eval = variable.Eval;
                 returnVariable.IsDefaulted = false;
             }
             else
@@ -109,6 +110,13 @@ public static Variable<T> InitializeFromVariable(Variable<T> variable, string ke
         [DataMember(Name = "isDefaulted")] public bool IsDefaulted { get; set; }
         public string EvalReason { get; set; }
 
+        /// <summary>
+        /// Evaluation details
+        /// </summary>
+        /// <value>Evaluation details</value>
+        [DataMember(Name = "eval", EmitDefaultValue = false)]
+        public EvalReason Eval { get; set; }
+
         public static TypeEnum DetermineType(T variableValue)
         {
             TypeEnum typeEnum;
@@ -148,7 +156,7 @@ public static TypeEnum DetermineType(T variableValue)
                 throw;
             }
         }
-        
+
         public override bool Equals(object input)
         {
             return Equals(input as Variable<T>);
@@ -164,23 +172,23 @@ public bool Equals(Variable<T> input)
             if (input == null)
                 return false;
 
-            return 
+            return
                 (
                     Key == input.Key ||
                     (Key != null &&
                      Key.Equals(input.Key))
-                ) && 
+                ) &&
                 (
                     Type == input.Type ||
                     Type.Equals(input.Type)
-                ) && 
+                ) &&
                 (
                     (Value != null &&
                      Value.Equals(input.Value))
                 );
         }
-        
-        
+
+
         /// <summary>
         /// Gets the hash code
         /// </summary>

DevCycle.SDK.Server.Local/Api/DevCycleLocalClient.cs

@@ -10,7 +10,7 @@
 using Google.Protobuf;
 using Microsoft.Extensions.Logging;
 using Newtonsoft.Json;
 using DevCycle.SDK.Server.Common.Model;
 using System.Runtime.InteropServices;
 
 namespace DevCycle.SDK.Server.Local.Api
@@ -99,7 +99,7 @@
             localBucketing.SetPlatformData(platformData.ToJson());
             evalHooksRunner = new EvalHooksRunner(logger, dvcLocalOptions.EvalHooks);
 
-            if(dvcLocalOptions.CdnSlug != "")
+            if (dvcLocalOptions.CdnSlug != "")
             {
                 logger.LogWarning("The config CDN slug is being overriden, please ensure to update the config to v2 according to the config CDN updates documentation.");
 
@@ -159,17 +159,17 @@
                     else if (entry.Value is string strValue)
                     {
                         nullableCustomData.Value[entry.Key] = new CustomDataValue()
-                            { StringValue = strValue, Type = CustomDataType.Str };
+                        { StringValue = strValue, Type = CustomDataType.Str };
                     }
                     else if (entry.Value is double numValue)
                     {
                         nullableCustomData.Value[entry.Key] = new CustomDataValue()
-                            { DoubleValue = numValue, Type = CustomDataType.Num };
+                        { DoubleValue = numValue, Type = CustomDataType.Num };
                     }
                     else if (entry.Value is bool boolValue)
                     {
                         nullableCustomData.Value[entry.Key] = new CustomDataValue()
-                            { BoolValue = boolValue, Type = CustomDataType.Bool };
+                        { BoolValue = boolValue, Type = CustomDataType.Bool };
                     }
                 }
 
@@ -342,6 +342,12 @@
                 }
 
                 SDKVariable_PB sdkVariable = SDKVariable_PB.Parser.ParseFrom(variableData);
+                Console.WriteLine("sdkVariable properties:");
+                foreach (var prop in sdkVariable.GetType().GetProperties())
+                {
+                    var value = prop.GetValue(sdkVariable, null);
+                    Console.WriteLine($"{prop.Name}: {value}");
+                }
 
                 if (variableType != sdkVariable.Type)
                 {
@@ -390,13 +396,13 @@
                 ShouldTrackEvent = true
             };
 
-            Variable<T> existingVariable = Common.Model.Variable<T>.InitializeFromVariable(null, key, defaultValue);;
+            Variable<T> existingVariable = Common.Model.Variable<T>.InitializeFromVariable(null, key, defaultValue); ;
             HookContext<T> hookContext = new HookContext<T>(user, key, defaultValue, null);
-            
+
             var hooks = evalHooksRunner.GetHooks();
             var reversedHooks = new List<EvalHook>(hooks);
             reversedHooks.Reverse();
-            
+
             try
             {
                 System.Exception beforeError = null;
@@ -408,7 +414,7 @@
                 {
                     beforeError = e;
                 }
-                
+
                 var paramsBuffer = paramsPb.ToByteArray();
 
                 byte[] variableData = localBucketing.GetVariableForUserProtobuf(serializedParams: paramsBuffer);
@@ -426,7 +432,9 @@
                 if (variableType != sdkVariable.Type)
                 {
                     logger.LogWarning("Type of Variable does not match DevCycle configuration. Using default value");
-                } else {
+                }
+                else
+                {
                     existingVariable = GetVariable<T>(sdkVariable, defaultValue);
                 }
 
@@ -451,7 +459,7 @@
             return existingVariable;
         }
 
-    
+
 
         public override async Task<T> VariableValue<T>(DevCycleUser user, string key, T defaultValue)
         {

DevCycle.SDK.Server.Local/variableForUserParams.proto

@@ -68,4 +68,12 @@ message SDKVariable_PB {
     double doubleValue = 5;
     string stringValue = 6;
     NullableString evalReason = 7;
+    NullableString _feature = 8; 
+    EvalReason_PB eval = 9;
+}
+
+message EvalReason_PB {
+  string reason = 1;
+  string details = 2;
+  string target_id = 3;
 }