Archiving channels for the current user

[laevandus]

🔗 Issue Links

Part of IOS-553

🎯 Goal

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

📝 Summary

• Public API changes:
  • Add Chat.archive(scope:) and Chat.unarchive(scope:)
  • Add ChatChannelController.archive(scope:completion:) and ChatChannelController.unarchive(scope:completion:)
  • Add ChannelArchivingScope with only one supported option of me (archiving the channel for everyone is not supported)
  • Add FilterKey.archived for filtering channel lists
  • Add ChatChannel.membership.archivedAt
  • Add ChatChannel.isArchived
• Parse archived_at in member payloads
• Add supporting code for calling member's partial update with archive: true with the MemberUpdatePayload type or unsetting archived
• Demo app: added channel list filter for archived channels and archive and unarchive debug actions.

🛠 Implementation

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

Note: Archiving is per user. Meaning that if user A archives an channel with user B, then user B does not see it archived.

🧪 Manual Testing Notes

Archiving and unarchiving

1. Open the channel list
2. Archive a channel (debug menu > Archive channel)
   Result: Nothing happens because default channel list includes archived channels
3. Open "Filter channels" menu in the toolbar > Archived channels
   Result: archived channel is shown
4. Unarchive the channel
   Result: channel list is empty

Filtering archived channels

Open DemoAppCoordinator+DemoApp.swift:L98 and change the initial channels query to:

            channelListQuery = .init(
                filter: .and([
                    .containMembers(userIds: [userCredentials.id]),
                    .equal(.archived, to: false)
                ])
            )

1. Open the channel list
2. Archive a channel (debug menu > Archive channel)
   Result: Channel is removed because we filter out archived channels
3. Open "Filter channels" menu in the toolbar > Archived channels
   Result: Archived channel is shown
4. Unarchive the channel
   Result: Channel list is empty
5. Open "Filter channels" menu in the toolbar > Initial channels
6. The unarchived channel is part of the channel list

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

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

[Stream-SDK-Bot]

SDK Performance

target	metric	benchmark	branch	performance	status
MessageList	Hitches total duration	10 ms	3.34 ms	66.6% 🔼	🟢
	Duration	2.6 s	2.55 s	1.92% 🔼	🟢
	Hitch time ratio	4 ms per s	1.31 ms per s	67.25% 🔼	🟢
	Frame rate	75 fps	78.52 fps	4.69% 🔼	🟢
	Number of hitches	1	0.4	60.0% 🔼	🟢

[github-actions]

	2 Warnings
⚠️	Big PR
⚠️	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	7.0 MB	7.03 MB	+33 KB	🟢
StreamChatUI	4.77 MB	4.77 MB	0 KB	🟢

[nuno-vieira]

LGTM! ✅

[martinmitrevski]

LGTM ✅ Same comment about adding it to SwiftUI

[sonarcloud]

Quality Gate passed

Issues
170 New issues
0 Accepted issues

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

See analysis details on SonarQube Cloud