Pinning channels for the current user

[laevandus]

🔗 Issue Links

Part of IOS-553

🎯 Goal

Add a new feature enabling users to pin channels (pinned status is tied to the user, not a global action)

📝 Summary

• Public API changes:
  • Add Chat.pin(scope:) and Chat.unpin(scope:)
  • Add ChatChannelController.pin(scope:completion:) and ChatChannelController.unpin(scope:completion:)
  • Add ChannelPinningScope with only one supported option of me (pinning the channel for everyone is not supported)
  • Add FilterKey.pinned for filtering channel lists
  • Add ChannelListSortingKey.pinnedAt
  • Add ChatChannel.membership.pinnedAt
  • Add ChatChannel.isPinned
• Parse pinned_at in member payloads
• Add supporting code for calling member's partial update with pinned: true using the new MemberUpdatePayload type or unsetting pinned
• Updated the demo app and replaced the custom pinning support. Additionally added channel list filter for pinned channels.

🛠 Implementation

Pinning and unpinning works by calling partial update on the chat channel member (current user) and setting either pinned: true or unsetting this. Therefore, one could also use ChatChannelMemberController.partialUpdate(extraData:unsetProperties:completion:) where the user if is the current user id and extra data is ["pinned": .boolean(true)] or unsetProperties is set to ["pinned"]. New high-level pin and unpinning methods end up calling the same member updater's code, just make it more natural and discoverable.

Note: Pinning is per user. Meaning that if user A pins a channel with user B, then user B does not get the pinned state.

🧪 Manual Testing Notes

Pin and unpin channel

1. Open channel list
2. Pin a channel (debug menu > Pin channel)
   Result: Pinned channel gets a yellow background (demo app has a custom message cell)
3. Unpin the channel (debug menu > Unpin channel)
   Result: yellow background is removed

Querying pinned channels

1. Open channel list
2. Pin multiple channels (debug menu > Pin channel)
3. Open "Filter channels" menu in the toolbar > Pinned channels
   Result: Only pinned channels are displayed
4. Unpin a channel
   Result: channel list removes the unpinned channel

Sorting

Change the demo app: DemoAppCoordinator+DemoApp.swift:L98 to

channelListQuery = .init(
                filter: .containMembers(userIds: [userCredentials.id]),
                sort: [.init(key: .pinnedAt), .init(key: .default)]
            )

1. Launch the app
2. Pinning a channel moves it to the top of the list
3. Unpin a channel and the list is reordered again

☑️ 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
⚠️	Big PR

Generated by 🚫 Danger

[Stream-SDK-Bot]

SDK Size

title	develop	branch	diff	status
StreamChat	7.06 MB	7.07 MB	+17 KB	🟢
StreamChatUI	4.96 MB	4.96 MB	0 KB	🟢

[Stream-SDK-Bot]

SDK Performance

target	metric	benchmark	branch	performance	status
MessageList	Hitches total duration	10 ms	10.01 ms	-0.1% 🔽	🟡
	Duration	2.6 s	2.54 s	2.31% 🔼	🟢
	Hitch time ratio	4 ms per s	3.94 ms per s	1.5% 🔼	🟢
	Frame rate	75 fps	78.04 fps	4.05% 🔼	🟢
	Number of hitches	1	1.2	-20.0% 🔽	🔴

[Stream-SDK-Bot]

SDK Size

title	develop	branch	diff	status
StreamChat	6.98 MB	7.0 MB	+18 KB	🟢
StreamChatUI	4.77 MB	4.77 MB	0 KB	🟢

[martinmitrevski]

Looks good to me ✅ Can you also do this in the SwiftUI app? Most of the stuff is already in place.

[sonarcloud]

Quality Gate passed

Issues
169 New issues
0 Accepted issues

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

See analysis details on SonarQube Cloud

[nuno-vieira]

Out of scope (but not intended 😄 ) but in the future if we have global pinning, we might need to have more than 1 property to distinguish isPinned from local only or global only 🤔

[nuno-vieira]

Since this not meant to be used by the customer to perform switching it should be fine. But in theory, adding a new case would be a breaking change. But I guess it is fine in this case 👍

[nuno-vieira]

LGTM! ✅