Be resilient to dispatch order

cashapp · Oct 29, 2023 · a34ebe7 · a34ebe7
1 parent df396a6
commit a34ebe7
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 7 deletions.
diff --git a/redwood-treehouse-host/src/commonTest/kotlin/app/cash/redwood/treehouse/EventLog.kt b/redwood-treehouse-host/src/commonTest/kotlin/app/cash/redwood/treehouse/EventLog.kt
@@ -16,6 +16,7 @@
 package app.cash.redwood.treehouse
 
 import assertk.assertThat
+import assertk.assertions.containsExactlyInAnyOrder
 import assertk.assertions.isEqualTo
 import kotlinx.coroutines.channels.Channel
 
@@ -35,6 +36,18 @@ class EventLog {
     assertThat(takeEvent()).isEqualTo(event)
   }
 
+  /**
+   * Take all the events in [events], in any order. Use this when events published are dependent on
+   * dispatch order.
+   */
+  suspend fun takeEventsInAnyOrder(vararg events: String) {
+    val actual = mutableListOf<String>()
+    while (actual.size < events.size) {
+      actual += takeEvent()
+    }
+    assertThat(actual).containsExactlyInAnyOrder(*events)
+  }
+
   fun assertNoEvents() {
     val received = events.tryReceive()
     check(received.isFailure) {

diff --git a/redwood-treehouse-host/src/commonTest/kotlin/app/cash/redwood/treehouse/FakeCodeListener.kt b/redwood-treehouse-host/src/commonTest/kotlin/app/cash/redwood/treehouse/FakeCodeListener.kt
@@ -35,6 +35,8 @@ class FakeCodeListener(
     view: TreehouseView<*>,
     e: Throwable,
   ) {
-    eventLog += "codeListener.onUncaughtException($view, $e)"
+    // Canonicalize "java.lang.Exception(boom!)" to "kotlin.Exception(boom!)".
+    val exceptionString = e.toString().replace("java.lang.", "kotlin.")
+    eventLog += "codeListener.onUncaughtException($view, $exceptionString)"
   }
 }
diff --git a/...reehouse-host/src/commonTest/kotlin/app/cash/redwood/treehouse/TreehouseAppContentTest.kt b/...reehouse-host/src/commonTest/kotlin/app/cash/redwood/treehouse/TreehouseAppContentTest.kt
@@ -305,9 +305,11 @@ class TreehouseAppContentTest {
     eventLog.takeEvent("codeSessionA.app.uis[0].start()")
 
     codeHost.triggerException(Exception("boom!"))
-    eventLog.takeEvent("codeSessionA.app.uis[0].close()")
-    eventLog.takeEvent("codeListener.onUncaughtException(view1, java.lang.Exception: boom!)")
-    eventLog.takeEvent("codeSessionA.cancel()")
+    eventLog.takeEventsInAnyOrder(
+      "codeSessionA.app.uis[0].close()",
+      "codeListener.onUncaughtException(view1, kotlin.Exception: boom!)",
+      "codeSessionA.cancel()",
+    )
 
     content.unbind()
   }
@@ -346,9 +348,11 @@ class TreehouseAppContentTest {
     eventLog.takeEvent("codeSessionA.app.uis[0].start()")
 
     codeHost.triggerException(Exception("boom!"))
-    eventLog.takeEvent("codeSessionA.app.uis[0].close()")
-    eventLog.takeEvent("codeListener.onUncaughtException(view1, java.lang.Exception: boom!)")
-    eventLog.takeEvent("codeSessionA.cancel()")
+    eventLog.takeEventsInAnyOrder(
+      "codeSessionA.app.uis[0].close()",
+      "codeListener.onUncaughtException(view1, kotlin.Exception: boom!)",
+      "codeSessionA.cancel()",
+    )
 
     codeHost.session = FakeCodeSession("codeSessionB", eventLog)
     eventLog.takeEvent("codeSessionB.start()")