Fix for subscribe issue, on cold start always unsubscribed (#599)

* Fix for subscribe issue, on cold start always unsubscribed
* During previous refactoring for USerDefault keys an issue was caused with SUBSCRIPTION key
* Two essential checks (OneSignal.m and OSSubscription.m) were changed and should not have been
* When pausing in app messaging, this only prevented items from being added to the queue, instead of from showing

* Demo app changes
  * Moved all UI property to ViewController.h interface so that the AppDelegate.m has access to them
  * Added a subscribe segment control (like consent and pausing IAM) to demo app, connected subscription observer
  * When subscription changes so does the segment control will also
  * Made segment control selected switches green instead
  * Fixed white text problem due to default in dark mode

* SDK changes
  * Reverted change for the SUBSCRIPTION key to fix the always unsubscribed issue
  * Using keyExists in OSSubscription.m now, replaces getSavedObjectForKey and objectForKey
  * Reverted changes for saving SUBSCRIPTION status in OneSignal.m
  * Moved the check for paused in app messaging so that queue items won't be shown now

* Fixing comments from previous commit in PR
* Additional clean-up (sorting and naming) to the OneSignalUserDefault keys
* Fixed a unit test after changing functionality of the pause IAM flag
  * Continuously accumulate IAMs in the queue, but don't show any IAMs until IAMs are enabled again

* Fixing comments from previous commit in PR
* Changes in OneSignalCommonDefines for OneSignalUserDefault (NSUserDefaults) keys
  * Now we add suffixes to keys with a to and from state ("_TO" or "_FROM")
  * Organized and renamed any confusing or inconsistent keys
  * String values need to be changed still, but we do not know of the affects here and should wait to do anything with the string values until we have a proper migration solution
* Removed 2 "saveForBoolKey" methods because they are not using the getter "getBoolForSavedKey" anywhere
  * To be more specific, OSUD_PERMISSION_ACCEPTED_TO, OSUD_WAS_PROMPTED_FOR_NOTIFICATIONS_TO, OSUD_PROVISIONAL_PUSH_AUTHORIZATION_TO al;l are not used in any setters or getters for UserDefaults
  * We may need these in the future and we currently use their FROM variants

Author: mikechoch

iOS_SDK/OneSignalDevApp/OneSignalDevApp/AppDelegate.m

@@ -29,10 +29,10 @@
 // This project exisits to make testing OneSignal SDK changes.
 
 #import "AppDelegate.h"
+#import "ViewController.h"
 
 @implementation AppDelegate
 
-
 - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
 
 //    [FIRApp configure];
@@ -64,8 +64,6 @@ - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(
         [OneSignal onesignal_Log:ONE_S_LL_DEBUG message:message];
     };
 
-    [OneSignal setSubscription:true];
-
     // Example setter for IAM action click handler using OneSignal public method
     [OneSignal setInAppMessageClickHandler:inAppMessagingActionClickBlock];
 
@@ -105,19 +103,18 @@ + (void) setOneSignalAppId:(NSString*)onesignalAppId {
     [[NSUserDefaults standardUserDefaults] synchronize];
 }
 
-- (void) onOSSubscriptionChanged:(OSSubscriptionStateChanges*)stateChanges {
-    NSLog(@"onOSSubscriptionChanged: %@", stateChanges);
-    NSLog(@"HERE");
-}
-
 - (void) onOSPermissionChanged:(OSPermissionStateChanges*)stateChanges {
     NSLog(@"onOSPermissionChanged: %@", stateChanges);
-    NSLog(@"HERE");
 }
 
--(void)onOSEmailSubscriptionChanged:(OSEmailSubscriptionStateChanges *)stateChanges {
+- (void) onOSSubscriptionChanged:(OSSubscriptionStateChanges*)stateChanges {
+    NSLog(@"onOSSubscriptionChanged: %@", stateChanges);
+    ViewController* mainController = (ViewController*) self.window.rootViewController;
+    mainController.subscriptionSegmentedControl.selectedSegmentIndex = (NSInteger) stateChanges.to.subscribed;
+}
+
+- (void)onOSEmailSubscriptionChanged:(OSEmailSubscriptionStateChanges *)stateChanges {
     NSLog(@"onOSEmailSubscriptionChanged: %@", stateChanges);
-    
 }
 
 - (void)applicationWillResignActive:(UIApplication *)application {

iOS_SDK/OneSignalDevApp/OneSignalDevApp/Base.lproj/Main.storyboard

@@ -33,5 +33,23 @@
 
 @interface ViewController : UIViewController <OSInAppMessageDelegate>
 
+    @property (weak, nonatomic) IBOutlet UITextField *appIdTextField;
+    @property (weak, nonatomic) IBOutlet UIActivityIndicatorView *activityIndicatorView;
+    @property (weak, nonatomic) IBOutlet UISegmentedControl *consentSegmentedControl;
+    @property (weak, nonatomic) IBOutlet UISegmentedControl *subscriptionSegmentedControl;
+    @property (weak, nonatomic) IBOutlet UISegmentedControl *inAppMessagingSegmentedControl;
+    @property (weak, nonatomic) IBOutlet UITextField *addTriggerKey;
+    @property (weak, nonatomic) IBOutlet UITextField *addTriggerValue;
+    @property (weak, nonatomic) IBOutlet UIButton *addTriggerButton;
+    @property (weak, nonatomic) IBOutlet UITextField *removeTriggerKey;
+    @property (weak, nonatomic) IBOutlet UITextField *getTriggerKey;
+    @property (weak, nonatomic) IBOutlet UILabel *infoLabel;
+    @property (weak, nonatomic) IBOutlet UITextField *externalIdTextField;
+    @property (weak, nonatomic) IBOutlet UITextField *outcomeName;
+    @property (weak, nonatomic) IBOutlet UITextField *outcomeValueName;
+    @property (weak, nonatomic) IBOutlet UITextField *outcomeValue;
+    @property (weak, nonatomic) IBOutlet UITextField *outcomeUniqueName;
+    @property (weak, nonatomic) IBOutlet UITextView *result;
+
 @end
 

iOS_SDK/OneSignalDevApp/OneSignalDevApp/ViewController.h

@@ -31,27 +31,6 @@
 #import "ViewController.h"
 #import "AppDelegate.h"
 
-
-@interface ViewController ()
-@property (weak, nonatomic) IBOutlet UITextField *appIdTextField;
-@property (weak, nonatomic) IBOutlet UIActivityIndicatorView *activityIndicatorView;
-@property (weak, nonatomic) IBOutlet UISegmentedControl *consentSegmentedControl;
-@property (weak, nonatomic) IBOutlet UISegmentedControl *inAppMessagingSegmentedControl;
-@property (weak, nonatomic) IBOutlet UITextField *addTriggerKey;
-@property (weak, nonatomic) IBOutlet UITextField *addTriggerValue;
-@property (weak, nonatomic) IBOutlet UIButton *addTriggerButton;
-@property (weak, nonatomic) IBOutlet UITextField *removeTriggerKey;
-@property (weak, nonatomic) IBOutlet UITextField *getTriggerKey;
-@property (weak, nonatomic) IBOutlet UILabel *infoLabel;
-@property (weak, nonatomic) IBOutlet UITextField *externalIdTextField;
-@property (weak, nonatomic) IBOutlet UITextField *outcomeName;
-@property (weak, nonatomic) IBOutlet UITextField *outcomeValueName;
-@property (weak, nonatomic) IBOutlet UITextField *outcomeValue;
-@property (weak, nonatomic) IBOutlet UITextField *outcomeUniqueName;
-@property (weak, nonatomic) IBOutlet UITextView *result;
-
-@end
-
 @implementation ViewController
 
 - (void)viewDidLoad {
@@ -60,9 +39,11 @@ - (void)viewDidLoad {
 
     self.activityIndicatorView.hidden = true;
 
-    self.consentSegmentedControl.selectedSegmentIndex = (NSInteger)![OneSignal requiresUserPrivacyConsent];
+    self.consentSegmentedControl.selectedSegmentIndex = (NSInteger) ![OneSignal requiresUserPrivacyConsent];
 
-    self.inAppMessagingSegmentedControl.selectedSegmentIndex = (NSInteger)![OneSignal isInAppMessagingPaused];
+    self.subscriptionSegmentedControl.selectedSegmentIndex = (NSInteger) OneSignal.getPermissionSubscriptionState.subscriptionStatus.subscribed;
+    
+    self.inAppMessagingSegmentedControl.selectedSegmentIndex = (NSInteger) ![OneSignal isInAppMessagingPaused];
 
     self.appIdTextField.text = [AppDelegate getOneSignalAppId];
 
@@ -102,9 +83,8 @@ - (IBAction)getTriggersAction:(id)sender {
 }
 
 - (IBAction)sendTagButton:(id)sender {
-    //[self promptForNotificationsWithNativeiOS10Code];
-    
-    //[OneSignal registerForPushNotifications];
+//    [self promptForNotificationsWithNativeiOS10Code];
+//    [OneSignal registerForPushNotifications];
 
     [OneSignal promptForPushNotificationsWithUserResponse:^(BOOL accepted) {
         NSLog(@"NEW SDK 2.5.0 METHDO: promptForPushNotificationsWithUserResponse: %d", accepted);
@@ -146,13 +126,18 @@ - (void)didReceiveMemoryWarning {
 }
 
 - (IBAction)consentSegmentedControlValueChanged:(UISegmentedControl *)sender {
-    NSLog(@"View controller consent granted: %i", (int)sender.selectedSegmentIndex);
-    [OneSignal consentGranted:(bool)sender.selectedSegmentIndex];
+    NSLog(@"View controller consent granted: %i", (int) sender.selectedSegmentIndex);
+    [OneSignal consentGranted:(bool) sender.selectedSegmentIndex];
+}
+
+- (IBAction)subscriptionSegmentedControlValueChanged:(UISegmentedControl *)sender {
+    NSLog(@"View controller subscription status: %i", (int) sender.selectedSegmentIndex);
+    [OneSignal setSubscription:(bool) sender.selectedSegmentIndex];
 }
 
 - (IBAction)inAppMessagingSegmentedControlValueChanged:(UISegmentedControl *)sender {
-    NSLog(@"View controller in app messaging paused: %i", (int)sender.selectedSegmentIndex);
-    [OneSignal pauseInAppMessages:(bool)sender.selectedSegmentIndex];
+    NSLog(@"View controller in app messaging paused: %i", (int) !sender.selectedSegmentIndex);
+    [OneSignal pauseInAppMessages:(bool) !sender.selectedSegmentIndex];
 }
 
 -(void)handleMessageAction:(NSString *)actionId {

iOS_SDK/OneSignalDevApp/OneSignalDevApp/ViewController.m

@@ -61,7 +61,7 @@ - (int)getMinSessionTime {
 }
 
 - (NSString*)unsentActiveTimeUserDefaultsKey {
-    return UNSENT_ACTIVE_TIME_ATTRIBUTED;
+    return OSUD_UNSENT_ACTIVE_TIME_ATTRIBUTED;
 }
 
 - (void)sendOnFocusCall:(OSFocusCallParams *)params {

iOS_SDK/OneSignalSDK/Source/OSAttributedFocusTimeProcessor.m

@@ -40,10 +40,10 @@ - (ObservableEmailSubscriptionStateType *)observable {
 
 - (instancetype)init {
     let standardUserDefaults = OneSignalUserDefaults.initStandard;
-    _emailAddress = [standardUserDefaults getSavedStringForKey:EMAIL_ADDRESS defaultValue:nil];
-    _requiresEmailAuth = [standardUserDefaults getSavedBoolForKey:REQUIRE_EMAIL_AUTH defaultValue:false];
-    _emailAuthCode = [standardUserDefaults getSavedStringForKey:EMAIL_AUTH_CODE defaultValue:nil];
-    _emailUserId = [standardUserDefaults getSavedStringForKey:EMAIL_USERID defaultValue:nil];
+    _emailAddress = [standardUserDefaults getSavedStringForKey:OSUD_EMAIL_ADDRESS defaultValue:nil];
+    _requiresEmailAuth = [standardUserDefaults getSavedBoolForKey:OSUD_REQUIRE_EMAIL_AUTH defaultValue:false];
+    _emailAuthCode = [standardUserDefaults getSavedStringForKey:OSUD_EMAIL_AUTH_CODE defaultValue:nil];
+    _emailUserId = [standardUserDefaults getSavedStringForKey:OSUD_EMAIL_PLAYER_ID defaultValue:nil];
 
     return self;
 }
@@ -54,10 +54,10 @@ -(BOOL)subscribed {
 
 - (void)persist {
     let standardUserDefaults = OneSignalUserDefaults.initStandard;
-    [standardUserDefaults saveStringForKey:EMAIL_ADDRESS withValue:_emailAddress];
-    [standardUserDefaults saveBoolForKey:REQUIRE_EMAIL_AUTH withValue:_requiresEmailAuth];
-    [standardUserDefaults saveStringForKey:EMAIL_AUTH_CODE withValue:_emailAuthCode];
-    [standardUserDefaults saveStringForKey:EMAIL_USERID withValue:_emailUserId];
+    [standardUserDefaults saveStringForKey:OSUD_EMAIL_ADDRESS withValue:_emailAddress];
+    [standardUserDefaults saveBoolForKey:OSUD_REQUIRE_EMAIL_AUTH withValue:_requiresEmailAuth];
+    [standardUserDefaults saveStringForKey:OSUD_EMAIL_AUTH_CODE withValue:_emailAuthCode];
+    [standardUserDefaults saveStringForKey:OSUD_EMAIL_PLAYER_ID withValue:_emailUserId];
 }
 
 - (NSString *)description {

iOS_SDK/OneSignalSDK/Source/OSEmailSubscription.m

@@ -34,8 +34,8 @@
 NS_ASSUME_NONNULL_BEGIN
 
 @interface OSMessagingController : NSObject <OSInAppMessageViewControllerDelegate, OSTriggerControllerDelegate>
-  
-@property (nonatomic) BOOL isInAppMessagingPaused;
+
+@property (class, readonly) BOOL isInAppMessagingPaused;
 
 // Tracks when an IAM is showing or not, useful for deciding to show or hide an IAM
 // Toggled in two places dismissing/displaying

iOS_SDK/OneSignalSDK/Source/OSMessagingController.h

@@ -58,11 +58,9 @@ @interface OSMessagingController ()
 @end
 
 @implementation OSMessagingController
-@synthesize isInAppMessagingPaused = _isInAppMessagingPaused;
 
 static OSMessagingController *sharedInstance = nil;
 static dispatch_once_t once;
-
 + (OSMessagingController *)sharedInstance {
     dispatch_once(&once, ^{
         // Make sure only devices with iOS 10 or newer can use IAMs
@@ -79,6 +77,18 @@ + (void)removeInstance {
     once = NULL;
 }
 
+static BOOL _isInAppMessagingPaused = false;
+- (BOOL)isInAppMessagingPaused {
+    return _isInAppMessagingPaused;
+}
+- (void)setInAppMessagingPaused:(BOOL)pause {
+    _isInAppMessagingPaused = pause;
+    
+    // If IAM are not paused, try to evaluate and show IAMs
+    if (!pause)
+        [self evaluateMessages];
+}
+
 + (BOOL)doesDeviceSupportIAM {
     // We do not support Mac Catalyst as it does not display correctly.
     // We could support in the future after we reslove the display issues.
@@ -110,18 +120,6 @@ - (instancetype)init {
     return self;
 }
 
-- (BOOL)isInAppMessagingPaused {
-    return _isInAppMessagingPaused;
-}
-
-- (void)setInAppMessagingPaused:(BOOL)pause {
-    _isInAppMessagingPaused = pause;
-    
-    // If IAM are not paused, try to evaluate and show IAMs
-    if (!pause)
-        [self evaluateMessages];
-}
-
 - (void)didUpdateMessagesForSession:(NSArray<OSInAppMessage *> *)newMessages {
     self.messages = newMessages;
 
@@ -133,22 +131,16 @@ - (void)setInAppMessageClickHandler:(OSHandleInAppMessageActionClickBlock)action
 }
 
 - (void)presentInAppMessage:(OSInAppMessage *)message {
-    // Check if the app disabled IAMs for this device
-    if (_isInAppMessagingPaused)
-        return;
-    
     if (!message.variantId) {
         let errorMessage = [NSString stringWithFormat:@"Attempted to display a message with a nil variantId. Current preferred language is %@, supported message variants are %@", NSLocale.preferredLanguages, message.variants];
         [OneSignal onesignal_Log:ONE_S_LL_ERROR message:errorMessage];
         return;
     }
 
     @synchronized (self.messageDisplayQueue) {
-        // Check if the message already exists in the display queue
-        if ([self isMessageInDisplayQueue:message.messageId])
-            return;
-        
-        [self.messageDisplayQueue addObject:message];
+        // Add the message to the messageDisplayQueue, if it hasn't been added yet
+        if (![self isMessageInDisplayQueue:message.messageId])
+            [self.messageDisplayQueue addObject:message];
 
         // Return early if an IAM is already showing
         if (self.isInAppMessageShowing)
@@ -167,28 +159,31 @@ - (BOOL)isMessageInDisplayQueue:(NSString *)messageId {
     return false;
 }
 
+/*
+ If an IAM is currently showing add the preview right behind it in the messageDisplayQueue and then dismiss the current IAM
+ Otherwise, Add it to the front of the messageDisplayQueue and call displayMessage
+ */
 - (void)presentInAppPreviewMessage:(OSInAppMessage *)message {
     @synchronized (self.messageDisplayQueue) {
-        
-        // If an IAM is currently showing add the preview right behind it in the messageDisplayQueue and then dismiss the current IAM
-        // Otherwise, Add it to the front of the messageDisplayQueue and call displayMessage
         if (self.isInAppMessageShowing) {
-            
-            // Add preview behind current displaying IAM in messageDisplayQueue
+            // Add preview second in messageDisplayQueue
             [self.messageDisplayQueue insertObject:message atIndex:1];
-            // Get current OSInAppMessageViewController and dismiss current IAM showing using dismissMessageWithDirection method
             [self.viewController dismissCurrentInAppMessage];
         } else {
-            
             // Add preview to front of messageDisplayQueue
             [self.messageDisplayQueue insertObject:message atIndex:0];
-            // Show new IAM preview
             [self displayMessage:message];
         }
     };
 }
 
 - (void)displayMessage:(OSInAppMessage *)message {
+    // Check if the app disabled IAMs for this device before showing an IAM
+    if (_isInAppMessagingPaused) {
+        [OneSignal onesignal_Log:ONE_S_LL_VERBOSE message:@"In app messages will not show while paused"];
+        return;
+    }
+    
     self.isInAppMessageShowing = true;
 
     self.viewController = [[OSInAppMessageViewController alloc] initWithMessage:message delegate:self];
@@ -204,7 +199,6 @@ - (void)displayMessage:(OSInAppMessage *)message {
  Request should only be made for IAMs that are not previews and have not been impressioned yet
  */
 - (void)messageViewImpressionRequest:(OSInAppMessage *)message {
-    
     // Make sure no tracking is performed for previewed IAMs
     // If the messageId exists in cached impressionedInAppMessages return early so the impression is not tracked again
     if (message.isPreview || [self.impressionedInAppMessages containsObject:message.messageId])
@@ -240,6 +234,7 @@ - (void)messageViewImpressionRequest:(OSInAppMessage *)message {
  Checks to see if any messages should be shown now
  */
 - (void)evaluateMessages {
+    [OneSignal onesignal_Log:ONE_S_LL_VERBOSE message:@"Evaluating in app messages"];
     for (OSInAppMessage *message in self.messages) {
         // Should we show the in app message
         if ([self shouldShowInAppMessage:message]) {

iOS_SDK/OneSignalSDK/Source/OSMessagingController.m

@@ -29,14 +29,14 @@
 #define OSOutcomeEventsDefines_h
 
 // Outcome param keys
-static NSString * const OUTCOMES_PARAM = @"outcomes";
-static NSString * const DIRECT_PARAM = @"direct";
-static NSString * const INDIRECT_PARAM = @"indirect";
-static NSString * const UNATTRIBUTED_PARAM = @"unattributed";
-static NSString * const ENABLED_PARAM = @"enabled";
-static NSString * const NOTIFICATION_ATTRIBUTION_PARAM = @"notification_attribution";
-static NSString * const MINUTES_SINCE_DISPLAYED_PARAM = @"minutes_since_displayed";
-static NSString * const LIMIT_PARAM = @"limit";
+static NSString* const OUTCOMES_PARAM = @"outcomes";
+static NSString* const DIRECT_PARAM = @"direct";
+static NSString* const INDIRECT_PARAM = @"indirect";
+static NSString* const UNATTRIBUTED_PARAM = @"unattributed";
+static NSString* const ENABLED_PARAM = @"enabled";
+static NSString* const NOTIFICATION_ATTRIBUTION_PARAM = @"notification_attribution";
+static NSString* const MINUTES_SINCE_DISPLAYED_PARAM = @"minutes_since_displayed";
+static NSString* const LIMIT_PARAM = @"limit";
 
 // Outcome default param values
 static int DEFAULT_INDIRECT_NOTIFICATION_LIMIT = 10;