Exclude features from IAM preview

* Redisplay, tags, outcomes, impression should not be included on IAM preview
OneSignal · Mar 23, 2020 · 70cea7e · 70cea7e
1 parent 02b7060
commit 70cea7e
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 6 deletions.
diff --git a/iOS_SDK/OneSignalSDK/Source/OSInAppMessageOutcome.m b/iOS_SDK/OneSignalSDK/Source/OSInAppMessageOutcome.m
@@ -66,7 +66,7 @@ + (instancetype _Nullable)instancePreviewFromPayload:(OSNotificationPayload * _N
 }
 
 - (NSString *)description {
-    return [NSString stringWithFormat:@"OSInAppMessageOutcome name: %@\nweight: %@unique: %s\n", _name, _weight, _unique ? "YES" : "NO"];
+    return [NSString stringWithFormat:@"OSInAppMessageOutcome name: %@ weight: %@ unique: %s\n", _name, _weight, _unique ? "YES" : "NO"];
 }
 
 @end
diff --git a/iOS_SDK/OneSignalSDK/Source/OSInAppMessageTag.h b/iOS_SDK/OneSignalSDK/Source/OSInAppMessageTag.h
@@ -32,7 +32,7 @@
 #import "OSJSONHandling.h"
 #import "OneSignal.h"
 
-@interface OSInAppMessageTag : NSObject <OSJSONDecodable>
+@interface OSInAppMessageTag : NSObject <OSJSONEncodable, OSJSONDecodable>
 
 @property (strong, nonatomic, nullable) NSDictionary *tagsToAdd;
 @property (strong, nonatomic, nullable) NSArray *tagsToRemove;

diff --git a/iOS_SDK/OneSignalSDK/Source/OSInAppMessageTag.m b/iOS_SDK/OneSignalSDK/Source/OSInAppMessageTag.m
@@ -26,6 +26,7 @@
 */
 
 #import "OSInAppMessageTag.h"
+#import "OneSignalHelper.h"
 
 @implementation OSInAppMessageTag
 
@@ -64,6 +65,18 @@ + (instancetype _Nullable)instancePreviewFromPayload:(OSNotificationPayload * _N
     return nil;
 }
 
+
+- (NSDictionary *)jsonRepresentation {
+    let json = [NSMutableDictionary new];
+
+    if (_tagsToAdd)
+        json[@"adds"] = _tagsToAdd;
+    if (_tagsToRemove)
+        json[@"removes"] = _tagsToRemove;
+
+    return json;
+}
+
 - (NSString *)description {
     return [NSString stringWithFormat:@"OSInAppMessageTag tagsToAdd: %@ \ntagsToRemove: %@", _tagsToAdd, _tagsToRemove];
 }

diff --git a/iOS_SDK/OneSignalSDK/Source/OSMessagingController.m b/iOS_SDK/OneSignalSDK/Source/OSMessagingController.m
@@ -435,6 +435,7 @@ - (void)messageViewControllerWasDismissed {
             OSInAppMessage *showingIAM = self.messageDisplayQueue.firstObject;
             [self.seenInAppMessages addObject:showingIAM.messageId];
             [OneSignalUserDefaults.initStandard saveSetForKey:OS_IAM_SEEN_SET_KEY withValue:self.seenInAppMessages];
+            [OneSignal onesignal_Log:ONE_S_LL_VERBOSE message:[NSString stringWithFormat:@"Dismissing IAM save seenInAppMessages: %@", _seenInAppMessages]];
             // Remove dismissed IAM from messageDisplayQueue
             [self.messageDisplayQueue removeObjectAtIndex:0];
             [self persistInAppMessageForRedisplay:showingIAM];
@@ -477,8 +478,8 @@ - (void)hideWindow {
 }
 
 - (void)persistInAppMessageForRedisplay:(OSInAppMessage *)message {
-    // If the IAM doesn't have the re display prop there is no need to save it
-    if (![message.displayStats isRedisplayEnabled])
+    // If the IAM doesn't have the re display prop or is a preview IAM there is no need to save it
+    if (![message.displayStats isRedisplayEnabled] || message.isPreview)
       return;
 
     let displayTimeSeconds = self.dateGenerator();
@@ -511,6 +512,7 @@ - (void)handlePromptActions:(NSArray<NSObject<OSInAppMessagePrompt> *> *)promptA
         _currentPromptAction.hasPrompted = YES;
         [_currentPromptAction handlePrompt:^(BOOL accepted) {
             _currentPromptAction = nil;
+            [OneSignal onesignal_Log:ONE_S_LL_VERBOSE message:[NSString stringWithFormat:@"IAM prompt to handle finished accepted: %@", accepted ? @"YES" : @"NO"]];
             [self handlePromptActions:promptActions];
         }];
     } else if (!_viewController) { // IAM dismissed by action
@@ -531,11 +533,30 @@ - (void)messageViewDidSelectAction:(OSInAppMessage *)message withAction:(OSInApp
     if (self.actionClickBlock)
         self.actionClickBlock(action);
 
+    if (message.isPreview) {
+        [self processPreviewInAppMessage:message withAction:action];
+        return;
+    }
+
+    // The following features are for non preview IAM
+    // Make sure no click, outcome, tag tracking is performed for IAM previews
     [self sendClickRESTCall:message withAction:action];
     [self sendTagCallWithAction:action];
     [self sendOutcomes:action.outcomes];
 }
 
+/*
+* Show the developer what will happen with a non IAM preview
+ */
+- (void)processPreviewInAppMessage:(OSInAppMessage *)message withAction:(OSInAppMessageAction *)action {
+     if (action.tags)
+        [OneSignal onesignal_Log:ONE_S_LL_VERBOSE message:[NSString stringWithFormat:@"Tags detected inside of the action click payload, ignoring because action came from IAM preview\nTags: %@", action.tags.jsonRepresentation]];
+
+    if (action.outcomes.count > 0) {
+        [OneSignal onesignal_Log:ONE_S_LL_VERBOSE message:[NSString stringWithFormat:@"Outcomes detected inside of the action click payload, ignoring because action came from IAM preview: %@", [action.outcomes description]]];
+    }
+}
+
 /*
 * Checks if a click being available:
 * 1. Redisplay is enabled and click is available within message
@@ -548,11 +569,10 @@ - (BOOL)isClickAvailable:(OSInAppMessage *)message withClickId:(NSString *)click
 
 - (void)sendClickRESTCall:(OSInAppMessage *)message withAction:(OSInAppMessageAction *)action {
     let clickId = action.clickId;
-    // Make sure no click tracking is performed for IAM previews
     // If the IAM clickId exists within the cached clickedClickIds return early so the click is not tracked
     // unless that click is from an IAM with redisplay
     // Handles body, button, or image clicks
-    if (message.isPreview || ![self isClickAvailable:message withClickId:clickId])
+    if (![self isClickAvailable:message withClickId:clickId])
         return;
     // Add clickId to clickedClickIds
     [self.clickedClickIds addObject:clickId];