Use local room list sorting from Rust. (#2978)

* Switch to the new local room list sorting API * Get rid of the RoomSummary enum, replace it by the inner RoomSummaryDetails * And finally, rename RoomSummaryDetails to RoomSummary * Fix a bunch of warnings * Small tidy up post rebase/review. - Remove unused invalidated property. - Rename some RoomSummary instances to summary instead of details. - Fix tests with missing roomListItem's. * Update snapshots --------- Co-authored-by: Doug <douglase@element.io>
2026-11-06 12:28:29 +00:00 · 2024-07-05 12:10:53 +03:00
parent c024702d50
commit d71c8c4e83
26 changed files with 556 additions and 608 deletions
@@ -0,0 +1,85 @@
+//
+// Copyright 2024 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 XCTest
+
+@testable import ElementX
+
+class RoomSummaryTests: XCTestCase {
+    // swiftlint:disable:next large_tuple
+    let roomDetails: (id: String, name: String, avatarURL: URL) = ("room_id", "Room Name", "mxc://hs.tld/room/avatar")
+    let heroes = [UserProfileProxy(userID: "hero_1", displayName: "Hero 1", avatarURL: "mxc://hs.tld/user/avatar")]
+    
+    func testRoomAvatar() {
+        let details = makeSummary(isDirect: false, hasRoomAvatar: true)
+        
+        switch details.avatar {
+        case .room(let id, let name, let avatarURL):
+            XCTAssertEqual(id, roomDetails.id)
+            XCTAssertEqual(name, roomDetails.name)
+            XCTAssertEqual(avatarURL, roomDetails.avatarURL)
+        case .heroes:
+            XCTFail("A room shouldn't use the heroes for its avatar.")
+        }
+    }
+    
+    func testDMAvatarSet() {
+        let details = makeSummary(isDirect: true, hasRoomAvatar: true)
+        
+        switch details.avatar {
+        case .room(let id, let name, let avatarURL):
+            XCTAssertEqual(id, roomDetails.id)
+            XCTAssertEqual(name, roomDetails.name)
+            XCTAssertEqual(avatarURL, roomDetails.avatarURL)
+        case .heroes:
+            XCTFail("A DM with an avatar set shouldn't use the heroes instead.")
+        }
+    }
+    
+    func testDMAvatarNotSet() {
+        let details = makeSummary(isDirect: true, hasRoomAvatar: false)
+        
+        switch details.avatar {
+        case .room:
+            XCTFail("A DM without an avatar should defer to the hero for the correct placeholder tint colour.")
+        case .heroes(let heroes):
+            XCTAssertEqual(heroes, self.heroes)
+        }
+    }
+    
+    // MARK: - Helpers
+    
+    func makeSummary(isDirect: Bool, hasRoomAvatar: Bool) -> RoomSummary {
+        RoomSummary(roomListItem: .init(noPointer: .init()),
+                    id: roomDetails.id,
+                    isInvite: false,
+                    inviter: nil,
+                    name: roomDetails.name,
+                    isDirect: isDirect,
+                    avatarURL: hasRoomAvatar ? roomDetails.avatarURL : nil,
+                    heroes: heroes,
+                    lastMessage: nil,
+                    lastMessageFormattedTimestamp: nil,
+                    unreadMessagesCount: 0,
+                    unreadMentionsCount: 0,
+                    unreadNotificationsCount: 0,
+                    notificationMode: nil,
+                    canonicalAlias: nil,
+                    hasOngoingCall: false,
+                    isMarkedUnread: false,
+                    isFavourite: false)
+    }
+}