home: Show starred-message count in main menu, subject to user setting

lib/api/model/events.dart

@@ -185,6 +185,7 @@ class UserSettingsUpdateEvent extends Event {
     switch (UserSettingName.fromRawString(json['property'] as String)) {
       case UserSettingName.twentyFourHourTime:
         return TwentyFourHourTimeMode.fromApiValue(value as bool?);
+      case UserSettingName.starredMessageCounts:
       case UserSettingName.displayEmojiReactionUsers:
         return value as bool;
       case UserSettingName.emojiset:

lib/api/model/initial_snapshot.dart

@@ -58,6 +58,8 @@ class InitialSnapshot {
 
   final UnreadMessagesSnapshot unreadMsgs;
 
+  final List<int> starredMessages;
+
   final List<ZulipStream> streams;
 
   // In register-queue, the name of this field is the singular "user_status",
@@ -175,6 +177,7 @@ class InitialSnapshot {
     required this.subscriptions,
     required this.channelFolders,
     required this.unreadMsgs,
+    required this.starredMessages,
     required this.streams,
     required this.userStatuses,
     required this.userSettings,
@@ -294,6 +297,7 @@ class UserSettings {
   )
   TwentyFourHourTimeMode twentyFourHourTime;
 
+  bool starredMessageCounts;
   bool displayEmojiReactionUsers;
   Emojiset emojiset;
   bool presenceEnabled;
@@ -306,6 +310,7 @@ class UserSettings {
 
   UserSettings({
     required this.twentyFourHourTime,
+    required this.starredMessageCounts,
     required this.displayEmojiReactionUsers,
     required this.emojiset,
     required this.presenceEnabled,

lib/api/model/model.dart

@@ -337,6 +337,7 @@ class UserStatusChange {
 @JsonEnum(fieldRename: FieldRename.snake, alwaysCreate: true)
 enum UserSettingName {
   twentyFourHourTime,
+  starredMessageCounts,
   displayEmojiReactionUsers,
   emojiset,
   presenceEnabled,

lib/api/route/settings.dart

@@ -16,6 +16,7 @@ Future<void> updateSettings(ApiConnection connection, {
         // TODO(server-future) allow localeDefault for servers that support it
         assert(mode != TwentyFourHourTimeMode.localeDefault);
         value = mode.toJson();
+      case UserSettingName.starredMessageCounts:
       case UserSettingName.displayEmojiReactionUsers:
         value = valueRaw as bool;
       case UserSettingName.emojiset:

lib/model/message.dart

@@ -24,6 +24,9 @@ mixin MessageStore on ChannelStore {
   /// All known messages, indexed by [Message.id].
   Map<int, Message> get messages;
 
+  /// All starred messages, as message IDs.
+  Set<int> get starredMessages;
+
   /// [OutboxMessage]s sent by the user, indexed by [OutboxMessage.localMessageId].
   Map<int, OutboxMessage> get outboxMessages;
 
@@ -208,6 +211,8 @@ mixin ProxyMessageStore on MessageStore {
   @override
   Map<int, Message> get messages => messageStore.messages;
   @override
+  Set<int> get starredMessages => messageStore.starredMessages;
+  @override
   Map<int, OutboxMessage> get outboxMessages => messageStore.outboxMessages;
   @override
   void registerMessageList(MessageListView view) =>
@@ -261,14 +266,19 @@ class _EditMessageRequestStatus {
 }
 
 class MessageStoreImpl extends HasChannelStore with MessageStore, _OutboxMessageStore {
-  MessageStoreImpl({required super.channels})
-    : // There are no messages in InitialSnapshot, so we don't have
-      // a use case for initializing MessageStore with nonempty [messages].
-      messages = {};
+  MessageStoreImpl({
+    required super.channels,
+    required List<int> initialStarredMessages,
+  }) :
+     messages = {},
+     starredMessages = Set.of(initialStarredMessages);
 
   @override
   final Map<int, Message> messages;
 
+  @override
+  final Set<int> starredMessages;
+
   @override
   final Set<MessageListView> _messageListViews = {};
 
@@ -717,23 +727,29 @@ class MessageStoreImpl extends HasChannelStore with MessageStore, _OutboxMessage
     }
   }
 
-  void handleDeleteMessageEvent(DeleteMessageEvent event) {
+  /// Handle a [DeleteMessageEvent]
+  /// and return whether the [PerAccountStore] should notify listeners.
+  bool handleDeleteMessageEvent(DeleteMessageEvent event) {
+    bool perAccountStoreShouldNotify = false;
     for (final messageId in event.messageIds) {
       messages.remove(messageId);
+      perAccountStoreShouldNotify |= starredMessages.remove(messageId);
       _maybeStaleChannelMessages.remove(messageId);
       _editMessageRequests.remove(messageId);
     }
     for (final view in _messageListViews) {
       view.handleDeleteMessageEvent(event);
     }
+    return perAccountStoreShouldNotify;
   }
 
-  void handleUpdateMessageFlagsEvent(UpdateMessageFlagsEvent event) {
+  /// Handle an [UpdateMessageFlagsEvent]
+  /// and return whether the [PerAccountStore] should notify listeners.
+  bool handleUpdateMessageFlagsEvent(UpdateMessageFlagsEvent event) {
     final isAdd = switch (event) {
       UpdateMessageFlagsAddEvent()    => true,
       UpdateMessageFlagsRemoveEvent() => false,
     };
-
     if (isAdd && (event as UpdateMessageFlagsAddEvent).all) {
       for (final message in messages.values) {
         message.flags.add(event.flag);
@@ -766,6 +782,15 @@ class MessageStoreImpl extends HasChannelStore with MessageStore, _OutboxMessage
         _notifyMessageListViews(event.messages);
       }
     }
+
+    if (event.flag == MessageFlag.starred) {
+      isAdd
+        ? starredMessages.addAll(event.messages)
+        : starredMessages.removeAll(event.messages);
+      return true;
+    }
+
+    return false;
   }
 
   void handleReactionEvent(ReactionEvent event) {

lib/model/store.dart

@@ -564,7 +564,8 @@ class PerAccountStore extends PerAccountStoreBase with
       presence: Presence(realm: realm,
         initial: initialSnapshot.presences),
       channels: channels,
-      messages: MessageStoreImpl(channels: channels),
+      messages: MessageStoreImpl(channels: channels,
+        initialStarredMessages: initialSnapshot.starredMessages),
       unreads: Unreads(core: core, channelStore: channels,
         initial: initialSnapshot.unreadMsgs),
       recentDmConversationsView: RecentDmConversationsView(core: core,
@@ -776,6 +777,8 @@ class PerAccountStore extends PerAccountStoreBase with
         switch (event.property!) {
           case UserSettingName.twentyFourHourTime:
             userSettings.twentyFourHourTime        = event.value as TwentyFourHourTimeMode;
+          case UserSettingName.starredMessageCounts:
+            userSettings.starredMessageCounts      = event.value as bool;
           case UserSettingName.displayEmojiReactionUsers:
             userSettings.displayEmojiReactionUsers = event.value as bool;
           case UserSettingName.emojiset:
@@ -877,12 +880,16 @@ class PerAccountStore extends PerAccountStoreBase with
         // specifically, their `senderId`s. By calling this after the
         // aforementioned line, we'll lose reference to those messages.
         recentSenders.handleDeleteMessageEvent(event, messages);
-        _messages.handleDeleteMessageEvent(event);
+        if (_messages.handleDeleteMessageEvent(event)) {
+          notifyListeners();
+        }
         unreads.handleDeleteMessageEvent(event);
 
       case UpdateMessageFlagsEvent():
         assert(debugLog("server event: update_message_flags/${event.op} ${event.flag.toJson()}"));
-        _messages.handleUpdateMessageFlagsEvent(event);
+        if (_messages.handleUpdateMessageFlagsEvent(event)) {
+          notifyListeners();
+        }
         unreads.handleUpdateMessageFlagsEvent(event);
 
       case SubmessageEvent():

lib/model/unreads.dart

@@ -160,9 +160,7 @@ class Unreads extends PerAccountStoreBase with ChangeNotifier {
   // TODO(#370): maintain this count incrementally, rather than recomputing from scratch
   int countInCombinedFeedNarrow() {
     int c = 0;
-    for (final messageIds in dms.values) {
-      c = c + messageIds.length;
-    }
+    c += countInAllDms();
     for (final MapEntry(key: streamId, value: topics) in streams.entries) {
       for (final MapEntry(key: topic, value: messageIds) in topics.entries) {
         if (channelStore.isTopicVisible(streamId, topic)) {
@@ -230,6 +228,15 @@ class Unreads extends PerAccountStoreBase with ChangeNotifier {
   // TODO: Implement unreads handling?
   int countInKeywordSearchNarrow() => 0;
 
+  int countInAllDms() {
+    int c = 0;
+    for (final MapEntry(key: narrow, value: messageIds) in dms.entries) {
+      if (channelStore.shouldMuteDmConversation(narrow)) continue;
+      c += messageIds.length;
+    }
+    return c;
+  }
+
   int countInNarrow(Narrow narrow) {
     switch (narrow) {
       case CombinedFeedNarrow():