fix: change the types of event revenue and value fields (#467)

Author: jaeopt

Sources/Data Model/DispatchEvents/BatchEvent.swift

@@ -1,5 +1,5 @@
 //
-// Copyright 2019-2021, Optimizely, Inc. and contributors
+// Copyright 2019-2022, Optimizely, Inc. and contributors
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -120,8 +120,8 @@ struct DispatchEvent: Codable, Equatable {
     let timestamp: Int64
     let uuid: String
     var tags: [String: AttributeValue]?
-    var revenue: AttributeValue?
-    var value: AttributeValue?
+    var revenue: Int64?
+    var value: Double?
 
     enum CodingKeys: String, CodingKey {
         case entityID = "entity_id"
@@ -138,11 +138,9 @@ struct DispatchEvent: Codable, Equatable {
          entityID: String,
          uuid: String,
          tags: [String: AttributeValue]? = [:],
-         value: AttributeValue? = nil,
-         revenue: AttributeValue? = nil) {
-        
-        // TODO: add validation and throw here for invalid value (int, double) and revenue (int) types
-       
+         value: Double? = nil,
+         revenue: Int64? = nil) {
+               
         self.timestamp = timestamp
         self.key = key
         self.entityID = entityID

Sources/Implementation/Events/BatchEventBuilder.swift

@@ -1,5 +1,5 @@
 //
-// Copyright 2019, 2021, Optimizely, Inc. and contributors
+// Copyright 2019, 2021-2022, Optimizely, Inc. and contributors
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -108,7 +108,7 @@ class BatchEventBuilder {
 
     // MARK: - Event Tags
 
-    static func filterEventTags(_ eventTags: [String: Any]?) -> ([String: AttributeValue], AttributeValue?, AttributeValue?) {
+    static func filterEventTags(_ eventTags: [String: Any]?) -> ([String: AttributeValue], Double?, Int64?) {
         guard let eventTags = eventTags else {
             return ([:], nil, nil)
         }
@@ -124,54 +124,53 @@ class BatchEventBuilder {
     }
 
     static func filterTagsWithInvalidTypes(_ eventTags: [String: Any]) -> [String: AttributeValue] {
-        let filteredTags = eventTags.mapValues { AttributeValue(value: $0) }.filter { $0.value != nil } as? [String: AttributeValue]
-        return filteredTags ?? [:]
+        return eventTags.compactMapValues { AttributeValue(value: $0) }
     }
 
-    static func extractValueEventTag(_ eventTags: [String: AttributeValue]) -> AttributeValue? {
+    static func extractValueEventTag(_ eventTags: [String: AttributeValue]) -> Double? {
         guard let valueFromTags = eventTags[DispatchEvent.valueKey] else { return nil }
 
         // export {value, revenue} only for {double, int64} types
-        var value: AttributeValue?
+        var value: Double?
 
         switch valueFromTags {
-        case .double:
+        case .double(let attrValue):
             // valid value type
-            value = valueFromTags
-        case .int(let int64Value):
-            value = AttributeValue(value: Double(int64Value))
+            value = attrValue
+        case .int(let attrValue):
+            value = Double(attrValue)
         default:
             value = nil
         }
 
         if let value = value {
-            logger.i(.extractValueFromEventTags(value.stringValue))
+            logger.i(.extractValueFromEventTags("\(value)"))
         } else {
             logger.i(.failedToExtractValueFromEventTags(valueFromTags.stringValue))
         }
 
         return value
     }
 
-    static func extractRevenueEventTag(_ eventTags: [String: AttributeValue]) -> AttributeValue? {
+    static func extractRevenueEventTag(_ eventTags: [String: AttributeValue]) -> Int64? {
         guard let revenueFromTags = eventTags[DispatchEvent.revenueKey] else { return nil }
 
         // export {value, revenue} only for {double, int64} types
-        var revenue: AttributeValue?
+        var revenue: Int64?
 
         switch revenueFromTags {
-        case .int:
+        case .int(let value):
             // valid revenue type
-            revenue = revenueFromTags
-        case .double(let doubleValue):
+            revenue = Int64(value)
+        case .double(let value):
             // not accurate but acceptable ("3.14" -> "3")
-            revenue = AttributeValue(value: Int64(doubleValue))
+            revenue = Int64(value)
         default:
             revenue = nil
         }
 
         if let revenue = revenue {
-            logger.i(.extractRevenueFromEventTags(revenue.stringValue))
+            logger.i(.extractRevenueFromEventTags("\(revenue)"))
         } else {
             logger.i(.failedToExtractRevenueFromEventTags(revenueFromTags.stringValue))
         }

Tests/OptimizelyTests-Common/BatchEventBuilderTest.swift

@@ -1,5 +1,5 @@
 //
-// Copyright 2019-2021, Optimizely, Inc. and contributors
+// Copyright 2019-2022, Optimizely, Inc. and contributors
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -38,16 +38,22 @@ class BatchEventBuilderTests: XCTestCase {
     }
 
     func testConversionEventWithNoExperiment() {
-        let conversion = BatchEventBuilder.createConversionEvent(config: (optimizely?.config)!, eventKey: eventWithNoExperimentKey, userId: userId, attributes: ["anyattribute": "value", "broswer_type": "firefox"], eventTags: nil)
+        // serialized to JSON
+        let conversion = BatchEventBuilder.createConversionEvent(config: (optimizely?.config)!,
+                                                                 eventKey: eventWithNoExperimentKey,
+                                                                 userId: userId,
+                                                                 attributes: ["anyattribute": "value", "broswer_type": "firefox"],
+                                                                 eventTags: ["browser": "chrome"])
 
         XCTAssertNotNil(conversion)
 
+        // deserialized from JSON
         let batchEvent = try? JSONDecoder().decode(BatchEvent.self, from: conversion!)
 
         XCTAssertNotNil(batchEvent)
 
         XCTAssert((batchEvent?.enrichDecisions)! == true)
-        
+        XCTAssertEqual(batchEvent?.visitors[0].visitorID, userId)
     }
 
 }

Tests/OptimizelyTests-Common/BatchEventBuilderTests_EventTags.swift

@@ -1,5 +1,5 @@
 //
-// Copyright 2019, 2021, Optimizely, Inc. and contributors
+// Copyright 2019, 2021-2022, Optimizely, Inc. and contributors
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -315,7 +315,36 @@ extension BatchEventBuilderTests_EventTags {
         XCTAssertEqual(de["revenue"] as! Int, 40, "value must be valid for revenue")
         XCTAssertEqual(de["value"] as! Double, 32, "value must be valid for value")
     }
-
+    
+    func testEventTagsWithRevenueAndValue_toJSON() {
+        
+        // valid revenue/value types
+        
+        let conversion1 = BatchEventBuilder.createConversionEvent(config: (optimizely?.config)!, eventKey: eventKey, userId: userId, attributes: [:],
+                                                                  eventTags: ["browser": "chrome",
+                                                                              "revenue": 123,
+                                                                              "value": 32.5])
+        
+        // invalid revenue/value types
+        
+        let conversion2 = BatchEventBuilder.createConversionEvent(config: (optimizely?.config)!, eventKey: eventKey, userId: userId, attributes: [:],
+                                                                  eventTags: ["browser": "chrome",
+                                                                              "revenue": true,
+                                                                              "value": "invalid"])
+        
+        // deserialized from JSON
+        let batchEvent1 = try? JSONDecoder().decode(BatchEvent.self, from: conversion1!)
+        let batchEvent2 = try? JSONDecoder().decode(BatchEvent.self, from: conversion2!)
+        
+        XCTAssertEqual(batchEvent1?.visitors[0].visitorID, userId)
+        XCTAssertEqual(batchEvent1?.visitors[0].snapshots[0].events[0].revenue, 123)
+        XCTAssertEqual(batchEvent1?.visitors[0].snapshots[0].events[0].value, 32.5)
+        
+        XCTAssertEqual(batchEvent2?.visitors[0].visitorID, userId)
+        XCTAssertNil(batchEvent2?.visitors[0].snapshots[0].events[0].revenue, "invalid type not extracted")
+        XCTAssertNil(batchEvent2?.visitors[0].snapshots[0].events[0].value, "invalid type not extracted")
+    }
+    
 }
 
 // MARK: - Utils