Make IAM able to re display multiple times

  * Add OSInAppMessageDisplayStats class with delay and limit params for redisplay logic
  * Make OSMessagingController handle the multiple re displays
  * Save on UserDefaults quantity of displays and last display time per IAM
  * Remove from UserDefaults when not available from backend
  * Add unit test and integration test for new functionality
  * Fix test that weren't taking care of all logic flow

Author: Jeasmine

iOS_SDK/OneSignalSDK/OneSignal.xcodeproj/project.pbxproj

@@ -85,6 +85,10 @@
 		7A674F1B2360D82E001F9ACD /* OSBaseFocusTimeProcessor.m in Sources */ = {isa = PBXBuildFile; fileRef = 7A674F1A2360D82E001F9ACD /* OSBaseFocusTimeProcessor.m */; };
 		7A674F1C2360D82E001F9ACD /* OSBaseFocusTimeProcessor.m in Sources */ = {isa = PBXBuildFile; fileRef = 7A674F1A2360D82E001F9ACD /* OSBaseFocusTimeProcessor.m */; };
 		7A674F1D2360D82E001F9ACD /* OSBaseFocusTimeProcessor.m in Sources */ = {isa = PBXBuildFile; fileRef = 7A674F1A2360D82E001F9ACD /* OSBaseFocusTimeProcessor.m */; };
+		7A72EB0E23E252C200B4D50F /* OSInAppMessageDisplayStats.m in Sources */ = {isa = PBXBuildFile; fileRef = 7A72EB0D23E252C200B4D50F /* OSInAppMessageDisplayStats.m */; };
+		7A72EB0F23E252C700B4D50F /* OSInAppMessageDisplayStats.m in Sources */ = {isa = PBXBuildFile; fileRef = 7A72EB0D23E252C200B4D50F /* OSInAppMessageDisplayStats.m */; };
+		7A72EB1023E252C700B4D50F /* OSInAppMessageDisplayStats.m in Sources */ = {isa = PBXBuildFile; fileRef = 7A72EB0D23E252C200B4D50F /* OSInAppMessageDisplayStats.m */; };
+		7A72EB1223E252DD00B4D50F /* OSInAppMessageDisplayStats.h in Headers */ = {isa = PBXBuildFile; fileRef = 7A72EB1123E252D400B4D50F /* OSInAppMessageDisplayStats.h */; };
 		7A9173A2231971E5007848FA /* OneSignalReceiveReceiptsController.m in Sources */ = {isa = PBXBuildFile; fileRef = 7A9173A1231971E5007848FA /* OneSignalReceiveReceiptsController.m */; };
 		7AD8DDE7234BD3BE00747A8A /* OneSignalUserDefaults.m in Sources */ = {isa = PBXBuildFile; fileRef = 7AD8DDE6234BD3BE00747A8A /* OneSignalUserDefaults.m */; };
 		7ADE379422E8B69C00263048 /* OneSignalOutcomeEventsController.m in Sources */ = {isa = PBXBuildFile; fileRef = 7ADE379322E8B69C00263048 /* OneSignalOutcomeEventsController.m */; };
@@ -398,6 +402,8 @@
 		7A12EBDC23060B37005C4FA5 /* OSIndirectNotification.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = OSIndirectNotification.m; sourceTree = "<group>"; };
 		7A674F182360D813001F9ACD /* OSBaseFocusTimeProcessor.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = OSBaseFocusTimeProcessor.h; sourceTree = "<group>"; };
 		7A674F1A2360D82E001F9ACD /* OSBaseFocusTimeProcessor.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = OSBaseFocusTimeProcessor.m; sourceTree = "<group>"; };
+		7A72EB0D23E252C200B4D50F /* OSInAppMessageDisplayStats.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = OSInAppMessageDisplayStats.m; sourceTree = "<group>"; };
+		7A72EB1123E252D400B4D50F /* OSInAppMessageDisplayStats.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = OSInAppMessageDisplayStats.h; sourceTree = "<group>"; };
 		7A9173A1231971E5007848FA /* OneSignalReceiveReceiptsController.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = OneSignalReceiveReceiptsController.m; sourceTree = "<group>"; };
 		7A9173A3231971F8007848FA /* OneSignalReceiveReceiptsController.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = OneSignalReceiveReceiptsController.h; sourceTree = "<group>"; };
 		7AD8DDE6234BD3BE00747A8A /* OneSignalUserDefaults.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = OneSignalUserDefaults.m; sourceTree = "<group>"; };
@@ -936,6 +942,8 @@
 				CAB269D821B0B6F000F8A43C /* OSInAppMessageAction.m */,
 				CAB269DD21B2038B00F8A43C /* OSInAppMessageBridgeEvent.h */,
 				CAB269DE21B2038B00F8A43C /* OSInAppMessageBridgeEvent.m */,
+				7A72EB1123E252D400B4D50F /* OSInAppMessageDisplayStats.h */,
+				7A72EB0D23E252C200B4D50F /* OSInAppMessageDisplayStats.m */,
 			);
 			name = Model;
 			sourceTree = "<group>";
@@ -1030,6 +1038,7 @@
 				9124121D1E73342200E41FD7 /* OneSignalJailbreakDetection.h in Headers */,
 				7AFE856F2368DDC50091D6A5 /* OSFocusCallParams.h in Headers */,
 				9129C6B71E89E59B009CB6A0 /* OSPermission.h in Headers */,
+				7A72EB1223E252DD00B4D50F /* OSInAppMessageDisplayStats.h in Headers */,
 				912412151E73342200E41FD7 /* OneSignalHelper.h in Headers */,
 				CAAEA68A21ED68A40049CF15 /* OneSignalNotificationCategoryController.h in Headers */,
 				7A1232A5235E179B002B6CE3 /* OSIndirectNotification.h in Headers */,
@@ -1213,6 +1222,7 @@
 				91F58D831E7C80DA0017D24D /* OneSignalNotificationSettingsIOS8.m in Sources */,
 				CAAEA68721ED68A40049CF15 /* OneSignalNotificationCategoryController.m in Sources */,
 				9D1BD9602379E7C300A064F7 /* OSOutcomeEvent.m in Sources */,
+				7A72EB0E23E252C200B4D50F /* OSInAppMessageDisplayStats.m in Sources */,
 				9124121E1E73342200E41FD7 /* OneSignalJailbreakDetection.m in Sources */,
 				CA08FC791FE99B13004C445F /* OneSignalRequest.m in Sources */,
 				912412471E73369600E41FD7 /* OneSignalHelper.m in Sources */,
@@ -1282,6 +1292,7 @@
 				CAAEA68821ED68A40049CF15 /* OneSignalNotificationCategoryController.m in Sources */,
 				9124121F1E73342200E41FD7 /* OneSignalJailbreakDetection.m in Sources */,
 				CA08FC7A1FE99B13004C445F /* OneSignalRequest.m in Sources */,
+				7A72EB0F23E252C700B4D50F /* OSInAppMessageDisplayStats.m in Sources */,
 				912412481E73369700E41FD7 /* OneSignalHelper.m in Sources */,
 				9124122F1E73342200E41FD7 /* OneSignalSelectorHelpers.m in Sources */,
 				9124122B1E73342200E41FD7 /* OneSignalReachability.m in Sources */,
@@ -1414,6 +1425,7 @@
 				9D3300F623145AF3000F0A83 /* OneSignalViewHelper.m in Sources */,
 				4529DEF31FA8440A00CEAB1D /* UIAlertViewOverrider.m in Sources */,
 				CA8E18FF2193A1A5009DA223 /* NSTimerOverrider.m in Sources */,
+				7A72EB1023E252C700B4D50F /* OSInAppMessageDisplayStats.m in Sources */,
 				CACBAA9F218A6243000ACAA5 /* OSInAppMessageView.m in Sources */,
 				CA4742E7218B8FF30020DC8C /* OSTriggerController.m in Sources */,
 				4529DEEA1FA8360C00CEAB1D /* UIApplicationOverrider.m in Sources */,

iOS_SDK/OneSignalSDK/Source/OSInAppMessage.h

@@ -27,6 +27,7 @@
 
 #import <Foundation/Foundation.h>
 #import "OSInAppMessagingDefines.h"
+#import "OSInAppMessageDisplayStats.h"
 #import "OSJSONHandling.h"
 #import "OneSignal.h"
 #import "OSTrigger.h"
@@ -40,13 +41,21 @@ NS_ASSUME_NONNULL_BEGIN
 @property (strong, nonatomic, nonnull) NSArray<NSArray <OSTrigger *> *> *triggers;
 
 @property (nonatomic) OSInAppMessageDisplayPosition position;
+@property (nonatomic) OSInAppMessageDisplayStats *displayStats;
 @property (nonatomic) BOOL actionTaken;
 @property (nonatomic) BOOL isPreview;
+@property (nonatomic) BOOL isTriggerChanged;
 @property (nonatomic) NSNumber *height;
 
 - (BOOL)isBanner;
 - (BOOL)takeActionAsUnique;
 
+- (NSSet<NSString *> *)getClickedClickIds;
+- (BOOL)isClickAvailable:(NSString *)clickId;
+
+- (void)clearClickIds;
+- (void)addClickId:(NSString *)clickId;
+
 @end
 
 NS_ASSUME_NONNULL_END

iOS_SDK/OneSignalSDK/Source/OSInAppMessage.m

@@ -29,8 +29,23 @@
 #import "OneSignalHelper.h"
 #import "OneSignalCommonDefines.h"
 
+@interface OSInAppMessage ()
+
+@property (strong, nonatomic, nonnull) NSMutableSet <NSString *> *clickedClickIds;
+
+@end
+
 @implementation OSInAppMessage
 
+- (instancetype)init {
+    if (self = [super init]) {
+        self.clickedClickIds = [[NSMutableSet alloc] init];
+        self.isTriggerChanged = false;
+    }
+    
+    return self;
+}
+
 - (BOOL)isBanner {
     return self.position == OSInAppMessageDisplayPositionTop || self.position == OSInAppMessageDisplayPositionBottom;
 }
@@ -41,6 +56,22 @@ - (BOOL)takeActionAsUnique {
     return self.actionTaken = true;
 }
 
+- (BOOL)isClickAvailable:(NSString *)clickId {
+    return ![_clickedClickIds containsObject:clickId];
+}
+
+- (void)clearClickIds {
+    _clickedClickIds = [[NSMutableSet alloc] init];
+}
+
+- (void)addClickId:(NSString *)clickId {
+    [_clickedClickIds addObject:clickId];
+}
+
+- (NSSet<NSString *> *)getClickedClickIds {
+    return _clickedClickIds;
+}
+
 + (instancetype)instanceWithData:(NSData *)data {
     NSError *error;
     NSDictionary *json = [NSJSONSerialization JSONObjectWithData:data options:0 error:&error];
@@ -66,6 +97,11 @@ + (instancetype)instanceWithJson:(NSDictionary * _Nonnull)json {
     else
         return nil;
 
+    if (json[@"redisplay"] && [json[@"redisplay"] isKindOfClass:[NSDictionary class]])
+        message.displayStats = [OSInAppMessageDisplayStats instanceWithJson:json[@"redisplay"]];
+    else
+        message.displayStats = [[OSInAppMessageDisplayStats alloc] init];
+    
     if (json[@"triggers"] && [json[@"triggers"] isKindOfClass:[NSArray class]]) {
         let triggers = [NSMutableArray new];
 
@@ -120,8 +156,34 @@ -(NSDictionary *)jsonRepresentation {
 
     json[@"triggers"] = triggers;
 
+    if ([_displayStats isRedisplayEnabled]) {
+        json[@"redisplay"] = [_displayStats jsonRepresentation];
+    }
+    
     return json;
 }
 
+- (NSString *)description {
+    return [NSString stringWithFormat:@"OSInAppMessage:  \nmessageId: %@  \ntriggers: %@ \ndisplayStats: %@", self.messageId, self.triggers, self.displayStats];
+}
+
+- (BOOL)isEqual:(id)object {
+  if (self == object) {
+    return YES;
+  }
+
+  if (![object isKindOfClass:[OSInAppMessage class]]) {
+    return NO;
+  }
+
+  OSInAppMessage *iam = object;
+    
+  return [self.messageId isEqualToString:iam.messageId];
+}
+
+- (NSUInteger)hash {
+    return [self.messageId hash];
+}
+
 @end
 

iOS_SDK/OneSignalSDK/Source/OSInAppMessageDisplayStats.h

@@ -0,0 +1,49 @@
+/**
+* Modified MIT License
+*
+* Copyright 2020 OneSignal
+*
+* Permission is hereby granted, free of charge, to any person obtaining a copy
+* of this software and associated documentation files (the "Software"), to deal
+* in the Software without restriction, including without limitation the rights
+* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+* copies of the Software, and to permit persons to whom the Software is
+* furnished to do so, subject to the following conditions:
+*
+* 1. The above copyright notice and this permission notice shall be included in
+* all copies or substantial portions of the Software.
+*
+* 2. All copies of substantial portions of the Software may only be used in connection
+* with services provided by OneSignal.
+*
+* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+* THE SOFTWARE.
+*/
+
+#import "OneSignal.h"
+#import "OSJSONHandling.h"
+
+@interface OSInAppMessageDisplayStats : NSObject <OSJSONDecodable, OSJSONEncodable>
+
+//Last IAM display time in seconds
+@property (nonatomic, readwrite) double lastDisplayTime;
+//Delay between displays in seconds
+@property (nonatomic, readwrite) double displayDelay;
+//Current quantity of displays
+@property (nonatomic, readwrite) NSInteger displayQuantity;
+//Quantity of displays limit
+@property (nonatomic, readwrite) NSInteger displayLimit;
+
+@property (nonatomic) BOOL isRedisplayEnabled;
+
+- (BOOL)isDelayTimeSatisfied:(NSTimeInterval)date;
+- (BOOL)shouldDisplayAgain;
+
+- (void)incrementDisplayQuantity;
+
+@end

iOS_SDK/OneSignalSDK/Source/OSInAppMessageDisplayStats.m

@@ -0,0 +1,126 @@
+/**
+* Modified MIT License
+*
+* Copyright 2020 OneSignal
+*
+* Permission is hereby granted, free of charge, to any person obtaining a copy
+* of this software and associated documentation files (the "Software"), to deal
+* in the Software without restriction, including without limitation the rights
+* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+* copies of the Software, and to permit persons to whom the Software is
+* furnished to do so, subject to the following conditions:
+*
+* 1. The above copyright notice and this permission notice shall be included in
+* all copies or substantial portions of the Software.
+*
+* 2. All copies of substantial portions of the Software may only be used in connection
+* with services provided by OneSignal.
+*
+* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+* THE SOFTWARE.
+*/
+
+#import "OSInAppMessageDisplayStats.h"
+#import "OneSignalHelper.h"
+
+@interface OSInAppMessageDisplayStats ()
+@property (nonatomic, readwrite) BOOL redisplayEnabled;
+@end
+
+@implementation OSInAppMessageDisplayStats
+
+- (instancetype)init
+{
+    self = [super init];
+    if (self) {
+        self.displayLimit = NSIntegerMax;
+        self.displayDelay = 0;
+        self.displayQuantity = 0;
+        self.lastDisplayTime = -1;
+        self.redisplayEnabled = false;
+    }
+    return self;
+}
+
++ (instancetype)instanceWithDisplayQuantity:(NSInteger)displayQuantity lastDisplayTime:(NSTimeInterval)lastDisplayTime {
+    let displayStats = [OSInAppMessageDisplayStats new];
+    
+    displayStats.displayQuantity = displayQuantity;
+    displayStats.lastDisplayTime = lastDisplayTime;
+
+    return displayStats;
+}
+
++ (instancetype _Nullable)instanceWithData:(NSData * _Nonnull)data {
+    NSError *error;
+    NSDictionary *json = [NSJSONSerialization JSONObjectWithData:data options:0 error:&error];
+   
+    if (error || !json) {
+        [OneSignal onesignal_Log:ONE_S_LL_ERROR message:[NSString stringWithFormat:@"Unable to decode in-app display state message JSON: %@", error.description ?: @"No Data"]];
+        return nil;
+    }
+   
+    return [self instanceWithJson:json];
+}
+
++ (instancetype)instanceWithJson:(NSDictionary * _Nonnull)json {
+    let displayStats = [OSInAppMessageDisplayStats new];
+    
+    if (json[@"limit"] && [json[@"limit"] isKindOfClass:[NSNumber class]])
+        displayStats.displayLimit = [json[@"limit"] integerValue];
+    else
+        displayStats.displayLimit = NSIntegerMax;
+    
+    if (json[@"delay"] && [json[@"delay"] isKindOfClass:[NSNumber class]])
+        displayStats.displayDelay = [json[@"delay"] doubleValue];
+    else
+        displayStats.displayDelay = [@0 doubleValue];
+    
+    displayStats.displayQuantity = 0;
+    displayStats.lastDisplayTime = [@-1 doubleValue];
+    displayStats.redisplayEnabled = YES;
+
+    return displayStats;
+}
+
+- (BOOL)isDelayTimeSatisfied:(NSTimeInterval)date {
+    if (_lastDisplayTime < 0) {
+        _lastDisplayTime = date;
+        return true;
+    }
+    //Calculate gap between display times
+    let diffInSeconds = date - _lastDisplayTime;
+    return diffInSeconds >= _displayDelay;
+}
+
+- (BOOL)shouldDisplayAgain {
+    return _displayQuantity < _displayLimit;
+}
+
+- (void)incrementDisplayQuantity {
+    _displayQuantity++;
+}
+
+- (BOOL)isRedisplayEnabled {
+    return _redisplayEnabled;
+}
+
+- (NSString *)description {
+    return [NSString stringWithFormat:@"OSInAppMessageDisplayStats:  redisplayEnabled: %@ \nlastDisplayTime: %f  \ndisplayDelay: %f \ndisplayQuantity: %ld \ndisplayLimit: %ld", self.redisplayEnabled ? @"YES" : @"NO", self.lastDisplayTime, self.displayDelay, (long)self.displayQuantity, (long)self.displayLimit];
+}
+
+- (NSDictionary * _Nonnull)jsonRepresentation {
+    let json = [NSMutableDictionary new];
+    
+    json[@"limit"] = @(self.displayLimit);
+    json[@"delay"] = @(self.displayDelay);
+    
+    return json;
+}
+
+@end

iOS_SDK/OneSignalSDK/Source/OSInAppMessagingDefines.h

@@ -73,6 +73,7 @@ typedef NS_ENUM(NSUInteger, OSTriggerOperatorType) {
 #define OS_IAM_SEEN_SET_KEY @"OS_IAM_SEEN_SET"
 #define OS_IAM_CLICKED_SET_KEY @"OS_IAM_CLICKED_SET"
 #define OS_IAM_IMPRESSIONED_SET_KEY @"OS_IAM_IMPRESSIONED_SET"
+#define OS_IAM_SEEN_WITH_REDISPLAY_DICTIONARY_KEY @"OS_IAM_SEEN_WITH_REDISPLAY_DICTIONARY_KEY"
 
 // Dynamic trigger kind types
 #define OS_DYNAMIC_TRIGGER_KIND_CUSTOM @"custom"