Fix incorrect channel list sorting when sorted by .hasUnread (#3646)

* Fix incorrect channel list sorting when sorted by `.hasUnread`

* Update CHANGELOG.md

* Fix test

Author: nuno-vieira

CHANGELOG.md

@@ -6,6 +6,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 ## StreamChat
 ### 🐞 Fixed
 - Fix `FilterKey.id` not returning any channels in `ChannelListQuery` [#3643](https://github.com/GetStream/stream-chat-swift/pull/3643)
+- Fix incorrect channel list sorting when sorted by `.hasUnread` [#3646](https://github.com/GetStream/stream-chat-swift/pull/3646)
 
 ## StreamChatUI
 ### 🐞 Fixed

DemoApp/StreamChat/Components/DemoChatChannelListVC.swift

@@ -41,10 +41,23 @@ final class DemoChatChannelListVC: ChatChannelListVC {
         .equal(.hidden, to: true)
     ]))
 
-    lazy var unreadChannelsQuery: ChannelListQuery = .init(filter: .and([
-        .containMembers(userIds: [currentUserId]),
-        .hasUnread
-    ]), sort: [.init(key: .unreadCount, isAscending: false)])
+    lazy var unreadCountChannelsQuery: ChannelListQuery = .init(
+        filter: .and([
+            .containMembers(userIds: [currentUserId]),
+            .hasUnread
+        ]),
+        sort: [.init(key: .unreadCount, isAscending: false)]
+    )
+
+    lazy var sortedByHasUnreadChannelsQuery: ChannelListQuery = .init(
+        filter: .and([
+            .containMembers(userIds: [currentUserId])
+        ]),
+        sort: [
+            .init(key: .hasUnread, isAscending: false),
+            .init(key: .updatedAt, isAscending: false)
+        ]
+    )
 
     lazy var mutedChannelsQuery: ChannelListQuery = .init(filter: .and([
         .containMembers(userIds: [currentUserId]),
@@ -132,12 +145,21 @@ final class DemoChatChannelListVC: ChatChannelListVC {
             }
         )
 
-        let unreadChannelsAction = UIAlertAction(
-            title: "Unread Channels",
+        let unreadCountChannelsAction = UIAlertAction(
+            title: "Unread Count Channels",
+            style: .default,
+            handler: { [weak self] _ in
+                self?.title = "Unread Count Channels"
+                self?.setUnreadCountChannelsQuery()
+            }
+        )
+
+        let hasUnreadChannelsAction = UIAlertAction(
+            title: "Sorted hasUnread Channels",
             style: .default,
             handler: { [weak self] _ in
-                self?.title = "Unread Channels"
-                self?.setUnreadChannelsQuery()
+                self?.title = "Sorted hasUnread Channels"
+                self?.setSortedByHasUnreadChannelsQuery()
             }
         )
 
@@ -187,7 +209,8 @@ final class DemoChatChannelListVC: ChatChannelListVC {
             title: "Filter Channels",
             actions: [
                 defaultChannelsAction,
-                unreadChannelsAction,
+                unreadCountChannelsAction,
+                hasUnreadChannelsAction,
                 hiddenChannelsAction,
                 mutedChannelsAction,
                 coolChannelsAction,
@@ -204,8 +227,12 @@ final class DemoChatChannelListVC: ChatChannelListVC {
         replaceQuery(hiddenChannelsQuery)
     }
 
-    func setUnreadChannelsQuery() {
-        replaceQuery(unreadChannelsQuery)
+    func setUnreadCountChannelsQuery() {
+        replaceQuery(unreadCountChannelsQuery)
+    }
+
+    func setSortedByHasUnreadChannelsQuery() {
+        replaceQuery(sortedByHasUnreadChannelsQuery)
     }
 
     func setMutedChannelsQuery() {

Sources/StreamChat/Database/DTOs/ChannelDTO.swift

@@ -65,7 +65,11 @@ class ChannelDTO: NSManagedObject {
     @NSManaged var messages: Set<MessageDTO>
     @NSManaged var pinnedMessages: Set<MessageDTO>
     @NSManaged var reads: Set<ChannelReadDTO>
+
+    /// Helper properties used for sorting channels with unread counts of the current user.
     @NSManaged var currentUserUnreadMessagesCount: Int32
+    @NSManaged var hasUnreadSorting: Int16
+
     @NSManaged var watchers: Set<UserDTO>
     @NSManaged var memberListQueries: Set<ChannelMemberListQueryDTO>
     @NSManaged var previewMessage: MessageDTO?
@@ -82,12 +86,13 @@ class ChannelDTO: NSManagedObject {
         }
 
         // Update the unreadMessagesCount for the current user.
-        // At the moment this computed property is used for `hasUnread` automatic channel list filtering.
+        // At the moment this computed property is used for `hasUnread` and `unreadCount` automatic channel list filtering.
         if let currentUserId = managedObjectContext?.currentUser?.user.id {
             let currentUserUnread = reads.first(where: { $0.user.id == currentUserId })
             let newUnreadCount = currentUserUnread?.unreadMessageCount ?? 0
             if newUnreadCount != currentUserUnreadMessagesCount {
                 currentUserUnreadMessagesCount = newUnreadCount
+                hasUnreadSorting = newUnreadCount > 0 ? 1 : 0
             }
         }
 

Sources/StreamChat/Database/StreamChatModel.xcdatamodeld/StreamChatModel.xcdatamodel/contents

@@ -44,6 +44,7 @@
         <attribute name="defaultSortingAt" attributeType="Date" usesScalarValueType="NO" spotlightIndexingEnabled="YES"/>
         <attribute name="deletedAt" optional="YES" attributeType="Date" usesScalarValueType="NO"/>
         <attribute name="extraData" attributeType="Binary"/>
+        <attribute name="hasUnreadSorting" attributeType="Integer 16" defaultValueString="0" usesScalarValueType="YES"/>
         <attribute name="id" optional="YES" attributeType="String"/>
         <attribute name="imageURL" optional="YES" attributeType="URI"/>
         <attribute name="isBlocked" optional="YES" attributeType="Boolean" usesScalarValueType="YES"/>

Sources/StreamChat/Query/Sorting/ChannelListSortingKey.swift

@@ -63,7 +63,7 @@ public struct ChannelListSortingKey: SortingKey, Equatable {
     /// **Note:** If you want to sort by number of unreads, you should use the `unreadCount` sorting key.
     public static let hasUnread = Self(
         keyPath: \.hasUnread,
-        localKey: nil,
+        localKey: #keyPath(ChannelDTO.hasUnreadSorting),
         remoteKey: "has_unread"
     )
 

Tests/StreamChatTests/Controllers/ChannelListController/ChannelListController_Tests.swift

@@ -1632,6 +1632,51 @@ final class ChannelListController_Tests: XCTestCase {
         )
     }
 
+    func test_filterPredicate_sortedByHasUnread_returnsExpectedResults() throws {
+        let cid1 = ChannelId.unique
+        let cid2 = ChannelId.unique
+        let cid3 = ChannelId.unique
+        let cid4 = ChannelId.unique
+        let currentUserId = UserId.unique
+        let createdAt = Date()
+
+        try assertFilterPredicate(
+            .in(.cid, values: [cid1, cid2, cid3, cid4]),
+            sort: [
+                .init(key: .hasUnread, isAscending: false),
+                .init(key: .createdAt, isAscending: false)
+            ],
+            currentUserId: currentUserId,
+            channelsInDB: [
+                .dummy(
+                    channel: .dummy(cid: cid1, createdAt: createdAt.addingTimeInterval(100)),
+                    channelReads: [
+                        .init(
+                            user: .dummy(userId: currentUserId),
+                            lastReadAt: .unique,
+                            lastReadMessageId: nil,
+                            unreadMessagesCount: 3
+                        )
+                    ]
+                ),
+                .dummy(channel: .dummy(cid: cid3, createdAt: createdAt.addingTimeInterval(200))),
+                .dummy(channel: .dummy(cid: cid4, createdAt: createdAt.addingTimeInterval(300))),
+                .dummy(
+                    channel: .dummy(cid: cid2, createdAt: createdAt),
+                    channelReads: [
+                        .init(
+                            user: .dummy(userId: currentUserId),
+                            lastReadAt: .unique,
+                            lastReadMessageId: nil,
+                            unreadMessagesCount: 20
+                        )
+                    ]
+                )
+            ],
+            expectedResult: [cid2, cid1, cid3, cid4]
+        )
+    }
+
     func test_filterPredicate_muted_returnsExpectedResults() throws {
         let cid1 = ChannelId.unique
         let userId = memberId

Tests/StreamChatTests/Query/Sorting/ChannelListSortingKey_Tests.swift

@@ -74,9 +74,10 @@ final class ChannelListSortingKey_Tests: XCTestCase {
                 XCTAssertEqual(key.remoteKey, "cid")
                 XCTAssertFalse(key.requiresRuntimeSorting)
             case .hasUnread:
-                XCTAssertNil(key.sortDescriptor(isAscending: true))
+                XCTAssertNotNil(key.sortDescriptor(isAscending: false))
+                XCTAssertEqual(key.localKey, "hasUnreadSorting")
                 XCTAssertEqual(key.remoteKey, "has_unread")
-                XCTAssertTrue(key.requiresRuntimeSorting)
+                XCTAssertFalse(key.requiresRuntimeSorting)
             case .unreadCount:
                 XCTAssertNotNil(key.sortDescriptor(isAscending: true))
                 XCTAssertEqual(key.remoteKey, "unread_count")