feat: populate Eval reason as event metadata being sent to the Events API

kaushalkapasi · kaushalkapasi · commit 59ac1d95bbe6 · 2025-06-23T16:30:38.000-04:00
diff --git a/DevCycle/DVCVariable.swift b/DevCycle/DVCVariable.swift
@@ -73,9 +73,7 @@ public class DVCVariable<T> {
         var defaulted = false
         self.key = variable.key
         self.defaultValue = defaultValue
-        if (variable.eval != nil) {
-            self.eval = variable.eval
-        }
+        self.eval = variable.eval
 
         let classString = String(describing: T.self)
         do {
diff --git a/DevCycle/DevCycleClient.swift b/DevCycle/DevCycleClient.swift
@@ -414,15 +414,25 @@ public class DevCycleClient {
                     variable, forKey: defaultValue as AnyObject)
             }
 
-            if !self.closed && !self.disableAutomaticEventLogging {
+            if !self.closed && !self.disableAutomaticEventLogging {                
                 self.eventQueue.updateAggregateEvents(
-                    variableKey: variable.key, variableIsDefaulted: variable.isDefaulted)
+                    variableKey: variable.key, variableIsDefaulted: variable.isDefaulted, metadata: createVariableEventMetaData(variableEval: variable.eval))
             }
 
             return variable
         }
     }
 
+    private func createVariableEventMetaData(variableEval: EvalReason?) -> [String: Any]? {
+        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]]
+        }
+        return nil
+    }
+
     public func identifyUser(user: DevCycleUser, callback: IdentifyCompletedHandler? = nil) throws {
         guard let currentUser = self.user, !currentUser.userId.isEmpty,
             !user.userId.isEmpty
diff --git a/DevCycle/Models/DevCycleEvent.swift b/DevCycle/Models/DevCycleEvent.swift
@@ -88,18 +88,18 @@ struct DVCAggregateEvents {
         self.variableEvaluated = [:]
     }
     
-    mutating func track(variableKey: String, eventType: DVCEventTypes) {
+    mutating func track(variableKey: String, eventType: DVCEventTypes, metadata: [String: Any]?) {
         if (eventType == DVCEventTypes.VariableEvaluated) {
             if let variableEvaluatedEvent = self.variableEvaluated[variableKey] {
                 variableEvaluatedEvent.value = variableEvaluatedEvent.value! + 1
             } else {
-                self.variableEvaluated[variableKey] = DevCycleEvent(type: "variableEvaluated", target: variableKey, clientDate: nil, value: 1, metaData: nil)
+                self.variableEvaluated[variableKey] = DevCycleEvent(type: "variableEvaluated", target: variableKey, clientDate: nil, value: 1, metaData: metadata)
             }
         } else {
             if let variableDefaultedEvent = self.variableDefaulted[variableKey] {
                 variableDefaultedEvent.value = variableDefaultedEvent.value! + 1
             } else {
-                self.variableDefaulted[variableKey] = DevCycleEvent(type: "variableDefaulted", target: variableKey, clientDate: nil, value: 1, metaData: nil)
+                self.variableDefaulted[variableKey] = DevCycleEvent(type: "variableDefaulted", target: variableKey, clientDate: nil, value: 1, metaData: metadata)
             }
         }
     }
diff --git a/DevCycle/Models/EventQueue.swift b/DevCycle/Models/EventQueue.swift
@@ -68,11 +68,12 @@ class EventQueue {
         }
     }
     
-    func updateAggregateEvents(variableKey: String, variableIsDefaulted: Bool) {
+    func updateAggregateEvents(variableKey: String, variableIsDefaulted: Bool, metadata: [String: Any]?) {
         eventDispatchQueue.async {
             self.aggregateEventQueue.track(
                 variableKey: variableKey,
-                eventType: variableIsDefaulted ? DVCEventTypes.VariableDefaulted : DVCEventTypes.VariableEvaluated
+                eventType: variableIsDefaulted ? DVCEventTypes.VariableDefaulted : DVCEventTypes.VariableEvaluated,
+                metadata: metadata
             )
         }
     }
diff --git a/DevCycleTests/Models/DevCycleClientTests.swift b/DevCycleTests/Models/DevCycleClientTests.swift
@@ -165,6 +165,68 @@ class DevCycleClientTest: XCTestCase {
         client.close(callback: nil)
     }
 
+    func testFlushEventsWithEvalReasons() throws{
+        let data = getConfigData(name: "test_config_eval_reason")
+        let dictionary = try JSONSerialization.jsonObject(with: data, options: .fragmentsAllowed) as! [String:Any]
+        let evalReasonConfig = try UserConfig(from: dictionary)
+
+        let options = DevCycleOptions.builder().eventFlushIntervalMS(100).build()
+        let service = MockService(userConfig: evalReasonConfig)
+
+        let client = try! DevCycleClient.builder().user(self.user).sdkKey("my_sdk_key").options(options).build(
+            onInitialized: nil)
+        client.setup(service: service)
+        client.config?.userConfig = evalReasonConfig
+        client.initialized = true
+
+        XCTAssertTrue(client.initialized)
+
+        let variable1 = client.variable(key: "string-var", defaultValue: "test_string")
+        XCTAssertEqual(variable1.value, "string1")
+        XCTAssertEqual(variable1.eval?.reason, "TARGETING_MATCH")
+        XCTAssertEqual(variable1.eval?.details, "Platform AND App Version")
+        XCTAssertEqual(variable1.eval?.targetId, "target_id_1")
+        
+        let variable2Value = client.variableValue(key: "bool-var", defaultValue: false)
+        XCTAssertTrue(variable2Value)
+        
+        let variableInvalid = client.variable(key: "title_text", defaultValue: "Default")
+        XCTAssertEqual(variableInvalid.value, "Default")
+        XCTAssertEqual(variableInvalid.eval?.reason, "DEFAULT")
+        XCTAssertEqual(variableInvalid.eval?.details, "User Not Targeted")
+        XCTAssertNil(variableInvalid.eval?.targetId)
+
+        let expectation = XCTestExpectation(description: "EventQueue has events with Eval metadata")
+        // Add a slight delay to ensure events are queued correctly
+        DispatchQueue.main.asyncAfter(deadline: .now() + 0.01) {
+            expectation.fulfill()
+        }
+        wait(for: [expectation], timeout: 0.5)
+        
+        let variableEvaluatedEvents = client.eventQueue.aggregateEventQueue.variableEvaluated
+        XCTAssertEqual(variableEvaluatedEvents.count, 2)
+        
+        let variableDefaultedEvents = client.eventQueue.aggregateEventQueue.variableDefaulted
+        XCTAssertEqual(variableDefaultedEvents.count, 1)
+        
+        let expectedEvaluatedMetadata = ["eval": ["reason": "TARGETING_MATCH", "details": "Platform AND App Version", "target_id": "target_id_1"]]
+        XCTAssertEqual(variableEvaluatedEvents["bool-var"]?.metaData as! [String: [String:String]], expectedEvaluatedMetadata)
+        XCTAssertEqual(variableEvaluatedEvents["string-var"]?.metaData as! [String: [String:String]], expectedEvaluatedMetadata)
+        
+        let expectedDefaultedMetadata = ["eval": ["reason": "DEFAULT", "details": "User Not Targeted"]]
+        XCTAssertEqual(variableDefaultedEvents["title_text"]?.metaData as! [String : [String : String?]], expectedDefaultedMetadata)
+        
+        client.flushEvents()
+        
+        let publishExpectation = XCTestExpectation(description: "EventQueue publishes an event")
+        DispatchQueue.main.asyncAfter(deadline: .now() + 0.01) {
+            XCTAssertTrue(service.publishCallCount == 1)
+            publishExpectation.fulfill()
+        }
+        wait(for: [publishExpectation], timeout: 0.5)
+        client.close(callback: nil)
+    }
+
     func testFlushEventsWithOneEventInQueueAndCallback() {
         let expectation = XCTestExpectation(description: "EventQueue publishes an event")
         let options = DevCycleOptions.builder().flushEventsIntervalMs(100).build()
diff --git a/DevCycleTests/Models/test_config_eval_reason.json b/DevCycleTests/Models/test_config_eval_reason.json
@@ -17,7 +17,8 @@
             "variationName": "id4 name",
             "eval": {
                 "reason": "TARGETING_MATCH",
-                "details": "Platform AND App Version"
+                "details": "Platform AND App Version",
+                "target_id": "target_id_1"
             }
         }
     },
@@ -33,7 +34,8 @@
             "value": true,
             "eval": {
                 "reason": "TARGETING_MATCH",
-                "details": "Platform AND App Version"
+                "details": "Platform AND App Version",
+                "target_id": "target_id_1"
             }
         },
         "json-var": {
@@ -48,7 +50,8 @@
             },
             "eval": {
                 "reason": "TARGETING_MATCH",
-                "details": "Platform AND App Version"
+                "details": "Platform AND App Version",
+                "target_id": "target_id_1"
             }
         },
         "string-var": {
@@ -58,7 +61,8 @@
             "value": "string1",
             "eval": {
                 "reason": "TARGETING_MATCH",
-                "details": "Platform AND App Version"
+                "details": "Platform AND App Version",
+                "target_id": "target_id_1"
             }
         },
         "num-var": {
@@ -68,7 +72,8 @@
             "value": 4,
             "eval": {
                 "reason": "TARGETING_MATCH",
-                "details": "Platform AND App Version"
+                "details": "Platform AND App Version",
+                "target_id": "target_id_1"
             }
         }
     },

Original file line number	Diff line number	Diff line change
`@@ -88,18 +88,18 @@ struct DVCAggregateEvents {`
`88`	`88`	`self.variableEvaluated = [:]`
`89`	`89`	`}`
`90`	`90`
`91`		`- mutating func track(variableKey: String, eventType: DVCEventTypes) {`
	`91`	`+ mutating func track(variableKey: String, eventType: DVCEventTypes, metadata: [String: Any]?) {`
`92`	`92`	`if (eventType == DVCEventTypes.VariableEvaluated) {`
`93`	`93`	`if let variableEvaluatedEvent = self.variableEvaluated[variableKey] {`
`94`	`94`	`variableEvaluatedEvent.value = variableEvaluatedEvent.value! + 1`
`95`	`95`	`} else {`
`96`		`- self.variableEvaluated[variableKey] = DevCycleEvent(type: "variableEvaluated", target: variableKey, clientDate: nil, value: 1, metaData: nil)`
	`96`	`+ self.variableEvaluated[variableKey] = DevCycleEvent(type: "variableEvaluated", target: variableKey, clientDate: nil, value: 1, metaData: metadata)`
`97`	`97`	`}`
`98`	`98`	`} else {`
`99`	`99`	`if let variableDefaultedEvent = self.variableDefaulted[variableKey] {`
`100`	`100`	`variableDefaultedEvent.value = variableDefaultedEvent.value! + 1`
`101`	`101`	`} else {`
`102`		`- self.variableDefaulted[variableKey] = DevCycleEvent(type: "variableDefaulted", target: variableKey, clientDate: nil, value: 1, metaData: nil)`
	`102`	`+ self.variableDefaulted[variableKey] = DevCycleEvent(type: "variableDefaulted", target: variableKey, clientDate: nil, value: 1, metaData: metadata)`
`103`	`103`	`}`
`104`	`104`	`}`
`105`	`105`	`}`
Original file line number	Diff line number	Diff line change
`@@ -68,11 +68,12 @@ class EventQueue {`
`68`	`68`	`}`
`69`	`69`	`}`
`70`	`70`
`71`		`- func updateAggregateEvents(variableKey: String, variableIsDefaulted: Bool) {`
	`71`	`+ func updateAggregateEvents(variableKey: String, variableIsDefaulted: Bool, metadata: [String: Any]?) {`
`72`	`72`	`eventDispatchQueue.async {`
`73`	`73`	`self.aggregateEventQueue.track(`
`74`	`74`	`variableKey: variableKey,`
`75`		`- eventType: variableIsDefaulted ? DVCEventTypes.VariableDefaulted : DVCEventTypes.VariableEvaluated`
	`75`	`+ eventType: variableIsDefaulted ? DVCEventTypes.VariableDefaulted : DVCEventTypes.VariableEvaluated,`
	`76`	`+ metadata: metadata`
`76`	`77`	`)`
`77`	`78`	`}`
`78`	`79`	`}`