narrow: Add starred messages narrow.

PIG208 · PIG208 · commit 9a04993f392b · 2024-08-12T18:34:39.000-04:00
"Starred messages narrow" is the user facing name of the narrow, thus we
name the Narrow class after it. This narrow is pretty similar to
MentionsNarrow.

Signed-off-by: Zixuan James Li &lt;zixuan@zulip.com&gt;
diff --git a/assets/l10n/app_en.arb b/assets/l10n/app_en.arb
@@ -480,6 +480,10 @@
   "@mentionsPageTitle": {
     "description": "Title for the page of @-mentions."
   },
+  "starredMessagesPageTitle": "Starred messages",
+  "@starredMessagesPageTitle": {
+    "description": "Title for the page of starred messages."
+  },
   "notifGroupDmConversationLabel": "{senderFullName} to you and {numOthers, plural, =1{1 other} other{{numOthers} others}}",
   "@notifGroupDmConversationLabel": {
     "description": "Label for a group DM conversation notification.",
diff --git a/lib/model/autocomplete.dart b/lib/model/autocomplete.dart
@@ -223,6 +223,7 @@ class MentionAutocompleteView extends ChangeNotifier {
         break;
       case CombinedFeedNarrow():
       case MentionsNarrow():
+      case StarredMessagesNarrow():
         assert(false, 'No compose box, thus no autocomplete is available in ${narrow.runtimeType}.');
     }
     return (userA, userB) => _compareByRelevance(userA, userB,
diff --git a/lib/model/message_list.dart b/lib/model/message_list.dart
@@ -385,6 +385,7 @@ class MessageListView with ChangeNotifier, _MessageSequence {
       case TopicNarrow():
       case DmNarrow():
       case MentionsNarrow():
+      case StarredMessagesNarrow():
         return true;
     }
   }
@@ -401,6 +402,7 @@ class MessageListView with ChangeNotifier, _MessageSequence {
       case TopicNarrow():
       case DmNarrow():
       case MentionsNarrow():
+      case StarredMessagesNarrow():
         return true;
     }
   }
@@ -562,6 +564,7 @@ class MessageListView with ChangeNotifier, _MessageSequence {
 
       case CombinedFeedNarrow():
       case MentionsNarrow():
+      case StarredMessagesNarrow():
         // The messages were and remain in this narrow.
         // TODO(#421): … except they may have become muted or not.
         //   We'll handle that at the same time as we handle muting itself changing.
diff --git a/lib/model/narrow.dart b/lib/model/narrow.dart
@@ -321,3 +321,25 @@ class MentionsNarrow extends Narrow {
   @override
   int get hashCode => 'MentionsNarrow'.hashCode;
 }
+
+class StarredMessagesNarrow extends Narrow {
+  const StarredMessagesNarrow();
+
+  @override
+  ApiNarrow apiEncode() => [ApiNarrowIs(IsOperand.starred)];
+
+  @override
+  bool containsMessage(Message message) {
+    return message.flags.contains(MessageFlag.starred);
+  }
+
+  @override
+  bool operator ==(Object other) {
+    if (other is! StarredMessagesNarrow) return false;
+    // Conceptually there's only one value of this type.
+    return true;
+  }
+
+  @override
+  int get hashCode => 'StarredMessagesNarrow'.hashCode;
+}
diff --git a/lib/model/unreads.dart b/lib/model/unreads.dart
@@ -195,6 +195,9 @@ class Unreads extends ChangeNotifier {
 
   int countInMentionsNarrow() => mentions.length;
 
+  // TODO: Implement unreads handling.
+  int countInStarredMessagesNarrow() => 0;
+
   int countInNarrow(Narrow narrow) {
     switch (narrow) {
       case CombinedFeedNarrow():
@@ -207,6 +210,8 @@ class Unreads extends ChangeNotifier {
         return countInDmNarrow(narrow);
       case MentionsNarrow():
         return countInMentionsNarrow();
+      case StarredMessagesNarrow():
+        return countInStarredMessagesNarrow();
     }
   }
 
diff --git a/lib/widgets/actions.dart b/lib/widgets/actions.dart
@@ -141,5 +141,8 @@ Future<void> _legacyMarkNarrowAsRead(BuildContext context, Narrow narrow) async
         messages: unreadMentions,
         op: UpdateMessageFlagsOp.add,
         flag: MessageFlag.read);
+    case StarredMessagesNarrow():
+      // TODO: Implement unreads handling.
+      return;
   }
 }
diff --git a/lib/widgets/compose_box.dart b/lib/widgets/compose_box.dart
@@ -1072,6 +1072,7 @@ class ComposeBox extends StatelessWidget {
 
       case CombinedFeedNarrow():
       case MentionsNarrow():
+      case StarredMessagesNarrow():
         return false;
     }
   }
@@ -1088,6 +1089,7 @@ class ComposeBox extends StatelessWidget {
         return _FixedDestinationComposeBox(key: controllerKey, narrow: narrow);
       case CombinedFeedNarrow():
       case MentionsNarrow():
+      case StarredMessagesNarrow():
         return const SizedBox.shrink();
     }
   }
diff --git a/lib/widgets/message_list.dart b/lib/widgets/message_list.dart
@@ -249,6 +249,7 @@ class _MessageListPageState extends State<MessageListPage> implements MessageLis
     switch(narrow) {
       case CombinedFeedNarrow():
       case MentionsNarrow():
+      case StarredMessagesNarrow():
         appBarBackgroundColor = null; // i.e., inherit
 
       case ChannelNarrow(:final streamId):
@@ -338,6 +339,9 @@ class MessageListAppBarTitle extends StatelessWidget {
       case MentionsNarrow():
         return Text(zulipLocalizations.mentionsPageTitle);
 
+      case StarredMessagesNarrow():
+        return Text(zulipLocalizations.starredMessagesPageTitle);
+
       case ChannelNarrow(:var streamId):
         final store = PerAccountStoreWidget.of(context);
         final stream = store.streams[streamId];
@@ -835,6 +839,7 @@ class RecipientHeader extends StatelessWidget {
     switch (narrow) {
       case CombinedFeedNarrow():
       case MentionsNarrow():
+      case StarredMessagesNarrow():
         return true;
 
       case ChannelNarrow():
diff --git a/test/api/route/messages_test.dart b/test/api/route/messages_test.dart
@@ -191,6 +191,9 @@ void main() {
       checkNarrow(const MentionsNarrow().apiEncode(), jsonEncode([
         {'operator': 'is', 'operand': 'mentioned'},
       ]));
+      checkNarrow(const StarredMessagesNarrow().apiEncode(), jsonEncode([
+        {'operator': 'is', 'operand': 'starred'},
+      ]));
 
       checkNarrow([ApiNarrowDm([123, 234])], jsonEncode([
         {'operator': 'dm', 'operand': [123, 234]},
diff --git a/test/model/autocomplete_test.dart b/test/model/autocomplete_test.dart
@@ -676,6 +676,13 @@ void main() {
         check(() => MentionAutocompleteView.init(store: store, narrow: narrow))
           .throws<AssertionError>();
       });
+
+      test('StarredMessagesNarrow gives error', () async {
+        await prepare(users: [eg.user(), eg.user()], messages: []);
+        const narrow = StarredMessagesNarrow();
+        check(() => MentionAutocompleteView.init(store: store, narrow: narrow))
+          .throws<AssertionError>();
+      });
     });
 
     test('final results end-to-end', () async {
diff --git a/test/model/compose_test.dart b/test/model/compose_test.dart
@@ -239,6 +239,14 @@ hello
         .equals(store.realmUrl.resolve('#narrow/is/mentioned/near/1'));
     });
 
+    test('StarredMessagesNarrow', () {
+      final store = eg.store();
+      check(narrowLink(store, const StarredMessagesNarrow()))
+        .equals(store.realmUrl.resolve('#narrow/is/starred'));
+      check(narrowLink(store, const StarredMessagesNarrow(), nearMessageId: 1))
+        .equals(store.realmUrl.resolve('#narrow/is/starred/near/1'));
+    });
+
     test('ChannelNarrow / TopicNarrow', () {
       void checkNarrow(String expectedFragment, {
         required int streamId,
diff --git a/test/model/message_list_test.dart b/test/model/message_list_test.dart
@@ -1274,6 +1274,44 @@ void main() {
         check(model.messages.map((m) => m.id)).deepEquals(expected..add(301 + i));
       }
     });
+
+    test('in StarredMessagesNarrow', () async {
+      final stream = eg.stream(streamId: 1, name: 'muted stream');
+      const mutedTopic = 'muted';
+      await prepare(narrow: const StarredMessagesNarrow());
+      await store.addStream(stream);
+      await store.addUserTopic(stream, mutedTopic, UserTopicVisibilityPolicy.muted);
+      await store.addSubscription(eg.subscription(stream, isMuted: true));
+
+      List<Message> getMessages(int startingId) => [
+        eg.streamMessage(id: startingId,
+          stream: stream, topic: mutedTopic, flags: [MessageFlag.starred]),
+        eg.dmMessage(id: startingId + 1,
+          from: eg.otherUser, to: [eg.selfUser], flags: [MessageFlag.starred]),
+      ];
+
+      // Check filtering on fetchInitial…
+      await prepareMessages(foundOldest: false, messages: getMessages(201));
+      final expected = <int>[];
+      check(model.messages.map((m) => m.id))
+        .deepEquals(expected..addAll([201, 202]));
+
+      // … and on fetchOlder…
+      connection.prepare(json: olderResult(
+        anchor: 201, foundOldest: true, messages: getMessages(101)).toJson());
+      await model.fetchOlder();
+      checkNotified(count: 2);
+      check(model.messages.map((m) => m.id))
+        .deepEquals(expected..insertAll(0, [101, 102]));
+
+      // … and on MessageEvent.
+      final messages = getMessages(301);
+      for (var i = 0; i < 2; i += 1) {
+        await store.handleEvent(MessageEvent(id: 0, message: messages[i]));
+        checkNotifiedOnce();
+        check(model.messages.map((m) => m.id)).deepEquals(expected..add(301 + i));
+      }
+    });
   });
 
   test('recipient headers are maintained consistently', () async {
@@ -1520,6 +1558,7 @@ void checkInvariants(MessageListView model) {
       case TopicNarrow():
       case DmNarrow():
       case MentionsNarrow():
+      case StarredMessagesNarrow():
     }
   }
 
diff --git a/test/model/narrow_test.dart b/test/model/narrow_test.dart
@@ -162,4 +162,15 @@ void main() {
         eg.streamMessage(flags: [MessageFlag.wildcardMentioned]))).isTrue();
     });
   });
+
+  group('StarredMessagesNarrow', () {
+    test('containsMessage', () {
+      const narrow = StarredMessagesNarrow();
+
+      check(narrow.containsMessage(
+        eg.streamMessage(flags: []))).isFalse();
+      check(narrow.containsMessage(
+        eg.streamMessage(flags:[MessageFlag.starred]))).isTrue();
+    });
+  });
 }
diff --git a/test/model/unreads_test.dart b/test/model/unreads_test.dart
@@ -227,6 +227,17 @@ void main() {
       ]);
       check(model.countInMentionsNarrow()).equals(2);
     });
+
+    test('countInStarredMessagesNarrow', () async {
+      final stream = eg.stream();
+      prepare();
+      await channelStore.addStream(stream);
+      fillWithMessages([
+        eg.streamMessage(stream: stream, flags: []),
+        eg.streamMessage(stream: stream, flags: [MessageFlag.starred]),
+      ]);
+      check(model.countInStarredMessagesNarrow()).equals(0);
+    });
   });
 
   group('handleMessageEvent', () {
diff --git a/test/widgets/action_sheet_test.dart b/test/widgets/action_sheet_test.dart
@@ -374,8 +374,9 @@ void main() {
 
     group('composing to reply is not yet supported', () {
       final testCases = [
-        ('CombinedFeedNarrow', const CombinedFeedNarrow(), eg.streamMessage()),
-        ('MentionsNarrow',     const MentionsNarrow(),     eg.streamMessage(flags: [MessageFlag.mentioned])),
+        ('CombinedFeedNarrow',    const CombinedFeedNarrow(),    eg.streamMessage()),
+        ('MentionsNarrow',        const MentionsNarrow(),        eg.streamMessage(flags: [MessageFlag.mentioned])),
+        ('StarredMessagesNarrow', const StarredMessagesNarrow(), eg.streamMessage(flags: [MessageFlag.starred])),
       ];
 
       for (final (narrowName, narrow, message) in testCases) {
diff --git a/test/widgets/message_list_test.dart b/test/widgets/message_list_test.dart
@@ -124,8 +124,9 @@ void main() {
   group('presents message content appropriately', () {
     // regression test for https://github.com/zulip/zulip-flutter/issues/736
     final testCases = [
-      ("Combined feed", const CombinedFeedNarrow(), <MessageFlag>[]),
-      ("MentionsNarrow", const MentionsNarrow(),    [MessageFlag.mentioned]),
+      ("Combined feed",         const CombinedFeedNarrow(),    <MessageFlag>[]),
+      ("MentionsNarrow",        const MentionsNarrow(),        [MessageFlag.mentioned]),
+      ("StarredMessagesNarrow", const StarredMessagesNarrow(), [MessageFlag.starred]),
     ];
     for (final (narrowName, narrow, flags) in testCases) {
       testWidgets('content in $narrowName not asked to consume insets (including bottom)', (tester) async {
@@ -713,11 +714,14 @@ void main() {
       group('show channel name conditionally', () {
         final mentionedMessage =
           eg.streamMessage(stream: stream, topic: 'topic name', flags: [MessageFlag.mentioned]);
+        final starredMessage =
+          eg.streamMessage(stream: stream, topic: 'topic name', flags: [MessageFlag.starred]);
         final testCases = [
-          (true,  'CombinedFeedNarrow', const CombinedFeedNarrow(),     message),
-          (true,  'MentionsNarrow',     const MentionsNarrow(),         mentionedMessage),
-          (false, 'ChannelNarrow',      ChannelNarrow(stream.streamId), message),
-          (false, 'TopicNarrow',        TopicNarrow.ofMessage(message), message)
+          (true,  'CombinedFeedNarrow',    const CombinedFeedNarrow(),     message),
+          (true,  'MentionsNarrow',        const MentionsNarrow(),         mentionedMessage),
+          (true,  'StarredMessagesNarrow', const StarredMessagesNarrow(),  starredMessage),
+          (false, 'ChannelNarrow',         ChannelNarrow(stream.streamId), message),
+          (false, 'TopicNarrow',           TopicNarrow.ofMessage(message), message)
         ];
 
         for (final (showChannelName, narrowName, narrow, message) in testCases) {

Original file line number	Diff line number	Diff line change
`@@ -223,6 +223,7 @@ class MentionAutocompleteView extends ChangeNotifier {`
`223`	`223`	`break;`
`224`	`224`	`case CombinedFeedNarrow():`
`225`	`225`	`case MentionsNarrow():`
	`226`	`+ case StarredMessagesNarrow():`
`226`	`227`	`assert(false, 'No compose box, thus no autocomplete is available in ${narrow.runtimeType}.');`
`227`	`228`	`}`
`228`	`229`	`return (userA, userB) => _compareByRelevance(userA, userB,`
Original file line number	Diff line number	Diff line change
`@@ -385,6 +385,7 @@ class MessageListView with ChangeNotifier, _MessageSequence {`
`385`	`385`	`case TopicNarrow():`
`386`	`386`	`case DmNarrow():`
`387`	`387`	`case MentionsNarrow():`
	`388`	`+ case StarredMessagesNarrow():`
`388`	`389`	`return true;`
`389`	`390`	`}`
`390`	`391`	`}`
`@@ -401,6 +402,7 @@ class MessageListView with ChangeNotifier, _MessageSequence {`
`401`	`402`	`case TopicNarrow():`
`402`	`403`	`case DmNarrow():`
`403`	`404`	`case MentionsNarrow():`
	`405`	`+ case StarredMessagesNarrow():`
`404`	`406`	`return true;`
`405`	`407`	`}`
`406`	`408`	`}`
`@@ -562,6 +564,7 @@ class MessageListView with ChangeNotifier, _MessageSequence {`
`562`	`564`
`563`	`565`	`case CombinedFeedNarrow():`
`564`	`566`	`case MentionsNarrow():`
	`567`	`+ case StarredMessagesNarrow():`
`565`	`568`	`// The messages were and remain in this narrow.`
`566`	`569`	`// TODO(#421): … except they may have become muted or not.`
`567`	`570`	`// We'll handle that at the same time as we handle muting itself changing.`
Original file line number	Diff line number	Diff line change
`@@ -141,5 +141,8 @@ Future<void> _legacyMarkNarrowAsRead(BuildContext context, Narrow narrow) async`
`141`	`141`	`messages: unreadMentions,`
`142`	`142`	`op: UpdateMessageFlagsOp.add,`
`143`	`143`	`flag: MessageFlag.read);`
	`144`	`+ case StarredMessagesNarrow():`
	`145`	`+ // TODO: Implement unreads handling.`
	`146`	`+ return;`
`144`	`147`	`}`
`145`	`148`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1072,6 +1072,7 @@ class ComposeBox extends StatelessWidget {`
`1072`	`1072`
`1073`	`1073`	`case CombinedFeedNarrow():`
`1074`	`1074`	`case MentionsNarrow():`
	`1075`	`+ case StarredMessagesNarrow():`
`1075`	`1076`	`return false;`
`1076`	`1077`	`}`
`1077`	`1078`	`}`
`@@ -1088,6 +1089,7 @@ class ComposeBox extends StatelessWidget {`
`1088`	`1089`	`return _FixedDestinationComposeBox(key: controllerKey, narrow: narrow);`
`1089`	`1090`	`case CombinedFeedNarrow():`
`1090`	`1091`	`case MentionsNarrow():`
	`1092`	`+ case StarredMessagesNarrow():`
`1091`	`1093`	`return const SizedBox.shrink();`
`1092`	`1094`	`}`
`1093`	`1095`	`}`