Disable push sub when logout called (JWT on)

Author: nan-li

iOS_SDK/OneSignalSDK/OneSignalUser/Source/Modeling/OSSubscriptionModel.swift

@@ -98,6 +98,10 @@ enum OSSubscriptionType: String {
  Internal subscription model.
  */
 class OSSubscriptionModel: OSModel {
+    struct Constants {
+      static let isDisabledInternallyKey = "isDisabledInternallyKey"
+    }
+
     var type: OSSubscriptionType
 
     var address: String? { // This is token on push subs so must remain Optional
@@ -194,6 +198,21 @@ class OSSubscriptionModel: OSModel {
         }
     }
 
+    /**
+     Set to `true` by the SDK when logout is called with Identity Verification turned on.
+     The properties of `_isDisabled` and `notificationTypes` remain unchanged, to maintain correct data.
+     When a subscription update is made, this value will be read and `enabled = false` and `notification_types = -2` will be sent.
+     When a user logs in, this property will be set to `false` and the subscription will be included in the User Create request..
+     */
+    var _isDisabledInternally = false {
+        didSet {
+            guard _isDisabledInternally != oldValue else {
+                return
+            }
+            self.set(property: Constants.isDisabledInternallyKey, newValue: _isDisabledInternally)
+        }
+    }
+
     // Properties for push subscription
     var testType: Int? {
         didSet {

iOS_SDK/OneSignalSDK/OneSignalUser/Source/Modeling/OSSubscriptionModelStoreListener.swift

@@ -62,6 +62,14 @@ class OSSubscriptionModelStoreListener: OSModelStoreListener {
     }
 
     func getUpdateModelDelta(_ args: OSModelChangedArgs) -> OSDelta? {
+        /*
+         Don't generate a Delta if setting internal disable to false, which will generate a subscription update.
+         This means a user is logging in and a create user will be sent with the updated subscription included.
+         */
+        if args.property == OSSubscriptionModel.Constants.isDisabledInternallyKey && args.newValue as? Bool == false {
+            return nil
+        }
+
         return OSDelta(
             name: OS_UPDATE_SUBSCRIPTION_DELTA,
             identityModelId: OneSignalUserManagerImpl.sharedInstance.user.identityModel.modelId,

iOS_SDK/OneSignalSDK/OneSignalUser/Source/OneSignalUserManagerImpl.swift

@@ -400,6 +400,10 @@ public class OneSignalUserManagerImpl: NSObject, OneSignalUserManager {
         }
         OneSignalLog.onesignalLog(.LL_VERBOSE, message: "OneSignalUserManager internal _login called with externalId: \(externalId ?? "nil")")
 
+        if externalId != nil {
+            pushSubscriptionModel?._isDisabledInternally = false
+        }
+
         /*
          Logging in to a "new-to-the-sdk" externalId from an anonymous user, if JWT is OFF or UNKNOWN.
 
@@ -440,6 +444,13 @@ public class OneSignalUserManagerImpl: NSObject, OneSignalUserManager {
         prepareForNewUser()
         _user = nil
         createUserIfNil()
+
+        /*
+         If Identity Verification is on, disable the push subscription.
+         */
+        if jwtConfig.isRequired == true {
+            user.pushSubscriptionModel._isDisabledInternally = true
+        }
     }
 
     @objc

iOS_SDK/OneSignalSDK/OneSignalUser/Source/Requests/OSRequestUpdateSubscription.swift

@@ -65,17 +65,23 @@ class OSRequestUpdateSubscription: OneSignalRequest, OSUserRequest {
         var subscriptionParams = subscriptionObject
         subscriptionParams.removeValue(forKey: "address")
         subscriptionParams.removeValue(forKey: "notificationTypes")
+        subscriptionParams.removeValue(forKey: OSSubscriptionModel.Constants.isDisabledInternallyKey)
         subscriptionParams["token"] = subscriptionModel.address
         subscriptionParams["device_os"] = subscriptionModel.deviceOs
         subscriptionParams["sdk"] = subscriptionModel.sdk
         subscriptionParams["app_version"] = subscriptionModel.appVersion
 
-        // notificationTypes defaults to -1 instead of nil, don't send if it's -1
-        if subscriptionModel.notificationTypes != -1 {
-            subscriptionParams["notification_types"] = subscriptionModel.notificationTypes
+        if subscriptionModel._isDisabledInternally {
+            subscriptionParams["enabled"] = false
+            subscriptionParams["notification_types"] = -2
+        } else {
+            // notificationTypes defaults to -1 instead of nil, don't send if it's -1
+            if subscriptionModel.notificationTypes != -1 {
+                subscriptionParams["notification_types"] = subscriptionModel.notificationTypes
+            }
+            subscriptionParams["enabled"] = subscriptionModel.enabled
         }
 
-        subscriptionParams["enabled"] = subscriptionModel.enabled
         // TODO: The above is not quite right. If we hydrate, we will over-write any pending updates
         // May use subscriptionObject, but enabled and notification_types should be sent together...