Add createdAt to request body.

Author: tapashmajumder

swift-sdk/Constants.swift

@@ -176,6 +176,10 @@ public enum JsonKey: String, JsonKeyRepresentable {
         static let sentAt = "sentAt"
     }
 
+    public enum Body {
+        static let createdAt = "createdAt"
+    }
+    
     public enum InApp {
         static let trigger = "trigger"
         static let type = "type"

swift-sdk/Internal/IterableAPICallRequest.swift

@@ -39,6 +39,14 @@ struct IterableAPICallRequest {
         }
     }
 
+    func addingBodyField(key: AnyHashable, value: Any) -> IterableAPICallRequest {
+        IterableAPICallRequest(apiKey: apiKey,
+                               endPoint: endPoint,
+                               auth: auth,
+                               deviceMetadata: deviceMetadata,
+                               iterableRequest: iterableRequest.addingBodyField(key: key, value: value))
+    }
+    
     private func createIterableHeaders(currentDate: Date) -> [String: String] {
         var headers = [JsonKey.contentType.jsonKey: JsonValue.applicationJson.jsonStringValue,
                        JsonKey.Header.sdkPlatform: JsonValue.iOS.jsonStringValue,

swift-sdk/Internal/IterableAPICallTaskProcessor.swift

@@ -19,7 +19,10 @@ struct IterableAPICallTaskProcessor: IterableTaskProcessor {
             return IterableTaskError.createErroredFuture(reason: "expecting data")
         }
 
-        let iterableRequest = try JSONDecoder().decode(IterableAPICallRequest.self, from: data)
+        let decodedIterableRequest = try JSONDecoder().decode(IterableAPICallRequest.self, from: data)
+        let iterableRequest = decodedIterableRequest.addingBodyField(key: JsonKey.Body.createdAt,
+                                                                     value: IterableUtil.int(fromDate: task.scheduledAt))
+        
         guard let urlRequest = iterableRequest.convertToURLRequest(currentDate: dateProvider.currentDate) else {
             return IterableTaskError.createErroredFuture(reason: "could not convert to url request")
         }

swift-sdk/Internal/IterableRequest.swift

@@ -45,6 +45,14 @@ extension IterableRequest: Codable {
         }
     }
 
+    func addingBodyField(key: AnyHashable, value: Any) -> IterableRequest {
+        if case .post(let postRequest) = self {
+            return .post(postRequest.addingBodyField(key: key, value: value))
+        } else {
+            return self
+        }
+    }
+    
     private static let requestTypeGet = "get"
     private static let requestTypePost = "post"
 }
@@ -58,6 +66,12 @@ struct PostRequest {
     let path: String
     let args: [String: String]?
     let body: [AnyHashable: Any]?
+    
+    func addingBodyField(key: AnyHashable, value: Any) -> PostRequest {
+        var newBody = body ?? [AnyHashable: Any]()
+        newBody[key] = value
+        return PostRequest(path: path, args: args, body: newBody)
+    }
 }
 
 extension PostRequest: Codable {

swift-sdk/Internal/IterableRequestUtil.swift

@@ -8,15 +8,35 @@
 import Foundation
 
 struct IterableRequestUtil {
-    static func createPostRequest(forApiEndPoint apiEndPoint: String, path: String, headers: [String: String]? = nil, args: [String: String]? = nil, body: [AnyHashable: Any]? = nil) -> URLRequest? {
-        createPostRequest(forApiEndPoint: apiEndPoint, path: path, headers: headers, args: args, body: dictToJsonData(body))
+    static func createPostRequest(forApiEndPoint apiEndPoint: String,
+                                  path: String,
+                                  headers: [String: String]? = nil,
+                                  args: [String: String]? = nil,
+                                  body: [AnyHashable: Any]? = nil) -> URLRequest? {
+        createPostRequest(forApiEndPoint: apiEndPoint,
+                          path: path,
+                          headers: headers,
+                          args: args,
+                          body: dictToJsonData(body))
     }
 
-    static func createPostRequest<T: Encodable>(forApiEndPoint apiEndPoint: String, path: String, headers: [String: String]? = nil, args: [String: String]? = nil, body: T) -> URLRequest? {
-        createPostRequest(forApiEndPoint: apiEndPoint, path: path, headers: headers, args: args, body: try? JSONEncoder().encode(body))
+    static func createPostRequest<T: Encodable>(forApiEndPoint apiEndPoint: String,
+                                                path: String,
+                                                headers: [String: String]? = nil,
+                                                args: [String: String]? = nil,
+                                                body: T) -> URLRequest? {
+        createPostRequest(forApiEndPoint: apiEndPoint,
+                          path: path,
+                          headers: headers,
+                          args: args,
+                          body: try? JSONEncoder().encode(body))
     }
 
-    static func createPostRequest(forApiEndPoint apiEndPoint: String, path: String, headers: [String: String]? = nil, args: [String: String]? = nil, body: Data? = nil) -> URLRequest? {
+    static func createPostRequest(forApiEndPoint apiEndPoint: String,
+                                  path: String,
+                                  headers: [String: String]? = nil,
+                                  args: [String: String]? = nil,
+                                  body: Data? = nil) -> URLRequest? {
         guard let url = getUrlComponents(forApiEndPoint: apiEndPoint, path: path, args: args)?.url else {
             return nil
         }
@@ -29,7 +49,10 @@ struct IterableRequestUtil {
         return request
     }
 
-    static func createGetRequest(forApiEndPoint apiEndPoint: String, path: String, headers: [String: String]? = nil, args: [String: String]? = nil) -> URLRequest? {
+    static func createGetRequest(forApiEndPoint apiEndPoint: String,
+                                 path: String,
+                                 headers: [String: String]? = nil,
+                                 args: [String: String]? = nil) -> URLRequest? {
         guard let url = getUrlComponents(forApiEndPoint: apiEndPoint, path: path, args: args)?.url else {
             return nil
         }

tests/offline-events-tests/TaskProcessorTests.swift

@@ -180,7 +180,42 @@ class TaskProcessorTests: XCTestCase {
         wait(for: [expectation1], timeout: 5.0)
     }
 
-    private func createSampleTask() throws -> IterableTask? {
+    func testCreatedAtInBody() throws {
+        let expectation1 = expectation(description: #function)
+        let date = Date()
+        let createdAtTime = Int(date.timeIntervalSince1970 * 1000)
+        let task = try createSampleTask(scheduledAt: date)!
+        
+        let networkSession = MockNetworkSession()
+        networkSession.requestCallback = { request in
+            if request.bodyDict.contains(where: { $0.key == "createdAt" && ($0.value as! Int) == createdAtTime }) {
+                expectation1.fulfill()
+            }
+        }
+        
+        // process data
+        let processor = IterableAPICallTaskProcessor(networkSession: networkSession)
+        try processor.process(task: task)
+            .onSuccess { taskResult in
+                switch taskResult {
+                case .success(detail: _):
+                    break
+                case .failureWithNoRetry(detail: _):
+                    XCTFail("not expecting failure with no retry")
+                case .failureWithRetry(retryAfter: _, detail: _):
+                    XCTFail("not expecting failure with retry")
+                }
+            }
+            .onError { _ in
+                XCTFail()
+            }
+
+        try persistenceProvider.mainQueueContext().delete(task: task)
+        try persistenceProvider.mainQueueContext().save()
+        wait(for: [expectation1], timeout: 5.0)
+    }
+
+    private func createSampleTask(scheduledAt: Date = Date(), requestedAt: Date = Date()) throws -> IterableTask? {
         let apiKey = "test-api-key"
         let email = "[email protected]"
         let eventName = "CustomEvent1"
@@ -206,9 +241,9 @@ class TaskProcessorTests: XCTestCase {
         let taskId = IterableUtil.generateUUID()
         try persistenceProvider.mainQueueContext().create(task: IterableTask(id: taskId,
                                                                              type: .apiCall,
-                                                                             scheduledAt: Date(),
+                                                                             scheduledAt: scheduledAt,
                                                                              data: data,
-                                                                             requestedAt: Date()))
+                                                                             requestedAt: requestedAt))
         try persistenceProvider.mainQueueContext().save()
 
         return try persistenceProvider.mainQueueContext().findTask(withId: taskId)

tests/offline-events-tests/TaskRunnerTests.swift

@@ -240,7 +240,34 @@ class TaskRunnerTests: XCTestCase {
         wait(for: [expectation1], timeout: 5.0)
     }
 
-    private func scheduleSampleTask(notificationCenter: NotificationCenterProtocol) throws -> String {
+    func testCreatedAtInBody() throws {
+        let date = Date()
+        let createdAtTime = Int(date.timeIntervalSince1970 * 1000)
+        let dateProvider = MockDateProvider()
+        dateProvider.currentDate = date
+        let expectation1 = expectation(description: #function)
+        let networkSession = MockNetworkSession()
+        networkSession.requestCallback = { request in
+            if request.bodyDict.contains(where: { $0.key == "createdAt" && ($0.value as! Int) == createdAtTime }) {
+                expectation1.fulfill()
+            }
+        }
+        let notificationCenter = MockNotificationCenter()
+        
+        let taskRunner = IterableTaskRunner(networkSession: networkSession,
+                           persistenceContextProvider: persistenceContextProvider,
+                           notificationCenter: notificationCenter,
+                           timeInterval: 0.5)
+        taskRunner.start()
+
+        let _ = try! self.scheduleSampleTask(notificationCenter: notificationCenter, dateProvider: dateProvider)
+        verifyTaskIsExecuted(notificationCenter, withinInterval: 1.0)
+
+        taskRunner.stop()
+        wait(for: [expectation1], timeout: 5.0)
+    }
+    
+    private func scheduleSampleTask(notificationCenter: NotificationCenterProtocol, dateProvider: DateProviderProtocol = SystemDateProvider()) throws -> String {
         let apiKey = "zee-api-key"
         let eventName = "CustomEvent1"
         let dataFields = ["var1": "val1", "var2": "val2"]
@@ -292,11 +319,9 @@ class TaskRunnerTests: XCTestCase {
                                                 appPackageName: Bundle.main.appPackageName ?? "")
 
     private lazy var persistenceContextProvider: IterablePersistenceContextProvider = {
-        let provider = CoreDataPersistenceContextProvider(dateProvider: dateProvider)!
+        let provider = CoreDataPersistenceContextProvider()!
         return provider
     }()
-
-    private let dateProvider = MockDateProvider()
 }
 
 extension TaskRunnerTests: AuthProvider {