chore: add default details as an enum. adds return type to createVariableEventMetaData function

Author: kaushalkapasi

DevCycle/DVCVariable.swift

@@ -63,7 +63,7 @@ public class DVCVariable<T> {
                     + "String / Boolean / NSNumber / Int / NSDictionary")
             self.value = defaultValue
             self.isDefaulted = true
-            self.eval = EvalReason.defaultReason(details: "Invalid Variable Type")
+            self.eval = EvalReason.defaultReason(details: DVCDefaultDetails.invalidVariableType.rawValue)
         }
 
         addNotificationObserver()
@@ -85,7 +85,7 @@ public class DVCVariable<T> {
             )
             self.value = defaultValue
             self.isDefaulted = true
-            self.eval = EvalReason.defaultReason(details: "Invalid Variable Type")
+            self.eval = EvalReason.defaultReason(details: DVCDefaultDetails.invalidVariableType.rawValue)
             addNotificationObserver()
             return
         }
@@ -96,7 +96,7 @@ public class DVCVariable<T> {
             Log.warn("Variable \(variable.key) does not match type of default value \(T.self))")
             self.value = defaultValue
             defaulted = true
-            self.eval = EvalReason.defaultReason(details: "Variable Type Mismatch")
+            self.eval = EvalReason.defaultReason(details: DVCDefaultDetails.variableTypeMismatch.rawValue)
         }
 
         self.isDefaulted = defaulted
@@ -118,7 +118,7 @@ public class DVCVariable<T> {
             }
         } else {
             Log.warn("Variable \(variable.key) does not match type of default value \(T.self))")
-            self.eval = EvalReason.defaultReason(details: "Variable Type Mismatch")
+            self.eval = EvalReason.defaultReason(details: DVCDefaultDetails.variableTypeMismatch.rawValue)
         }
     }
 
@@ -133,14 +133,14 @@ public class DVCVariable<T> {
             self.handler?(value)
         } else if !self.isDefaulted {
             self.isDefaulted = true
-            self.eval = EvalReason.defaultReason(details: "User Not Targeted")
+            self.eval = EvalReason.defaultReason(details: DVCDefaultDetails.userNotTargeted.rawValue)
         }
     }
 
     private func resetToDefault() {
         self.value = self.defaultValue
         self.isDefaulted = true
-        self.eval = EvalReason.defaultReason(details: "User Not Targeted")
+        self.eval = EvalReason.defaultReason(details: DVCDefaultDetails.userNotTargeted.rawValue)
     }
 
     private func addNotificationObserver() {

DevCycle/DevCycleClient.swift

@@ -381,7 +381,7 @@ public class DevCycleClient {
                 key: key,
                 value: nil,
                 defaultValue: defaultValue,
-                eval: EvalReason.defaultReason(details: "Invalid Variable Key")
+                eval: EvalReason.defaultReason(details: DVCDefaultDetails.invalidVariableKey.rawValue)
             )
         }
 
@@ -406,7 +406,7 @@ public class DevCycleClient {
                         key: key,
                         value: nil,
                         defaultValue: defaultValue,
-                        eval: EvalReason.defaultReason(details: "User Not Targeted")
+                        eval: EvalReason.defaultReason(details: DVCDefaultDetails.userNotTargeted.rawValue)
                     )
                 }
 
@@ -416,19 +416,22 @@ public class DevCycleClient {
 
             if !self.closed && !self.disableAutomaticEventLogging {                
                 self.eventQueue.updateAggregateEvents(
-                    variableKey: variable.key, variableIsDefaulted: variable.isDefaulted, metadata: createVariableEventMetaData(variableEval: variable.eval))
+                    variableKey: variable.key,
+                    variableIsDefaulted: variable.isDefaulted,
+                    metadata: createVariableEventMetaData(variableEval: variable.eval
+                ))
             }
 
             return variable
         }
     }
 
-    private func createVariableEventMetaData(variableEval: EvalReason?) -> [String: Any]? {
+    private func createVariableEventMetaData(variableEval: EvalReason?) -> [String: [String: String]]? {
         if let eval = variableEval {
             if let targetId = eval.targetId {
-                return ["eval": ["reason": eval.reason, "details": eval.details, "target_id": targetId]]
+                return ["eval": ["reason": eval.reason, "details": eval.details ?? "", "target_id": targetId]]
             }
-            return ["eval": ["reason": eval.reason, "details": eval.details]]
+            return ["eval": ["reason": eval.reason, "details": eval.details ?? ""]]
         }
         return nil
     }

DevCycle/Models/UserConfig.swift

@@ -233,3 +233,10 @@ public struct EvalReason {
         return EvalReason(reason: "DEFAULT", details: details)
     }
 }
+
+internal enum DVCDefaultDetails: String {
+    case userNotTargeted = "User Not Targeted"
+    case invalidVariableKey = "Invalid Variable Key"
+    case invalidVariableType = "Invalid Variable Type"
+    case variableTypeMismatch = "Variable Type Mismatch"
+}

DevCycle/ObjC/ObjCDevCycleClient.swift

@@ -189,7 +189,7 @@ public class ObjCDevCycleClient: NSObject {
                 key: key,
                 value: nil,
                 defaultValue: defaultValue,
-                eval: EvalReason.defaultReason(details: "User Not Targeted")
+                eval: EvalReason.defaultReason(details: DVCDefaultDetails.userNotTargeted.rawValue)
             )
         )
     }