Merge pull request #18 from yumemi-inc/feature/concurrency

Swift ConcurrencyのAsync課題を追加

Author: Elvis Shi

Documentation/Concurrency.md

@@ -0,0 +1,11 @@
+# コンカレンシー
+
+iOS 15以降のSwiftランタイムはコンカレンシー（並行演算）をサポートし、またXcode 13.2以降ではこの機能をiOS 13までバックデプロイしました。
+コンカレンシーを使うと、これまでのようにスレッドをブロックすることなく、あたかも同期的に処理が書けますが、内部的にはきちんと非同期に動きます。
+例えば`URLSession`の[`data(from:delegate:)`](https://developer.apple.com/documentation/foundation/urlsession/3767353-data)などがこの機能を利用しています。
+
+非同期処理にも関わらず、スレッドをブロックせずに同期的のようにコードが書けるので、コールバックを用いる方法よりも遥かに書きやすくなるでしょう。
+
+## 課題
+- Delegateで受け取っていたAPIの結果を、コンカレンシー形式で受け取るように変更する
+- ViewControllerを閉じた時に`deinit`が呼ばれることを確認する

Documentation/YumemiWeather.md

@@ -99,11 +99,11 @@ Json文字列
 
 ---
 
-## Async ver
+## Callback ver
 天気予報を取得するAPIです。  
-非同期に処理します。  
+非同期に処理し、結果をコンプリーションハンドラーに渡します。  
 ```swift
-static func asyncFetchWeather(_ jsonString: String, completion: @escaping (Result<String, YumemiWeatherError>) -> Void)
+static func callbackFetchWeather(_ jsonString: String, completion: @escaping (Result<String, YumemiWeatherError>) -> Void)
 ```
 
 ### Parameters
@@ -124,11 +124,40 @@ Void
 
 ---
 
+## Async ver
+天気予報を取得するAPIです。  
+非同期に処理します。  
+```swift
+static func asyncFetchWeather(_ jsonString: String) async throws -> String
+```
+
+### Parameters
+#### jsonString
+Json文字列
+|Key|型|フォーマット|例|
+|:--|:--|:--|:--|
+|area|String|自由|tokyo|
+|data|String|yyyy-MM-dd'T'HH:mm:ssZZZZZ|2020-04-01T12:00:00+09:00|
+
+### Throws
+YumemiWeatherError型
+
+### Returns
+Json文字列
+|Key|型|フォーマット|例|
+|:--|:--|:--|:--|
+|weather|String|sunny or cloudy or rainy|sunny|
+|maxTemp|Int|--|20|
+|minTemp|Int|--|-20|
+|date|String|yyyy-MM-dd'T'HH:mm:ssZZZZZ|2020-04-01T12:00:00+09:00|
+
+---
+
 ## Error type
 YumemiWeatherError
 ```swift
 public enum YumemiWeatherError: Swift.Error {
     case invalidParameterError
     case unknownError
 }
-```
+```

README.md

@@ -51,7 +51,8 @@ Session1がレビュー待ちの場合...
 - [Session9](Documentation/ThreadBlock.md)
 - [Session10](Documentation/Delegate.md)
 - [Session11](Documentation/Closure.md)
-- [Session12](Documentation/BugFix.md)
+- [Session12](Documentation/Concurrency.md)
+- [Session13](Documentation/BugFix.md)
 
 **(注1)**  
 このようなケースで `rebase` コマンドを使うことが必ずしも正しいとは限りません。  

Sources/YumemiWeather/YumemiWeather.swift

@@ -127,7 +127,7 @@ final public class YumemiWeather {
         return try self.fetchWeather(jsonString)
     }
 
-    /// 擬似 天気予報API Async ver
+    /// 擬似 天気予報API Callback ver
     /// - Parameters:
     ///   - jsonString: 地域と日付を含むJson文字列
     /// example:
@@ -136,7 +136,7 @@ final public class YumemiWeather {
     ///   "date": "2020-04-01T12:00:00+09:00"
     /// }
     ///   - completion: 完了コールバック
-    public static func asyncFetchWeather(_ jsonString: String, completion: @escaping (Result<String, YumemiWeatherError>) -> Void) {
+    public static func callbackFetchWeather(_ jsonString: String, completion: @escaping (Result<String, YumemiWeatherError>) -> Void) {
         DispatchQueue.global().asyncAfter(deadline: .now() + apiDuration) {
             do {
                 let response = try fetchWeather(jsonString)
@@ -150,4 +150,22 @@ final public class YumemiWeather {
             }
         }
     }
+    
+    /// 擬似 天気予報API Async ver
+    /// - Parameter jsonString: 地域と日付を含むJson文字列
+    /// example:
+    /// {
+    ///   "area": "tokyo",
+    ///   "date": "2020-04-01T12:00:00+09:00"
+    /// }
+    /// - Throws: YumemiWeatherError パラメータが正常でもランダムにエラーが発生する
+    /// - Returns: Json文字列
+    @available(iOS 13, macOS 10.15, *)
+    public static func asyncFetchWeather(_ jsonString: String) async throws -> String {
+        return try await withCheckedThrowingContinuation { continuation in
+            callbackFetchWeather(jsonString) { result in
+                continuation.resume(with: result)
+            }
+        }
+    }
 }

Tests/LinuxMain.swift

@@ -3,5 +3,8 @@ import XCTest
 import YumemiWeatherTests
 
 var tests = [XCTestCaseEntry]()
-tests += YumemiWeatherTests.allTests()
+tests += YumemiWeatherTests.allNonConcurrentTests()
+if #available(iOS 13, macOS 10.15) {
+    tests += YumemiWeatherTests.allConcurrentTests
+}
 XCTMain(tests)

Tests/YumemiWeatherTests/XCTestManifests.swift

@@ -1,9 +1,14 @@
 import XCTest
 
 #if !canImport(ObjectiveC)
-public func allTests() -> [XCTestCaseEntry] {
+public func allNonConcurrentTests() -> [XCTestCaseEntry] {
     return [
-        testCase(YumemiWeatherTests.allTests),
+        testCase(YumemiWeatherTests.allNonConcurrentTests),
+    ]
+}
+public func allConcurrentTests() -> [XCTestCaseEntry] {
+    return [
+        testCase(YumemiWeatherTests.allConcurrentTests),
     ]
 }
 #endif

Tests/YumemiWeatherTests/YumemiWeatherTests.swift

@@ -72,15 +72,15 @@ final class YumemiWeatherTests: XCTestCase {
         XCTAssertGreaterThanOrEqual(Date().timeIntervalSince(beginDate), YumemiWeather.apiDuration)
     }
 
-    func test_fetchWeather_jsonString_async() {
+    func test_fetchWeather_jsonString_callback() {
         let parameter = """
 {
     "area": "tokyo",
     "date": "2020-04-01T12:00:00+09:00"
 }
 """
         let exp = expectation(description: #function)
-        YumemiWeather.asyncFetchWeather(parameter) { result in
+        YumemiWeather.callbackFetchWeather(parameter) { result in
             exp.fulfill()
             switch result {
             case .success(let jsonString):
@@ -97,11 +97,44 @@ final class YumemiWeatherTests: XCTestCase {
         self.wait(for: [exp], timeout: YumemiWeather.apiDuration + 0.1)
     }
 
-    static var allTests = [
+    @available(iOS 13, macOS 10.15, *)
+    func test_fetchWeather_jsonString_async() async {
+        let beginDate = Date()
+        let parameter = """
+{
+    "area": "tokyo",
+    "date": "2020-04-01T12:00:00+09:00"
+}
+"""
+        do {
+            let responseJson = try await YumemiWeather.asyncFetchWeather(parameter)
+            let dateFormatter = DateFormatter()
+            dateFormatter.dateFormat = "yyyy-MM-dd'T'HH:mm:ssZZZZZ"
+            let decoder = JSONDecoder()
+            decoder.keyDecodingStrategy = .convertFromSnakeCase
+            decoder.dateDecodingStrategy = .formatted(dateFormatter)
+            _ = try decoder.decode(Response.self, from: Data(responseJson.utf8))
+        }
+        catch let error as YumemiWeatherError {
+            XCTAssertEqual(error, YumemiWeatherError.unknownError)
+        }
+        catch {
+            XCTFail()
+        }
+        
+        XCTAssertGreaterThanOrEqual(Date().timeIntervalSince(beginDate), YumemiWeather.apiDuration)
+    }
+    
+    static var allNonConcurrentTests = [
         ("test_fetchWeather", test_fetchWeather),
         ("test_fetchWeather_at", test_fetchWeather_at),
         ("test_fetchWeather_jsonString", test_fetchWeather_jsonString),
         ("test_fetchWeather_jsonString_sync", test_fetchWeather_jsonString_sync),
+        ("test_fetchWeather_jsonString_callback", test_fetchWeather_jsonString_callback),
+    ]
+    
+    @available(iOS 13, macOS 10.15, *)
+    static var allConcurrentTests = [
         ("test_fetchWeather_jsonString_async", test_fetchWeather_jsonString_async),
     ]
 }