Fixes #2486 - Implement blocked users management in the app settings

2026-11-02 21:33:26 +00:00 · 2024-02-28 13:21:54 +02:00
parent a0b510cb6b
commit 7615e97c7f
46 changed files with 624 additions and 98 deletions
@@ -0,0 +1,49 @@
+//
+// 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 SwiftUI
+
+struct BlockedUsersScreenCoordinatorParameters {
+    let clientProxy: ClientProxyProtocol
+    let userIndicatorController: UserIndicatorControllerProtocol
+}
+
+enum BlockedUsersScreenCoordinatorAction { }
+
+final class BlockedUsersScreenCoordinator: CoordinatorProtocol {
+    private let viewModel: BlockedUsersScreenViewModelProtocol
+    
+    private var cancellables = Set<AnyCancellable>()
+ 
+    private let actionsSubject: PassthroughSubject<BlockedUsersScreenCoordinatorAction, Never> = .init()
+    var actionsPublisher: AnyPublisher<BlockedUsersScreenCoordinatorAction, Never> {
+        actionsSubject.eraseToAnyPublisher()
+    }
+    
+    init(parameters: BlockedUsersScreenCoordinatorParameters) {
+        viewModel = BlockedUsersScreenViewModel(clientProxy: parameters.clientProxy,
+                                                userIndicatorController: parameters.userIndicatorController)
+    }
+    
+    func stop() {
+        viewModel.stop()
+    }
+        
+    func toPresentable() -> AnyView {
+        AnyView(BlockedUsersScreen(context: viewModel.context))
+    }
+}
@@ -0,0 +1,39 @@
+//
+// 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 BlockedUsersScreenViewModelAction { }
+
+struct BlockedUsersScreenViewState: BindableState {
+    var blockedUsers: [String]
+    var processingUserID: String?
+    
+    var bindings = BlockedUsersScreenViewStateBindings()
+}
+
+struct BlockedUsersScreenViewStateBindings {
+    var alertInfo: AlertInfo<BlockedUsersScreenViewStateAlertType>?
+}
+
+enum BlockedUsersScreenViewAction {
+    case unblockUser(userID: String)
+}
+
+enum BlockedUsersScreenViewStateAlertType: Hashable {
+    case unblock
+    case error
+}
@@ -0,0 +1,103 @@
+//
+// 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 SwiftUI
+
+typealias BlockedUsersScreenViewModelType = StateStoreViewModel<BlockedUsersScreenViewState, BlockedUsersScreenViewAction>
+
+class BlockedUsersScreenViewModel: BlockedUsersScreenViewModelType, BlockedUsersScreenViewModelProtocol {
+    let clientProxy: ClientProxyProtocol
+    let userIndicatorController: UserIndicatorControllerProtocol
+    
+    private let actionsSubject: PassthroughSubject<BlockedUsersScreenViewModelAction, Never> = .init()
+    var actionsPublisher: AnyPublisher<BlockedUsersScreenViewModelAction, Never> {
+        actionsSubject.eraseToAnyPublisher()
+    }
+
+    init(clientProxy: ClientProxyProtocol,
+         userIndicatorController: UserIndicatorControllerProtocol) {
+        self.clientProxy = clientProxy
+        self.userIndicatorController = userIndicatorController
+        
+        super.init(initialViewState: BlockedUsersScreenViewState(blockedUsers: clientProxy.ignoredUsersPublisher.value ?? []))
+        
+        showLoadingIndicator()
+        
+        clientProxy.ignoredUsersPublisher
+            .receive(on: DispatchQueue.main)
+            .sink { [weak self] blockedUsers in
+                guard let self else { return }
+                
+                if let blockedUsers {
+                    hideLoadingIndicator()
+                    state.blockedUsers = blockedUsers
+                }
+            }
+            .store(in: &cancellables)
+    }
+    
+    // MARK: - Public
+    
+    override func process(viewAction: BlockedUsersScreenViewAction) {
+        switch viewAction {
+        case .unblockUser(let userID):
+            state.bindings.alertInfo = .init(id: .unblock,
+                                             title: L10n.screenBlockedUsersUnblockAlertTitle,
+                                             message: L10n.screenBlockedUsersUnblockAlertDescription,
+                                             primaryButton: .init(title: L10n.screenBlockedUsersUnblockAlertAction, role: .destructive) { [weak self] in
+                                                 self?.unblockUser(userID)
+                                             },
+                                             secondaryButton: .init(title: L10n.actionCancel, role: .cancel, action: nil))
+        }
+    }
+    
+    func stop() {
+        hideLoadingIndicator()
+    }
+    
+    // MARK: - Private
+    
+    private func unblockUser(_ userID: String) {
+        showLoadingIndicator()
+        state.processingUserID = userID
+        
+        Task {
+            if case .failure = await clientProxy.unignoreUser(userID) {
+                state.bindings.alertInfo = .init(id: .error)
+            }
+            
+            state.processingUserID = nil
+            hideLoadingIndicator()
+        }
+    }
+    
+    // MARK: Loading indicator
+    
+    private static let loadingIndicatorIdentifier = "BlockedUsersLoading"
+    
+    private func showLoadingIndicator() {
+        userIndicatorController.submitIndicator(UserIndicator(id: Self.loadingIndicatorIdentifier,
+                                                              type: .modal(progress: .indeterminate, interactiveDismissDisabled: false, allowsInteraction: true),
+                                                              title: L10n.commonLoading,
+                                                              persistent: true),
+                                                delay: .milliseconds(100))
+    }
+    
+    private func hideLoadingIndicator() {
+        userIndicatorController.retractIndicatorWithId(Self.loadingIndicatorIdentifier)
+    }
+}
@@ -0,0 +1,25 @@
+//
+// 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
+
+@MainActor
+protocol BlockedUsersScreenViewModelProtocol {
+    var actionsPublisher: AnyPublisher<BlockedUsersScreenViewModelAction, Never> { get }
+    var context: BlockedUsersScreenViewModelType.Context { get }
+    
+    func stop()
+}
@@ -0,0 +1,73 @@
+//
+// 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 Compound
+import SwiftUI
+
+struct BlockedUsersScreen: View {
+    @ObservedObject var context: BlockedUsersScreenViewModel.Context
+    
+    var body: some View {
+        content
+            .compoundList()
+            .navigationBarTitleDisplayMode(.inline)
+            .navigationTitle(L10n.commonBlockedUsers)
+            .alert(item: $context.alertInfo)
+            .disabled(context.viewState.processingUserID != nil)
+    }
+    
+    // MARK: - Private
+    
+    @ViewBuilder
+    private var content: some View {
+        if context.viewState.blockedUsers.isEmpty {
+            Text(L10n.screenBlockedUsersEmpty)
+                .font(.compound.bodyMD)
+                .foregroundColor(.compound.textSecondary)
+                .frame(maxWidth: .infinity, maxHeight: .infinity)
+        } else {
+            Form {
+                ForEach(context.viewState.blockedUsers, id: \.self) { userID in
+                    ListRow(label: .avatar(title: userID, icon: avatar(for: userID)),
+                            details: .isWaiting(context.viewState.processingUserID == userID),
+                            kind: .button(action: { context.send(viewAction: .unblockUser(userID: userID)) }))
+                }
+            }
+        }
+    }
+    
+    private func avatar(for userID: String) -> some View {
+        LoadableAvatarImage(url: nil,
+                            name: String(userID.dropFirst()),
+                            contentID: userID,
+                            avatarSize: .user(on: .blockedUsers),
+                            imageProvider: nil)
+            .accessibilityHidden(true)
+    }
+}
+
+// MARK: - Previews
+
+struct BlockedUsersScreen_Previews: PreviewProvider, TestablePreview {
+    static let viewModel = BlockedUsersScreenViewModel(clientProxy: MockClientProxy(userID: RoomMemberProxyMock.mockMe.userID),
+                                                       userIndicatorController: UserIndicatorControllerMock())
+    
+    static var previews: some View {
+        NavigationStack {
+            BlockedUsersScreen(context: viewModel.context)
+        }
+    }
+}