model: Restore matchContent/matchTopic but remove them in reconcileMessages

This reverts commit ac7be16 while still keeping these
per-keyword-search fields out of MessageStore (by removing them in
reconcileMessages).

Related: #1663

Author: chrisbobbe

lib/api/model/events.dart

@@ -763,6 +763,11 @@ class MessageEvent extends Event {
   // In the server API, the `flags` field appears directly on the event rather
   // than on the message object.  To avoid proliferating message types, we
   // normalize that away in deserialization.
+  //
+  // The other difference in the server API between message objects in these
+  // events and in the get-messages results is that `matchContent` and
+  // `matchTopic` are absent here.  Already [Message.matchContent] and
+  // [Message.matchTopic] are optional, so no action is needed on that.
   @JsonKey(readValue: _readMessageValue, fromJson: Message.fromJson, includeToJson: false)
   final Message message;
 

lib/api/model/model.dart

@@ -865,8 +865,9 @@ sealed class Message<T extends Conversation> extends MessageBase<T> {
   // final string type; // handled by runtime type of object
   @JsonKey(fromJson: _flagsFromJson)
   List<MessageFlag> flags; // Unrecognized flags won't roundtrip through {to,from}Json.
-  // TODO(#1663) Add matchContent and matchTopic back again;
-  //   revert the commit that removed these and related test/comment changes.
+  String? matchContent;
+  @JsonKey(name: 'match_subject')
+  String? matchTopic;
 
   static MessageEditState _messageEditStateFromJson(Object? json) {
     // This is a no-op so that [MessageEditState._readFromMessage]
@@ -911,6 +912,8 @@ sealed class Message<T extends Conversation> extends MessageBase<T> {
     required this.senderRealmStr,
     required super.timestamp,
     required this.flags,
+    required this.matchContent,
+    required this.matchTopic,
   });
 
   // TODO(dart): This has to be a static method, because factories/constructors
@@ -994,6 +997,8 @@ class StreamMessage extends Message<StreamConversation> {
     required super.senderRealmStr,
     required super.timestamp,
     required super.flags,
+    required super.matchContent,
+    required super.matchTopic,
     required this.conversation,
   });
 
@@ -1054,6 +1059,8 @@ class DmMessage extends Message<DmConversation> {
     required super.senderRealmStr,
     required super.timestamp,
     required super.flags,
+    required super.matchContent,
+    required super.matchTopic,
     required this.conversation,
   });
 

lib/api/model/model.g.dart

@@ -52,9 +52,14 @@ mixin MessageStore {
   /// to the store.
   ///
   /// The list's length will not change, but some entries may be replaced
-  /// by a different [Message] object with the same [Message.id].
+  /// by a different [Message] object with the same [Message.id],
+  /// or mutated to remove [Message.matchContent] and [Message.matchTopic]
+  /// (since these are appropriate for search views but not the central store).
   /// All [Message] objects in the resulting list will be present in
   /// [this.messages].
+  ///
+  /// [Message.matchTopic] and [Message.matchContent] should be captured,
+  /// as needed for search, before this is called.
   void reconcileMessages(List<Message> messages);
 
   /// Whether the current edit request for the given message, if any, has failed.
@@ -280,7 +285,11 @@ class MessageStoreImpl extends PerAccountStoreBase with MessageStore, _OutboxMes
     // those events' changes.  So we always stick with the version we have.
     for (int i = 0; i < messages.length; i++) {
       final message = messages[i];
-      messages[i] = this.messages.putIfAbsent(message.id, () => message);
+      messages[i] = this.messages.putIfAbsent(message.id, () {
+        message.matchContent = null;
+        message.matchTopic = null;
+        return message;
+      });
     }
   }
 

lib/model/message.dart

@@ -942,6 +942,10 @@ class PerAccountStore extends PerAccountStoreBase with ChangeNotifier, EmojiStor
 
       case MessageEvent():
         assert(debugLog("server event: message ${jsonEncode(event.message.toJson())}"));
+        // Assert against malformed events that might be created in test code.
+        assert(event.message.matchContent == null);
+        assert(event.message.matchTopic == null);
+
         _messages.handleMessageEvent(event);
         unreads.handleMessageEvent(event);
         recentDmConversationsView.handleMessageEvent(event);

lib/model/store.dart

@@ -69,6 +69,8 @@ extension MessageChecks on Subject<Message> {
   Subject<Poll?> get poll => has((e) => e.poll, 'poll');
   Subject<String> get type => has((e) => e.type, 'type');
   Subject<List<MessageFlag>> get flags => has((e) => e.flags, 'flags');
+  Subject<String?> get matchContent => has((e) => e.matchContent, 'matchContent');
+  Subject<String?> get matchTopic => has((e) => e.matchTopic, 'matchTopic');
 }
 
 extension StreamMessageChecks on Subject<StreamMessage> {

test/api/model/model_checks.dart

@@ -93,6 +93,13 @@ void main() {
         .topic.equals(const TopicName('hello'));
     });
 
+    test('match_subject -> matchTopic', () {
+      check(baseStreamJson()).not((it) => it.containsKey('match_topic'));
+      check(Message.fromJson(baseStreamJson()
+        ..['match_subject'] = 'yo'
+      )).matchTopic.equals('yo');
+    });
+
     test('no crash on unrecognized flag', () {
       final m1 = Message.fromJson(
         (deepToJson(eg.streamMessage()) as Map<String, dynamic>)

test/api/model/model_test.dart

@@ -522,6 +522,8 @@ StreamMessage streamMessage({
   List<Reaction>? reactions,
   int? timestamp,
   List<MessageFlag>? flags,
+  String? matchContent,
+  String? matchTopic,
   List<Submessage>? submessages,
 }) {
   _checkPositive(id, 'message ID');
@@ -545,6 +547,8 @@ StreamMessage streamMessage({
     'submessages': submessages ?? [],
     'timestamp': timestamp ?? 1678139636,
     'type': 'stream',
+    'match_content': matchContent,
+    'match_subject': matchTopic,
   }) as Map<String, dynamic>);
 }
 

test/example_data.dart

@@ -518,6 +518,37 @@ void main() {
       check(messages).single.identicalTo(message);
       check(store.messages).deepEquals({1: message});
     });
+
+    test('matchContent and matchTopic are removed', () async {
+      await prepare();
+      final message1 = eg.streamMessage(id: 1, content: '<p>foo</p>');
+      await addMessages([message1]);
+      check(store.messages).deepEquals({1: message1});
+      final otherMessage1 = eg.streamMessage(id: 1, content: '<p>foo</p>',
+        matchContent: 'some highlighted content',
+        matchTopic: 'some highlighted topic');
+      final message2 = eg.streamMessage(id: 2, content: '<p>bar</p>',
+        matchContent: 'some highlighted content',
+        matchTopic: 'some highlighted topic');
+      final messages = [otherMessage1, message2];
+      store.reconcileMessages(messages);
+
+      Condition<Object?> conditionIdenticalAndNullMatchFields(Message message) {
+        return (it) => it.isA<Message>()
+                         ..identicalTo(message)
+                         ..matchContent.isNull()..matchTopic.isNull();
+      }
+
+      check(messages).deepEquals([
+        conditionIdenticalAndNullMatchFields(message1),
+        conditionIdenticalAndNullMatchFields(message2),
+      ]);
+
+      check(store.messages).deepEquals({
+        1: conditionIdenticalAndNullMatchFields(message1),
+        2: conditionIdenticalAndNullMatchFields(message2),
+      });
+    });
   });
 
   group('edit-message methods', () {