add tests for event-batching

Author: jaeopt

OptimizelySDK/Customization/DefaultEventDispatcher.swift

@@ -73,10 +73,11 @@ open class DefaultEventDispatcher : BackgroundingCallbacks, OPTEventDispatcher {
         unsubscribe()
     }
 
-    open func dispatchEvent(event: EventForDispatch, completionHandler: @escaping DispatchCompletionHandler) {
-        
+    open func dispatchEvent(event: EventForDispatch, completionHandler: DispatchCompletionHandler?) {
         dataStore.save(item: event)
 
+        // TODO: use or clean up completionHandler
+
         setTimer()
     }
 
@@ -229,6 +230,9 @@ open class DefaultEventDispatcher : BackgroundingCallbacks, OPTEventDispatcher {
 
         if #available(iOS 10.0, tvOS 10.0, *) {
             DispatchQueue.main.async {
+                // should check here again
+                guard self.timer.property == nil else { return }
+                
                 self.timer.property = Timer.scheduledTimer(withTimeInterval: self.timerInterval, repeats: true) { (timer) in
                     if self.dataStore.count == 0 {
                         self.timer.performAtomic() { (timer) in

OptimizelySDK/Customization/Protocols/OPTEventDispatcher.swift

@@ -35,7 +35,7 @@ public protocol OPTEventDispatcher {
      - Parameter event: EventForDispatch object which contains the url to send to and the body.
      - Parameter completionHandler: Called when the event has been sent or if an error occured.  This may not be called in the case where the dispatcher is doing batch events. It is up to the implementor of the protocol.
     */
-    func dispatchEvent(event:EventForDispatch, completionHandler: @escaping DispatchCompletionHandler)
+    func dispatchEvent(event:EventForDispatch, completionHandler: DispatchCompletionHandler?)
 
     /// Attempts to flush the event queue if there are any events to process.
     func flushEvents()

OptimizelySDK/Data Model/DispatchEvents/BatchEvent.swift

@@ -9,14 +9,14 @@
 import Foundation
 
 struct BatchEvent: Codable, Equatable {
-    let revision: String
-    let accountID: String
-    let clientVersion: String
-    let visitors: [Visitor]
-    let projectID: String
-    let clientName: String
-    let anonymizeIP: Bool
-    let enrichDecisions: Bool
+    var revision: String
+    var accountID: String
+    var clientVersion: String
+    var visitors: [Visitor]
+    var projectID: String
+    var clientName: String
+    var anonymizeIP: Bool
+    var enrichDecisions: Bool
 
     enum CodingKeys: String, CodingKey {
         case revision
@@ -31,9 +31,9 @@ struct BatchEvent: Codable, Equatable {
 }
 
 struct Visitor: Codable, Equatable {
-    let attributes: [EventAttribute]
-    let snapshots: [Snapshot]
-    let visitorID: String
+    var attributes: [EventAttribute]
+    var snapshots: [Snapshot]
+    var visitorID: String
 
     enum CodingKeys: String, CodingKey {
         case attributes
@@ -43,10 +43,10 @@ struct Visitor: Codable, Equatable {
 }
 
 struct EventAttribute: Codable, Equatable {
-    let value: AttributeValue
-    let key: String
-    let type: String
-    let entityID: String
+    var value: AttributeValue
+    var key: String
+    var type: String
+    var entityID: String
 
     enum CodingKeys: String, CodingKey {
         case value
@@ -57,12 +57,12 @@ struct EventAttribute: Codable, Equatable {
 }
 
 struct Snapshot: Codable, Equatable {
-    let decisions: [Decision]?
-    let events: [DispatchEvent]
+    var decisions: [Decision]?
+    var events: [DispatchEvent]
 }
 
 struct Decision: Codable, Equatable {
-    let variationID, campaignID, experimentID: String
+    var variationID, campaignID, experimentID: String
 
     enum CodingKeys: String, CodingKey {
         case variationID = "variation_id"
@@ -77,14 +77,18 @@ struct DispatchEvent: Codable, Equatable {
     static let activateEventKey = "campaign_activated"
 
     // entityID is the layer id for impression events.
-    let entityID: String
-    let key: String
-    let timestamp: Int64
-    let uuid: String
+    var entityID: String
+    var key: String
+    var timestamp: Int64
+    var uuid: String
     var tags: [String: AttributeValue]?
     var revenue: AttributeValue?
     var value: AttributeValue?
 
+    // TODO: [Tom] these two in spec, not used here. is it ok?
+    // quantity: MISSING
+    // type: MISSING
+
     enum CodingKeys: String, CodingKey {
         case entityID = "entity_id"
         case key

OptimizelySDK/OptimizelyTests/OptimizelyTests-APIs/OptimizelyManagerTests_Threading.swift

@@ -289,7 +289,7 @@ class OptimizelyManagerTests_Threading: XCTestCase {
 
         dispatchGroup.wait()
 
-        XCTAssertTrue(atomicBackground.property!.count == 101, "Count should be 101 but was \(atomicBackground.property!.count)")
+        XCTAssertTrue(atomicBackground.property!.count == 101)
 
         for index in 0...100 where index < atomicBackground.property!.count {
             XCTAssertTrue(atomicBackground.property![index].enabled!)
@@ -337,7 +337,7 @@ class OptimizelyManagerTests_Threading: XCTestCase {
 
     func makeEventHandler() -> OPTEventDispatcher {
         class NoOpEventHandler : OPTEventDispatcher {
-            func dispatchEvent(event: EventForDispatch, completionHandler: @escaping DispatchCompletionHandler) {
+            func dispatchEvent(event: EventForDispatch, completionHandler: DispatchCompletionHandler?) {
 
             }