user: Add UserStore.mutedUsers with helper methods, updating with events

Author: sm-sayedi

lib/model/store.dart

@@ -645,6 +645,13 @@ class PerAccountStore extends PerAccountStoreBase with ChangeNotifier, EmojiStor
   @override
   Iterable<User> get allUsers => _users.allUsers;
 
+  @override
+  Set<int> get mutedUsers => _users.mutedUsers;
+
+  @override
+  bool isUserMuted(int id, {Set<int>? mutedUsers}) =>
+    _users.isUserMuted(id, mutedUsers: mutedUsers);
+
   final UserStoreImpl _users;
 
   final TypingStatus typingStatus;
@@ -950,8 +957,9 @@ class PerAccountStore extends PerAccountStoreBase with ChangeNotifier, EmojiStor
         _messages.handleReactionEvent(event);
 
       case MutedUsersEvent():
-        // TODO handle
-        break;
+        assert(debugLog("server event: muted_users"));
+        _users.handleMutedUsersEvent(event);
+        notifyListeners();
 
       case UnexpectedEvent():
         assert(debugLog("server event: ${jsonEncode(event.toJson())}")); // TODO log better

lib/model/user.dart

@@ -1,3 +1,5 @@
+import 'package:flutter/foundation.dart';
+
 import '../api/model/events.dart';
 import '../api/model/initial_snapshot.dart';
 import '../api/model/model.dart';
@@ -66,6 +68,16 @@ mixin UserStore on PerAccountStoreBase {
     return getUser(message.senderId)?.fullName
       ?? message.senderFullName;
   }
+
+  /// Ids of all the users muted by [selfUser].
+  @visibleForTesting
+  Set<int> get mutedUsers;
+
+  /// Whether the user with the given [id] is muted by [selfUser].
+  ///
+  /// 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});
 }
 
 /// The implementation of [UserStore] that does the work.
@@ -81,7 +93,8 @@ class UserStoreImpl extends PerAccountStoreBase with UserStore {
          initialSnapshot.realmUsers
          .followedBy(initialSnapshot.realmNonActiveUsers)
          .followedBy(initialSnapshot.crossRealmBots)
-         .map((user) => MapEntry(user.userId, user)));
+         .map((user) => MapEntry(user.userId, user))),
+       mutedUsers = _toUserIds(initialSnapshot.mutedUsers);
 
   final Map<int, User> _users;
 
@@ -91,6 +104,18 @@ class UserStoreImpl extends PerAccountStoreBase with UserStore {
   @override
   Iterable<User> get allUsers => _users.values;
 
+  @override
+  final Set<int> mutedUsers;
+
+  @override
+  bool isUserMuted(int id, {Set<int>? mutedUsers}) {
+    return (mutedUsers ?? this.mutedUsers).contains(id);
+  }
+
+  static Set<int> _toUserIds(List<MutedUserItem> mutedUserItems) {
+    return Set.from(mutedUserItems.map((item) => item.id));
+  }
+
   void handleRealmUserEvent(RealmUserEvent event) {
     switch (event) {
       case RealmUserAddEvent():
@@ -129,4 +154,9 @@ class UserStoreImpl extends PerAccountStoreBase with UserStore {
         }
     }
   }
+
+  void handleMutedUsersEvent(MutedUsersEvent event) {
+    mutedUsers.clear();
+    mutedUsers.addAll(_toUserIds(event.mutedUsers));
+  }
 }

test/model/store_checks.dart

@@ -57,6 +57,7 @@ extension PerAccountStoreChecks on Subject<PerAccountStore> {
   Subject<int> get selfUserId => has((x) => x.selfUserId, 'selfUserId');
   Subject<UserSettings?> get userSettings => has((x) => x.userSettings, 'userSettings');
   Subject<Map<int, SavedSnippet>> get savedSnippets => has((x) => x.savedSnippets, 'savedSnippets');
+  Subject<Set<int>> get mutedUsers => has((x) => x.mutedUsers, 'mutedUsers');
   Subject<Map<int, ZulipStream>> get streams => has((x) => x.streams, 'streams');
   Subject<Map<String, ZulipStream>> get streamsByName => has((x) => x.streamsByName, 'streamsByName');
   Subject<Map<int, Subscription>> get subscriptions => has((x) => x.subscriptions, 'subscriptions');

test/model/test_store.dart

@@ -1,3 +1,4 @@
+import 'package:collection/collection.dart';
 import 'package:zulip/api/model/events.dart';
 import 'package:zulip/api/model/initial_snapshot.dart';
 import 'package:zulip/api/model/model.dart';
@@ -267,6 +268,21 @@ extension PerAccountStoreTestExtension on PerAccountStore {
     }
   }
 
+  Future<void> muteUser(int id) async {
+    await handleEvent(eg.mutedUsersEvent([...mutedUsers, id]));
+  }
+
+  Future<void> muteUsers(List<int> ids) async {
+    for (final id in ids) {
+      await muteUser(id);
+    }
+  }
+
+  Future<void> unmuteUser(int id) async {
+    await handleEvent(eg.mutedUsersEvent(
+      mutedUsers.whereNot((userId) => userId == id).toList()));
+  }
+
   Future<void> addStream(ZulipStream stream) async {
     await addStreams([stream]);
   }

test/model/user_test.dart

@@ -5,6 +5,7 @@ import 'package:zulip/api/model/model.dart';
 
 import '../api/model/model_checks.dart';
 import '../example_data.dart' as eg;
+import 'store_checks.dart';
 import 'test_store.dart';
 
 void main() {
@@ -79,4 +80,21 @@ void main() {
       check(getUser()).deliveryEmail.equals('[email protected]');
     });
   });
+
+  testWidgets('MutedUsersEvent', (tester) async {
+    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(
+      realmUsers: [user1, user2, user3],
+      mutedUsers: [MutedUserItem(id: 2), MutedUserItem(id: 1)]));
+    check(store).mutedUsers.deepEquals({2, 1});
+
+    await store.handleEvent(eg.mutedUsersEvent([2, 1, 3]));
+    check(store).mutedUsers.deepEquals({2, 1, 3});
+
+    await store.handleEvent(eg.mutedUsersEvent([2, 3]));
+    check(store).mutedUsers.deepEquals({2, 3});
+  });
 }