Add FilterKey.members and support for equal operator to match an array

[laevandus]

🔗 Issue Links

Resolves IOS-609

🎯 Goal

Enable filtering channel list with $eq and an array of channel member ids

📝 Summary

• Add FilterKey.members
• Add support for $eq to match an array of values

🛠 Implementation

Filtering by members supports $in and $eq operators. We did not expose the latter. For supporting it, some changes were required for enabling Core Data to match channels with $eq and an array of values.

🎨 Showcase

🧪 Manual Testing Notes

1. Log in with chewbacca
2. Try different channel queries (R2-D2 Channels uses the new members equals query and returns all the channels where members equal to current user and r2-d2)

Example snippet

DispatchQueue.main.asyncAfter(deadline: .now() + .seconds(5)) {
    Task {
        let query = ChannelListQuery(filter: .equal(.members, values: ["chewbacca", "luke_skywalker"]))
        let channelList = self.makeChannelList(with: query)
        try await channelList.get()
        let channels = channelList.state.channels
        for channel in channels {
            print(channel.cid, channel.memberCount, channel.lastActiveMembers.map(\.id).sorted())
        }
    }
}

☑️ 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)

[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.56 s	1.54% 🔼	🟢
	Hitch time ratio	4 ms per s	2.63 ms per s	34.25% 🔼	🟢
	Frame rate	75 fps	78.09 fps	4.12% 🔼	🟢
	Number of hitches	1	0.6	40.0% 🔼	🟢

[Stream-SDK-Bot]

SDK Size

title	develop	branch	diff	status
StreamChat	7.03 MB	7.03 MB	0 KB	🟢
StreamChatUI	4.77 MB	4.77 MB	0 KB	🟢

[martinmitrevski]

LGTM ✅ Also, please update the docs in the LLC

[nuno-vieira]

Shouldn't we expose something like equalMembers(userIds:) since only $eq and $in operator are supported?

[laevandus]

It feels more closer to public docs if we allow using it directly. But I am lacking some historic knowledge on channel list filters so not sure what is best here.

[laevandus]

With other keys we can create incompatible combinations.

[nuno-vieira]

Yeah, my guess is that for some properties, we started limiting the operators, especially for performance reasons. But for other properties we did not follow the same approach.

IMO, it would be better that programmatically you could only use the operators that you are allowed to, and that it would not require you to look into docs to see which operators are supported. It would be better to just limit every field but now it is kinda too late, since we already expose most of them :/

So yeah, maybe it is better we open up this one for consistency

[laevandus]

Since we have that containMembers, maybe it is better then to have equalMembers. Hmm

[sonarqubecloud]

Quality Gate passed

Issues
172 New issues
0 Accepted issues

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

See analysis details on SonarQube Cloud