Merge pull request #949 from OneSignal/fix/iam_display_twice

Fixing IAM displaying twice on cold start

Author: emawby

iOS_SDK/OneSignalSDK/Source/OSMessagingController.m

@@ -160,7 +160,6 @@ - (instancetype)init {
 
 - (void)updateInAppMessagesFromCache {
     self.messages = [OneSignalUserDefaults.initStandard getSavedCodeableDataForKey:OS_IAM_MESSAGES_ARRAY defaultValue:[NSArray new]];
-
     [self evaluateMessages];
 }
 
@@ -241,8 +240,9 @@ - (void)presentInAppMessage:(OSInAppMessage *)message {
             [self.messageDisplayQueue addObject:message];
 
         // Return early if an IAM is already showing
-        if (self.isInAppMessageShowing)
+        if (self.isInAppMessageShowing) {
             return;
+        }
         // Return early if the app is not active
         if (![UIApplication applicationIsActive]) {
             [OneSignal onesignal_Log:ONE_S_LL_VERBOSE message:@"Pause IAMs display due to app inactivity"];
@@ -286,7 +286,6 @@ - (void)displayMessage:(OSInAppMessage *)message {
         [OneSignal onesignal_Log:ONE_S_LL_VERBOSE message:@"In app messages will not show while paused"];
         return;
     }
-    
     self.isInAppMessageShowing = true;
     [self showMessage:message];
 }
@@ -485,7 +484,8 @@ - (BOOL)hasMessageTriggerChanged:(OSInAppMessage *)message {
 - (BOOL)shouldShowInAppMessage:(OSInAppMessage *)message {
     return ![self.seenInAppMessages containsObject:message.messageId] &&
            [self.triggerController messageMatchesTriggers:message] &&
-           ![message isFinished];
+           ![message isFinished] &&
+           OneSignal.isRegisterUserFinished;
 }
 
 - (void)handleMessageActionWithURL:(OSInAppMessageAction *)action {

iOS_SDK/OneSignalSDK/Source/OSStateSynchronizer.m

@@ -48,7 +48,7 @@ + (void)setEmailUserId:(NSString *)emailUserId;
 + (void)saveExternalIdAuthToken:(NSString *)hashToken;
 + (void)saveSMSNumber:(NSString *)smsNumber withAuthToken:(NSString *)smsAuthToken userId:(NSString *)smsPlayerId;
 + (void)registerUserFinished;
-
++ (void)registerUserSuccessful;
 @end
 
 @interface OSStateSynchronizer ()
@@ -129,7 +129,7 @@ - (void)registerUserWithState:(OSUserState *)registrationState withSuccess:(OSMu
 
     [OneSignalClient.sharedClient executeSimultaneousRequests:requests withSuccess:^(NSDictionary<NSString *, NSDictionary *> *results) {
         [OneSignal onesignal_Log:ONE_S_LL_VERBOSE message:[NSString stringWithFormat:@"on_session result: %@", results]];
-        [OneSignal registerUserFinished];
+        [OneSignal registerUserSuccessful];
 
         // If the external user ID was sent as part of this request, we need to save it
         // Cache the external id if it exists within the registration payload
@@ -186,6 +186,7 @@ - (void)registerUserWithState:(OSUserState *)registrationState withSuccess:(OSMu
         for (NSString *key in @[OS_PUSH, OS_EMAIL])
             [OneSignal onesignal_Log:ONE_S_LL_ERROR message:[NSString stringWithFormat: @"Encountered error during %@ registration with OneSignal: %@", key, errors[key]]];
 
+        [OneSignal registerUserFinished];
         if (failureBlock)
             failureBlock(errors);
     }];

iOS_SDK/OneSignalSDK/Source/OSSubscription.m

@@ -181,7 +181,7 @@ + (void)fireChangesObserver:(OSSubscriptionState*)state {
     OSSubscriptionStateChanges* stateChanges = [OSSubscriptionStateChanges alloc];
     stateChanges.from = OneSignal.lastSubscriptionState;
     stateChanges.to = [state copy];
-    if (OneSignal.isRegisterUserFinished) {
+    if (OneSignal.isRegisterUserSuccessful) {
         BOOL hasReceiver = [OneSignal.subscriptionStateChangesObserver notifyChange:stateChanges];
 
         if (hasReceiver) {

iOS_SDK/OneSignalSDK/Source/OneSignal.m

@@ -471,10 +471,15 @@ + (NSString*)mUserId {
 + (void)setUserId:(NSString *)userId {
     self.currentSubscriptionState.userId = userId;
 }
-
+// This is set to true even if register user fails
 + (void)registerUserFinished {
     _registerUserFinished = true;
 }
+// If successful then register user is also finished
++ (void)registerUserSuccessful {
+    _registerUserSuccessful = true;
+    [OneSignal registerUserFinished];
+}
 
 + (NSString *)mEmailAuthToken {
     return self.currentEmailSubscriptionState.emailAuthCode;
@@ -593,6 +598,7 @@ + (void)clearStatics {
     _outcomeEventsController = nil;
 
     _registerUserFinished = false;
+    _registerUserSuccessful = false;
 
     _delayedSMSParameters = nil;
 }
@@ -1663,6 +1669,11 @@ + (BOOL)isRegisterUserFinished {
     return _registerUserFinished || isOnSessionSuccessfulForCurrentState;
 }
 
+static BOOL _registerUserSuccessful = false;
++ (BOOL)isRegisterUserSuccessful {
+    return _registerUserSuccessful || isOnSessionSuccessfulForCurrentState;
+}
+
 + (BOOL)shouldRegisterNow {
     // return if the user has not granted privacy permissions
     if ([self shouldLogMissingPrivacyConsentErrorWithMethodName:nil])
@@ -1832,6 +1843,7 @@ + (OSUserState *)createUserState {
 + (void)registerUserInternal {
     [OneSignal onesignal_Log:ONE_S_LL_VERBOSE message:@"registerUserInternal"];
     _registerUserFinished = false;
+    _registerUserSuccessful = false;
 
     // return if the user has not granted privacy permissions
     if ([self shouldLogMissingPrivacyConsentErrorWithMethodName:nil])
@@ -1938,6 +1950,7 @@ + (void)registerUserInternal {
                     callbackSet.failureBlock(error);
             }
         }
+        [OSMessagingController.sharedInstance updateInAppMessagesFromCache];
     }];
 }
 

iOS_SDK/OneSignalSDK/Source/OneSignalInternal.h

@@ -79,7 +79,10 @@
 
 @property (class, readonly) BOOL didCallDownloadParameters;
 @property (class, readonly) BOOL downloadedParameters;
+//Indicates we have attempted to register the user and it has succeeded or failed
 @property (class, readonly) BOOL isRegisterUserFinished;
+//Indicates that registering the user was successful
+@property (class, readonly) BOOL isRegisterUserSuccessful;
 
 @property (class) NSObject<OneSignalNotificationSettings>* _Nonnull osNotificationSettings;
 @property (class) OSPermissionState* _Nonnull currentPermissionState;

iOS_SDK/OneSignalSDK/UnitTests/InAppMessagingIntegrationTests.m

@@ -439,6 +439,51 @@ - (void)testIAMWithRedisplay {
     XCTAssertTrue(secondLastDisplayTime - firstInterval >= delay);
 }
 
+- (void)testCachedIAMsDonotDisplayUntilRegisterUser {
+    let limit = 5;
+    let delay = 30;
+
+    let message = [OSInAppMessageTestHelper testMessageWithRedisplayLimit:limit delay:@(delay)];
+    //Time interval mock
+    NSDateComponents* comps = [[NSDateComponents alloc]init];
+    comps.year = 2019;
+    comps.month = 6;
+    comps.day = 10;
+    comps.hour = 10;
+    comps.minute = 1;
+
+    NSCalendar* calendar = [NSCalendar currentCalendar];
+    NSDate* date = [calendar dateFromComponents:comps];
+    NSTimeInterval firstInterval = [date timeIntervalSince1970];
+    NSMutableSet <NSString *> *seenMessages = [NSMutableSet new];
+    [OSMessagingControllerOverrider setSeenMessages:seenMessages];
+
+    message.displayStats.lastDisplayTime = firstInterval - delay;
+    // Save IAM to messages cache
+    [OneSignalUserDefaults.initStandard saveCodeableDataForKey:OS_IAM_MESSAGES_ARRAY withValue:@[message]];
+    
+    [OSMessagingControllerOverrider setMockDateGenerator: ^NSTimeInterval(void) {
+        return firstInterval;
+    }];
+    
+    [OneSignal setAppId:@"b2f7f966-d8cc-11e4-bed1-df8f05be55ba"];
+    
+    [[OSMessagingController sharedInstance] updateInAppMessagesFromCache];
+
+    [OneSignal pauseInAppMessages:false];
+
+    // IAM should not be shown since we have not initialized OneSignal
+    XCTAssertEqual(0, OSMessagingControllerOverrider.messageDisplayQueue.count);
+    XCTAssertFalse(OSMessagingControllerOverrider.isInAppMessageShowing);
+    
+    [self initOneSignalWithInAppMessage:message];
+    XCTAssertEqual(1, OSMessagingControllerOverrider.messageDisplayQueue.count);
+    XCTAssertTrue(OSMessagingControllerOverrider.isInAppMessageShowing);
+    [OSMessagingControllerOverrider dismissCurrentMessage];
+    XCTAssertEqual(0, OSMessagingControllerOverrider.messageDisplayQueue.count);
+    XCTAssertFalse(OSMessagingControllerOverrider.isInAppMessageShowing);
+}
+
 - (void)testIAMClickLaunchesAPIRequestMultipleTimes_Redisplay {
     let limit = 5;
     let delay = 60;