RoomMemberDetailsScreen (#727)

* generated files * Revert "generated files" This reverts commit f62c1dbcd9e505083ad4ff17532e2c054e253187. * renaming files to RoomMembersList * completed the renaming of the list files * added generated files * basic setup of the view and the mock * added a new mock with a avatar * share/copy link * copyUserLink implemented * removed unimplemented tests * block user UI * navigation to room member details added * implemented but we require a sync from the Rust side * adjusted some UI test screens * alert for unblocking * completed * some tests * changelog * some unit tests * improved the tests * removed unused comment * Update ElementX/Sources/Services/Room/RoomProxy.swift Co-authored-by: Doug <6060466+pixlwave@users.noreply.github.com> * optional displayName * removing toggle * removed cancel title * Update UnitTests/Sources/RoomMemberDetailsViewModelTests.swift Co-authored-by: Doug <6060466+pixlwave@users.noreply.github.com> * removing Group * pr suggestion * better naming * removed capitalizingFirstLetter * Update ElementX/Sources/Other/Extensions/Alert.swift Co-authored-by: Doug <6060466+pixlwave@users.noreply.github.com> * trailing closure * removed useless catch clause * naming conformed to ignore --------- Co-authored-by: Doug <6060466+pixlwave@users.noreply.github.com>
2026-11-04 10:33:45 +00:00 · 2023-03-24 20:27:47 +01:00
parent 9cd38d1a4c
commit 8daa23b27a
41 changed files with 835 additions and 94 deletions
@@ -49,7 +49,7 @@ final class RoomDetailsCoordinator: CoordinatorProtocol {
            
            switch action {
            case .requestMemberDetailsPresentation(let members):
-                self.presentRoomMemberDetails(members)
+                self.presentRoomMembersList(members)
            case .cancel:
                self.callback?(.cancel)
            case .leftRoom:
@@ -62,13 +62,11 @@ final class RoomDetailsCoordinator: CoordinatorProtocol {
        AnyView(RoomDetailsScreen(context: viewModel.context))
    }
    
-    private func presentRoomMemberDetails(_ members: [RoomMemberProxyProtocol]) {
-        let params = RoomMemberDetailsCoordinatorParameters(mediaProvider: parameters.mediaProvider,
-                                                            members: members)
-        let coordinator = RoomMemberDetailsCoordinator(parameters: params)
-        coordinator.callback = { [weak self] _ in
-            self?.navigationStackCoordinator.pop()
-        }
+    private func presentRoomMembersList(_ members: [RoomMemberProxyProtocol]) {
+        let params = RoomMembersListCoordinatorParameters(navigationStackCoordinator: navigationStackCoordinator,
+                                                          mediaProvider: parameters.mediaProvider,
+                                                          members: members)
+        let coordinator = RoomMembersListCoordinator(parameters: params)
        
        navigationStackCoordinator.push(coordinator)
    }
@@ -86,6 +86,7 @@ struct RoomDetailsMember: Identifiable, Equatable {
    let name: String?
    let avatarURL: URL?

+    @MainActor
    init(withProxy proxy: RoomMemberProxyProtocol) {
        id = proxy.userID
        name = proxy.displayName
@@ -69,7 +69,7 @@ struct RoomDetailsScreen: View {
                    Button { context.send(viewAction: .copyRoomLink) } label: {
                        Image(systemName: "link")
                    }
-                    .buttonStyle(FormActionButtonStyle(title: ElementL10n.roomDetailsCopyLink))
+                    .buttonStyle(FormActionButtonStyle(title: ElementL10n.actionCopyLink))
                    
                    ShareLink(item: permalink) {
                        Image(systemName: "square.and.arrow.up")
@@ -17,35 +17,26 @@
 import SwiftUI

 struct RoomMemberDetailsCoordinatorParameters {
+    let roomMemberProxy: RoomMemberProxyProtocol
    let mediaProvider: MediaProviderProtocol
-    let members: [RoomMemberProxyProtocol]
 }

-enum RoomMemberDetailsCoordinatorAction {
-    case cancel
-}
+enum RoomMemberDetailsCoordinatorAction { }

 final class RoomMemberDetailsCoordinator: CoordinatorProtocol {
+    private let parameters: RoomMemberDetailsCoordinatorParameters
    private var viewModel: RoomMemberDetailsViewModelProtocol
-    
+
    var callback: ((RoomMemberDetailsCoordinatorAction) -> Void)?
-    
+
    init(parameters: RoomMemberDetailsCoordinatorParameters) {
-        viewModel = RoomMemberDetailsViewModel(mediaProvider: parameters.mediaProvider,
-                                               members: parameters.members)
+        self.parameters = parameters
+
+        viewModel = RoomMemberDetailsViewModel(roomMemberProxy: parameters.roomMemberProxy, mediaProvider: parameters.mediaProvider)
    }
-    
-    func start() {
-        viewModel.callback = { [weak self] action in
-            guard let self else { return }
-            
-            switch action {
-            case .cancel:
-                self.callback?(.cancel)
-            }
-        }
-    }
-        
+
+    func start() { }
+
    func toPresentable() -> AnyView {
        AnyView(RoomMemberDetailsScreen(context: viewModel.context))
    }
@@ -0,0 +1,81 @@
+//
+// 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 RoomMemberDetailsViewModelAction { }
+
+struct RoomMemberDetailsViewState: BindableState {
+    let userID: String
+    let name: String?
+    let avatarURL: URL?
+    let isAccountOwner: Bool
+    let permalink: URL?
+    var isIgnored: Bool
+
+    var bindings: RoomMemberDetailsViewStateBindings
+}
+
+struct RoomMemberDetailsViewStateBindings {
+    var ignoreUserAlert: IgnoreUserAlertItem?
+    var errorAlert: ErrorAlertItem?
+}
+
+struct IgnoreUserAlertItem: AlertItem {
+    enum Action {
+        case ignore
+        case unignore
+    }
+
+    let action: Action
+    let cancelTitle = ElementL10n.actionCancel
+
+    var title: String {
+        switch action {
+        case .ignore: return ElementL10n.roomMemberDetailsBlockUser
+        case .unignore: return ElementL10n.roomMemberDetailsUnblockUser
+        }
+    }
+
+    var confirmationTitle: String {
+        switch action {
+        case .ignore: return ElementL10n.roomMemberDetailsBlockAlertAction
+        case .unignore: return ElementL10n.roomMemberDetailsUnblockAlertAction
+        }
+    }
+
+    var description: String {
+        switch action {
+        case .ignore: return ElementL10n.roomMemberDetailsBlockAlertDescription
+        case .unignore: return ElementL10n.roomMemberDetailsUnblockAlertDescription
+        }
+    }
+
+    var viewAction: RoomMemberDetailsViewAction {
+        switch action {
+        case .ignore: return .ignoreConfirmed
+        case .unignore: return .unignoreConfirmed
+        }
+    }
+}
+
+enum RoomMemberDetailsViewAction {
+    case showUnblockAlert
+    case showBlockAlert
+    case ignoreConfirmed
+    case unignoreConfirmed
+    case copyUserLink
+}
@@ -0,0 +1,83 @@
+//
+// 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 RoomMemberDetailsViewModelType = StateStoreViewModel<RoomMemberDetailsViewState, RoomMemberDetailsViewAction>
+
+class RoomMemberDetailsViewModel: RoomMemberDetailsViewModelType, RoomMemberDetailsViewModelProtocol {
+    let roomMemberProxy: RoomMemberProxyProtocol
+
+    var callback: ((RoomMemberDetailsViewModelAction) -> Void)?
+
+    init(roomMemberProxy: RoomMemberProxyProtocol, mediaProvider: MediaProviderProtocol) {
+        self.roomMemberProxy = roomMemberProxy
+        let initialViewState = RoomMemberDetailsViewState(userID: roomMemberProxy.userID,
+                                                          name: roomMemberProxy.displayName,
+                                                          avatarURL: roomMemberProxy.avatarURL,
+                                                          isAccountOwner: roomMemberProxy.isAccountOwner,
+                                                          permalink: roomMemberProxy.permalink,
+                                                          isIgnored: roomMemberProxy.isIgnored,
+                                                          bindings: .init())
+        super.init(initialViewState: initialViewState, imageProvider: mediaProvider)
+    }
+    
+    // MARK: - Public
+    
+    override func process(viewAction: RoomMemberDetailsViewAction) async {
+        switch viewAction {
+        case .showUnblockAlert:
+            state.bindings.ignoreUserAlert = .init(action: .unignore)
+        case .showBlockAlert:
+            state.bindings.ignoreUserAlert = .init(action: .ignore)
+        case .copyUserLink:
+            copyUserLink()
+        case .ignoreConfirmed:
+            await ignoreUser()
+        case .unignoreConfirmed:
+            await unignoreUser()
+        }
+    }
+
+    // MARK: - Private
+
+    private func copyUserLink() {
+        if let userLink = state.permalink {
+            UIPasteboard.general.url = userLink
+            ServiceLocator.shared.userIndicatorController.submitIndicator(UserIndicator(title: ElementL10n.linkCopiedToClipboard))
+        } else {
+            ServiceLocator.shared.userIndicatorController.submitIndicator(UserIndicator(title: ElementL10n.unknownError))
+        }
+    }
+
+    private func ignoreUser() async {
+        switch await roomMemberProxy.ignoreUser() {
+        case .success:
+            state.isIgnored = true
+        case .failure:
+            state.bindings.errorAlert = .init()
+        }
+    }
+
+    private func unignoreUser() async {
+        switch await roomMemberProxy.unignoreUser() {
+        case .success:
+            state.isIgnored = false
+        case .failure:
+            state.bindings.errorAlert = .init()
+        }
+    }
+}
@@ -0,0 +1,137 @@
+//
+// 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 RoomMemberDetailsScreen: View {
+    @ObservedObject var context: RoomMemberDetailsViewModel.Context
+    
+    var body: some View {
+        Form {
+            headerSection
+
+            // TODO: Uncomment when the feature is ready
+//            if !context.viewState.isAccountOwner {
+//                blockUserSection
+//            }
+        }
+        .scrollContentBackground(.hidden)
+        .background(Color.element.formBackground.ignoresSafeArea())
+        .alert(item: $context.ignoreUserAlert, actions: blockUserAlertActions, message: blockUserAlertMessage)
+        .errorAlert(item: $context.errorAlert)
+    }
+    
+    // MARK: - Private
+
+    private var headerSection: some View {
+        VStack(spacing: 8.0) {
+            LoadableAvatarImage(url: context.viewState.avatarURL,
+                                name: context.viewState.name,
+                                contentID: context.viewState.userID,
+                                avatarSize: .user(on: .memberDetails),
+                                imageProvider: context.imageProvider)
+            if let name = context.viewState.name {
+                Text(name)
+                    .foregroundColor(.element.primaryContent)
+                    .font(.element.title1Bold)
+                    .multilineTextAlignment(.center)
+            }
+            Text(context.viewState.userID)
+                .foregroundColor(.element.secondaryContent)
+                .font(.element.body)
+                .multilineTextAlignment(.center)
+
+            if let permalink = context.viewState.permalink {
+                HStack(spacing: 32) {
+                    Button { context.send(viewAction: .copyUserLink) } label: {
+                        Image(systemName: "link")
+                    }
+                    .buttonStyle(FormActionButtonStyle(title: ElementL10n.actionCopyLink))
+
+                    ShareLink(item: permalink) {
+                        Image(systemName: "square.and.arrow.up")
+                    }
+                    .buttonStyle(FormActionButtonStyle(title: ElementL10n.actionShareLink))
+                }
+                .padding(.top, 32)
+            }
+        }
+        .frame(maxWidth: .infinity, alignment: .center)
+        .listRowBackground(Color.clear)
+    }
+
+    private var blockUserSection: some View {
+        Section {
+            if context.viewState.isIgnored {
+                Button {
+                    context.send(viewAction: .showUnblockAlert)
+                } label: {
+                    Label(ElementL10n.roomMemberDetailsUnblockUser, systemImage: "slash.circle")
+                }
+                .buttonStyle(FormButtonStyle(accessory: nil))
+            } else {
+                Button(role: .destructive) {
+                    context.send(viewAction: .showBlockAlert)
+                } label: {
+                    Label(ElementL10n.roomMemberDetailsBlockUser, systemImage: "slash.circle")
+                }
+                .buttonStyle(FormButtonStyle(accessory: nil))
+            }
+        }
+        .formSectionStyle()
+    }
+
+    @ViewBuilder
+    private func blockUserAlertActions(_ item: IgnoreUserAlertItem) -> some View {
+        Button(item.cancelTitle, role: .cancel) { }
+        Button(item.confirmationTitle,
+               role: item.action == .ignore ? .destructive : nil) {
+            context.send(viewAction: item.viewAction)
+        }
+    }
+
+    private func blockUserAlertMessage(_ item: IgnoreUserAlertItem) -> some View {
+        Text(item.description)
+    }
+}
+
+// MARK: - Previews
+
+struct RoomMemberDetails_Previews: PreviewProvider {
+    static let otherUserViewModel = {
+        let member = RoomMemberProxyMock.mockDan
+        return RoomMemberDetailsViewModel(roomMemberProxy: member, mediaProvider: MockMediaProvider())
+    }()
+
+    static let accountOwnerViewModel = {
+        let member = RoomMemberProxyMock.mockMe
+        return RoomMemberDetailsViewModel(roomMemberProxy: member, mediaProvider: MockMediaProvider())
+    }()
+
+    static let ignoredUserViewModel = {
+        let member = RoomMemberProxyMock.mockIgnored
+        return RoomMemberDetailsViewModel(roomMemberProxy: member, mediaProvider: MockMediaProvider())
+    }()
+    
+    static var previews: some View {
+        RoomMemberDetailsScreen(context: otherUserViewModel.context)
+            .previewDisplayName("Other User")
+        RoomMemberDetailsScreen(context: accountOwnerViewModel.context)
+            .previewDisplayName("Account Owner")
+        RoomMemberDetailsScreen(context: ignoredUserViewModel.context)
+            .previewDisplayName("Ignored User")
+    }
+}
@@ -0,0 +1,64 @@
+//
+// 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 RoomMembersListCoordinatorParameters {
+    let navigationStackCoordinator: NavigationStackCoordinator
+    let mediaProvider: MediaProviderProtocol
+    let members: [RoomMemberProxyProtocol]
+}
+
+enum RoomMembersListCoordinatorAction { }
+
+final class RoomMembersListCoordinator: CoordinatorProtocol {
+    private let parameters: RoomMembersListCoordinatorParameters
+    private var viewModel: RoomMembersListViewModelProtocol
+    private var navigationStackCoordinator: NavigationStackCoordinator { parameters.navigationStackCoordinator }
+    
+    var callback: ((RoomMembersListCoordinatorAction) -> Void)?
+    
+    init(parameters: RoomMembersListCoordinatorParameters) {
+        self.parameters = parameters
+
+        viewModel = RoomMembersListViewModel(mediaProvider: parameters.mediaProvider,
+                                             members: parameters.members)
+    }
+    
+    func start() {
+        viewModel.callback = { [weak self] action in
+            guard let self else { return }
+            
+            switch action {
+            case let .selectMember(member):
+                self.selectMember(member)
+            }
+        }
+    }
+        
+    func toPresentable() -> AnyView {
+        AnyView(RoomMembersListScreen(context: viewModel.context))
+    }
+
+    // MARK: - Private
+
+    private func selectMember(_ member: RoomMemberProxyProtocol) {
+        let parameters = RoomMemberDetailsCoordinatorParameters(roomMemberProxy: member, mediaProvider: parameters.mediaProvider)
+        let coordinator = RoomMemberDetailsCoordinator(parameters: parameters)
+
+        navigationStackCoordinator.push(coordinator)
+    }
+}
@@ -16,14 +16,14 @@

 import Foundation

-enum RoomMemberDetailsViewModelAction {
-    case cancel
+enum RoomMembersListViewModelAction {
+    case selectMember(_ member: RoomMemberProxyProtocol)
 }

-struct RoomMemberDetailsViewState: BindableState {
+struct RoomMembersListViewState: BindableState {
    var members: [RoomDetailsMember]

-    var bindings: RoomMemberDetailsViewStateBindings
+    var bindings: RoomMembersListViewStateBindings

    var visibleMembers: [RoomDetailsMember] {
        if bindings.searchQuery.isEmpty {
@@ -37,13 +37,13 @@ struct RoomMemberDetailsViewState: BindableState {
    }
 }

-struct RoomMemberDetailsViewStateBindings {
+struct RoomMembersListViewStateBindings {
    var searchQuery = ""

    /// Information describing the currently displayed alert.
    var alertInfo: AlertInfo<RoomDetailsErrorType>?
 }

-enum RoomMemberDetailsViewAction {
+enum RoomMembersListViewAction {
    case selectMember(id: String)
 }
@@ -16,16 +16,18 @@

 import SwiftUI

-typealias RoomMemberDetailsViewModelType = StateStoreViewModel<RoomMemberDetailsViewState, RoomMemberDetailsViewAction>
+typealias RoomMembersListViewModelType = StateStoreViewModel<RoomMembersListViewState, RoomMembersListViewAction>

-class RoomMemberDetailsViewModel: RoomMemberDetailsViewModelType, RoomMemberDetailsViewModelProtocol {
+class RoomMembersListViewModel: RoomMembersListViewModelType, RoomMembersListViewModelProtocol {
    private let mediaProvider: MediaProviderProtocol
+    private let members: [RoomMemberProxyProtocol]
    
-    var callback: ((RoomMemberDetailsViewModelAction) -> Void)?
+    var callback: ((RoomMembersListViewModelAction) -> Void)?

    init(mediaProvider: MediaProviderProtocol,
         members: [RoomMemberProxyProtocol]) {
        self.mediaProvider = mediaProvider
+        self.members = members
        super.init(initialViewState: .init(members: members.map { RoomDetailsMember(withProxy: $0) },
                                           bindings: .init()),
                   imageProvider: mediaProvider)
@@ -33,10 +35,14 @@ class RoomMemberDetailsViewModel: RoomMemberDetailsViewModelType, RoomMemberDeta
    
    // MARK: - Public
    
-    override func process(viewAction: RoomMemberDetailsViewAction) async {
+    override func process(viewAction: RoomMembersListViewAction) async {
        switch viewAction {
        case .selectMember(let id):
-            MXLog.debug("Member selected: \(id)")
+            guard let member = members.first(where: { $0.userID == id }) else {
+                MXLog.error("Selected member \(id) not found")
+                return
+            }
+            callback?(.selectMember(member))
        }
    }
 }
@@ -0,0 +1,23 @@
+//
+// 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 RoomMembersListViewModelProtocol {
+    var callback: ((RoomMembersListViewModelAction) -> Void)? { get set }
+    var context: RoomMembersListViewModelType.Context { get }
+}
@@ -16,11 +16,11 @@

 import SwiftUI

-struct RoomMemberDetailsMemberCell: View {
+struct RoomMembersListMemberCell: View {
    @ScaledMetric private var avatarSize = AvatarSize.user(on: .roomDetails).value

    let member: RoomDetailsMember
-    let context: RoomMemberDetailsViewModel.Context
+    let context: RoomMembersListViewModel.Context

    var body: some View {
        Button {
@@ -46,19 +46,19 @@ struct RoomMemberDetailsMemberCell: View {
    }
 }

-struct RoomMemberDetailsMemberCell_Previews: PreviewProvider {
+struct RoomMembersListMemberCell_Previews: PreviewProvider {
    static var previews: some View {
        let members: [RoomMemberProxyMock] = [
            .mockAlice,
            .mockBob,
            .mockCharlie
        ]
-        let viewModel = RoomMemberDetailsViewModel(mediaProvider: MockMediaProvider(),
-                                                   members: members)
+        let viewModel = RoomMembersListViewModel(mediaProvider: MockMediaProvider(),
+                                                 members: members)
        
        return VStack {
            ForEach(members, id: \.userID) { member in
-                RoomMemberDetailsMemberCell(member: .init(withProxy: member), context: viewModel.context)
+                RoomMembersListMemberCell(member: .init(withProxy: member), context: viewModel.context)
            }
        }
    }
@@ -16,17 +16,17 @@

 import SwiftUI

-struct RoomMemberDetailsScreen: View {
+struct RoomMembersListScreen: View {
    @Environment(\.colorScheme) private var colorScheme

-    @ObservedObject var context: RoomMemberDetailsViewModel.Context
+    @ObservedObject var context: RoomMembersListViewModel.Context
    
    var body: some View {
        ScrollView {
            LazyVStack(alignment: .leading) {
                Section {
                    ForEach(context.viewState.visibleMembers) { member in
-                        RoomMemberDetailsMemberCell(member: member, context: context)
+                        RoomMembersListMemberCell(member: member, context: context)
                            .id(member.id)
                    }
                } header: {
@@ -48,20 +48,20 @@ struct RoomMemberDetailsScreen: View {

 // MARK: - Previews

-struct RoomMemberDetails_Previews: PreviewProvider {
+struct RoomMembersList_Previews: PreviewProvider {
    static let viewModel = {
        let members: [RoomMemberProxyMock] = [
            .mockAlice,
            .mockBob,
            .mockCharlie
        ]
-        return RoomMemberDetailsViewModel(mediaProvider: MockMediaProvider(),
-                                          members: members)
+        return RoomMembersListViewModel(mediaProvider: MockMediaProvider(),
+                                        members: members)
    }()
    
    static var previews: some View {
        NavigationStack {
-            RoomMemberDetailsScreen(context: viewModel.context)
+            RoomMembersListScreen(context: viewModel.context)
        }
    }
 }