Fix/implement caching for iams pulled on session (#630)

* Added IAM caching from on_session request
* Now IAMs from the on_session request response will be persisted and used in the case where an on_session is not called and we have no IAMs to reference
* Using the codeable data method in the OneSignalUserDefaults class and required to setup decoder and encoder for the OSInAppMessage and OSTrigger class
* Now we try to init IAMs with the cached IAMs just in case

Added two unit tests in relation to this added functionality
 * First test checks that on_session we start using the IAMs and persist them
 * Second test makes sure that on_session is called, IAMs are cached, and then cold start without a new on_session
   * This should result in the app using the cached IAMs

* Added a little deeper logic into the on_session IAM unit tests
* First test now checks for persisted IAMs before and after the test runs
* Second test now checks for persisted IAMs at the start, and the network check at the end verifies the IAMs came from cache instead of request response

* Fixing unit test request count for 2 on_session IAM tests

* Added IAM cache logic down same path as a on_session IAM receive

* Comment fix, missing space

* Split up on_session IAMs and cache inits

* Return early in the case where we use the session for IAMs

* Only need to call eval after getting cached IAMs

* Fixed unit tests related to pausing IAMs

Author: mikechoch

iOS_SDK/OneSignalDevApp/OneSignalDevApp/AppDelegate.m

@@ -39,7 +39,7 @@ - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(
 
     NSLog(@"Bundle URL: %@", [[NSBundle mainBundle] bundleURL]);
 
-    [OneSignal setLogLevel:ONE_S_LL_VERBOSE visualLevel:ONE_S_LL_ERROR];
+    [OneSignal setLogLevel:ONE_S_LL_VERBOSE visualLevel:ONE_S_LL_NONE];
 
     OneSignal.inFocusDisplayType = OSNotificationDisplayTypeInAppAlert;
 

iOS_SDK/OneSignalSDK/Source/OSInAppMessage.m

@@ -191,5 +191,20 @@ - (NSUInteger)hash {
     return [self.messageId hash];
 }
 
+- (void)encodeWithCoder:(NSCoder *)encoder {
+    [encoder encodeObject:_messageId forKey:@"messageId"];
+    [encoder encodeObject:_variants forKey:@"variants"];
+    [encoder encodeObject:_triggers forKey:@"triggers"];
+}
+
+- (id)initWithCoder:(NSCoder *)decoder {
+    if (self = [super init]) {
+        _messageId = [decoder decodeObjectForKey:@"messageId"];
+        _variants = [decoder decodeObjectForKey:@"variants"];
+        _triggers = [decoder decodeObjectForKey:@"triggers"];
+    }
+    return self;
+}
+
 @end
 

iOS_SDK/OneSignalSDK/Source/OSInAppMessagingDefines.h

@@ -69,10 +69,11 @@ typedef NS_ENUM(NSUInteger, OSTriggerOperatorType) {
 #define MIN_DISMISSAL_ANIMATION_DURATION 0.1f
 #define MAX_DISMISSAL_ANIMATION_DURATION 0.3f
 
-// Keys for NSUserDefaults
+// In-App Messaging NSUserDefaults
 #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_MESSAGES_ARRAY @"OS_IAM_MESSAGES_ARRAY"
 #define OS_IAM_REDISPLAY_DICTIONARY @"OS_IAM_REDISPLAY_DICTIONARY"
 
 // Dynamic trigger kind types

iOS_SDK/OneSignalSDK/Source/OSMessagingController.h

@@ -45,7 +45,8 @@ NS_ASSUME_NONNULL_BEGIN
 + (void)removeInstance;
 - (void)presentInAppMessage:(OSInAppMessage *)message;
 - (void)presentInAppPreviewMessage:(OSInAppMessage *)message;
-- (void)didUpdateMessagesForSession:(NSArray<OSInAppMessage *> *)newMessages;
+- (void)updateInAppMessagesFromCache;
+- (void)updateInAppMessagesFromOnSession:(NSArray<OSInAppMessage *> *)newMessages;
 - (void)messageViewImpressionRequest:(OSInAppMessage *)message;
 
 - (BOOL)isInAppMessagingPaused;

iOS_SDK/OneSignalSDK/Source/OSMessagingController.m

@@ -120,7 +120,8 @@ - (instancetype)init {
         self.dateGenerator = ^ NSTimeInterval {
             return [[NSDate date] timeIntervalSince1970];
         };
-        self.messages = [NSArray<OSInAppMessage *> new];
+        self.messages = [OneSignalUserDefaults.initStandard getSavedCodeableDataForKey:OS_IAM_MESSAGES_ARRAY
+                                                                                          defaultValue:[NSArray<OSInAppMessage *> new]];
         self.triggerController = [OSTriggerController new];
         self.triggerController.delegate = self;
         self.messageDisplayQueue = [NSMutableArray new];
@@ -140,8 +141,18 @@ - (instancetype)init {
     return self;
 }
 
-- (void)didUpdateMessagesForSession:(NSArray<OSInAppMessage *> *)newMessages {
+- (void)updateInAppMessagesFromCache {
+    self.messages = [OneSignalUserDefaults.initStandard getSavedCodeableDataForKey:OS_IAM_MESSAGES_ARRAY defaultValue:[NSArray new]];
+    [self evaluateMessages];
+}
+
+- (void)updateInAppMessagesFromOnSession:(NSArray<OSInAppMessage *> *)newMessages {
     self.messages = newMessages;
+    
+    // Cache if messages passed in are not null, this method is called from on_session for
+    //  new messages and cached when foregrounding app
+    if (self.messages)
+        [OneSignalUserDefaults.initStandard saveCodeableDataForKey:OS_IAM_MESSAGES_ARRAY withValue:self.messages];
 
     [self resetRedisplayMessagesBySession];
     [self evaluateMessages];
@@ -583,7 +594,7 @@ + (OSMessagingController *)sharedInstance {return nil; }
 - (instancetype)init { self = [super init]; return self; }
 - (BOOL)isInAppMessagingPaused { return false; }
 - (void)setInAppMessagingPaused:(BOOL)pause {}
-- (void)didUpdateMessagesForSession:(NSArray<OSInAppMessage *> *)newMessages {}
+- (void)updateInAppMessagesFromOnSession:(NSArray<OSInAppMessage *> *)newMessages {}
 - (void)setInAppMessageClickHandler:(OSHandleInAppMessageActionClickBlock)actionClickBlock {}
 - (void)presentInAppMessage:(OSInAppMessage *)message {}
 - (void)presentInAppPreviewMessage:(OSInAppMessage *)message {}

iOS_SDK/OneSignalSDK/Source/OSTrigger.m

@@ -90,7 +90,31 @@ - (NSDictionary *)jsonRepresentation {
 }
 
 - (NSString *)description {
-    return [NSString stringWithFormat: @"OSTrigger: triggerId=%@ property=%@ operatorType=%lu value=%@", _triggerId, _property, (unsigned long)_operatorType, _value];
+    return [NSString stringWithFormat:@"OSTrigger: triggerId=%@ kind=%@ property=%@ operatorType=%lu value=%@",
+            _triggerId,
+            _kind,
+            _property,
+            (unsigned long)_operatorType,
+            _value];
+}
+
+- (void)encodeWithCoder:(NSCoder *)encoder {
+    [encoder encodeObject:_triggerId forKey:@"triggerId"];
+    [encoder encodeObject:_kind forKey:@"kind"];
+    [encoder encodeObject:_property forKey:@"property"];
+    [encoder encodeInt:(int)_operatorType forKey:@"operatorType"];
+    [encoder encodeObject:_value forKey:@"value"];
+}
+
+- (id)initWithCoder:(NSCoder *)decoder {
+    if (self = [super init]) {
+        _triggerId = [decoder decodeObjectForKey:@"triggerId"];
+        _kind = [decoder decodeObjectForKey:@"kind"];
+        _property = [decoder decodeObjectForKey:@"property"];
+        _operatorType = (OSTriggerOperatorType)[decoder decodeIntForKey:@"operatorType"];
+        _value = [decoder decodeObjectForKey:@"value"];
+    }
+    return self;
 }
 
 @end

iOS_SDK/OneSignalSDK/Source/OneSignal.m

@@ -1779,15 +1779,21 @@ + (void)registerUserInternal {
 
 + (void)receivedInAppMessageJson:(NSArray<NSDictionary *> *)messagesJson {
     let messages = [NSMutableArray new];
-
-    for (NSDictionary *messageJson in messagesJson) {
-        let message = [OSInAppMessage instanceWithJson:messageJson];
-
-        if (message)
-            [messages addObject:message];
+    
+    if (messagesJson) {
+        for (NSDictionary *messageJson in messagesJson) {
+            let message = [OSInAppMessage instanceWithJson:messageJson];
+            
+            if (message)
+                [messages addObject:message];
+        }
+        
+        [OSMessagingController.sharedInstance updateInAppMessagesFromOnSession:messages];
+        return;
     }
 
-    [[OSMessagingController sharedInstance] didUpdateMessagesForSession:messages];
+    // Default is using cached IAMs in the messaging controller
+    [OSMessagingController.sharedInstance updateInAppMessagesFromCache];
 }
 
 + (NSString*)getUsableDeviceToken {

iOS_SDK/OneSignalSDK/Source/OneSignalInternal.h

@@ -63,6 +63,7 @@
 + (BOOL)shouldPromptToShowURL;
 + (void)setIsOnSessionSuccessfulForCurrentState:(BOOL)value;
 + (BOOL)shouldRegisterNow;
++ (void)receivedInAppMessageJson:(NSArray<NSDictionary *> *)messagesJson;
 
 + (NSDate *)sessionLaunchTime;
 

iOS_SDK/OneSignalSDK/Source/OneSignalTracker.m

@@ -39,6 +39,7 @@
 #import "OSFocusTimeProcessorFactory.h"
 #import "OSBaseFocusTimeProcessor.h"
 #import "OSFocusCallParams.h"
+#import "OSMessagingController.h"
 
 @interface OneSignal ()
 
@@ -110,9 +111,10 @@ + (void)applicationForegrounded {
     if ([OneSignal shouldRegisterNow])
         [OneSignal registerUser];
     else {
-        // This checks if notifiation permissions changed when app was backgrounded
+        // This checks if notification permissions changed when app was backgrounded
         [OneSignal sendNotificationTypesUpdate];
         [OneSignal.sessionManager attemptSessionUpgrade];
+        [OneSignal receivedInAppMessageJson:nil];
     }
 
     let wasBadgeSet = [OneSignal clearBadgeCount:false];

iOS_SDK/OneSignalSDK/UnitTests/InAppMessagingIntegrationTests.m

@@ -82,15 +82,101 @@ - (void)setUp {
     NSTimerOverrider.shouldScheduleTimers = false;
 }
 
--(void)tearDown {
+- (void)tearDown {
     OneSignalOverrider.shouldOverrideSessionLaunchTime = false;
 
     [OSMessagingController.sharedInstance resetState];
 
     NSTimerOverrider.shouldScheduleTimers = true;
+}
+
+/**
+ Make sure on_session IAMs are pulled for the specific app_id
+ For this test we have mocked a single IAM in the on_session request
+ After first on_session IAMs are setup to be used by controller
+*/
+- (void)testIAMsAvailable_afterOnSession {
+    // 1. Make sure 0 IAMs are persisted
+    NSArray *cachedMessages = [OneSignalUserDefaults.initStandard getSavedCodeableDataForKey:OS_IAM_MESSAGES_ARRAY defaultValue:nil];
+    XCTAssertNil(cachedMessages);
 
-    // Set to false so that we don't interfere with other tests
-    [OneSignal pauseInAppMessages:false];
+    // 2. Open app
+    [UnitTestCommonMethods initOneSignalAndThreadWait];
+    [UnitTestCommonMethods runBackgroundThreads];
+
+    // 3. Kill the app and wait 31 seconds
+    [UnitTestCommonMethods backgroundApp];
+    [UnitTestCommonMethods clearStateForAppRestart:self];
+    [NSDateOverrider advanceSystemTimeBy:31];
+    [UnitTestCommonMethods runBackgroundThreads];
+    
+    // 4. Open app
+    [UnitTestCommonMethods initOneSignalAndThreadWait];
+    [UnitTestCommonMethods runBackgroundThreads];
+    
+    // 5. Ensure the last network call is an on_session
+    // Total calls - 2 ios params + player create + on_session = 4 requests
+    XCTAssertEqualObjects(OneSignalClientOverrider.lastUrl, serverUrlWithPath(@"players/1234/on_session"));
+    XCTAssertEqual(OneSignalClientOverrider.networkRequestCount, 4);
+    
+    // 6. Make sure IAMs are available, but not in queue
+    XCTAssertTrue([OSMessagingController.sharedInstance getInAppMessages].count > 0);
+    
+    // 7. Make sure 1 IAM is persisted
+    cachedMessages = [OneSignalUserDefaults.initStandard getSavedCodeableDataForKey:OS_IAM_MESSAGES_ARRAY defaultValue:nil];
+    XCTAssertEqual(1, cachedMessages.count);
+}
+
+/**
+ Make sure on_session IAMs are pulled for the specific app_id
+ For this test we have mocked a single IAM in the on_session request response
+ After first on_session IAMs will be cached, now force quit app and return in less than 30 seconds to make sure cached IAMs are used instead
+*/
+- (void)testIAMsCacheAvailable_afterOnSession_andAppRestart {
+    // 1. Make sure 0 IAMs are persisted
+    NSArray *cachedMessages = [OneSignalUserDefaults.initStandard getSavedCodeableDataForKey:OS_IAM_MESSAGES_ARRAY defaultValue:nil];
+    XCTAssertNil(cachedMessages);
+    
+    // 2. Open app
+    [UnitTestCommonMethods initOneSignalAndThreadWait];
+    
+    // 3. Kill the app and wait 31 seconds
+    [UnitTestCommonMethods backgroundApp];
+    [NSDateOverrider advanceSystemTimeBy:31];
+    [UnitTestCommonMethods runBackgroundThreads];
+    
+    // 4. Open app
+    [UnitTestCommonMethods initOneSignalAndThreadWait];
+    
+    // 5. Ensure the last network call is an on_session
+    // Total calls - ios params + 2 on_session = 3 requests
+    XCTAssertEqualObjects(OneSignalClientOverrider.lastUrl, serverUrlWithPath(@"players/1234/on_session"));
+    XCTAssertEqual(OneSignalClientOverrider.networkRequestCount, 3);
+    
+    // 6. Make sure IAMs are available
+    XCTAssertTrue([OSMessagingController.sharedInstance getInAppMessages].count > 0);
+    
+    // 7. Don't make an on_session call if only out of the app for 10 secounds
+    [UnitTestCommonMethods clearStateForAppRestart:self];
+    [UnitTestCommonMethods backgroundApp];
+    [NSDateOverrider advanceSystemTimeBy:10];
+    [UnitTestCommonMethods runBackgroundThreads];
+    
+    // 8. Make sure no more IAMs exist
+    XCTAssertTrue([OSMessagingController.sharedInstance getInAppMessages].count == 0);
+    
+    // 9. Open app
+    [UnitTestCommonMethods initOneSignalAndThreadWait];
+    [UnitTestCommonMethods runBackgroundThreads];
+    
+    // 10. Make sure 1 IAM is persisted
+    cachedMessages = [OneSignalUserDefaults.initStandard getSavedCodeableDataForKey:OS_IAM_MESSAGES_ARRAY defaultValue:nil];
+    XCTAssertEqual(1, cachedMessages.count);
+    
+    // 11. Make sure IAMs are available
+    XCTAssertTrue([OSMessagingController.sharedInstance getInAppMessages].count > 0);
+    // Total calls - ios params + 2 on_session + 1 ios params + 1 on_session = 5 requests
+    XCTAssertEqual(OneSignalClientOverrider.networkRequestCount, 5);
 }
 
 /**
@@ -187,6 +273,8 @@ - (void)testDelaysSettingUpTimers {
 }
 
 - (void)testIAMWithRedisplay {
+    [OneSignal pauseInAppMessages:false];
+    
     let limit = 5;
     let delay = 60;
     let firstTrigger = [OSTrigger customTriggerWithProperty:@"prop1" withOperator:OSTriggerOperatorTypeExists withValue:nil];
@@ -339,6 +427,8 @@ - (void)testRemoveTriggers {
 }
 
 - (void)testIAMWithNoTriggersDisplayOnePerSession_Redisplay {
+    [OneSignal pauseInAppMessages:false];
+    
     let limit = 5;
     let delay = 60;
 
@@ -394,6 +484,8 @@ - (void)testIAMWithNoTriggersDisplayOnePerSession_Redisplay {
 }
 
 - (void)testIAMShowAfterRemoveTrigger_Redisplay {
+    [OneSignal pauseInAppMessages:false];
+    
     [OSMessagingController.sharedInstance setTriggerWithName:@"prop1" withValue:@2];
     let limit = 5;
     let delay = 60;
@@ -556,6 +648,8 @@ - (void)testPastButValidExactTimeTrigger {
 
 // when an in-app message is displayed to the user, the SDK should launch an API request
 - (void)testIAMViewedLaunchesViewedAPIRequest {
+    [OneSignal pauseInAppMessages:false];
+    
     let message = [OSInAppMessageTestHelper testMessageJsonWithTriggerPropertyName:OS_DYNAMIC_TRIGGER_KIND_SESSION_TIME withId:@"test_id1" withOperator:OSTriggerOperatorTypeLessThan withValue:@10.0];
 
     let registrationResponse = [OSInAppMessageTestHelper testRegistrationJsonWithMessages:@[message]];