Upgrade coroutines to 1.6.1

Still left todo: Udpate all uses of runBlocking in tests to use runTest where appropriate now that
runTest handles asynchronous calls correctly.

Author: steve-the-edwards

gradle/libs.versions.toml

@@ -49,7 +49,7 @@ kotest = "5.1.0"
 kotlin = "1.6.10"
 
 kotlinx-binary-compatibility = "0.6.0"
-kotlinx-coroutines = "1.5.1"
+kotlinx-coroutines = "1.6.1"
 # The 1.5.1 test artifact is jvm-only. The commonTest module should use 1.6.1.
 kotlinx-coroutines-test-common = "1.6.1"
 kotlinx-serialization-json = "1.3.2"

trace-encoder/dependencies/runtimeClasspath.txt

@@ -6,6 +6,7 @@ org.jetbrains.kotlin:kotlin-stdlib-common:1.6.10
 org.jetbrains.kotlin:kotlin-stdlib-jdk7:1.6.10
 org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.6.10
 org.jetbrains.kotlin:kotlin-stdlib:1.6.10
-org.jetbrains.kotlinx:kotlinx-coroutines-core-jvm:1.5.1
-org.jetbrains.kotlinx:kotlinx-coroutines-core:1.5.1
+org.jetbrains.kotlinx:kotlinx-coroutines-bom:1.6.1
+org.jetbrains.kotlinx:kotlinx-coroutines-core-jvm:1.6.1
+org.jetbrains.kotlinx:kotlinx-coroutines-core:1.6.1
 org.jetbrains:annotations:13.0

workflow-core/dependencies/jvmRuntimeClasspath.txt

@@ -4,6 +4,7 @@ org.jetbrains.kotlin:kotlin-bom:1.6.10
 org.jetbrains.kotlin:kotlin-stdlib-jdk7:1.6.10
 org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.6.10
 org.jetbrains.kotlin:kotlin-stdlib:1.6.10
-org.jetbrains.kotlinx:kotlinx-coroutines-core-jvm:1.5.1
-org.jetbrains.kotlinx:kotlinx-coroutines-core:1.5.1
+org.jetbrains.kotlinx:kotlinx-coroutines-bom:1.6.1
+org.jetbrains.kotlinx:kotlinx-coroutines-core-jvm:1.6.1
+org.jetbrains.kotlinx:kotlinx-coroutines-core:1.6.1
 org.jetbrains:annotations:13.0

workflow-core/dependencies/runtimeClasspath.txt

@@ -5,6 +5,7 @@ org.jetbrains.kotlin:kotlin-stdlib-common:1.6.10
 org.jetbrains.kotlin:kotlin-stdlib-jdk7:1.6.10
 org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.6.10
 org.jetbrains.kotlin:kotlin-stdlib:1.6.10
-org.jetbrains.kotlinx:kotlinx-coroutines-core-jvm:1.5.1
-org.jetbrains.kotlinx:kotlinx-coroutines-core:1.5.1
+org.jetbrains.kotlinx:kotlinx-coroutines-bom:1.6.1
+org.jetbrains.kotlinx:kotlinx-coroutines-core-jvm:1.6.1
+org.jetbrains.kotlinx:kotlinx-coroutines-core:1.6.1
 org.jetbrains:annotations:13.0

workflow-runtime/dependencies/jvmRuntimeClasspath.txt

@@ -5,6 +5,7 @@ org.jetbrains.kotlin:kotlin-bom:1.6.10
 org.jetbrains.kotlin:kotlin-stdlib-jdk7:1.6.10
 org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.6.10
 org.jetbrains.kotlin:kotlin-stdlib:1.6.10
-org.jetbrains.kotlinx:kotlinx-coroutines-core-jvm:1.5.1
-org.jetbrains.kotlinx:kotlinx-coroutines-core:1.5.1
+org.jetbrains.kotlinx:kotlinx-coroutines-bom:1.6.1
+org.jetbrains.kotlinx:kotlinx-coroutines-core-jvm:1.6.1
+org.jetbrains.kotlinx:kotlinx-coroutines-core:1.6.1
 org.jetbrains:annotations:13.0

workflow-runtime/src/commonTest/kotlin/com/squareup/workflow1/internal/WorkflowNodeTest.kt

@@ -1,4 +1,5 @@
 @file:Suppress("EXPERIMENTAL_API_USAGE", "DEPRECATION")
+@file:OptIn(ExperimentalCoroutinesApi::class)
 
 package com.squareup.workflow1.internal
 
@@ -28,12 +29,13 @@ import kotlinx.coroutines.CancellationException
 import kotlinx.coroutines.CoroutineName
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Dispatchers.Unconfined
+import kotlinx.coroutines.ExperimentalCoroutinesApi
 import kotlinx.coroutines.Job
 import kotlinx.coroutines.cancel
 import kotlinx.coroutines.flow.MutableStateFlow
-import kotlinx.coroutines.runBlocking
 import kotlinx.coroutines.selects.select
 import kotlinx.coroutines.suspendCancellableCoroutine
+import kotlinx.coroutines.test.runTest
 import kotlinx.coroutines.withTimeout
 import kotlin.coroutines.CoroutineContext
 import kotlin.test.AfterTest
@@ -171,14 +173,14 @@ internal class WorkflowNodeTest {
     )
     node.render(workflow, "")("event")
 
-    val result = runBlocking {
-      withTimeout(10) {
+    runTest {
+      val result = withTimeout(10) {
         select<WorkflowOutput<String>?> {
           node.tick(this)
         }
       }
+      assertEquals("tick:event", result?.value)
     }
-    assertEquals("tick:event", result?.value)
   }
 
   @Test fun `accepts events sent to stale renderings`() {
@@ -208,16 +210,16 @@ internal class WorkflowNodeTest {
     sink("event")
     sink("event2")
 
-    val result = runBlocking {
-      withTimeout(10) {
+    runTest {
+      val result = withTimeout(10) {
         List(2) {
           select<WorkflowOutput<String>?> {
             node.tick(this)
           }
         }
       }
+      assertEquals(listOf("tick:event", "tick:event2"), result.map { it?.value })
     }
-    assertEquals(listOf("tick:event", "tick:event2"), result.map { it?.value })
   }
 
   @Test fun `send allows subsequent events on same rendering`() {
@@ -262,7 +264,7 @@ internal class WorkflowNodeTest {
       snapshot = null, baseContext = context
     )
 
-    runBlocking {
+    runTest {
       node.render(workflow.asStatefulWorkflow(), Unit)
       assertTrue(started)
     }
@@ -300,16 +302,15 @@ internal class WorkflowNodeTest {
     )
     node.render(workflow.asStatefulWorkflow(), Unit)
 
-    val result = runBlocking {
+    runTest {
       // Result should be available instantly, any delay at all indicates something is broken.
-      withTimeout(1) {
+      val result = withTimeout(1) {
         select<WorkflowOutput<String>?> {
           node.tick(this)
         }
       }
+      assertEquals("result", result?.value)
     }
-
-    assertEquals("result", result?.value)
   }
 
   @Test fun `sideEffect is cancelled when stops being ran`() {
@@ -329,7 +330,7 @@ internal class WorkflowNodeTest {
       snapshot = null, baseContext = context
     )
 
-    runBlocking {
+    runTest {
       node.render(workflow.asStatefulWorkflow(), true)
       assertNull(cancellationException)
 
@@ -355,7 +356,7 @@ internal class WorkflowNodeTest {
       snapshot = null, baseContext = context
     )
 
-    runBlocking {
+    runTest {
       node.render(workflow.asStatefulWorkflow(), Unit)
       assertNull(cancellationException)
 
@@ -381,7 +382,7 @@ internal class WorkflowNodeTest {
       snapshot = null, baseContext = context
     )
 
-    runBlocking {
+    runTest {
       node.render(workflow.asStatefulWorkflow(), 0)
       assertFalse(cancelled)
       assertEquals(1, renderPasses)
@@ -406,7 +407,7 @@ internal class WorkflowNodeTest {
       snapshot = null, baseContext = context
     )
 
-    runBlocking {
+    runTest {
       node.render(workflow.asStatefulWorkflow(), 0)
       assertEquals(listOf(0), seenProps)
       assertEquals(1, renderPasses)
@@ -1097,7 +1098,7 @@ internal class WorkflowNodeTest {
 
     sink.send("hello")
 
-    runBlocking {
+    runTest {
       select<WorkflowOutput<String>?> {
         node.tick(this)
       }
@@ -1123,13 +1124,12 @@ internal class WorkflowNodeTest {
 
     rendering.send("hello")
 
-    val output = runBlocking {
-      select<WorkflowOutput<String>?> {
+    runTest {
+      val output = select<WorkflowOutput<String>?> {
         node.tick(this)
       }
+      assertEquals("output:hello", output?.value)
     }
-
-    assertEquals("output:hello", output?.value)
   }
 
   @Test fun `actionSink action allows null output`() {
@@ -1148,13 +1148,12 @@ internal class WorkflowNodeTest {
 
     rendering.send("hello")
 
-    val output = runBlocking {
-      select<WorkflowOutput<String>?> {
+    runTest {
+      val output = select<WorkflowOutput<String>?> {
         node.tick(this)
       }
+      assertNull(output?.value)
     }
-
-    assertNull(output?.value)
   }
 
   @Test fun `child action changes state`() {
@@ -1176,7 +1175,7 @@ internal class WorkflowNodeTest {
     )
     node.render(workflow.asStatefulWorkflow(), Unit)
 
-    runBlocking {
+    runTest {
       select<WorkflowOutput<String>?> {
         node.tick(this)
       }
@@ -1202,13 +1201,12 @@ internal class WorkflowNodeTest {
     )
     node.render(workflow.asStatefulWorkflow(), Unit)
 
-    val output = runBlocking {
-      select<WorkflowOutput<String>?> {
+    runTest {
+      val output = select<WorkflowOutput<String>?> {
         node.tick(this)
       }
+      assertEquals("output:child:hello", output?.value)
     }
-
-    assertEquals("output:child:hello", output?.value)
   }
 
   @Test fun `child action allows null output`() {
@@ -1227,13 +1225,12 @@ internal class WorkflowNodeTest {
     )
     node.render(workflow.asStatefulWorkflow(), Unit)
 
-    val output = runBlocking {
-      select<WorkflowOutput<String>?> {
+    runTest {
+      val output = select<WorkflowOutput<String>?> {
         node.tick(this)
       }
+      assertNull(output?.value)
     }
-
-    assertNull(output?.value)
   }
 
   private class TestSession(override val sessionId: Long = 0) : WorkflowSession {

workflow-rx2/dependencies/runtimeClasspath.txt

@@ -7,9 +7,10 @@ org.jetbrains.kotlin:kotlin-stdlib-common:1.6.10
 org.jetbrains.kotlin:kotlin-stdlib-jdk7:1.6.10
 org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.6.10
 org.jetbrains.kotlin:kotlin-stdlib:1.6.10
-org.jetbrains.kotlinx:kotlinx-coroutines-core-jvm:1.5.1
-org.jetbrains.kotlinx:kotlinx-coroutines-core:1.5.1
-org.jetbrains.kotlinx:kotlinx-coroutines-reactive:1.5.1
-org.jetbrains.kotlinx:kotlinx-coroutines-rx2:1.5.1
+org.jetbrains.kotlinx:kotlinx-coroutines-bom:1.6.1
+org.jetbrains.kotlinx:kotlinx-coroutines-core-jvm:1.6.1
+org.jetbrains.kotlinx:kotlinx-coroutines-core:1.6.1
+org.jetbrains.kotlinx:kotlinx-coroutines-reactive:1.6.1
+org.jetbrains.kotlinx:kotlinx-coroutines-rx2:1.6.1
 org.jetbrains:annotations:13.0
 org.reactivestreams:reactive-streams:1.0.3

workflow-testing/dependencies/runtimeClasspath.txt

@@ -3,16 +3,15 @@
 :workflow-runtime
 com.squareup.okio:okio-jvm:3.0.0
 com.squareup.okio:okio:3.0.0
-net.java.dev.jna:jna-platform:5.5.0
-net.java.dev.jna:jna:5.5.0
 org.jetbrains.kotlin:kotlin-bom:1.6.10
 org.jetbrains.kotlin:kotlin-reflect:1.6.10
 org.jetbrains.kotlin:kotlin-stdlib-common:1.6.10
 org.jetbrains.kotlin:kotlin-stdlib-jdk7:1.6.10
 org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.6.10
 org.jetbrains.kotlin:kotlin-stdlib:1.6.10
-org.jetbrains.kotlinx:kotlinx-coroutines-core-jvm:1.5.1
-org.jetbrains.kotlinx:kotlinx-coroutines-core:1.5.1
-org.jetbrains.kotlinx:kotlinx-coroutines-debug:1.5.1
-org.jetbrains.kotlinx:kotlinx-coroutines-test:1.5.1
+org.jetbrains.kotlinx:kotlinx-coroutines-bom:1.6.1
+org.jetbrains.kotlinx:kotlinx-coroutines-core-jvm:1.6.1
+org.jetbrains.kotlinx:kotlinx-coroutines-core:1.6.1
+org.jetbrains.kotlinx:kotlinx-coroutines-test-jvm:1.6.1
+org.jetbrains.kotlinx:kotlinx-coroutines-test:1.6.1
 org.jetbrains:annotations:13.0

workflow-testing/src/test/java/com/squareup/workflow1/WorkerTest.kt

@@ -3,14 +3,16 @@
 package com.squareup.workflow1
 
 import com.squareup.workflow1.testing.test
+import kotlinx.coroutines.ExperimentalCoroutinesApi
 import kotlinx.coroutines.flow.flowOn
-import kotlinx.coroutines.test.TestCoroutineDispatcher
+import kotlinx.coroutines.test.StandardTestDispatcher
 import kotlin.test.Test
 import kotlin.test.assertEquals
 import kotlin.test.assertNotSame
 import kotlin.test.assertTrue
 
 /** Worker tests that use the [Worker.test] function. Core tests are in the core module. */
+@OptIn(ExperimentalCoroutinesApi::class)
 internal class WorkerTest {
 
   private class ExpectedException : RuntimeException()
@@ -119,7 +121,7 @@ internal class WorkerTest {
   }
 
   @Test fun `timer emits and finishes after delay`() {
-    val testDispatcher = TestCoroutineDispatcher()
+    val testDispatcher = StandardTestDispatcher()
     val worker = Worker.timer(1000)
       // Run the timer on the test dispatcher so we can control time.
       .transform { it.flowOn(testDispatcher) }
@@ -128,11 +130,13 @@ internal class WorkerTest {
       assertNoOutput()
       assertNotFinished()
 
-      testDispatcher.advanceTimeBy(999)
+      testDispatcher.scheduler.advanceTimeBy(999)
+      testDispatcher.scheduler.runCurrent()
       assertNoOutput()
       assertNotFinished()
 
-      testDispatcher.advanceTimeBy(1)
+      testDispatcher.scheduler.advanceTimeBy(1)
+      testDispatcher.scheduler.runCurrent()
       assertEquals(Unit, nextOutput())
       assertFinished()
     }

workflow-testing/src/test/java/com/squareup/workflow1/testing/RenderIdempotencyCheckerTest.kt

@@ -8,9 +8,8 @@ import com.squareup.workflow1.stateless
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Dispatchers.Unconfined
 import kotlinx.coroutines.ExperimentalCoroutinesApi
-import kotlinx.coroutines.Job
 import kotlinx.coroutines.flow.MutableStateFlow
-import kotlinx.coroutines.test.TestCoroutineScope
+import kotlinx.coroutines.test.TestScope
 import kotlin.test.Test
 import kotlin.test.assertEquals
 
@@ -26,8 +25,7 @@ class RenderIdempotencyCheckerTest {
       rootRenders++
       renderChild(leafWorkflow)
     }
-    val scope = TestCoroutineScope(Job())
-      .apply { pauseDispatcher() }
+    val scope = TestScope()
 
     renderWorkflowIn(
       rootWorkflow, scope, MutableStateFlow(Unit), interceptors = listOf(RenderIdempotencyChecker)