Skip to content

Fix cancelled delayed jobs not being disposed of in TestDispatcher #3441

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 8, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion kotlinx-coroutines-test/common/src/TestDispatcher.kt
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,14 @@ public abstract class TestDispatcher internal constructor() : CoroutineDispatche
/** @suppress */
override fun scheduleResumeAfterDelay(timeMillis: Long, continuation: CancellableContinuation<Unit>) {
val timedRunnable = CancellableContinuationRunnable(continuation, this)
scheduler.registerEvent(this, timeMillis, timedRunnable, continuation.context, ::cancellableRunnableIsCancelled)
val handle = scheduler.registerEvent(
this,
timeMillis,
timedRunnable,
continuation.context,
::cancellableRunnableIsCancelled
)
continuation.invokeOnCancellation { handle.dispose() }
}

/** @suppress */
Expand Down
28 changes: 28 additions & 0 deletions kotlinx-coroutines-test/jvm/test/MemoryLeakTest.kt
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
/*
* Copyright 2016-2022 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/
import kotlinx.coroutines.*
import kotlinx.coroutines.test.*
import java.lang.ref.*
import kotlin.test.*

class MemoryLeakTest {

@Test
fun testCancellationLeakInTestCoroutineScheduler() = runTest {
lateinit var weakRef: WeakReference<*>
val job = launch(start = CoroutineStart.UNDISPATCHED) {
val leakingObject = Any()
weakRef = WeakReference(leakingObject)
delay(3)
// This code is needed to hold a reference to `leakingObject` until the job itself is weakly reachable.
leakingObject.hashCode()
}
job.cancel()
System.gc()
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

System.gc() is not the most reliable tool.

We have deterministic tests on that matter, see FieldWalker usages.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Convenient!

assertNotNull(weakRef.get()) // the cancellation handler has not run yet
runCurrent()
System.gc()
assertNull(weakRef.get()) // the cancellation handler has run, disposing of the job
}
}