api: Mark UpdateMessageEvent fields as required, relying on server 5+, FL 114+

See "Feature level 114" from Zulip API changelog:

  https://zulip.com/api/changelog

See also:

  https://zulip.com/api/get-events#update_message

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

Author: PIG208

lib/api/model/events.dart

@@ -704,13 +704,13 @@ class UpdateMessageEvent extends Event {
   @JsonKey(includeToJson: true)
   String get type => 'update_message';
 
-  final int? userId; // TODO(server-5)
-  final bool? renderingOnly; // TODO(server-5)
+  final int userId;
+  final bool renderingOnly;
   final int messageId;
   final List<int> messageIds;
 
   final List<MessageFlag> flags;
-  final int? editTimestamp; // TODO(server-5)
+  final int editTimestamp;
 
   // final String? streamName; // ignore
 

lib/api/model/events.g.dart

@@ -120,9 +120,7 @@ class MessageStoreImpl with MessageStore {
   }
 
   void _handleUpdateMessageEventTimestamp(UpdateMessageEvent event) {
-    // TODO(server-5): Cut this fallback; rely on renderingOnly from FL 114
-    final isRenderingOnly = event.renderingOnly ?? (event.userId == null);
-    if (event.editTimestamp == null || isRenderingOnly) {
+    if (event.renderingOnly) {
       // A rendering-only update gets omitted from the message edit history,
       // and [Message.lastEditTimestamp] is the last timestamp of that history.
       // So on a rendering-only update, the timestamp doesn't get updated.

lib/model/message.dart

@@ -42,12 +42,12 @@ extension MessageEventChecks on Subject<MessageEvent> {
 }
 
 extension UpdateMessageEventChecks on Subject<UpdateMessageEvent> {
-  Subject<int?> get userId => has((e) => e.userId, 'userId');
-  Subject<bool?> get renderingOnly => has((e) => e.renderingOnly, 'renderingOnly');
+  Subject<int> get userId => has((e) => e.userId, 'userId');
+  Subject<bool> get renderingOnly => has((e) => e.renderingOnly, 'renderingOnly');
   Subject<int> get messageId => has((e) => e.messageId, 'messageId');
   Subject<List<int>> get messageIds => has((e) => e.messageIds, 'messageIds');
   Subject<List<MessageFlag>> get flags => has((e) => e.flags, 'flags');
-  Subject<int?> get editTimestamp => has((e) => e.editTimestamp, 'editTimestamp');
+  Subject<int> get editTimestamp => has((e) => e.editTimestamp, 'editTimestamp');
   Subject<int?> get origStreamId => has((e) => e.origStreamId, 'origStreamId');
   Subject<int?> get newStreamId => has((e) => e.newStreamId, 'newStreamId');
   Subject<PropagateMode?> get propagateMode => has((e) => e.propagateMode, 'propagateMode');

test/api/model/events_checks.dart

@@ -529,8 +529,8 @@ DeleteMessageEvent deleteMessageEvent(List<StreamMessage> messages) {
 
 UpdateMessageEvent updateMessageEditEvent(
   Message origMessage, {
-  int? userId = -1, // null means null; default is [selfUser.userId]
-  bool? renderingOnly = false,
+  int? userId,
+  bool renderingOnly = false,
   int? messageId,
   List<MessageFlag>? flags,
   int? editTimestamp,
@@ -541,7 +541,7 @@ UpdateMessageEvent updateMessageEditEvent(
   messageId ??= origMessage.id;
   return UpdateMessageEvent(
     id: 0,
-    userId: userId == -1 ? selfUser.userId : userId,
+    userId: userId ?? selfUser.userId,
     renderingOnly: renderingOnly,
     messageId: messageId,
     messageIds: [messageId],

test/example_data.dart

@@ -258,16 +258,14 @@ void main() {
         ..content.not((it) => it.equals(updateEvent.renderedContent!));
     });
 
-    // TODO(server-5): Cut legacy case for rendering-only message update
-    Future<void> checkRenderingOnly({required bool legacy}) async {
+    test('rendering-only update does not change timestamp', () async {
       final originalMessage = eg.streamMessage(
         lastEditTimestamp: 78492,
         content: "<p>Hello, world</p>");
       final updateEvent = eg.updateMessageEditEvent(originalMessage,
         renderedContent: "<p>Hello, world</p> <div>Some link preview</div>",
         editTimestamp: 99999,
-        renderingOnly: legacy ? null : true,
-        userId: null,
+        renderingOnly: true,
       );
       await prepare();
       await prepareMessages([originalMessage]);
@@ -282,14 +280,6 @@ void main() {
         // ... edit timestamp is not.
         ..lastEditTimestamp.equals(originalMessage.lastEditTimestamp)
         ..lastEditTimestamp.not((it) => it.equals(updateEvent.editTimestamp));
-    }
-
-    test('rendering-only update does not change timestamp', () async {
-      await checkRenderingOnly(legacy: false);
-    });
-
-    test('rendering-only update does not change timestamp (for old server versions)', () async {
-      await checkRenderingOnly(legacy: true);
     });
 
     group('Handle message edit state update', () {