Room list fixes (#431)

* Fixes #396 - Avoid duplicates in room list, cleanup logic throughout

* Re-enabled the allRoomsView with a hard 500 room limit and reduced the diffing collection time.

* Fixes #385, #411 - Filter out spaces, invites and tombstoned rooms from the room list

* Various tweaks following code review

ElementX/Sources/Services/Room/RoomSummary/MockRoomSummaryProvider.swift

@@ -71,6 +71,6 @@ class MockRoomSummaryProvider: RoomSummaryProviderProtocol {
                                             lastMessage: try? AttributedString(markdown: "**@mock:client.com**: T-bone beef ribs bacon"),
                                             lastMessageTimestamp: .distantPast,
                                             unreadNotificationCount: 0)),
-        .empty(id: "3")
+        .empty
     ]
 }

ElementX/Sources/Services/Room/RoomSummary/RoomSummaryProvider.swift

@@ -56,7 +56,7 @@ class RoomSummaryProvider: RoomSummaryProviderProtocol {
             .store(in: &cancellables)
         
         slidingSyncViewProxy.diffPublisher
-            .collect(.byTime(serialDispatchQueue, 0.25))
+            .collect(.byTime(serialDispatchQueue, 0.1))
             .sink { [weak self] in self?.updateRoomsWithDiffs($0) }
             .store(in: &cancellables)
     }
@@ -65,15 +65,16 @@ class RoomSummaryProvider: RoomSummaryProviderProtocol {
         guard statePublisher.value == .live else {
             return
         }
-
+        
         var changes = [CollectionDifference<RoomSummary>.Change]()
         for identifier in identifiers {
-            guard let index = rooms.firstIndex(where: { $0.id == identifier }) else {
+            guard let index = rooms.firstIndex(where: { $0.id == identifier }),
+                  let roomListEntry = slidingSyncViewProxy.currentRoomsList().first(where: { $0.id == identifier }) else {
                 continue
             }
-
+            
             let oldRoom = rooms[index]
-            let newRoom = buildRoomSummaryForIdentifier(identifier)
+            let newRoom = buildRoomSummaryForIdentifier(identifier, invalidated: roomListEntry.isInvalidated)
 
             changes.append(.remove(offset: index, element: oldRoom, associatedWith: nil))
             changes.append(.insert(offset: index, element: newRoom, associatedWith: nil))
@@ -120,15 +121,11 @@ class RoomSummaryProvider: RoomSummaryProviderProtocol {
         
         MXLog.info("Finished applying diffs")
     }
-    
-    private func buildEmptyRoomSummary(forIdentifier identifier: String = UUID().uuidString) -> RoomSummary {
-        .empty(id: identifier)
-    }
-    
-    private func buildRoomSummaryForIdentifier(_ identifier: String) -> RoomSummary {
+        
+    private func buildRoomSummaryForIdentifier(_ identifier: String, invalidated: Bool) -> RoomSummary {
         guard let room = try? slidingSyncViewProxy.roomForIdentifier(identifier) else {
             MXLog.error("Failed finding room with id: \(identifier)")
-            return buildEmptyRoomSummary(forIdentifier: identifier)
+            return .empty
         }
         
         var attributedLastMessage: AttributedString?
@@ -145,23 +142,25 @@ class RoomSummaryProvider: RoomSummaryProviderProtocol {
             lastMessageTimestamp = lastMessage.timestamp
         }
         
-        return .filled(details: RoomSummaryDetails(id: room.roomId(),
-                                                   name: room.name() ?? room.roomId(),
-                                                   isDirect: room.isDm() ?? false,
-                                                   avatarURLString: room.fullRoom()?.avatarUrl(),
-                                                   lastMessage: attributedLastMessage,
-                                                   lastMessageTimestamp: lastMessageTimestamp,
-                                                   unreadNotificationCount: UInt(room.unreadNotifications().notificationCount())))
+        let details = RoomSummaryDetails(id: room.roomId(),
+                                         name: room.name() ?? room.roomId(),
+                                         isDirect: room.isDm() ?? false,
+                                         avatarURLString: room.fullRoom()?.avatarUrl(),
+                                         lastMessage: attributedLastMessage,
+                                         lastMessageTimestamp: lastMessageTimestamp,
+                                         unreadNotificationCount: UInt(room.unreadNotifications().notificationCount()))
+        
+        return invalidated ? .invalidated(details: details) : .filled(details: details)
     }
     
     private func buildSummaryForRoomListEntry(_ entry: RoomListEntry) -> RoomSummary {
         switch entry {
         case .empty:
-            return buildEmptyRoomSummary()
+            return .empty
         case .filled(let roomId):
-            return buildRoomSummaryForIdentifier(roomId)
+            return buildRoomSummaryForIdentifier(roomId, invalidated: false)
         case .invalidated(let roomId):
-            return buildRoomSummaryForIdentifier(roomId)
+            return buildRoomSummaryForIdentifier(roomId, invalidated: true)
         }
     }
     
@@ -236,3 +235,23 @@ extension RoomSummaryProviderState {
         }
     }
 }
+
+extension MatrixRustSDK.RoomListEntry {
+    var id: String? {
+        switch self {
+        case .empty:
+            return nil
+        case .invalidated(let roomId), .filled(let roomId):
+            return roomId
+        }
+    }
+    
+    var isInvalidated: Bool {
+        switch self {
+        case .invalidated:
+            return true
+        default:
+            return false
+        }
+    }
+}

ElementX/Sources/Services/Room/RoomSummary/RoomSummaryProviderProtocol.swift

@@ -16,6 +16,7 @@
 
 import Combine
 import Foundation
+import MatrixRustSDK
 
 enum RoomSummaryProviderState {
     case cold
@@ -24,25 +25,18 @@ enum RoomSummaryProviderState {
     case live
 }
 
-enum RoomSummary: Identifiable {
-    case empty(id: String)
+enum RoomSummary {
+    case empty
     case filled(details: RoomSummaryDetails)
+    case invalidated(details: RoomSummaryDetails)
     
-    var id: String {
+    var id: String? {
         switch self {
-        case .empty(let id):
-            return id
-        case .filled(let summary):
-            return summary.id
-        }
-    }
-    
-    var asFilled: RoomSummaryDetails? {
-        guard case let .filled(details) = self else {
+        case .empty:
             return nil
+        case .invalidated(let details), .filled(let details):
+            return details.id
         }
-        
-        return details
     }
 }