api: Handle muted_users event

Author: sm-sayedi

lib/api/model/events.dart

@@ -55,6 +55,7 @@ sealed class Event {
         }
       // case 'muted_topics': … // TODO(#422) we ignore this feature on older servers
       case 'user_topic': return UserTopicEvent.fromJson(json);
+      case 'muted_users': return MutedUsersEvent.fromJson(json);
       case 'message': return MessageEvent.fromJson(json);
       case 'update_message': return UpdateMessageEvent.fromJson(json);
       case 'delete_message': return DeleteMessageEvent.fromJson(json);
@@ -664,6 +665,24 @@ class UserTopicEvent extends Event {
   Map<String, dynamic> toJson() => _$UserTopicEventToJson(this);
 }
 
+/// A Zulip event of type `muted_users`: https://zulip.com/api/get-events#muted_users
+@JsonSerializable(fieldRename: FieldRename.snake)
+class MutedUsersEvent extends Event {
+  @override
+  @JsonKey(includeToJson: true)
+  String get type => 'muted_users';
+
+  final List<MutedUserItem> mutedUsers;
+
+  MutedUsersEvent({required super.id, required this.mutedUsers});
+
+  factory MutedUsersEvent.fromJson(Map<String, dynamic> json) =>
+    _$MutedUsersEventFromJson(json);
+
+  @override
+  Map<String, dynamic> toJson() => _$MutedUsersEventToJson(this);
+}
+
 /// A Zulip event of type `message`: https://zulip.com/api/get-events#message
 @JsonSerializable(fieldRename: FieldRename.snake)
 class MessageEvent extends Event {

lib/api/model/events.g.dart

@@ -886,6 +886,11 @@ class PerAccountStore extends PerAccountStoreBase with ChangeNotifier, EmojiStor
         _channels.handleUserTopicEvent(event);
         notifyListeners();
 
+      case MutedUsersEvent():
+        assert(debugLog("server event: muted_users"));
+        _users.handleMutedUsersEvent(event);
+        notifyListeners();
+
       case MessageEvent():
         assert(debugLog("server event: message ${jsonEncode(event.message.toJson())}"));
         _messages.handleMessageEvent(event);

lib/model/store.dart

@@ -87,17 +87,16 @@ class UserStoreImpl extends PerAccountStoreBase with UserStore {
          .followedBy(initialSnapshot.crossRealmBots)
          .map((user) => MapEntry(user.userId, user))),
        _mutedUsers = initialSnapshot.mutedUsers,
-       _mutedUsersSorted = initialSnapshot.mutedUsers
-         ..sort((a, b) => a.id.compareTo(b.id));
+       _mutedUsersSorted = _sortMutedUsers(initialSnapshot.mutedUsers);
 
   final Map<int, User> _users;
 
   // Currently we don't need this, but we would need it if we wanted to display
   // muted users in the order of server.
   // ignore: unused_field
-  final List<MutedUserItem> _mutedUsers;
+  List<MutedUserItem> _mutedUsers;
 
-  final List<MutedUserItem> _mutedUsersSorted;
+  List<MutedUserItem> _mutedUsersSorted;
 
   @override
   User? getUser(int userId) => _users[userId];
@@ -149,4 +148,13 @@ class UserStoreImpl extends PerAccountStoreBase with UserStore {
         }
     }
   }
+
+  void handleMutedUsersEvent(MutedUsersEvent event) {
+    _mutedUsers = event.mutedUsers;
+    _mutedUsersSorted = _sortMutedUsers(event.mutedUsers);
+  }
+
+  static List<MutedUserItem> _sortMutedUsers(List<MutedUserItem> mutedUsers) {
+    return mutedUsers..sort((a, b) => a.id.compareTo(b.id));
+  }
 }