Update background sending session_time to user

nan-li · nan-li · commit c6cfcda5033c · 2023-08-10T03:33:49.000-07:00
* When app is backgrounded, create a background task and send the session_time to the user endpoint
* Have callbacks, bypassing the operation repo
* This is done both for unattributed sessions that send the request right away and for attributed sessions that wait 30 seconds before sending
diff --git a/iOS_SDK/OneSignalSDK/OneSignalUser/Source/OSPropertyOperationExecutor.swift b/iOS_SDK/OneSignalSDK/OneSignalUser/Source/OSPropertyOperationExecutor.swift
@@ -180,7 +180,7 @@ class OSPropertyOperationExecutor: OSOperationExecutor {
 
 extension OSPropertyOperationExecutor {
     // TODO: We can make this go through the operation repo
-    func updateProperties(propertiesDeltas: OSPropertiesDeltas, refreshDeviceMetadata: Bool?, propertiesModel: OSPropertiesModel, identityModel: OSIdentityModel) {
+    func updateProperties(propertiesDeltas: OSPropertiesDeltas, refreshDeviceMetadata: Bool, propertiesModel: OSPropertiesModel, identityModel: OSIdentityModel, sendImmediately: Bool = false, onSuccess: (() -> Void)? = nil, onFailure: (() -> Void)? = nil) {
 
         let request = OSRequestUpdateProperties(
             properties: [:],
@@ -189,7 +189,20 @@ extension OSPropertyOperationExecutor {
             modelToUpdate: propertiesModel,
             identityModel: identityModel)
 
-        updateRequestQueue.append(request)
-        OneSignalUserDefaults.initShared().saveCodeableData(forKey: OS_PROPERTIES_EXECUTOR_UPDATE_REQUEST_QUEUE_KEY, withValue: self.updateRequestQueue)
+        if (sendImmediately) {
+            // Bypass the request queues
+            OneSignalClient.shared().execute(request) { _ in
+                if let onSuccess = onSuccess {
+                    onSuccess()
+                }
+            } onFailure: { _ in
+                if let onFailure = onFailure {
+                    onFailure()
+                }
+            }
+        } else {
+            updateRequestQueue.append(request)
+            OneSignalUserDefaults.initShared().saveCodeableData(forKey: OS_PROPERTIES_EXECUTOR_UPDATE_REQUEST_QUEUE_KEY, withValue: self.updateRequestQueue)
+        }
     }
 }
diff --git a/iOS_SDK/OneSignalSDK/OneSignalUser/Source/OneSignalUserManagerImpl.swift b/iOS_SDK/OneSignalSDK/OneSignalUser/Source/OneSignalUserManagerImpl.swift
@@ -548,8 +548,11 @@ extension OneSignalUserManagerImpl {
     }
 
     @objc
-    public func updateSession(sessionCount: NSNumber?, sessionTime: NSNumber?, refreshDeviceMetadata: Bool) {
+    public func updateSession(sessionCount: NSNumber?, sessionTime: NSNumber?, refreshDeviceMetadata: Bool, sendImmediately: Bool = false, onSuccess: (() -> Void)? = nil, onFailure: (() -> Void)? = nil) {
         guard !OneSignalConfigManager.shouldAwaitAppIdAndLogMissingPrivacyConsent(forMethod: nil) else {
+            if let onFailure = onFailure {
+                onFailure()
+            }
             return
         }
 
@@ -564,10 +567,16 @@ extension OneSignalUserManagerImpl {
                 propertiesDeltas: propertiesDeltas,
                 refreshDeviceMetadata: refreshDeviceMetadata,
                 propertiesModel: propertiesModel,
-                identityModel: identityModel
+                identityModel: identityModel,
+                sendImmediately: sendImmediately,
+                onSuccess: onSuccess,
+                onFailure: onFailure
             )
         } else {
             OneSignalLog.onesignalLog(.LL_ERROR, message: "OneSignalUserManagerImpl.updateSession with sessionCount: \(String(describing: sessionCount)) sessionTime: \(String(describing: sessionTime)) cannot be executed due to missing property executor.")
+            if let onFailure = onFailure {
+                onFailure()
+            }
         }
     }
 
diff --git a/iOS_SDK/OneSignalSDK/Source/OSAttributedFocusTimeProcessor.m b/iOS_SDK/OneSignalSDK/Source/OSAttributedFocusTimeProcessor.m
@@ -28,6 +28,7 @@
 #import <OneSignalCore/OneSignalCore.h>
 #import "OneSignalFramework.h"
 #import "OSAttributedFocusTimeProcessor.h"
+#import <OneSignalUser/OneSignalUser.h>
 
 @interface OneSignal ()
 + (void)sendSessionEndOutcomes:(NSNumber*)totalTimeActive params:(OSFocusCallParams *)params onSuccess:(OSResultSuccessBlock _Nonnull)successBlock onFailure:(OSFailureBlock _Nonnull)failureBlock;
@@ -43,6 +44,8 @@ @implementation OSAttributedFocusTimeProcessor {
 - (instancetype)init {
     self = [super init];
     [OSBackgroundTaskManager setTaskInvalid:ATTRIBUTED_FOCUS_TASK];
+    [OSBackgroundTaskManager setTaskInvalid:SEND_SESSION_TIME_TO_USER_TASK];
+
     return self;
 }
 
@@ -80,37 +83,51 @@ - (void)sendOnFocusCallWithParams:(OSFocusCallParams *)params totalTimeActive:(N
     }
     
     [OSBackgroundTaskManager beginBackgroundTask:ATTRIBUTED_FOCUS_TASK];
+    [OSBackgroundTaskManager beginBackgroundTask:SEND_SESSION_TIME_TO_USER_TASK];
 
     if (params.onSessionEnded) {
-        [self sendBackgroundAttributedFocusPingWithParams:params withTotalTimeActive:@(totalTimeActive)];
+        [self sendBackgroundAttributedSessionTimeWithParams:params withTotalTimeActive:@(totalTimeActive)];
         return;
     }
     
     restCallTimer = [NSTimer
         scheduledTimerWithTimeInterval:DELAY_TIME
                                target:self
-                             selector:@selector(sendBackgroundAttributedFocusPingWithNSTimer:)
+                             selector:@selector(sendBackgroundAttributedSessionTimeWithNSTimer:)
                              userInfo:@{@"params": params, @"time": @(totalTimeActive)}
                               repeats:false];
 }
 
-- (void)sendBackgroundAttributedFocusPingWithNSTimer:(NSTimer*)timer {
+- (void)sendBackgroundAttributedSessionTimeWithNSTimer:(NSTimer*)timer {
     let userInfo = (NSDictionary<NSString*, id>*)timer.userInfo;
     let params = (OSFocusCallParams*)userInfo[@"params"];
     let totalTimeActive = (NSNumber*)userInfo[@"time"];
-    [self sendBackgroundAttributedFocusPingWithParams:params withTotalTimeActive:totalTimeActive];
+    [self sendBackgroundAttributedSessionTimeWithParams:params withTotalTimeActive:totalTimeActive];
 }
 
-- (void)sendBackgroundAttributedFocusPingWithParams:(OSFocusCallParams *)params withTotalTimeActive:(NSNumber*)totalTimeActive {
-    
-    [OneSignalLog onesignalLog:ONE_S_LL_DEBUG message:@"OSAttributedFocusTimeProcessor:sendBackgroundAttributedFocusPingWithParams start"];
-    // TODO: Can we get wait for onSuccess to call [super saveUnsentActiveTime:0]
-    // Need on failure an success to end background task
-    if ([OneSignal sendSessionEndOutcomes:totalTimeActive params:params]) {
-        [super saveUnsentActiveTime:0];
-    }
+- (void)sendBackgroundAttributedSessionTimeWithParams:(OSFocusCallParams *)params withTotalTimeActive:(NSNumber*)totalTimeActive {
+    [OneSignalLog onesignalLog:ONE_S_LL_DEBUG message:@"OSAttributedFocusTimeProcessor:sendBackgroundAttributedSessionTimeWithParams start"];
 
-    [OSBackgroundTaskManager endBackgroundTask:ATTRIBUTED_FOCUS_TASK];
+    dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
+        [OneSignalUserManagerImpl.sharedInstance updateSessionWithSessionCount:nil sessionTime:totalTimeActive refreshDeviceMetadata:false sendImmediately:true onSuccess:^{
+            [super saveUnsentActiveTime:0];
+            [OneSignalLog onesignalLog:ONE_S_LL_DEBUG message:@"sendBackgroundAttributed session time succeed, saveUnsentActiveTime with 0"];
+            [OSBackgroundTaskManager endBackgroundTask:SEND_SESSION_TIME_TO_USER_TASK];
+        } onFailure:^{
+            [OneSignalLog onesignalLog:ONE_S_LL_ERROR message:@"sendBackgroundAttributed session time failed, will retry on next open"];
+            [OSBackgroundTaskManager endBackgroundTask:SEND_SESSION_TIME_TO_USER_TASK];
+        }];
+    });
+    
+    dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
+        [OneSignal sendSessionEndOutcomes:totalTimeActive params:params onSuccess:^(NSDictionary *result) {
+            [OneSignalLog onesignalLog:ONE_S_LL_DEBUG message:@"sendBackgroundAttributed succeed"];
+            [OSBackgroundTaskManager endBackgroundTask:ATTRIBUTED_FOCUS_TASK];
+        } onFailure:^(NSError *error) {
+            [OneSignalLog onesignalLog:ONE_S_LL_ERROR message:@"sendBackgroundAttributed failed, will retry on next open"];
+            [OSBackgroundTaskManager endBackgroundTask:ATTRIBUTED_FOCUS_TASK];
+        }];
+    });
 }
 
 - (void)cancelDelayedJob {
@@ -120,6 +137,8 @@ - (void)cancelDelayedJob {
     [restCallTimer invalidate];
     restCallTimer = nil;
     [OSBackgroundTaskManager endBackgroundTask:ATTRIBUTED_FOCUS_TASK];
+    [OSBackgroundTaskManager endBackgroundTask:SEND_SESSION_TIME_TO_USER_TASK];
+
 }
 
 @end
diff --git a/iOS_SDK/OneSignalSDK/Source/OSUnattributedFocusTimeProcessor.m b/iOS_SDK/OneSignalSDK/Source/OSUnattributedFocusTimeProcessor.m
@@ -77,15 +77,14 @@ - (void)sendOnFocusCallWithParams:(OSFocusCallParams *)params totalTimeActive:(N
         
         [OneSignalLog onesignalLog:ONE_S_LL_DEBUG message:@"OSUnattributedFocusTimeProcessor:sendOnFocusCallWithParams start"];
         
-        // updateSession can have a success fail block
-        [OneSignalUserManagerImpl.sharedInstance updateSessionWithSessionCount:nil sessionTime:@(totalTimeActive) refreshDeviceMetadata:false];
-        
-        // TODO: Can we get wait for onSuccess to call [super saveUnsentActiveTime:0]
-        // TODO: Revisit when we also test op repo flushing on backgrounding
-        // We could have callbacks from user module updateSessionTime and set to 0 when we get that callback
-        [super saveUnsentActiveTime:0];
-
-        [OSBackgroundTaskManager endBackgroundTask:UNATTRIBUTED_FOCUS_TASK];
+        [OneSignalUserManagerImpl.sharedInstance updateSessionWithSessionCount:nil sessionTime:@(totalTimeActive) refreshDeviceMetadata:false sendImmediately:true onSuccess:^{
+            [super saveUnsentActiveTime:0];
+            [OneSignalLog onesignalLog:ONE_S_LL_DEBUG message:@"sendOnFocusCallWithParams unattributed succeed, saveUnsentActiveTime with 0"];
+            [OSBackgroundTaskManager endBackgroundTask:UNATTRIBUTED_FOCUS_TASK];
+        } onFailure:^{
+            [OneSignalLog onesignalLog:ONE_S_LL_WARN message:@"sendOnFocusCallWithParams unattributed failed, will retry on next open"];
+            [OSBackgroundTaskManager endBackgroundTask:UNATTRIBUTED_FOCUS_TASK];
+        }];
     });
 }
 

Original file line number	Diff line number	Diff line change
`@@ -548,8 +548,11 @@ extension OneSignalUserManagerImpl {`
`548`	`548`	`}`
`549`	`549`
`550`	`550`	`@objc`
`551`		`- public func updateSession(sessionCount: NSNumber?, sessionTime: NSNumber?, refreshDeviceMetadata: Bool) {`
	`551`	`+ public func updateSession(sessionCount: NSNumber?, sessionTime: NSNumber?, refreshDeviceMetadata: Bool, sendImmediately: Bool = false, onSuccess: (() -> Void)? = nil, onFailure: (() -> Void)? = nil) {`
`552`	`552`	`guard !OneSignalConfigManager.shouldAwaitAppIdAndLogMissingPrivacyConsent(forMethod: nil) else {`
	`553`	`+ if let onFailure = onFailure {`
	`554`	`+ onFailure()`
	`555`	`+ }`
`553`	`556`	`return`
`554`	`557`	`}`
`555`	`558`
`@@ -564,10 +567,16 @@ extension OneSignalUserManagerImpl {`
`564`	`567`	`propertiesDeltas: propertiesDeltas,`
`565`	`568`	`refreshDeviceMetadata: refreshDeviceMetadata,`
`566`	`569`	`propertiesModel: propertiesModel,`
`567`		`- identityModel: identityModel`
	`570`	`+ identityModel: identityModel,`
	`571`	`+ sendImmediately: sendImmediately,`
	`572`	`+ onSuccess: onSuccess,`
	`573`	`+ onFailure: onFailure`
`568`	`574`	`)`
`569`	`575`	`} else {`
`570`	`576`	`OneSignalLog.onesignalLog(.LL_ERROR, message: "OneSignalUserManagerImpl.updateSession with sessionCount: \(String(describing: sessionCount)) sessionTime: \(String(describing: sessionTime)) cannot be executed due to missing property executor.")`
	`577`	`+ if let onFailure = onFailure {`
	`578`	`+ onFailure()`
	`579`	`+ }`
`571`	`580`	`}`
`572`	`581`	`}`
`573`	`582`