Merge pull request #931 from OneSignal/fix/stopped_iams_still_display

Fixing impressions being sent for in-active IAMs

Author: emawby

iOS_SDK/OneSignalSDK/Source/OSInAppMessageViewController.h

@@ -39,7 +39,8 @@ NS_ASSUME_NONNULL_BEGIN
 - (void)messageViewDidSelectAction:(OSInAppMessage *)message withAction:(OSInAppMessageAction *)action;
 - (void)messageViewDidDisplayPage:(OSInAppMessage *)message withPageId:(NSString *)pageId;
 - (void)messageViewControllerWasDismissed;
-- (void)webViewContentFinishedLoading;
+- (void)webViewContentFinishedLoading:(OSInAppMessage *)message;
+- (void)messageIsNotActive:(OSInAppMessage *)message;
 
 @end
 

iOS_SDK/OneSignalSDK/Source/OSInAppMessageViewController.m

@@ -266,6 +266,9 @@ - (void)loadPreviewMessageContent {
 
 - (void)encounteredErrorLoadingMessageContent:(NSError * _Nullable)error {
     let message = [NSString stringWithFormat:@"An error occurred while attempting to load message content: %@", error.description ?: @"Unknown Error"];
+    if (error.code == 410 || error.code == 404) {
+        [self.delegate messageIsNotActive:self.message];
+    }
     [OneSignal onesignal_Log:ONE_S_LL_ERROR message:message];
 }
 
@@ -649,7 +652,7 @@ - (void)jsEventOccurredWithBody:(NSData *)body {
                 // The page is fully loaded and should now be displayed
                 // This is only fired once the javascript on the page sends the "rendering_complete" type event
                 dispatch_async(dispatch_get_main_queue(), ^{
-                    [self.delegate webViewContentFinishedLoading];
+                    [self.delegate webViewContentFinishedLoading:self.message];
                     [OneSignalHelper performSelector:@selector(displayMessage) onMainThreadOnObject:self withObject:nil afterDelay:0.0f];
                 });
                 break;

iOS_SDK/OneSignalSDK/Source/OSMessagingController.m

@@ -187,6 +187,19 @@ - (void)resetRedisplayMessagesBySession {
     }
 }
 
+- (void)deleteInactiveMessage:(OSInAppMessage *)message {
+    let deleteMessage = [NSString stringWithFormat:@"Deleting inactive in-app message from cache: %@", message.messageId];
+    [OneSignal onesignal_Log:ONE_S_LL_ERROR message:deleteMessage];
+    NSMutableArray *newMessagesArray = [NSMutableArray arrayWithArray:self.messages];
+    [newMessagesArray removeObject: message];
+    self.messages = newMessagesArray;
+    if (self.messages) {
+        [OneSignalUserDefaults.initStandard saveCodeableDataForKey:OS_IAM_MESSAGES_ARRAY withValue:self.messages];
+    } else {
+        [OneSignalUserDefaults.initStandard removeValueForKey:OS_IAM_MESSAGES_ARRAY];
+    }
+}
+
 /*
  Part of redisplay logic
  Remove IAMs that the last display time was six month ago
@@ -275,21 +288,28 @@ - (void)displayMessage:(OSInAppMessage *)message {
     }
 
     self.isInAppMessageShowing = true;
-    [self showAndImpressMessage:message];
+    [self showMessage:message];
 }
 
-- (void)showAndImpressMessage:(OSInAppMessage *)message {
+- (void)showMessage:(OSInAppMessage *)message {
     self.viewController = [[OSInAppMessageViewController alloc] initWithMessage:message delegate:self];
     if (message.hasLiquid && !self.calledLoadTags) {
         self.viewController.waitForTags = YES;
         [self loadTags];
     }
     dispatch_async(dispatch_get_main_queue(), ^{
-           [[self.viewController view] setNeedsLayout];
-           [self messageViewImpressionRequest:message];
+        [[self.viewController view] setNeedsLayout];
     });
 }
 
+- (void)sendMessageImpression:(OSInAppMessage *)message {
+    if ([self shouldSendImpression:message]) {
+        dispatch_async(dispatch_get_main_queue(), ^{
+            [self messageViewImpressionRequest:message];
+        });
+    }
+}
+
 - (void)loadTags {
     self.calledLoadTags = YES;
     [OneSignal getTags:^(NSDictionary *result) {
@@ -677,6 +697,10 @@ - (void)messageViewDidDisplayPage:(OSInAppMessage *)message withPageId:(NSString
     });
 }
 
+- (void)messageIsNotActive:(OSInAppMessage *)message {
+    [self deleteInactiveMessage:message];
+}
+
 /*
 * Show the developer what will happen with a non IAM preview
  */
@@ -754,12 +778,16 @@ - (void)sendOutcomes:(NSArray<OSInAppMessageOutcome *>*)outcomes forMessageId:(N
 /*
  This method must be called on the Main thread
  */
-- (void)webViewContentFinishedLoading {
+- (void)webViewContentFinishedLoading:(OSInAppMessage *)message {
     if (!self.viewController) {
         [self evaluateMessages];
         return;
     }
 
+    if (message) {
+        [self sendMessageImpression:message];
+    }
+    
     if (!self.window) {
         self.window = [[UIWindow alloc] init];
         self.window.windowLevel = UIWindowLevelAlert;
@@ -845,7 +873,7 @@ - (id)getTriggerValueForKey:(NSString *)key { return 0; }
 #pragma mark OSInAppMessageViewControllerDelegate Methods
 - (void)messageViewControllerWasDismissed {}
 - (void)messageViewDidSelectAction:(OSInAppMessage *)message withAction:(OSInAppMessageAction *)action {}
-- (void)webViewContentFinishedLoading {}
+- (void)webViewContentFinishedLoading:(OSInAppMessage *)message {}
 #pragma mark OSTriggerControllerDelegate Methods
 - (void)triggerConditionChanged {}
 - (void)dynamicTriggerCompleted:(NSString *)triggerId {}

iOS_SDK/OneSignalSDK/UnitTests/InAppMessagingIntegrationTests.m

@@ -388,6 +388,8 @@ - (void)testIAMWithRedisplay {
     }];
 
     [OneSignal addTrigger:@"prop1" withValue:@2];
+    
+    [UnitTestCommonMethods runLongBackgroundThreads];
 
     // IAM should be shown instantly and be within the messageDisplayQueue
     XCTAssertEqual(1, OSMessagingControllerOverrider.messageDisplayQueue.count);
@@ -420,7 +422,10 @@ - (void)testIAMWithRedisplay {
 
     [OneSignal addTrigger:@"prop1" withValue:@2];
 
+    [UnitTestCommonMethods runLongBackgroundThreads];
+    
     XCTAssertEqual(1, OSMessagingControllerOverrider.messageDisplayQueue.count);
+   
     // The display should cause an new "viewed" API request
     XCTAssertEqualObjects(OneSignalClientOverrider.lastHTTPRequestType, NSStringFromClass([OSRequestInAppMessageViewed class]));
 
@@ -747,9 +752,11 @@ - (void)testIAMViewedLaunchesViewedAPIRequest {
     // the trigger should immediately evaluate to true and should
     // be shown once the SDK is fully initialized.
     [OneSignalClientOverrider setMockResponseForRequest:NSStringFromClass([OSRequestRegisterUser class]) withResponse:registrationResponse];
-    
+
     [UnitTestCommonMethods initOneSignal_andThreadWait];
 
+    [UnitTestCommonMethods runLongBackgroundThreads];
+
     // the message should now be displayed
     XCTAssertEqualObjects(OneSignalClientOverrider.lastHTTPRequestType, NSStringFromClass([OSRequestInAppMessageViewed class]));
 }

iOS_SDK/OneSignalSDK/UnitTests/Shadows/OSMessagingControllerOverrider.m

@@ -87,16 +87,23 @@ @implementation OSMessagingControllerOverrider
 + (void)load {
     #pragma clang diagnostic push
     #pragma clang diagnostic ignored "-Wundeclared-selector"
-    injectToProperClass(@selector(overrideShowAndImpressMessage:), @selector(showAndImpressMessage:), @[], [OSMessagingControllerOverrider class], [OSMessagingController class]);
+    injectToProperClass(@selector(overrideShowMessage:), @selector(showMessage:), @[], [OSMessagingControllerOverrider class], [OSMessagingController class]);
+    injectToProperClass(@selector(overrideWebViewContentFinishedLoading:), @selector(webViewContentFinishedLoading:), @[], [OSMessagingControllerOverrider class], [OSMessagingController class]);
     #pragma clang diagnostic pop
 }
 
-- (void)overrideShowAndImpressMessage:(OSInAppMessage *)message {
+- (void)overrideShowMessage:(OSInAppMessage *)message {
     dispatch_async(dispatch_get_main_queue(), ^{
         let viewController = [[OSInAppMessageViewController alloc] initWithMessage:message delegate:OSMessagingController.self];
         [viewController viewDidLoad];
+        [OSMessagingController.sharedInstance webViewContentFinishedLoading:message];
     });
-    [OSMessagingController.sharedInstance messageViewImpressionRequest:message];
+}
+
+- (void)overrideWebViewContentFinishedLoading:(OSInAppMessage *)message {
+    if (message) {
+        [OSMessagingController.sharedInstance messageViewImpressionRequest:message];
+    }
 }
 
 + (void)dismissCurrentMessage {

iOS_SDK/OneSignalSDK/UnitTests/UnitTestCommonMethods.h

@@ -59,6 +59,7 @@ withNotificationWillShowInForegroundHandler:(OSNotificationWillShowInForegroundB
  withNotificationOpenedHandler:(OSNotificationOpenedBlock)notificationOpenedDelegate;
 
 + (void)runBackgroundThreads;
++ (void)runLongBackgroundThreads;
 + (void)clearStateForAppRestart:(XCTestCase *)testCase;
 + (void)beforeAllTest;
 + (void)beforeAllTest:(XCTestCase *)testCase;

iOS_SDK/OneSignalSDK/UnitTests/UnitTestCommonMethods.m

@@ -148,6 +148,23 @@ + (void)initOneSignalWithAppId:(NSString*)appId
     [OneSignal setNotificationOpenedHandler:notificationOpenedDelegate];
 }
 
+/*
+ Runs any blocks passed to dispatch_async() with delays after each call
+ This will allow more time for chained async methods to complete
+ */
++ (void)runLongBackgroundThreads {
+    NSLog(@"START runLongBackgroundThreads");
+    
+    [[NSRunLoop mainRunLoop] runUntilDate:[NSDate dateWithTimeIntervalSinceNow:0.05]];
+    
+    for(int i = 0; i < 10; i++) {
+        [[NSRunLoop mainRunLoop] runUntilDate:[NSDate dateWithTimeIntervalSinceNow:0.1]];
+        [UnitTestCommonMethods runThreadsOnEachQueue];
+    }
+    
+    NSLog(@"END runLongBackgroundThreads");
+}
+
 /*
  Runs any blocks passed to dispatch_async()
  */
@@ -156,32 +173,36 @@ + (void)runBackgroundThreads {
 
     [[NSRunLoop mainRunLoop] runUntilDate:[NSDate dateWithTimeIntervalSinceNow:0.05]];
 
-    // the httpQueue makes sure all HTTP request mocks are sync'ed
-    
-    dispatch_queue_t registerUserQueue, notifSettingsQueue;
     for(int i = 0; i < 10; i++) {
-        [OneSignalHelperOverrider runBackgroundThreads];
-        
-        notifSettingsQueue = [OneSignalNotificationSettingsIOS10 getQueue];
-        if (notifSettingsQueue)
-            dispatch_sync(notifSettingsQueue, ^{});
-        
-        registerUserQueue = [OneSignal getRegisterQueue];
-        if (registerUserQueue)
-            dispatch_sync(registerUserQueue, ^{});
-        
-        [OneSignalClientOverrider runBackgroundThreads];
-        
-        [UNUserNotificationCenterOverrider runBackgroundThreads];
-        
-        dispatch_barrier_sync(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{});
-        
-        [UIApplicationOverrider runBackgroundThreads];
+        [UnitTestCommonMethods runThreadsOnEachQueue];
     }
 
     NSLog(@"END runBackgroundThreads");
 }
 
++ (void)runThreadsOnEachQueue {
+    // the httpQueue makes sure all HTTP request mocks are sync'ed
+    dispatch_queue_t registerUserQueue, notifSettingsQueue;
+    
+    [OneSignalHelperOverrider runBackgroundThreads];
+    
+    notifSettingsQueue = [OneSignalNotificationSettingsIOS10 getQueue];
+    if (notifSettingsQueue)
+        dispatch_sync(notifSettingsQueue, ^{});
+    
+    registerUserQueue = [OneSignal getRegisterQueue];
+    if (registerUserQueue)
+        dispatch_sync(registerUserQueue, ^{});
+    
+    [OneSignalClientOverrider runBackgroundThreads];
+    
+    [UNUserNotificationCenterOverrider runBackgroundThreads];
+    
+    dispatch_barrier_sync(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{});
+    
+    [UIApplicationOverrider runBackgroundThreads];
+}
+
 + (void)clearStateForAppRestart:(XCTestCase *)testCase {
     NSLog(@"=======  APP RESTART ======\n\n");