Merge pull request #394 from Iterable/feature/mob-2051

[MOB-2051] - Fix TaskScheduler `schedule` method to return `Result`.

Author: tapashmajumder

swift-sdk/Internal/IterableTaskScheduler.swift

@@ -17,22 +17,25 @@ class IterableTaskScheduler {
 
     func schedule(apiCallRequest: IterableAPICallRequest,
                   context: IterableTaskContext = IterableTaskContext(blocking: true),
-                  scheduledAt: Date? = nil) throws -> String {
+                  scheduledAt: Date? = nil) -> Result<String, IterableTaskError> {
         ITBInfo()
         let taskId = IterableUtil.generateUUID()
-        let data = try JSONEncoder().encode(apiCallRequest)
-
-        try persistenceContext.create(task: IterableTask(id: taskId,
-                                                         name: apiCallRequest.getPath(),
-                                                         type: .apiCall,
-                                                         scheduledAt: scheduledAt ?? dateProvider.currentDate,
-                                                         data: data,
-                                                         requestedAt: dateProvider.currentDate))
-        try persistenceContext.save()
-
-        notificationCenter.post(name: .iterableTaskScheduled, object: self, userInfo: nil)
-        
-        return taskId
+        do {
+            let data = try JSONEncoder().encode(apiCallRequest)
+            
+            try persistenceContext.create(task: IterableTask(id: taskId,
+                                                             name: apiCallRequest.getPath(),
+                                                             type: .apiCall,
+                                                             scheduledAt: scheduledAt ?? dateProvider.currentDate,
+                                                             data: data,
+                                                             requestedAt: dateProvider.currentDate))
+            try persistenceContext.save()
+            
+            notificationCenter.post(name: .iterableTaskScheduled, object: self, userInfo: nil)
+        } catch let error {
+            return Result.failure(IterableTaskError.general("schedule taskId: \(taskId) failed with error: \(error.localizedDescription)"))
+        }
+        return Result.success(taskId)
     }
 
     private let persistenceContextProvider: IterablePersistenceContextProvider

swift-sdk/Internal/OfflineRequestProcessor.swift

@@ -367,17 +367,15 @@ struct OfflineRequestProcessor: RequestProcessorProtocol {
                                                     auth: authProvider.auth,
                                                     deviceMetadata: deviceMetadata,
                                                     iterableRequest: iterableRequest)
-        
-        do {
-            let taskId = try taskScheduler.schedule(apiCallRequest: apiCallRequest,
-                                                    context: IterableTaskContext(blocking: true))
+        switch taskScheduler.schedule(apiCallRequest: apiCallRequest, context: IterableTaskContext(blocking: true)) {
+        case .success(let taskId):
             let result = notificationListener.futureFromTask(withTaskId: taskId)
             return RequestProcessorUtil.apply(successHandler: onSuccess,
                                               andFailureHandler: onFailure,
                                               andAuthManager: authManager,
                                               toResult: result,
                                               withIdentifier: identifier)
-        } catch let error {
+        case .failure(let error):
             ITBError(error.localizedDescription)
             return SendRequestError.createErroredFuture(reason: error.localizedDescription)
         }

tests/offline-events-tests/TaskRunnerTests.swift

@@ -231,7 +231,7 @@ class TaskRunnerTests: XCTestCase {
 
         return try IterableTaskScheduler(persistenceContextProvider: persistenceContextProvider,
                                          notificationCenter: notificationCenter,
-                                         dateProvider: dateProvider).schedule(apiCallRequest: apiCallRequest)
+                                         dateProvider: dateProvider).schedule(apiCallRequest: apiCallRequest).get()
     }
 
     private func verifyNoTaskIsExecuted(_ notificationCenter: MockNotificationCenter, forInterval interval: TimeInterval) {

tests/offline-events-tests/TaskSchedulerTests.swift

@@ -45,7 +45,7 @@ class TaskSchedulerTests: XCTestCase {
         let scheduler = IterableTaskScheduler(persistenceContextProvider: persistenceContextProvider,
                                               notificationCenter: notificationCenter,
                                               dateProvider: dateProvider)
-        let taskId = try scheduler.schedule(apiCallRequest: apiCallRequest)
+        let taskId = try scheduler.schedule(apiCallRequest: apiCallRequest).get()
 
         wait(for: [expectation1], timeout: 10.0)