Merge pull request #187 from optimizely/fixForEventDispatcher

(fix): fix for event dispatcher batch size

Author: jaeopt

OptimizelySDK/Customization/DefaultEventDispatcher.swift

@@ -28,13 +28,13 @@ open class DefaultEventDispatcher : BackgroundingCallbacks, OPTEventDispatcher {
     static let MAX_FAILURE_COUNT = 3
 
     // default timerInterval
-    open var timerInterval:TimeInterval = 60 * 5 // every five minutes
+    var timerInterval:TimeInterval = 60 * 5 // every five minutes
     // default batchSize.
     // attempt to send events in batches with batchSize number of events combined
-    open var batchSize:Int = 10
+    var batchSize:Int = 10
     // start trimming the front of the queue when we get to over maxQueueSize
     // TODO: implement
-    open var maxQueueSize:Int = 3000
+    var maxQueueSize:Int = 30000
 
     lazy var logger = HandlerRegistryService.shared.injectLogger()
     var backingStore:DataStoreType = .file
@@ -47,9 +47,8 @@ open class DefaultEventDispatcher : BackgroundingCallbacks, OPTEventDispatcher {
     // timer as a atomic property.
     var timer:AtomicProperty<Timer> = AtomicProperty<Timer>()
 
-    public init(batchSize:Int = 10, maxQueueSize:Int = 3000, backingStore:DataStoreType = .file, dataStoreName:String = "OPTEventQueue", timerInterval:TimeInterval = 60*5 ) {
-        self.batchSize = batchSize
-        self.maxQueueSize = maxQueueSize
+    public init(batchSize:Int = 10, backingStore:DataStoreType = .file, dataStoreName:String = "OPTEventQueue", timerInterval:TimeInterval = 60*5 ) {
+        self.batchSize = batchSize > 0 ? batchSize : 1
         self.backingStore = backingStore
         self.backingStoreName = dataStoreName
         self.timerInterval = timerInterval
@@ -112,9 +111,17 @@ open class DefaultEventDispatcher : BackgroundingCallbacks, OPTEventDispatcher {
 
             }
             while let eventsToSend:[EventForDispatch] = self.dataStore.getFirstItems(count:self.batchSize) {
+                let actualEventsSize = eventsToSend.count
                 var eventToSend = eventsToSend.batch()
                 if let _ = eventToSend {
                     // we merged the event and ready for batch
+                    // if the bacth size is not equal to the actual event size,
+                    // then setup the batchSizeHolder to be the size of the event.
+                    if actualEventsSize != self.batchSize {
+                        batchSizeHolder = actualEventsSize
+                        self.batchSize = actualEventsSize
+                        sendCount = actualEventsSize - 1
+                    }
                 }
                 else {
                     failedBatch()
@@ -182,7 +189,7 @@ open class DefaultEventDispatcher : BackgroundingCallbacks, OPTEventDispatcher {
 
     }
 
-    func sendEvent(event: EventForDispatch, completionHandler: @escaping DispatchCompletionHandler) {
+    open func sendEvent(event: EventForDispatch, completionHandler: @escaping DispatchCompletionHandler) {
         let config = URLSessionConfiguration.ephemeral
         let session = URLSession(configuration: config)
         var request = URLRequest(url: event.url)

OptimizelySDK/OptimizelyTests/OptimizelyTests-Common/EventDispatcherTests.swift

@@ -80,6 +80,32 @@ class EventDispatcherTests: XCTestCase {
         // This is an example of a functional test case.
         // Use XCTAssert and related functions to verify your tests produce the correct results.
     }
+    
+    func testDispatcherZeroTimeInterval() {
+        class InnerEventDispatcher : DefaultEventDispatcher {
+            var once = false
+            var events:[EventForDispatch] = [EventForDispatch]()
+            override func sendEvent(event: EventForDispatch, completionHandler: @escaping DispatchCompletionHandler) {
+                events.append(event)
+                if !once {
+                    self.dataStore.save(item: EventForDispatch(body: Data()))
+                    once = true
+                }
+                completionHandler(.success(Data()))
+            }
+        }
+        
+        let dispatcher = InnerEventDispatcher(timerInterval:0)
+
+        // add two items.... call flush
+        dispatcher.dataStore.save(item: EventForDispatch(body: Data()))
+        dispatcher.flushEvents()
+        
+        dispatcher.dispatcher.sync {
+        }
+        
+        XCTAssert(dispatcher.events.count == 2)
+    }
 
     func testEventDispatcherFile() {
         eventDispatcher = DefaultEventDispatcher( backingStore: .file)
@@ -238,6 +264,12 @@ class EventDispatcherTests: XCTestCase {
 
     }
 
+    func testDispatcherZeroBatchSize() {
+        let eventDispatcher = DefaultEventDispatcher(batchSize: 0, backingStore: .userDefaults, dataStoreName: "DoNothing", timerInterval: 0)
+        
+        XCTAssert(eventDispatcher.batchSize > 0)
+    }
+    
     func testDataStoreQueue() {
         let queue = DataStoreQueueStackImpl<EventForDispatch>(queueStackName: "OPTEventQueue", dataStore: DataStoreMemory<Array<Data>>(storeName: "backingStoreName"))