Introduce newSingleThreadDispatcher

Author: qwwdfsad

kotlinx-coroutines-core/common/test/flow/FlowInvariantsTest.kt

@@ -235,7 +235,7 @@ class FlowInvariantsTest : TestBase() {
             }
             expectUnreached()
         } catch (e: IllegalStateException) {
-            assertTrue(e.message!!.contains("Flow invariant is violated"))
+            assertTrue(e.message!!.contains("Flow invariant is violated"), "But had: ${e.message}")
             finish(2)
         }
     }

kotlinx-coroutines-core/concurrent/src/SingleThread.common.kt

@@ -0,0 +1,20 @@
+/*
+ * Copyright 2016-2021 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+package kotlinx.coroutines
+
+@ExperimentalCoroutinesApi
+public expect fun newSingleThreadContext(name: String): SingleThreadDispatcher
+
+/**
+ * A coroutine dispatcher that is confined to a single thread.
+ */
+@ExperimentalCoroutinesApi
+public expect abstract class SingleThreadDispatcher : CoroutineDispatcher {
+
+    /**
+     * Closes this coroutine dispatcher and shuts down its thread.
+     */
+    public abstract fun close()
+}

kotlinx-coroutines-core/concurrent/test/AbstractDispatcherConcurrencyTest.kt

@@ -0,0 +1,54 @@
+package kotlinx.coroutines
+
+import kotlinx.coroutines.channels.*
+import kotlin.test.*
+
+/*
+ * Copyright 2016-2021 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+abstract class AbstractDispatcherConcurrencyTest : TestBase() {
+
+   public abstract val dispatcher: CoroutineDispatcher
+
+    @Test
+    fun testLaunchAndJoin() {
+        expect(1)
+        var capturedMutableState = 0
+        val job = GlobalScope.launch(dispatcher) {
+            ++capturedMutableState
+            expect(2)
+        }
+        runBlocking { job.join() }
+        assertEquals(1, capturedMutableState)
+        finish(3)
+    }
+
+    @Test
+    fun testDispatcherIsActuallyMultithreaded() {
+        val channel = Channel<Int>()
+        GlobalScope.launch(dispatcher) {
+            channel.send(42)
+        }
+
+        var result = ChannelResult.failure<Int>()
+        while (!result.isSuccess) {
+            result = channel.tryReceive()
+            // Block the thread, wait
+        }
+        // Delivery was successful, let's check it
+        assertEquals(42, result.getOrThrow())
+    }
+
+    @Test
+    fun testDelayInDefaultDispatcher() {
+        expect(1)
+        val job = GlobalScope.launch(dispatcher) {
+            expect(2)
+            delay(100)
+            expect(3)
+        }
+        runBlocking { job.join() }
+        finish(4)
+    }
+}

kotlinx-coroutines-core/concurrent/test/DefaultDispatcherConcurrencyTest.kt

@@ -1,53 +1,9 @@
 package kotlinx.coroutines
 
-import kotlinx.coroutines.channels.*
-import kotlin.test.*
-
 /*
  * Copyright 2016-2021 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
  */
 
-class DefaultDispatcherConcurrencyTest : TestBase() {
-
-    @Test
-    fun testLaunchAndJoin() {
-        expect(1)
-        var capturedMutableState = 0
-        val job = GlobalScope.launch {
-            ++capturedMutableState
-            expect(2)
-        }
-        runBlocking { job.join() }
-        assertEquals(1, capturedMutableState)
-        finish(3)
-    }
-
-    @Test
-    fun testDefaultDispatcherIsActuallyMultithreaded() {
-        val channel = Channel<Int>()
-        GlobalScope.launch {
-            channel.send(42)
-        }
-
-        var result = ChannelResult.failure<Int>()
-        while (!result.isSuccess) {
-            result = channel.tryReceive()
-            // Block the thread, wait
-        }
-        // Delivery was successful, let's check it
-        assertEquals(42, result.getOrThrow())
-    }
-
-    @Test
-    fun testDelayInDefaultDispatcher() {
-        expect(1)
-        val job = GlobalScope.launch {
-            expect(2)
-            delay(100)
-            println("Actually resumed")
-            expect(3)
-        }
-        runBlocking { job.join() }
-        finish(4)
-    }
+class DefaultDispatcherConcurrencyTest : AbstractDispatcherConcurrencyTest() {
+    override val dispatcher: CoroutineDispatcher = Dispatchers.Default
 }

kotlinx-coroutines-core/concurrent/test/SingleThreadDispatcherConcurrencyTest.kt

@@ -0,0 +1,14 @@
+package kotlinx.coroutines
+
+import kotlin.test.*
+
+/*
+ * Copyright 2016-2021 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+class SingleThreadDispatcherConcurrencyTest : AbstractDispatcherConcurrencyTest() {
+    override val dispatcher: CoroutineDispatcher = newSingleThreadContext("SingleThreadDispatcherConcurrencyTest")
+
+    @AfterTest
+    fun shutDown() = (dispatcher as SingleThreadDispatcher).close()
+}

kotlinx-coroutines-core/js/src/EventLoop.kt

@@ -20,7 +20,6 @@ internal actual abstract class EventLoopImplPlatform : EventLoop() {
 }
 
 internal actual object DefaultExecutor {
-    public actual fun enqueue(task: Runnable): Unit = unsupported()
 }
 
 private fun unsupported(): Nothing =

kotlinx-coroutines-core/jvm/src/ThreadPoolDispatcher.kt

@@ -30,9 +30,14 @@ import java.util.concurrent.atomic.AtomicInteger
  * @param name the base name of the created thread.
  */
 @ObsoleteCoroutinesApi
-public fun newSingleThreadContext(name: String): ExecutorCoroutineDispatcher =
+public actual fun newSingleThreadContext(name: String): ExecutorCoroutineDispatcher =
     newFixedThreadPoolContext(1, name)
 
+/**
+ * A coroutine dispatcher that is confined to a single thread.
+ */
+public actual typealias SingleThreadDispatcher = ExecutorCoroutineDispatcher
+
 /**
  * Creates a coroutine execution context with the fixed-size thread-pool and built-in [yield] support.
  * **NOTE: The resulting [ExecutorCoroutineDispatcher] owns native resources (its threads).

kotlinx-coroutines-core/native/src/CoroutineContext.kt

@@ -11,24 +11,16 @@ import kotlin.native.concurrent.*
 
 internal actual object DefaultExecutor : CoroutineDispatcher(), Delay {
 
-    private val worker = Worker.start(name = "Dispatchers.Default")
+    private val delegate = SingleThreadDispatcherImpl(name = "Dispatchers.Default")
 
     override fun dispatch(context: CoroutineContext, block: Runnable) =
-        worker.executeAfter(0L) { block.run() }
+        delegate.dispatch(context, block)
 
-    override fun scheduleResumeAfterDelay(timeMillis: Long, continuation: CancellableContinuation<Unit>) {
-        // TODO proper toMicros
-        worker.executeAfter(timeMillis * 1000)
-        { with(continuation) { resumeUndispatched(Unit) } }
-    }
+    override fun scheduleResumeAfterDelay(timeMillis: Long, continuation: CancellableContinuation<Unit>) = delegate.scheduleResumeAfterDelay(timeMillis, continuation)
 
-    override fun invokeOnTimeout(timeMillis: Long, block: Runnable, context: CoroutineContext): DisposableHandle {
-        // No API to cancel on timeout
-        worker.executeAfter(timeMillis * 1000) { block.run() }
-        return NonDisposableHandle
-    }
+    override fun invokeOnTimeout(timeMillis: Long, block: Runnable, context: CoroutineContext): DisposableHandle = delegate.invokeOnTimeout(timeMillis, block, context)
 
-    actual fun enqueue(task: Runnable): Unit = worker.executeAfter(0L) { task.run() }
+    actual fun enqueue(task: Runnable): Unit = delegate.dispatch(EmptyCoroutineContext, task)
 }
 
 internal fun loopWasShutDown(): Nothing = error("Cannot execute task because event loop was shut down")

kotlinx-coroutines-core/native/src/EventLoop.kt

@@ -18,7 +18,7 @@ internal actual abstract class EventLoopImplPlatform : EventLoop() {
         current.execute(TransferMode.SAFE, {}) {} // send an empty task to unpark the waiting event loop
     }
 
-    // TODO verify loop was shut down is an okay behaviour
+    // TODO actually reschedule
     protected actual fun reschedule(now: Long, delayedTask: EventLoopImplBase.DelayedTask): Unit =
         loopWasShutDown()
 }

kotlinx-coroutines-core/native/src/SingleThread.kt

@@ -0,0 +1,42 @@
+/*
+ * Copyright 2016-2021 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
+ */
+
+package kotlinx.coroutines
+
+import kotlin.coroutines.*
+import kotlin.native.concurrent.*
+
+@ExperimentalCoroutinesApi
+public actual fun newSingleThreadContext(name: String): SingleThreadDispatcher = SingleThreadDispatcherImpl(name)
+
+/**
+ * A coroutine dispatcher that is confined to a single thread.
+ */
+@ExperimentalCoroutinesApi
+public actual abstract class SingleThreadDispatcher : CoroutineDispatcher() {
+    public actual abstract fun close()
+}
+
+internal class SingleThreadDispatcherImpl(name: String) : SingleThreadDispatcher(), Delay {
+    private val worker = Worker.start(name = name)
+
+    override fun dispatch(context: CoroutineContext, block: Runnable) =
+        worker.executeAfter(0L) { block.run() }
+
+    override fun scheduleResumeAfterDelay(timeMillis: Long, continuation: CancellableContinuation<Unit>) {
+        // TODO proper toMicros
+        worker.executeAfter(timeMillis * 1000)
+        { with(continuation) { resumeUndispatched(Unit) } }
+    }
+
+    override fun invokeOnTimeout(timeMillis: Long, block: Runnable, context: CoroutineContext): DisposableHandle {
+        // No API to cancel on timeout
+        worker.executeAfter(timeMillis * 1000) { block.run() }
+        return NonDisposableHandle
+    }
+
+    override fun close() {
+        worker.requestTermination().result // Note: calling "result" blocks
+    }
+}