api: Start using 'direct' for MessageType.

We still offer support for 'private', which gets converted to 'direct'
as well when deserialized.

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

Author: PIG208

lib/api/model/events.dart

@@ -707,6 +707,9 @@ class DeleteMessageEvent extends Event {
 
   final List<int> messageIds;
   // final int messageId; // Not present; we support the bulk_message_deletion capability
+  // The server never actually sends "direct" here yet (it's "private" instead),
+  // but we accept both forms for forward-compatibility.
+  @MessageTypeConverter()
   final MessageType messageType;
   final int? streamId;
   final String? topic;
@@ -735,10 +738,25 @@ class DeleteMessageEvent extends Event {
 
 /// As in [DeleteMessageEvent.messageType]
 /// or [UpdateMessageFlagsMessageDetail.type].
-@JsonEnum(fieldRename: FieldRename.snake)
+@JsonEnum(alwaysCreate: true)
 enum MessageType {
   stream,
-  private;
+  direct;
+}
+
+class MessageTypeConverter extends JsonConverter<MessageType, String> {
+  const MessageTypeConverter();
+
+  @override
+  MessageType fromJson(String json) {
+    if (json == 'private') json = 'direct'; // TODO(server-future)
+    return $enumDecode(_$MessageTypeEnumMap, json);
+  }
+
+  @override
+  String toJson(MessageType object) {
+    return _$MessageTypeEnumMap[object]!;
+  }
 }
 
 /// A Zulip event of type `update_message_flags`.
@@ -820,6 +838,9 @@ class UpdateMessageFlagsRemoveEvent extends UpdateMessageFlagsEvent {
 /// As in [UpdateMessageFlagsRemoveEvent.messageDetails].
 @JsonSerializable(fieldRename: FieldRename.snake)
 class UpdateMessageFlagsMessageDetail {
+  // The server never actually sends "direct" here yet (it's "private" instead),
+  // but we accept both forms for forward-compatibility.
+  @MessageTypeConverter()
   final MessageType type;
   final bool? mentioned;
   final List<int>? userIds;
@@ -841,7 +862,7 @@ class UpdateMessageFlagsMessageDetail {
       case MessageType.stream:
         result.streamId as int;
         result.topic as String;
-      case MessageType.private:
+      case MessageType.direct:
         result.userIds as List<int>;
     }
     return result;

lib/api/model/events.g.dart

@@ -204,7 +204,7 @@ class DmNarrow extends Narrow implements SendableNarrow {
     UpdateMessageFlagsMessageDetail detail, {
     required int selfUserId,
   }) {
-    assert(detail.type == MessageType.private);
+    assert(detail.type == MessageType.direct);
     return DmNarrow.withOtherUsers(detail.userIds!, selfUserId: selfUserId);
   }
 

lib/model/narrow.dart

@@ -288,7 +288,7 @@ class Unreads extends ChangeNotifier {
         final streamId = event.streamId!;
         final topic = event.topic!;
         _removeAllInStreamTopic(messageIdsSet, streamId, topic);
-      case MessageType.private:
+      case MessageType.direct:
         _slowRemoveAllInDms(messageIdsSet);
     }
 
@@ -363,7 +363,7 @@ class Unreads extends ChangeNotifier {
                   final topics = (newlyUnreadInStreams[detail.streamId!] ??= {});
                   final messageIds = (topics[detail.topic!] ??= QueueList());
                   messageIds.add(messageId);
-                case MessageType.private:
+                case MessageType.direct:
                   final narrow = DmNarrow.ofUpdateMessageFlagsMessageDetail(selfUserId: selfUserId,
                     detail);
                   (newlyUnreadInDms[narrow] ??= QueueList())

lib/model/unreads.dart

@@ -60,6 +60,18 @@ extension UpdateMessageEventChecks on Subject<UpdateMessageEvent> {
   Subject<bool?> get isMeMessage => has((e) => e.isMeMessage, 'isMeMessage');
 }
 
+extension DeleteMessageEventChecks on Subject<DeleteMessageEvent> {
+  Subject<MessageType?> get messageType => has((e) => e.messageType, 'messageType');
+}
+
+extension UpdateMessageFlagsRemoveEventChecks on Subject<UpdateMessageFlagsRemoveEvent> {
+  Subject<Map<int, UpdateMessageFlagsMessageDetail>?> get messageDetails => has((e) => e.messageDetails, 'messageDetails');
+}
+
+extension UpdateMessageFlagsMessageDetailCheck on Subject<UpdateMessageFlagsMessageDetail> {
+  Subject<MessageType?> get type => has((e) => e.type, 'type');
+}
+
 extension HeartbeatEventChecks on Subject<HeartbeatEvent> {
   // No properties not covered by Event.
 }

test/api/model/events_checks.dart

@@ -153,7 +153,16 @@ void main() {
     })).throws<void>();
   });
 
-  test('update_message_flags/remove: require messageDetails in mark-as-unread', () {
+  test('delete_message: private -> direct', () {
+    check(DeleteMessageEvent.fromJson({
+      'id': 1,
+      'type': 'delete_message',
+      'message_ids': [1, 2, 3],
+      'message_type': 'private',
+    })).messageType.equals(MessageType.direct);
+  });
+
+  group('update_message_flags/remove', () {
     final baseJson = {
       'id': 1,
       'type': 'update_message_flags',
@@ -162,14 +171,30 @@ void main() {
       'messages': [123],
       'all': false,
     };
-    check(() => UpdateMessageFlagsRemoveEvent.fromJson(baseJson)).returnsNormally();
-    check(() => UpdateMessageFlagsRemoveEvent.fromJson({
-      ...baseJson, 'flag': 'read',
-    })).throws<void>();
-    check(() => UpdateMessageFlagsRemoveEvent.fromJson({
-      ...baseJson,
-      'flag': 'read',
-      'message_details': {'123': {'type': 'private', 'mentioned': false, 'user_ids': [2]}},
-    })).returnsNormally();
+    final messageDetail = {'type': 'direct', 'mentioned': false, 'user_ids': [2]};
+
+    test('require messageDetails in mark-as-unread', () {
+      check(() => UpdateMessageFlagsRemoveEvent.fromJson(baseJson)).returnsNormally();
+      check(() => UpdateMessageFlagsRemoveEvent.fromJson({
+        ...baseJson, 'flag': 'read',
+      })).throws<void>();
+      check(() => UpdateMessageFlagsRemoveEvent.fromJson({
+        ...baseJson,
+        'flag': 'read',
+        'message_details': {'123': messageDetail},
+      })).returnsNormally();
+    });
+
+    test('private -> direct', () {
+      check(UpdateMessageFlagsRemoveEvent.fromJson({
+        ...baseJson,
+        'flag': 'read',
+        'message_details': {
+          '123': {
+            ...messageDetail,
+            'type': 'private',
+          }}})).messageDetails.isNotNull()
+               .values.single.type.equals(MessageType.direct);
+    });
   });
 }

test/api/model/events_test.dart

@@ -492,7 +492,7 @@ UpdateMessageFlagsRemoveEvent updateMessageFlagsRemoveEvent(
             userIds: null,
           ),
           DmMessage() => UpdateMessageFlagsMessageDetail(
-            type: MessageType.private,
+            type: MessageType.direct,
             mentioned: mentioned,
             streamId: null,
             topic: null,

test/example_data.dart

@@ -449,7 +449,7 @@ void main() {
           ),
           DmMessage() => DeleteMessageEvent(
             id: 0,
-            messageType: MessageType.private,
+            messageType: MessageType.direct,
             messageIds: [message.id],
             streamId: null,
             topic: null,
@@ -488,7 +488,7 @@ void main() {
       model.handleDeleteMessageEvent(DeleteMessageEvent(
         id: 0,
         messageIds: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10],
-        messageType: MessageType.private,
+        messageType: MessageType.direct,
         streamId: null,
         topic: null,
       ));
@@ -523,7 +523,7 @@ void main() {
       model.handleDeleteMessageEvent(DeleteMessageEvent(
         id: 0,
         messageIds: [message.id],
-        messageType: MessageType.private,
+        messageType: MessageType.direct,
         streamId: null,
         topic: null,
       ));
@@ -968,7 +968,7 @@ void main() {
               ),
               // message 2 and 3 have their details missing
               message4.id: UpdateMessageFlagsMessageDetail(
-                type: MessageType.private,
+                type: MessageType.direct,
                 mentioned: false,
                 streamId: null,
                 topic: null,