Followup fix: only consume in-app messages if they're shown (#66)

Author: vbabenkoru

Iterable-iOS-SDK/IterableAPI.m

@@ -1188,13 +1188,14 @@ - (void)spawnInAppNotification:(ITEActionBlock)callbackBlock
                     IterableNotificationMetadata *notification = [IterableNotificationMetadata metadataFromInAppOptions:messageId];
 
                     dispatch_async(dispatch_get_main_queue(), ^{
-                        [IterableInAppManager showIterableNotificationHTML:html trackParams:(IterableNotificationMetadata*)notification callbackBlock:(ITEActionBlock)callbackBlock backgroundAlpha:backgroundAlpha padding:edgeInsets];
+                        if ([IterableInAppManager showIterableNotificationHTML:html trackParams:notification callbackBlock:callbackBlock backgroundAlpha:backgroundAlpha padding:edgeInsets]) {
+                            [self inAppConsume:messageId];
+                        }
                     });
                 } else {
                     LogWarning(@"No href tag found in the in-app html payload: %@", html);
+                    [self inAppConsume:messageId];
                 }
-                
-                [self inAppConsume:messageId];
             }
         } else {
             LogDebug(@"No notifications found for inApp payload %@", payload);

Iterable-iOS-SDK/IterableInAppManager.h

@@ -33,8 +33,9 @@
  @param callbackBlock   The callback to send after a button on the notification is clicked
  @param backgroundAlpha The background alpha behind the notification
  @param padding         The padding around the notification
+ @return                A boolean indicating whether the notification was shown
  */
-+(void) showIterableNotificationHTML:(NSString *)htmlString trackParams:(IterableNotificationMetadata*)trackParams callbackBlock:(ITEActionBlock)callbackBlock backgroundAlpha:(double)backgroundAlpha padding:(UIEdgeInsets)padding;
++(BOOL) showIterableNotificationHTML:(NSString *)htmlString trackParams:(IterableNotificationMetadata*)trackParams callbackBlock:(ITEActionBlock)callbackBlock backgroundAlpha:(double)backgroundAlpha padding:(UIEdgeInsets)padding;
 
 /*!
  @method

Iterable-iOS-SDK/IterableInAppManager.m

@@ -10,8 +10,6 @@
 #import <UIKit/UIKit.h>
 
 #import "IterableInAppManager.h"
-#import "IterableConstants.h"
-#import "IterableNotificationMetadata.h"
 #import "IterableInAppHTMLViewController.h"
 #import "IterableLogging.h"
 
@@ -31,7 +29,7 @@ @implementation IterableInAppManager
 static NSString *const IN_APP_AUTO_EXPAND = @"AutoExpand";
 
 // documented in IterableInAppManager.h
-+(void) showIterableNotificationHTML:(NSString*)htmlString trackParams:(IterableNotificationMetadata*)trackParams callbackBlock:(ITEActionBlock)callbackBlock backgroundAlpha:(double)backgroundAlpha padding:(UIEdgeInsets)padding{
++(BOOL) showIterableNotificationHTML:(NSString*)htmlString trackParams:(IterableNotificationMetadata*)trackParams callbackBlock:(ITEActionBlock)callbackBlock backgroundAlpha:(double)backgroundAlpha padding:(UIEdgeInsets)padding{
     if (htmlString != NULL) {
         UIViewController *topViewController = [UIApplication sharedApplication].delegate.window.rootViewController;
         if([topViewController isKindOfClass:[UIViewController class]])
@@ -44,7 +42,7 @@ +(void) showIterableNotificationHTML:(NSString*)htmlString trackParams:(Iterable
 
         if ([topViewController isKindOfClass:[IterableInAppHTMLViewController class]]) {
             LogWarning(@"Skipping the in-app notification: another notification is already being displayed");
-            return;
+            return NO;
         }
 
         IterableInAppHTMLViewController *baseNotification;
@@ -54,10 +52,13 @@ +(void) showIterableNotificationHTML:(NSString*)htmlString trackParams:(Iterable
         [baseNotification ITESetPadding:padding];
 
         topViewController.definesPresentationContext = YES;
-        baseNotification.view.backgroundColor = [UIColor colorWithWhite:0 alpha:backgroundAlpha];;
+        baseNotification.view.backgroundColor = [UIColor colorWithWhite:0 alpha:backgroundAlpha];
         baseNotification.modalPresentationStyle = UIModalPresentationOverCurrentContext;
 
         [topViewController presentViewController:baseNotification animated:NO completion:nil];
+        return YES;
+    } else {
+        return NO;
     }
 }
 

Iterable-iOS-SDKTests/IterableInAppNotificationTests.m

@@ -165,4 +165,11 @@ - (void)testNotificationPaddingDefault {
     XCTAssertEqual(notificationType, INAPP_CENTER);
 }
 
+- (void)testDoNotShowMultipleTimes {
+    BOOL shownFirstTime = [IterableInAppManager showIterableNotificationHTML:@"" trackParams:nil callbackBlock:nil backgroundAlpha:0.0 padding:UIEdgeInsetsZero];
+    BOOL shownSecondTime = [IterableInAppManager showIterableNotificationHTML:@"" trackParams:nil callbackBlock:nil backgroundAlpha:0.0 padding:UIEdgeInsetsZero];
+    XCTAssertTrue(shownFirstTime);
+    XCTAssertFalse(shownSecondTime);
+}
+
 @end