"An error occurred while pushing a context" error occurs when using RequestContextHooks.enable()

Application using RequestContextHooks.enable() for log tracking, and if many requests come in at the same time, An error occurred while pushing a context error occurs.

In the service, it occurs in the action of querying with r2dbc jooq. I’m not sure sample code below is the same cause, but the same error occurs.

version info

kotlin 1.7.20
armeria-logback : 1.20.1
armeria-reactor3: 1.20.1
kotlinx-coroutines-core-jvm: 1.6.4
kotlinx-coroutines-reactive: 1.6.4
kotlinx-coroutines-reactor: 1.6.4

Error log

Caused by: java.lang.IllegalStateException: Trying to call object wrapped with context [sreqId=8d41eecd, chanId=96523267, raddr=127.0.0.1:57795, laddr=127.0.0.1:8080][h1c://gimnamjung-ui-macbookpro.local/v1/players/test/%ED%95%9C%EB%8F%99%EA%B7%B8%EB%9D%BC%EB%AF%B8#GET], but context is currently set to [sreqId=673c702e, chanId=7a3518ba, raddr=127.0.0.1:57796, laddr=127.0.0.1:8080][h1c://gimnamjung-ui-macbookpro.local/v1/players/test/%ED%95%9C%EB%8F%99%EA%B7%B8%EB%9D%BC%EB%AF%B8#GET]. This means the callback was called from unexpected thread or forgetting to close previous context.

Sample Code

// TestAnnotatedService
@Get("/test")
suspend fun test(): Long? {
        return testService.test()
}

// TestService
private val mutex = Mutex() // kotlinx.coroutines.sync

suspend fun test(): Long? {
        return mutex.withLock {
            Mono.just(1L)
                .awaitSingle()
        }
}

[minwoox]

I found one possible workaround. It’s using ArmeriaRequestCoroutinContext explicitly with GlobalScope.async:

@Service
class TestService {
    private val mutex = Mutex()

    suspend fun runWithMutex(): String {
        val requestContext = ServiceRequestContext.current()
        return GlobalScope.async(ArmeriaRequestCoroutineContext(requestContext)) {
            mutex.withLock {
                Mono.just("test").awaitSingle()
            }
        }.await()
    }
}

[minwoox]

Sorry about the late response. 😓

kotlin coroutine doesn’t guarantee that the block executes on the same thread.

Yes, exactly. When there’re two concurrent requests A and B, the thread for A also runs the block for the request B which then:

• the Mono is created with the aContext by the hook
• the Mono raises an exception when it subscribed with the bContext.

I guess not using the RequestContextHooks and push the context manually where it needs is the best way we can do for now. 😢 I’m thinking of adding a global hook that is removing the RequestContext in thread-local and pushing it back when the continuation is resumed but I’m not sure if it’s really possible. Let me get back to this issue when I find the solution. 🙇