Renaming screens returns (#829)

* Rename: StartChat -> StartChatScreen

* Rename: Login -> LoginScreen

* Rename: ServerSelection -> ServerSelectionScreen

* Rename: SoftLogout -> SoftLogoutScreen

ElementX/Sources/Screens/Authentication/ServerSelectionScreen/MockServerSelectionScreenState.swift

@@ -0,0 +1,44 @@
+//
+// 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 SwiftUI
+
+enum MockServerSelectionScreenState: CaseIterable {
+    case matrix
+    case emptyAddress
+    case invalidAddress
+    case nonModal
+    
+    /// Generate the view struct for the screen state.
+    @MainActor var viewModel: ServerSelectionScreenViewModel {
+        switch self {
+        case .matrix:
+            return ServerSelectionScreenViewModel(homeserverAddress: "https://matrix.org",
+                                                  isModallyPresented: true)
+        case .emptyAddress:
+            return ServerSelectionScreenViewModel(homeserverAddress: "",
+                                                  isModallyPresented: true)
+        case .invalidAddress:
+            let viewModel = ServerSelectionScreenViewModel(homeserverAddress: "thisisbad",
+                                                           isModallyPresented: true)
+            viewModel.displayError(.footerMessage(L10n.errorUnknown))
+            return viewModel
+        case .nonModal:
+            return ServerSelectionScreenViewModel(homeserverAddress: "https://matrix.org",
+                                                  isModallyPresented: false)
+        }
+    }
+}

ElementX/Sources/Screens/Authentication/ServerSelectionScreen/ServerSelectionScreenCoordinator.swift

@@ -0,0 +1,111 @@
+//
+// 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 SwiftUI
+
+struct ServerSelectionScreenCoordinatorParameters {
+    /// The service used to authenticate the user.
+    let authenticationService: AuthenticationServiceProxyProtocol
+    let userIndicatorController: UserIndicatorControllerProtocol
+    /// Whether the screen is presented modally or within a navigation stack.
+    let isModallyPresented: Bool
+}
+
+enum ServerSelectionScreenCoordinatorAction {
+    case updated
+    case dismiss
+}
+
+final class ServerSelectionScreenCoordinator: CoordinatorProtocol {
+    private let parameters: ServerSelectionScreenCoordinatorParameters
+    private let userIndicatorController: UserIndicatorControllerProtocol
+    private var viewModel: ServerSelectionScreenViewModelProtocol
+    private var authenticationService: AuthenticationServiceProxyProtocol { parameters.authenticationService }
+
+    var callback: (@MainActor (ServerSelectionScreenCoordinatorAction) -> Void)?
+    
+    init(parameters: ServerSelectionScreenCoordinatorParameters) {
+        self.parameters = parameters
+        viewModel = ServerSelectionScreenViewModel(homeserverAddress: parameters.authenticationService.homeserver.address,
+                                                   isModallyPresented: parameters.isModallyPresented)
+        userIndicatorController = parameters.userIndicatorController
+    }
+    
+    // MARK: - Public
+    
+    func start() {
+        viewModel.callback = { [weak self] action in
+            guard let self else { return }
+            
+            switch action {
+            case .confirm(let homeserverAddress):
+                self.useHomeserver(homeserverAddress)
+            case .dismiss:
+                self.callback?(.dismiss)
+            }
+        }
+    }
+    
+    func stop() {
+        stopLoading()
+    }
+    
+    func toPresentable() -> AnyView {
+        AnyView(ServerSelectionScreen(context: viewModel.context))
+    }
+    
+    // MARK: - Private
+    
+    private func startLoading(label: String = L10n.commonLoading) {
+        userIndicatorController.submitIndicator(UserIndicator(type: .modal,
+                                                              title: label,
+                                                              persistent: true))
+    }
+    
+    private func stopLoading() {
+        userIndicatorController.retractAllIndicators()
+    }
+    
+    /// Updates the login flow using the supplied homeserver address, or shows an error when this isn't possible.
+    private func useHomeserver(_ homeserverAddress: String) {
+        startLoading()
+        
+        Task {
+            switch await authenticationService.configure(for: homeserverAddress) {
+            case .success:
+                MXLog.info("Selected homeserver: \(homeserverAddress)")
+                callback?(.updated)
+                stopLoading()
+            case .failure(let error):
+                MXLog.info("Invalid homeserver: \(homeserverAddress)")
+                stopLoading()
+                handleError(error)
+            }
+        }
+    }
+    
+    /// Processes an error to either update the flow or display it to the user.
+    private func handleError(_ error: AuthenticationServiceError) {
+        switch error {
+        case .invalidServer, .invalidHomeserverAddress:
+            viewModel.displayError(.footerMessage(L10n.screenChangeServerErrorInvalidHomeserver))
+        case .slidingSyncNotAvailable:
+            viewModel.displayError(.slidingSyncAlert)
+        default:
+            viewModel.displayError(.footerMessage(L10n.errorUnknown))
+        }
+    }
+}

ElementX/Sources/Screens/Authentication/ServerSelectionScreen/ServerSelectionScreenModels.swift

@@ -0,0 +1,86 @@
+//
+// 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 Foundation
+
+enum ServerSelectionScreenViewModelAction {
+    /// The user would like to use the homeserver at the given address.
+    case confirm(homeserverAddress: String)
+    /// Dismiss the view without using the entered address.
+    case dismiss
+}
+
+struct ServerSelectionScreenViewState: BindableState {
+    /// The message to be shown in the text field footer when no error has occurred.
+    private let regularFooterMessage = {
+        let linkPlaceholder = "{link}"
+        var message = AttributedString(L10n.screenChangeServerFormNotice(linkPlaceholder))
+        message.replace(linkPlaceholder,
+                        with: L10n.actionLearnMore,
+                        asLinkTo: ServiceLocator.shared.settings.slidingSyncLearnMoreURL)
+        return message
+    }()
+    
+    /// View state that can be bound to from SwiftUI.
+    var bindings: ServerSelectionScreenBindings
+    /// An error message to be shown in the text field footer.
+    var footerErrorMessage: String?
+    /// Whether the screen is presented modally or within a navigation stack.
+    var isModallyPresented: Bool
+    
+    /// The message to show in the text field footer.
+    var footerMessage: AttributedString {
+        footerErrorMessage.map(AttributedString.init) ?? regularFooterMessage
+    }
+    
+    /// The title shown on the confirm button.
+    var buttonTitle: String {
+        isModallyPresented ? L10n.actionContinue : L10n.actionNext
+    }
+    
+    /// The text field is showing an error.
+    var isShowingFooterError: Bool {
+        footerErrorMessage != nil
+    }
+    
+    /// Whether it is possible to continue when tapping the confirmation button.
+    var hasValidationError: Bool {
+        bindings.homeserverAddress.isEmpty || isShowingFooterError
+    }
+}
+
+struct ServerSelectionScreenBindings {
+    /// The homeserver address input by the user.
+    var homeserverAddress: String
+    /// Information describing the currently displayed alert.
+    var alertInfo: AlertInfo<ServerSelectionScreenErrorType>?
+}
+
+enum ServerSelectionScreenViewAction {
+    /// The user would like to use the homeserver at the input address.
+    case confirm
+    /// Dismiss the view without using the entered address.
+    case dismiss
+    /// Clear any errors shown in the text field footer.
+    case clearFooterError
+}
+
+enum ServerSelectionScreenErrorType: Hashable {
+    /// An error message to be shown in the text field footer.
+    case footerMessage(String)
+    /// An alert that allows the user to learn about sliding sync.
+    case slidingSyncAlert
+}

ElementX/Sources/Screens/Authentication/ServerSelectionScreen/ServerSelectionScreenViewModel.swift

@@ -0,0 +1,65 @@
+//
+// 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 SwiftUI
+
+typealias ServerSelectionScreenViewModelType = StateStoreViewModel<ServerSelectionScreenViewState, ServerSelectionScreenViewAction>
+
+class ServerSelectionScreenViewModel: ServerSelectionScreenViewModelType, ServerSelectionScreenViewModelProtocol {
+    var callback: (@MainActor (ServerSelectionScreenViewModelAction) -> Void)?
+
+    init(homeserverAddress: String, isModallyPresented: Bool) {
+        let bindings = ServerSelectionScreenBindings(homeserverAddress: homeserverAddress)
+        
+        super.init(initialViewState: ServerSelectionScreenViewState(bindings: bindings,
+                                                                    isModallyPresented: isModallyPresented))
+    }
+    
+    override func process(viewAction: ServerSelectionScreenViewAction) {
+        switch viewAction {
+        case .confirm:
+            callback?(.confirm(homeserverAddress: state.bindings.homeserverAddress))
+        case .dismiss:
+            callback?(.dismiss)
+        case .clearFooterError:
+            clearFooterError()
+        }
+    }
+    
+    func displayError(_ type: ServerSelectionScreenErrorType) {
+        switch type {
+        case .footerMessage(let message):
+            withElementAnimation {
+                state.footerErrorMessage = message
+            }
+        case .slidingSyncAlert:
+            let openURL = { UIApplication.shared.open(ServiceLocator.shared.settings.slidingSyncLearnMoreURL) }
+            state.bindings.alertInfo = AlertInfo(id: .slidingSyncAlert,
+                                                 title: L10n.commonServerNotSupported,
+                                                 message: L10n.screenChangeServerErrorNoSlidingSyncMessage,
+                                                 primaryButton: .init(title: L10n.actionLearnMore, role: .cancel, action: openURL),
+                                                 secondaryButton: .init(title: L10n.actionCancel, action: nil))
+        }
+    }
+    
+    // MARK: - Private
+    
+    /// Clear any errors shown in the text field footer.
+    private func clearFooterError() {
+        guard state.footerErrorMessage != nil else { return }
+        withElementAnimation { state.footerErrorMessage = nil }
+    }
+}

ElementX/Sources/Screens/Authentication/ServerSelectionScreen/ServerSelectionScreenViewModelProtocol.swift

@@ -0,0 +1,26 @@
+//
+// 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 Foundation
+
+@MainActor
+protocol ServerSelectionScreenViewModelProtocol {
+    var callback: (@MainActor (ServerSelectionScreenViewModelAction) -> Void)? { get set }
+    var context: ServerSelectionScreenViewModelType.Context { get }
+    
+    /// Displays an error to the user.
+    func displayError(_ type: ServerSelectionScreenErrorType)
+}

ElementX/Sources/Screens/Authentication/ServerSelectionScreen/View/ServerSelectionScreen.swift

@@ -0,0 +1,112 @@
+//
+// 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 SwiftUI
+
+struct ServerSelectionScreen: View {
+    @ObservedObject var context: ServerSelectionScreenViewModel.Context
+    
+    var body: some View {
+        ScrollView {
+            VStack(spacing: 0) {
+                header
+                    .padding(.top, UIConstants.iconTopPaddingToNavigationBar)
+                    .padding(.bottom, 36)
+                
+                serverForm
+            }
+            .readableFrame()
+            .padding(.horizontal, 16)
+        }
+        .background(Color.element.background.ignoresSafeArea())
+        .toolbar { toolbar }
+        .alert(item: $context.alertInfo) { $0.alert }
+        .interactiveDismissDisabled()
+    }
+    
+    /// The title, message and icon at the top of the screen.
+    var header: some View {
+        VStack(spacing: 8) {
+            AuthenticationIconImage(image: Image(asset: Asset.Images.serverSelectionIcon), insets: 19)
+                .padding(.bottom, 8)
+            
+            Text(L10n.commonSelectYourServer)
+                .font(.element.title2Bold)
+                .multilineTextAlignment(.center)
+                .foregroundColor(.element.primaryContent)
+            
+            Text(L10n.screenChangeServerSubtitle)
+                .font(.element.subheadline)
+                .multilineTextAlignment(.center)
+                .foregroundColor(.element.tertiaryContent)
+        }
+        .padding(.horizontal, 16)
+    }
+    
+    /// The text field and confirm button where the user enters a server URL.
+    var serverForm: some View {
+        VStack(alignment: .leading, spacing: 24) {
+            TextField(L10n.commonServerUrl, text: $context.homeserverAddress)
+                .textFieldStyle(.elementInput(labelText: Text(L10n.screenChangeServerFormHeader),
+                                              footerText: Text(context.viewState.footerMessage),
+                                              isError: context.viewState.isShowingFooterError,
+                                              accessibilityIdentifier: A11yIdentifiers.changeServerScreen.server))
+                .keyboardType(.URL)
+                .autocapitalization(.none)
+                .disableAutocorrection(true)
+                .onChange(of: context.homeserverAddress) { _ in context.send(viewAction: .clearFooterError) }
+                .submitLabel(.done)
+                .onSubmit(submit)
+            
+            Button(action: submit) {
+                Text(context.viewState.buttonTitle)
+            }
+            .buttonStyle(.elementAction(.xLarge))
+            .disabled(context.viewState.hasValidationError)
+            .accessibilityIdentifier(A11yIdentifiers.changeServerScreen.continue)
+        }
+    }
+    
+    @ToolbarContentBuilder
+    var toolbar: some ToolbarContent {
+        ToolbarItem(placement: .cancellationAction) {
+            if context.viewState.isModallyPresented {
+                Button { context.send(viewAction: .dismiss) } label: {
+                    Text(L10n.actionCancel)
+                }
+                .accessibilityIdentifier(A11yIdentifiers.changeServerScreen.dismiss)
+            }
+        }
+    }
+    
+    /// Sends the `confirm` view action so long as the text field input is valid.
+    func submit() {
+        guard !context.viewState.hasValidationError else { return }
+        context.send(viewAction: .confirm)
+    }
+}
+
+// MARK: - Previews
+
+struct ServerSelection_Previews: PreviewProvider {
+    static var previews: some View {
+        ForEach(MockServerSelectionScreenState.allCases, id: \.self) { state in
+            NavigationStack {
+                ServerSelectionScreen(context: state.viewModel.context)
+            }
+        }
+    }
+}