chris squash: Make _mutedUsers private; adjust some names/docs

Making the Set private was Greg's suggestion in review:
  #1530 (comment)

It required changing some tests to use `isUserMuted` instead, and
removing some helper methods on PerAccountStoreTestExtension that
weren't used anyway. We can add it back later if needed, or do
something else.

Author: chrisbobbe

lib/model/store.dart

@@ -646,11 +646,8 @@ class PerAccountStore extends PerAccountStoreBase with ChangeNotifier, EmojiStor
   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);
+  bool isUserMuted(int userId, {Set<int>? mutedUsers}) =>
+    _users.isUserMuted(userId, mutedUsers: mutedUsers);
 
   final UserStoreImpl _users;
 

lib/model/user.dart

@@ -1,5 +1,3 @@
-import 'package:flutter/foundation.dart';
-
 import '../api/model/events.dart';
 import '../api/model/initial_snapshot.dart';
 import '../api/model/model.dart';
@@ -69,15 +67,11 @@ mixin UserStore on PerAccountStoreBase {
       ?? 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].
+  /// Whether the user with [userId] is muted by the self-user.
   ///
-  /// 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});
+  /// Looks for [userId] in a private [Set],
+  /// or in [mutedUsers] instead if that's non-null.
+  bool isUserMuted(int userId, {Set<int>? mutedUsers});
 }
 
 /// The implementation of [UserStore] that does the work.
@@ -94,7 +88,7 @@ class UserStoreImpl extends PerAccountStoreBase with UserStore {
          .followedBy(initialSnapshot.realmNonActiveUsers)
          .followedBy(initialSnapshot.crossRealmBots)
          .map((user) => MapEntry(user.userId, user))),
-       mutedUsers = _toUserIds(initialSnapshot.mutedUsers);
+       _mutedUsers = _toUserIds(initialSnapshot.mutedUsers);
 
   final Map<int, User> _users;
 
@@ -104,12 +98,11 @@ class UserStoreImpl extends PerAccountStoreBase with UserStore {
   @override
   Iterable<User> get allUsers => _users.values;
 
-  @override
-  final Set<int> mutedUsers;
+  final Set<int> _mutedUsers;
 
   @override
-  bool isUserMuted(int id, {Set<int>? mutedUsers}) {
-    return (mutedUsers ?? this.mutedUsers).contains(id);
+  bool isUserMuted(int userId, {Set<int>? mutedUsers}) {
+    return (mutedUsers ?? _mutedUsers).contains(userId);
   }
 
   static Set<int> _toUserIds(List<MutedUserItem> mutedUserItems) {
@@ -156,7 +149,7 @@ class UserStoreImpl extends PerAccountStoreBase with UserStore {
   }
 
   void handleMutedUsersEvent(MutedUsersEvent event) {
-    mutedUsers.clear();
-    mutedUsers.addAll(_toUserIds(event.mutedUsers));
+    _mutedUsers.clear();
+    _mutedUsers.addAll(_toUserIds(event.mutedUsers));
   }
 }

test/model/store_checks.dart

@@ -57,7 +57,6 @@ 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,4 +1,3 @@
-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';
@@ -268,21 +267,6 @@ 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,7 +5,6 @@ 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() {
@@ -89,12 +88,18 @@ void main() {
     final store = eg.store(initialSnapshot: eg.initialSnapshot(
       realmUsers: [user1, user2, user3],
       mutedUsers: [MutedUserItem(id: 2), MutedUserItem(id: 1)]));
-    check(store).mutedUsers.deepEquals({2, 1});
+    check(store.isUserMuted(1)).isTrue();
+    check(store.isUserMuted(2)).isTrue();
+    check(store.isUserMuted(3)).isFalse();
 
     await store.handleEvent(eg.mutedUsersEvent([2, 1, 3]));
-    check(store).mutedUsers.deepEquals({2, 1, 3});
+    check(store.isUserMuted(1)).isTrue();
+    check(store.isUserMuted(2)).isTrue();
+    check(store.isUserMuted(3)).isTrue();
 
     await store.handleEvent(eg.mutedUsersEvent([2, 3]));
-    check(store).mutedUsers.deepEquals({2, 3});
+    check(store.isUserMuted(1)).isFalse();
+    check(store.isUserMuted(2)).isTrue();
+    check(store.isUserMuted(3)).isTrue();
   });
 }