Improve error logging for Realm-level Coroutine tests

realm · Nov 27, 2023 · 21b7eee · 21b7eee
1 parent a4b071b
commit 21b7eee
Show file tree

Hide file tree

Showing 3 changed files with 51 additions and 53 deletions.
diff --git a/packages/test-base/src/commonMain/kotlin/io/realm/kotlin/test/util/Utils.kt b/packages/test-base/src/commonMain/kotlin/io/realm/kotlin/test/util/Utils.kt
@@ -99,7 +99,7 @@ suspend fun <T : Any?> Channel<T>.receiveOrFail(timeout: Duration = 1.minutes, m
         this@receiveOrFail.onReceive { it }
         onTimeout(timeout) {
             @Suppress("invisible_member")
-            throw TimeoutCancellationException("Timeout: $message")
+            throw TimeoutCancellationException("Timeout after $timeout: ${if (message.isNullOrBlank()) "<no message>" else message}")
         }
     }
 }
diff --git a/packages/test-base/src/commonTest/kotlin/io/realm/kotlin/test/common/VersionTrackingTests.kt b/packages/test-base/src/commonTest/kotlin/io/realm/kotlin/test/common/VersionTrackingTests.kt
@@ -232,12 +232,12 @@ class VersionTrackingTests {
                 }
 
                 // Wait for the notifier to start
-                realmUpdates.receiveOrFail()
+                realmUpdates.receiveOrFail(message = "Initial event was not received")
 
                 realm.write { }
 
                 // Wait for the notifier to start
-                realmUpdates.receiveOrFail()
+                realmUpdates.receiveOrFail(message = "Update event was not received")
 
                 assertNull(realm.initialRealmReference.value, toString())
                 assertEquals(1, realm.versionTracker.versions().size, toString())

diff --git a/...rc/commonTest/kotlin/io/realm/kotlin/test/common/notifications/RealmNotificationsTests.kt b/...rc/commonTest/kotlin/io/realm/kotlin/test/common/notifications/RealmNotificationsTests.kt
@@ -121,69 +121,67 @@ class RealmNotificationsTests : FlowableTests {
     }
 
     @Test
-    override fun cancelAsFlow() {
-        runBlocking {
-            val c1 = Channel<RealmChange<Realm>>(1)
-            val c2 = Channel<RealmChange<Realm>>(1)
-            val startingVersion = realm.version()
+    override fun cancelAsFlow() = runBlocking<Unit> {
+        val c1 = Channel<RealmChange<Realm>>(1)
+        val c2 = Channel<RealmChange<Realm>>(1)
+        val startingVersion = realm.version()
 
-            val observer1 = async {
-                realm.asFlow().collect {
-                    c1.send(it)
-                }
+        val observer1 = async {
+            realm.asFlow().collect {
+                c1.send(it)
             }
-            val observer2Cancelled = Mutex(false)
-            val observer2 = async {
-                realm.asFlow().collect {
-                    if (!observer2Cancelled.isLocked) {
-                        c2.send(it)
-                    } else {
-                        fail("Should not receive notifications on a canceled scope")
-                    }
+        }
+        val observer2Cancelled = Mutex(false)
+        val observer2 = async {
+            realm.asFlow().collect {
+                if (!observer2Cancelled.isLocked) {
+                    c2.send(it)
+                } else {
+                    fail("Should not receive notifications on a canceled scope")
                 }
             }
+        }
 
-            // We should first receive an initial Realm notification.
-            c1.receiveOrFail().let { realmChange ->
-                assertIs<InitialRealm<Realm>>(realmChange)
-                assertEquals(startingVersion, realmChange.realm.version())
-            }
-
-            c2.receiveOrFail().let { realmChange ->
-                assertIs<InitialRealm<Realm>>(realmChange)
-                assertEquals(startingVersion, realmChange.realm.version())
-            }
+        // We should first receive an initial Realm notification.
+        c1.receiveOrFail(message = "Did not receive Initial event on Channel 1").let { realmChange ->
+            assertIs<InitialRealm<Realm>>(realmChange)
+            assertEquals(startingVersion, realmChange.realm.version())
+        }
 
-            realm.write { /* Do nothing */ }
+        c2.receiveOrFail(message = "Did not receive Initial event on Channel 2").let { realmChange ->
+            assertIs<InitialRealm<Realm>>(realmChange)
+            assertEquals(startingVersion, realmChange.realm.version())
+        }
 
-            // Now we we should receive an updated Realm change notification.
-            c1.receiveOrFail().let { realmChange ->
-                assertIs<UpdatedRealm<Realm>>(realmChange)
-                assertEquals(VersionId(startingVersion.version + 1), realmChange.realm.version())
-            }
+        realm.write { /* Do nothing */ }
 
-            c2.receiveOrFail().let { realmChange ->
-                assertIs<UpdatedRealm<Realm>>(realmChange)
-                assertEquals(VersionId(startingVersion.version + 1), realmChange.realm.version())
-            }
+        // Now we we should receive an updated Realm change notification.
+        c1.receiveOrFail(message = "Did not receive Update event on Channel 1").let { realmChange ->
+            assertIs<UpdatedRealm<Realm>>(realmChange)
+            assertEquals(VersionId(startingVersion.version + 1), realmChange.realm.version())
+        }
 
-            // Stop one observer and ensure that we dont receive any more notifications in that scope
-            observer2.cancel()
-            observer2Cancelled.lock()
+        c2.receiveOrFail(message = "Did not receive Update event on Channel 2").let { realmChange ->
+            assertIs<UpdatedRealm<Realm>>(realmChange)
+            assertEquals(VersionId(startingVersion.version + 1), realmChange.realm.version())
+        }
 
-            realm.write { /* Do nothing */ }
+        // Stop one observer and ensure that we dont receive any more notifications in that scope
+        observer2.cancel()
+        observer2Cancelled.lock()
 
-            // But unclosed channels should receive notifications
-            c1.receiveOrFail().let { realmChange ->
-                assertIs<UpdatedRealm<Realm>>(realmChange)
-                assertEquals(VersionId(startingVersion.version + 2), realmChange.realm.version())
-            }
+        realm.write { /* Do nothing */ }
 
-            realm.write { /* Do nothing */ }
-            observer1.cancel()
-            c1.close()
-            c2.close()
+        // But unclosed channels should receive notifications
+        c1.receiveOrFail(message = "Did not receive 2nd Update event on Channel 1").let { realmChange ->
+            assertIs<UpdatedRealm<Realm>>(realmChange)
+            assertEquals(VersionId(startingVersion.version + 2), realmChange.realm.version())
         }
+
+        realm.write { /* Do nothing */ }
+        observer1.cancel()
+        c1.close()
+        c2.close()
     }
 
     @Test