Recreate a push subscription when we detect it is removed

* On a new session, we fetch the user. If we detect our push subscription missing from the user (indicating the push subscription may be deleted), we send a create subscription request for the device's push sub.

Author: nan-li

iOS_SDK/OneSignalSDK/OneSignalUser/Source/OSSubscriptionModel.swift

@@ -349,6 +349,26 @@ class OSSubscriptionModel: OSModel {
             }
         }
     }
+    
+    // Using snake_case so we can use this in request bodies
+    public func jsonRepresentation() -> [String: Any] {
+        var json: [String: Any] = [:]
+        json["id"] = self.subscriptionId
+        json["type"] = self.type.rawValue
+        json["token"] = self.address
+        json["enabled"] = self.enabled
+        json["test_type"] = self.testType
+        json["device_os"] = self.deviceOs
+        json["sdk"] = self.sdk
+        json["device_model"] = self.deviceModel
+        json["app_version"] = self.appVersion
+        json["net_type"] = self.netType
+        // notificationTypes defaults to -1 instead of nil, don't send if it's -1
+        if self.notificationTypes != -1 {
+            json["notification_types"] = self.notificationTypes
+        }
+        return json
+    }
 }
 
 // Push Subscription related

iOS_SDK/OneSignalSDK/OneSignalUser/Source/OSSubscriptionOperationExecutor.swift

@@ -201,6 +201,13 @@ class OSSubscriptionOperationExecutor: OSOperationExecutor {
         processRequestQueue()
     }
 
+    // Bypasses the operation repo to create a push subscription request
+    func createPushSubscription(subscriptionModel: OSSubscriptionModel, identityModel: OSIdentityModel) {
+        let request = OSRequestCreateSubscription(subscriptionModel: subscriptionModel, identityModel: identityModel)
+        addRequestQueue.append(request)
+        OneSignalUserDefaults.initShared().saveCodeableData(forKey: OS_SUBSCRIPTION_EXECUTOR_ADD_REQUEST_QUEUE_KEY, withValue: self.addRequestQueue)
+    }
+
     func processRequestQueue() {
         let requestQueue: [OneSignalRequest] = addRequestQueue + removeRequestQueue + updateRequestQueue
 

iOS_SDK/OneSignalSDK/OneSignalUser/Source/OSUserRequests.swift

@@ -504,8 +504,8 @@ class OSUserExecutor {
         }
     }
 
-    static func fetchUser(aliasLabel: String, aliasId: String, identityModel: OSIdentityModel) {
-        let request = OSRequestFetchUser(identityModel: identityModel, aliasLabel: aliasLabel, aliasId: aliasId)
+    static func fetchUser(aliasLabel: String, aliasId: String, identityModel: OSIdentityModel, onNewSession: Bool = false) {
+        let request = OSRequestFetchUser(identityModel: identityModel, aliasLabel: aliasLabel, aliasId: aliasId, onNewSession: onNewSession)
 
         appendToQueue(request)
 
@@ -528,6 +528,28 @@ class OSUserExecutor {
                 // Clear local data in preparation for hydration
                 OneSignalUserManagerImpl.sharedInstance.clearUserData()
                 parseFetchUserResponse(response: response, identityModel: request.identityModel, originalPushToken: OneSignalUserManagerImpl.sharedInstance.token)
+                
+                // If this is a on-new-session's fetch user call, check that the subscription still exists
+                if request.onNewSession,
+                   OneSignalUserManagerImpl.sharedInstance.isCurrentUser(request.identityModel),
+                   let subId = OneSignalUserManagerImpl.sharedInstance.user.pushSubscriptionModel.subscriptionId,
+                   let subscriptionObjects = parseSubscriptionObjectResponse(response)
+                {
+                    var subscriptionExists = false
+                    for subModel in subscriptionObjects {
+                        if subModel["id"] as? String == subId {
+                            subscriptionExists = true
+                            break
+                        }
+                    }
+                    
+                    if !subscriptionExists {
+                        // This subscription probably has been deleted
+                        OneSignalLog.onesignalLog(.LL_ERROR, message: "OSUserExecutor.executeFetchUserRequest found this device's push subscription gone, now send the push subscription to server.")
+                        OneSignalUserManagerImpl.sharedInstance.pushSubscriptionModel?.subscriptionId = nil
+                        OneSignalUserManagerImpl.sharedInstance.createPushSubscriptionRequest()
+                    }
+                }
             }
             executePendingRequests()
         } onFailure: { error in
@@ -594,23 +616,7 @@ class OSRequestCreateUser: OneSignalRequest, OSUserRequest {
     // When reading from the cache, update the push subscription model
     func updatePushSubscriptionModel(_ pushSubscriptionModel: OSSubscriptionModel) {
         self.pushSubscriptionModel = pushSubscriptionModel
-        // Push Subscription Object
-        var pushSubscriptionObject: [String: Any] = [:]
-        pushSubscriptionObject["id"] = pushSubscriptionModel.subscriptionId
-        pushSubscriptionObject["type"] = pushSubscriptionModel.type.rawValue
-        pushSubscriptionObject["token"] = pushSubscriptionModel.address
-        pushSubscriptionObject["enabled"] = pushSubscriptionModel.enabled
-        pushSubscriptionObject["test_type"] = pushSubscriptionModel.testType
-        pushSubscriptionObject["device_os"] = pushSubscriptionModel.deviceOs
-        pushSubscriptionObject["sdk"] = pushSubscriptionModel.sdk
-        pushSubscriptionObject["device_model"] = pushSubscriptionModel.deviceModel
-        pushSubscriptionObject["app_version"] = pushSubscriptionModel.appVersion
-        pushSubscriptionObject["net_type"] = pushSubscriptionModel.netType
-        // notificationTypes defaults to -1 instead of nil, don't send if it's -1
-        if pushSubscriptionModel.notificationTypes != -1 {
-            pushSubscriptionObject["notification_types"] = pushSubscriptionModel.notificationTypes
-        }
-        self.parameters?["subscriptions"] = [pushSubscriptionObject]
+        self.parameters?["subscriptions"] = [pushSubscriptionModel.jsonRepresentation()]
     }
 
     init(identityModel: OSIdentityModel, propertiesModel: OSPropertiesModel, pushSubscriptionModel: OSSubscriptionModel, originalPushToken: String?) {
@@ -836,7 +842,8 @@ class OSRequestFetchUser: OneSignalRequest, OSUserRequest {
     let identityModel: OSIdentityModel
     let aliasLabel: String
     let aliasId: String
-
+    let onNewSession: Bool
+    
     func prepareForExecution() -> Bool {
         guard let appId = OneSignalConfigManager.getAppId() else {
             OneSignalLog.onesignalLog(.LL_DEBUG, message: "Cannot generate the fetch user request due to null app ID.")
@@ -847,10 +854,11 @@ class OSRequestFetchUser: OneSignalRequest, OSUserRequest {
         return true
     }
 
-    init(identityModel: OSIdentityModel, aliasLabel: String, aliasId: String) {
+    init(identityModel: OSIdentityModel, aliasLabel: String, aliasId: String, onNewSession: Bool) {
         self.identityModel = identityModel
         self.aliasLabel = aliasLabel
         self.aliasId = aliasId
+        self.onNewSession = onNewSession
         self.stringDescription = "OSRequestFetchUser with aliasLabel: \(aliasLabel) aliasId: \(aliasId)"
         super.init()
         self.method = GET
@@ -861,6 +869,7 @@ class OSRequestFetchUser: OneSignalRequest, OSUserRequest {
         coder.encode(aliasLabel, forKey: "aliasLabel")
         coder.encode(aliasId, forKey: "aliasId")
         coder.encode(identityModel, forKey: "identityModel")
+        coder.encode(onNewSession, forKey: "onNewSession")
         coder.encode(method.rawValue, forKey: "method") // Encodes as String
         coder.encode(timestamp, forKey: "timestamp")
     }
@@ -879,6 +888,7 @@ class OSRequestFetchUser: OneSignalRequest, OSUserRequest {
         self.identityModel = identityModel
         self.aliasLabel = aliasLabel
         self.aliasId = aliasId
+        self.onNewSession = coder.decodeBool(forKey: "onNewSession")
         self.stringDescription = "OSRequestFetchUser with aliasLabel: \(aliasLabel) aliasId: \(aliasId)"
         super.init()
         self.method = HTTPMethod(rawValue: rawMethod)
@@ -1107,8 +1117,9 @@ class OSRequestUpdateProperties: OneSignalRequest, OSUserRequest {
 }
 
 /**
- Current uses of this request are for adding Email and SMS subscriptions. Push subscriptions won't be created using
- this request because they will be created with ``OSRequestCreateUser``.
+ Primary uses of this request are for adding Email and SMS subscriptions. Push subscriptions typically won't be created using
+ this request because they will be created with ``OSRequestCreateUser``. However, if we detect that this device's
+ push subscription is ever deleted, we will make a request to create it again.
  */
 class OSRequestCreateSubscription: OneSignalRequest, OSUserRequest {
     var sentToClient = false
@@ -1137,15 +1148,7 @@ class OSRequestCreateSubscription: OneSignalRequest, OSUserRequest {
         self.identityModel = identityModel
         self.stringDescription = "OSRequestCreateSubscription with subscriptionModel: \(subscriptionModel.address ?? "nil")"
         super.init()
-
-        var subscriptionParams: [String: Any] = [:]
-        subscriptionParams["type"] = subscriptionModel.type.rawValue
-        subscriptionParams["token"] = subscriptionModel.address
-        // 1/5/2023: For email and SMS, either send `enabled` AND `notification_types` or don't send either
-        // TODO: ^ Backend changes may require us to come back and change this request's payload.
-        // TODO: Since this is not used for push, don't send either of those. Revisit if we ever create push subscriptions with this request.
-
-        self.parameters = ["subscription": subscriptionParams]
+        self.parameters = ["subscription": subscriptionModel.jsonRepresentation()]
         self.method = POST
         _ = prepareForExecution() // sets the path property
     }

iOS_SDK/OneSignalSDK/OneSignalUser/Source/OneSignalUserManagerImpl.swift

@@ -445,6 +445,17 @@ public class OneSignalUserManagerImpl: NSObject, OneSignalUserManager {
                                    changeNotifier: OSEventProducer())
     }
 
+    func createPushSubscriptionRequest() {
+        // subscriptionExecutor should exist as this should be called after `start()` has been called
+        if let subscriptionExecutor = self.subscriptionExecutor,
+        let subscriptionModel = pushSubscriptionModel
+        {
+            subscriptionExecutor.createPushSubscription(subscriptionModel: subscriptionModel, identityModel: user.identityModel)
+        } else {
+            OneSignalLog.onesignalLog(.LL_ERROR, message: "OneSignalUserManagerImpl.createPushSubscriptionRequest cannot be executed due to missing subscriptionExecutor.")
+        }
+    }
+    
     @objc
     public func getTags() -> [String: String]? {
         guard let user = _user else {
@@ -521,7 +532,7 @@ extension OneSignalUserManagerImpl {
         // Fetch the user's data if there is a onesignal_id
         // TODO: What if onesignal_id is missing, because we may init a user from cache but it may be missing onesignal_id. Is this ok.
         if let onesignalId = onesignalId {
-            OSUserExecutor.fetchUser(aliasLabel: OS_ONESIGNAL_ID, aliasId: onesignalId, identityModel: user.identityModel)
+            OSUserExecutor.fetchUser(aliasLabel: OS_ONESIGNAL_ID, aliasId: onesignalId, identityModel: user.identityModel, onNewSession: true)
         }
     }