Merge pull request #821 from vector-im/feature/query_latch

Remove CountDownLatch (inspired from #419)

matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/database/RealmQueryLatch.kt

@@ -16,43 +16,36 @@
 
 package im.vector.matrix.android.internal.database
 
-import im.vector.matrix.android.internal.util.createBackgroundHandler
 import io.realm.*
-import java.util.concurrent.CountDownLatch
+import kotlinx.coroutines.*
-import java.util.concurrent.TimeUnit
-import java.util.concurrent.atomic.AtomicReference
 
-class RealmQueryLatch<E : RealmObject>(private val realmConfiguration: RealmConfiguration,
+internal suspend fun <T> awaitNotEmptyResult(realmConfiguration: RealmConfiguration,
-                                       private val realmQueryBuilder: (Realm) -> RealmQuery<E>) {
+                                    timeoutMillis: Long,
+                                    builder: (Realm) -> RealmQuery<T>) {
+    withTimeout(timeoutMillis) {
+        // Confine Realm interaction to a single thread with Looper.
+        withContext(Dispatchers.Main) {
+            val latch = CompletableDeferred<Unit>()
 
-    private companion object {
+            Realm.getInstance(realmConfiguration).use { realm ->
-        val QUERY_LATCH_HANDLER = createBackgroundHandler("REALM_QUERY_LATCH")
+                val result = builder(realm).findAllAsync()
-    }
 
-    @Throws(InterruptedException::class)
+                val listener = object : RealmChangeListener<RealmResults<T>> {
-    fun await(timeout: Long, timeUnit: TimeUnit) {
+                    override fun onChange(it: RealmResults<T>) {
-        val realmRef = AtomicReference<Realm>()
+                        if (it.isNotEmpty()) {
-        val latch = CountDownLatch(1)
+                            result.removeChangeListener(this)
-        QUERY_LATCH_HANDLER.post {
+                            latch.complete(Unit)
-            val realm = Realm.getInstance(realmConfiguration)
+                        }
-            realmRef.set(realm)
-            val result = realmQueryBuilder(realm).findAllAsync()
-            result.addChangeListener(object : RealmChangeListener<RealmResults<E>> {
-                override fun onChange(t: RealmResults<E>) {
-                    if (t.isNotEmpty()) {
-                        result.removeChangeListener(this)
-                        latch.countDown()
                     }
                 }
-            })
+
-        }
+                result.addChangeListener(listener)
-        try {
+                try {
-            latch.await(timeout, timeUnit)
+                    latch.await()
-        } catch (exception: InterruptedException) {
+                } catch (e: CancellationException) {
-            throw exception
+                    result.removeChangeListener(listener)
-        } finally {
+                    throw e
-            QUERY_LATCH_HANDLER.post {
+                }
-                realmRef.getAndSet(null).close()
             }
         }
     }

matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/session/room/create/CreateRoomTask.kt

@@ -20,7 +20,7 @@ import com.zhuinden.monarchy.Monarchy
 import im.vector.matrix.android.api.session.room.failure.CreateRoomFailure
 import im.vector.matrix.android.api.session.room.model.create.CreateRoomParams
 import im.vector.matrix.android.api.session.room.model.create.CreateRoomResponse
-import im.vector.matrix.android.internal.database.RealmQueryLatch
+import im.vector.matrix.android.internal.database.awaitNotEmptyResult
 import im.vector.matrix.android.internal.database.model.RoomEntity
 import im.vector.matrix.android.internal.database.model.RoomEntityFields
 import im.vector.matrix.android.internal.database.model.RoomSummaryEntity
@@ -34,6 +34,7 @@ import im.vector.matrix.android.internal.session.user.accountdata.UpdateUserAcco
 import im.vector.matrix.android.internal.task.Task
 import im.vector.matrix.android.internal.util.awaitTransaction
 import io.realm.RealmConfiguration
+import kotlinx.coroutines.TimeoutCancellationException
 import java.util.concurrent.TimeUnit
 import javax.inject.Inject
 
@@ -53,13 +54,12 @@ internal class DefaultCreateRoomTask @Inject constructor(private val roomAPI: Ro
         }
         val roomId = createRoomResponse.roomId!!
         // Wait for room to come back from the sync (but it can maybe be in the DB if the sync response is received before)
-        val rql = RealmQueryLatch<RoomEntity>(realmConfiguration) { realm ->
-            realm.where(RoomEntity::class.java)
-                    .equalTo(RoomEntityFields.ROOM_ID, roomId)
-        }
         try {
-            rql.await(timeout = 1L, timeUnit = TimeUnit.MINUTES)
+            awaitNotEmptyResult(realmConfiguration, TimeUnit.MINUTES.toMillis(1L)) { realm ->
-        } catch (exception: Exception) {
+                realm.where(RoomEntity::class.java)
+                        .equalTo(RoomEntityFields.ROOM_ID, roomId)
+            }
+        } catch (exception: TimeoutCancellationException) {
             throw CreateRoomFailure.CreatedWithTimeout
         }
         if (params.isDirect()) {

matrix-sdk-android/src/main/java/im/vector/matrix/android/internal/session/room/membership/joining/JoinRoomTask.kt

@@ -17,7 +17,7 @@
 package im.vector.matrix.android.internal.session.room.membership.joining
 
 import im.vector.matrix.android.api.session.room.failure.JoinRoomFailure
-import im.vector.matrix.android.internal.database.RealmQueryLatch
+import im.vector.matrix.android.internal.database.awaitNotEmptyResult
 import im.vector.matrix.android.internal.database.model.RoomEntity
 import im.vector.matrix.android.internal.database.model.RoomEntityFields
 import im.vector.matrix.android.internal.di.SessionDatabase
@@ -26,6 +26,7 @@ import im.vector.matrix.android.internal.session.room.RoomAPI
 import im.vector.matrix.android.internal.session.room.read.SetReadMarkersTask
 import im.vector.matrix.android.internal.task.Task
 import io.realm.RealmConfiguration
+import kotlinx.coroutines.TimeoutCancellationException
 import java.util.concurrent.TimeUnit
 import javax.inject.Inject
 
@@ -46,18 +47,16 @@ internal class DefaultJoinRoomTask @Inject constructor(private val roomAPI: Room
         executeRequest<Unit> {
             apiCall = roomAPI.join(params.roomId, params.viaServers, mapOf("reason" to params.reason))
         }
-        val roomId = params.roomId
         // Wait for room to come back from the sync (but it can maybe be in the DB is the sync response is received before)
-        val rql = RealmQueryLatch<RoomEntity>(realmConfiguration) { realm ->
-            realm.where(RoomEntity::class.java)
-                    .equalTo(RoomEntityFields.ROOM_ID, roomId)
-        }
         try {
-            rql.await(timeout = 1L, timeUnit = TimeUnit.MINUTES)
+            awaitNotEmptyResult(realmConfiguration, TimeUnit.MINUTES.toMillis(1L)) { realm ->
-        } catch (exception: Exception) {
+                realm.where(RoomEntity::class.java)
+                        .equalTo(RoomEntityFields.ROOM_ID, params.roomId)
+            }
+        } catch (exception: TimeoutCancellationException) {
             throw JoinRoomFailure.JoinedWithTimeout
         }
-        setReadMarkers(roomId)
+        setReadMarkers(params.roomId)
     }
 
     private suspend fun setReadMarkers(roomId: String) {