Kotlin/kotlinx.coroutines

CoroutinesTimeout non-coroutines jobs dump

Open

#1,543 opened on Sep 17, 2019

View on GitHub
 (4 comments) (0 reactions) (1 assignee)Kotlin (1,927 forks)batch import
debugenhancementhelp wanted

Repository metrics

Stars
 (13,749 stars)
PR merge metrics
 (Avg merge 130d 3h) (4 merged PRs in 30d)

Description

It would be convenient to see non-coroutines incomplete Job instances in coroutines dumps as well. It will improve structured jobs analysis in the case when a Job (or CompletableDeferred) prevents a parent from completion.

The following example test hangs because of a job and a completable deferred, but the coroutines dump doesn't provide enough information, so it's not that easy to backtrace the reason.

class DumpTest {
    @get:Rule
    val timeout: CoroutinesTimeout = CoroutinesTimeout.seconds(1)

    private val parent = Job()

    @BeforeTest
    fun start() {
        Job(parent)
        CompletableDeferred<Unit>(parent)
    }

    @Test
    fun test(): Unit = runBlocking(CoroutineName("blocking")) {
        parent.complete()
        parent.join()
    }
}

Contributor guide

Research direction
Investigate the coroutines dump mechanism in kotlinx.coroutines and extend it to include non coroutines Job and CompletableDeferred instances. Focus on the CoroutinesTimeout and the DumpTest example to understand the current behavior and identify where to add the missing Job information.
Tech stack
kotlin
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
KotlinCoroutines
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40