Merge pull request #1050 from OneSignal/fix/display_test_iam_when_paused

Display test IAMs when IAMs are paused

Author: shepherd-l

iOS_SDK/OneSignalSDK/Source/OSInAppMessageInternal.m

@@ -126,6 +126,10 @@ + (instancetype)instanceWithJson:(NSDictionary * _Nonnull)json {
         message.hasLiquid = YES;
     }
 
+    if (json[@"is_preview"]) {
+        message.isPreview = YES;
+    }
+
     if (json[@"triggers"] && [json[@"triggers"] isKindOfClass:[NSArray class]]) {
         let triggers = [NSMutableArray new];
 
@@ -189,6 +193,10 @@ -(NSDictionary *)jsonRepresentation {
     if (self.hasLiquid) {
         json[@"has_liquid"] = @true;
     }
+
+    if (self.isPreview) {
+        json[@"is_preview"] = @true;
+    }
 
     return json;
 }

iOS_SDK/OneSignalSDK/Source/OSMessagingController.m

@@ -316,7 +316,7 @@ - (void)presentInAppPreviewMessage:(OSInAppMessageInternal *)message {
 
 - (void)displayMessage:(OSInAppMessageInternal *)message {
     // Check if the app disabled IAMs for this device before showing an IAM
-    if (_isInAppMessagingPaused) {
+    if (_isInAppMessagingPaused && !message.isPreview) {
         [OneSignal onesignal_Log:ONE_S_LL_VERBOSE message:@"In app messages will not show while paused"];
         return;
     }

iOS_SDK/OneSignalSDK/UnitTests/InAppMessagingIntegrationTests.m

@@ -1411,6 +1411,19 @@ - (void)testDisablingIAMs_stillCreatesMessageQueue_butPreventsMessageDisplay {
     XCTAssertEqual(OSMessagingControllerOverrider.messageDisplayQueue.count, 1);
 }
 
+/*
+ Test IAMs should display even when IAMs are paused
+*/
+- (void)testPreviewIAMIsDisplayedOnPause {
+    [OneSignal pauseInAppMessages:true];
+    
+    let message = [OSInAppMessageTestHelper testMessageWithPreview];
+    
+    [self initOneSignalWithInAppMessage:message];
+
+    XCTAssertTrue(OSMessagingControllerOverrider.isInAppMessageShowing);
+}
+
 - (void)testInAppMessageIdTracked {
     [OneSignal pauseInAppMessages:false];
 

iOS_SDK/OneSignalSDK/UnitTests/OSInAppMessagingHelpers.h

@@ -57,6 +57,7 @@ NS_ASSUME_NONNULL_BEGIN
 + (OSInAppMessageInternal *)testMessageWithTriggersJson:(NSArray *)triggers redisplayLimit:(NSInteger)limit delay:(NSNumber *)delay;
 + (OSInAppMessageInternal *)testMessage;
 + (OSInAppMessageInternal *)testMessageWithLiquid;
++ (OSInAppMessageInternal *)testMessageWithPreview;
 + (OSInAppMessageInternal *)testMessageWithRedisplayLimit:(NSInteger)limit delay:(NSNumber *)delay;
 + (OSInAppMessageInternal *)testMessageWithTriggers:(NSArray <NSArray<OSTrigger *> *> *)triggers;
 + (OSInAppMessageInternal *)testMessageWithTriggers:(NSArray <NSArray<OSTrigger *> *> *)triggers withRedisplayLimit:(NSInteger)limit delay:(NSNumber *)delay;

iOS_SDK/OneSignalSDK/UnitTests/OSInAppMessagingHelpers.m

@@ -110,6 +110,24 @@ + (NSDictionary * _Nonnull)testMessageJsonLiquid {
     };
 }
 
++ (NSDictionary * _Nonnull)testMessageJsonPreview {
+    return @{
+        @"type" : @"centered_modal", // Prevents issues with the "os_viewed_message" count trigger that lets us prevent a message from being shown > than X times
+        @"id" : [NSString stringWithFormat:@"%@_%i", OS_TEST_MESSAGE_ID, ++messageIdIncrementer],
+        @"variants" : @{
+            @"ios" : @{
+                @"default" : OS_TEST_MESSAGE_VARIANT_ID,
+                @"en" : OS_TEST_ENGLISH_VARIANT_ID
+            },
+            @"all" : @{
+                @"default" : @"should_never_be_used_by_any_test"
+            }
+        },
+        @"triggers" : @[],
+        @"is_preview" : @true,
+    };
+}
+
 + (NSDictionary * _Nonnull)testMessageJsonRedisplay {
     return @{
         @"type" : @"centered_modal", // Prevents issues with the "os_viewed_message" count trigger that lets us prevent a message from being shown > than X times
@@ -206,6 +224,14 @@ + (OSInAppMessageInternal *)testMessageWithPastEndTime:(BOOL)pastEndTime {
     return [OSInAppMessageInternal instanceWithData:data];
 }
 
++ (OSInAppMessageInternal *)testMessageWithPreview {
+    let messageJson = self.testMessageJsonPreview;
+    
+    let data = [NSJSONSerialization dataWithJSONObject:messageJson options:0 error:nil];
+
+    return [OSInAppMessageInternal instanceWithData:data];
+}
+
 + (OSInAppMessageInternal *)testMessageWithRedisplayLimit:(NSInteger)limit delay:(NSNumber *)delay {
      let messageJson = self.testMessageJsonRedisplay;