channel: Keep get-stream-topics data up-to-date

Fixes: #1499

Author: PIG208

lib/model/channel.dart

@@ -1,8 +1,15 @@
+import 'dart:async';
+
+import 'package:collection/collection.dart';
 import 'package:flutter/foundation.dart';
 
 import '../api/model/events.dart';
 import '../api/model/initial_snapshot.dart';
 import '../api/model/model.dart';
+import '../api/route/channels.dart';
+import 'store.dart';
+
+final _apiGetStreamTopics = getStreamTopics;  // similar to _apiSendMessage in lib/model/message.dart
 
 /// The portion of [PerAccountStore] for channels, topics, and stuff about them.
 ///
@@ -34,6 +41,26 @@ mixin ChannelStore {
   /// and [streamsByName].
   Map<int, Subscription> get subscriptions;
 
+  /// Fetch topics in a stream from the server.
+  ///
+  /// The results from the last successful fetch
+  /// can be retrieved with [getStreamTopics].
+  Future<void> fetchTopics(int streamId);
+
+  /// Pairs of the known topics and its latest message ID, in the given stream.
+  ///
+  /// Returns null if the data has never been fetched yet.
+  /// To fetch it from the server, use [fetchTopics].
+  ///
+  /// The result is guaranteed to be sorted by [GetStreamTopicsEntry.maxId], and the
+  /// topics are guaranteed to be distinct.
+  ///
+  /// In some cases, the same maxId affected by message moves can be present in
+  /// multiple [GetStreamTopicsEntry] entries.  For this reason, the caller
+  /// should not rely on [getStreamTopics] to determine which topic the message
+  /// is in.  Instead, refer to [PerAccountStore.messages].
+  List<GetStreamTopicsEntry>? getStreamTopics(int streamId);
+
   /// The visibility policy that the self-user has for the given topic.
   ///
   /// This does not incorporate the user's channel-level policy,
@@ -208,6 +235,34 @@ class ChannelStoreImpl extends PerAccountStoreBase with ChannelStore {
   @override
   final Map<int, Subscription> subscriptions;
 
+  /// Maps indexed by stream IDs, of the known latest message IDs in each topic.
+  ///
+  /// For example: `_latestMessageIdsByStreamTopic[stream.id][topic] = maxId`
+  ///
+  /// In some cases, the same message IDs, when affected by message moves, can
+  /// be present for mutliple stream-topic keys.
+  final Map<int, Map<TopicName, int>> _latestMessageIdsByStreamTopic = {};
+
+  @override
+  Future<void> fetchTopics(int streamId) async {
+    final result = await _apiGetStreamTopics(connection, streamId: streamId,
+      allowEmptyTopicName: true);
+    _latestMessageIdsByStreamTopic[streamId] = {
+      for (final GetStreamTopicsEntry(:name, :maxId) in result.topics)
+        name: maxId,
+    };
+  }
+
+  @override
+  List<GetStreamTopicsEntry>? getStreamTopics(int streamId) {
+    final latestMessageIdsInStream = _latestMessageIdsByStreamTopic[streamId];
+    if (latestMessageIdsInStream == null) return null;
+    return [
+      for (final MapEntry(:key, :value) in latestMessageIdsInStream.entries)
+        GetStreamTopicsEntry(maxId: value, name: key),
+    ].sortedBy((value) => -value.maxId);
+  }
+
   @override
   Map<int, Map<TopicName, UserTopicVisibilityPolicy>> get debugTopicVisibility => topicVisibility;
 
@@ -374,4 +429,45 @@ class ChannelStoreImpl extends PerAccountStoreBase with ChannelStore {
       forStream[event.topicName] = visibilityPolicy;
     }
   }
+
+  /// Handle a [MessageEvent], returning whether listeners should be notified.
+  bool handleMessageEvent(MessageEvent event) {
+    if (event.message is! StreamMessage) return false;
+    final StreamMessage(:streamId, :topic) = event.message as StreamMessage;
+
+    final latestMessageIdsByTopic = _latestMessageIdsByStreamTopic[streamId];
+    if (latestMessageIdsByTopic == null) return false;
+    assert(!latestMessageIdsByTopic.containsKey(topic)
+           || latestMessageIdsByTopic[topic]! < event.message.id);
+    latestMessageIdsByTopic[topic] = event.message.id;
+    return true;
+  }
+
+  /// Handle a [UpdateMessageEvent], returning whether listeners should be
+  /// notified.
+  bool handleUpdateMessageEvent(UpdateMessageEvent event) {
+    if (event.moveData == null) return false;
+    final UpdateMessageMoveData(
+      :origStreamId, :origTopic, :newStreamId, :newTopic, :propagateMode,
+    ) = event.moveData!;
+    bool shouldNotify = false;
+
+    final origLatestMessageIdsByTopics = _latestMessageIdsByStreamTopic[origStreamId];
+    if (propagateMode == PropagateMode.changeAll
+        && origLatestMessageIdsByTopics != null) {
+      shouldNotify = origLatestMessageIdsByTopics.remove(origTopic) != null;
+    }
+
+    final newLatestMessageIdsByTopics = _latestMessageIdsByStreamTopic[newStreamId];
+    if (newLatestMessageIdsByTopics != null) {
+      final movedMaxId = event.messageIds.max;
+      if (!newLatestMessageIdsByTopics.containsKey(newTopic)
+          || newLatestMessageIdsByTopics[newTopic]! < movedMaxId) {
+        newLatestMessageIdsByTopics[newTopic] = movedMaxId;
+        shouldNotify = true;
+      }
+    }
+
+    return shouldNotify;
+  }
 }

lib/model/store.dart

@@ -13,6 +13,7 @@ import '../api/exception.dart';
 import '../api/model/events.dart';
 import '../api/model/initial_snapshot.dart';
 import '../api/model/model.dart';
+import '../api/route/channels.dart';
 import '../api/route/events.dart';
 import '../api/route/messages.dart';
 import '../api/backoff.dart';
@@ -694,6 +695,12 @@ class PerAccountStore extends PerAccountStoreBase with ChangeNotifier, EmojiStor
   Map<String, ZulipStream> get streamsByName => _channels.streamsByName;
   @override
   Map<int, Subscription> get subscriptions => _channels.subscriptions;
+
+  @override
+  Future<void> fetchTopics(int streamId) => _channels.fetchTopics(streamId);
+  @override
+  List<GetStreamTopicsEntry>? getStreamTopics(int streamId) =>
+    _channels.getStreamTopics(streamId);
   @override
   UserTopicVisibilityPolicy topicVisibilityPolicy(int streamId, TopicName topic) =>
     _channels.topicVisibilityPolicy(streamId, topic);
@@ -891,13 +898,15 @@ class PerAccountStore extends PerAccountStoreBase with ChangeNotifier, EmojiStor
         unreads.handleMessageEvent(event);
         recentDmConversationsView.handleMessageEvent(event);
         recentSenders.handleMessage(event.message); // TODO(#824)
+        if (_channels.handleMessageEvent(event)) notifyListeners();
         // When adding anything here (to handle [MessageEvent]),
         // it probably belongs in [reconcileMessages] too.
 
       case UpdateMessageEvent():
         assert(debugLog("server event: update_message ${event.messageId}"));
         _messages.handleUpdateMessageEvent(event);
         unreads.handleUpdateMessageEvent(event);
+        if (_channels.handleUpdateMessageEvent(event)) notifyListeners();
 
       case DeleteMessageEvent():
         assert(debugLog("server event: delete_message ${event.messageIds}"));

lib/widgets/topic_list.dart

@@ -4,6 +4,7 @@ import '../api/model/model.dart';
 import '../api/route/channels.dart';
 import '../generated/l10n/zulip_localizations.dart';
 import '../model/narrow.dart';
+import '../model/store.dart';
 import '../model/unreads.dart';
 import 'action_sheet.dart';
 import 'app_bar.dart';
@@ -128,16 +129,13 @@ class _TopicList extends StatefulWidget {
 
 class _TopicListState extends State<_TopicList> with PerAccountStoreAwareStateMixin {
   Unreads? unreadsModel;
-  // TODO(#1499): store the results on [ChannelStore], and keep them
-  //   up-to-date by handling events
-  List<GetStreamTopicsEntry>? lastFetchedTopics;
 
   @override
   void onNewStore() {
     unreadsModel?.removeListener(_modelChanged);
     final store = PerAccountStoreWidget.of(context);
     unreadsModel = store.unreads..addListener(_modelChanged);
-    _fetchTopics();
+    _fetchTopics(store);
   }
 
   @override
@@ -152,31 +150,30 @@ class _TopicListState extends State<_TopicList> with PerAccountStoreAwareStateMi
     });
   }
 
-  void _fetchTopics() async {
+  void _fetchTopics(PerAccountStore store) async {
     // Do nothing when the fetch fails; the topic-list will stay on
     // the loading screen, until the user navigates away and back.
     // TODO(design) show a nice error message on screen when this fails
-    final store = PerAccountStoreWidget.of(context);
-    final result = await getStreamTopics(store.connection,
-      streamId: widget.streamId,
-      allowEmptyTopicName: true);
+    await store.fetchTopics(widget.streamId);
     if (!mounted) return;
     setState(() {
-      lastFetchedTopics = result.topics;
+      // The actuall state lives in the PerAccountStore
     });
   }
 
   @override
   Widget build(BuildContext context) {
-    if (lastFetchedTopics == null) {
+    final store = PerAccountStoreWidget.of(context);
+    final streamTopics = store.getStreamTopics(widget.streamId);
+    if (streamTopics == null) {
       return const Center(child: CircularProgressIndicator());
     }
 
     // TODO(design) handle the rare case when `lastFetchTopics` is empty
 
     // This is adapted from parts of the build method on [_InboxPageState].
     final topicItems = <_TopicItemData>[];
-    for (final GetStreamTopicsEntry(:maxId, name: topic) in lastFetchedTopics!) {
+    for (final GetStreamTopicsEntry(:maxId, name: topic) in streamTopics) {
       final unreadMessageIds =
         unreadsModel!.streams[widget.streamId]?[topic] ?? <int>[];
       final countInTopic = unreadMessageIds.length;
@@ -186,9 +183,6 @@ class _TopicListState extends State<_TopicList> with PerAccountStoreAwareStateMi
         topic: topic,
         unreadCount: countInTopic,
         hasMention: hasMention,
-        // `lastFetchedTopics.maxId` can become outdated when a new message
-        // arrives or when there are message moves, until we re-fetch.
-        // TODO(#1499): track changes to this
         maxId: maxId,
       ));
     }
@@ -237,6 +231,14 @@ class _TopicItem extends StatelessWidget {
     final isTopicVisibleInStream = store.isTopicVisibleInStream(streamId, topic);
     final visibilityIcon = iconDataForTopicVisibilityPolicy(
       store.topicVisibilityPolicy(streamId, topic));
+    // The message with `maxId` might not remain in `topic` since we last fetch
+    // the list of topics.  Make sure we check for that before passing `maxId`
+    // to the topic action sheet.
+    // See also: [ChannelStore.getStreamTopics]
+    final message = store.messages[maxId];
+    final isMaxIdInTopic = message is StreamMessage
+      && message.streamId == streamId
+      && message.topic.isSameAs(topic);
 
     final trailingWidgets = [
       if (hasMention) const _IconMarker(icon: ZulipIcons.at_sign),
@@ -255,7 +257,7 @@ class _TopicItem extends StatelessWidget {
         onLongPress: () => showTopicActionSheet(context,
           channelId: streamId,
           topic: topic,
-          someMessageIdInTopic: maxId),
+          someMessageIdInTopic: isMaxIdInTopic ? maxId : null),
         splashFactory: NoSplash.splashFactory,
         child: Padding(padding: EdgeInsetsDirectional.fromSTEB(28, 8, 12, 8),
           child: Row(

test/api/route/route_checks.dart

@@ -1,8 +1,15 @@
 import 'package:checks/checks.dart';
+import 'package:zulip/api/model/model.dart';
+import 'package:zulip/api/route/channels.dart';
 import 'package:zulip/api/route/messages.dart';
 
 extension SendMessageResultChecks on Subject<SendMessageResult> {
   Subject<int> get id => has((e) => e.id, 'id');
 }
 
+extension GetStreamTopicEntryChecks on Subject<GetStreamTopicsEntry> {
+  Subject<int> get maxId => has((e) => e.maxId, 'maxId');
+  Subject<TopicName> get name => has((e) => e.name, 'name');
+}
+
 // TODO add similar extensions for other classes in api/route/*.dart