recent-dms: Exclude DM conversations where all other recipients are muted

Co-authored-by: Sayed Mahmood Sayedi <[email protected]>

Author: chrisbobbe

lib/model/user.dart

@@ -2,6 +2,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.
@@ -85,6 +86,17 @@ mixin UserStore on PerAccountStoreBase {
   /// Looks for [userId] in a private [Set],
   /// or in [mutedUsers] instead if that's non-null.
   bool isUserMuted(int userId, {Set<int>? mutedUsers});
+
+  /// Whether the self-user has muted everyone in [narrow].
+  ///
+  /// Returns false for the self-DM.
+  ///
+  /// Calls [isUserMuted] for each participant, passing along [mutedUsers].
+  bool shouldMuteDmConversation(DmNarrow narrow, {Set<int>? mutedUsers}) {
+    if (narrow.otherRecipientIds.isEmpty) return false;
+    return narrow.otherRecipientIds.every(
+      (userId) => isUserMuted(userId, mutedUsers: mutedUsers));
+  }
 }
 
 /// The implementation of [UserStore] that does the work.

lib/widgets/recent_dm_conversations.dart

@@ -48,6 +48,7 @@ class _RecentDmConversationsPageBodyState extends State<RecentDmConversationsPag
 
   @override
   Widget build(BuildContext context) {
+    final store = PerAccountStoreWidget.of(context);
     final sorted = model!.sorted;
     return SafeArea(
       // Don't pad the bottom here; we want the list content to do that.
@@ -56,6 +57,12 @@ class _RecentDmConversationsPageBodyState extends State<RecentDmConversationsPag
         itemCount: sorted.length,
         itemBuilder: (context, index) {
           final narrow = sorted[index];
+          if (store.shouldMuteDmConversation(narrow)) {
+            // Filter out conversations where everyone is muted.
+            // TODO should we offer a "spam folder"-style summary screen
+            //   for these conversations we're filtering out?
+            return SizedBox.shrink();
+          }
           return RecentDmConversationsItem(
             narrow: narrow,
             unreadCount: unreadsModel!.countInDmNarrow(narrow),
@@ -88,9 +95,6 @@ class RecentDmConversationsItem extends StatelessWidget {
         title = store.selfUser.fullName;
         avatar = AvatarImage(userId: store.selfUserId, size: _avatarSize);
       case [var otherUserId]:
-        // TODO(#296) actually don't show this row if the user is muted?
-        //   (should we offer a "spam folder" style summary screen of recent
-        //   1:1 DM conversations from muted users?)
         title = store.userDisplayName(otherUserId);
         avatar = AvatarImage(userId: otherUserId, size: _avatarSize);
       default:

test/model/user_test.dart

@@ -2,6 +2,8 @@ import 'package:checks/checks.dart';
 import 'package:flutter_test/flutter_test.dart';
 import 'package:zulip/api/model/events.dart';
 import 'package:zulip/api/model/model.dart';
+import 'package:zulip/model/narrow.dart';
+import 'package:zulip/model/store.dart';
 
 import '../api/model/model_checks.dart';
 import '../example_data.dart' as eg;
@@ -81,25 +83,39 @@ void main() {
   });
 
   testWidgets('MutedUsersEvent', (tester) async {
+    late PerAccountStore store;
+
+    void checkDmConversationMuted(List<int> otherUserIds, bool expected) {
+      final narrow = DmNarrow.withOtherUsers(otherUserIds, selfUserId: store.selfUserId);
+      check(store.shouldMuteDmConversation(narrow)).equals(expected);
+    }
+
     final user1 = eg.user(userId: 1);
     final user2 = eg.user(userId: 2);
     final user3 = eg.user(userId: 3);
 
-    final store = eg.store(initialSnapshot: eg.initialSnapshot(
+    store = eg.store(initialSnapshot: eg.initialSnapshot(
       realmUsers: [user1, user2, user3],
       mutedUsers: [MutedUserItem(id: 2), MutedUserItem(id: 1)]));
     check(store.isUserMuted(1)).isTrue();
     check(store.isUserMuted(2)).isTrue();
     check(store.isUserMuted(3)).isFalse();
+    checkDmConversationMuted([1], true);
+    checkDmConversationMuted([1, 2], true);
+    checkDmConversationMuted([2, 3], false);
+    checkDmConversationMuted([1, 2, 3], false);
 
     await store.handleEvent(eg.mutedUsersEvent([2, 1, 3]));
     check(store.isUserMuted(1)).isTrue();
     check(store.isUserMuted(2)).isTrue();
     check(store.isUserMuted(3)).isTrue();
+    checkDmConversationMuted([1, 2, 3], true);
 
     await store.handleEvent(eg.mutedUsersEvent([2, 3]));
     check(store.isUserMuted(1)).isFalse();
     check(store.isUserMuted(2)).isTrue();
     check(store.isUserMuted(3)).isTrue();
+    checkDmConversationMuted([1], false);
+    checkDmConversationMuted([], false);
   });
 }

test/widgets/recent_dm_conversations_test.dart

@@ -1,6 +1,7 @@
 import 'package:checks/checks.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter/rendering.dart';
+import 'package:flutter_checks/flutter_checks.dart';
 import 'package:flutter_test/flutter_test.dart';
 import 'package:zulip/api/model/events.dart';
 import 'package:zulip/api/model/model.dart';
@@ -67,11 +68,11 @@ Future<void> setupPage(WidgetTester tester, {
 void main() {
   TestZulipBinding.ensureInitialized();
 
-  group('RecentDmConversationsPage', () {
-    Finder findConversationItem(Narrow narrow) => find.byWidgetPredicate(
-      (widget) => widget is RecentDmConversationsItem && widget.narrow == narrow,
-    );
+  Finder findConversationItem(Narrow narrow) => find.byWidgetPredicate(
+    (widget) => widget is RecentDmConversationsItem && widget.narrow == narrow,
+  );
 
+  group('RecentDmConversationsPage', () {
     testWidgets('page builds; conversations appear in order', (tester) async {
       final user1 = eg.user(userId: 1);
       final user2 = eg.user(userId: 2);
@@ -226,8 +227,8 @@ void main() {
               mutedUserIds: [user.userId],
               dmMessages: [message]);
 
-            checkAvatar(tester, DmNarrow.ofMessage(message, selfUserId: eg.selfUser.userId));
-            checkTitle(tester, 'Muted user');
+            final narrow = DmNarrow.ofMessage(message, selfUserId: eg.selfUser.userId);
+            check(findConversationItem(narrow)).findsNothing();
           });
         });
 
@@ -312,8 +313,8 @@ void main() {
               mutedUserIds: [user0.userId, user1.userId],
               dmMessages: [message]);
 
-            checkAvatar(tester, DmNarrow.ofMessage(message, selfUserId: eg.selfUser.userId));
-            checkTitle(tester, 'Muted user, Muted user');
+            final narrow = DmNarrow.ofMessage(message, selfUserId: eg.selfUser.userId);
+            check(findConversationItem(narrow)).findsNothing();
           });
         });