Coordinator stops (#207)

* Add `stop` method to `Coordinator`

* Use new stop method to cleanup room screen

* Call stop implicitly when removing a child coordinator

* Revert placeholder avatar font change

* Fix PR remarks

ElementX/Sources/AppCoordinator.swift

@@ -105,6 +105,10 @@ class AppCoordinator: Coordinator {
         stateMachine.processEvent(userSessionStore.hasSessions ? .startWithExistingSession : .startWithAuthentication)
     }
 
+    func stop() {
+        hideLoadingIndicator()
+    }
+
     // MARK: - Private
     
     private func setupLogging() {

ElementX/Sources/Other/Coordinator.swift

@@ -36,6 +36,9 @@ protocol Coordinator: AnyObject {
     ///
     /// - Parameter childCoordinator: Child coordinator to remove.
     func remove(childCoordinator: Coordinator)
+
+    /// Stops job of the coordinator. Can be used to clear some resources. Will be automatically called when the coordinator removed.
+    func stop()
 }
 
 // `Coordinator` default implementation
@@ -45,6 +48,7 @@ extension Coordinator {
     }
     
     func remove(childCoordinator: Coordinator) {
+        childCoordinator.stop()
         childCoordinators = childCoordinators.filter { $0 !== childCoordinator }
     }
 }

ElementX/Sources/Screens/AnalyticsPrompt/AnalyticsPromptCoordinator.swift

@@ -70,4 +70,6 @@ final class AnalyticsPromptCoordinator: Coordinator, Presentable {
     }
     
     func toPresentable() -> UIViewController { analyticsPromptHostingController }
+
+    func stop() { }
 }

ElementX/Sources/Screens/Authentication/AuthenticationCoordinator.swift

@@ -48,6 +48,10 @@ class AuthenticationCoordinator: Coordinator, Presentable {
         navigationRouter.toPresentable()
     }
 
+    func stop() {
+        stopLoading()
+    }
+    
     // MARK: - Private
     
     /// Shows the splash screen as the root view in the navigation stack.

ElementX/Sources/Screens/Authentication/LoginScreen/LoginCoordinator.swift

@@ -100,6 +100,10 @@ final class LoginCoordinator: Coordinator, Presentable {
         loginHostingController
     }
 
+    func stop() {
+        stopLoading()
+    }
+    
     // MARK: - Private
     
     /// Show a blocking activity indicator whilst saving.

ElementX/Sources/Screens/Authentication/ServerSelection/ServerSelectionCoordinator.swift

@@ -83,6 +83,10 @@ final class ServerSelectionCoordinator: Coordinator, Presentable {
         serverSelectionHostingController
     }
 
+    func stop() {
+        stopLoading()
+    }
+    
     // MARK: - Private
     
     /// Show an activity indicator whilst loading.

ElementX/Sources/Screens/Authentication/SoftLogout/SoftLogoutCoordinator.swift

@@ -109,6 +109,10 @@ final class SoftLogoutCoordinator: Coordinator, Presentable {
         softLogoutHostingController
     }
 
+    func stop() {
+        stopLoading()
+    }
+    
     // MARK: - Private
     
     /// Show an activity indicator whilst loading.

ElementX/Sources/Screens/BugReport/BugReportCoordinator.swift

@@ -78,6 +78,10 @@ final class BugReportCoordinator: Coordinator, Presentable {
         bugReportHostingController
     }
 
+    func stop() {
+        stopLoading()
+    }
+    
     // MARK: - Private
     
     /// Show an activity indicator whilst loading.

ElementX/Sources/Screens/HomeScreen/HomeScreenCoordinator.swift

@@ -80,6 +80,8 @@ final class HomeScreenCoordinator: Coordinator, Presentable {
         hostingController
     }
 
+    func stop() { }
+    
     // MARK: - Private
     
     private func processUserMenuAction(_ action: HomeScreenViewUserMenuAction) {

ElementX/Sources/Screens/RoomScreen/RoomScreenCoordinator.swift

@@ -58,4 +58,8 @@ final class RoomScreenCoordinator: Coordinator, Presentable {
     func toPresentable() -> UIViewController {
         roomScreenHostingController
     }
+
+    func stop() {
+        roomScreenViewModel.stop()
+    }
 }

ElementX/Sources/Screens/RoomScreen/RoomScreenModels.swift

@@ -40,7 +40,6 @@ enum RoomScreenViewAction {
     case sendMessage
     case sendReaction(key: String, eventID: String)
     case cancelReply
-    case viewDisappeared
 }
 
 struct RoomScreenViewState: BindableState {

ElementX/Sources/Screens/RoomScreen/RoomScreenViewModel.swift

@@ -90,12 +90,14 @@ class RoomScreenViewModel: RoomScreenViewModelType, RoomScreenViewModelProtocol
             MXLog.warning("React with \(key) failed. Not implemented.")
         case .cancelReply:
             state.composerMode = .default
-        case .viewDisappeared:
+        }
+    }
+
+    func stop() {
         cancellables.forEach { $0.cancel() }
         cancellables.removeAll()
         state.contextMenuBuilder = nil
     }
-    }
     
     // MARK: - Private
     

ElementX/Sources/Screens/RoomScreen/RoomScreenViewModelProtocol.swift

@@ -19,4 +19,6 @@ import Foundation
 @MainActor
 protocol RoomScreenViewModelProtocol {
     var context: RoomScreenViewModelType.Context { get }
+
+    func stop()
 }

ElementX/Sources/Screens/RoomScreen/View/RoomScreen.swift

@@ -41,9 +41,6 @@ struct RoomScreen: View {
             }
         }
         .alert(item: $context.alertInfo) { $0.alert }
-        .onDisappear {
-            context.send(viewAction: .viewDisappeared)
-        }
     }
     
     private func sendMessage() {

ElementX/Sources/Screens/RoomScreen/View/Timeline/PlaceholderAvatarImage.swift

@@ -26,7 +26,8 @@ struct PlaceholderAvatarImage: View {
             Text(textForImage)
                 .padding(4)
                 .foregroundColor(.white)
-                .font(.title2.bold())
+                .font(.system(size: 200).weight(.semibold))
+                .minimumScaleFactor(0.001)
         }
         .aspectRatio(1, contentMode: .fill)
     }

ElementX/Sources/Screens/SessionVerification/SessionVerificationCoordinator.swift

@@ -63,4 +63,6 @@ final class SessionVerificationCoordinator: Coordinator, Presentable {
     func toPresentable() -> UIViewController {
         sessionVerificationHostingController
     }
+
+    func stop() { }
 }

ElementX/Sources/Screens/Settings/SettingsCoordinator.swift

@@ -88,6 +88,8 @@ final class SettingsCoordinator: Coordinator, Presentable {
         settingsHostingController
     }
 
+    func stop() { }
+    
     // MARK: - Private
     
     private func toggleAnalytics() {

ElementX/Sources/UITestsAppCoordinator.swift

@@ -60,6 +60,8 @@ class UITestsAppCoordinator: Coordinator {
     private func mockScreens() -> [MockScreen] {
         UITestScreenIdentifier.allCases.map { MockScreen(id: $0, navigationRouter: navigationRouter) }
     }
+
+    func stop() { }
 }
 
 @MainActor

Tools/Scripts/Templates/SimpleScreenExample/ElementX/TemplateCoordinator.swift

@@ -76,6 +76,10 @@ final class TemplateCoordinator: Coordinator, Presentable {
         templateHostingController
     }
 
+    func stop() {
+        stopLoading()
+    }
+    
     // MARK: - Private
     
     /// Show an activity indicator whilst loading.