Add support for filter tags in channels (#3886)

Author: laevandus

.swiftlint.yml

@@ -67,8 +67,8 @@ file_name_no_space:
 
 cyclomatic_complexity:
   ignores_case_statements: true
-  warning: 25
-  error: 30
+  warning: 30
+  error: 35
 
 custom_rules:
   regular_constraints_forbidden:

CHANGELOG.md

@@ -9,6 +9,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 - Add `ChatClient.deleteAttachment(remoteUrl:)` [#3883](https://github.com/GetStream/stream-chat-swift/pull/3883)
 - Add `CDNClient.deleteAttachment(remoteUrl:)` [#3883](https://github.com/GetStream/stream-chat-swift/pull/3883)
 - Add `heic`, `heif` and `svg` formats to the supported image file types [#3883](https://github.com/GetStream/stream-chat-swift/pull/3883)
+- Add support for filter tags in channels [#3886](https://github.com/GetStream/stream-chat-swift/pull/3886)
+  - Add `ChatChannel.filterTags`
+  - Add `filterTags` channel list filtering key
+  - Add `filterTags` argument to `ChatChannelController` and `Chat` factory methods in `ChatClient`
+  - Add `filterTags` argument to `ChatChannelController.updateChannel` and `ChatChannelController.partialUpdateChannel`
+  - Add `filterTags` argument to `Chat.update` and `Chat.updatePartial`
 ### 🐞 Fixed
 - Fix rare crash in `WebSocketClient.connectEndpoint` [#3882](https://github.com/GetStream/stream-chat-swift/pull/3882)
 - Fix audio recordings not playing from AirPods automatically [#3884](https://github.com/GetStream/stream-chat-swift/pull/3884)

DemoApp/StreamChat/Components/DemoChatChannelListRouter.swift

@@ -477,6 +477,14 @@ final class DemoChatChannelListRouter: ChatChannelListRouter {
                     }
                 }
             }),
+            .init(title: "Add Premium Tag", isEnabled: canUpdateChannel, handler: { [unowned self] _ in
+                channelController.partialChannelUpdate(filterTags: ["premium"]) { error in
+                    if let error = error {
+                        self.rootViewController.presentAlert(title: "Couldn't make the channel \(cid) premium", message: "\(error)")
+                    }
+                }
+            }),
+            
             .init(title: "Unmute channel", isEnabled: canMuteChannel, handler: { [unowned self] _ in
                 channelController.unmuteChannel { error in
                     if let error = error {

DemoApp/StreamChat/Components/DemoChatChannelListVC.swift

@@ -107,6 +107,8 @@ final class DemoChatChannelListVC: ChatChannelListVC {
     lazy var equalMembersQuery: ChannelListQuery = .init(filter:
         .equal(.members, values: [currentUserId, "r2-d2"])
     )
+    
+    lazy var premiumTaggedChannelsQuery: ChannelListQuery = .init(filter: .in(.filterTags, values: ["premium"]))
 
     var demoRouter: DemoChatChannelListRouter? {
         router as? DemoChatChannelListRouter
@@ -256,6 +258,15 @@ final class DemoChatChannelListVC: ChatChannelListVC {
             self?.title = "R2-D2 Channels (Equal Members)"
             self?.setEqualMembersChannelsQuery()
         }
+        
+        let taggedChannelsAction = UIAlertAction(
+            title: "Premium Tagged Channels",
+            style: .default,
+            handler: { [weak self] _ in
+                self?.title = "Premium Tagged Channels"
+                self?.setPremiumTaggedChannelsQuery()
+            }
+        )
 
         presentAlert(
             title: "Filter Channels",
@@ -271,7 +282,8 @@ final class DemoChatChannelListVC: ChatChannelListVC {
                 pinnedChannelsAction,
                 archivedChannelsAction,
                 equalMembersAction,
-                channelRoleChannelsAction
+                channelRoleChannelsAction,
+                taggedChannelsAction
             ].sorted(by: { $0.title ?? "" < $1.title ?? "" }),
             preferredStyle: .actionSheet,
             sourceView: filterChannelsButton
@@ -327,6 +339,10 @@ final class DemoChatChannelListVC: ChatChannelListVC {
     func setEqualMembersChannelsQuery() {
         replaceQuery(equalMembersQuery)
     }
+    
+    func setPremiumTaggedChannelsQuery() {
+        replaceQuery(premiumTaggedChannelsQuery)
+    }
 
     func setInitialChannelsQuery() {
         replaceQuery(initialQuery)

Sources/StreamChat/APIClient/Endpoints/Payloads/ChannelCodingKeys.swift

@@ -42,6 +42,7 @@ public enum ChannelCodingKeys: String, CodingKey, CaseIterable {
     case members
     /// Invites.
     case invites
+    case filterTags = "filter_tags"
     /// The team the channel belongs to.
     case team
     case memberCount = "member_count"

Sources/StreamChat/APIClient/Endpoints/Payloads/ChannelEditDetailPayload.swift

@@ -12,6 +12,7 @@ struct ChannelEditDetailPayload: Encodable {
     let team: String?
     let members: Set<UserId>
     let invites: Set<UserId>
+    let filterTags: Set<String>
     let extraData: [String: RawJSON]
 
     init(
@@ -21,6 +22,7 @@ struct ChannelEditDetailPayload: Encodable {
         team: String?,
         members: Set<UserId>,
         invites: Set<UserId>,
+        filterTags: Set<String>,
         extraData: [String: RawJSON]
     ) {
         id = cid.id
@@ -30,6 +32,7 @@ struct ChannelEditDetailPayload: Encodable {
         self.team = team
         self.members = members
         self.invites = invites
+        self.filterTags = filterTags
         self.extraData = extraData
     }
 
@@ -40,6 +43,7 @@ struct ChannelEditDetailPayload: Encodable {
         team: String?,
         members: Set<UserId>,
         invites: Set<UserId>,
+        filterTags: Set<String>,
         extraData: [String: RawJSON]
     ) {
         id = nil
@@ -49,6 +53,7 @@ struct ChannelEditDetailPayload: Encodable {
         self.team = team
         self.members = members
         self.invites = invites
+        self.filterTags = filterTags
         self.extraData = extraData
     }
 
@@ -63,6 +68,10 @@ struct ChannelEditDetailPayload: Encodable {
             allMembers = allMembers.union(invites)
             try container.encode(invites, forKey: .invites)
         }
+        
+        if !filterTags.isEmpty {
+            try container.encode(filterTags, forKey: .filterTags)
+        }
 
         if !allMembers.isEmpty {
             try container.encode(allMembers, forKey: .members)

Sources/StreamChat/APIClient/Endpoints/Payloads/ChannelListPayload.swift

@@ -127,6 +127,7 @@ struct ChannelDetailPayload {
     let createdBy: UserPayload?
     /// A config.
     let config: ChannelConfig
+    let filterTags: [String]?
     /// The list of actions that the current user can perform in a channel.
     /// It is optional, since not all events contain the own capabilities property for performance reasons.
     let ownCapabilities: [String]?
@@ -188,6 +189,7 @@ extension ChannelDetailPayload: Decodable {
             truncatedAt: try container.decodeIfPresent(Date.self, forKey: .truncatedAt),
             createdBy: try container.decodeIfPresent(UserPayload.self, forKey: .createdBy),
             config: try container.decode(ChannelConfig.self, forKey: .config),
+            filterTags: try container.decodeIfPresent([String].self, forKey: .filterTags),
             ownCapabilities: try container.decodeIfPresent([String].self, forKey: .ownCapabilities),
             isDisabled: try container.decode(Bool.self, forKey: .disabled),
             isFrozen: try container.decode(Bool.self, forKey: .frozen),

Sources/StreamChat/Controllers/ChannelController/ChannelController.swift

@@ -253,6 +253,7 @@ public class ChatChannelController: DataController, DelegateCallable, DataStoreP
     ///   - team: New team.
     ///   - members: New members.
     ///   - invites: New invites.
+    ///   - filterTags: A list of tags to add to the channel.
     ///   - extraData: New `ExtraData`.
     ///   - completion: The completion. Will be called on a **callbackQueue** when the network request is finished.
     ///                 If request fails, the completion will be called with an error.
@@ -263,6 +264,7 @@ public class ChatChannelController: DataController, DelegateCallable, DataStoreP
         team: String?,
         members: Set<UserId> = [],
         invites: Set<UserId> = [],
+        filterTags: Set<String> = [],
         extraData: [String: RawJSON] = [:],
         completion: ((Error?) -> Void)? = nil
     ) {
@@ -279,6 +281,7 @@ public class ChatChannelController: DataController, DelegateCallable, DataStoreP
             team: team,
             members: members,
             invites: invites,
+            filterTags: filterTags,
             extraData: extraData
         )
 
@@ -295,6 +298,7 @@ public class ChatChannelController: DataController, DelegateCallable, DataStoreP
     ///   - team: New team.
     ///   - members: New members.
     ///   - invites: New invites.
+    ///   - filterTags: A list of tags to add to the channel.
     ///   - extraData: New `ExtraData`.
     ///   - unsetProperties: Properties from the channel that are going to be cleared/unset.
     ///   - completion: The completion. Will be called on a **callbackQueue** when the network request is finished.
@@ -306,6 +310,7 @@ public class ChatChannelController: DataController, DelegateCallable, DataStoreP
         team: String? = nil,
         members: Set<UserId> = [],
         invites: Set<UserId> = [],
+        filterTags: Set<String> = [],
         extraData: [String: RawJSON] = [:],
         unsetProperties: [String] = [],
         completion: ((Error?) -> Void)? = nil
@@ -323,6 +328,7 @@ public class ChatChannelController: DataController, DelegateCallable, DataStoreP
             team: team,
             members: members,
             invites: invites,
+            filterTags: filterTags,
             extraData: extraData
         )
 

Sources/StreamChat/Controllers/ChannelController/ChatClient+ChannelController.swift

@@ -65,6 +65,7 @@ public extension ChatClient {
     ///   - isCurrentUserMember: If set to `true` the current user will be included into the channel. Is `true` by default.
     ///   - messageOrdering: Describes the ordering the messages are presented.
     ///   - invites: IDs for the new channel invitees.
+    ///   - filterTags: A list of tags to add to the channel.
     ///   - extraData: Extra data for the new channel.
     ///   - channelListQuery: The channel list query the channel this controller represents is part of.
     /// - Throws: `ClientError.CurrentUserDoesNotExist` if there is no currently logged-in user.
@@ -78,6 +79,7 @@ public extension ChatClient {
         isCurrentUserMember: Bool = true,
         messageOrdering: MessageOrdering = .topToBottom,
         invites: Set<UserId> = [],
+        filterTags: Set<String> = [],
         extraData: [String: RawJSON] = [:],
         channelListQuery: ChannelListQuery? = nil
     ) throws -> ChatChannelController {
@@ -92,6 +94,7 @@ public extension ChatClient {
             team: team,
             members: members.union(isCurrentUserMember ? [currentUserId] : []),
             invites: invites,
+            filterTags: filterTags,
             extraData: extraData
         )
 
@@ -119,6 +122,7 @@ public extension ChatClient {
     ///   - name: The new channel name.
     ///   - imageURL: The new channel avatar URL.
     ///   - team: Team for the new channel.
+    ///   - filterTags: A list of tags to add to the channel.
     ///   - extraData: Extra data for the new channel.
     ///   - channelListQuery: The channel list query the channel this controller represents is part of.
     ///
@@ -134,6 +138,7 @@ public extension ChatClient {
         name: String? = nil,
         imageURL: URL? = nil,
         team: String? = nil,
+        filterTags: Set<String> = [],
         extraData: [String: RawJSON],
         channelListQuery: ChannelListQuery? = nil
     ) throws -> ChatChannelController {
@@ -147,6 +152,7 @@ public extension ChatClient {
             team: team,
             members: members.union(isCurrentUserMember ? [currentUserId] : []),
             invites: [],
+            filterTags: filterTags,
             extraData: extraData
         )
         return .init(

Sources/StreamChat/Controllers/ChannelController/LivestreamChannelController.swift

@@ -1139,6 +1139,7 @@ public class LivestreamChannelController: DataStoreProvider, EventsControllerDel
             isHidden: event.channel.isHidden,
             createdBy: event.channel.createdBy,
             config: event.channel.config,
+            filterTags: event.channel.filterTags,
             ownCapabilities: event.channel.ownCapabilities,
             isFrozen: event.channel.isFrozen,
             isDisabled: event.channel.isDisabled,