reading Deltas and Requests from cache, connect to models

* Motivation: When initializing the delta queue and request queue, the executors need to hook up the Deltas' and Requests' models to the ones in the store, so that they can get the updated information needed to send the requests, and hydrate the correct models.
* When model stores, deltas, and requests are initialized from cache, they lose their references as they are new instances.
* To simplify uncaching, we maintain separate request queues for each request type in the executor
* Also needed to update some `let` properties to be `var`

Author: nan-li

iOS_SDK/OneSignalSDK/OneSignalCore/Source/OneSignalCommonDefines.h

@@ -285,7 +285,9 @@ typedef enum {GET, POST, HEAD, PUT, DELETE, OPTIONS, CONNECT, TRACE, PATCH} HTTP
 #define OS_EXTERNAL_ID                                                      @"external_id"
 
 #define OS_RETAIN_PREVIOUS_USER                                             @"retain_previous_user"
+#define OS_ON_USER_WILL_CHANGE                                              @"OS_ON_USER_WILL_CHANGE"
 
+// Models and Model Stores
 #define OS_IDENTITY_MODEL_KEY                                               @"OS_IDENTITY_MODEL_KEY"
 #define OS_IDENTITY_MODEL_STORE_KEY                                         @"OS_IDENTITY_MODEL_STORE_KEY"
 #define OS_PROPERTIES_MODEL_KEY                                             @"OS_PROPERTIES_MODEL_KEY"
@@ -294,6 +296,7 @@ typedef enum {GET, POST, HEAD, PUT, DELETE, OPTIONS, CONNECT, TRACE, PATCH} HTTP
 #define OS_PUSH_SUBSCRIPTION_MODEL_STORE_KEY                                @"OS_PUSH_SUBSCRIPTION_MODEL_STORE_KEY"
 #define OS_SUBSCRIPTION_MODEL_STORE_KEY                                     @"OS_SUBSCRIPTION_MODEL_STORE_KEY"
 
+// Deltas
 #define OS_ADD_ALIAS_DELTA                                                  @"OS_ADD_ALIAS_DELTA"
 #define OS_REMOVE_ALIAS_DELTA                                               @"OS_REMOVE_ALIAS_DELTA"
 
@@ -303,16 +306,25 @@ typedef enum {GET, POST, HEAD, PUT, DELETE, OPTIONS, CONNECT, TRACE, PATCH} HTTP
 #define OS_REMOVE_SUBSCRIPTION_DELTA                                        @"OS_REMOVE_SUBSCRIPTION_DELTA"
 #define OS_UPDATE_SUBSCRIPTION_DELTA                                        @"OS_UPDATE_SUBSCRIPTION_DELTA"
 
+// Operation Repo
 #define OS_OPERATION_REPO_DELTA_QUEUE_KEY                                   @"OS_OPERATION_REPO_DELTA_QUEUE_KEY"
 
+// User Executor
 #define OS_USER_EXECUTOR_REQUEST_QUEUE_KEY                                  @"OS_USER_EXECUTOR_REQUEST_QUEUE_KEY"
+
+// Identity Executor
 #define OS_IDENTITY_EXECUTOR_DELTA_QUEUE_KEY                                @"OS_IDENTITY_EXECUTOR_DELTA_QUEUE_KEY"
-#define OS_IDENTITY_EXECUTOR_REQUEST_QUEUE_KEY                              @"OS_IDENTITY_EXECUTOR_REQUEST_QUEUE_KEY"
+#define OS_IDENTITY_EXECUTOR_ADD_REQUEST_QUEUE_KEY                          @"OS_IDENTITY_EXECUTOR_ADD_REQUEST_QUEUE_KEY"
+#define OS_IDENTITY_EXECUTOR_REMOVE_REQUEST_QUEUE_KEY                       @"OS_IDENTITY_EXECUTOR_REMOVE_REQUEST_QUEUE_KEY"
+
+// Property Executor
 #define OS_PROPERTIES_EXECUTOR_DELTA_QUEUE_KEY                              @"OS_PROPERTIES_EXECUTOR_DELTA_QUEUE_KEY"
-#define OS_PROPERTIES_EXECUTOR_REQUEST_QUEUE_KEY                            @"OS_PROPERTIES_EXECUTOR_REQUEST_QUEUE_KEY"
-#define OS_SUBSCRIPTION_EXECUTOR_DELTA_QUEUE_KEY                            @"OS_SUBSCRIPTION_EXECUTOR_DELTA_QUEUE_KEY"
-#define OS_SUBSCRIPTION_EXECUTOR_REQUEST_QUEUE_KEY                          @"OS_SUBSCRIPTION_EXECUTOR_REQUEST_QUEUE_KEY"
+#define OS_PROPERTIES_EXECUTOR_UPDATE_REQUEST_QUEUE_KEY                     @"OS_PROPERTIES_EXECUTOR_UPDATE_REQUEST_QUEUE_KEY"
 
-#define OS_ON_USER_WILL_CHANGE                                              @"OS_ON_USER_WILL_CHANGE"
+// Subscription Executor
+#define OS_SUBSCRIPTION_EXECUTOR_DELTA_QUEUE_KEY                            @"OS_SUBSCRIPTION_EXECUTOR_DELTA_QUEUE_KEY"
+#define OS_SUBSCRIPTION_EXECUTOR_ADD_REQUEST_QUEUE_KEY                      @"OS_SUBSCRIPTION_EXECUTOR_ADD_REQUEST_QUEUE_KEY"
+#define OS_SUBSCRIPTION_EXECUTOR_REMOVE_REQUEST_QUEUE_KEY                   @"OS_SUBSCRIPTION_EXECUTOR_REMOVE_REQUEST_QUEUE_KEY"
+#define OS_SUBSCRIPTION_EXECUTOR_UPDATE_REQUEST_QUEUE_KEY                   @"OS_SUBSCRIPTION_EXECUTOR_UPDATE_REQUEST_QUEUE_KEY"
 
 #endif /* OneSignalCommonDefines_h */

iOS_SDK/OneSignalSDK/OneSignalOSCore/Source/OSDelta.swift

@@ -34,7 +34,7 @@ open class OSDelta: NSObject, NSCoding {
     public let name: String
     public let deltaId: String
     public let timestamp: Date
-    public let model: OSModel
+    public var model: OSModel
     public let property: String
     public let value: Any
 

iOS_SDK/OneSignalSDK/OneSignalOSCore/Source/OSModelStore.swift

@@ -60,12 +60,24 @@ open class OSModelStore<TModel: OSModel>: NSObject {
     }
 
     /**
-     Uses the ID that is used a key to store models in the store's models dictionary.
+     Uses the ID that is used as the key to store models in the store's models dictionary.
      Examples:  "[email protected]" for a subscription model or `OS_IDENTITY_MODEL_KEY` for an identity model.
      */
     public func getModel(key: String) -> TModel? {
         return self.models[key]
     }
+    
+    /**
+     Uses the `modelId` to get the corresponding model in the store's models dictionary.
+     */
+    public func getModel(modelId: String) -> TModel? {
+        for model in models.values {
+            if model.modelId == modelId {
+                return model
+            }
+        }
+        return nil
+    }
 
     public func getModels() -> [String: TModel] {
         return self.models

iOS_SDK/OneSignalSDK/OneSignalOSCore/Source/OSOperationExecutor.swift

@@ -27,15 +27,15 @@
 
 import OneSignalCore
 
+// TODO: Concrete executors drop OSDeltas and Requests when initializing from the cache, when they cannot be connected to their respective models anymore. Revisit this behavior of dropping.
+
 public protocol OSOperationExecutor {
     var supportedDeltas: [String] { get }
     var deltaQueue: [OSDelta] { get }
-    var requestQueue: [OneSignalRequest] { get }
 
     func enqueueDelta(_ delta: OSDelta)
     func cacheDeltaQueue()
     func processDeltaQueue()
 
-    func enqueueRequest(_ request: OneSignalRequest)
     func processRequestQueue()
 }

iOS_SDK/OneSignalSDK/OneSignalUser/Source/OSIdentityOperationExecutor.swift

@@ -31,21 +31,60 @@ import OneSignalCore
 class OSIdentityOperationExecutor: OSOperationExecutor {
     var supportedDeltas: [String] = [OS_ADD_ALIAS_DELTA, OS_REMOVE_ALIAS_DELTA]
     var deltaQueue: [OSDelta] = []
-    var requestQueue: [OneSignalRequest] = []
+    // To simplify uncaching, we maintain separate request queues for each type
+    var addRequestQueue: [OSRequestAddAliases] = []
+    var removeRequestQueue: [OSRequestRemoveAlias] = []
 
     init() {
-        // Read unfinished deltas and requests from cache, if any...
-
-        if let deltaQueue = OneSignalUserDefaults.initShared().getSavedCodeableData(forKey: OS_IDENTITY_EXECUTOR_DELTA_QUEUE_KEY, defaultValue: []) as? [OSDelta] {
+        // Read unfinished deltas from cache, if any...
+        if var deltaQueue = OneSignalUserDefaults.initShared().getSavedCodeableData(forKey: OS_IDENTITY_EXECUTOR_DELTA_QUEUE_KEY, defaultValue: []) as? [OSDelta] {
+            // Hook each uncached Delta to the model in the store
+            for (index, delta) in deltaQueue.enumerated().reversed() {
+                if let modelInStore = OneSignalUserManagerImpl.sharedInstance.identityModelStore.getModel(modelId: delta.model.modelId) {
+                    // The model exists in the store, set it to be the Delta's model
+                    delta.model = modelInStore
+                } else {
+                    // The model does not exist, drop this Delta
+                    deltaQueue.remove(at: index)
+                }
+            }
             self.deltaQueue = deltaQueue
         } else {
-            // log error
+            OneSignalLog.onesignalLog(.LL_ERROR, message: "OSIdentityOperationExecutor error encountered reading from cache for \(OS_IDENTITY_EXECUTOR_DELTA_QUEUE_KEY)")
         }
-
-        if let requestQueue = OneSignalUserDefaults.initShared().getSavedCodeableData(forKey: OS_IDENTITY_EXECUTOR_REQUEST_QUEUE_KEY, defaultValue: []) as? [OneSignalRequest] {
-            self.requestQueue = requestQueue
+        
+        // Read unfinished requests from cache, if any...
+        
+        if var addRequestQueue = OneSignalUserDefaults.initShared().getSavedCodeableData(forKey: OS_IDENTITY_EXECUTOR_ADD_REQUEST_QUEUE_KEY, defaultValue: []) as? [OSRequestAddAliases] {
+            // Hook each uncached Request to the model in the store
+            for (index, request) in addRequestQueue.enumerated().reversed() {
+                if let identityModel = OneSignalUserManagerImpl.sharedInstance.identityModelStore.getModel(modelId: request.identityModel.modelId) {
+                    // The model exists in the store, set it to be the Request's models
+                    request.identityModel = identityModel
+                } else if !request.prepareForExecution() {
+                    // The models do not exist AND this request cannot be sent, drop this Request
+                    addRequestQueue.remove(at: index)
+                }
+            }
+            self.addRequestQueue = addRequestQueue
+        } else {
+            OneSignalLog.onesignalLog(.LL_ERROR, message: "OSIdentityOperationExecutor error encountered reading from cache for \(OS_IDENTITY_EXECUTOR_ADD_REQUEST_QUEUE_KEY)")
+        }
+        
+        if var removeRequestQueue = OneSignalUserDefaults.initShared().getSavedCodeableData(forKey: OS_IDENTITY_EXECUTOR_REMOVE_REQUEST_QUEUE_KEY, defaultValue: []) as? [OSRequestRemoveAlias] {
+            // Hook each uncached Request to the model in the store
+            for (index, request) in removeRequestQueue.enumerated().reversed() {
+                if let identityModel = OneSignalUserManagerImpl.sharedInstance.identityModelStore.getModel(modelId: request.identityModel.modelId) {
+                    // The model exists in the store, set it to be the Request's model
+                    request.identityModel = identityModel
+                } else if !request.prepareForExecution() {
+                    // The model does not exist AND this request cannot be sent, drop this Request
+                    removeRequestQueue.remove(at: index)
+                }
+            }
+            self.removeRequestQueue = removeRequestQueue
         } else {
-            // log error
+            OneSignalLog.onesignalLog(.LL_ERROR, message: "OSIdentityOperationExecutor error encountered reading from cache for \(OS_IDENTITY_EXECUTOR_REMOVE_REQUEST_QUEUE_KEY)")
         }
     }
 
@@ -73,48 +112,47 @@ class OSIdentityOperationExecutor: OSOperationExecutor {
             switch delta.name {
             case OS_ADD_ALIAS_DELTA:
                 let request = OSRequestAddAliases(aliases: aliases, identityModel: model)
-                enqueueRequest(request)
+                addRequestQueue.append(request)
 
             case OS_REMOVE_ALIAS_DELTA:
                 if let label = aliases.first?.key {
                     let request = OSRequestRemoveAlias(labelToRemove: label, identityModel: model)
-                    enqueueRequest(request)
+                    removeRequestQueue.append(request)
                 }
-                // Log error
 
             default:
-                // Log error
                 OneSignalLog.onesignalLog(.LL_DEBUG, message: "OSIdentityOperationExecutor met incompatible OSDelta type: \(delta)")
             }
         }
 
         self.deltaQueue = [] // TODO: Check that we can simply clear all the deltas in the deltaQueue
 
         // persist executor's requests (including new request) to storage
-        OneSignalUserDefaults.initShared().saveCodeableData(forKey: OS_IDENTITY_EXECUTOR_REQUEST_QUEUE_KEY, withValue: self.requestQueue)
+        OneSignalUserDefaults.initShared().saveCodeableData(forKey: OS_IDENTITY_EXECUTOR_ADD_REQUEST_QUEUE_KEY, withValue: self.addRequestQueue)
+        OneSignalUserDefaults.initShared().saveCodeableData(forKey: OS_IDENTITY_EXECUTOR_REMOVE_REQUEST_QUEUE_KEY, withValue: self.removeRequestQueue)
 
         OneSignalUserDefaults.initShared().saveCodeableData(forKey: OS_IDENTITY_EXECUTOR_DELTA_QUEUE_KEY, withValue: self.deltaQueue) // This should be empty, can remove instead?
 
         processRequestQueue()
     }
 
-    func enqueueRequest(_ request: OneSignalRequest) {
-        OneSignalLog.onesignalLog(.LL_VERBOSE, message: "OSIdentityOperationExecutor enqueueRequest: \(request)")
-        requestQueue.append(request)
-    }
-
     func processRequestQueue() {
+        let requestQueue: [OneSignalRequest] = addRequestQueue + removeRequestQueue
+        
         if requestQueue.isEmpty {
             return
         }
 
-        for request in requestQueue {
+        // Sort the requestQueue by timestamp
+        for request in requestQueue.sorted(by: { first, second in
+            return first.timestamp < second.timestamp
+        }) {
             if request.isKind(of: OSRequestAddAliases.self), let addAliasesRequest = request as? OSRequestAddAliases {
                 executeAddAliasesRequest(addAliasesRequest)
             } else if request.isKind(of: OSRequestRemoveAlias.self), let removeAliasRequest = request as? OSRequestRemoveAlias {
                 executeRemoveAliasRequest(removeAliasRequest)
             } else {
-                // Log Error
+                OneSignalLog.onesignalLog(.LL_DEBUG, message: "OSIdentityOperationExecutor.processRequestQueue met incompatible OneSignalRequest type: \(request).")
             }
         }
     }
@@ -128,15 +166,15 @@ class OSIdentityOperationExecutor: OSOperationExecutor {
 
             // On success, remove request from cache, and hydrate model
             // For example, if app restarts and we read in operations between sending this off and getting the response
-            self.requestQueue.removeAll(where: { $0 == request})
-            OneSignalUserDefaults.initShared().saveCodeableData(forKey: OS_IDENTITY_EXECUTOR_REQUEST_QUEUE_KEY, withValue: self.requestQueue)
+            self.addRequestQueue.removeAll(where: { $0 == request})
+            OneSignalUserDefaults.initShared().saveCodeableData(forKey: OS_IDENTITY_EXECUTOR_ADD_REQUEST_QUEUE_KEY, withValue: self.addRequestQueue)
 
             // instead: modelstore.hydratewithresponse with modelid passed in.. request.modeltoupdate.modelId
                 // store can determine if modelid is same, then hydrate or do nothign
             request.identityModel.hydrate(response)
 
         } onFailure: { error in
-            self.requestQueue.removeAll(where: { $0 == request})
+            self.addRequestQueue.removeAll(where: { $0 == request})
             OneSignalLog.onesignalLog(.LL_ERROR, message: error.debugDescription)
         }
     }
@@ -151,13 +189,13 @@ class OSIdentityOperationExecutor: OSOperationExecutor {
 
             // On success, remove request from cache, and hydrate model
             // For example, if app restarts and we read in operations between sending this off and getting the response
-            self.requestQueue.removeAll(where: { $0 == request})
-            OneSignalUserDefaults.initShared().saveCodeableData(forKey: OS_IDENTITY_EXECUTOR_REQUEST_QUEUE_KEY, withValue: self.requestQueue)
+            self.removeRequestQueue.removeAll(where: { $0 == request})
+            OneSignalUserDefaults.initShared().saveCodeableData(forKey: OS_IDENTITY_EXECUTOR_REMOVE_REQUEST_QUEUE_KEY, withValue: self.removeRequestQueue)
 
             request.identityModel.hydrate(response)
 
         } onFailure: { error in
-            self.requestQueue.removeAll(where: { $0 == request})
+            self.removeRequestQueue.removeAll(where: { $0 == request})
             OneSignalLog.onesignalLog(.LL_ERROR, message: error.debugDescription)
         }
     }