Merge pull request #631 from PravinPK/assurance

[MOB-14383] - Update NetworkService to post raw blob data
adobe · May 20, 2021 · 1599c5e · 1599c5e
2 parents ad8a261 + 45e5a25
commit 1599c5e
Show file tree

Hide file tree

Showing 5 changed files with 47 additions and 7 deletions.
diff --git a/AEPIntegrationTests/SignalIntegrationTests.swift b/AEPIntegrationTests/SignalIntegrationTests.swift
@@ -88,7 +88,7 @@ class SignalIntegrationTests: XCTestCase {
             if request.url.absoluteString.starts(with: "https://www.signal.com") {
                 XCTAssertEqual("https://www.signal.com?name=testPostRequest", request.url.absoluteString)
                 XCTAssertEqual(HttpMethod.post, request.httpMethod)
-                XCTAssertEqual("name=testPostRequest", request.connectPayload)
+                XCTAssertEqual("name=testPostRequest", String(decoding: request.connectPayload, as: UTF8.self))
                 XCTAssertEqual("zip", request.httpHeaders["Content-Type"])
                 XCTAssertEqual(2, request.connectTimeout)
                 XCTAssertEqual(2, request.readTimeout)

diff --git a/AEPServices/Sources/network/NetworkRequest.swift b/AEPServices/Sources/network/NetworkRequest.swift
@@ -19,7 +19,7 @@ import Foundation
 
     public let url: URL
     public let httpMethod: HttpMethod
-    public let connectPayload: String
+    public let connectPayload: Data
     public let httpHeaders: [String: String]
     public let connectTimeout: TimeInterval
     public let readTimeout: TimeInterval
@@ -33,10 +33,27 @@ import Foundation
     ///   - connectTimeout: optional connect timeout value in seconds; default is 5 seconds
     ///   - readTimeout: optional read timeout value in seconds, used to wait for a read to finish after a successful connect, default is 5 seconds
     /// - Returns: an initialized `NetworkRequest` object
-    public init(url: URL, httpMethod: HttpMethod = HttpMethod.get, connectPayload: String = "", httpHeaders: [String: String] = [:], connectTimeout: TimeInterval = 5, readTimeout: TimeInterval = 5) {
+    public convenience init(url: URL, httpMethod: HttpMethod = HttpMethod.get, connectPayload: String = "", httpHeaders: [String: String] = [:], connectTimeout: TimeInterval = 5, readTimeout: TimeInterval = 5) {
+        self.init(url: url,
+                  httpMethod: httpMethod,
+                  connectPayloadData: connectPayload.data(using: .utf8) ?? Data(),
+                  httpHeaders: httpHeaders,
+                  connectTimeout: connectTimeout,
+                  readTimeout: readTimeout)
+    }
+
+    /// Initialize the `NetworkRequest`
+    /// - Parameters:
+    ///   - url: URL used to initiate the network connection, should use https scheme
+    ///   - connectPayloadData: the body of the network request as a Data
+    ///   - httpHeaders: optional HTTP headers for the request
+    ///   - connectTimeout: optional connect timeout value in seconds; default is 5 seconds
+    ///   - readTimeout: optional read timeout value in seconds, used to wait for a read to finish after a successful connect, default is 5 seconds
+    /// - Returns: an initialized `NetworkRequest` object
+    public init(url: URL, httpMethod: HttpMethod = HttpMethod.get, connectPayloadData: Data, httpHeaders: [String: String] = [:], connectTimeout: TimeInterval = 5, readTimeout: TimeInterval = 5) {
         self.url = url
         self.httpMethod = httpMethod
-        self.connectPayload = connectPayload
+        self.connectPayload = connectPayloadData
 
         let systemInfoService = ServiceProvider.shared.systemInfoService
         let defaultHeaders = [NetworkRequest.REQUEST_HEADER_KEY_USER_AGENT: systemInfoService.getDefaultUserAgent(),

diff --git a/AEPServices/Sources/network/NetworkService.swift b/AEPServices/Sources/network/NetworkService.swift
@@ -72,7 +72,7 @@ class NetworkService: Networking {
         request.httpMethod = networkRequest.httpMethod.toString()
 
         if !networkRequest.connectPayload.isEmpty, networkRequest.httpMethod == .post {
-            request.httpBody = networkRequest.connectPayload.data(using: .utf8)
+            request.httpBody = networkRequest.connectPayload
         }
 
         for (key, val) in networkRequest.httpHeaders {

diff --git a/AEPServices/Tests/services/NetworkServiceTests.swift b/AEPServices/Tests/services/NetworkServiceTests.swift
@@ -154,6 +154,29 @@ class NetworkServiceTests: XCTestCase {
         XCTAssertEqual(testUrl, mockSession.calledWithUrlRequest?.url)
     }
 
+    func testConnectAsync_initiatesConnection_whenValidNetworkRequest_withData() {
+        // setup
+        let sampleData = "sampleData".data(using: .utf8)!
+        let expectation = XCTestExpectation(description: "Completion handler called")
+
+        // test
+        let testUrl = URL(string: "https://test.com")!
+        let networkRequest = NetworkRequest(url: testUrl, httpMethod: .post, connectPayloadData: sampleData, connectTimeout: 2.0, readTimeout: 2.0)
+        networkStub.connectAsync(networkRequest: networkRequest, completionHandler: { connection in
+            XCTAssertEqual(jsonData, connection.data) // jsonData is the data returned from MockSession
+            XCTAssertNil(connection.response)
+            XCTAssertNil(connection.error)
+            expectation.fulfill()
+        })
+
+        // verify
+        wait(for: [expectation], timeout: 1.0)
+        XCTAssertTrue(mockSession.dataTaskWithCompletionHandlerCalled)
+        XCTAssertEqual(sampleData, mockSession.calledWithUrlRequest?.httpBody) // makes the network call with the same data provided in network request
+        XCTAssertEqual("POST", mockSession.calledWithUrlRequest?.httpMethod)
+        XCTAssertEqual(testUrl, mockSession.calledWithUrlRequest?.url)
+    }
+
     func testConnectAsync_returnsTimeoutError_whenConnectionTimesOut() {
         let defaultNetworkService = NetworkService()
         let expectation = XCTestExpectation(description: "Completion handler called")

diff --git a/AEPSignal/Tests/SignalHitProcessorTests.swift b/AEPSignal/Tests/SignalHitProcessorTests.swift
@@ -71,7 +71,7 @@ class SignalHitProcessorTests: XCTestCase {
             throw SignalHitProcessingError.invalidNetworkRequest
         }
         XCTAssertEqual(testUrl, sentRequest.url)
-        XCTAssertEqual(testPostBody, sentRequest.connectPayload)
+        XCTAssertEqual(testPostBody, String(decoding: sentRequest.connectPayload, as: UTF8.self))
         XCTAssertEqual(HttpMethod.post, sentRequest.httpMethod)
         XCTAssertEqual(testContentType, sentRequest.httpHeaders[NetworkServiceConstants.Headers.CONTENT_TYPE])
         XCTAssertEqual(testTimeout, sentRequest.connectTimeout)
@@ -101,7 +101,7 @@ class SignalHitProcessorTests: XCTestCase {
             throw SignalHitProcessingError.invalidNetworkRequest
         }
         XCTAssertEqual(testUrl, sentRequest.url)
-        XCTAssertEqual("", sentRequest.connectPayload)
+        XCTAssertEqual("", String(decoding: sentRequest.connectPayload, as: UTF8.self))
         XCTAssertEqual(HttpMethod.get, sentRequest.httpMethod)
         XCTAssertNil(sentRequest.httpHeaders[NetworkServiceConstants.Headers.CONTENT_TYPE])
         XCTAssertEqual(testTimeout, sentRequest.connectTimeout)