[SDK-446] onRunActionNamed (#441)

Author: nzagorchev

Example/Tests/Classes/LPActionContextTest.m

@@ -135,4 +135,32 @@ - (void)test_asciiEncodedFileURL {
     XCTAssert([encodedUrl isEqualToString:@"file:///Users/mayank/Library/Developer/CoreSimulator/Devices/24394C0B-8820-4369-B3AA-9BF26F62A798/data/Containers/Data/Application/29AF4C33-1C94-46DF-A8A5-4B4CD5A3A364/Library/Caches/Leanplum_Resources/lp_public_sf_ui_font.css"]);
 }
 
+- (void)test_setActionNamedResponder {
+    NSString *acceptAction = @"Accept action";
+    NSDictionary *args = @{
+        acceptAction: @"Test"
+    };
+    
+    LPActionContext *messageContext = [LPActionContext
+                                actionContextWithName:@"action"
+                                args:args
+                                messageId:@"1"];
+    
+    XCTestExpectation *onRunActionNamedExpectation = [self expectationWithDescription:@"onRunActionNamedExpectation"];
+    
+    __weak LPActionContext *weakMessageContext = messageContext;
+    
+    [messageContext setActionNamedResponder:^BOOL(LPActionContext * _Nonnull context) {
+        XCTAssertEqual([context actionName], acceptAction);
+        XCTAssertNotNil([context parentContext]);
+        XCTAssertEqual([[context parentContext] actionName], [weakMessageContext actionName]);
+        XCTAssertEqual([[context parentContext] messageId], [weakMessageContext messageId]);
+        [onRunActionNamedExpectation fulfill];
+        return YES;
+    }];
+    [messageContext runActionNamed:acceptAction];
+    
+    [self waitForExpectationsWithTimeout:6 handler:nil];
+}
+
 @end

Example/Tests/Classes/LeanplumTest.m

@@ -64,6 +64,12 @@ + (void)trackGeofence:(LPGeofenceEventType *)event withValue:(double)value andIn
 
 @end
 
+@interface LPActionContext (Test)
+
+@property(strong, nonatomic) LeanplumActionBlock actionNamedResponder;
+
+@end
+
 @interface LeanplumTest : XCTestCase
 
 @end
@@ -2407,4 +2413,66 @@ - (void) test_forceContentUpdateVariants
     XCTAssertTrue([[LPVarCache sharedCache] variants].count == 4);
 }
 
+- (void)test_onAction {
+    NSString *actionName = @"TestAction";
+    LPActionContext *context = [LPActionContext
+                                actionContextWithName:actionName
+                                args:nil
+                                messageId:@"1"];
+    
+    XCTestExpectation *onActionExpectation = [self expectationWithDescription:@"onActionExpectation"];
+    
+    [Leanplum onAction:actionName invoke:^BOOL(LPActionContext * _Nonnull context) {
+        XCTAssertEqual([context actionName], actionName);
+        [onActionExpectation fulfill];
+        return NO;
+    }];
+    [Leanplum triggerAction:context];
+    
+    [self waitForExpectationsWithTimeout:6 handler:nil];
+}
+
+/**
+ * Leanplum triggerAction uses the same context instance to call all LeanplumActionBlock responders
+ * Those include the defineAction:actionResponder and the onAction:actionResponder blocks
+ */
+- (void)test_onAction_sameContext {
+    NSString *actionName = @"TestAction";
+    LPActionContext *messageContext = [LPActionContext
+                                actionContextWithName:actionName
+                                args:nil
+                                messageId:@"1"];
+    
+    __weak LPActionContext *weakContext = messageContext;
+    
+    XCTestExpectation *onActionExpectation = [self expectationWithDescription:@"onActionExpectation"];
+    
+    [Leanplum onAction:actionName invoke:^BOOL(LPActionContext * _Nonnull context) {
+        XCTAssertEqual(context, weakContext);
+        
+        [context setActionNamedResponder:^BOOL(LPActionContext * _Nonnull context) {
+            return NO;
+        }];
+        
+        [onActionExpectation fulfill];
+        return NO;
+    }];
+    
+    XCTestExpectation *onActionExpectation2 = [self expectationWithDescription:@"onActionExpectation2"];
+    
+    [Leanplum onAction:actionName invoke:^BOOL(LPActionContext * _Nonnull context) {
+        XCTAssertEqual(context, weakContext);
+        
+        // The responder is already set to the context from the previous onAction block
+        XCTAssertNotNil([context actionNamedResponder]);
+        
+        [onActionExpectation2 fulfill];
+        return NO;
+    }];
+    
+    [Leanplum triggerAction:messageContext];
+    
+    [self waitForExpectationsWithTimeout:6 handler:nil];
+}
+
 @end

Leanplum-SDK/Classes/Features/Actions/LPActionContext-Internal.h

@@ -6,6 +6,7 @@
 //
 
 #import "LeanplumInternal.h"
+#import "LPActionContext.h"
 
 NS_ASSUME_NONNULL_BEGIN
 
@@ -26,7 +27,6 @@ NS_ASSUME_NONNULL_BEGIN
 @property (readonly, strong) NSString *name;
 @property (readonly, strong) NSString *originalMessageId;
 @property (readonly, strong) NSNumber *priority;
-@property (readonly, strong, nullable) LPActionContext *parentContext;
 @property (readonly) int contentVersion;
 @property (readonly, strong, nullable) NSString *key;
 @property (assign) BOOL preventRealtimeUpdating;

Leanplum-SDK/Classes/Features/Actions/LPActionContext.m

@@ -30,6 +30,7 @@ @interface LPActionContext (PrivateProperties)
 @interface LPActionContext()
 
 @property (nonatomic, strong) LPCountAggregator *countAggregator;
+@property (strong, nonatomic) LeanplumActionBlock actionNamedResponder;
 
 @end
 
@@ -498,6 +499,29 @@ - (NSString *)eventWithParentEventNamesFromEvent:(NSString *)event
     LP_END_TRY
 }
 
+- (void)setActionNamedResponder:(LeanplumActionBlock)block
+{
+    if (block) {
+        _actionNamedResponder = [block copy];
+    } else {
+        _actionNamedResponder = nil;
+    }
+}
+
+- (void)triggerActionNamedResponder:(NSString *)name withArgs:(NSDictionary *)args
+{
+    if ([self actionNamedResponder]) {
+        LPActionContext *actionContext = [LPActionContext
+                                          actionContextWithName:name
+                                          args:args messageId:_messageId];
+        
+        __weak LPActionContext *weakSelf = self;
+        actionContext->_parentContext = weakSelf;
+        
+        self.actionNamedResponder(actionContext);
+    }
+}
+
 - (void)runActionNamed:(NSString *)name
 {
     LP_TRY
@@ -506,6 +530,9 @@ - (void)runActionNamed:(NSString *)name
         return;
     }
     NSDictionary *args = [self getChildArgs:name];
+    
+    [self triggerActionNamedResponder:name withArgs:args];
+    
     if (!args) {
         return;
     }

Leanplum-SDK/Classes/LPActionContext.h

@@ -21,8 +21,8 @@
 //  specific language governing permissions and limitations
 //  under the License.
 
-#import <Foundation/Foundation.h>
 #import <UIKit/UIKit.h>
+#import "Leanplum.h"
 
 NS_ASSUME_NONNULL_BEGIN
 
@@ -41,6 +41,11 @@ NS_SWIFT_NAME(ActionContext)
  */
 @property (readonly, strong, nullable) NSDictionary *args;
 
+/**
+ * The parent ActionContext if present
+ */
+@property (readonly, nonatomic, strong, nullable) LPActionContext *parentContext;
+
 - (id)objectNamed:(NSString *)name
 NS_SWIFT_NAME(object(name:));
 
@@ -77,6 +82,11 @@ NS_SWIFT_NAME(htmlTemplate(name:));
 - (void)runActionNamed:(NSString *)name
 NS_SWIFT_NAME(runAction(name:));
 
+/**
+ * Executes a block when action is run.
+ */
+- (void)setActionNamedResponder:(LeanplumActionBlock)block;
+
 /**
  * Runs and tracks an event for the action given by the "name" key.
  * This will track an event if no action is set.

Leanplum-SDK/Classes/Leanplum.h

@@ -26,7 +26,6 @@
 #import <UserNotifications/UserNotifications.h>
 #import "LPInbox.h"
 #import "LPActionArg.h"
-#import "LPActionContext.h"
 #import "LPVar.h"
 #import "LPMessageArchiveData.h"
 #import "LPEnumConstants.h"
@@ -68,9 +67,6 @@
 #import "LPLogManager.h"
 #import "LPRequestSenderTimer.h"
 
-// Prevent circular reference
-@class LPDeferrableAction;
-
 NS_ASSUME_NONNULL_BEGIN
 
 #define _LP_DEFINE_HELPER(name,val,type) LPVar* name; \
@@ -133,6 +129,8 @@ name = [LPVar define:[@#name stringByReplacingOccurrencesOfString:@"_" withStrin
 }
 /**@}*/
 
+// Prevent circular reference
+@class LPDeferrableAction;
 @class LPActionContext;
 @class SKPaymentTransaction;
 @class NSExtensionContext;

Leanplum-SDK/Classes/MessageTemplates/LPAlertMessageTemplate.m

@@ -7,6 +7,7 @@
 //
 
 #import "LPAlertMessageTemplate.h"
+#import "LPActionContext.h"
 
 @implementation LPAlertMessageTemplate
 

Leanplum-SDK/Classes/MessageTemplates/LPAppRatingMessageTemplate.m

@@ -7,6 +7,7 @@
 //
 
 #import "LPAppRatingMessageTemplate.h"
+#import "LPActionContext.h"
 
 @implementation LPAppRatingMessageTemplate
 

Leanplum-SDK/Classes/MessageTemplates/LPCenterPopupMessageTemplate.m

@@ -7,6 +7,7 @@
 //
 
 #import "LPCenterPopupMessageTemplate.h"
+#import "LPActionContext.h"
 
 @implementation LPCenterPopupMessageTemplate
 

Leanplum-SDK/Classes/MessageTemplates/LPConfirmMessageTemplate.m

@@ -7,6 +7,7 @@
 //
 
 #import "LPConfirmMessageTemplate.h"
+#import "LPActionContext.h"
 
 @implementation LPConfirmMessageTemplate