Merge pull request #817 from square/coroutines_1.6

Upgrade coroutines to 1.6.4 (including coroutines.test changes)
square · Jul 26, 2022 · 0ae7867 · 0ae7867
2 parents d19ae7a + 58d2cc2
commit 0ae7867
Show file tree

Hide file tree

Showing 23 changed files with 205 additions and 198 deletions.
diff --git a/gradle/libs.versions.toml b/gradle/libs.versions.toml
@@ -49,9 +49,7 @@ kotest = "5.1.0"
 kotlin = "1.6.10"
 
 kotlinx-binary-compatibility = "0.6.0"
-kotlinx-coroutines = "1.5.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-coroutines = "1.6.4"
 kotlinx-serialization-json = "1.3.2"
 kotlinx-benchmark = "0.4.2"
 kotlinx-atomicfu = "0.17.2"
@@ -187,7 +185,7 @@ kotlinx-coroutines-android = { module = "org.jetbrains.kotlinx:kotlinx-coroutine
 kotlinx-coroutines-core = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-core", version.ref = "kotlinx-coroutines" }
 kotlinx-coroutines-rx2 = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-rx2", version.ref = "kotlinx-coroutines" }
 kotlinx-coroutines-test = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-test", version.ref = "kotlinx-coroutines" }
-kotlinx-coroutines-test-common = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-test", version.ref = "kotlinx-coroutines-test-common" }
+kotlinx-coroutines-test-common = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-test", version.ref = "kotlinx-coroutines" }
 kotlinx-serialization-json = { module = "org.jetbrains.kotlinx:kotlinx-serialization-json", version.ref = "kotlinx-serialization-json" }
 kotlinx-benchmark-gradle-plugin = { module = "org.jetbrains.kotlinx:kotlinx-benchmark-plugin", version.ref = "kotlinx-benchmark" }
 kotlinx-benchmark-runtime = { module = "org.jetbrains.kotlinx:kotlinx-benchmark-runtime", version.ref = "kotlinx-benchmark" }

diff --git a/trace-encoder/dependencies/runtimeClasspath.txt b/trace-encoder/dependencies/runtimeClasspath.txt
@@ -2,10 +2,11 @@ com.squareup.moshi:moshi-adapters:1.13.0
 com.squareup.moshi:moshi:1.13.0
 com.squareup.okio:okio:2.10.0
 org.jetbrains.kotlin:kotlin-bom: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.kotlin:kotlin-stdlib-common:1.6.21
+org.jetbrains.kotlin:kotlin-stdlib-jdk7:1.6.21
+org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.6.21
+org.jetbrains.kotlin:kotlin-stdlib:1.6.21
+org.jetbrains.kotlinx:kotlinx-coroutines-bom:1.6.4
+org.jetbrains.kotlinx:kotlinx-coroutines-core-jvm:1.6.4
+org.jetbrains.kotlinx:kotlinx-coroutines-core:1.6.4
 org.jetbrains:annotations:13.0
diff --git a/workflow-config/config-android/dependencies/releaseRuntimeClasspath.txt b/workflow-config/config-android/dependencies/releaseRuntimeClasspath.txt
@@ -3,10 +3,11 @@
 com.squareup.okio:okio-jvm:3.0.0
 com.squareup.okio:okio:3.0.0
 org.jetbrains.kotlin:kotlin-bom: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.kotlin:kotlin-stdlib-common:1.6.21
+org.jetbrains.kotlin:kotlin-stdlib-jdk7:1.6.21
+org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.6.21
+org.jetbrains.kotlin:kotlin-stdlib:1.6.21
+org.jetbrains.kotlinx:kotlinx-coroutines-bom:1.6.4
+org.jetbrains.kotlinx:kotlinx-coroutines-core-jvm:1.6.4
+org.jetbrains.kotlinx:kotlinx-coroutines-core:1.6.4
 org.jetbrains:annotations:13.0
diff --git a/workflow-config/config-jvm/dependencies/runtimeClasspath.txt b/workflow-config/config-jvm/dependencies/runtimeClasspath.txt
@@ -3,10 +3,11 @@
 com.squareup.okio:okio-jvm:3.0.0
 com.squareup.okio:okio:3.0.0
 org.jetbrains.kotlin:kotlin-bom: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.kotlin:kotlin-stdlib-common:1.6.21
+org.jetbrains.kotlin:kotlin-stdlib-jdk7:1.6.21
+org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.6.21
+org.jetbrains.kotlin:kotlin-stdlib:1.6.21
+org.jetbrains.kotlinx:kotlinx-coroutines-bom:1.6.4
+org.jetbrains.kotlinx:kotlinx-coroutines-core-jvm:1.6.4
+org.jetbrains.kotlinx:kotlinx-coroutines-core:1.6.4
 org.jetbrains:annotations:13.0
diff --git a/workflow-core/dependencies/jvmRuntimeClasspath.txt b/workflow-core/dependencies/jvmRuntimeClasspath.txt
@@ -1,9 +1,10 @@
 com.squareup.okio:okio-jvm:3.0.0
 com.squareup.okio:okio:3.0.0
 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.kotlin:kotlin-stdlib-jdk7:1.6.21
+org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.6.21
+org.jetbrains.kotlin:kotlin-stdlib:1.6.21
+org.jetbrains.kotlinx:kotlinx-coroutines-bom:1.6.4
+org.jetbrains.kotlinx:kotlinx-coroutines-core-jvm:1.6.4
+org.jetbrains.kotlinx:kotlinx-coroutines-core:1.6.4
 org.jetbrains:annotations:13.0
diff --git a/workflow-core/dependencies/runtimeClasspath.txt b/workflow-core/dependencies/runtimeClasspath.txt
@@ -1,10 +1,11 @@
 com.squareup.okio:okio-jvm:3.0.0
 com.squareup.okio:okio:3.0.0
 org.jetbrains.kotlin:kotlin-bom: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.kotlin:kotlin-stdlib-common:1.6.21
+org.jetbrains.kotlin:kotlin-stdlib-jdk7:1.6.21
+org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.6.21
+org.jetbrains.kotlin:kotlin-stdlib:1.6.21
+org.jetbrains.kotlinx:kotlinx-coroutines-bom:1.6.4
+org.jetbrains.kotlinx:kotlinx-coroutines-core-jvm:1.6.4
+org.jetbrains.kotlinx:kotlinx-coroutines-core:1.6.4
 org.jetbrains:annotations:13.0
diff --git a/workflow-runtime/dependencies/jvmRuntimeClasspath.txt b/workflow-runtime/dependencies/jvmRuntimeClasspath.txt
@@ -2,9 +2,10 @@
 com.squareup.okio:okio-jvm:3.0.0
 com.squareup.okio:okio:3.0.0
 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.kotlin:kotlin-stdlib-jdk7:1.6.21
+org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.6.21
+org.jetbrains.kotlin:kotlin-stdlib:1.6.21
+org.jetbrains.kotlinx:kotlinx-coroutines-bom:1.6.4
+org.jetbrains.kotlinx:kotlinx-coroutines-core-jvm:1.6.4
+org.jetbrains.kotlinx:kotlinx-coroutines-core:1.6.4
 org.jetbrains:annotations:13.0
diff --git a/workflow-runtime/src/commonTest/kotlin/com/squareup/workflow1/RenderWorkflowInTest.kt b/workflow-runtime/src/commonTest/kotlin/com/squareup/workflow1/RenderWorkflowInTest.kt
@@ -215,6 +215,7 @@ class RenderWorkflowInTest {
       if (runtimeConfig1 is FrameTimeout) {
         // Get past frame timeout to ensure snapshot saved.
         testScope.advanceTimeBy(runtimeConfig1.frameTimeoutMs + 1)
+        testScope.runCurrent()
       }
       val snapshot = renderings.value.let { (rendering, snapshot) ->
         val (state, updateState) = rendering
@@ -280,13 +281,15 @@ class RenderWorkflowInTest {
       if (runtimeConfig is FrameTimeout) {
         // Get past frame timeout to ensure snapshot saved.
         testScope.advanceTimeBy(runtimeConfig.frameTimeoutMs + 1)
+        testScope.runCurrent()
       }
 
       sink.send("unchanging state")
 
       if (runtimeConfig is FrameTimeout) {
         // Get past frame timeout to ensure snapshot saved.
         testScope.advanceTimeBy(runtimeConfig.frameTimeoutMs + 1)
+        testScope.runCurrent()
       }
 
       scope.cancel()
@@ -506,6 +509,7 @@ class RenderWorkflowInTest {
       trigger.complete(Unit)
       if (runtimeConfig is FrameTimeout) {
         testScope.advanceTimeBy(runtimeConfig.frameTimeoutMs + 1)
+        testScope.runCurrent()
       }
       assertFalse(testScope.isActive)
     }

diff --git a/workflow-runtime/src/commonTest/kotlin/com/squareup/workflow1/internal/WorkflowNodeTest.kt b/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
 
@@ -29,12 +30,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
@@ -173,14 +175,14 @@ internal class WorkflowNodeTest {
     )
     node.render(workflow, "")("event")
 
-    val result = runBlocking {
-      withTimeout(10) {
+    runTest {
+      val result = withTimeout(10) {
         select<ActionProcessingResult?> {
           node.tick(this)
         } as WorkflowOutput<String>?
       }
+      assertEquals("tick:event", result?.value)
     }
-    assertEquals("tick:event", result?.value)
   }
 
   @Test fun `accepts events sent to stale renderings`() {
@@ -210,16 +212,16 @@ internal class WorkflowNodeTest {
     sink("event")
     sink("event2")
 
-    val result = runBlocking {
-      withTimeout(10) {
+    runTest {
+      val result = withTimeout(10) {
         List(2) {
           select<ActionProcessingResult?> {
             node.tick(this)
           } as WorkflowOutput<String>?
         }
       }
+      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`() {
@@ -264,7 +266,7 @@ internal class WorkflowNodeTest {
       snapshot = null, baseContext = context
     )
 
-    runBlocking {
+    runTest {
       node.render(workflow.asStatefulWorkflow(), Unit)
       assertTrue(started)
     }
@@ -302,16 +304,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<ActionProcessingResult?> {
           node.tick(this)
         } as WorkflowOutput<String>?
       }
+      assertEquals("result", result?.value)
     }
-
-    assertEquals("result", result?.value)
   }
 
   @Test fun `sideEffect is cancelled when stops being ran`() {
@@ -331,7 +332,7 @@ internal class WorkflowNodeTest {
       snapshot = null, baseContext = context
     )
 
-    runBlocking {
+    runTest {
       node.render(workflow.asStatefulWorkflow(), true)
       assertNull(cancellationException)
 
@@ -357,7 +358,7 @@ internal class WorkflowNodeTest {
       snapshot = null, baseContext = context
     )
 
-    runBlocking {
+    runTest {
       node.render(workflow.asStatefulWorkflow(), Unit)
       assertNull(cancellationException)
 
@@ -383,7 +384,7 @@ internal class WorkflowNodeTest {
       snapshot = null, baseContext = context
     )
 
-    runBlocking {
+    runTest {
       node.render(workflow.asStatefulWorkflow(), 0)
       assertFalse(cancelled)
       assertEquals(1, renderPasses)
@@ -408,7 +409,7 @@ internal class WorkflowNodeTest {
       snapshot = null, baseContext = context
     )
 
-    runBlocking {
+    runTest {
       node.render(workflow.asStatefulWorkflow(), 0)
       assertEquals(listOf(0), seenProps)
       assertEquals(1, renderPasses)
@@ -1099,7 +1100,7 @@ internal class WorkflowNodeTest {
 
     sink.send("hello")
 
-    runBlocking {
+    runTest {
       select<ActionProcessingResult?> {
         node.tick(this)
       } as WorkflowOutput<String>?
@@ -1125,13 +1126,12 @@ internal class WorkflowNodeTest {
 
     rendering.send("hello")
 
-    val output = runBlocking {
-      select<ActionProcessingResult?> {
+    runTest {
+      val output = select<ActionProcessingResult?> {
         node.tick(this)
       } as WorkflowOutput<String>?
+      assertEquals("output:hello", output?.value)
     }
-
-    assertEquals("output:hello", output?.value)
   }
 
   @Test fun `actionSink action allows null output`() {
@@ -1150,13 +1150,12 @@ internal class WorkflowNodeTest {
 
     rendering.send("hello")
 
-    val output = runBlocking {
-      select<ActionProcessingResult?> {
+    runTest {
+      val output = select<ActionProcessingResult?> {
         node.tick(this)
       } as WorkflowOutput<String>?
+      assertNull(output?.value)
     }
-
-    assertNull(output?.value)
   }
 
   @Test fun `child action changes state`() {
@@ -1178,7 +1177,7 @@ internal class WorkflowNodeTest {
     )
     node.render(workflow.asStatefulWorkflow(), Unit)
 
-    runBlocking {
+    runTest {
       select<ActionProcessingResult?> {
         node.tick(this)
       } as WorkflowOutput<String>?
@@ -1204,13 +1203,12 @@ internal class WorkflowNodeTest {
     )
     node.render(workflow.asStatefulWorkflow(), Unit)
 
-    val output = runBlocking {
-      select<ActionProcessingResult?> {
+    runTest {
+      val output = select<ActionProcessingResult?> {
         node.tick(this)
       } as WorkflowOutput<String>?
+      assertEquals("output:child:hello", output?.value)
     }
-
-    assertEquals("output:child:hello", output?.value)
   }
 
   @Test fun `child action allows null output`() {
@@ -1229,13 +1227,12 @@ internal class WorkflowNodeTest {
     )
     node.render(workflow.asStatefulWorkflow(), Unit)
 
-    val output = runBlocking {
-      select<ActionProcessingResult?> {
+    runTest {
+      val output = select<ActionProcessingResult?> {
         node.tick(this)
       } as WorkflowOutput<String>?
+      assertNull(output?.value)
     }
-
-    assertNull(output?.value)
   }
 
   private class TestSession(override val sessionId: Long = 0) : WorkflowSession {

diff --git a/workflow-rx2/dependencies/runtimeClasspath.txt b/workflow-rx2/dependencies/runtimeClasspath.txt
@@ -3,13 +3,14 @@ com.squareup.okio:okio-jvm:3.0.0
 com.squareup.okio:okio:3.0.0
 io.reactivex.rxjava2:rxjava:2.2.21
 org.jetbrains.kotlin:kotlin-bom: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-reactive:1.5.1
-org.jetbrains.kotlinx:kotlinx-coroutines-rx2:1.5.1
+org.jetbrains.kotlin:kotlin-stdlib-common:1.6.21
+org.jetbrains.kotlin:kotlin-stdlib-jdk7:1.6.21
+org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.6.21
+org.jetbrains.kotlin:kotlin-stdlib:1.6.21
+org.jetbrains.kotlinx:kotlinx-coroutines-bom:1.6.4
+org.jetbrains.kotlinx:kotlinx-coroutines-core-jvm:1.6.4
+org.jetbrains.kotlinx:kotlinx-coroutines-core:1.6.4
+org.jetbrains.kotlinx:kotlinx-coroutines-reactive:1.6.4
+org.jetbrains.kotlinx:kotlinx-coroutines-rx2:1.6.4
 org.jetbrains:annotations:13.0
 org.reactivestreams:reactive-streams:1.0.3