fix: Make Client.findDM return a Result (#4816)

Author: jmartinesp

features/createroom/impl/src/test/kotlin/io/element/android/features/createroom/impl/DefaultStartDMActionTest.kt

@@ -27,7 +27,7 @@ class DefaultStartDMActionTest {
     @Test
     fun `when dm is found, assert state is updated with given room id`() = runTest {
         val matrixClient = FakeMatrixClient().apply {
-            givenFindDmResult(A_ROOM_ID)
+            givenFindDmResult(Result.success(A_ROOM_ID))
         }
         val analyticsService = FakeAnalyticsService()
         val action = createStartDMAction(matrixClient, analyticsService)
@@ -37,10 +37,23 @@ class DefaultStartDMActionTest {
         assertThat(analyticsService.capturedEvents).isEmpty()
     }
 
+    @Test
+    fun `when finding the dm fails, assert state is updated with given error`() = runTest {
+        val matrixClient = FakeMatrixClient().apply {
+            givenFindDmResult(Result.failure(AN_EXCEPTION))
+        }
+        val analyticsService = FakeAnalyticsService()
+        val action = createStartDMAction(matrixClient, analyticsService)
+        val state = mutableStateOf<AsyncAction<RoomId>>(AsyncAction.Uninitialized)
+        action.execute(aMatrixUser(), true, state)
+        assertThat(state.value).isEqualTo(AsyncAction.Failure(AN_EXCEPTION))
+        assertThat(analyticsService.capturedEvents).isEmpty()
+    }
+
     @Test
     fun `when dm is not found, assert dm is created, state is updated with given room id and analytics get called`() = runTest {
         val matrixClient = FakeMatrixClient().apply {
-            givenFindDmResult(null)
+            givenFindDmResult(Result.success(null))
             givenCreateDmResult(Result.success(A_ROOM_ID))
         }
         val analyticsService = FakeAnalyticsService()
@@ -54,7 +67,7 @@ class DefaultStartDMActionTest {
     @Test
     fun `when dm is not found, and createIfDmDoesNotExist is false, assert dm is not created and state is updated to confirmation state`() = runTest {
         val matrixClient = FakeMatrixClient().apply {
-            givenFindDmResult(null)
+            givenFindDmResult(Result.success(null))
             givenCreateDmResult(Result.success(A_ROOM_ID))
         }
         val analyticsService = FakeAnalyticsService()
@@ -69,7 +82,7 @@ class DefaultStartDMActionTest {
     @Test
     fun `when dm creation fails, assert state is updated with given error`() = runTest {
         val matrixClient = FakeMatrixClient().apply {
-            givenFindDmResult(null)
+            givenFindDmResult(Result.success(null))
             givenCreateDmResult(Result.failure(AN_EXCEPTION))
         }
         val analyticsService = FakeAnalyticsService()

features/userprofile/impl/src/main/kotlin/io/element/android/features/userprofile/impl/root/UserProfilePresenter.kt

@@ -55,7 +55,7 @@ class UserProfilePresenter @AssistedInject constructor(
     @Composable
     private fun getDmRoomId(): State<RoomId?> {
         return produceState<RoomId?>(initialValue = null) {
-            value = client.findDM(userId)
+            value = client.findDM(userId).getOrNull()
         }
     }
 

features/userprofile/impl/src/test/kotlin/io/element/android/features/userprofile/impl/UserProfilePresenterTest.kt

@@ -141,7 +141,7 @@ class UserProfilePresenterTest {
             if (canFindRoom) {
                 givenGetRoomResult(A_ROOM_ID, room)
             }
-            givenFindDmResult(dmRoom)
+            givenFindDmResult(Result.success(dmRoom))
         }
         val presenter = createUserProfilePresenter(
             userId = A_USER_ID_2,

libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/MatrixClient.kt

@@ -55,7 +55,7 @@ interface MatrixClient {
     val ignoredUsersFlow: StateFlow<ImmutableList<UserId>>
     suspend fun getJoinedRoom(roomId: RoomId): JoinedRoom?
     suspend fun getRoom(roomId: RoomId): BaseRoom?
-    suspend fun findDM(userId: UserId): RoomId?
+    suspend fun findDM(userId: UserId): Result<RoomId?>
     suspend fun ignoreUser(userId: UserId): Result<Unit>
     suspend fun unignoreUser(userId: UserId): Result<Unit>
     suspend fun createRoom(createRoomParams: CreateRoomParameters): Result<RoomId>

libraries/matrix/api/src/main/kotlin/io/element/android/libraries/matrix/api/room/StartDM.kt

@@ -18,17 +18,24 @@ suspend fun MatrixClient.startDM(
     userId: UserId,
     createIfDmDoesNotExist: Boolean,
 ): StartDMResult {
-    val existingDM = findDM(userId)
-    return if (existingDM != null) {
-        StartDMResult.Success(existingDM, isNew = false)
-    } else if (createIfDmDoesNotExist) {
-        createDM(userId).fold(
-            { StartDMResult.Success(it, isNew = true) },
-            { StartDMResult.Failure(it) }
+    return findDM(userId)
+        .fold(
+            onSuccess = { existingDM ->
+                if (existingDM != null) {
+                    StartDMResult.Success(existingDM, isNew = false)
+                } else if (createIfDmDoesNotExist) {
+                    createDM(userId).fold(
+                        { StartDMResult.Success(it, isNew = true) },
+                        { StartDMResult.Failure(it) }
+                    )
+                } else {
+                    StartDMResult.DmDoesNotExist
+                }
+            },
+            onFailure = { error ->
+                StartDMResult.Failure(error)
+            }
         )
-    } else {
-        StartDMResult.DmDoesNotExist
-    }
 }
 
 sealed interface StartDMResult {

libraries/matrix/impl/src/main/kotlin/io/element/android/libraries/matrix/impl/RustMatrixClient.kt

@@ -297,8 +297,10 @@ class RustMatrixClient(
         }
     }
 
-    override suspend fun findDM(userId: UserId): RoomId? = withContext(sessionDispatcher) {
-        innerClient.getDmRoom(userId.value)?.use { RoomId(it.id()) }
+    override suspend fun findDM(userId: UserId): Result<RoomId?> = withContext(sessionDispatcher) {
+        runCatchingExceptions {
+            innerClient.getDmRoom(userId.value)?.use { RoomId(it.id()) }
+        }
     }
 
     override suspend fun ignoreUser(userId: UserId): Result<Unit> = withContext(sessionDispatcher) {

libraries/matrix/test/src/main/kotlin/io/element/android/libraries/matrix/test/FakeMatrixClient.kt

@@ -103,7 +103,7 @@ class FakeMatrixClient(
 
     private var createRoomResult: Result<RoomId> = Result.success(A_ROOM_ID)
     private var createDmResult: Result<RoomId> = Result.success(A_ROOM_ID)
-    private var findDmResult: RoomId? = A_ROOM_ID
+    private var findDmResult: Result<RoomId?> = Result.success(A_ROOM_ID)
     private val getRoomResults = mutableMapOf<RoomId, BaseRoom>()
     private val searchUserResults = mutableMapOf<String, Result<MatrixSearchUserResults>>()
     private val getProfileResults = mutableMapOf<UserId, Result<MatrixUser>>()
@@ -133,7 +133,7 @@ class FakeMatrixClient(
         return getRoomResults[roomId] as? JoinedRoom
     }
 
-    override suspend fun findDM(userId: UserId): RoomId? {
+    override suspend fun findDM(userId: UserId): Result<RoomId?> {
         return findDmResult
     }
 
@@ -248,7 +248,7 @@ class FakeMatrixClient(
         createDmResult = result
     }
 
-    fun givenFindDmResult(result: RoomId?) {
+    fun givenFindDmResult(result: Result<RoomId?>) {
         findDmResult = result
     }