-
Notifications
You must be signed in to change notification settings - Fork 1.9k
/
Copy pathCoroutinesDumpTest.kt
183 lines (162 loc) · 8.4 KB
/
CoroutinesDumpTest.kt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
/*
* Copyright 2016-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/
package kotlinx.coroutines.debug
import kotlinx.coroutines.*
import org.junit.Test
import kotlin.coroutines.*
import kotlin.test.*
class CoroutinesDumpTest : DebugTestBase() {
private val monitor = Any()
private var coroutineThread: Thread? = null // guarded by monitor
@Test
fun testSuspendedCoroutine() = runBlocking {
val deferred = async(Dispatchers.Default) {
sleepingOuterMethod()
}
awaitCoroutine()
val found = DebugProbes.dumpCoroutinesInfo().single { it.job === deferred }
verifyDump(
"Coroutine \"coroutine#1\":DeferredCoroutine{Active}@1e4a7dd4, state: SUSPENDED\n" +
"\tat kotlinx.coroutines.debug.CoroutinesDumpTest.sleepingNestedMethod(CoroutinesDumpTest.kt:95)\n" +
"\tat kotlinx.coroutines.debug.CoroutinesDumpTest.sleepingOuterMethod(CoroutinesDumpTest.kt:88)\n" +
"\t(Coroutine creation stacktrace)\n" +
"\tat kotlin.coroutines.intrinsics.IntrinsicsKt__IntrinsicsJvmKt.createCoroutineUnintercepted(IntrinsicsJvm.kt:116)\n" +
"\tat kotlinx.coroutines.intrinsics.CancellableKt.startCoroutineCancellable(Cancellable.kt:23)\n" +
"\tat kotlinx.coroutines.CoroutineStart.invoke(CoroutineStart.kt:99)\n",
ignoredCoroutine = "BlockingCoroutine"
) {
deferred.cancel()
coroutineThread!!.interrupt()
}
assertSame(deferred, found.job)
}
@Test
fun testRunningCoroutine() = runBlocking {
val deferred = async(Dispatchers.IO) {
activeMethod(shouldSuspend = false)
assertTrue(true)
}
awaitCoroutine()
verifyDump(
"Coroutine \"coroutine#1\":DeferredCoroutine{Active}@227d9994, state: RUNNING\n" +
"\tat java.lang.Thread.sleep(Native Method)\n" +
"\tat kotlinx.coroutines.debug.CoroutinesDumpTest.nestedActiveMethod(CoroutinesDumpTest.kt:141)\n" +
"\tat kotlinx.coroutines.debug.CoroutinesDumpTest.activeMethod(CoroutinesDumpTest.kt:133)\n" +
"\tat kotlinx.coroutines.debug.CoroutinesDumpTest\$testRunningCoroutine\$1$deferred\$1.invokeSuspend(CoroutinesDumpTest.kt:41)\n" +
"\t(Coroutine creation stacktrace)\n" +
"\tat kotlin.coroutines.intrinsics.IntrinsicsKt__IntrinsicsJvmKt.createCoroutineUnintercepted(IntrinsicsJvm.kt:116)\n" +
"\tat kotlinx.coroutines.intrinsics.CancellableKt.startCoroutineCancellable(Cancellable.kt:23)\n" +
"\tat kotlinx.coroutines.CoroutineStart.invoke(CoroutineStart.kt:99)\n" +
"\tat kotlinx.coroutines.AbstractCoroutine.start(AbstractCoroutine.kt:148)\n" +
"\tat kotlinx.coroutines.BuildersKt__Builders_commonKt.async(Builders.common.kt)\n" +
"\tat kotlinx.coroutines.BuildersKt.async(Unknown Source)\n" +
"\tat kotlinx.coroutines.BuildersKt__Builders_commonKt.async\$default(Builders.common.kt)\n" +
"\tat kotlinx.coroutines.BuildersKt.async\$default(Unknown Source)\n" +
"\tat kotlinx.coroutines.debug.CoroutinesDumpTest.testRunningCoroutine(CoroutinesDumpTest.kt:49)",
ignoredCoroutine = "BlockingCoroutine"
) {
deferred.cancel()
coroutineThread?.interrupt()
}
}
@Test
fun testRunningCoroutineWithSuspensionPoint() = runBlocking {
val deferred = async(Dispatchers.IO) {
activeMethod(shouldSuspend = true)
yield() // tail-call
}
awaitCoroutine()
verifyDump(
"Coroutine \"coroutine#1\":DeferredCoroutine{Active}@1e4a7dd4, state: RUNNING\n" +
"\tat java.lang.Thread.sleep(Native Method)\n" +
"\tat kotlinx.coroutines.debug.CoroutinesDumpTest.nestedActiveMethod(CoroutinesDumpTest.kt:111)\n" +
"\tat kotlinx.coroutines.debug.CoroutinesDumpTest.activeMethod(CoroutinesDumpTest.kt:106)\n" +
"\t(Coroutine creation stacktrace)\n" +
"\tat kotlin.coroutines.intrinsics.IntrinsicsKt__IntrinsicsJvmKt.createCoroutineUnintercepted(IntrinsicsJvm.kt:116)\n" +
"\tat kotlinx.coroutines.intrinsics.CancellableKt.startCoroutineCancellable(Cancellable.kt:23)\n" +
"\tat kotlinx.coroutines.CoroutineStart.invoke(CoroutineStart.kt:99)\n" +
"\tat kotlinx.coroutines.AbstractCoroutine.start(AbstractCoroutine.kt:148)\n" +
"\tat kotlinx.coroutines.BuildersKt__Builders_commonKt.async(Builders.common.kt)\n" +
"\tat kotlinx.coroutines.BuildersKt.async(Unknown Source)\n" +
"\tat kotlinx.coroutines.BuildersKt__Builders_commonKt.async\$default(Builders.common.kt)\n" +
"\tat kotlinx.coroutines.BuildersKt.async\$default(Unknown Source)\n" +
"\tat kotlinx.coroutines.debug.CoroutinesDumpTest.testRunningCoroutineWithSuspensionPoint(CoroutinesDumpTest.kt:71)",
ignoredCoroutine = "BlockingCoroutine"
) {
deferred.cancel()
coroutineThread!!.interrupt()
}
}
@Test
fun testCreationStackTrace() = runBlocking {
val deferred = async(Dispatchers.IO) {
activeMethod(shouldSuspend = true)
}
awaitCoroutine()
val coroutine = DebugProbes.dumpCoroutinesInfo().first { it.job is Deferred<*> }
val result = coroutine.creationStackTrace.fold(StringBuilder()) { acc, element ->
acc.append(element.toString())
acc.append('\n')
}.toString().trimStackTrace()
deferred.cancel()
coroutineThread!!.interrupt()
val expected =
("kotlin.coroutines.intrinsics.IntrinsicsKt__IntrinsicsJvmKt.createCoroutineUnintercepted(IntrinsicsJvm.kt:116)\n" +
"kotlinx.coroutines.intrinsics.CancellableKt.startCoroutineCancellable(Cancellable.kt:23)\n" +
"kotlinx.coroutines.CoroutineStart.invoke(CoroutineStart.kt:109)\n" +
"kotlinx.coroutines.AbstractCoroutine.start(AbstractCoroutine.kt:160)\n" +
"kotlinx.coroutines.BuildersKt__Builders_commonKt.async(Builders.common.kt:88)\n" +
"kotlinx.coroutines.BuildersKt.async(Unknown Source)\n" +
"kotlinx.coroutines.BuildersKt__Builders_commonKt.async\$default(Builders.common.kt:81)\n" +
"kotlinx.coroutines.BuildersKt.async\$default(Unknown Source)\n" +
"kotlinx.coroutines.debug.CoroutinesDumpTest\$testCreationStackTrace\$1.invokeSuspend(CoroutinesDumpTest.kt)").trimStackTrace()
assertTrue(result.startsWith(expected))
}
@Test
fun testFinishedCoroutineRemoved() = runBlocking {
val deferred = async(Dispatchers.IO) {
activeMethod(shouldSuspend = true)
}
awaitCoroutine()
deferred.cancel()
coroutineThread!!.interrupt()
deferred.join()
verifyDump(ignoredCoroutine = "BlockingCoroutine")
}
private suspend fun activeMethod(shouldSuspend: Boolean) {
nestedActiveMethod(shouldSuspend)
assertTrue(true) // tail-call
}
private suspend fun nestedActiveMethod(shouldSuspend: Boolean) {
if (shouldSuspend) yield()
notifyCoroutineStarted()
while (coroutineContext[Job]!!.isActive) {
try {
Thread.sleep(60_000)
} catch (_ : InterruptedException) {
}
}
}
private suspend fun sleepingOuterMethod() {
sleepingNestedMethod()
yield() // TCE
}
private suspend fun sleepingNestedMethod() {
yield() // Suspension point
notifyCoroutineStarted()
delay(Long.MAX_VALUE)
}
private fun awaitCoroutine() = synchronized(monitor) {
while (coroutineThread == null) (monitor as Object).wait()
while (coroutineThread!!.state != Thread.State.TIMED_WAITING) {
// Wait until thread sleeps to have a consistent stacktrace
}
}
private fun notifyCoroutineStarted() {
synchronized(monitor) {
coroutineThread = Thread.currentThread()
(monitor as Object).notifyAll()
}
}
}