Add a scope for launching background work in tests #3348

dkhalanskyjb · 2022-06-27T12:15:31Z

kotlinx-coroutines-test/common/test/TestScopeTest.kt

dkhalanskyjb · 2022-06-27T13:51:03Z

Reported the compiler bug here: https://youtrack.jetbrains.com/issue/KT-52985/Native-a-function-with-type-T-returned-a-kotlinUnit-instead-of-null

kotlinx-coroutines-test/common/src/TestCoroutineScheduler.kt

kotlinx-coroutines-test/common/src/TestScope.kt

kotlinx-coroutines-test/common/test/TestScopeTest.kt

The bug was that the test would time out if every non-background coroutine was waiting for something from the background ones.

kotlinx-coroutines-test/common/src/TestScope.kt

kotlinx-coroutines-test/common/src/TestBuilders.kt

qwwdfsad · 2022-07-08T15:39:34Z

kotlinx-coroutines-test/common/src/TestBuilders.kt

+                    completed = true
+                }
+                scheduler.onDispatchEvent {
+                    // we received knowledge that `scheduler` observed a dispatch event, so we reset the timeout


also worth noting that it doesn't receive events from background jobs

kotlinx-coroutines-test/common/src/internal/ReportingSupervisorJob.kt

kotlinx-coroutines-test/common/src/TestScope.kt

qwwdfsad · 2022-07-08T15:50:03Z

kotlinx-coroutines-test/common/src/TestScope.kt

+    // Only call this in a `synchronized(lock)` block.
+    @Suppress("INVISIBLE_MEMBER")
+    private fun collectUncaughtExceptions(): List<Throwable> {
+        val exceptions = LinkedHashSet(uncaughtExceptions)


In JobSupport we use an identity hash set to workaround throwables that throw exceptions from their hashCode/equals.
I don't think it's worth fixing here, but it's definitely worth to file an issue here and I'll escalate it to MPP stdlib

qwwdfsad

In general looks good

kotlinx-coroutines-test/common/src/TestBuilders.kt

kotlinx-coroutines-test/common/src/internal/ReportingSupervisorJob.kt

kotlinx-coroutines-test/common/src/TestScope.kt

Fixes Kotlin#3287

…to baxter/upstream-flow-timeout * origin/baxter/upstream-flow-timeout: (328 commits) Commit API dump Cleanup API, update knit Fix typo in runTest method docs (Kotlin#3417) Update coroutines-and-channels.md (Kotlin#3410) chore: update the website's release step (Kotlin#3397) ktl-695 chore: support Dokka HTML customization (Kotlin#3388) update: KT-50122 adding kotlinx.dependencies Improve bump-version.sh (Kotlin#3365) Fix documentation for `DEBUG_PROPERTY_VALUE_OFF` (Kotlin#3389) feat: moving coroutines hands-on to docs (Kotlin#3369) Version 1.6.4 Improve CoroutineDispatcher documentation (Kotlin#3359) Update binary compatibility validator to 0.11.0 (Kotlin#3362) Add a scope for launching background work in tests (Kotlin#3348) Fix debug module publication with shadow plugin (Kotlin#3357) Comply with Subscriber rule 2.7 in the `await*` impl (Kotlin#3360) Update readme (Kotlin#3343) Reduce reachable references of disposed invokeOnTimeout handle (Kotlin#3353) breakleg; knit validation fix Additional comment in CoroutineScheduler ... # Conflicts: # README.md

WIP

9bc3335

dkhalanskyjb commented Jun 27, 2022

View reviewed changes

kotlinx-coroutines-test/common/test/TestScopeTest.kt Outdated Show resolved Hide resolved

dkhalanskyjb requested a review from qwwdfsad June 27, 2022 12:17

Fix crashing on Native

4e35d15

dkhalanskyjb marked this pull request as ready for review June 27, 2022 13:32

qwwdfsad requested changes Jun 28, 2022

View reviewed changes

dkhalanskyjb added 4 commits July 5, 2022 17:16

Add some tests, fix a bug

6fa024c

The bug was that the test would time out if every non-background coroutine was waiting for something from the background ones.

backgroundWorkScope -> backgroundScope

cefc6b9

Improve the backgroundScope documentation

bffa53a

Catch more of the errors

1865848

dkhalanskyjb requested a review from qwwdfsad July 7, 2022 13:56

whyoleg reviewed Jul 7, 2022

View reviewed changes

kotlinx-coroutines-test/common/src/TestScope.kt Show resolved Hide resolved

Fix the API dump

6329202