recent-dms: Exclude DM conversations with muted users

Conversations are excluded where all other recipients are muted.

Author: sm-sayedi

lib/model/recent_dm_conversations.dart

@@ -8,6 +8,7 @@ import '../api/model/model.dart';
 import '../api/model/events.dart';
 import 'narrow.dart';
 import 'store.dart';
+import 'user.dart';
 
 /// A view-model for the recent-DM-conversations UI.
 ///
@@ -17,6 +18,7 @@ class RecentDmConversationsView extends PerAccountStoreBase with ChangeNotifier
   factory RecentDmConversationsView({
     required CorePerAccountStore core,
     required List<RecentDmConversation> initial,
+    required UserStore userStore,
   }) {
     final entries = initial.map((conversation) => MapEntry(
         DmNarrow.ofRecentDmConversation(conversation, selfUserId: core.selfUserId),
@@ -35,6 +37,7 @@ class RecentDmConversationsView extends PerAccountStoreBase with ChangeNotifier
 
     return RecentDmConversationsView._(
       core: core,
+      userStore: userStore,
       map: Map.fromEntries(entries),
       sorted: QueueList.from(entries.map((e) => e.key)),
       latestMessagesByRecipient: latestMessagesByRecipient,
@@ -43,11 +46,14 @@ class RecentDmConversationsView extends PerAccountStoreBase with ChangeNotifier
 
   RecentDmConversationsView._({
     required super.core,
+    required this.userStore,
     required this.map,
     required this.sorted,
     required this.latestMessagesByRecipient,
   });
 
+  final UserStore userStore;
+
   /// The latest message ID in each conversation.
   final Map<DmNarrow, int> map;
 
@@ -63,6 +69,11 @@ class RecentDmConversationsView extends PerAccountStoreBase with ChangeNotifier
   /// it might have been sent by anyone in its conversation.)
   final Map<int, int> latestMessagesByRecipient;
 
+  /// Same as [sorted] but excluding conversations where all the recipients are
+  /// muted.
+  QueueList<DmNarrow> get sortedFiltered => QueueList.from(
+    sorted.whereNot((narrow) => userStore.ignoreConversation(narrow)));
+
   /// Insert the key at the proper place in [sorted].
   ///
   /// Optimized, taking O(1) time, for the case where that place is the start,

lib/model/store.dart

@@ -471,6 +471,7 @@ class PerAccountStore extends PerAccountStoreBase with ChangeNotifier, EmojiStor
       accountId: accountId,
       selfUserId: account.userId,
     );
+    final users = UserStoreImpl(core: core, initialSnapshot: initialSnapshot);
     final channels = ChannelStoreImpl(initialSnapshot: initialSnapshot);
     return PerAccountStore._(
       core: core,
@@ -496,7 +497,7 @@ class PerAccountStore extends PerAccountStoreBase with ChangeNotifier, EmojiStor
         typingStartedWaitPeriod: Duration(
           milliseconds: initialSnapshot.serverTypingStartedWaitPeriodMilliseconds),
       ),
-      users: UserStoreImpl(core: core, initialSnapshot: initialSnapshot),
+      users: users,
       typingStatus: TypingStatus(core: core,
         typingStartedExpiryPeriod: Duration(milliseconds: initialSnapshot.serverTypingStartedExpiryPeriodMilliseconds),
       ),
@@ -508,8 +509,11 @@ class PerAccountStore extends PerAccountStoreBase with ChangeNotifier, EmojiStor
         core: core,
         channelStore: channels,
       ),
-      recentDmConversationsView: RecentDmConversationsView(core: core,
-        initial: initialSnapshot.recentPrivateConversations),
+      recentDmConversationsView: RecentDmConversationsView(
+        core: core,
+        initial: initialSnapshot.recentPrivateConversations,
+        userStore: users,
+      ),
       recentSenders: RecentSenders(),
     );
   }

lib/model/user.dart

@@ -4,6 +4,7 @@ import '../api/model/events.dart';
 import '../api/model/initial_snapshot.dart';
 import '../api/model/model.dart';
 import 'localizations.dart';
+import 'narrow.dart';
 import 'store.dart';
 
 /// The portion of [PerAccountStore] describing the users in the realm.
@@ -78,6 +79,18 @@ mixin UserStore on PerAccountStoreBase {
   /// By default, looks for the user id in [UserStore.mutedUsers] unless
   /// [mutedUsers] is non-null, in which case looks in the latter.
   bool isUserMuted(int id, {Set<int>? mutedUsers});
+
+  /// Ignores conversation where all of the users corresponding to
+  /// [DmNarrow.otherRecipientIds] are muted by [selfUser].
+  ///
+  /// Returns false for self-1:1 conversation.
+  ///
+  /// By default, looks for the recipients in [UserStore.mutedUsers] unless
+  /// [mutedUsers] is non-null, in which case looks in the latter.
+  bool ignoreConversation(DmNarrow narrow, {Set<int>? mutedUsers}) {
+    if (narrow.otherRecipientIds.isEmpty) return false;
+    return !narrow.otherRecipientIds.any((id) => !isUserMuted(id, mutedUsers: mutedUsers));
+  }
 }
 
 /// The implementation of [UserStore] that does the work.

lib/widgets/recent_dm_conversations.dart

@@ -49,7 +49,7 @@ class _RecentDmConversationsPageBodyState extends State<RecentDmConversationsPag
 
   @override
   Widget build(BuildContext context) {
-    final sorted = model!.sorted;
+    final sorted = model!.sortedFiltered;
     return SafeArea(
       // Don't pad the bottom here; we want the list content to do that.
       bottom: false,

test/model/recent_dm_conversations_checks.dart

@@ -6,6 +6,7 @@ import 'package:zulip/model/recent_dm_conversations.dart';
 extension RecentDmConversationsViewChecks on Subject<RecentDmConversationsView> {
   Subject<Map<DmNarrow, int>> get map => has((v) => v.map, 'map');
   Subject<QueueList<DmNarrow>> get sorted => has((v) => v.sorted, 'sorted');
+  Subject<QueueList<DmNarrow>> get sortedFiltered => has((v) => v.sortedFiltered, 'sortedFiltered');
   Subject<Map<int, int>> get latestMessagesByRecipient => has(
     (v) => v.latestMessagesByRecipient, 'latestMessagesByRecipient');
 }

test/model/recent_dm_conversations_test.dart

@@ -1,6 +1,7 @@
 import 'package:checks/checks.dart';
 import 'package:test/scaffolding.dart';
 import 'package:zulip/api/model/initial_snapshot.dart';
+import 'package:zulip/api/model/model.dart';
 import 'package:zulip/model/narrow.dart';
 import 'package:zulip/model/recent_dm_conversations.dart';
 
@@ -24,6 +25,7 @@ void main() {
       ))).recentDmConversationsView
           ..map.isEmpty()
           ..sorted.isEmpty()
+          ..sortedFiltered.isEmpty()
           ..latestMessagesByRecipient.isEmpty();
 
       check(eg.store(initialSnapshot: eg.initialSnapshot(
@@ -38,7 +40,45 @@ void main() {
             key([1]):    100,
           })
           ..sorted.deepEquals([key([1, 2]), key([]), key([1])])
+          ..sortedFiltered.deepEquals([key([1, 2]), key([]), key([1])])
           ..latestMessagesByRecipient.deepEquals({1: 300, 2: 300});
+
+      check(eg.store(initialSnapshot: eg.initialSnapshot(
+        recentPrivateConversations: [
+          RecentDmConversation(userIds: [],     maxMessageId: 200),
+          RecentDmConversation(userIds: [1],    maxMessageId: 100),
+          RecentDmConversation(userIds: [2],    maxMessageId: 400),
+          RecentDmConversation(userIds: [2, 1], maxMessageId: 300), // userIds out of order
+          RecentDmConversation(userIds: [1, 3], maxMessageId: 500),
+          RecentDmConversation(userIds: [2, 4], maxMessageId: 600),
+        ],
+        mutedUsers: [
+          MutedUserItem(id: 1),
+          MutedUserItem(id: 3),
+        ]))).recentDmConversationsView
+          ..map.deepEquals({
+            key([2, 4]): 600,
+            key([1, 3]): 500,
+            key([2]):    400,
+            key([1, 2]): 300,
+            key([]):     200,
+            key([1]):    100,
+          })
+          ..sorted.deepEquals([
+            key([2, 4]),
+            key([1, 3]),
+            key([2]),
+            key([1, 2]),
+            key([]),
+            key([1]),
+          ])
+          ..sortedFiltered.deepEquals([
+            key([2, 4]),
+            key([2]),
+            key([1, 2]),
+            key([]),
+          ])
+          ..latestMessagesByRecipient.deepEquals({1: 500, 2: 600, 3: 500, 4: 600});
     });
 
     group('message event (new message)', () {

test/widgets/recent_dm_conversations_test.dart

@@ -211,6 +211,12 @@ void main() {
       group('1:1', () {
         group('has right title/avatar', () {
           for (final isUserMuted in [false, true]) {
+            if (isUserMuted) {
+              // Right now, we don't show DM conversations where all other
+              // recipients are muted.
+              continue;
+            }
+
             testWidgets(isUserMuted ? 'muted user' : 'normal user', (tester) async {
               final user = eg.user(userId: 1);
               final message = eg.dmMessage(from: eg.selfUser, to: [user]);
@@ -275,6 +281,12 @@ void main() {
 
         group('has right title/avatar', () {
           for (final areUsersMuted in [false, true]) {
+            if (areUsersMuted) {
+              // Right now, we don't show DM conversations where all other
+              // recipients are muted.
+              continue;
+            }
+
             testWidgets(areUsersMuted ? 'muted users' : 'normal users', (tester) async {
               final users = usersList(2);
               final user0 = users[0];