Merge pull request #447 from Iterable/feature/mob-2547-add-header

[MOB-2547] - Add "SDK-Request-Processor" field to header.

Author: tapashmajumder

swift-sdk/Constants.swift

@@ -67,6 +67,11 @@ public enum Const {
 
         static let unassigned = 300.5
     }
+    
+    enum ProcessorTypeName {
+        static let online = "Online"
+        static let offline = "Offline"
+    }
 }
 
 public protocol JsonKeyValueRepresentable {
@@ -186,6 +191,7 @@ public enum JsonKey: String, JsonKeyRepresentable {
         static let sdkPlatform = "SDK-Platform"
         static let authorization = "Authorization"
         static let sentAt = "sentAt"
+        static let requestProcessor = "SDK-Request-Processor"
     }
 
     public enum Body {

swift-sdk/Internal/IterableAPICallRequest.swift

@@ -13,17 +13,24 @@ struct IterableAPICallRequest {
     let deviceMetadata: DeviceMetadata
     let iterableRequest: IterableRequest
 
-    func convertToURLRequest(currentDate: Date) -> URLRequest? {
+    enum ProcessorType {
+        case offline
+        case online
+    }
+    
+    func convertToURLRequest(currentDate: Date, processorType: ProcessorType = .online) -> URLRequest? {
         switch iterableRequest {
         case let .get(getRequest):
             return IterableRequestUtil.createGetRequest(forApiEndPoint: endPoint,
                                                         path: getRequest.path,
-                                                        headers: createIterableHeaders(currentDate: currentDate),
+                                                        headers: createIterableHeaders(currentDate: currentDate,
+                                                                                       processorType: processorType),
                                                         args: getRequest.args)
         case let .post(postRequest):
             return IterableRequestUtil.createPostRequest(forApiEndPoint: endPoint,
                                                          path: postRequest.path,
-                                                         headers: createIterableHeaders(currentDate: currentDate),
+                                                         headers: createIterableHeaders(currentDate: currentDate,
+                                                                                        processorType: processorType),
                                                          args: postRequest.args,
                                                          body: postRequest.body)
         }
@@ -46,12 +53,13 @@ struct IterableAPICallRequest {
                                iterableRequest: iterableRequest.addingBodyField(key: key, value: value))
     }
 
-    private func createIterableHeaders(currentDate: Date) -> [String: String] {
+    private func createIterableHeaders(currentDate: Date, processorType: ProcessorType) -> [String: String] {
         var headers = [JsonKey.contentType.jsonKey: JsonValue.applicationJson.jsonStringValue,
                        JsonKey.Header.sdkPlatform: JsonValue.iOS.jsonStringValue,
                        JsonKey.Header.sdkVersion: IterableAPI.sdkVersion,
                        JsonKey.Header.apiKey: apiKey,
                        JsonKey.Header.sentAt: Self.format(sentAt: currentDate),
+                       JsonKey.Header.requestProcessor: Self.name(for: processorType)
         ]
 
         if let authToken = auth.authToken {
@@ -64,6 +72,15 @@ struct IterableAPICallRequest {
     private static func format(sentAt: Date) -> String {
         return "\(IterableUtil.secondsFromEpoch(for: sentAt))"
     }
+    
+    private static func name(for processorType: ProcessorType) -> String {
+        switch processorType {
+        case .online:
+            return Const.ProcessorTypeName.online
+        case .offline:
+            return Const.ProcessorTypeName.offline
+        }
+    }
 }
 
 extension IterableAPICallRequest: Codable {}

swift-sdk/Internal/IterableAPICallTaskProcessor.swift

@@ -22,7 +22,7 @@ struct IterableAPICallTaskProcessor: IterableTaskProcessor {
         let iterableRequest = decodedIterableRequest.addingBodyField(key: JsonKey.Body.createdAt,
                                                                      value: IterableUtil.secondsFromEpoch(for: task.scheduledAt))
 
-        guard let urlRequest = iterableRequest.convertToURLRequest(currentDate: dateProvider.currentDate) else {
+        guard let urlRequest = iterableRequest.convertToURLRequest(currentDate: dateProvider.currentDate, processorType: .offline) else {
             return IterableTaskError.createErroredFuture(reason: "could not convert to url request")
         }
 

tests/swift-sdk-swift-tests/RequestCreatorTests.swift

@@ -345,6 +345,26 @@ class RequestCreatorTests: XCTestCase {
         TestUtils.validateMatch(keyPath: KeyPath(JsonKey.preferUserId), value: true, inDictionary: body)
     }
 
+    func testProcessorTypeOfflineInHeader() throws {
+        let eventName = "dsfsdf"
+        
+        let iterableRequest = try createRequestCreator().createTrackEventRequest(eventName, dataFields: nil).get()
+        let apiCallRequest = IterableAPICallRequest(apiKey: apiKey,
+                                                    endPoint: Endpoint.api,
+                                                    auth: Auth(userId: nil, email: "[email protected]", authToken: nil),
+                                                    deviceMetadata: deviceMetadata,
+                                                    iterableRequest: iterableRequest)
+        
+        let request = apiCallRequest.convertToURLRequest(currentDate: dateProvider.currentDate, processorType: .offline)!
+        
+        TestUtils.validateHeader(request, apiKey, processorType: .offline)
+        TestUtils.validate(request: request, requestType: .post, apiEndPoint: Endpoint.api, path: Const.Path.trackEvent)
+        
+        let body = request.bodyDict
+        TestUtils.validateMatch(keyPath: KeyPath(.eventName), value: eventName, inDictionary: body)
+        TestUtils.validateNil(keyPath: KeyPath(.dataFields), inDictionary: body)
+    }
+
     private let apiKey = "zee-api-key"
 
     private let email = "[email protected]"

tests/swift-sdk-swift-tests/TestUtils.swift

@@ -68,7 +68,7 @@ struct TestUtils {
         }
     }
 
-    static func validateHeader(_ request: URLRequest, _ apiKey: String) {
+    static func validateHeader(_ request: URLRequest, _ apiKey: String, processorType: IterableAPICallRequest.ProcessorType = .online) {
         guard let header = request.allHTTPHeaderFields else {
             XCTFail("no header for request")
             return
@@ -78,6 +78,7 @@ struct TestUtils {
         XCTAssertEqual(header[JsonKey.Header.sdkPlatform], JsonValue.iOS.jsonStringValue)
         XCTAssertEqual(header[JsonKey.Header.sdkVersion], IterableAPI.sdkVersion)
         XCTAssertEqual(header[JsonKey.Header.apiKey], apiKey)
+        XCTAssertEqual(header[JsonKey.Header.requestProcessor], processorType == .online ? "Online" : "Offline")
     }
 
     static func validateEmailOrUserId(email: String? = nil, userId: String? = nil, inBody body: [String: Any]) {