test [nfc]: Split eg.updateMessageMoveEvent helper.

When testing, in some cases it is more convenient to prepare the
original messages with the topic/stream prior to the move or the other
way around. To keep the fallback behavior consistent in either cases, we
introduce two variants that produce an UpdateMessageEvent suitable for
different contexts.

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

Author: PIG208

test/example_data.dart

@@ -463,26 +463,28 @@ UpdateMessageEvent updateMessageEditEvent(
   );
 }
 
-UpdateMessageEvent updateMessageMoveEvent(
-  List<Message> messages, {
+UpdateMessageEvent _updateMessageMoveEvent(
+  List<int> messageIds, {
+  required int origStreamId,
   int? newStreamId,
-  String? origTopic,
+  required String origTopic,
   String? newTopic,
   String? origContent,
   String? newContent,
+  required List<MessageFlag> flags,
 }) {
-  assert(messages.isNotEmpty);
-  final origMessage = messages[0];
-  final messageId = origMessage.id;
+  assert(newTopic != origTopic
+         || (newStreamId != null && newStreamId != origStreamId));
+  assert(messageIds.isNotEmpty);
   return UpdateMessageEvent(
     id: 0,
     userId: selfUser.userId,
     renderingOnly: false,
-    messageId: messageId,
-    messageIds: messages.map((message) => message.id).toList(),
-    flags: origMessage.flags,
+    messageId: messageIds.first,
+    messageIds: messageIds,
+    flags: flags,
     editTimestamp: 1234567890, // TODO generate timestamp
-    origStreamId: origMessage is StreamMessage ? origMessage.streamId : null,
+    origStreamId: origStreamId,
     newStreamId: newStreamId,
     propagateMode: null,
     origTopic: origTopic,
@@ -495,6 +497,54 @@ UpdateMessageEvent updateMessageMoveEvent(
   );
 }
 
+/// An [UpdateMessageEvent] where [origMessages] are moved to somewhere else.
+UpdateMessageEvent updateMessageEventMoveFrom({
+  required List<StreamMessage> origMessages,
+  int? newStreamId,
+  String? newTopic,
+  String? newContent,
+}) {
+  assert(origMessages.isNotEmpty);
+  final origMessage = origMessages.first;
+  // Only present on content change.
+  final origContent = (newContent != null) ? origMessage.content : null;
+  return _updateMessageMoveEvent(origMessages.map((e) => e.id).toList(),
+    origStreamId: origMessage.streamId,
+    newStreamId: newStreamId,
+    origTopic: origMessage.topic,
+    newTopic: newTopic,
+    origContent: origContent,
+    newContent: newContent,
+    flags: origMessage.flags,
+  );
+}
+
+/// An [UpdateMessageEvent] where [newMessages] are moved from somewhere.
+UpdateMessageEvent updateMessageEventMoveTo({
+  required List<StreamMessage> newMessages,
+  int? origStreamId,
+  String? origTopic,
+  String? origContent,
+}) {
+  assert(newMessages.isNotEmpty);
+  final newMessage = newMessages.first;
+  // Only present on topic move.
+  final newTopic = (origTopic != null) ? newMessage.topic : null;
+  // Only present on channel move.
+  final newStreamId = (origStreamId != null) ? newMessage.streamId : null;
+  // Only present on content change.
+  final newContent = (origContent != null) ? newMessage.content : null;
+  return _updateMessageMoveEvent(newMessages.map((e) => e.id).toList(),
+    origStreamId: origStreamId ?? newMessage.streamId,
+    newStreamId: newStreamId,
+    origTopic: origTopic ?? newMessage.topic,
+    newTopic:  newTopic,
+    origContent: origContent,
+    newContent: newContent,
+    flags: newMessage.flags,
+  );
+}
+
 UpdateMessageFlagsRemoveEvent updateMessageFlagsRemoveEvent(
   MessageFlag flag,
   Iterable<Message> messages, {

test/model/message_test.dart

@@ -297,73 +297,63 @@ void main() {
 
       test('message topic moved update', () async {
         await prepareOrigMessages(origTopic: 'old topic');
-        await store.handleEvent(eg.updateMessageMoveEvent(
-          origMessages,
-          origTopic: 'old topic',
+        await store.handleEvent(eg.updateMessageEventMoveFrom(
+          origMessages: origMessages,
           newTopic:  'new topic'));
         checkNotifiedOnce();
         check(store).messages.values.every(((message) => message.editState.equals(MessageEditState.moved)));
       });
 
       test('message topic resolved update', () async {
         await prepareOrigMessages(origTopic: 'new topic');
-        await store.handleEvent(eg.updateMessageMoveEvent(
-          origMessages,
-          origTopic: 'new topic',
+        await store.handleEvent(eg.updateMessageEventMoveFrom(
+          origMessages: origMessages,
           newTopic:  '✔ new topic'));
         checkNotifiedOnce();
         check(store).messages.values.every(((message) => message.editState.equals(MessageEditState.none)));
       });
 
       test('message topic unresolved update', () async {
         await prepareOrigMessages(origTopic: '✔ new topic');
-        await store.handleEvent(eg.updateMessageMoveEvent(
-          origMessages,
-          origTopic: '✔ new topic',
+        await store.handleEvent(eg.updateMessageEventMoveFrom(
+          origMessages: origMessages,
           newTopic:  'new topic'));
         checkNotifiedOnce();
         check(store).messages.values.every(((message) => message.editState.equals(MessageEditState.none)));
       });
 
       test('message topic both resolved and edited update', () async {
         await prepareOrigMessages(origTopic: 'new topic');
-        await store.handleEvent(eg.updateMessageMoveEvent(
-          origMessages,
-          origTopic: 'new topic',
+        await store.handleEvent(eg.updateMessageEventMoveFrom(
+          origMessages: origMessages,
           newTopic:  '✔ new topic 2'));
         checkNotifiedOnce();
         check(store).messages.values.every(((message) => message.editState.equals(MessageEditState.moved)));
       });
 
       test('message topic both unresolved and edited update', () async {
         await prepareOrigMessages(origTopic: '✔ new topic');
-        await store.handleEvent(eg.updateMessageMoveEvent(
-          origMessages,
-          origTopic: '✔ new topic',
+        await store.handleEvent(eg.updateMessageEventMoveFrom(
+          origMessages: origMessages,
           newTopic:  'new topic 2'));
         checkNotifiedOnce();
         check(store).messages.values.every(((message) => message.editState.equals(MessageEditState.moved)));
       });
 
       test('message stream moved without topic change', () async {
         await prepareOrigMessages(origTopic: 'topic');
-        await store.handleEvent(eg.updateMessageMoveEvent(
-          origMessages,
-          origTopic: 'topic',
-          newTopic: 'topic',
-          newStreamId:  20));
+        await store.handleEvent(eg.updateMessageEventMoveFrom(
+          origMessages: origMessages,
+          newStreamId: 20));
         checkNotifiedOnce();
         check(store).messages.values.every(((message) => message.editState.equals(MessageEditState.moved)));
       });
 
       test('message is both moved and updated', () async {
         await prepareOrigMessages(origTopic: 'topic', origContent: 'old content');
-        await store.handleEvent(eg.updateMessageMoveEvent(
-          origMessages,
-          origTopic: 'topic',
-          newTopic: 'topic',
-          newStreamId:  20,
-          origContent: 'old content',
+        await store.handleEvent(eg.updateMessageEventMoveFrom(
+          origMessages: origMessages,
+          newStreamId: 20,
           newContent: 'new content'));
         checkNotifiedOnce();
         check(store).messages[origMessages[0].id].editState.equals(MessageEditState.edited);

test/widgets/message_list_test.dart

@@ -965,17 +965,17 @@ void main() {
     });
 
     testWidgets('edited and moved messages from events', (WidgetTester tester) async {
-      final message = eg.streamMessage();
-      final message2 = eg.streamMessage();
+      final message = eg.streamMessage(topic: 'old');
+      final message2 = eg.streamMessage(topic: 'old');
       await setupMessageListPage(tester, messages: [message, message2]);
       checkMarkersCount(edited: 0, moved: 0);
 
       await store.handleEvent(eg.updateMessageEditEvent(message, renderedContent: 'edited'));
       await tester.pump();
       checkMarkersCount(edited: 1, moved: 0);
 
-      await store.handleEvent(eg.updateMessageMoveEvent(
-        [message, message2], origTopic: 'old', newTopic: 'new'));
+      await store.handleEvent(eg.updateMessageEventMoveFrom(
+        origMessages: [message, message2], newTopic: 'new'));
       await tester.pump();
       checkMarkersCount(edited: 1, moved: 1);
 
@@ -1030,8 +1030,9 @@ void main() {
       final rectsBefore = captureMessageRects(tester, messages, messageWithMarker);
       checkMarkersCount(edited: 0, moved: 0);
 
-      await store.handleEvent(eg.updateMessageMoveEvent(
-        [messageWithMarker], origTopic: 'old', newTopic: messageWithMarker.topic));
+      // TODO(#150): [messageWithMarker]'s topic in store is inconsistent with the event. This will be fixed soon.
+      await store.handleEvent(eg.updateMessageEventMoveTo(
+        origTopic: 'old', newMessages: [messageWithMarker]));
       await tester.pump();
       check(captureMessageRects(tester, messages, messageWithMarker))
         .deepEquals(rectsBefore);