kotlinx.coroutines.runBlocking & awaitSingle deadlock issue

[jun108059]

✍🏻 Description

1. Spring Webflux + coroutine runBlocking + webClient + awaitSingle 사용시 timeout이 발생하는 이슈가 발생
2. webClient + awaitSingle을 사용하지 않으면 timeout이 발생하지 않음

데드락 발생 가능성

• kotlinx.coroutines.runBlocking 블록에서 호출한 메서드가 awaitSingle로 묶인 코루틴인 경우 발생할 수 있는 문제
• WebFlux가 사용하는 이벤트 루프 스레드가 블로킹되면, 해당 스레드에서 처리해야 하는 다른 작업들이 모두 대기 상태에 빠져 데드락이 발생할 수 있음
  • WebFlux는 기본적으로 Netty나 Undertow와 같은 논블로킹 서버를 사용
  • 이벤트 루프 모델에서는 한정된 수의 스레드로 많은 요청을 처리할 수 있음

runBlocking은 현재 쓰레드를 블로킹하고, 이벤트 루프의 스레드를 차단
이로 인해, 이벤트 루프 스레드가 블로킹되면 다른 요청을 처리할 수 없게 되어 성능 저하와 데드락이 발생할 수 있음

[jun108059]

Sample code

Controller

    @GetMapping("/api/reststop/foods")
    fun getRestBestFoods() = runBlocking {
        val allRestBestFoods = restBestFoodService.fetchAllPages()
        allRestBestFoods.forEach { response ->
            response.list.forEach { restBestFood ->
                println(restBestFood)
            }
        }
        allRestBestFoods
    }

Linked method

    suspend fun fetchReststopFood(pageNo: Int): ReststopFoodResponse {
        return webClient.get()
            .uri { builder ->
                builder.path("/openapi/restinfo/restBestfoodList")
                    .queryParam("key", "secret")
                    .queryParam("type", "json")
                    .queryParam("numOfRows", "99")
                    .queryParam("pageNo", pageNo)
                    .build()
            }
            .retrieve()
            .bodyToMono(ReststopFoodResponse::class.java)
            .awaitSingle()
    }