muted-users: Say "Muted user" to replace a user's name, where applicable

(Done by adding an is-muted condition in store.userDisplayName and
store.senderDisplayName, with an opt-out param.)

If Chris is muted, we'll now show "Muted user" where before we would
show "Chris Bobbe", in the following places:

- Message-list page:
  - DM-narrow app bar.
  - DM recipient headers.
  - The sender row on messages. This and message content will get
    more treatment in a separate commit.
  - Emoji-reaction chips on messages.
  - Typing indicators ("Muted user is typing…"), but we'll be
    excluding muted users, coming up in a separate commit.
  - Voter names in poll messages.
- DM items in the Inbox page. (Messages from muted users are
  automatically marked as read, but they can end up in the inbox if
  you un-mark them as read.)
- @-mention autocomplete, but we'll be excluding muted users, coming
  up in a separate commit.
- Items in the Direct messages ("recent DMs") page. We'll be
  excluding DMs where everyone is muted, coming up in a separate
  commit.
- User items in custom profile fields.

We *don't* do this replacement in the following places, i.e., we'll
still show "Chris Bobbe" if Chris is muted:

- Sender name in the header of the lightbox page. (This follows
  web.)
- The "hint text" for the compose box in a DM narrow: it will still
  say "Message @chris Bobbe", not "Message @muted user". (This
  follows web.)
- The user's name at the top of the Profile page.
- We won't generate malformed @-mention syntax like
  @_**Muted user|13313**.

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

Author: chrisbobbe

assets/l10n/app_en.arb

@@ -983,17 +983,13 @@
   "@noEarlierMessages": {
     "description": "Text to show at the start of a message list if there are no earlier messages."
   },
-  "mutedSender": "Muted sender",
-  "@mutedSender": {
-    "description": "Name for a muted user to display in message list."
-  },
   "revealButtonLabel": "Reveal message for muted sender",
   "@revealButtonLabel": {
     "description": "Label for the button revealing hidden message from a muted sender in message list."
   },
   "mutedUser": "Muted user",
   "@mutedUser": {
-    "description": "Name for a muted user to display all over the app."
+    "description": "Text to display in place of a muted user's name."
   },
   "scrollToBottomTooltip": "Scroll to bottom",
   "@scrollToBottomTooltip": {

lib/generated/l10n/zulip_localizations.dart

@@ -1463,19 +1463,13 @@ abstract class ZulipLocalizations {
   /// **'No earlier messages'**
   String get noEarlierMessages;
 
-  /// Name for a muted user to display in message list.
-  ///
-  /// In en, this message translates to:
-  /// **'Muted sender'**
-  String get mutedSender;
-
   /// Label for the button revealing hidden message from a muted sender in message list.
   ///
   /// In en, this message translates to:
   /// **'Reveal message for muted sender'**
   String get revealButtonLabel;
 
-  /// Name for a muted user to display all over the app.
+  /// Text to display in place of a muted user's name.
   ///
   /// In en, this message translates to:
   /// **'Muted user'**

lib/generated/l10n/zulip_localizations_ar.dart

@@ -796,9 +796,6 @@ class ZulipLocalizationsAr extends ZulipLocalizations {
   @override
   String get noEarlierMessages => 'No earlier messages';
 
-  @override
-  String get mutedSender => 'Muted sender';
-
   @override
   String get revealButtonLabel => 'Reveal message for muted sender';
 

lib/generated/l10n/zulip_localizations_de.dart

@@ -796,9 +796,6 @@ class ZulipLocalizationsDe extends ZulipLocalizations {
   @override
   String get noEarlierMessages => 'No earlier messages';
 
-  @override
-  String get mutedSender => 'Muted sender';
-
   @override
   String get revealButtonLabel => 'Reveal message for muted sender';
 

lib/generated/l10n/zulip_localizations_en.dart

@@ -796,9 +796,6 @@ class ZulipLocalizationsEn extends ZulipLocalizations {
   @override
   String get noEarlierMessages => 'No earlier messages';
 
-  @override
-  String get mutedSender => 'Muted sender';
-
   @override
   String get revealButtonLabel => 'Reveal message for muted sender';
 

lib/generated/l10n/zulip_localizations_ja.dart

@@ -796,9 +796,6 @@ class ZulipLocalizationsJa extends ZulipLocalizations {
   @override
   String get noEarlierMessages => 'No earlier messages';
 
-  @override
-  String get mutedSender => 'Muted sender';
-
   @override
   String get revealButtonLabel => 'Reveal message for muted sender';
 

lib/generated/l10n/zulip_localizations_nb.dart

@@ -796,9 +796,6 @@ class ZulipLocalizationsNb extends ZulipLocalizations {
   @override
   String get noEarlierMessages => 'No earlier messages';
 
-  @override
-  String get mutedSender => 'Muted sender';
-
   @override
   String get revealButtonLabel => 'Reveal message for muted sender';
 

lib/generated/l10n/zulip_localizations_pl.dart

@@ -807,9 +807,6 @@ class ZulipLocalizationsPl extends ZulipLocalizations {
   @override
   String get noEarlierMessages => 'Brak historii';
 
-  @override
-  String get mutedSender => 'Muted sender';
-
   @override
   String get revealButtonLabel => 'Reveal message for muted sender';
 

lib/generated/l10n/zulip_localizations_ru.dart

@@ -810,9 +810,6 @@ class ZulipLocalizationsRu extends ZulipLocalizations {
   @override
   String get noEarlierMessages => 'Предшествующих сообщений нет';
 
-  @override
-  String get mutedSender => 'Muted sender';
-
   @override
   String get revealButtonLabel => 'Reveal message for muted sender';
 

lib/generated/l10n/zulip_localizations_sk.dart

@@ -798,9 +798,6 @@ class ZulipLocalizationsSk extends ZulipLocalizations {
   @override
   String get noEarlierMessages => 'No earlier messages';
 
-  @override
-  String get mutedSender => 'Muted sender';
-
   @override
   String get revealButtonLabel => 'Reveal message for muted sender';
 

lib/generated/l10n/zulip_localizations_uk.dart

@@ -810,9 +810,6 @@ class ZulipLocalizationsUk extends ZulipLocalizations {
   @override
   String get noEarlierMessages => 'Немає попередніх повідомлень';
 
-  @override
-  String get mutedSender => 'Muted sender';
-
   @override
   String get revealButtonLabel => 'Reveal message for muted sender';
 

lib/generated/l10n/zulip_localizations_zh.dart

@@ -796,9 +796,6 @@ class ZulipLocalizationsZh extends ZulipLocalizations {
   @override
   String get noEarlierMessages => 'No earlier messages';
 
-  @override
-  String get mutedSender => 'Muted sender';
-
   @override
   String get revealButtonLabel => 'Reveal message for muted sender';
 

lib/model/compose.dart

@@ -151,7 +151,7 @@ String userMention(User user, {bool silent = false, UserStore? users}) {
 String userMentionFromMessage(Message message, {bool silent = false, required UserStore users}) =>
   _userMentionImpl(
     silent: silent,
-    fullName: users.senderDisplayName(message),
+    fullName: users.senderDisplayName(message, replaceIfMuted: false),
     userId: message.senderId);
 
 String _userMentionImpl({required bool silent, required String fullName, int? userId}) =>

lib/model/user.dart

@@ -44,27 +44,40 @@ mixin UserStore on PerAccountStoreBase {
 
   /// The name to show the given user as in the UI, even for unknown users.
   ///
-  /// This is the user's [User.fullName] if the user is known,
-  /// and otherwise a translation of "(unknown user)".
+  /// If the user is muted and [replaceIfMuted] is true (the default),
+  /// this is [ZulipLocalizations.mutedUser].
+  ///
+  /// Otherwise this is the user's [User.fullName] if the user is known,
+  /// or (if unknown) [ZulipLocalizations.unknownUserName].
   ///
   /// When a [Message] is available which the user sent,
   /// use [senderDisplayName] instead for a better-informed fallback.
-  String userDisplayName(int userId) {
+  String userDisplayName(int userId, {bool replaceIfMuted = true}) {
+    if (replaceIfMuted && isUserMuted(userId)) {
+      return GlobalLocalizations.zulipLocalizations.mutedUser;
+    }
     return getUser(userId)?.fullName
       ?? GlobalLocalizations.zulipLocalizations.unknownUserName;
   }
 
   /// The name to show for the given message's sender in the UI.
   ///
-  /// If the user is known (see [getUser]), this is their current [User.fullName].
+  /// If the sender is muted and [replaceIfMuted] is true (the default),
+  /// this is [ZulipLocalizations.mutedUser].
+  ///
+  /// Otherwise, if the user is known (see [getUser]),
+  /// this is their current [User.fullName].
   /// If unknown, this uses the fallback value conveniently provided on the
   /// [Message] object itself, namely [Message.senderFullName].
   ///
   /// For a user who isn't the sender of some known message,
   /// see [userDisplayName].
-  String senderDisplayName(Message message) {
-    return getUser(message.senderId)?.fullName
-      ?? message.senderFullName;
+  String senderDisplayName(Message message, {bool replaceIfMuted = true}) {
+    final senderId = message.senderId;
+    if (replaceIfMuted && isUserMuted(senderId)) {
+      return GlobalLocalizations.zulipLocalizations.mutedUser;
+    }
+    return getUser(senderId)?.fullName ?? message.senderFullName;
   }
 
   /// Whether the user with [userId] is muted by the self-user.

lib/widgets/compose_box.dart

@@ -860,8 +860,9 @@ class _FixedDestinationContentInput extends StatelessWidget {
         final store = PerAccountStoreWidget.of(context);
         final user = store.getUser(otherUserId);
         if (user == null) return zulipLocalizations.composeBoxGenericContentHint;
+        // TODO write a test where the user is muted
         return zulipLocalizations.composeBoxDmContentHint(
-          store.userDisplayName(otherUserId));
+          store.userDisplayName(otherUserId, replaceIfMuted: false));
 
       case DmNarrow(): // A group DM thread.
         return zulipLocalizations.composeBoxGroupDmContentHint;

lib/widgets/inbox.dart

@@ -387,6 +387,7 @@ class _DmItem extends StatelessWidget {
     final store = PerAccountStoreWidget.of(context);
     final designVariables = DesignVariables.of(context);
 
+    // TODO write a test where a/the recipient is muted
     final title = switch (narrow.otherRecipientIds) { // TODO dedupe with [RecentDmConversationsItem]
       [] => store.selfUser.fullName,
       [var otherUserId] => store.userDisplayName(otherUserId),

lib/widgets/lightbox.dart

@@ -201,7 +201,8 @@ class _LightboxPageLayoutState extends State<_LightboxPageLayout> {
             child: RichText(
               text: TextSpan(children: [
                 TextSpan(
-                  text: '${store.senderDisplayName(widget.message)}\n',
+                  // TODO write a test where the sender is muted
+                  text: '${store.senderDisplayName(widget.message, replaceIfMuted: false)}\n',
 
                   // Restate default
                   style: themeData.textTheme.titleLarge!.copyWith(color: appBarForegroundColor)),

lib/widgets/profile.dart

@@ -49,7 +49,8 @@ class ProfilePage extends StatelessWidget {
       Center(
         child: Avatar(userId: userId, size: 200, borderRadius: 200 / 8)),
       const SizedBox(height: 16),
-      Text(store.userDisplayName(userId),
+      // TODO write a test where the user is muted
+      Text(store.userDisplayName(userId, replaceIfMuted: false),
         textAlign: TextAlign.center,
         style: _TextStyles.primaryFieldText
           .merge(weightVariableTextStyle(context, wght: 700))),
@@ -75,7 +76,9 @@ class ProfilePage extends StatelessWidget {
     ];
 
     return Scaffold(
-      appBar: ZulipAppBar(title: Text(store.userDisplayName(userId))),
+      appBar: ZulipAppBar(
+        // TODO write a test where the user is muted
+        title: Text(store.userDisplayName(userId, replaceIfMuted: false))),
       body: SingleChildScrollView(
         child: Center(
           child: ConstrainedBox(

test/model/compose_test.dart

@@ -281,6 +281,15 @@ hello
         check(userMentionFromMessage(message, silent: false, users: store))
           .equals('@**Full Name|123**');
       });
+
+      test('userMentionFromMessage, muted user', () async {
+        final store = eg.store();
+        await store.addUser(user);
+        await store.setMutedUsers([user.userId]);
+        check(store.isUserMuted(user.userId)).isTrue();
+        check(userMentionFromMessage(message, silent: false, users: store))
+          .equals('@**Full Name|123**'); // not replaced with 'Muted user'
+      });
     });
 
     test('wildcard', () {

test/model/test_store.dart

@@ -267,6 +267,10 @@ extension PerAccountStoreTestExtension on PerAccountStore {
     }
   }
 
+  Future<void> setMutedUsers(List<int> userIds) async {
+    await handleEvent(eg.mutedUsersEvent(userIds));
+  }
+
   Future<void> addStream(ZulipStream stream) async {
     await addStreams([stream]);
   }

test/widgets/emoji_reaction_test.dart

@@ -227,6 +227,27 @@ void main() {
         }
       }
     }
+
+    testWidgets('show "Muted user" label for muted reactors', (tester) async {
+      final user1 = eg.user(userId: 1, fullName: 'User 1');
+      final user2 = eg.user(userId: 2, fullName: 'User 2');
+
+      await prepare();
+      await store.addUsers([user1, user2]);
+      await store.setMutedUsers([user1.userId]);
+      await setupChipsInBox(tester,
+        reactions: [
+          Reaction.fromJson({'emoji_name': '+1', 'emoji_code': '1f44d', 'reaction_type': 'unicode_emoji', 'user_id': user1.userId}),
+          Reaction.fromJson({'emoji_name': '+1', 'emoji_code': '1f44d', 'reaction_type': 'unicode_emoji', 'user_id': user2.userId}),
+        ]);
+
+      final reactionChipFinder = find.byType(ReactionChip);
+      check(reactionChipFinder).findsOne();
+      check(find.descendant(
+        of: reactionChipFinder,
+        matching: find.text('Muted user, User 2')
+      )).findsOne();
+    });
   });
 
   testWidgets('Smoke test for light/dark/lerped', (tester) async {