feat(event processor): Add LogEvent notification support

.travis.yml

@@ -53,8 +53,8 @@ jobs:
       branches:
         only:
           - master
-      env: SCHEME=OptimizelySwiftSDK-iOS TEST_SDK=iphonesimulator PLATFORM='iOS Simulator' OS=9.3 NAME='iPad Air'
-      name: PLATFORM='iOS Simulator' OS=9.3 NAME='iPad Air'
+      env: SCHEME=OptimizelySwiftSDK-iOS TEST_SDK=iphonesimulator PLATFORM='iOS Simulator' OS=12.1 NAME='iPhone 7'
+      name: PLATFORM='iOS Simulator' OS=12.1 NAME='iPhone 7'
       install:
         - gem install slather --no-document --quiet
         - gem install cocoapods -v '1.6.1'
@@ -80,8 +80,8 @@ jobs:
       env: SCHEME=OptimizelySwiftSDK-iOS TEST_SDK=iphonesimulator PLATFORM='iOS Simulator' OS=11.4 NAME='iPhone 7 Plus'
       name: PLATFORM='iOS Simulator' OS=11.4 NAME='iPhone 7 Plus'
     - <<: *unittests
-      env: SCHEME=OptimizelySwiftSDK-iOS TEST_SDK=iphonesimulator PLATFORM='iOS Simulator' OS=12.1 NAME='iPhone 7'
-      name: PLATFORM='iOS Simulator' OS=12.1 NAME='iPhone 7'
+      env: SCHEME=OptimizelySwiftSDK-iOS TEST_SDK=iphonesimulator PLATFORM='iOS Simulator' OS=9.3 NAME='iPad Air'
+      name: PLATFORM='iOS Simulator' OS=9.3 NAME='iPad Air'
     - <<: *unittests
       env: SCHEME=OptimizelySwiftSDK-tvOS TEST_SDK=appletvsimulator PLATFORM='tvOS Simulator' OS=12.1 NAME='Apple TV 4K'
       name: PLATFORM='tvOS Simulator' OS=12.1 NAME='Apple TV 4K'

DemoObjCApp/AppDelegate.m

@@ -55,9 +55,14 @@ - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(
 // MARK: - Initialization Examples
 
 -(void)initializeOptimizelySDKAsynchronous {
-    DefaultEventDispatcher *eventDispacher = [[DefaultEventDispatcher alloc] initWithTimerInterval:1];
+    DefaultEventDispatcher *eventDispacher = [[DefaultEventDispatcher alloc] initWithBatchSize:10 timerInterval:1 maxQueueSize:1000];
 
-    self.optimizely = [[OptimizelyClient alloc] initWithSdkKey:kOptimizelySdkKey logger:nil eventDispatcher:eventDispacher userProfileService:nil periodicDownloadInterval:@(5) defaultLogLevel:OptimizelyLogLevelDebug];
+    self.optimizely = [[OptimizelyClient alloc] initWithSdkKey:kOptimizelySdkKey
+                                                        logger:nil
+                                               eventDispatcher:eventDispacher
+                                            userProfileService:nil
+                                      periodicDownloadInterval:@(5)
+                                               defaultLogLevel:OptimizelyLogLevelDebug];
 
     [self.optimizely startWithCompletion:^(NSData *data, NSError *error) {
         if (error == nil) {
@@ -126,6 +131,11 @@ -(void)initializeOptimizelySDKWithCustomization {
 
     }];
 
+    notifId = [self.optimizely.notificationCenter addLogEventNotificationListenerWithLogEventListener:^(NSString *url,
+                                                                                                        NSDictionary<NSString *,id> *event) {
+        NSLog(@"Received logEvent notification: %@ %@", url, event);
+    }];
+
     [self.optimizely startWithCompletion:^(NSData *data, NSError *error) {
         if (error == nil) {
             NSLog(@"Optimizely SDK initialized successfully!");

DemoSwiftApp/AppDelegate.swift

@@ -82,7 +82,7 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
 
         do {
             let datafileJSON = try String(contentsOfFile: localDatafilePath, encoding: .utf8)
-            try optimizely!.start(datafile: datafileJSON)
+            try optimizely.start(datafile: datafileJSON)
 
             print("Optimizely SDK initialized successfully!")
         } catch {
@@ -108,7 +108,7 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
         addListeners()
 
         // initialize SDK
-        optimizely!.start { result in
+        optimizely.start { result in
             switch result {
             case .failure(let error):
                 print("Optimizely SDK initiliazation failed: \(error)")
@@ -151,7 +151,10 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
                 }
             }
         })
-
+
+        _ = optimizely.notificationCenter.addLogEventNotificationListener(logEventListener: { (url, event) in
+            print("Received logEvent notification: \(url) \(event)")
+        })
     }
 
     // MARK: - ViewControl

OptimizelySwiftSDK.xcodeproj/xcshareddata/xcschemes/OptimizelySwiftSDK-tvOS.xcscheme

@@ -26,7 +26,6 @@
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      codeCoverageEnabled = "YES"
       shouldUseLaunchSchemeArgsEnv = "YES">
       <Testables>
          <TestableReference

Sources/Customization/DefaultEventDispatcher.swift

@@ -80,7 +80,6 @@ open class DefaultEventDispatcher: BackgroundingCallbacks, OPTEventDispatcher {
                                                                        dataStore: DataStoreUserDefaults())
         }
 
-
         if self.maxQueueSize < self.batchSize {
             self.logger.e(.eventDispatcherConfigError("batchSize cannot be bigger than maxQueueSize"))
             self.maxQueueSize = self.batchSize
@@ -93,7 +92,7 @@ open class DefaultEventDispatcher: BackgroundingCallbacks, OPTEventDispatcher {
 
     deinit {
         stopTimer()
-
+        
         removeProjectChangeNotificationObservers()
 
         unsubscribe()
@@ -189,6 +188,9 @@ open class DefaultEventDispatcher: BackgroundingCallbacks, OPTEventDispatcher {
         request.httpBody = event.body
         request.addValue("application/json", forHTTPHeaderField: "Content-Type")
 
+        // send notification BEFORE sending event to the server
+        NotificationCenter.default.post(name: .willSendOptimizelyEvents, object: event)
+
         let task = session.uploadTask(with: request, from: event.body) { (_, response, error) in
             self.logger.d(response.debugDescription)
 

Sources/Implementation/DefaultNotificationCenter.swift

@@ -20,8 +20,14 @@ public class DefaultNotificationCenter: OPTNotificationCenter {
     public var notificationId: Int = 1
     var notificationListeners = [Int: (Int, GenericListener)]()
 
+    var observerLogEvent: NSObjectProtocol?
+
     required public init() {
-
+        addInternalNotificationListners()
+    }
+
+    deinit {
+        removeInternalNotificationListners()
     }
 
     internal func incrementNotificationId() -> Int {
@@ -116,6 +122,23 @@ public class DefaultNotificationCenter: OPTNotificationCenter {
         return incrementNotificationId()
     }
 
+    public func addLogEventNotificationListener(logEventListener: @escaping LogEventListener) -> Int? {
+        notificationListeners[notificationId] = (NotificationType.logEvent.rawValue, { (args: Any...) in
+            guard let myArgs = args[0] as? [Any?] else {
+                return
+            }
+            if myArgs.count < 2 {
+                return
+            }
+            if let url = myArgs[0] as? String,
+                let event = myArgs[1] as? [String: Any] {
+                logEventListener(url, event)
+            }
+        })
+
+        return incrementNotificationId()
+    }
+
     public func removeNotificationListener(notificationId: Int) {
         self.notificationListeners.removeValue(forKey: notificationId)
     }
@@ -135,3 +158,31 @@ public class DefaultNotificationCenter: OPTNotificationCenter {
     }
 
 }
+
+// MARK: Notification Translation
+
+extension DefaultNotificationCenter {
+
+    func addInternalNotificationListners() {
+        observerLogEvent = NotificationCenter.default.addObserver(forName: .willSendOptimizelyEvents, object: nil, queue: nil) { (notif) in
+            guard let eventForDispatch = notif.object as? EventForDispatch else { return }
+
+            let url = eventForDispatch.url.absoluteString
+            let eventData = eventForDispatch.body
+
+            if let event = try? JSONSerialization.jsonObject(with: eventData, options: []) as? [String: Any] {
+                let args: [Any] = [url, event]
+                self.sendNotifications(type: NotificationType.logEvent.rawValue, args: args)
+            } else {
+                print("LogEvent notification discarded due to invalid event")
+            }
+        }
+    }
+
+    func removeInternalNotificationListners() {
+        if let observer = observerLogEvent {
+            NotificationCenter.default.removeObserver(observer, name: .willSendOptimizelyEvents, object: nil)
+        }
+    }
+
+}

Sources/Optimizely/OptimizelyClient+ObjC.swift

@@ -410,6 +410,14 @@ extension OptimizelyClient {
                 return returnVal(num: num)
             }
 
+            func addLogEventNotificationListener(logEventListener: @escaping (String, [String: Any]) -> Void) -> NSNumber? {
+                let num = notifications.addLogEventNotificationListener { (url, event) in
+                    logEventListener(url, event)
+                }
+
+                return returnVal(num: num)
+            }
+
             func removeNotificationListener(notificationId: Int) {
                 notifications.removeNotificationListener(notificationId: notificationId)
             }
@@ -441,8 +449,10 @@ extension OptimizelyClient {
 
     let innerEventDispatcher: DefaultEventDispatcher
 
-    @objc public init(timerInterval: TimeInterval) {
-        innerEventDispatcher = DefaultEventDispatcher(timerInterval: timerInterval)
+    @objc public init(batchSize: Int = DefaultEventDispatcher.DefaultValues.batchSize,
+                      timerInterval: TimeInterval = DefaultEventDispatcher.DefaultValues.timeInterval,
+                      maxQueueSize: Int = DefaultEventDispatcher.DefaultValues.maxQueueSize) {
+        innerEventDispatcher = DefaultEventDispatcher(batchSize: batchSize, timerInterval: timerInterval, maxQueueSize: maxQueueSize)
     }
 
     public func dispatchEvent(event: EventForDispatch, completionHandler: ((Data?, NSError?) -> Void)?) {