Add Click Action handler for outcomes

Jeasmine · Jeasmine · commit 977e300f90bc · 2020-05-29T21:19:06.000-03:00
* If the user sends and outcome from the click action handler callback, that outcome should be DIRECT influenced by IAM
  * DIRECT influences by IAM can be from click action handler or click action outcome
  * Reset and cache indirect state to avoid direct being the last cached state
diff --git a/iOS_SDK/OneSignalSDK/Source/OSChannelTracker.m b/iOS_SDK/OneSignalSDK/Source/OSChannelTracker.m
@@ -79,6 +79,7 @@ - (void)resetAndInitInfluence {
     _indirectIds = [self lastReceivedIds];
     _influenceType = _indirectIds != nil && _indirectIds.count > 0 ? INDIRECT : UNATTRIBUTED;
     
+    [self cacheState];
     [OneSignal onesignal_Log:ONE_S_LL_DEBUG message:[NSString stringWithFormat:@"OSChannelTracker resetAndInitInfluence for: %@ finish with influenceType: %@", [self idTag], OS_INFLUENCE_TYPE_TO_STRING(_influenceType)]];
 }
 
diff --git a/iOS_SDK/OneSignalSDK/Source/OSInAppMessageTracker.m b/iOS_SDK/OneSignalSDK/Source/OSInAppMessageTracker.m
@@ -89,5 +89,4 @@ - (void)cacheState {
     [self.dataRepository cacheIAMInfluenceType:self.influenceType];
 }
 
-
 @end
diff --git a/iOS_SDK/OneSignalSDK/Source/OSMessagingController.m b/iOS_SDK/OneSignalSDK/Source/OSMessagingController.m
@@ -437,7 +437,9 @@ - (id)getTriggerValueForKey:(NSString *)key {
 - (void)messageViewControllerWasDismissed {
     @synchronized (self.messageDisplayQueue) {
         [OneSignal onesignal_Log:ONE_S_LL_VERBOSE message:@"Dismissing IAM and preparing to show next IAM"];
-        
+        // Remove DIRECT influence due to ClickHandler of ClickAction outcomes
+        [OneSignal.sessionManager onDirectInfluenceFromIAMClickFinished];
+
         // Add current dismissed messageId to seenInAppMessages set and save it to NSUserDefaults
         if (self.isInAppMessageShowing) {
             OSInAppMessage *showingIAM = self.messageDisplayQueue.firstObject;
@@ -569,8 +571,11 @@ - (void)messageViewDidSelectAction:(OSInAppMessage *)message withAction:(OSInApp
     if (action.promptActions && action.promptActions.count > 0)
         [self handlePromptActions:action.promptActions withMessage:message];
 
-    if (self.actionClickBlock)
+    if (self.actionClickBlock) {
+        // Any outcome sent on this callback should count as DIRECT from this IAM
+        [OneSignal.sessionManager onDirectInfluenceFromIAMClick:message.messageId];
         self.actionClickBlock(action);
+    }
     
     if (message.isPreview) {
         [self processPreviewInAppMessage:message withAction:action];
diff --git a/iOS_SDK/OneSignalSDK/Source/OSSessionManager.m b/iOS_SDK/OneSignalSDK/Source/OSSessionManager.m
@@ -93,7 +93,6 @@ - (void)onInAppMessageReceived:(NSString *)messageId {
     
     OSChannelTracker *inAppMessageTracker = [_trackerFactory iamChannelTracker];
     [inAppMessageTracker saveLastId:messageId];
-    [inAppMessageTracker resetAndInitInfluence];
 }
 
 - (void)onDirectInfluenceFromIAMClick:(NSString *)directIAMId {
diff --git a/iOS_SDK/OneSignalSDK/Source/OneSignalOutcomeEventsController.m b/iOS_SDK/OneSignalSDK/Source/OneSignalOutcomeEventsController.m
@@ -84,8 +84,6 @@ - (void)sendClickActionOutcomes:(NSArray<OSInAppMessageOutcome *> *)outcomes
         else
             [self sendOutcomeEvent:name appId:appId deviceType:deviceType successBlock:nil];
     }
-    // Requests are sent or cached at this point
-    [_sessionManager onDirectInfluenceFromIAMClickFinished];
 }
 
 - (void)sendUniqueOutcomeEvent:(NSString * _Nonnull)name
diff --git a/iOS_SDK/OneSignalSDK/UnitTests/InAppMessagingIntegrationTests.m b/iOS_SDK/OneSignalSDK/UnitTests/InAppMessagingIntegrationTests.m
@@ -95,7 +95,9 @@ - (void)setUp {
 - (void)tearDown {
     // Wait for IAM viewDidLoad if available to not conflict with other tests
     [UnitTestCommonMethods runBackgroundThreads];
-    
+    [OneSignal setInAppMessageClickHandler:nil];
+    [OneSignal pauseInAppMessages:true];
+
     OneSignalOverrider.shouldOverrideSessionLaunchTime = false;
     
     [OSMessagingController.sharedInstance resetState];
@@ -877,6 +879,98 @@ - (void)testIAMClickedLaunchesOutcomeWithValueAPIV2Request {
     XCTAssertEqual(outcomeWeight, [[OneSignalClientOverrider.lastHTTPRequest objectForKey:@"weight"] intValue]);
 }
 
+- (void)testIAMClickedLaunchesClickHandlerSendDirectOutcomeV2Request {
+    [self setOutcomesParamsEnabled];
+    [self setOutcomesV2Enabled];
+
+    let firstTrigger = [OSTrigger customTriggerWithProperty:@"testProp" withOperator:OSTriggerOperatorTypeExists withValue:nil];
+
+    OSInAppMessage * message = [OSInAppMessageTestHelper testMessageWithTriggers:@[@[firstTrigger]]];
+
+    [self initOneSignalWithInAppMessage:message];
+    
+    XCTAssertEqual(0, OSMessagingControllerOverrider.messageDisplayQueue.count);
+
+    __block OSInAppMessageAction *actionReceived = nil;
+    id inAppMessagingActionClickBlock = ^(OSInAppMessageAction *action) {
+        actionReceived = action;
+
+        [OneSignal sendOutcome:@"test"];
+        [UnitTestCommonMethods runBackgroundThreads];
+
+        // The action should cause an "outcome" API request
+        XCTAssertEqualObjects(OneSignalClientOverrider.lastUrl, @"https://api.onesignal.com/outcomes/measure_sources");
+        XCTAssertEqualObjects(OneSignalClientOverrider.lastHTTPRequestType, NSStringFromClass([OSRequestSendOutcomesV2ToServer class]));
+        id source = [OneSignalClientOverrider.lastHTTPRequest objectForKey:@"sources"];
+        id directBody = [source objectForKey:@"direct"];
+        id indirectBody = [source objectForKey:@"indirect"];
+        id iamIds = [directBody objectForKey:@"in_app_message_ids"];
+        XCTAssertEqual(1, [iamIds count]);
+        XCTAssertNil(indirectBody);
+        XCTAssertNil([OneSignalClientOverrider.lastHTTPRequest objectForKey:@"weight"]);
+    };
+    [OneSignal setInAppMessageClickHandler:inAppMessagingActionClickBlock];
+    
+    [OneSignal addTrigger:@"testProp" withValue:@2];
+    [UnitTestCommonMethods runBackgroundThreads];
+    // the message should now be displayed
+    // simulate a button press (action) on the inapp message
+    let action = [OSInAppMessageAction instanceWithJson: OSInAppMessageTestHelper.testActionJson];
+    [OSMessagingController.sharedInstance messageViewDidSelectAction:message withAction:action];
+
+    XCTAssertNotNil(actionReceived);
+}
+
+- (void)testIAMClickedLaunchesClickHandlerDismissIAMSendIndirectOutcomeV2Request {
+    [OneSignal pauseInAppMessages:false];
+    [self setOutcomesParamsEnabled];
+    [self setOutcomesV2Enabled];
+
+    let firstTrigger = [OSTrigger customTriggerWithProperty:@"testProp" withOperator:OSTriggerOperatorTypeExists withValue:nil];
+
+    OSInAppMessage * message = [OSInAppMessageTestHelper testMessageWithTriggers:@[@[firstTrigger]]];
+
+    [self initOneSignalWithInAppMessage:message];
+
+    XCTAssertEqual(0, OSMessagingControllerOverrider.messageDisplayQueue.count);
+
+    // Check no influence id saved
+    NSArray *lastReceivedIds = [[[[OSTrackerFactory alloc] init] iamChannelTracker] lastReceivedIds];
+    XCTAssertEqual(lastReceivedIds.count, 0);
+
+    __block OSInAppMessageAction *actionReceived = nil;
+    id inAppMessagingActionClickBlock = ^(OSInAppMessageAction *action) {
+        actionReceived = action;
+    };
+    [OneSignal setInAppMessageClickHandler:inAppMessagingActionClickBlock];
+
+    [OneSignal addTrigger:@"testProp" withValue:@2];
+    [UnitTestCommonMethods runBackgroundThreads];
+
+    // the message should now be displayed
+    // simulate a button press (action) on the inapp message
+    let action = [OSInAppMessageAction instanceWithJson: OSInAppMessageTestHelper.testActionJson];
+    [OSMessagingController.sharedInstance messageViewDidSelectAction:message withAction:action];
+
+    XCTAssertNotNil(actionReceived);
+
+    [OSMessagingControllerOverrider dismissCurrentMessage];
+
+    [OneSignal sendOutcome:@"test"];
+    [UnitTestCommonMethods runBackgroundThreads];
+
+    // The action should cause an "outcome" API request
+    XCTAssertEqualObjects(OneSignalClientOverrider.lastUrl, @"https://api.onesignal.com/outcomes/measure_sources");
+    XCTAssertEqualObjects(OneSignalClientOverrider.lastHTTPRequestType, NSStringFromClass([OSRequestSendOutcomesV2ToServer class]));
+    id source = [OneSignalClientOverrider.lastHTTPRequest objectForKey:@"sources"];
+    id directBody = [source objectForKey:@"direct"];
+    id indirectBody = [source objectForKey:@"indirect"];
+    id iamIds = [indirectBody objectForKey:@"in_app_message_ids"];
+    XCTAssertEqual(1, [iamIds count]);
+    XCTAssertNil(directBody);
+    XCTAssertNil([OneSignalClientOverrider.lastHTTPRequest objectForKey:@"weight"]);
+}
+
 - (void)testIAMClickedLaunchesMultipleOutcomesAPIRequest {
     [self setOutcomesParamsEnabled];
 
diff --git a/iOS_SDK/OneSignalSDK/UnitTests/OutcomeIntegrationV2Tests.m b/iOS_SDK/OneSignalSDK/UnitTests/OutcomeIntegrationV2Tests.m
@@ -654,8 +654,10 @@ - (void)testSendingOutcome_inIAMIndirectSession {
     // 2. Receive 2 iam
     [[OneSignal sessionManager] onInAppMessageReceived:@"test_in_app_message_1"];
     [[OneSignal sessionManager] onInAppMessageReceived:@"test_in_app_message_2"];
+    // 3. Dismiss iam
+    [[OneSignal sessionManager] onDirectInfluenceFromIAMClickFinished];
     
-    // 3. Validate IN_APP_MESSAGE influence is INDIRECT and send 2 outcomes
+    // 4. Validate IN_APP_MESSAGE influence is INDIRECT and send 2 outcomes
     let sessionInfluences = [OneSignal.sessionManager getInfluences];
     for (OSInfluence *influence in sessionInfluences) {
         switch (influence.influenceChannel) {
@@ -672,7 +674,7 @@ - (void)testSendingOutcome_inIAMIndirectSession {
     [OneSignal sendOutcome:@"normal_1"];
     [OneSignal sendOutcome:@"normal_2"];
     
-    // 6. Make sure 2 measure requests were made with correct params
+    // 5. Make sure 2 measure requests were made with correct params
     [RestClientAsserts assertMeasureSourcesAtIndex:2 payload:@{
         @"sources": @{
                 @"indirect": @{
@@ -731,8 +733,10 @@ - (void)testSendingOutcomeWithValue_inIAMIndirectSession {
     // 2. Receive 2 iam
     [[OneSignal sessionManager] onInAppMessageReceived:@"test_in_app_message_1"];
     [[OneSignal sessionManager] onInAppMessageReceived:@"test_in_app_message_2"];
+    // 3. Dismiss iam
+    [[OneSignal sessionManager] onDirectInfluenceFromIAMClickFinished];
     
-    // 3. Validate IN_APP_MESSAGE influence is INDIRECT and send 2 outcomes
+    // 4. Validate IN_APP_MESSAGE influence is INDIRECT and send 2 outcomes
     let sessionInfluences = [OneSignal.sessionManager getInfluences];
     for (OSInfluence *influence in sessionInfluences) {
         switch (influence.influenceChannel) {
@@ -751,7 +755,7 @@ - (void)testSendingOutcomeWithValue_inIAMIndirectSession {
     let val2 = [NSNumber numberWithDouble:9.95];
     [OneSignal sendOutcomeWithValue:@"value_2" value:val2];
 
-    // 6. Make sure 2 measure requests were made with correct params
+    // 5. Make sure 2 measure requests were made with correct params
     [RestClientAsserts assertMeasureSourcesAtIndex:2 payload:@{
         @"sources": @{
                 @"indirect": @{
diff --git a/iOS_SDK/OneSignalSDK/UnitTests/OutcomeTests.m b/iOS_SDK/OneSignalSDK/UnitTests/OutcomeTests.m
@@ -185,7 +185,7 @@ - (void)testUnattributedSessionToIndirectSession {
         XCTAssertEqual(influence.ids, nil);
     }
     
-    // 4. Rceive 3 notifications
+    // 4. Receive 3 notifications
     [sessionManager onNotificationReceived:testNotificationId];
     [sessionManager onNotificationReceived:testNotificationId];
     [sessionManager onNotificationReceived:testNotificationId];
diff --git a/iOS_SDK/OneSignalSDK/UnitTests/OutcomeV2Tests.m b/iOS_SDK/OneSignalSDK/UnitTests/OutcomeV2Tests.m
@@ -115,8 +115,10 @@ - (void)testIAMIndirectSession {
     // 2. Receive 2 iam
     [sessionManager onInAppMessageReceived:testInAppMessageId];
     [sessionManager onInAppMessageReceived:testGenericId];
+    // 3. Dismiss iam
+    [sessionManager onDirectInfluenceFromIAMClickFinished];
     
-    // 3. Make sure IN_APP_MESSAGE influence is INDIRECT and has 3 notifications
+    // 4. Make sure IN_APP_MESSAGE influence is INDIRECT and has 3 notifications
     let sessionInfluences = [sessionManager getInfluences];
     for (OSInfluence *influence in sessionInfluences) {
         switch (influence.influenceChannel) {
@@ -140,8 +142,10 @@ - (void)testIAMIndirectSessionWithRedisplay {
     [sessionManager onInAppMessageReceived:testInAppMessageId];
     [sessionManager onInAppMessageReceived:testGenericId];
     [sessionManager onInAppMessageReceived:testInAppMessageId];
+    // 3. Dismiss iam
+    [sessionManager onDirectInfluenceFromIAMClickFinished];
     
-    // 3. Make sure IN_APP_MESSAGE influence is INDIRECT and has 3 notifications
+    // 4. Make sure IN_APP_MESSAGE influence is INDIRECT and has 3 notifications
     let sessionInfluences = [sessionManager getInfluences];
     for (OSInfluence *influence in sessionInfluences) {
         switch (influence.influenceChannel) {
@@ -195,10 +199,12 @@ - (void)testUnattributedSessionToIndirectSession {
         XCTAssertEqual(influence.ids, nil);
     }
     
-    // 4. Rceive 3 notifications
+    // 4. Receive 3 notifications
     [sessionManager onInAppMessageReceived:testInAppMessageId];
+    // 5. Dismiss iam
+    [sessionManager onDirectInfluenceFromIAMClickFinished];
     
-    // 5. Make sure IN_APP_MESSAGE influence is INDIRECT and has 1 iam
+    // 6. Make sure IN_APP_MESSAGE influence is INDIRECT and has 1 iam
     sessionInfluences = [sessionManager getInfluences];
     for (OSInfluence *influence in sessionInfluences) {
         switch (influence.influenceChannel) {
@@ -219,8 +225,10 @@ - (void)testIndirectSessionWithIAMInfluence_overrideIndirectSession_withoutNewSe
     
     // 2. Receive a notification
     [sessionManager onInAppMessageReceived:testInAppMessageId];
+    // 3. Dismiss iam
+    [sessionManager onDirectInfluenceFromIAMClickFinished];
     
-    // 3. Make sure IN_APP_MESSAGE influence is INDIRECT and has 1 iam
+    // 4. Make sure IN_APP_MESSAGE influence is INDIRECT and has 1 iam
     NSArray<OSInfluence *> *sessionInfluences = [sessionManager getInfluences];
     for (OSInfluence *influence in sessionInfluences) {
         switch (influence.influenceChannel) {
@@ -234,11 +242,13 @@ - (void)testIndirectSessionWithIAMInfluence_overrideIndirectSession_withoutNewSe
         }
     }
     
-    // 4. Receive 2 more iams
+    // 5. Receive 2 more iams
     [sessionManager onInAppMessageReceived:testNotificationId];
     [sessionManager onInAppMessageReceived:testGenericId];
-
-    // 5. Make sure IN_APP_MESSAGE influence is INDIRECT and has 3 iams because IAM influence does not depend on session
+    // 6. Dismiss iam
+    [sessionManager onDirectInfluenceFromIAMClickFinished];
+    
+    // 7. Make sure IN_APP_MESSAGE influence is INDIRECT and has 3 iams because IAM influence does not depend on session
     sessionInfluences = [sessionManager getInfluences];
     for (OSInfluence *influence in sessionInfluences) {
         switch (influence.influenceChannel) {
@@ -284,8 +294,10 @@ - (void)testIndirectSessionToDirectSession {
     // 2. Receive 2 notifications
     [sessionManager onInAppMessageReceived:testInAppMessageId];
     [sessionManager onInAppMessageReceived:testGenericId];
-
-    // 3. Make sure IN_APP_MESSAGE influence is INDIRECT and has 2 iam
+    // 4. Dismiss iam
+    [sessionManager onDirectInfluenceFromIAMClickFinished];
+    
+    // 5. Make sure IN_APP_MESSAGE influence is INDIRECT and has 2 iam
     NSArray<OSInfluence *> *sessionInfluences = [sessionManager getInfluences];
     for (OSInfluence *influence in sessionInfluences) {
         switch (influence.influenceChannel) {
@@ -299,11 +311,11 @@ - (void)testIndirectSessionToDirectSession {
         }
     }
     
-    // 5. Receive a notification and open it
+    // 6. Receive a notification and open it
     [sessionManager onInAppMessageReceived:testNotificationId];
     [sessionManager onDirectInfluenceFromIAMClick:testNotificationId];
 
-    // 6. Make sure IN_APP_MESSAGE influence is DIRECT and has 1 iam
+    // 7. Make sure IN_APP_MESSAGE influence is DIRECT and has 1 iam
     sessionInfluences = [sessionManager getInfluences];
     for (OSInfluence *influence in sessionInfluences) {
         switch (influence.influenceChannel) {
diff --git a/iOS_SDK/OneSignalSDK/UnitTests/SessionManagerTests.m b/iOS_SDK/OneSignalSDK/UnitTests/SessionManagerTests.m
@@ -318,6 +318,7 @@ - (void)testSessionUpgradeFromUnattributedToIndirect {
 
     [sessionManager onNotificationReceived:testGenericId];
     [sessionManager onInAppMessageReceived:testGenericId];
+    [sessionManager onDirectInfluenceFromIAMClickFinished];
     
     [sessionManager attemptSessionUpgrade:APP_OPEN];
 
@@ -350,6 +351,7 @@ - (void)testSessionUpgradeFromUnattributedToDirectNotification {
 
     [sessionManager onNotificationReceived:testGenericId];
     [sessionManager onInAppMessageReceived:testGenericId];
+    [sessionManager onDirectInfluenceFromIAMClickFinished];
     [sessionManager onDirectInfluenceFromNotificationOpen:NOTIFICATION_CLICK withNotificationId:testGenericId];
 
     iamInfluence = [[trackerFactory iamChannelTracker] currentSessionInfluence];
@@ -511,6 +513,7 @@ - (void)testRestartSessionIfNeededFromOpen {
     [self setOutcomesParamsEnabled];
 
     [sessionManager onInAppMessageReceived:testIAMId];
+    [sessionManager onDirectInfluenceFromIAMClickFinished];
     [sessionManager onNotificationReceived:testNotificationId];
 
     [sessionManager restartSessionIfNeeded:APP_OPEN];
@@ -528,6 +531,7 @@ - (void)testRestartSessionIfNeededFromClose {
     [self setOutcomesParamsEnabled];
 
     [sessionManager onInAppMessageReceived:testIAMId];
+    [sessionManager onDirectInfluenceFromIAMClickFinished];
     [sessionManager onNotificationReceived:testNotificationId];
 
     [sessionManager restartSessionIfNeeded:APP_CLOSE];

Original file line number	Diff line number	Diff line change
`@@ -79,6 +79,7 @@ - (void)resetAndInitInfluence {`
`79`	`79`	`_indirectIds = [self lastReceivedIds];`
`80`	`80`	`_influenceType = _indirectIds != nil && _indirectIds.count > 0 ? INDIRECT : UNATTRIBUTED;`
`81`	`81`
	`82`	`+ [self cacheState];`
`82`	`83`	`[OneSignal onesignal_Log:ONE_S_LL_DEBUG message:[NSString stringWithFormat:@"OSChannelTracker resetAndInitInfluence for: %@ finish with influenceType: %@", [self idTag], OS_INFLUENCE_TYPE_TO_STRING(_influenceType)]];`
`83`	`84`	`}`
`84`	`85`
Original file line number	Diff line number	Diff line change
`@@ -89,5 +89,4 @@ - (void)cacheState {`
`89`	`89`	`[self.dataRepository cacheIAMInfluenceType:self.influenceType];`
`90`	`90`	`}`
`91`	`91`
`92`		`-`
`93`	`92`	`@end`
Original file line number	Diff line number	Diff line change
`@@ -93,7 +93,6 @@ - (void)onInAppMessageReceived:(NSString *)messageId {`
`93`	`93`
`94`	`94`	`OSChannelTracker *inAppMessageTracker = [_trackerFactory iamChannelTracker];`
`95`	`95`	`[inAppMessageTracker saveLastId:messageId];`
`96`		`- [inAppMessageTracker resetAndInitInfluence];`
`97`	`96`	`}`
`98`	`97`
`99`	`98`	`- (void)onDirectInfluenceFromIAMClick:(NSString *)directIAMId {`
Original file line number	Diff line number	Diff line change
`@@ -84,8 +84,6 @@ - (void)sendClickActionOutcomes:(NSArray<OSInAppMessageOutcome > )outcomes`
`84`	`84`	`else`
`85`	`85`	`[self sendOutcomeEvent:name appId:appId deviceType:deviceType successBlock:nil];`
`86`	`86`	`}`
`87`		`- // Requests are sent or cached at this point`
`88`		`- [_sessionManager onDirectInfluenceFromIAMClickFinished];`
`89`	`87`	`}`
`90`	`88`
`91`	`89`	`- (void)sendUniqueOutcomeEvent:(NSString * _Nonnull)name`
Original file line number	Diff line number	Diff line change
`@@ -185,7 +185,7 @@ - (void)testUnattributedSessionToIndirectSession {`
`185`	`185`	`XCTAssertEqual(influence.ids, nil);`
`186`	`186`	`}`
`187`	`187`
`188`		`- // 4. Rceive 3 notifications`
	`188`	`+ // 4. Receive 3 notifications`
`189`	`189`	`[sessionManager onNotificationReceived:testNotificationId];`
`190`	`190`	`[sessionManager onNotificationReceived:testNotificationId];`
`191`	`191`	`[sessionManager onNotificationReceived:testNotificationId];`