Merge pull request #23 from uhooi/feature/support_swift_concurrency

uhooi · web-flow · commit 28a1dfdab58d · 2021-12-19T13:48:49.000+09:00
Support Swift Concurrency
diff --git a/.github/workflows/ci-examples.yml b/.github/workflows/ci-examples.yml
@@ -7,7 +7,7 @@ on:
     branches: [ main ]
 
 env:
-  DEVELOPER_DIR: /Applications/Xcode_13.0.app
+  DEVELOPER_DIR: /Applications/Xcode_13.2.app
 
 jobs:
   build:
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -16,7 +16,7 @@ jobs:
     runs-on: macos-11
     strategy:
       matrix:
-        xcode: ["12.5.1", "13.0"]
+        xcode: ["13.2"]
         subcommand: ["Build", "Test"]
     steps:
     - uses: actions/checkout@v2
@@ -36,7 +36,7 @@ jobs:
     container: swift:${{ matrix.swift }}
     strategy:
       matrix:
-        swift: ["5.4.2", "5.5.0"]
+        swift: ["5.5.2"]
     steps:
     - uses: actions/checkout@v2
     - name: Build and Test
diff --git a/Examples/Example/APIClient/JSONPlaceholderAPIClient.swift b/Examples/Example/APIClient/JSONPlaceholderAPIClient.swift
@@ -7,6 +7,12 @@ final class JSONPlaceholderAPIClient {
 }
 
 extension JSONPlaceholderAPIClient: JSONPlaceholderRepository {
+    // Swift Concurrency
+    func fetchAllUser() async throws -> [User] {
+        return try await httpClient.request(FetchAllUserRequest())
+    }
+    
+    // Completion handler
     func fetchAllUser(_ completion: @escaping (Result<[User], Error>) -> Void) {
         httpClient.request(FetchAllUserRequest()) { result in
             completion(result)
diff --git a/Examples/Example/Repositories/JSONPlaceholderRepository.swift b/Examples/Example/Repositories/JSONPlaceholderRepository.swift
@@ -1,4 +1,8 @@
 protocol JSONPlaceholderRepository {
+    // Swift Concurrency
+    func fetchAllUser() async throws -> [User]
+    
+    // Completion handler
     func fetchAllUser(_ completion: @escaping (Result<[User], Error>) -> Void)
 }
 
diff --git a/Examples/Example/Views/ViewController.swift b/Examples/Example/Views/ViewController.swift
@@ -13,13 +13,24 @@ final class ViewController: UIViewController {
     override func viewDidLoad() {
         super.viewDidLoad()
         
+        // Swift Concurrency
+        Task {
+            do {
+                self.users = try await repository.fetchAllUser()
+                print("Swift Concurrency:", users)
+            } catch {
+                print("Swift Concurrency:", error)
+            }
+        }
+
+        // Completion handler
         repository.fetchAllUser { result in
             switch result {
             case let .success(users):
                 self.users = users
-                print(users)
+                print("Completion handler:", users)
             case let .failure(error):
-                print(error)
+                print("Completion handler:", error)
             }
         }
     }
diff --git a/Examples/Makefile b/Examples/Makefile
@@ -6,7 +6,7 @@ TEST_SDK := iphonesimulator
 TEST_CONFIGURATION := Debug
 TEST_PLATFORM := iOS Simulator
 TEST_DEVICE ?= iPhone 13 Pro Max
-TEST_OS ?= 15.0
+TEST_OS ?= 15.2
 TEST_DESTINATION := 'platform=${TEST_PLATFORM},name=${TEST_DEVICE},OS=${TEST_OS}'
 
 .PHONY: build-debug
diff --git a/Package.swift b/Package.swift
@@ -1,14 +1,14 @@
-// swift-tools-version:5.3
+// swift-tools-version:5.5
 
 import PackageDescription
 
 let package = Package(
     name: "HTTPClient",
     platforms: [
-        .iOS(.v9),
-        .macOS(.v10_10),
-        .tvOS(.v9),
-        .watchOS(.v2),
+        .iOS(.v13),
+        .macOS(.v10_15),
+        .tvOS(.v13),
+        .watchOS(.v6),
     ],
     products: [
         .library(
diff --git a/README.md b/README.md
@@ -13,11 +13,16 @@ Communicate via HTTP easily in Swift.
 
 ## Table of Contents
 
+- [Requirement](#Requirement)
 - [Installation](#installation)
 - [How to use](#how-to-use)
 - [Contribution](#contribution)
 - [Stats](#stats)
 
+## Requirement
+
+- Xcode 13.2+ (Swift 5.5.2+)
+
 ## Installation
 
 ### Swift Package Manager (Recommended)
@@ -108,7 +113,7 @@ You can just import `HTTPClient` to use it.
 
     ```swift
     protocol VersatileRepository {
-        func registerUser(name: String, description: String, completion: @escaping (Result<UserID, Error>) -> Void)
+        func registerUser(name: String, description: String) async throws -> UserID
     }
     ```
 
@@ -122,28 +127,21 @@ You can just import `HTTPClient` to use it.
     }
     
     extension VersatileAPIClient: VersatileRepository {
-        func registerUser(name: String, description: String, completion: @escaping (Result<UserID, Error>) -> Void) {
+        func registerUser(name: String, description: String) async throws -> UserID {
             let requestBody = RegisterUserRequestBody(name: name, description: description)
-            httpClient.request(RegisterUserRequest(), requestBody: requestBody) { result in
-                switch result {
-                case let .success(responseBody):
-                    completion(.success(responseBody.convertToUserID()))
-                case let .failure(error):
-                    completion(.failure(error))
-                }
-            }
+            let responseBody = try await httpClient.request(RegisterUserRequest(), requestBody: requestBody)
+            return responseBody.convertToUserID()
         }
     }
     ```
 
     ```swift
-    VersatileAPIClient.shared.registerUser(name: "Uhooi", description: "Green monster.") { result in
-        switch result {
-        case let .success(userID):
-            // Do something.
-        case let .failure(error):
-            // Do error handling.
-        }
+    do {
+        let userID = try await VersatileAPIClient.shared.registerUser(name: "Uhooi", description: "Green monster.")
+        // Do something.
+    } catch {
+        // Do error handling.
+        print(error)
     }
     ```
 
diff --git a/Sources/HTTPClient/Extensions/Foundation/URLSession+Async.swift b/Sources/HTTPClient/Extensions/Foundation/URLSession+Async.swift
@@ -0,0 +1,24 @@
+import Foundation
+#if canImport(FoundationNetworking)
+import FoundationNetworking
+#endif
+
+@available(iOS, introduced: 13.0, deprecated: 15.0, message: "Use the built-in API instead")
+extension URLSession {
+
+    func data(from request: URLRequest) async throws -> (Data, URLResponse) {
+        try await withCheckedThrowingContinuation { continuation in
+            self.dataTask(with: request) { data, response, error in
+                if let error = error {
+                    return continuation.resume(throwing: error)
+                }
+                guard let data = data, let response = response else {
+                    return continuation.resume(throwing: URLError(.badServerResponse))
+                }
+                continuation.resume(returning: (data, response))
+            }.resume()
+        }
+    }
+
+}
+
diff --git a/Sources/HTTPClient/HTTPClient.swift b/Sources/HTTPClient/HTTPClient.swift
@@ -20,21 +20,46 @@ public final class HTTPClient {
     
     // MARK: Other Public Methods
     
+    /// Send an HTTP request.
+    /// - Parameters:
+    ///   - requestContents: Request contents.
+    /// - Returns: Response body.
+    /// - SeeAlso: ``request(_:requestBody:)``
+    public func request<T: Request>(_ requestContents: T) async throws -> T.ResponseBody {
+        let request = try createRequest(requestContents)
+        return try await self.request(requestContents, request: request)
+    }
+
+    /// Send an HTTP request.
+    /// - Parameters:
+    ///   - requestContents: Request contents.
+    ///   - requestBody: Request body.
+    /// - Returns: Response body.
+    /// - SeeAlso: ``request(_:)``
+    public func request<T: Request, U: Encodable>(_ requestContents: T, requestBody: U) async throws -> T.ResponseBody {
+        var request: URLRequest
+        request = try createRequest(requestContents)
+        request.httpBody = try JSONEncoder().encode(requestBody)
+        return try await self.request(requestContents, request: request)
+    }
+    
     /// Send an HTTP request.
     /// - Parameters:
     ///   - requestContents: Request contents.
     ///   - completion: Completion handler.
     /// - SeeAlso: ``request(_:requestBody:completion:)``
+    @available(iOS, deprecated: 13.0, message: "Consider using asynchronous alternative function")
+    @available(macOS, deprecated: 10.15, message: "Consider using asynchronous alternative function")
+    @available(tvOS, deprecated: 13.0, message: "Consider using asynchronous alternative function")
+    @available(watchOS, deprecated: 6.0, message: "Consider using asynchronous alternative function")
     public func request<T: Request>(_ requestContents: T, completion: @escaping (Result<T.ResponseBody, Error>) -> Void) {
-        let request: URLRequest
         do {
-            request = try createRequest(requestContents)
-        } catch let error {
+            let request = try createRequest(requestContents)
+            self.request(requestContents, request: request, completion: completion)
+        } catch {
             completion(.failure(error))
             return
         }
-        
-        self.request(requestContents, request: request, completion: completion)
     }
     
     /// Send an HTTP request.
@@ -43,17 +68,20 @@ public final class HTTPClient {
     ///   - requestBody: Request body.
     ///   - completion: Completion handler.
     /// - SeeAlso: ``request(_:completion:)``
+    @available(iOS, deprecated: 13.0, message: "Consider using asynchronous alternative function")
+    @available(macOS, deprecated: 10.15, message: "Consider using asynchronous alternative function")
+    @available(tvOS, deprecated: 13.0, message: "Consider using asynchronous alternative function")
+    @available(watchOS, deprecated: 6.0, message: "Consider using asynchronous alternative function")
     public func request<T: Request, U: Encodable>(_ requestContents: T, requestBody: U, completion: @escaping (Result<T.ResponseBody, Error>) -> Void) {
-        var request: URLRequest
         do {
+            var request: URLRequest
             request = try createRequest(requestContents)
             request.httpBody = try JSONEncoder().encode(requestBody)
-        } catch let error {
+            self.request(requestContents, request: request, completion: completion)
+        } catch {
             completion(.failure(error))
             return
         }
-        
-        self.request(requestContents, request: request, completion: completion)
     }
     
     // MARK: Other Private Methods
@@ -80,6 +108,16 @@ public final class HTTPClient {
         return request
     }
     
+    private func request<T: Request>(_ requestContents: T, request: URLRequest) async throws -> T.ResponseBody {
+        let (data, response) = try await URLSession.shared.data(from: request)
+        if let requestError = validateResponse(response) {
+            throw requestError
+        }
+        let jsonDecoder = JSONDecoder()
+        jsonDecoder.keyDecodingStrategy = .convertFromSnakeCase
+        return try jsonDecoder.decode(T.ResponseBody.self, from: data)
+    }
+    
     private func request<T: Request>(_ requestContents: T, request: URLRequest, completion: @escaping (Result<T.ResponseBody, Error>) -> Void) {
         URLSession.shared.dataTask(with: request) { data, response, error in
             if let error = error {
@@ -100,7 +138,7 @@ public final class HTTPClient {
                 let responseBody = try jsonDecoder.decode(T.ResponseBody.self, from: data)
                 completion(.success(responseBody))
                 return
-            } catch let error {
+            } catch {
                 completion(.failure(error))
                 return
             }
diff --git a/Tests/HTTPClientTests/HTTPClientTests.swift b/Tests/HTTPClientTests/HTTPClientTests.swift
@@ -7,8 +7,4 @@ final class HTTPClientTests: XCTestCase {
         // Use XCTAssert and related functions to verify your tests produce the correct
         // results.
     }
-
-    static var allTests = [
-        ("testExample", testExample),
-    ]
 }
diff --git a/Tests/HTTPClientTests/XCTestManifests.swift b/Tests/HTTPClientTests/XCTestManifests.swift
diff --git a/Tests/LinuxMain.swift b/Tests/LinuxMain.swift
diff --git a/UHIHTTPClient.podspec b/UHIHTTPClient.podspec
@@ -8,11 +8,11 @@ Pod::Spec.new do |spec|
   spec.social_media_url = 'https://twitter.com/the_uhooi'
   spec.source           = { :git => 'https://github.com/uhooi/swift-http-client.git', :tag => spec.version.to_s }
   spec.source_files     = 'Sources/**/*.swift'
-  spec.swift_versions   = ['5.1', '5.2', '5.3', '5.4']
+  spec.swift_versions   = ['5.5.2']
   spec.framework        = 'Foundation'
 
-  spec.ios.deployment_target     = '9.0'
-  spec.osx.deployment_target     = '10.10'
-  spec.tvos.deployment_target    = '9.0'
-  spec.watchos.deployment_target = '2.0'
+  spec.ios.deployment_target     = '13.0'
+  spec.osx.deployment_target     = '10.15'
+  spec.tvos.deployment_target    = '13.0'
+  spec.watchos.deployment_target = '6.0'
 end

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,8 @@`
`1`	`1`	`protocol JSONPlaceholderRepository {`
	`2`	`+ // Swift Concurrency`
	`3`	`+ func fetchAllUser() async throws -> [User]`
	`4`	`+`
	`5`	`+ // Completion handler`
`2`	`6`	`func fetchAllUser(_ completion: @escaping (Result<[User], Error>) -> Void)`
`3`	`7`	`}`
`4`	`8`