feat(llc, persistence): add support for filter_tags in channel (#2461)

Author: xsahil03x

packages/stream_chat/CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ✅ Added
 
+- Added support for `filterTags` in channels.
 - Added support for `Channel.markUnreadByTimestamp` and `Client.markChannelUnreadByTimestamp`
   methods to mark all messages after a given timestamp as unread.
 - Added support for `hideHistoryBefore` in `Channel.addMembers` and `Client.addChannelMembers` to

packages/stream_chat/lib/src/client/channel.dart

@@ -432,6 +432,14 @@ class Channel {
     return state!.channelStateStream.map((cs) => cs.channel?.messageCount);
   }
 
+  /// List of filter tags applied to this channel.
+  ///
+  /// Generally used for filtering channels while querying.
+  List<String>? get filterTags {
+    _checkInitialized();
+    return state!._channelState.channel?.filterTags;
+  }
+
   /// Channel id.
   String? get id => state?._channelState.channel?.id ?? _id;
 

packages/stream_chat/lib/src/core/models/channel_model.dart

@@ -32,6 +32,7 @@ class ChannelModel {
     bool? hidden,
     DateTime? truncatedAt,
     this.messageCount,
+    this.filterTags,
   })  : assert(
           (cid != null && cid.contains(':')) || (id != null && type != null),
           'provide either a cid or an id and type',
@@ -159,6 +160,12 @@ class ChannelModel {
   @JsonKey(includeToJson: false)
   final int? messageCount;
 
+  /// List of filter tags applied to the channel.
+  ///
+  /// This is generally used for querying filtered channels based on tags.
+  @JsonKey(includeToJson: false)
+  final List<String>? filterTags;
+
   /// Known top level fields.
   /// Useful for [Serializer] methods.
   static const topLevelFields = [
@@ -178,6 +185,7 @@ class ChannelModel {
     'team',
     'cooldown',
     'message_count',
+    'filter_tags',
   ];
 
   /// Serialize to json
@@ -207,6 +215,7 @@ class ChannelModel {
     bool? hidden,
     DateTime? truncatedAt,
     int? messageCount,
+    List<String>? filterTags,
   }) =>
       ChannelModel(
         id: id ?? this.id,
@@ -234,6 +243,7 @@ class ChannelModel {
                 : DateTime.parse(extraData?['truncated_at'] as String)) ??
             this.truncatedAt,
         messageCount: messageCount ?? this.messageCount,
+        filterTags: filterTags ?? this.filterTags,
       );
 
   /// Returns a new [ChannelModel] that is a combination of this channelModel
@@ -261,6 +271,7 @@ class ChannelModel {
       hidden: other.hidden,
       truncatedAt: other.truncatedAt,
       messageCount: other.messageCount,
+      filterTags: other.filterTags,
     );
   }
 }

packages/stream_chat/lib/src/core/models/channel_model.g.dart

@@ -6357,6 +6357,71 @@ void main() {
     });
   });
 
+  group('Channel filterTags', () {
+    late final client = MockStreamChatClient();
+    const channelId = 'test-channel-id';
+    const channelType = 'test-channel-type';
+
+    setUpAll(() {
+      // detached loggers
+      when(() => client.detachedLogger(any())).thenAnswer((invocation) {
+        final name = invocation.positionalArguments.first;
+        return _createLogger(name);
+      });
+
+      final retryPolicy = RetryPolicy(
+        shouldRetry: (_, __, ___) => false,
+        delayFactor: Duration.zero,
+      );
+      when(() => client.retryPolicy).thenReturn(retryPolicy);
+
+      // fake clientState
+      final clientState = FakeClientState();
+      when(() => client.state).thenReturn(clientState);
+
+      // client logger
+      when(() => client.logger).thenReturn(_createLogger('mock-client-logger'));
+    });
+
+    test('should return filterTags from channel state', () {
+      final channelModel = ChannelModel(
+        id: channelId,
+        type: channelType,
+        filterTags: ['tag1', 'tag2'],
+      );
+
+      final channelState = ChannelState(channel: channelModel);
+      final testChannel = Channel.fromState(client, channelState);
+      addTearDown(testChannel.dispose);
+
+      expect(testChannel.filterTags, equals(['tag1', 'tag2']));
+    });
+
+    test('should update filterTags when channel state is updated', () {
+      final channelModel = ChannelModel(
+        id: channelId,
+        type: channelType,
+        filterTags: ['tag1', 'tag2'],
+      );
+
+      final channelState = ChannelState(channel: channelModel);
+      final testChannel = Channel.fromState(client, channelState);
+      addTearDown(testChannel.dispose);
+
+      expect(testChannel.filterTags, equals(['tag1', 'tag2']));
+
+      final updatedChannel = channelModel.copyWith(
+        filterTags: ['tag3', 'tag4', 'tag5'],
+      );
+
+      testChannel.state?.updateChannelState(
+        testChannel.state!.channelState.copyWith(channel: updatedChannel),
+      );
+
+      expect(testChannel.filterTags, equals(['tag3', 'tag4', 'tag5']));
+    });
+  });
+
   group('Typing Indicator', () {
     const channelId = 'test-channel-id';
     const channelType = 'test-channel-type';

packages/stream_chat/test/src/client/channel_test.dart

@@ -317,4 +317,14 @@ void main() {
 
     expect(channel.truncatedAt, isNull);
   });
+
+  test('should parse filterTags from json correctly', () {
+    final channel = ChannelModel.fromJson({
+      'id': 'test',
+      'type': 'livestream',
+      'filter_tags': ['tag1', 'tag2', 'tag3'],
+    });
+
+    expect(channel.filterTags, equals(['tag1', 'tag2', 'tag3']));
+  });
 }

packages/stream_chat/test/src/core/models/channel_test.dart

@@ -1,3 +1,9 @@
+## Upcoming
+
+✅ Added
+
+- Added support for `ChannelModel.filterTags` field.
+
 ## 9.21.0
 
 - Updated `stream_chat` dependency to [`9.21.0`](https://pub.dev/packages/stream_chat/changelog).

packages/stream_chat_persistence/CHANGELOG.md

@@ -55,7 +55,7 @@ class DriftChatDatabase extends _$DriftChatDatabase {
 
   // you should bump this number whenever you change or add a table definition.
   @override
-  int get schemaVersion => 26;
+  int get schemaVersion => 27;
 
   @override
   MigrationStrategy get migration => MigrationStrategy(