Suggest recently visited rooms when forwarding messages (#6251)

* Suggest recently visited rooms when forwarding messages The Forward to screen now shows up to 5 recently visited rooms in a Suggestions section, above a Chats section that lists every room. The suggestions are never searched: while searching, only the Chats section is shown and filtered. The source room, invites, spaces and upgraded rooms are never suggested, and the section is hidden when there is nothing to suggest. The suggestions are resolved from the room summaries rather than room proxies, so they show up without holding back the list, and they are re-resolved as the room list loads after a cold start. ClientProxy now exposes the recently visited room IDs for this. The recently visited rooms filter is now async, so callers choose its isolation instead of asserting it at runtime. * Apply review suggestions to the forwarding suggestions Rooms: - Each room is listed once. Suggested rooms are left out of Chats unless searching, where Chats lists every result. This also removes the duplicated row whose selection changed without the tapped row's animation. - The Chats header is hidden when the section has no rooms. Suggestions: - Resolve them once when the screen opens instead of on every room list update.
2026-11-03 06:55:59 +00:00 · 2026-10-02 12:04:07 +02:00
parent e67a4c388f
commit f91b7441e7
25 changed files with 287 additions and 68 deletions
@@ -15,11 +15,25 @@ enum MessageForwardingScreenViewModelAction {
 }

 struct MessageForwardingScreenViewState: BindableState {
+    /// The recently visited rooms, never filtered by the search query.
+    var suggestedRooms: [MessageForwardingRoom] = []
    var rooms: [MessageForwardingRoom] = []
    var selectedRoomIDs: Set<String> = []
    let maxRoomSelectionCount = 5
    var bindings = MessageForwardingScreenViewStateBindings()
    
+    var showsSuggestions: Bool {
+        bindings.searchQuery.isEmpty && !suggestedRooms.isEmpty
+    }
+    
+    /// Every room appears once: the suggested ones are left out unless searching.
+    var chats: [MessageForwardingRoom] {
+        guard showsSuggestions else { return rooms }
+        
+        let suggestedRoomIDs = Set(suggestedRooms.map(\.id))
+        return rooms.filter { !suggestedRoomIDs.contains($0.id) }
+    }
+    
    var isAtRoomSelectionLimit: Bool {
        selectedRoomIDs.count >= maxRoomSelectionCount
    }
@@ -44,6 +58,15 @@ struct MessageForwardingRoom: Identifiable, Equatable {
    let avatar: RoomAvatar
 }

+extension MessageForwardingRoom {
+    init(summary: RoomSummary) {
+        self.init(id: summary.id,
+                  title: summary.name,
+                  description: summary.roomListDescription,
+                  avatar: summary.avatar)
+    }
+}
+
 struct MessageForwardingPayload: Hashable {
    /// The source items' timeline IDs. Only necessary for a rough Hashable conformance.
    let ids: [TimelineItemIdentifier]
@@ -12,6 +12,8 @@ import SwiftUI
 typealias MessageForwardingScreenViewModelType = StateStoreViewModel<MessageForwardingScreenViewState, MessageForwardingScreenViewAction>

 class MessageForwardingScreenViewModel: MessageForwardingScreenViewModelType, MessageForwardingScreenViewModelProtocol {
+    private static let maxSuggestedRoomCount = 5
+    
    private let forwardingPayload: MessageForwardingPayload
    private let clientProxy: ClientProxyProtocol
    private let roomSummaryProvider: RoomSummaryProviderProtocol
@@ -54,6 +56,8 @@ class MessageForwardingScreenViewModel: MessageForwardingScreenViewModelType, Me
            .store(in: &cancellables)
        
        updateRooms()
+        
+        Task { await loadSuggestedRooms() }
    }
    
    override func process(viewAction: MessageForwardingScreenViewAction) {
@@ -83,20 +87,21 @@ class MessageForwardingScreenViewModel: MessageForwardingScreenViewModelType, Me
    // MARK: - Private
    
    private func updateRooms() {
-        var rooms = [MessageForwardingRoom]()
+        state.rooms = roomSummaryProvider.roomListPublisher.value
+            .filter { $0.id != forwardingPayload.roomID }
+            .map(MessageForwardingRoom.init(summary:))
+    }
+    
+    /// Built from the room summaries: building room proxies is slow and would shift the list down when the section appears.
+    private func loadSuggestedRooms() async {
+        guard case let .success(roomIDs) = await clientProxy.recentlyVisitedRoomIDs() else { return }
        
-        for summary in roomSummaryProvider.roomListPublisher.value {
-            if summary.id == forwardingPayload.roomID {
-                continue
-            }
-            
-            rooms.append(.init(id: summary.id,
-                               title: summary.name,
-                               description: summary.roomListDescription,
-                               avatar: summary.avatar))
-        }
-        
-        state.rooms = rooms
+        state.suggestedRooms = roomIDs
+            .filter { $0 != forwardingPayload.roomID }
+            .compactMap(clientProxy.roomSummaryForIdentifier)
+            .filter { $0.joinRequestType == nil && !$0.isSpace && !$0.isTombstoned }
+            .prefix(Self.maxSuggestedRoomCount)
+            .map(MessageForwardingRoom.init(summary:))
    }
    
    /// The actual range values don't matter as long as they contain the lower
@@ -15,19 +15,26 @@ struct MessageForwardingScreen: View {
    
    var body: some View {
        Form {
-            Section {
-                ForEach(context.viewState.rooms) { room in
-                    MessageForwardingListRow(room: room,
-                                             isSelected: context.viewState.selectedRoomIDs.contains(room.id),
-                                             isDisabled: context.viewState.isAtRoomSelectionLimit && !context.viewState.selectedRoomIDs.contains(room.id),
-                                             context: context)
+            if context.viewState.showsSuggestions {
+                Section {
+                    ForEach(context.viewState.suggestedRooms, content: row)
+                } header: {
+                    Text(L10n.commonSuggestions)
+                        .compoundListSectionHeader()
                }
+            }
+            
+            Section {
+                ForEach(context.viewState.chats, content: row)
                // Replace these with ScrollView's `scrollPosition` when dropping iOS 16.
            } header: {
-                emptyRectangle
-                    .onAppear {
-                        context.send(viewAction: .reachedTop)
-                    }
+                if !context.viewState.chats.isEmpty {
+                    Text(L10n.commonChats)
+                        .compoundListSectionHeader()
+                        .onAppear {
+                            context.send(viewAction: .reachedTop)
+                        }
+                }
            } footer: {
                emptyRectangle
                    .onAppear {
@@ -56,6 +63,15 @@ struct MessageForwardingScreen: View {
        .disableAutocorrection(true)
    }
    
+    private func row(for room: MessageForwardingRoom) -> some View {
+        let isSelected = context.viewState.selectedRoomIDs.contains(room.id)
+        
+        return MessageForwardingListRow(room: room,
+                                        isSelected: isSelected,
+                                        isDisabled: context.viewState.isAtRoomSelectionLimit && !isSelected,
+                                        context: context)
+    }
+    
    /// The greedy size of Rectangle can create an issue with the navigation bar when the search is highlighted, so is best to use a fixed frame instead of hidden() or EmptyView()
    private var emptyRectangle: some View {
        Rectangle()
@@ -97,17 +113,40 @@ private struct MessageForwardingListRow: View {
 // MARK: - Previews

 struct MessageForwardingScreen_Previews: PreviewProvider, TestablePreview {
+    static let viewModel = makeViewModel()
+    static let searchingViewModel = makeViewModel(searchQuery: "Foundation")
+    
    static var previews: some View {
-        let summaryProvider = RoomSummaryProviderMock(.init(state: .loaded(.mockRooms)))
-        let viewModel = MessageForwardingScreenViewModel(forwardingPayload: .init(ids: [.randomEvent],
-                                                                                  roomID: "",
-                                                                                  contents: [RoomMessageEventContentWithoutRelationSDKMock()]),
-                                                         userSession: UserSessionMock(.init()),
-                                                         roomSummaryProvider: summaryProvider,
-                                                         userIndicatorController: UserIndicatorControllerMock())
-        
        ElementNavigationStack {
            MessageForwardingScreen(context: viewModel.context)
        }
+        .previewDisplayName("Suggestions")
+        .snapshotPreferences(expect: viewModel.context.$viewState.map(\.showsSuggestions))
+        
+        ElementNavigationStack {
+            MessageForwardingScreen(context: searchingViewModel.context)
+        }
+        .previewDisplayName("Searching")
+        .snapshotPreferences(expect: searchingViewModel.context.$viewState.map { !$0.suggestedRooms.isEmpty && !$0.showsSuggestions },
+                             precision: 0.999) // The search field's clear button renders inconsistently in snapshots.
+    }
+    
+    static func makeViewModel(searchQuery: String? = nil) -> MessageForwardingScreenViewModel {
+        let clientProxy = ClientProxyMock(.init())
+        clientProxy.recentlyVisitedRoomIDsReturnValue = .success(["2", "5", "3"])
+        clientProxy.roomSummaryForIdentifierClosure = { roomID in [RoomSummary].mockRooms.first { $0.id == roomID } }
+        
+        let viewModel = MessageForwardingScreenViewModel(forwardingPayload: .init(ids: [.randomEvent],
+                                                                                  roomID: "",
+                                                                                  contents: [RoomMessageEventContentWithoutRelationSDKMock()]),
+                                                         userSession: UserSessionMock(.init(clientProxy: clientProxy)),
+                                                         roomSummaryProvider: RoomSummaryProviderMock(.init(state: .loaded(.mockRooms))),
+                                                         userIndicatorController: UserIndicatorControllerMock())
+        
+        if let searchQuery {
+            viewModel.context.searchQuery = searchQuery
+        }
+        
+        return viewModel
    }
 }
@@ -48,14 +48,11 @@ class SpaceAddRoomsScreenViewModel: SpaceAddRoomsScreenViewModelType, SpaceAddRo
        Task {
            let existingRooms = spaceRoomListProxy.spaceRoomsPublisher.value
            suggestedRooms = await userSession.clientProxy
-                .recentlyVisitedRooms { roomProxy in
-                    // The filter is Sendable for the mock's sake but the client proxy always calls it on the main actor.
-                    MainActor.assumeIsolated {
-                        !roomProxy.infoPublisher.value.isDirect
-                            && !roomProxy.infoPublisher.value.isSpace
-                            && roomProxy.infoPublisher.value.membership == .joined
-                            && !existingRooms.contains { $0.id == roomProxy.id }
-                    }
+                .recentlyVisitedRooms { @MainActor roomProxy in
+                    !roomProxy.infoPublisher.value.isDirect
+                        && !roomProxy.infoPublisher.value.isSpace
+                        && roomProxy.infoPublisher.value.membership == .joined
+                        && !existingRooms.contains { $0.id == roomProxy.id }
                }
                .map { .init(roomProxy: $0) }