use new notification listeners (#243)

* use new notification listeners

* fix TVOS errors and rename notification listener methods that were incorrect

Author: thomaszurkan-optimizely

OptimizelyDemoApp/AppDelegate.swift

@@ -59,55 +59,6 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
             Mixpanel.initialize(token:"MIXPANEL_TOKEN")
             Localytics.autoIntegrate("YOUR-LOCALYTICS-APP-KEY", launchOptions: launchOptions)
 
-            let defaultNotificationCenter = NotificationCenter.default
-            defaultNotificationCenter.addObserver(forName: NSNotification.Name("OptimizelyExperimentActivated"), object: nil, queue: nil) { (note) in
-                print("Received an activation notification: \n", note)
-                if let userInfo : Dictionary<String, AnyObject> = note.userInfo as! Dictionary<String, AnyObject>? {
-                    if let experiment = userInfo["experiment"] as! OPTLYExperiment? {
-                        if let variation = userInfo["variation"] as! OPTLYVariation? {
-                            // ---- Amplitude ----
-                            let propertyKey : String! = "[Optimizely] " + experiment.experimentKey
-                            let identify : AMPIdentify = AMPIdentify()
-                            identify.set(propertyKey, value:variation.variationKey as NSObject!)
-                            // Track impression event (optional)
-                            let eventIdentifier : String = "[Optimizely] " + experiment.experimentKey + " - " + variation.variationKey
-                            Amplitude.instance().logEvent(eventIdentifier)
-                            // ---- Google Analytics ----
-                            let tracker : GAITracker? = GAI.sharedInstance().defaultTracker
-                            let action : String = "Experiment - " + experiment.experimentKey
-                            let label : String = "Variation - " + variation.variationKey
-                            // Build and send a non-interaction Event
-                            let builder = GAIDictionaryBuilder.createEvent(withCategory: "Optimizely", action: action, label: label, value: nil).build()
-                            tracker?.send(builder as [NSObject : AnyObject]!)
-                            // ---- Mixpanel ----
-                            let mixpanel : MixpanelInstance = Mixpanel.mainInstance()
-                            mixpanel.registerSuperProperties([propertyKey: variation.variationKey])
-                            mixpanel.people.set(property: propertyKey, to: variation.variationKey)
-                            mixpanel.track(event:eventIdentifier)
-                        }
-                    }
-                }
-            }
-            
-            defaultNotificationCenter.addObserver(forName: NSNotification.Name("OptimizelyEventTracked"), object: nil, queue: nil) { (note) in
-                print("Received a tracking notification: \n", note)
-                if let userInfo : Dictionary<String, AnyObject> = note.userInfo as! Dictionary<String, AnyObject>? {
-                    // ---- Localytics ----
-                    let attributes : NSMutableDictionary = [:]
-                    if let userAttributes = userInfo["attributes"] as! Dictionary<String, AnyObject>? {
-                        attributes.addEntries(from: userAttributes)
-                    }
-                    if let userExperimentVariationMapping = userInfo["ExperimentVariationMapping"] as? Dictionary<String, OPTLYVariation>? {
-                        for (key,variation) in userExperimentVariationMapping! {
-                            attributes.setValue(key, forKey:variation.variationKey)
-                        }
-                    }
-                    // Tag custom event with attributes
-                    let event : String = userInfo["eventKey"] as! String
-                    let localyticsEventIdentifier : String = "[Optimizely] " + event
-                    Localytics.tagEvent(localyticsEventIdentifier)
-                }
-            }
         #endif
         // **************************************************
         // *********** Optimizely Initialization ************
@@ -137,6 +88,37 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
         // ---- 1. Asynchronous Initialization -----
         // initialize Optimizely Client from a datafile download
         optimizelyManager?.initialize(callback: { [weak self] (error, optimizelyClient) in
+#if os(iOS)
+            optimizelyClient?.optimizely?.notificationCenter?.addActivateNotificationListener({ (experiment, userId, attributes, variation, event) in
+                // ---- Amplitude ----
+                let propertyKey : String! = "[Optimizely] " + experiment.experimentKey
+                let identify : AMPIdentify = AMPIdentify()
+                identify.set(propertyKey, value:variation.variationKey as NSObject!)
+                // Track impression event (optional)
+                let eventIdentifier : String = "[Optimizely] " + experiment.experimentKey + " - " + variation.variationKey
+                Amplitude.instance().logEvent(eventIdentifier)
+                // ---- Google Analytics ----
+                let tracker : GAITracker? = GAI.sharedInstance().defaultTracker
+                let action : String = "Experiment - " + experiment.experimentKey
+                let label : String = "Variation - " + variation.variationKey
+                // Build and send a non-interaction Event
+                let builder = GAIDictionaryBuilder.createEvent(withCategory: "Optimizely", action: action, label: label, value: nil).build()
+                tracker?.send(builder as [NSObject : AnyObject]!)
+                // ---- Mixpanel ----
+                let mixpanel : MixpanelInstance = Mixpanel.mainInstance()
+                mixpanel.registerSuperProperties([propertyKey: variation.variationKey])
+                mixpanel.people.set(property: propertyKey, to: variation.variationKey)
+                mixpanel.track(event:eventIdentifier)
+            })
+            
+            optimizelyClient?.optimizely?.notificationCenter?.addTrackNotificationListener({ (eventKey, userId, attributes, eventTags, event) in
+                // Tag custom event with attributes
+                let event : String = eventKey
+                let localyticsEventIdentifier : String = "[Optimizely] " + event
+                Localytics.tagEvent(localyticsEventIdentifier)
+
+            })
+#endif
             let variation = optimizelyClient?.activate((self?.experimentKey)!, userId: (self?.userId)!, attributes: (self?.attributes))
             self?.setRootViewController(optimizelyClient: optimizelyClient, bucketedVariation:variation)
         })
@@ -200,9 +182,7 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
     func applicationWillResignActive(_ application: UIApplication) {
         // Sent when the application is about to move from active to inactive state. This can occur for certain types of temporary interruptions (such as an incoming phone call or SMS message) or when the user quits the application and it begins the transition to the background state.
         // Use this method to pause ongoing tasks, disable timers, and invalidate graphics rendering callbacks. Games should use this method to pause the game.
-        let defaultNotificationCenter = NotificationCenter.default
-        defaultNotificationCenter.removeObserver(self, name: NSNotification.Name("OptimizelyExperimentActivated"), object: nil)
-        defaultNotificationCenter.removeObserver(self, name: NSNotification.Name("OptimizelyEventTracked"), object: nil)
+        optimizelyClient?.optimizely?.notificationCenter?.clearAllNotificationListeners();
     }
 
     func applicationDidEnterBackground(_ application: UIApplication) {

OptimizelySDKCore/OptimizelySDKCore/OPTLYNotificationCenter.h

@@ -74,18 +74,18 @@ typedef NSMutableDictionary<NSNumber *, GenericListener > OPTLYNotificationHolde
  * @param notificationId the id passed back from add notification.
  * @return true if removed otherwise false (if the notification is already removed, it returns false).
  */
-- (BOOL)removeNotification:(NSUInteger)notificationId;
+- (BOOL)removeNotificationListener:(NSUInteger)notificationId;
 
 /**
  * Clear notification listeners by notification type.
  * @param type type of OPTLYNotificationType to remove.
  */
-- (void)clearNotifications:(OPTLYNotificationType)type;
+- (void)clearNotificationListeners:(OPTLYNotificationType)type;
 
 /**
  * Clear out all the notification listeners.
  */
-- (void)clearAllNotifications;
+- (void)clearAllNotificationListeners;
 
 //
 /**

OptimizelySDKCore/OptimizelySDKCore/OPTLYNotificationCenter.m

@@ -63,7 +63,7 @@ - (NSInteger)addTrackNotificationListener:(TrackListener)trackListener {
     return [self addNotification:OPTLYNotificationTypeTrack listener:(GenericListener)trackListener];
 }
 
-- (BOOL)removeNotification:(NSUInteger)notificationId {
+- (BOOL)removeNotificationListener:(NSUInteger)notificationId {
     for (NSNumber *notificationType in _notifications.allKeys) {
         OPTLYNotificationHolder *notificationMap = _notifications[notificationType];
         if (notificationMap != nil && [notificationMap.allKeys containsObject:@(notificationId)]) {
@@ -74,13 +74,13 @@ - (BOOL)removeNotification:(NSUInteger)notificationId {
     return NO;
 }
 
-- (void)clearNotifications:(OPTLYNotificationType)type {
+- (void)clearNotificationListeners:(OPTLYNotificationType)type {
     [_notifications[@(type)] removeAllObjects];
 }
 
-- (void)clearAllNotifications {
+- (void)clearAllNotificationListeners {
     for (NSNumber *notificationType in _notifications.allKeys) {
-        [self clearNotifications:[notificationType unsignedIntegerValue]];
+        [self clearNotificationListeners:[notificationType unsignedIntegerValue]];
     }
 }
 

OptimizelySDKCore/OptimizelySDKCoreTests/OPTLYNotificationCenterTest.m

@@ -81,7 +81,7 @@ - (void)tearDown {
     [super tearDown];
 
     // clean up all notifications
-    [_notificationCenter clearAllNotifications];
+    [_notificationCenter clearAllNotificationListeners];
 }
 
 - (void)testAddAndRemoveNotificationListener {
@@ -92,11 +92,11 @@ - (void)testAddAndRemoveNotificationListener {
     XCTAssertEqual(1, _notificationCenter.notificationsCount);
 
     // Verify that callback removed successfully.
-    XCTAssertEqual(YES, [_notificationCenter removeNotification:notificationId]);
+    XCTAssertEqual(YES, [_notificationCenter removeNotificationListener:notificationId]);
     XCTAssertEqual(0, _notificationCenter.notificationsCount);
 
     //Verify return false with invalid ID.
-    XCTAssertEqual(NO, [_notificationCenter removeNotification:notificationId]);
+    XCTAssertEqual(NO, [_notificationCenter removeNotificationListener:notificationId]);
 
     // Verify that callback added successfully and return right notification ID.
     XCTAssertEqual(_notificationCenter.notificationId, [_notificationCenter addActivateNotificationListener:_activateNotification]);
@@ -124,16 +124,16 @@ - (void)testClearNotifications {
     XCTAssertEqual(3, _notificationCenter.notificationsCount);
 
     // Verify that only decision callbacks are removed.
-    [_notificationCenter clearNotifications:OPTLYNotificationTypeActivate];
+    [_notificationCenter clearNotificationListeners:OPTLYNotificationTypeActivate];
     XCTAssertEqual(1, _notificationCenter.notificationsCount);
 
     // Verify that ClearNotifications does not break on calling twice for same type.
-    [_notificationCenter clearNotifications:OPTLYNotificationTypeActivate];
-    [_notificationCenter clearNotifications:OPTLYNotificationTypeActivate];
+    [_notificationCenter clearNotificationListeners:OPTLYNotificationTypeActivate];
+    [_notificationCenter clearNotificationListeners:OPTLYNotificationTypeActivate];
 
     // Verify that ClearNotifications does not break after calling ClearAllNotifications.
-    [_notificationCenter clearAllNotifications];
-    [_notificationCenter clearNotifications:OPTLYNotificationTypeTrack];
+    [_notificationCenter clearAllNotificationListeners];
+    [_notificationCenter clearNotificationListeners:OPTLYNotificationTypeTrack];
 }
 
 - (void)testClearAllNotifications {
@@ -149,13 +149,13 @@ - (void)testClearAllNotifications {
     XCTAssertEqual(3, _notificationCenter.notificationsCount);
 
     // Verify that ClearAllNotifications remove all the callbacks.
-    [_notificationCenter clearAllNotifications];
+    [_notificationCenter clearAllNotificationListeners];
     XCTAssertEqual(0, _notificationCenter.notificationsCount);
 
     // Verify that ClearAllNotifications does not break on calling twice or after ClearNotifications.
-    [_notificationCenter clearNotifications:OPTLYNotificationTypeActivate];
-    [_notificationCenter clearAllNotifications];
-    [_notificationCenter clearAllNotifications];
+    [_notificationCenter clearNotificationListeners:OPTLYNotificationTypeActivate];
+    [_notificationCenter clearAllNotificationListeners];
+    [_notificationCenter clearAllNotificationListeners];
 }
 
 - (void)testSendNotifications {
@@ -193,7 +193,7 @@ - (void)testSendNotifications {
 
     // Verify that after clearing notifications, SendNotification should not call any notification
     // which were previously registered.
-    [_notificationCenter clearAllNotifications];
+    [_notificationCenter clearAllNotificationListeners];
 
     [_notificationCenter sendNotifications:OPTLYNotificationTypeActivate args:@[experiment, userId, attributes, variation, event]];