Added possibility to use custom URLSession instance

railwaymen · Sep 11, 2020 · bad6b97 · bad6b97
1 parent 491a603
commit bad6b97
Show file tree

Hide file tree

Showing 12 changed files with 142 additions and 15 deletions.
diff --git a/.swiftlint.yml b/.swiftlint.yml
@@ -14,6 +14,7 @@ function_body_length:
 identifier_name:
   excluded:
     - id
+    - rx
 
 warning_threshold: 5
 

diff --git a/Sources/Restler/Internal/Networking.swift b/Sources/Restler/Internal/Networking.swift
@@ -9,6 +9,7 @@ typealias DataCompletion = (DataResult) -> Void
 protocol NetworkingType: class {
     func makeRequest(
         urlRequest: URLRequest,
+        urlSession: URLSessionType?,
         eventLogger: EventLoggerLogging,
         completion: @escaping DataCompletion) -> Restler.Task
 
@@ -40,13 +41,16 @@ final class Networking {
 extension Networking: NetworkingType {
     func makeRequest(
         urlRequest: URLRequest,
+        urlSession: URLSessionType?,
         eventLogger: EventLoggerLogging,
         completion: @escaping DataCompletion
     ) -> Restler.Task {
-        Restler.Task(task: self.runDataTask(
-            request: urlRequest,
-            eventLogger: eventLogger,
-            completion: completion))
+        Restler.Task(
+            task: self.runDataTask(
+                request: urlRequest,
+                urlSession: urlSession,
+                eventLogger: eventLogger,
+                completion: completion))
     }
 
     func buildRequest(
@@ -106,11 +110,13 @@ extension Networking {
 
     private func runDataTask(
         request: URLRequest,
+        urlSession: URLSessionType?,
         eventLogger: EventLoggerLogging,
         completion: @escaping DataCompletion
     ) -> URLSessionDataTaskType {
+        let session = urlSession ?? self.session
         let startTime: DispatchTime = .now()
-        let task = self.session.dataTask(with: request) { response in
+        let task = session.dataTask(with: request) { response in
             let elapsedTime: Milliseconds = DispatchTime.now().since(startTime).toMilliseconds()
             eventLogger.log(.requestCompleted(
                 request: request,

diff --git a/Sources/Restler/Internal/RestlerRequestInternal.swift b/Sources/Restler/Internal/RestlerRequestInternal.swift
@@ -2,6 +2,7 @@ import Foundation
 
 protocol RestlerRequestInternal: class {
     var dependencies: Restler.RequestDependencies { get }
+    var form: Restler.RequestForm { get }
     func getCompletion() -> DataCompletion
 }
 
@@ -13,6 +14,7 @@ extension RestlerRequestInternal {
         let completion = self.getCompletion()
         return self.dependencies.networking.makeRequest(
             urlRequest: urlRequest,
+            urlSession: self.form.urlSession,
             eventLogger: self.dependencies.eventLogger,
             completion: completion)
     }
@@ -55,4 +57,8 @@ extension Restler {
             self.urlRequest = urlRequest
         }
     }
+
+    struct RequestForm {
+        var urlSession: URLSessionType?
+    }
 }
diff --git a/Sources/Restler/Public/Classes/Request/DecodableRequest.swift b/Sources/Restler/Public/Classes/Request/DecodableRequest.swift
@@ -3,6 +3,7 @@ import Foundation
 extension Restler {
     public final class DecodableRequest<D: Decodable>: Request<D>, RestlerRequestInternal {
         internal let dependencies: Restler.RequestDependencies
+        internal var form: Restler.RequestForm = .init()
 
         private var successCompletionHandler: ((D) -> Void)?
         private var failureCompletionHandler: ((Swift.Error) -> Void)?
@@ -36,6 +37,11 @@ extension Restler {
             self.buildNetworkingRequest()
         }
 
+        public override func using(session: URLSession) -> Self {
+            self.form.urlSession = session
+            return self
+        }
+
         public override func subscribe(
             onSuccess: ((D) -> Void)? = nil,
             onFailure: ((Swift.Error) -> Void)? = nil,

diff --git a/Sources/Restler/Public/Classes/Request/OptionalDecodableRequest.swift b/Sources/Restler/Public/Classes/Request/OptionalDecodableRequest.swift
@@ -3,6 +3,7 @@ import Foundation
 extension Restler {
     public final class OptionalDecodableRequest<D: Decodable>: Request<D?>, RestlerRequestInternal {
         internal let dependencies: Restler.RequestDependencies
+        internal var form: Restler.RequestForm = .init()
 
         private var successCompletionHandler: ((D?) -> Void)?
         private var failureCompletionHandler: ((Swift.Error) -> Void)?
@@ -36,6 +37,11 @@ extension Restler {
             self.buildNetworkingRequest()
         }
 
+        public override func using(session: URLSession) -> Self {
+            self.form.urlSession = session
+            return self
+        }
+
         public override func subscribe(
             onSuccess: ((D?) -> Void)? = nil,
             onFailure: ((Swift.Error) -> Void)? = nil,

diff --git a/Sources/Restler/Public/Classes/Request/Request.swift b/Sources/Restler/Public/Classes/Request/Request.swift
@@ -66,6 +66,17 @@ extension Restler {
             return nil
         }
 
+        /// Sets the request to use the provided `URLSession` instead of the default one.
+        ///
+        /// - Parameters:
+        ///   - session: A `URLSession` that will perform the built task. If not set, `shared` will be used.
+        ///
+        /// - Returns: `self` for chaining.
+        ///
+        open func using(session: URLSession) -> Self {
+            return self
+        }
+
         /// Runs networking task with specified handlers at its completion.
         ///
         /// - Parameters:

diff --git a/Sources/Restler/Public/Classes/Request/VoidRequest.swift b/Sources/Restler/Public/Classes/Request/VoidRequest.swift
@@ -3,6 +3,7 @@ import Foundation
 extension Restler {
     public final class VoidRequest: Request<Void>, RestlerRequestInternal {
         internal let dependencies: Restler.RequestDependencies
+        internal var form: Restler.RequestForm = .init()
 
         private var successCompletionHandler: ((SuccessfulResponseObject) -> Void)?
         private var failureCompletionHandler: ((Swift.Error) -> Void)?
@@ -35,6 +36,11 @@ extension Restler {
             self.buildNetworkingRequest()
         }
 
+        public override func using(session: URLSession) -> Self {
+            self.form.urlSession = session
+            return self
+        }
+
         public override func subscribe(
             onSuccess: ((SuccessfulResponseObject) -> Void)? = nil,
             onFailure: ((Swift.Error) -> Void)? = nil,

diff --git a/Sources/Restler/Public/Protocols/Request/RestlerRequest.swift b/Sources/Restler/Public/Protocols/Request/RestlerRequest.swift
@@ -15,6 +15,8 @@ public protocol RestlerRequest: class {
     @available(*, deprecated, message: "Use `subscribe(onSuccess:onFailure:onCompletion:)`")
     func start() -> RestlerTaskType?
 
+    func using(session: URLSession) -> Self
+
     @discardableResult
     func subscribe(
         onSuccess: ((_ object: SuccessfulResponseObject) -> Void)?,

diff --git a/Sources/RxRestler/Request+Rx.swift b/Sources/RxRestler/Request+Rx.swift
@@ -3,7 +3,6 @@ import RxSwift
 import Restler
 
 extension Restler.Request {
-    // swiftlint:disable:next identifier_name
     public var rx: Single<D> {
         Single<D>.create { single in
             let task = self.subscribe(

diff --git a/Tests/RestlerTests/Mocks/NetworkingMock.swift b/Tests/RestlerTests/Mocks/NetworkingMock.swift
@@ -11,6 +11,8 @@ final class NetworkingMock {
     private(set) var makeRequestParams: [MakeRequestParams] = []
     struct MakeRequestParams {
         let urlRequest: URLRequest
+        let urlSession: URLSessionType?
+        let eventLogger: EventLoggerLogging
         let completion: DataCompletion
     }
 
@@ -33,11 +35,14 @@ final class NetworkingMock {
 extension NetworkingMock: NetworkingType {
     func makeRequest(
         urlRequest: URLRequest,
+        urlSession: URLSessionType?,
         eventLogger: EventLoggerLogging,
         completion: @escaping DataCompletion
     ) -> Restler.Task {
         self.makeRequestParams.append(MakeRequestParams(
             urlRequest: urlRequest,
+            urlSession: urlSession,
+            eventLogger: eventLogger,
             completion: completion))
         return self.makeRequestReturnValue
     }

diff --git a/Tests/RestlerTests/Tests/Integration/GetInterfaceIntegrationTests.swift b/Tests/RestlerTests/Tests/Integration/GetInterfaceIntegrationTests.swift
@@ -97,7 +97,8 @@ extension GetInterfaceIntegrationTests {
         let sut = self.buildSUT()
         let header = ["id": "1", "name": "name", "double": "1.23"]
         // Act
-        let request = sut.get(self.endpoint)
+        let request = sut
+            .get(self.endpoint)
             .query(header)
             .urlRequest()
         // Assert
@@ -128,6 +129,25 @@ extension GetInterfaceIntegrationTests {
             .deprecatedStart()
         // Assert
         XCTAssertEqual(self.networking.makeRequestParams.count, 1)
+        XCTAssertNil(try XCTUnwrap(self.networking.makeRequestParams.last).urlSession)
+        XCTAssertEqual(self.networking.buildRequestParams.count, 1)
+        XCTAssertNil(completionResult)
+    }
+
+    func testGetVoid_withCustomSession_buildsRequest() throws {
+        // Arrange
+        let sut = self.buildSUT()
+        let session = URLSession()
+        var completionResult: Restler.VoidResult?
+        // Act
+        sut.get(self.endpoint)
+            .decode(Void.self)
+            .using(session: session)
+            .deprecatedOnCompletion({ completionResult = $0 })
+            .deprecatedStart()
+        // Assert
+        XCTAssertEqual(self.networking.makeRequestParams.count, 1)
+        XCTAssertEqual(self.networking.makeRequestParams.last?.urlSession as? URLSession, session)
         XCTAssertEqual(self.networking.buildRequestParams.count, 1)
         XCTAssertNil(completionResult)
     }
@@ -333,6 +353,25 @@ extension GetInterfaceIntegrationTests {
             .deprecatedStart()
         // Assert
         XCTAssertEqual(self.networking.makeRequestParams.count, 1)
+        XCTAssertNil(try XCTUnwrap(self.networking.makeRequestParams.last).urlSession)
+        XCTAssertEqual(self.networking.buildRequestParams.count, 1)
+        XCTAssertNil(completionResult)
+    }
+
+    func testGetOptionalDecodable_withCustomSession_buildsRequest() throws {
+        // Arrange
+        let sut = self.buildSUT()
+        let session = URLSession()
+        var completionResult: Restler.DecodableResult<SomeObject?>?
+        // Act
+        sut.get(self.endpoint)
+            .decode(SomeObject?.self)
+            .using(session: session)
+            .deprecatedOnCompletion({ completionResult = $0 })
+            .deprecatedStart()
+        // Assert
+        XCTAssertEqual(self.networking.makeRequestParams.count, 1)
+        XCTAssertEqual(self.networking.makeRequestParams.last?.urlSession as? URLSession, session)
         XCTAssertEqual(self.networking.buildRequestParams.count, 1)
         XCTAssertNil(completionResult)
     }
@@ -546,6 +585,25 @@ extension GetInterfaceIntegrationTests {
             .deprecatedStart()
         // Assert
         XCTAssertEqual(self.networking.makeRequestParams.count, 1)
+        XCTAssertNil(try XCTUnwrap(self.networking.makeRequestParams.last).urlSession)
+        XCTAssertEqual(self.networking.buildRequestParams.count, 1)
+        XCTAssertNil(completionResult)
+    }
+
+    func testGetDecodable_withCustomSession_buildsRequest() throws {
+        // Arrange
+        let sut = self.buildSUT()
+        let session = URLSession()
+        var completionResult: Restler.DecodableResult<SomeObject>?
+        // Act
+        sut.get(self.endpoint)
+            .decode(SomeObject.self)
+            .using(session: session)
+            .deprecatedOnCompletion({ completionResult = $0 })
+            .deprecatedStart()
+        // Assert
+        XCTAssertEqual(self.networking.makeRequestParams.count, 1)
+        XCTAssertEqual(self.networking.makeRequestParams.last?.urlSession as? URLSession, session)
         XCTAssertEqual(self.networking.buildRequestParams.count, 1)
         XCTAssertNil(completionResult)
     }

diff --git a/Tests/RestlerTests/Tests/Unit/NetworkingTests.swift b/Tests/RestlerTests/Tests/Unit/NetworkingTests.swift
@@ -26,7 +26,7 @@ extension NetworkingTests {
         let urlRequest = URLRequest(url: url)
         var completionResult: DataResult?
         // Act
-        let task = sut.makeRequest(urlRequest: urlRequest, eventLogger: eventLogger) { result in
+        let task = sut.makeRequest(urlRequest: urlRequest, urlSession: nil, eventLogger: eventLogger) { result in
             completionResult = result
         }
         // Assert
@@ -38,6 +38,27 @@ extension NetworkingTests {
         XCTAssertNotNil(task)
     }
 
+    func testMakeRequest_providedCustomSession_makesProperRequest() throws {
+        // Arrange
+        let sut = self.buildSUT()
+        let url = try XCTUnwrap(URL(string: "https://www.example.com"))
+        let urlRequest = URLRequest(url: url)
+        let session = URLSessionMock()
+        var completionResult: DataResult?
+        // Act
+        let task = sut.makeRequest(urlRequest: urlRequest, urlSession: session, eventLogger: eventLogger) { result in
+            completionResult = result
+        }
+        // Assert
+        XCTAssertEqual(self.session.dataTaskParams.count, 0)
+        XCTAssertEqual(session.dataTaskParams.count, 1)
+        let request = try XCTUnwrap(session.dataTaskParams.last?.request)
+        XCTAssertEqual(urlRequest, request)
+        XCTAssertNil(completionResult)
+        XCTAssertEqual(session.dataTaskReturnValue.resumeParams.count, 1)
+        XCTAssertNotNil(task)
+    }
+
     func testMakeRequest_successfulResponse() throws {
         // Arrange
         let sut = self.buildSUT()
@@ -49,7 +70,7 @@ extension NetworkingTests {
         let response = HTTPRequestResponse(data: responseData, response: mockResponse, error: nil)
         var completionResult: DataResult?
         // Act
-        _ = sut.makeRequest(urlRequest: urlRequest, eventLogger: eventLogger) { result in
+        _ = sut.makeRequest(urlRequest: urlRequest, urlSession: nil, eventLogger: eventLogger) { result in
             completionResult = result
         }
         try XCTUnwrap(self.session.dataTaskParams.last).completion(response)
@@ -65,7 +86,7 @@ extension NetworkingTests {
         let response = HTTPRequestResponse(data: Data(), response: nil, error: nil)
         var completionResult: DataResult?
         // Act
-        _ = sut.makeRequest(urlRequest: urlRequest, eventLogger: eventLogger) { result in
+        _ = sut.makeRequest(urlRequest: urlRequest, urlSession: nil, eventLogger: eventLogger) { result in
             completionResult = result
         }
         try XCTUnwrap(self.session.dataTaskParams.last).completion(response)
@@ -85,7 +106,7 @@ extension NetworkingTests {
         let response = HTTPRequestResponse(data: Data(), response: mockResponse, error: nil)
         var completionResult: DataResult?
         // Act
-        _ = sut.makeRequest(urlRequest: urlRequest, eventLogger: eventLogger) { result in
+        _ = sut.makeRequest(urlRequest: urlRequest, urlSession: nil, eventLogger: eventLogger) { result in
             completionResult = result
         }
         try XCTUnwrap(self.session.dataTaskParams.last).completion(response)
@@ -105,7 +126,7 @@ extension NetworkingTests {
         let response = HTTPRequestResponse(data: Data(), response: mockResponse, error: TestError())
         var completionResult: DataResult?
         // Act
-        _ = sut.makeRequest(urlRequest: urlRequest, eventLogger: eventLogger) { result in
+        _ = sut.makeRequest(urlRequest: urlRequest, urlSession: nil, eventLogger: eventLogger) { result in
             completionResult = result
         }
         try XCTUnwrap(self.session.dataTaskParams.last).completion(response)
@@ -124,7 +145,7 @@ extension NetworkingTests {
         let response = HTTPRequestResponse(data: nil, response: mockResponse, error: nil)
         var completionResult: DataResult?
         // Act
-        _ = sut.makeRequest(urlRequest: urlRequest, eventLogger: eventLogger) { result in
+        _ = sut.makeRequest(urlRequest: urlRequest, urlSession: nil, eventLogger: eventLogger) { result in
             completionResult = result
         }
         try XCTUnwrap(self.session.dataTaskParams.last).completion(response)
@@ -143,7 +164,7 @@ extension NetworkingTests {
         let response = HTTPRequestResponse(data: nil, response: mockResponse, error: returnedError)
         var completionResult: DataResult?
         // Act
-        _ = sut.makeRequest(urlRequest: urlRequest, eventLogger: eventLogger) { result in
+        _ = sut.makeRequest(urlRequest: urlRequest, urlSession: nil, eventLogger: eventLogger) { result in
             completionResult = result
         }
         try XCTUnwrap(self.session.dataTaskParams.last).completion(response)
@@ -161,7 +182,7 @@ extension NetworkingTests {
         let response = HTTPRequestResponse(data: nil, response: nil, error: returnedError)
         var completionResult: DataResult?
         // Act
-        _ = sut.makeRequest(urlRequest: urlRequest, eventLogger: eventLogger) { result in
+        _ = sut.makeRequest(urlRequest: urlRequest, urlSession: nil, eventLogger: eventLogger) { result in
             completionResult = result
         }
         try XCTUnwrap(self.session.dataTaskParams.last).completion(response)