Add Channel List .hasUnread filter

[nuno-vieira]

🔗 Issue Links

Resolves https://stream-io.atlassian.net/browse/PBE-5351

🎯 Goal

• Expose .hasUnread channel list filter option
• Fix sorting channel list by unread count

🛠 Implementation

In order to support automatic filtering, I had to add a new property to ChannelDTO.currentUserUnreadMessagesCount which is computed from ChannelDTO.reads. Otherwise, it was not possible to create an NSPredicate out of ChannelDTO.reads.

By adding this property, we can now make the sorting of unreadCount work properly, which was not working before as well.

🎨 Showcase

Usage: ChannelListQuery(filter: .hasUnread)

Demo:

Unreads.mov

🧪 Manual Testing Notes

Requirements: Use the SwiftUI API Keys. (The hasUnread is not working on the default keys)

1- Login
2- Tap on filters button (right top corner)
3- Tap on Unread Channels
4- Should see only unread channels and sorted by unread count

☑️ Contributor Checklist

• I have signed the Stream CLA (required)
• This change should be manually QAed
• Changelog is updated with client-facing changes
• Changelog is updated with new localization keys
• New code is covered by unit tests
• Comparison screenshots added for visual changes
• Affected documentation updated (docusaurus, tutorial, CMS)

[github-actions]

	1 Warning
⚠️	The changes should be manually QAed before the Pull Request will be merged

Generated by 🚫 Danger

[Stream-SDK-Bot]

SDK Size

title	develop	branch	diff	status
StreamChat	6.8MB	6.8MB	0.0MB	🟢
StreamChatUI	4.4MB	4.4MB	0.0MB	🟢

[Stream-SDK-Bot]

SDK Performance

target	metric	benchmark	branch	performance	status
MessageList	Hitches total duration	10 ms	6.68 ms	33.2% 🔼	🟢
	Duration	2.6 s	2.54 s	2.31% 🔼	🟢
	Hitch time ratio	4 ms per s	2.62 ms per s	34.5% 🔼	🟢
	Frame rate	75 fps	78.23 fps	4.31% 🔼	🟢
	Number of hitches	1	0.6	40.0% 🔼	🟢
ChannelList	Hitches total duration	12.5 ms	15.86 ms	-26.88% 🔽	🔴
	Duration	2.6 s	2.55 s	1.92% 🔼	🟢
	Hitch time ratio	5 ms per s	6.23 ms per s	-24.6% 🔽	🔴
	Frame rate	72 fps	74.21 fps	3.07% 🔼	🟢
	Number of hitches	1.2	1.4	-16.67% 🔽	🔴

[martinmitrevski]

LGTM ✅

[Stream-SDK-Bot]

SDK Size

title	develop	branch	diff	status
StreamChat	6.76MB	6.76MB	0.0MB	🟢
StreamChatUI	4.41MB	4.41MB	0.0MB	🟢

[sonarqubecloud]

Quality Gate passed

Issues
151 New issues
0 Accepted issues

Measures
0 Security Hotspots
84.3% Coverage on New Code
0.1% Duplication on New Code

See analysis details on SonarCloud