swiftのsemaphoreを使うと、完了ハンドラ内の処理が実行されなくなる

Question

お世話になっております。
seiftでMoyaを利用したhttp通信の結果を返すために、semaphoreを使い、非同期処理を同期的に処理するようなプログラムを実装しています。
しかし、ApiClientのrequestメソッドの完了ハンドラに書いてある処理が実行されません。
semaphoreを無くしたら動いたので、おそらくsemaphoreの使用方法がまずいのだと思いますが、どのように改善していけばいいでしょうか

試したこと

この記事に同じような問題の解決策が載っていましたが、これを参考にコードを変更してもうまく動きませんでした。

    func isLogin() -> Bool {
        var isLogin = false
        let semaphore = DispatchSemaphore(value: 0)
        DispatchQueue.global(qos: .default).async {
            ApiClient.shared.request(CheckTokenTargetType()) { result in
                switch result {
                case .success(_):
                    isLogin = true

                default:
                    break
                }
                semaphore.signal()
            }
        }
        semaphore.wait()
        return isLogin
    }

class ApiClient: ApiClientInterface {
    private init() {}

    static let shared = ApiClient()

    func request<T>(_ request: T, completion: @escaping (Result<T.Response, MoyaResponseError>) -> Void) where T: ApiTargetType {
        let provider = MoyaProvider<T>()
        provider.request(request) { result in
            switch result {
            case let .success(response):
                if let model = try? response.map(T.Response.self) {
                    completion(.success(model))
                } else {
                        completion(.failure(.unknownError))
                    }

            case let .failure(moyaError):
                completion(.failure(moyaError))
            }
        }
    }
}

Comments

[hoshi-takanori]

非同期処理は非同期処理として処理すべきだと思います。

[oeiqgfodgfhps]

非同期処理で処理すると非同期処理の結果を戻り値として返せないと思うのですが、、、
非同期処理でもその結果を呼び出し元の関数が戻り値を返す前に返す方法などありますか？？

[hoshi-takanori]

非同期処理は、例えば Web API なら、ネットワークを通してサーバーにリクエストを送って、サーバー上で何か処理をして、結果が返ってくるわけで、どうしても時間がかかりますし、どのくらい時間がかかるかもわからない (サーバーの障害で返事が返らない可能性もあります) わけで、同期的に処理するということは、その間スレッドを停止して結果を待つことになります。特に、メインスレッドの場合はその間 GUI を止めて待つことになりますから、ユーザーから見るとアプリが固まったように見えてしまいます。

非同期処理というのは、リクエストを出したらすぐに制御を戻して、結果が返るまで例えばローディング中の表示にして待ち、結果が返ってきたらクロージャが呼ばれるのでそこで処理するという形になります。

[oeiqgfodgfhps]

アドバイスありがとうございます！
そのように実装していこうと思います。
一つ疑問なのですが、なぜ自分が投稿したコードでは非同期の部分が呼ばれないのでしょうか？？

[hoshi-takanori]

ApiClient.shared.request(CheckTokenTargetType()) { result in 〜 }
は、API リクエストを送信したらすぐに戻って semaphore.wait() します。そして、API の結果が返った時に { result in 〜 } の部分が実行されるはずですが、Moya のデフォルトの設定ではどうやらメインスレッドで実行することになってるようなので、isLogin メソッドの終了後に実行されるようにスケジュールされますが、isLogin メソッドは semaphore.wait() で止まってるために semaphore.signal() は実行されず、デッドロックすると思います。

[oeiqgfodgfhps]

ということはMoyaのリクエストの処理をバックグラウンドスレッドで行うようにすればsemaphore.signal()は実行されるという認識でよかったですか？

[hoshi-takanori]

そうですね。バックグラウンドスレッドで UI 操作などをしなければ大丈夫だと思います。

[oeiqgfodgfhps]

ありがとうございます！！
バックグラウンドスレッドで実行するようにコードを変更してみました（コードを編集しました）が、状況は変化しませんでした。。
何かおかしなところはありますでしょうか？？

Answer 1

Moya はデフォルトでは completion クロージャをメインスレッドで呼び出すようなので、semaphore がデッドロックしてしまいます。これを防ぐには、ApiClient.shared.request ではなく、completion クロージャをバックグラウンドスレッドで呼び出すように Moya にお願いする必要があります。
参考: Support Synchronous requests for SPM CLI tools · Issue #1562 · Moya/Moya

-        provider.request(request) { result in
+        provider.request(request, callbackQueue: .global(qos: .default)) { result in

とはいえ、API の返事をメインスレッドで待つと GUI が固まってしまうので、ちゃんと非同期処理で書くことをお勧めします。

Comments

[oeiqgfodgfhps]

ありがとうございます！
一点質問させてください。
Moya はデフォルトでは completion クロージャをメインスレッドで呼び出すというのは、リクエスト自体はバックグラウンドスレッドで行うが、完了ハンドラはメインスレッドという認識をしています。
なので、semaphoreでメインスレッドを止めている場合でも、リクエスト自体はバックグラウンドスレッドなので行われるが、完了ハンドラはメインスレッドだからデッドロックしてしまうという認識であっていますか？？

[hoshi-takanori]

いえ、リクエストはメインスレッドのままで構いません。リクエストの送信が完了してから semaphore.wait() してますので。

[oeiqgfodgfhps]

承知しました！