have a separate model store just for push sub

* Motivation: push sub behaves differently from other subscriptions and is not cleared from the store when a user changes. Separate it into its own store so that the email and sms subscriptions stores can be cleared but the push subscription store is not.

Author: nan-li

iOS_SDK/OneSignalSDK/OneSignalCore/Source/OneSignalCommonDefines.h

@@ -291,6 +291,7 @@ typedef enum {GET, POST, HEAD, PUT, DELETE, OPTIONS, CONNECT, TRACE, PATCH} HTTP
 #define OS_PROPERTIES_MODEL_KEY                                             @"OS_PROPERTIES_MODEL_KEY"
 #define OS_PROPERTIES_MODEL_STORE_KEY                                       @"OS_PROPERTIES_MODEL_STORE_KEY"
 #define OS_PUSH_SUBSCRIPTION_MODEL_KEY                                      @"OS_PUSH_SUBSCRIPTION_MODEL_KEY"
+#define OS_PUSH_SUBSCRIPTION_MODEL_STORE_KEY                                @"OS_PUSH_SUBSCRIPTION_MODEL_STORE_KEY"
 #define OS_SUBSCRIPTION_MODEL_STORE_KEY                                     @"OS_SUBSCRIPTION_MODEL_STORE_KEY"
 
 #define OS_ADD_ALIAS_DELTA                                                  @"OS_ADD_ALIAS_DELTA"

iOS_SDK/OneSignalSDK/OneSignalOSCore/Source/OSModelStore.swift

@@ -126,18 +126,8 @@ open class OSModelStore<TModel: OSModel>: NSObject {
      When the User changes, the Subscription Model Store must remove all models.
      In contrast, it is not necessary for the Identity or Properties Model Stores to do so.
      */
-    public func clearModelsFromStore(modelToKeepId: String?) {
-        // TODO: For now, uglily have param for model to keep as workaround for clearing all models except push sub
-        // When we have a new user, the subscription store should be cleared except for push sub
-        // That's currently the only model store we call this from.
-        if let modelToKeepId,
-           let modelToKeep = self.models[modelToKeepId]
-        {
-            self.models = [modelToKeepId: modelToKeep]
-            OneSignalUserDefaults.initShared().saveCodeableData(forKey: self.storeKey, withValue: self.models)
-        } else {
-            self.models = [:]
-        }
+    public func clearModelsFromStore() {
+        self.models = [:]
     }
 }
 

iOS_SDK/OneSignalSDK/OneSignalUser/Source/OneSignalUserManagerImpl.swift

@@ -140,15 +140,19 @@ public class OneSignalUserManagerImpl: NSObject, OneSignalUserManager {
         return pushSubscriptionStateChangesObserver
     }
 
-    // has Identity, Properties, and Subscription Model Stores
+    // has Identity, Properties, Subscription, and Push Subscription Model Stores
     let identityModelStore = OSModelStore<OSIdentityModel>(changeSubscription: OSEventProducer(), storeKey: OS_IDENTITY_MODEL_STORE_KEY)
     let propertiesModelStore = OSModelStore<OSPropertiesModel>(changeSubscription: OSEventProducer(), storeKey: OS_PROPERTIES_MODEL_STORE_KEY)
+    // Holds email and sms subscription models
     let subscriptionModelStore = OSModelStore<OSSubscriptionModel>(changeSubscription: OSEventProducer(), storeKey: OS_SUBSCRIPTION_MODEL_STORE_KEY)
+    // Holds a single push subscription model
+    let pushSubscriptionModelStore = OSModelStore<OSSubscriptionModel>(changeSubscription: OSEventProducer(), storeKey: OS_PUSH_SUBSCRIPTION_MODEL_STORE_KEY)
 
     // These must be initialized in init()
     let identityModelStoreListener: OSIdentityModelStoreListener
     let propertiesModelStoreListener: OSPropertiesModelStoreListener
     let subscriptionModelStoreListener: OSSubscriptionModelStoreListener
+    let pushSubscriptionModelStoreListener: OSSubscriptionModelStoreListener
 
     // has Property and Identity operation executors
     let propertyExecutor = OSPropertyOperationExecutor()
@@ -159,6 +163,7 @@ public class OneSignalUserManagerImpl: NSObject, OneSignalUserManager {
         self.identityModelStoreListener = OSIdentityModelStoreListener(store: identityModelStore)
         self.propertiesModelStoreListener = OSPropertiesModelStoreListener(store: propertiesModelStore)
         self.subscriptionModelStoreListener = OSSubscriptionModelStoreListener(store: subscriptionModelStore)
+        self.pushSubscriptionModelStoreListener = OSSubscriptionModelStoreListener(store: pushSubscriptionModelStore)
     }
 
     // TODO: This method is called A LOT, check if all calls are needed.
@@ -180,7 +185,7 @@ public class OneSignalUserManagerImpl: NSObject, OneSignalUserManager {
         // Corrupted state if any of these models exist without the others
         if let identityModel = identityModelStore.getModels()[OS_IDENTITY_MODEL_KEY],
            let propertiesModel = propertiesModelStore.getModels()[OS_PROPERTIES_MODEL_KEY],
-           let pushSubscription = subscriptionModelStore.getModels()[OS_PUSH_SUBSCRIPTION_MODEL_KEY] {
+           let pushSubscription = pushSubscriptionModelStore.getModels()[OS_PUSH_SUBSCRIPTION_MODEL_KEY] {
             _user = OSUserInternalImpl(identityModel: identityModel, propertiesModel: propertiesModel, pushSubscriptionModel: pushSubscription)
         }
 
@@ -191,6 +196,7 @@ public class OneSignalUserManagerImpl: NSObject, OneSignalUserManager {
         identityModelStoreListener.start()
         propertiesModelStoreListener.start()
         subscriptionModelStoreListener.start()
+        pushSubscriptionModelStoreListener.start()
 
         // Setup the executors
         OSUserExecutor.start()
@@ -226,7 +232,7 @@ public class OneSignalUserManagerImpl: NSObject, OneSignalUserManager {
             }
         }
 
-        let pushSubscriptionModel = subscriptionModelStore.getModel(key: OS_PUSH_SUBSCRIPTION_MODEL_KEY)
+        let pushSubscriptionModel = pushSubscriptionModelStore.getModel(key: OS_PUSH_SUBSCRIPTION_MODEL_KEY)
         prepareForNewUser()
 
         let newUser = setNewInternalUser(externalId: externalId, pushSubscriptionModel: pushSubscriptionModel)
@@ -251,7 +257,7 @@ public class OneSignalUserManagerImpl: NSObject, OneSignalUserManager {
         let identityModelToIdentify = currentUser.identityModel
 
         // Immediately drop the old user and set a new user in the SDK
-        let pushSubscriptionModel = subscriptionModelStore.getModel(key: OS_PUSH_SUBSCRIPTION_MODEL_KEY)
+        let pushSubscriptionModel = pushSubscriptionModelStore.getModel(key: OS_PUSH_SUBSCRIPTION_MODEL_KEY)
         prepareForNewUser()
         let newUser = setNewInternalUser(externalId: externalId, pushSubscriptionModel: pushSubscriptionModel)
 
@@ -313,7 +319,7 @@ public class OneSignalUserManagerImpl: NSObject, OneSignalUserManager {
         NotificationCenter.default.post(name: Notification.Name(OS_ON_USER_WILL_CHANGE), object: nil)
 
         // This store MUST be cleared, Identity and Properties do not.
-        subscriptionModelStore.clearModelsFromStore(modelToKeepId: OS_PUSH_SUBSCRIPTION_MODEL_KEY)
+        subscriptionModelStore.clearModelsFromStore()
     }
 
     /**
@@ -338,8 +344,8 @@ public class OneSignalUserManagerImpl: NSObject, OneSignalUserManager {
         let pushSubscription = pushSubscriptionModel ?? createDefaultPushSubscription()
 
         // Add pushSubscription to store if not present
-        if (!subscriptionModelStore.getModels().keys.contains(OS_PUSH_SUBSCRIPTION_MODEL_KEY)) {
-            subscriptionModelStore.add(id: OS_PUSH_SUBSCRIPTION_MODEL_KEY, model: pushSubscription)
+        if (!pushSubscriptionModelStore.getModels().keys.contains(OS_PUSH_SUBSCRIPTION_MODEL_KEY)) {
+            pushSubscriptionModelStore.add(id: OS_PUSH_SUBSCRIPTION_MODEL_KEY, model: pushSubscription)
         }
 
         _user = OSUserInternalImpl(identityModel: identityModel, propertiesModel: propertiesModel, pushSubscriptionModel: pushSubscription)