@-mentions wip.

Signed-off-by: Zixuan James Li <[email protected]>

Author: PIG208

assets/l10n/app_en.arb

@@ -344,6 +344,10 @@
   "@loginErrorMissingUsername": {
     "description": "Error message when an empty username was provided."
   },
+  "mentionsPageTitle": "Mentions",
+  "@mentionsPageTitle": {
+    "description": "Title for the page of @-mentions."
+  },
   "topicValidationErrorTooLong": "Topic length shouldn't be greater than 60 characters.",
   "@topicValidationErrorTooLong": {
     "description": "Topic validation error when topic is too long."

lib/api/model/events.g.dart

@@ -551,7 +551,9 @@ enum MessageFlag {
   starred,
   collapsed,
   mentioned,
-  wildcardMentioned,
+  wildcardMentioned, // TODO(server-8) deprecated FL 224
+  channelWildcardMentioned,
+  topicWildcardMentioned,
   hasAlertWord,
   historical,
   unknown;

lib/api/model/model.dart

@@ -34,6 +34,13 @@ sealed class ApiNarrowElement {
   };
 }
 
+class ApiNarrowMentions extends ApiNarrowElement {
+  @override String get operator => 'is';
+  @override String get operand => 'mentioned';
+
+  ApiNarrowMentions({super.negated});
+}
+
 class ApiNarrowStream extends ApiNarrowElement {
   @override String get operator => 'stream';
 

lib/api/model/model.g.dart

@@ -188,6 +188,7 @@ class MentionAutocompleteView extends ChangeNotifier {
     required Narrow narrow,
   }) {
     assert(narrow is! CombinedFeedNarrow);
+    assert(narrow is! MentionsNarrow);
     return store.users.values.toList()
       ..sort((userA, userB) => compareByDms(userA, userB, store: store));
   }

lib/api/model/narrow.dart

@@ -70,6 +70,8 @@ Uri narrowLink(PerAccountStore store, Narrow narrow, {int? nearMessageId}) {
     fragment.write('${element.operator}/');
 
     switch (element) {
+      case ApiNarrowMentions():
+        fragment.write(element.operand.toString());
       case ApiNarrowStream():
         final streamId = element.operand;
         final name = store.streams[streamId]?.name ?? 'unknown';

lib/model/autocomplete.dart

@@ -357,6 +357,7 @@ class MessageListView with ChangeNotifier, _MessageSequence {
   bool _messageVisible(Message message) {
     switch (narrow) {
       case CombinedFeedNarrow():
+      case MentionsNarrow():
         return switch (message) {
           StreamMessage() =>
             store.isTopicVisible(message.streamId, message.topic),
@@ -380,6 +381,7 @@ class MessageListView with ChangeNotifier, _MessageSequence {
   bool get _allMessagesVisible {
     switch (narrow) {
       case CombinedFeedNarrow():
+      case MentionsNarrow():
       case StreamNarrow():
         return false;
 

lib/model/internal_link.dart

@@ -65,6 +65,32 @@ class CombinedFeedNarrow extends Narrow {
   int get hashCode => 'CombinedFeedNarrow'.hashCode;
 }
 
+class MentionsNarrow extends Narrow {
+  const MentionsNarrow();
+
+  @override
+  bool containsMessage(Message message) {
+    return message.flags.any((flag) =>
+      flag == MessageFlag.mentioned
+      || flag == MessageFlag.wildcardMentioned
+      || flag == MessageFlag.channelWildcardMentioned
+      || flag == MessageFlag.topicWildcardMentioned);
+  }
+
+  @override
+  ApiNarrow apiEncode() => [ApiNarrowMentions()];
+
+  @override
+  bool operator ==(Object other) {
+    if (other is! MentionsNarrow) return false;
+    // Conceptually there's only one value of this type.
+    return true;
+  }
+
+  @override
+  int get hashCode => 'MentionedNarrow'.hashCode;
+}
+
 class StreamNarrow extends Narrow {
   const StreamNarrow(this.streamId);
 

lib/model/message_list.dart

@@ -144,6 +144,10 @@ class Unreads extends ChangeNotifier {
     return c;
   }
 
+  int countInMentionedNarrow() {
+    return mentions.length;
+  }
+
   /// The "strict" unread count for this stream,
   /// using [StreamStore.isTopicVisible].
   ///
@@ -197,6 +201,8 @@ class Unreads extends ChangeNotifier {
     switch (narrow) {
       case CombinedFeedNarrow():
         return countInCombinedFeedNarrow();
+      case MentionsNarrow():
+        return countInMentionedNarrow();
       case StreamNarrow():
         return countInStreamNarrow(narrow.streamId);
       case TopicNarrow():
@@ -222,6 +228,8 @@ class Unreads extends ChangeNotifier {
     if (
       message.flags.contains(MessageFlag.mentioned)
       || message.flags.contains(MessageFlag.wildcardMentioned)
+      || message.flags.contains(MessageFlag.channelWildcardMentioned)
+      || message.flags.contains(MessageFlag.topicWildcardMentioned)
     ) {
       mentions.add(message.id);
     }
@@ -308,6 +316,8 @@ class Unreads extends ChangeNotifier {
 
       case MessageFlag.mentioned:
       case MessageFlag.wildcardMentioned:
+      case MessageFlag.channelWildcardMentioned:
+      case MessageFlag.topicWildcardMentioned:
         // Empirically, we don't seem to get these events when a message is edited
         // to add/remove an @-mention, even though @-mention state is represented
         // as flags. Instead, we just get the [UpdateMessageEvent], and that

lib/model/narrow.dart

@@ -276,6 +276,12 @@ class HomePage extends StatelessWidget {
                 narrow: const CombinedFeedNarrow())),
             child: Text(zulipLocalizations.combinedFeedPageTitle)),
           const SizedBox(height: 16),
+          ElevatedButton(
+            onPressed: () => Navigator.push(context,
+              MessageListPage.buildRoute(context: context,
+                narrow: const MentionsNarrow())),
+            child: Text(zulipLocalizations.mentionsPageTitle)),
+          const SizedBox(height: 16),
           ElevatedButton(
             onPressed: () => Navigator.push(context,
               InboxPage.buildRoute(context: context)),

lib/model/unreads.dart

@@ -967,7 +967,7 @@ class ComposeBox extends StatelessWidget {
       return _FixedDestinationComposeBox(key: controllerKey, narrow: narrow);
     } else if (narrow is DmNarrow) {
       return _FixedDestinationComposeBox(key: controllerKey, narrow: narrow);
-    } else if (narrow is CombinedFeedNarrow) {
+    } else if (narrow is CombinedFeedNarrow || narrow is MentionsNarrow) {
       return const SizedBox.shrink();
     } else {
       throw Exception("impossible narrow"); // TODO(dart-3): show this statically

lib/widgets/app.dart

@@ -63,6 +63,7 @@ class _MessageListPageState extends State<MessageListPage> {
     bool removeAppBarBottomBorder = false;
     switch(widget.narrow) {
       case CombinedFeedNarrow():
+      case MentionsNarrow():
         appBarBackgroundColor = null; // i.e., inherit
 
       case StreamNarrow(:final streamId):
@@ -149,6 +150,8 @@ class MessageListAppBarTitle extends StatelessWidget {
     switch (narrow) {
       case CombinedFeedNarrow():
         return Text(zulipLocalizations.combinedFeedPageTitle);
+      case MentionsNarrow():
+        return Text(zulipLocalizations.mentionsPageTitle);
 
       case StreamNarrow(:var streamId):
         final store = PerAccountStoreWidget.of(context);
@@ -340,7 +343,7 @@ class _MessageListState extends State<MessageList> with PerAccountStoreAwareStat
           return _buildItem(data, i);
         }));
 
-    if (widget.narrow is CombinedFeedNarrow) {
+    if (widget.narrow is CombinedFeedNarrow || widget.narrow is MentionsNarrow) {
       // TODO(#311) If we have a bottom nav, it will pad the bottom
       //   inset, and this shouldn't be necessary
       sliver = SliverSafeArea(sliver: sliver);
@@ -521,7 +524,7 @@ class RecipientHeader extends StatelessWidget {
     final message = this.message;
     return switch (message) {
       StreamMessage() => StreamMessageRecipientHeader(message: message,
-        showStream: narrow is CombinedFeedNarrow),
+        showStream: narrow is CombinedFeedNarrow || narrow is MentionsNarrow),
       DmMessage() => DmRecipientHeader(message: message),
     };
   }
@@ -1097,6 +1100,13 @@ Future<void> _legacyMarkNarrowAsRead(BuildContext context, Narrow narrow) async
   switch (narrow) {
     case CombinedFeedNarrow():
       await markAllAsRead(connection);
+    case MentionsNarrow():
+    final unreadMentions = store.unreads.mentions.toList();
+    if (unreadMentions.isEmpty) return;
+    await updateMessageFlags(connection,
+      messages: unreadMentions,
+      op: UpdateMessageFlagsOp.add,
+      flag: MessageFlag.read);
     case StreamNarrow(:final streamId):
       await markStreamAsRead(connection, streamId: streamId);
     case TopicNarrow(:final streamId, :final topic):

lib/widgets/compose_box.dart

@@ -936,6 +936,7 @@ void checkInvariants(MessageListView model) {
       case StreamNarrow():
         check(model.store.isTopicVisibleInStream(message.streamId, message.topic))
           .isTrue();
+      case MentionsNarrow():
       case TopicNarrow():
       case DmNarrow():
     }

lib/widgets/message_list.dart

@@ -545,6 +545,8 @@ void main() {
         MessageFlag.unknown => true,
         MessageFlag.mentioned => false,
         MessageFlag.wildcardMentioned => false,
+        MessageFlag.channelWildcardMentioned => false,
+        MessageFlag.topicWildcardMentioned => false,
         MessageFlag.read => false,
       });