Log out (#174)

* Expose logout method from SDK

* Use logout from SDK, refactor logging out states

* Add some strings

* Introduce `initialDisplayName` on `UIDevice`

* Implement soft logout screen

* Add `softLogout` test screen identifier

* Add new fields into the client proxy and implement new delegate methods

* Add new fields into the user session and observe new client callbacks

* Implement updated login method

* Add remote logout state and event into the state machine

* Implement refreshing restore token on `UserSessionStore`

* Update app coordinator with new states and display soft logout screen when appropriate

* Add reference screenshots for soft logout screen

* Disable auto requesting photos access on screenshot detection

* Make initial device name optional, generate project file

* Add changelog

* Use logout from SDK, refactor logging out states

* Implement soft logout screen

* Implement updated login method

* Make initial device name optional, generate project file

* Fix renamed event

* Fix logout race

* Remove redundant strings

* Reuse existing strings

* Confirm clear all data

* Expose logout method from SDK

* Use logout from SDK, refactor logging out states

* Add some strings

* Introduce `initialDisplayName` on `UIDevice`

* Implement soft logout screen

* Add `softLogout` test screen identifier

* Add new fields into the client proxy and implement new delegate methods

* Add new fields into the user session and observe new client callbacks

* Implement updated login method

* Add remote logout state and event into the state machine

* Implement refreshing restore token on `UserSessionStore`

* Update app coordinator with new states and display soft logout screen when appropriate

* Add reference screenshots for soft logout screen

* Disable auto requesting photos access on screenshot detection

* Make initial device name optional, generate project file

* Add changelog

* Use logout from SDK, refactor logging out states

* Implement soft logout screen

* Implement updated login method

* Make initial device name optional, generate project file

* Fix renamed event

* Fix logout race

* Remove redundant strings

* Reuse existing strings

* Confirm clear all data

* Comment out new apis for now

* Make the PR compile

ElementX/Sources/Services/Client/ClientProxy.swift

@@ -29,6 +29,14 @@ private class WeakClientProxyWrapper: ClientDelegate {
     func didReceiveSyncUpdate() {
         clientProxy?.didReceiveSyncUpdate()
     }
+
+    func didReceiveAuthError(isSoftLogout: Bool) {
+        clientProxy?.didReceiveAuthError(isSoftLogout: isSoftLogout)
+    }
+
+    func didUpdateRestoreToken() {
+        clientProxy?.didUpdateRestoreToken()
+    }
 }
 
 class ClientProxy: ClientProxyProtocol {
@@ -57,11 +65,18 @@ class ClientProxy: ClientProxyProtocol {
         self.backgroundTaskService = backgroundTaskService
         
         client.setDelegate(delegate: WeakClientProxyWrapper(clientProxy: self))
-        
+
+        #warning("Use isSoftLogout() api on next SDK release.")
         Benchmark.startTrackingForIdentifier("ClientSync", message: "Started sync.")
         client.startSync(timelineLimit: ClientProxy.syncLimit)
-        
+
         Task { await updateRooms() }
+//        if !client.isSoftLogout() {
+//            Benchmark.startTrackingForIdentifier("ClientSync", message: "Started sync.")
+//            client.startSync(timelineLimit: ClientProxy.syncLimit)
+//
+//            Task { await updateRooms() }
+//        }
     }
     
     var userIdentifier: String {
@@ -72,6 +87,34 @@ class ClientProxy: ClientProxyProtocol {
             return "Unknown user identifier"
         }
     }
+
+    var isSoftLogout: Bool {
+        #warning("Use isSoftLogout() api on next SDK release.")
+        return false
+//        client.isSoftLogout()
+    }
+
+    var deviceId: String? {
+        do {
+            return try client.deviceId()
+        } catch {
+            MXLog.error("Failed retrieving device id with error: \(error)")
+            return nil
+        }
+    }
+
+    var homeserver: String {
+        client.homeserver()
+    }
+
+    var restoreToken: String? {
+        do {
+            return try client.restoreToken()
+        } catch {
+            MXLog.error("Failed retrieving restore token with error: \(error)")
+            return nil
+        }
+    }
     
     func loadUserDisplayName() async -> Result<String, ClientProxyError> {
         await Task.detached {
@@ -91,7 +134,7 @@ class ClientProxy: ClientProxyProtocol {
                 let avatarURL = try self.client.avatarUrl()
                 return .success(avatarURL)
             } catch {
-                return .failure(.failedRetrievingDisplayName)
+                return .failure(.failedRetrievingAvatarURL)
             }
         }
         .value
@@ -125,6 +168,15 @@ class ClientProxy: ClientProxyProtocol {
         }
         .value
     }
+
+    func logout() async {
+        do {
+            #warning("Use logout() api on next SDK release.")
+//            try client.logout()
+        } catch {
+            MXLog.error("Failed logging out with error: \(error)")
+        }
+    }
     
     // MARK: Private
     
@@ -137,6 +189,14 @@ class ClientProxy: ClientProxyProtocol {
             await self.updateRooms()
         }
     }
+
+    fileprivate func didReceiveAuthError(isSoftLogout: Bool) {
+        callbacks.send(.receivedAuthError(isSoftLogout: isSoftLogout))
+    }
+
+    fileprivate func didUpdateRestoreToken() {
+        callbacks.send(.updatedRestoreToken)
+    }
     
     private func updateRooms() async {
         var currentRooms = rooms

ElementX/Sources/Services/Client/ClientProxyProtocol.swift

@@ -21,6 +21,8 @@ import MatrixRustSDK
 enum ClientProxyCallback {
     case updatedRoomsList
     case receivedSyncUpdate
+    case receivedAuthError(isSoftLogout: Bool)
+    case updatedRestoreToken
 }
 
 enum ClientProxyError: Error {
@@ -36,6 +38,14 @@ protocol ClientProxyProtocol {
     var callbacks: PassthroughSubject<ClientProxyCallback, Never> { get }
     
     var userIdentifier: String { get }
+
+    var isSoftLogout: Bool { get }
+
+    var deviceId: String? { get }
+
+    var homeserver: String { get }
+
+    var restoreToken: String? { get }
     
     var rooms: [RoomProxy] { get }
     
@@ -52,4 +62,6 @@ protocol ClientProxyProtocol {
     func loadMediaContentForSource(_ source: MatrixRustSDK.MediaSource) throws -> Data
     
     func sessionVerificationControllerProxy() async -> Result<SessionVerificationControllerProxyProtocol, ClientProxyError>
+
+    func logout() async
 }

ElementX/Sources/Services/Client/MockClientProxy.swift

@@ -21,6 +21,10 @@ struct MockClientProxy: ClientProxyProtocol {
     let callbacks = PassthroughSubject<ClientProxyCallback, Never>()
     
     let userIdentifier: String
+    let isSoftLogout = false
+    let deviceId: String? = nil
+    let homeserver = ""
+    let restoreToken: String? = nil
     
     let rooms = [RoomProxy]()
     
@@ -51,4 +55,8 @@ struct MockClientProxy: ClientProxyProtocol {
     func sessionVerificationControllerProxy() async -> Result<SessionVerificationControllerProxyProtocol, ClientProxyError> {
         .failure(.failedRetrievingSessionVerificationController)
     }
+
+    func logout() async {
+        // no-op
+    }
 }