Notification Listener Changes (#212)

* Notification Listener Changes

* example of using notification center.

* removed type from addNotification overloads

* updated to match the design doc

* asserts in send notifications

* merge fixes

* test cases for NotificationCenter

* removed SwiftNotifyTest

* property for OPTLYNotificationCenter in OPTLYClient

* fix - file reference

* Track tests added
Copyright updated

* convert if to case statement

Author: arafay-folio3

OptimizelySDKCore/OptimizelySDKCore.xcodeproj/project.pbxproj

@@ -17,15 +17,28 @@
 #import <Foundation/Foundation.h>
 
 @class OPTLYProjectConfig, OPTLYExperiment, OPTLYVariation;
-@protocol OPTLYNotificationDelegate;
 
 /// Enum representing notification types.
 typedef NS_ENUM(NSUInteger, OPTLYNotificationType) {
     OPTLYNotificationTypeActivate,
     OPTLYNotificationTypeTrack
 };
 
-typedef NSMutableDictionary<NSNumber *, id<OPTLYNotificationDelegate> > OPTLYNotificationHolder;
+typedef void (^ActivateListener)(OPTLYExperiment * _Nonnull experiment,
+                                 NSString * _Nonnull userId,
+                                 NSDictionary<NSString *,NSString *> * _Nonnull attributes,
+                                 OPTLYVariation * _Nonnull variation,
+                                 NSDictionary<NSString *,NSObject *> * _Nonnull event);
+
+typedef void (^TrackListener)(NSString * _Nonnull eventKey,
+                              NSString * _Nonnull userId,
+                              NSDictionary<NSString *,NSString *> * _Nonnull attributes,
+                              NSDictionary * _Nonnull eventTags,
+                              NSDictionary<NSString *,NSObject *> * _Nonnull event);
+
+typedef void (^GenericListener)(NSArray * _Nonnull args);
+
+typedef NSMutableDictionary<NSNumber *, GenericListener > OPTLYNotificationHolder;
 
 @interface OPTLYNotificationCenter : NSObject
 
@@ -43,20 +56,18 @@ typedef NSMutableDictionary<NSNumber *, id<OPTLYNotificationDelegate> > OPTLYNot
 /**
  * Add an activate notification listener to the notification center.
  *
- * @param type - enum OPTLYNotificationType to add.
  * @param activateListener - Notification to add.
  * @return the notification id used to remove the notification. It is greater than 0 on success.
  */
-- (NSInteger)addNotification:(OPTLYNotificationType)type activateListener:(nonnull id<OPTLYNotificationDelegate>)activateListener;
+- (NSInteger)addActivateNotificationListener:(nonnull ActivateListener)activateListener;
 
 /**
  * Add a track notification listener to the notification center.
  *
- * @param type - enum OPTLYNotificationType to add.
  * @param trackListener - Notification to add.
  * @return the notification id used to remove the notification. It is greater than 0 on success.
  */
-- (NSInteger)addNotification:(OPTLYNotificationType)type trackListener:(nonnull id<OPTLYNotificationDelegate>)trackListener;
+- (NSInteger)addTrackNotificationListener:(TrackListener _Nonnull )trackListener;
 
 /**
  * Remove the notification listener based on the notificationId passed back from addNotification.

OptimizelySDKCore/OptimizelySDKCore/OPTLYNotificationCenter.h

@@ -20,7 +20,6 @@
 #import "OPTLYExperiment.h"
 #import "OPTLYVariation.h"
 #import <objc/runtime.h>
-#import "OPTLYNotificationDelegate.h"
 
 @interface OPTLYNotificationCenter()
 
@@ -56,16 +55,12 @@ -(NSUInteger)notificationsCount {
     return notificationsCount;
 }
 
-- (NSInteger)addNotification:(OPTLYNotificationType)type activateListener:(id<OPTLYNotificationDelegate>)activateListener {
-    if (![self isNotificationTypeValid:type expectedNotificationType:OPTLYNotificationTypeActivate])
-        return 0;
-    return [self addNotification:type listener:activateListener];
+- (NSInteger)addActivateNotificationListener:(ActivateListener)activateListener {
+    return [self addNotification:OPTLYNotificationTypeActivate listener:(GenericListener) activateListener];
 }
 
-- (NSInteger)addNotification:(OPTLYNotificationType)type trackListener:(id<OPTLYNotificationDelegate>)trackListener {
-    if (![self isNotificationTypeValid:type expectedNotificationType:OPTLYNotificationTypeTrack])
-        return 0;
-    return [self addNotification:type listener:trackListener];
+- (NSInteger)addTrackNotificationListener:(TrackListener)trackListener {
+    return [self addNotification:OPTLYNotificationTypeTrack listener:(GenericListener)trackListener];
 }
 
 - (BOOL)removeNotification:(NSUInteger)notificationId {
@@ -91,12 +86,18 @@ - (void)clearAllNotifications {
 
 - (void)sendNotifications:(OPTLYNotificationType)type args:(NSArray *)args {
     OPTLYNotificationHolder *notification = _notifications[@(type)];
-    for (id<OPTLYNotificationDelegate> object in notification.allValues) {
+    for (GenericListener listener in notification.allValues) {
         @try {
-            if (type == OPTLYNotificationTypeActivate)
-                [self invokeSelector:object selector:@selector(onActivate:userId:attributes:variation:event:) arguments:args];
-            else
-                [self invokeSelector:object selector:@selector(onTrack:userId:attributes:eventTags:event:) arguments:args];
+            switch (type) {
+                case OPTLYNotificationTypeActivate:
+                    [self notifyActivateListener:((ActivateListener) listener) args:args];
+                    break;
+                case OPTLYNotificationTypeTrack:
+                    [self notifyTrackListener:((TrackListener) listener) args:args];
+                    break;
+                default:
+                    listener(args);
+            }
         } @catch (NSException *exception) {
             NSString *logMessage = [NSString stringWithFormat:@"Problem calling notify callback. Error: %@", exception.reason];
             [_config.logger logMessage:logMessage withLevel:OptimizelyLogLevelError];
@@ -106,15 +107,15 @@ - (void)sendNotifications:(OPTLYNotificationType)type args:(NSArray *)args {
 
 #pragma mark - Private Methods
 
-- (NSInteger)addNotification:(OPTLYNotificationType)type listener:(id<OPTLYNotificationDelegate>)listener {
+- (NSInteger)addNotification:(OPTLYNotificationType)type listener:(GenericListener)listener {
     NSNumber *notificationTypeNumber = [NSNumber numberWithUnsignedInteger:type];
     NSNumber *notificationIdNumber = [NSNumber numberWithUnsignedInteger:_notificationId];
     OPTLYNotificationHolder *notificationHoldersList = _notifications[notificationTypeNumber];
 
     if (![_notifications.allKeys containsObject:notificationTypeNumber] || notificationHoldersList.count == 0) {
         notificationHoldersList[notificationIdNumber] = listener;
     } else {
-        for (id<OPTLYNotificationDelegate> notificationListener in notificationHoldersList.allValues) {
+        for (GenericListener notificationListener in notificationHoldersList.allValues) {
             if (notificationListener == listener) {
                 [_config.logger logMessage:@"The notification callback already exists." withLevel:OptimizelyLogLevelError];
                 return -1;
@@ -126,39 +127,66 @@ - (NSInteger)addNotification:(OPTLYNotificationType)type listener:(id<OPTLYNotif
     return _notificationId++;
 }
 
-- (BOOL)isNotificationTypeValid:(OPTLYNotificationType)notificationType expectedNotificationType:(OPTLYNotificationType)expectedNotificationType {
-    if (notificationType != expectedNotificationType) {
-        NSString *logMessage = [NSString stringWithFormat:@"Invalid notification type provided for %lu listener.", (unsigned long)expectedNotificationType];
+- (void)notifyActivateListener:(ActivateListener)listener args:(NSArray *)args {
+    
+    if(args.count < 5) {
+        NSString *logMessage = [NSString stringWithFormat:@"Not enough arguments to call %@ for notification callback.", listener];
         [_config.logger logMessage:logMessage withLevel:OptimizelyLogLevelError];
-        return NO;
+        return; // Not enough arguments in the array
     }
-    return YES;
+    
+    OPTLYExperiment *experiment = (OPTLYExperiment *)args[0];
+    assert(experiment);
+    assert([experiment isKindOfClass:[OPTLYExperiment class]]);
+    
+    NSString *userId = (NSString *)args[1];
+    assert(userId);
+    assert([userId isKindOfClass:[NSString class]]);
+    
+    NSDictionary *attributes = (NSDictionary *)args[2];
+    assert(attributes);
+    assert([attributes isKindOfClass:[NSDictionary class]]);
+    
+    OPTLYVariation *variation = (OPTLYVariation *)args[3];
+    assert(variation);
+    assert([variation isKindOfClass:[OPTLYVariation class]]);
+    
+    NSDictionary *logEvent = (NSDictionary *)args[4];
+    assert(logEvent);
+    assert([logEvent isKindOfClass:[NSDictionary class]]);
+    
+    listener(experiment, userId, attributes, variation, logEvent);
 }
 
-- (void)invokeSelector:(id)object selector:(SEL)selector arguments:(NSArray *)arguments {
-    Method method = class_getInstanceMethod([object class], selector);
-    int argumentCount = method_getNumberOfArguments(method);
+- (void)notifyTrackListener:(TrackListener)listener args:(NSArray *)args {
 
-    // The first two arguments are the hidden arguments self and _cmd
-    int hiddenArguments = 2;
-    
-    if(argumentCount > [arguments count] + hiddenArguments) {
-        NSString *logMessage = [NSString stringWithFormat:@"Not enough arguments to call %@ for notification Delegate.", object];
+    if(args.count < 5) {
+        NSString *logMessage = [NSString stringWithFormat:@"Not enough arguments to call %@ for notification callback.", listener];
         [_config.logger logMessage:logMessage withLevel:OptimizelyLogLevelError];
         return; // Not enough arguments in the array
     }
 
-    NSMethodSignature *signature = [object methodSignatureForSelector:selector];
-    NSInvocation *invocation = [NSInvocation invocationWithMethodSignature:signature];
-    [invocation setTarget:object];
-    [invocation setSelector:selector];
+    NSString *eventKey = (NSString *)args[0];
+    assert(eventKey);
+    assert([eventKey isKindOfClass:[NSString class]]);
 
-    for(int i=0; i<[arguments count]; i++) {
-        id arg = [arguments objectAtIndex:i];
-        [invocation setArgument:&arg atIndex:i+hiddenArguments];
-    }
+    NSString *userId = (NSString *)args[1];
+    assert(userId);
+    assert([userId isKindOfClass:[NSString class]]);
+    
+    NSDictionary *attributes = (NSDictionary *)args[2];
+    assert(attributes);
+    assert([attributes isKindOfClass:[NSDictionary class]]);
+    
+    NSDictionary *eventTags = (NSDictionary *)args[3];
+    assert(eventTags);
+    assert([eventTags isKindOfClass:[NSDictionary class]]);
+    
+    NSDictionary *logEvent = (NSDictionary *)args[4];
+    assert(logEvent);
+    assert([logEvent isKindOfClass:[NSDictionary class]]);
 
-    [invocation invoke]; // Invoke the selector
+    listener(eventKey, userId, attributes, eventTags, logEvent);
 }
 
 @end

OptimizelySDKCore/OptimizelySDKCore/OPTLYNotificationCenter.m

@@ -51,7 +51,6 @@
 #import "OPTLYLoggerMessages.h"
 #import "OPTLYNetworkService.h"
 #import "OPTLYNotificationCenter.h"
-#import "OPTLYNotificationDelegate.h"
 #import "OPTLYProjectConfig.h"
 #import "OPTLYProjectConfigBuilder.h"
 #import "OPTLYQueue.h"