Merge pull request #1290 from OneSignal/5.0.0/create_user_error

[5.0.0] Allow the SDK the chance to recover from failed Create User

Author: emawby

iOS_SDK/OneSignalSDK/OneSignalCore/Source/OneSignalCommonDefines.h

@@ -184,9 +184,13 @@ typedef enum {ATTRIBUTED, NOT_ATTRIBUTED} FocusAttributionState;
 #define focusAttributionStateString(enum) [@[@"ATTRIBUTED", @"NOT_ATTRIBUTED"] objectAtIndex:enum]
 
 // OneSignal Background Task Identifiers
-#define ATTRIBUTED_FOCUS_TASK           @"ATTRIBUTED_FOCUS_TASK"
-#define UNATTRIBUTED_FOCUS_TASK         @"UNATTRIBUTED_FOCUS_TASK"
-#define USER_MANAGER_BACKGROUND_TASK    @"USER_MANAGER_BACKGROUND_TASK"
+#define ATTRIBUTED_FOCUS_TASK                   @"ATTRIBUTED_FOCUS_TASK"
+#define UNATTRIBUTED_FOCUS_TASK                 @"UNATTRIBUTED_FOCUS_TASK"
+#define SEND_SESSION_TIME_TO_USER_TASK          @"SEND_SESSION_TIME_TO_USER_TASK"
+#define OPERATION_REPO_BACKGROUND_TASK          @"OPERATION_REPO_BACKGROUND_TASK"
+#define IDENTITY_EXECUTOR_BACKGROUND_TASK       @"IDENTITY_EXECUTOR_BACKGROUND_TASK_"
+#define PROPERTIES_EXECUTOR_BACKGROUND_TASK     @"PROPERTIES_EXECUTOR_BACKGROUND_TASK_"
+#define SUBSCRIPTION_EXECUTOR_BACKGROUND_TASK   @"SUBSCRIPTION_EXECUTOR_BACKGROUND_TASK_"
 
 // OneSignal constants
 #define OS_PUSH @"push"

iOS_SDK/OneSignalSDK/OneSignalInAppMessages/Controller/OSMessagingController.m

@@ -448,6 +448,7 @@ - (void)presentInAppPreviewMessage:(OSInAppMessageInternal *)message {
 - (void)displayMessage:(OSInAppMessageInternal *)message {
     // Check if the app disabled IAMs for this device before showing an IAM
     if (_isInAppMessagingPaused && !message.isPreview) {
+        [self cleanUpInAppWindow];
         [OneSignalLog onesignalLog:ONE_S_LL_VERBOSE message:@"In app messages will not show while paused"];
         return;
     }
@@ -749,6 +750,19 @@ - (void)messageViewControllerWasDismissed:(OSInAppMessageInternal *)message disp
     }
 }
 
+- (void)cleanUpInAppWindow {
+    self.viewController = nil;
+    if (self.window) {
+        /*
+         Hide the top level IAM window
+         After the IAM window is hidden, iOS will automatically promote the main window
+         This also re-shows the keyboard automatically if it had focus in a text input
+        */
+        self.window.hidden = true;
+        self.window = nil;
+    }
+}
+
 - (void)setAndPersistTimeSinceLastMessage {
     NSDate *timeSinceLastMessage = [NSDate new];
     [self.triggerController timeSinceLastMessage:timeSinceLastMessage];
@@ -768,21 +782,12 @@ - (void)evaluateMessageDisplayQueue {
         [self displayMessage:self.messageDisplayQueue.firstObject];
         return;
     } else {
-        [self hideWindow];
+        [self cleanUpInAppWindow];
         // Evaulate any IAMs (could be new IAM or added trigger conditions)
         [self evaluateMessages];
     }
 }
 
-/*
- Hide the top level IAM window
- After the IAM window is hidden, iOS will automatically promote the main window
- This also re-shows the keyboard automatically if it had focus in a text input
-*/
-- (void)hideWindow {
-    self.window.hidden = true;
-}
-
 - (void)persistInAppMessageForRedisplay:(OSInAppMessageInternal *)message {
     // If the IAM doesn't have the re display prop or is a preview IAM there is no need to save it
     if (![message.displayStats isRedisplayEnabled] || message.isPreview) {

iOS_SDK/OneSignalSDK/OneSignalInAppMessages/UI/OSInAppMessageViewController.m

@@ -95,12 +95,15 @@ @interface OSInAppMessageViewController ()
 
 @implementation OSInAppMessageViewController
 
+OSInAppMessageInternal *_dismissingMessage = nil;
+
 - (instancetype _Nonnull)initWithMessage:(OSInAppMessageInternal *)inAppMessage delegate:(id<OSInAppMessageViewControllerDelegate>)delegate {
     if (self = [super init]) {
         self.message = inAppMessage;
         self.delegate = delegate;
         self.useHeightMargin = YES;
         self.useWidthMargin = YES;
+        _dismissingMessage = nil;
     }
 
     return self;
@@ -490,6 +493,10 @@ - (void)dismissCurrentInAppMessage:(BOOL)up withVelocity:(double)velocity {
         [self.delegate messageViewControllerWasDismissed:self.message displayed:NO];
         return;
     }
+    
+    if (_dismissingMessage == self.message) {
+        return;
+    }
 
     [self.delegate messageViewControllerWillDismiss:self.message];
 
@@ -521,7 +528,7 @@ - (void)dismissCurrentInAppMessage:(BOOL)up withVelocity:(double)velocity {
         animationOption = UIViewAnimationOptionCurveEaseIn;
         dismissAnimationDuration = MIN_DISMISSAL_ANIMATION_DURATION;
     }
-
+    _dismissingMessage = self.message;
     [UIView animateWithDuration:dismissAnimationDuration delay:0.0f options:animationOption animations:^{
         self.view.backgroundColor = [UIColor clearColor];
         self.view.alpha = 0.0f;

iOS_SDK/OneSignalSDK/OneSignalOSCore/Source/OSEventProducer.swift

@@ -33,7 +33,6 @@ public class OSEventProducer<THandler>: NSObject {
     var subscriber: THandler?
 
     public func subscribe(_ handler: THandler) {
-        OneSignalLog.onesignalLog(.LL_VERBOSE, message: "OSEventProducer.subscribe() called with handler: \(handler)")
         // TODO: UM do we want to synchronize on subscribers
         subscriber = handler // TODO: UM style, implicit or explicit self?
     }

iOS_SDK/OneSignalSDK/OneSignalOSCore/Source/OSModelStore.swift

@@ -87,7 +87,6 @@ open class OSModelStore<TModel: OSModel>: NSObject {
     }
 
     public func add(id: String, model: TModel, hydrating: Bool) {
-        OneSignalLog.onesignalLog(.LL_VERBOSE, message: "OSModelStore add() called with model \(model)")
         // TODO: Check if we are adding the same model? Do we replace?
             // For example, calling addEmail multiple times with the same email
             // Check API endpoint for behavior
@@ -127,6 +126,8 @@ open class OSModelStore<TModel: OSModel>: NSObject {
             self.changeSubscription.fire { modelStoreListener in
                 modelStoreListener.onRemoved(model)
             }
+        } else {
+            OneSignalLog.onesignalLog(.LL_ERROR, message: "OSModelStore cannot remove \(id) because it doesn't exist in the store.")
         }
     }
 
@@ -151,8 +152,6 @@ open class OSModelStore<TModel: OSModel>: NSObject {
 
 extension OSModelStore: OSModelChangedHandler {
     public func onModelUpdated(args: OSModelChangedArgs, hydrating: Bool) {
-        OneSignalLog.onesignalLog(.LL_VERBOSE, message: "OSModelStore.onChanged() called with OSModelChangedArgs: \(args)")
-
         // persist the changed models to storage
         OneSignalUserDefaults.initShared().saveCodeableData(forKey: self.storeKey, withValue: self.models)
 

iOS_SDK/OneSignalSDK/OneSignalOSCore/Source/OSModelStoreListener.swift

@@ -52,7 +52,6 @@ extension OSModelStoreListener {
     }
 
     public func onAdded(_ model: OSModel) {
-        OneSignalLog.onesignalLog(.LL_VERBOSE, message: "OSModelStoreListener.onAdded() with model \(model)")
         guard let addedModel = model as? Self.TModel else {
             // log error
             return
@@ -63,7 +62,6 @@ extension OSModelStoreListener {
     }
 
     public func onUpdated(_ args: OSModelChangedArgs) {
-        OneSignalLog.onesignalLog(.LL_VERBOSE, message: "OSModelStoreListener.onUpdated() with args \(args)")
         if let delta = getUpdateModelDelta(args) {
             OSOperationRepo.sharedInstance.enqueueDelta(delta)
         }

iOS_SDK/OneSignalSDK/OneSignalOSCore/Source/OSOperationExecutor.swift

@@ -35,7 +35,7 @@ public protocol OSOperationExecutor {
 
     func enqueueDelta(_ delta: OSDelta)
     func cacheDeltaQueue()
-    func processDeltaQueue()
+    func processDeltaQueue(inBackground: Bool)
 
-    func processRequestQueue()
+    func processRequestQueue(inBackground: Bool)
 }

iOS_SDK/OneSignalSDK/OneSignalOSCore/Source/OSOperationRepo.swift

@@ -43,6 +43,7 @@ public class OSOperationRepo: NSObject {
 
     // TODO: This should come from a config, plist, method, remote params
     var pollIntervalSeconds = 5
+    public var paused = false
 
     /**
      Initilize this Operation Repo. Read from the cache. Executors may not be available by this time.
@@ -107,13 +108,23 @@ public class OSOperationRepo: NSObject {
         OneSignalUserDefaults.initShared().saveCodeableData(forKey: OS_OPERATION_REPO_DELTA_QUEUE_KEY, withValue: self.deltaQueue)
     }
 
-    @objc public func flushDeltaQueue() {
+    @objc public func flushDeltaQueue(inBackground: Bool = false) {
+        guard !paused else {
+            OneSignalLog.onesignalLog(.LL_DEBUG, message: "OSOperationRepo not flushing queue due to being paused")
+            return
+        }
+        
         guard !OneSignalConfigManager.shouldAwaitAppIdAndLogMissingPrivacyConsent(forMethod: nil) else {
             return
         }
+    
+        if (inBackground) {
+            OSBackgroundTaskManager.beginBackgroundTask(OPERATION_REPO_BACKGROUND_TASK)
+        }
+
         start()
         if !deltaQueue.isEmpty {
-            OneSignalLog.onesignalLog(.LL_VERBOSE, message: "OSOperationRepo flushDeltaQueue with queue: \(deltaQueue)")
+            OneSignalLog.onesignalLog(.LL_VERBOSE, message: "OSOperationRepo flushDeltaQueue in background: \(inBackground) with queue: \(deltaQueue)")
         }
 
         var index = 0
@@ -135,7 +146,12 @@ public class OSOperationRepo: NSObject {
         }
 
         for executor in executors {
-            executor.processDeltaQueue()
+            executor.processDeltaQueue(inBackground: inBackground)
+        }
+        
+        if (inBackground) {
+            OSBackgroundTaskManager.endBackgroundTask(OPERATION_REPO_BACKGROUND_TASK)
         }
+
     }
 }

iOS_SDK/OneSignalSDK/OneSignalOutcomes/Source/OutcomeEvents/OneSignalOutcomeEventsController.h

@@ -52,6 +52,8 @@
                          appId:(NSString * _Nonnull)appId
             pushSubscriptionId:(NSString * _Nonnull)pushSubscriptionId
                    onesignalId:(NSString * _Nonnull)onesignalId
-               influenceParams:(NSArray<OSFocusInfluenceParam *> *_Nonnull)influenceParams;
+               influenceParams:(NSArray<OSFocusInfluenceParam *> * _Nonnull)influenceParams
+                     onSuccess:(OSResultSuccessBlock _Nonnull)successBlock
+                     onFailure:(OSFailureBlock _Nonnull)failureBlock;
 
 @end

iOS_SDK/OneSignalSDK/OneSignalOutcomes/Source/OutcomeEvents/OneSignalOutcomeEventsController.m

@@ -108,22 +108,24 @@ - (void)sendSessionEndOutcomes:(NSNumber * _Nonnull)timeElapsed
                          appId:(NSString * _Nonnull)appId
             pushSubscriptionId:(NSString * _Nonnull)pushSubscriptionId
                    onesignalId:(NSString * _Nonnull)onesignalId
-               influenceParams:(NSArray<OSFocusInfluenceParam *> * _Nonnull)influenceParams {
-    // Don't send influenced session with time < 1 seconds
-    if ([timeElapsed intValue] < 1) {
-        [OneSignalLog onesignalLog:ONE_S_LL_DEBUG message:[NSString stringWithFormat:@"sendSessionEndOutcomes not sending active time %@", timeElapsed]];
-        return;
-    }
-    // TODO: What to do onSuccess and onFailure
+               influenceParams:(NSArray<OSFocusInfluenceParam *> * _Nonnull)influenceParams
+                     onSuccess:(OSResultSuccessBlock _Nonnull)successBlock
+                     onFailure:(OSFailureBlock _Nonnull)failureBlock {
     [OneSignalClient.sharedClient executeRequest:[OSRequestSendSessionEndOutcomes
                                                   withActiveTime:timeElapsed
                                                   appId:appId
                                                   pushSubscriptionId:pushSubscriptionId
                                                   onesignalId:onesignalId
                                                   influenceParams:influenceParams] onSuccess:^(NSDictionary *result) {
-        [OneSignalLog onesignalLog:ONE_S_LL_DEBUG message:@"sendSessionEndOutcomes attributed succeed"];
+        [OneSignalLog onesignalLog:ONE_S_LL_DEBUG message:@"OneSignalOutcomeEventsController:sendSessionEndOutcomes attributed succeed"];
+        if (successBlock) {
+            successBlock(result);
+        }
     } onFailure:^(NSError *error) {
-        [OneSignalLog onesignalLog:ONE_S_LL_DEBUG message:@"sendSessionEndOutcomes attributed failed"];
+        [OneSignalLog onesignalLog:ONE_S_LL_ERROR message:@"OneSignalOutcomeEventsController:sendSessionEndOutcomes attributed failed"];
+        if (failureBlock) {
+            failureBlock(error);
+        }
     }];
 }