SwiftでWebSocketイベント発火によるAPIコールについて

Question

現在、チャットクライアントをSwiftで作っています。チャット相手のクライアントはJavascriptで実装済みです。

サーバー側は、Python(Django)で作っていて、クライアントからAPI経由で各種のリクエストを処理しています。
Swift側はAlamofireとSwiftyJSONでAPIを叩いています。

これまでは、すべてのAPIリクエストが正常に処理されていたのですが、チャット実装にともなって、相手から
チャットが更新されたイベントを受け取ったときに、更新されたチャット内容をロードするためにAPIを叩こうと
すると、処理が永久ループにハマってしまい、抜け出すことができずにいます。

こちらがチャットをロードするコードになります。

func reloadChatData() {
    let jsonData = loadChat(_registration_id: RData.getRegistrationId())

    if(jsonData["status"].string! == "success") {
        for chat in jsonData["chat"].arrayValue {
            if (chat["chat_from"] == "D") {
                let chat = ChatEntity(text: chat["chat"].string!, time: "", userType: .You)
                chats.append(chat)
            }
            else {
                let chat = ChatEntity(text: chat["chat"].string!, time: "", userType: .I)
                chats.append(chat)
            }
        }
    }
    tableView.reloadData()

}

func loadChat(_registration_id: String) -> JSON {
    let _commonURL = CommmonURL()
    var _load_chat_url = _commonURL.SERVER_HOSTNAME + _commonURL.LOAD_CHAT_ENTRY_POINT

    _load_chat_url = addParameter(url: _load_chat_url, named: "registration_id", value: _registration_id)
    let response = runQuery(_load_chat_url)
    let data: Data? = String(describing: response.rawValue).data(using: .utf8)
    let responseJson = JSON(data!) as JSON
    return responseJson
}

private func runQuery(_ _url: String) -> JSON {
    var responseData: JSON = JSON.null
    let urlString = _url
    var keepAlive = true

    Alamofire.request(urlString, method: .get, parameters: nil, encoding: JSONEncoding.default).responseJSON(completionHandler: { response in
        responseData = JSON(response.result.value!)
        keepAlive = false
        print("**")  // ********** When I call runQuery from websocket event listener function, the code don't reach this line.   **********
    })

    print(keepAlive)
    let runLoop = RunLoop.current
    while keepAlive &&
        runLoop.run(mode: RunLoopMode.defaultRunLoopMode, before: Date(timeIntervalSinceNow: 0.1)) {
    }

    return responseData
}

上記のreloadChatData()をViewControllerの任意の場所（WebSocketのイベント待受以外の場所）から実行すると、正常にチャットデータが返ってきます。
しかし、下記のコードからreloadChatData()を呼び出すと、runQuery()のkeepAliveがFalseにならずに永久ループにハマってしまいます。
サーバーのログでは、正常にクライアントにレスポンスを返しています。

override func viewDidLoad() {

    manager = SocketManager(socketURL: URL(string: SocketURL)!, config: [.log(true), .compress])
    socketIOClient = manager.defaultSocket

    socketIOClient.on(clientEvent: .connect) {data, ack in
        print(data)

        // Connect Event is fired...
        let data : Dictionary<String, String> = ["value": RData.getRegistrationId()]
        self.socketIOClient.emit("join_room", data)
        print("socket connected")
    }

    socketIOClient.on(clientEvent: .error) { (data, eck) in
        print(data)
        print("socket error")
    }

    socketIOClient.on(clientEvent: .disconnect) { (data, eck) in
        print(data)
        print("socket disconnect")
    }

    socketIOClient.on(clientEvent: SocketClientEvent.reconnect) { (data, eck) in
        print(data)
        print("socket reconnect")
    }

    socketIOClient.on("server_to_client") { data, emitter in
        print("Get Message from Another Client...")

        // ********** FAILED **********
        self.reloadChatData()
    }

    socketIOClient.connect()

}

相手（Javascriptクライアント）からチャットを送ると、Xcodeのコンソールには、
print("Get Message from Another Client...")
が出力されます。

WebSocketでデータを受信したときだけの問題なので、なんらかreloadChatData()関数を呼び出す方法に問題があると思うのですが、解決の糸口がつかめません。

どのように実装すればよいのかアドバイスをいただけないでしょうか？
よろしくお願いします。

Answer 1

WebSocket（というか、Socket.IO）の接続に使用されているのは、こちらのライブラリですね？

https://github.com/socketio/socket.io-client-swift

でしたら、クライアントのイベントコールバックはメインスレッドではなく、クライアント内部で用意されたスレッド上で呼び出されていたはずです。（しばらく触っていないので、もしかしたら仕様に変更があったかもしれません）

そうすると、ご質問のコードのrunQuery内で呼んでいる RunLoop.current は、メインスレッド以外のスレッドに対するRunLoopを返すことになります。それに対し、Alamofireの完了時コールバックはメインスレッドで呼ばれるので、RunLoop.currentを使っていくら待機させても処理が完了しないわけです。

一番簡単な解決方法は、メインスレッドでreloadChatDataを呼ぶようにしてあげることです。

socketIOClient.on("server_to_client") { [weak self] data, emitter in
    print("Get Message from Another Client...")
    
    // メインスレッドで実行
    DispatchQueue.main.async { [weak self] in
        self?.reloadChatData()
    }
}

ただ、通信処理をメインスレッドで待機させるコードは処理を止めることになってしまいそもそもあまり好ましくないので、待機させずコールバック内で処理をしていくように設計を見直した方がよいかと思います。

Comments

[kazzzstudio]

アドバイス、ありがとうございます！

ご教示いただいたコードを試してみました。
おそらくこのあたりの問題ではないかと思うのですが、まだループから抜け出せずにいます。

止まっているループ側で、
let runLoop = RunLoop.current
を
let runLoop = RunLoop.main
に変えてみても動きませんでした。

[kakajika]

うーん、なるほど。。Alamofireの方もGCDのmain queueに完了時の処理を投げてると思うので、main queue内で待機処理をしてしまうとキューが詰まって完了時の処理が呼ばれなくなってしまうのかもしれません。

代替案として、DispatchQueue.main.asyncの代わりにperformSelectorOnMainThreadを使ってみてはどうでしょうか？

self?.performSelector(onMainThread: #selector(reloadChatData) ...)

もっとも、RunLoopで同期待ち合わせっぽい処理をするのは本来の使い方ではなく挙動が保証されるものでもないので、使わない方向に変えていただくのがよさそうです。

Answer 2

解決しました。

Alamofireの呼び出し方法を変えたら、動作するようになりました。

    private func runQuery(_ _url: String) -> JSON {
        var responseData: JSON = JSON.null
        let urlString = _url
        var keepAlive = true

        let queue = DispatchQueue(label: "com.xxxxxxxx", qos: .background, attributes: .concurrent)

        Alamofire.request(urlString, method: .get, parameters: nil, encoding: JSONEncoding.default).responseJSON(queue: queue) { response in
            responseData = JSON(response.result.value!)
            keepAlive = false
        }

        let runLoop = RunLoop.current
        while keepAlive &&
            runLoop.run(mode: RunLoopMode.defaultRunLoopMode, before: Date(timeIntervalSinceNow: 0.1)) {
        }

        return responseData
    }

ご教示いただきまして、ありがとうございました。