Leave Room (#699)

* created the row in the view and the alert, and added the new function to the RoomProxy

* fixed an issue with the alert function

* handling the navigation

* fixed a bug with the detail coordinators being dismissed incorrectly when inside a stack

* implementation completed

* replaced UI screenshots

* added a test for the fixed bug of the coordinators

* trying to increase the wait time for the expectation

* improved the test

* improved the buttons UI

* uploading artifacts for unit tests

* added result bundle true

* improved the tests

* added a new test

* pr suggestions

* updating mock

* PR suggestions

* improved tests

* fixed UI tests

* pr should be ready now

* removed testing code

* reduced complexity

* fixed test

* added a an assert to the new test case

* more tests and messages cases

* pr comments addressed

* completed

ElementX/Sources/Services/Room/MockRoomProxy.swift

@@ -1,89 +0,0 @@
-//
-// Copyright 2022 New Vector Ltd
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-// http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
-
-import Combine
-import Foundation
-import MatrixRustSDK
-
-struct MockRoomProxy: RoomProxyProtocol {
-    var id = UUID().uuidString
-    let name: String? = nil
-    let displayName: String?
-    var topic: String?
-    var avatarURL: URL?
-    var isDirect = Bool.random()
-    var isSpace = Bool.random()
-    var isPublic = Bool.random()
-    var isEncrypted = Bool.random()
-    var isTombstoned = Bool.random()
-    var canonicalAlias: String?
-    var alternativeAliases: [String] = []
-    var hasUnreadNotifications = Bool.random()
-    var members: [RoomMemberProxy]?
-    
-    let timelineProvider: RoomTimelineProviderProtocol = MockRoomTimelineProvider()
-    
-    func loadDisplayNameForUserId(_ userId: String) async -> Result<String?, RoomProxyError> {
-        .failure(.failedRetrievingMemberDisplayName)
-    }
-    
-    func loadAvatarURLForUserId(_ userId: String) async -> Result<URL?, RoomProxyError> {
-        .failure(.failedRetrievingMemberAvatarURL)
-    }
-    
-    func addTimelineListener(listener: TimelineListener) -> Result<[TimelineItem], RoomProxyError> {
-        .failure(.failedAddingTimelineListener)
-    }
-    
-    func removeTimelineListener() { }
-    
-    func paginateBackwards(requestSize: UInt, untilNumberOfItems: UInt) async -> Result<Void, RoomProxyError> {
-        .failure(.failedPaginatingBackwards)
-    }
-    
-    func sendReadReceipt(for eventID: String) async -> Result<Void, RoomProxyError> {
-        .failure(.failedSendingReadReceipt)
-    }
-        
-    func sendMessage(_ message: String, inReplyTo eventID: String? = nil) async -> Result<Void, RoomProxyError> {
-        .failure(.failedSendingMessage)
-    }
-    
-    func sendReaction(_ reaction: String, to eventID: String) async -> Result<Void, RoomProxyError> {
-        .failure(.failedSendingMessage)
-    }
-
-    func editMessage(_ newMessage: String, original eventID: String) async -> Result<Void, RoomProxyError> {
-        .failure(.failedSendingMessage)
-    }
-    
-    func redact(_ eventID: String) async -> Result<Void, RoomProxyError> {
-        .failure(.failedRedactingEvent)
-    }
-
-    func reportContent(_ eventID: String, reason: String?) async -> Result<Void, RoomProxyError> {
-        .failure(.failedReportingContent)
-    }
-
-    func members() async -> Result<[RoomMemberProxy], RoomProxyError> {
-        if let members {
-            return .success(members)
-        }
-        return .failure(.failedRetrievingMembers)
-    }
-    
-    func retryDecryption(for sessionID: String) async { }
-}

ElementX/Sources/Services/Room/RoomProxy.swift

@@ -287,6 +287,23 @@ class RoomProxy: RoomProxyProtocol {
             self?.room.retryDecryption(sessionIds: [sessionID])
         }
     }
+
+    func leaveRoom() async -> Result<Void, RoomProxyError> {
+        sendMessageBackgroundTask = backgroundTaskService.startBackgroundTask(withName: backgroundTaskName, isReusable: true)
+        defer {
+            sendMessageBackgroundTask?.stop()
+        }
+
+        return await Task.dispatch(on: .global()) {
+            do {
+                try self.room.leave()
+                return .success(())
+            } catch {
+                MXLog.error("Failed to leave the room: \(error)")
+                return .failure(.failedLeavingRoom)
+            }
+        }
+    }
     
     // MARK: - Private
     

ElementX/Sources/Services/Room/RoomProxyProtocol.swift

@@ -31,9 +31,11 @@ enum RoomProxyError: Error {
     case failedReportingContent
     case failedAddingTimelineListener
     case failedRetrievingMembers
+    case failedLeavingRoom
 }
 
 @MainActor
+// sourcery: AutoMockable
 protocol RoomProxyProtocol {
     var id: String { get }
     var isDirect: Bool { get }
@@ -51,9 +53,7 @@ protocol RoomProxyProtocol {
     var topic: String? { get }
     
     var avatarURL: URL? { get }
-    
-    var permalink: URL? { get }
-    
+        
     func loadAvatarURLForUserId(_ userId: String) async -> Result<URL?, RoomProxyError>
     
     func loadDisplayNameForUserId(_ userId: String) async -> Result<String?, RoomProxyError>
@@ -79,6 +79,8 @@ protocol RoomProxyProtocol {
     func members() async -> Result<[RoomMemberProxy], RoomProxyError>
     
     func retryDecryption(for sessionID: String) async
+
+    func leaveRoom() async -> Result<Void, RoomProxyError>
 }
 
 extension RoomProxyProtocol {