Invite people in an existing room (#915)

* Handle power levels * Add “invite” button in RoomMembersListScreen * Refactor DI in RoomDetailsScreenCoordinator * Add navigation to “select people” coordinator * Add InviteUsersScreenRoomContext * Add invite user by id api * Updare InviteUsersScreenRoomContext * Support disabled state on FormButtonStyles * Handle membership in UserProfileCell * Fix conflicts * Refactor RoomContext -> RoomType * Refactor UserProfileCell * Add invite action * Setup navigation to user flow coordinator * Add invite logic * Fix test build errors * Address comments * Fix localisations * Update required state * Handle error * Move invite logic in RoomDetailsScreenCoordinator * Add navigation from room’s members list * Fix UTs * Fix missing display name in RoomMemberDetails * Add user indicator * Add feature flag * Add RoomDetailsViewModel UTs * Add room details ui tests * Add InviteUsersViewModelTests UTs * Add UI tests * Update UI tests * Empty commit
2026-11-02 12:07:55 +00:00 · 2023-05-22 16:03:07 +02:00
parent 8ed8cf6f0c
commit d9e0f36aeb
58 changed files with 708 additions and 172 deletions
@@ -18,14 +18,15 @@ import Combine
 import SwiftUI

 struct InviteUsersScreenCoordinatorParameters {
-    let userSession: UserSessionProtocol
-    let userDiscoveryService: UserDiscoveryServiceProtocol
    let selectedUsers: CurrentValuePublisher<[UserProfile], Never>
+    let roomType: InviteUsersScreenRoomType
+    let mediaProvider: MediaProviderProtocol
+    let userDiscoveryService: UserDiscoveryServiceProtocol
 }

 enum InviteUsersScreenCoordinatorAction {
-    case close
    case proceed
+    case invite(users: [String])
    case toggleUser(UserProfile)
 }

@@ -42,17 +43,20 @@ final class InviteUsersScreenCoordinator: CoordinatorProtocol {
    init(parameters: InviteUsersScreenCoordinatorParameters) {
        self.parameters = parameters
        
-        viewModel = InviteUsersScreenViewModel(selectedUsers: parameters.selectedUsers, userSession: parameters.userSession, userDiscoveryService: parameters.userDiscoveryService)
+        viewModel = InviteUsersScreenViewModel(selectedUsers: parameters.selectedUsers,
+                                               roomType: parameters.roomType,
+                                               mediaProvider: parameters.mediaProvider,
+                                               userDiscoveryService: parameters.userDiscoveryService)
    }
    
    func start() {
        viewModel.actions.sink { [weak self] action in
            guard let self else { return }
            switch action {
-            case .close:
-                self.actionsSubject.send(.close)
            case .proceed:
                self.actionsSubject.send(.proceed)
+            case .invite(let users):
+                self.actionsSubject.send(.invite(users: users))
            case .toggleUser(let user):
                self.actionsSubject.send(.toggleUser(user))
            }
@@ -15,23 +15,30 @@
 //

 import Foundation
+import MatrixRustSDK

 enum InviteUsersScreenErrorType: Error {
    case unknown
 }

 enum InviteUsersScreenViewModelAction {
-    case close
    case proceed
+    case invite(users: [String])
    case toggleUser(UserProfile)
 }

+enum InviteUsersScreenRoomType {
+    case draft
+    case room(members: [RoomMemberProxyProtocol], userIndicatorController: UserIndicatorControllerProtocol)
+}
+
 struct InviteUsersScreenViewState: BindableState {
    var bindings = InviteUsersScreenViewStateBindings()
    
    var usersSection: UserDiscoverySection = .init(type: .suggestions, users: [])
    
    var selectedUsers: [UserProfile] = []
+    var membershipState: [String: MembershipState] = .init()
    
    var isSearching: Bool {
        !bindings.searchQuery.isEmpty
@@ -44,7 +51,30 @@ struct InviteUsersScreenViewState: BindableState {
    var scrollToLastID: String?
    
    func isUserSelected(_ user: UserProfile) -> Bool {
-        selectedUsers.contains { $0.userID == user.userID }
+        isUserDisabled(user) || selectedUsers.contains { $0.userID == user.userID }
+    }
+    
+    func isUserDisabled(_ user: UserProfile) -> Bool {
+        let membershipState = membershipState(user)
+        return membershipState == .invite || membershipState == .join
+    }
+    
+    func membershipState(_ user: UserProfile) -> MembershipState? {
+        membershipState[user.userID]
+    }
+    
+    let isCreatingRoom: Bool
+    
+    var actionText: String {
+        if isCreatingRoom {
+            return selectedUsers.isEmpty ? L10n.actionSkip : L10n.actionNext
+        } else {
+            return L10n.actionInvite
+        }
+    }
+    
+    var isActionDisabled: Bool {
+        isCreatingRoom ? false : selectedUsers.isEmpty
    }
 }

@@ -56,7 +86,6 @@ struct InviteUsersScreenViewStateBindings {
 }

 enum InviteUsersScreenViewAction {
-    case close
    case proceed
    case toggleUser(UserProfile)
 }
@@ -15,49 +15,77 @@
 //

 import Combine
+import MatrixRustSDK
 import SwiftUI

 typealias InviteUsersScreenViewModelType = StateStoreViewModel<InviteUsersScreenViewState, InviteUsersScreenViewAction>

 class InviteUsersScreenViewModel: InviteUsersScreenViewModelType, InviteUsersScreenViewModelProtocol {
-    private let userSession: UserSessionProtocol
+    private let mediaProvider: MediaProviderProtocol
    private let userDiscoveryService: UserDiscoveryServiceProtocol
+    private let roomType: InviteUsersScreenRoomType
    private let actionsSubject: PassthroughSubject<InviteUsersScreenViewModelAction, Never> = .init()
    
    var actions: AnyPublisher<InviteUsersScreenViewModelAction, Never> {
        actionsSubject.eraseToAnyPublisher()
    }
    
-    init(selectedUsers: CurrentValuePublisher<[UserProfile], Never>, userSession: UserSessionProtocol, userDiscoveryService: UserDiscoveryServiceProtocol) {
-        self.userSession = userSession
+    init(selectedUsers: CurrentValuePublisher<[UserProfile], Never>,
+         roomType: InviteUsersScreenRoomType,
+         mediaProvider: MediaProviderProtocol,
+         userDiscoveryService: UserDiscoveryServiceProtocol) {
+        self.roomType = roomType
+        self.mediaProvider = mediaProvider
        self.userDiscoveryService = userDiscoveryService
-        super.init(initialViewState: InviteUsersScreenViewState(selectedUsers: selectedUsers.value), imageProvider: userSession.mediaProvider)
-        
-        selectedUsers
-            .sink { [weak self] users in
-                self?.state.selectedUsers = users
-            }
-            .store(in: &cancellables)
-        
-        setupSubscriptions()
+        super.init(initialViewState: InviteUsersScreenViewState(selectedUsers: selectedUsers.value, isCreatingRoom: roomType.isCreatingRoom), imageProvider: mediaProvider)
+                
+        buildMembershipStateIfNeeded()
+        setupSubscriptions(selectedUsers: selectedUsers)
    }
    
    // MARK: - Public
    
    override func process(viewAction: InviteUsersScreenViewAction) {
        switch viewAction {
-        case .close:
-            actionsSubject.send(.close)
        case .proceed:
-            actionsSubject.send(.proceed)
+            switch roomType {
+            case .draft:
+                actionsSubject.send(.proceed)
+            case .room:
+                actionsSubject.send(.invite(users: state.selectedUsers.map(\.userID)))
+            }
        case .toggleUser(let user):
            actionsSubject.send(.toggleUser(user))
        }
    }
+    
+    private func buildMembershipStateIfNeeded() {
+        guard case let .room(members, userIndicatorController) = roomType else {
+            return
+        }
+        let indicatorID = UUID().uuidString
+        userIndicatorController.submitIndicator(UserIndicator(id: indicatorID, type: .modal, title: L10n.commonLoading, persistent: true))
+        
+        Task.detached { [members] in
+            // accessing RoomMember's properties is very slow. We need to do it in a background thread.
+            let membershipState = members
+                .reduce(into: [String: MembershipState]()) { partialResult, member in
+                    partialResult[member.userID] = member.membership
+                }
+            
+            Task { @MainActor in
+                self.state.membershipState = membershipState
+                userIndicatorController.retractIndicatorWithId(indicatorID)
+            }
+        }
+    }

    // MARK: - Private
    
-    private func setupSubscriptions() {
+    @CancellableTask
+    private var fetchUsersTask: Task<Void, Never>?
+    
+    private func setupSubscriptions(selectedUsers: CurrentValuePublisher<[UserProfile], Never>) {
        context.$viewState
            .map(\.bindings.searchQuery)
            .debounceAndRemoveDuplicates()
@@ -65,11 +93,14 @@ class InviteUsersScreenViewModel: InviteUsersScreenViewModelType, InviteUsersScr
                self?.fetchUsers()
            }
            .store(in: &cancellables)
+        
+        selectedUsers
+            .sink { [weak self] users in
+                self?.state.selectedUsers = users
+            }
+            .store(in: &cancellables)
    }
    
-    @CancellableTask
-    private var fetchUsersTask: Task<Void, Never>?
-    
    private func fetchUsers() {
        guard searchQuery.count >= 3 else {
            fetchSuggestions()
@@ -107,3 +138,14 @@ class InviteUsersScreenViewModel: InviteUsersScreenViewModelType, InviteUsersScr
        context.searchQuery
    }
 }
+
+private extension InviteUsersScreenRoomType {
+    var isCreatingRoom: Bool {
+        switch self {
+        case .draft:
+            return true
+        case .room:
+            return false
+        }
+    }
+}
@@ -69,9 +69,11 @@ struct InviteUsersScreen: View {
            ForEach(context.viewState.usersSection.users, id: \.userID) { user in
                Button { context.send(viewAction: .toggleUser(user)) } label: {
                    UserProfileCell(user: user,
+                                    membership: context.viewState.membershipState(user),
                                    imageProvider: context.imageProvider)
                }
-                .buttonStyle(FormButtonStyle(accessory: .selection(isSelected: context.viewState.isUserSelected(user))))
+                .buttonStyle(FormButtonStyle(isDisabled: context.viewState.isUserDisabled(user),
+                                             accessory: .selection(isSelected: context.viewState.isUserSelected(user))))
            }
        } header: {
            if let title = context.viewState.usersSection.title {
@@ -107,8 +109,9 @@ struct InviteUsersScreen: View {
    
    private var nextButton: some View {
        Button { context.send(viewAction: .proceed) } label: {
-            Text(context.viewState.selectedUsers.isEmpty ? L10n.actionSkip : L10n.actionNext)
+            Text(context.viewState.actionText)
        }
+        .disabled(context.viewState.isActionDisabled)
    }
    
    private func deselect(_ user: UserProfile) {
@@ -120,12 +123,10 @@ struct InviteUsersScreen: View {

 struct InviteUsersScreen_Previews: PreviewProvider {
    static let viewModel = {
-        let userSession = MockUserSession(clientProxy: MockClientProxy(userID: "@userid:example.com"),
-                                          mediaProvider: MockMediaProvider())
        let userDiscoveryService = UserDiscoveryServiceMock()
        userDiscoveryService.fetchSuggestionsReturnValue = .success([.mockAlice])
        userDiscoveryService.searchProfilesWithReturnValue = .success([.mockAlice])
-        return InviteUsersScreenViewModel(selectedUsers: .init([]), userSession: userSession, userDiscoveryService: userDiscoveryService)
+        return InviteUsersScreenViewModel(selectedUsers: .init([]), roomType: .draft, mediaProvider: MockMediaProvider(), userDiscoveryService: userDiscoveryService)
    }()
    
    static var previews: some View {