events: Sort recipientIds for TypingEvent.

DmNarrow expects them to be sorted, so doing it early during
deserialization helps. Because of this TypingStatus no longer needs to
modify the recipientIds list.

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

Author: PIG208

lib/api/model/events.dart

@@ -1,5 +1,6 @@
 import 'package:json_annotation/json_annotation.dart';
 
+import '../../model/algorithms.dart';
 import 'json.dart';
 import 'model.dart';
 
@@ -900,16 +901,16 @@ class TypingEvent extends Event {
     required this.recipientIds,
     required this.streamId,
     required this.topic,
-  });
+  }) : assert(isSortedWithoutDuplicates(recipientIds ?? []));
 
   static Object? _readSenderId(Map<Object?, Object?> json, String key) {
     return (json['sender'] as Map<String, dynamic>)['user_id'];
   }
 
   static List<int>? _recipientIdsFromJson(Object? json) {
     if (json == null) return null;
-    return (json as List<Object?>).map(
-      (item) => (item as Map<String, Object?>)['user_id'] as int).toList();
+    return (json as Iterable<Object?>).map(
+      (item) => (item as Map<String, Object?>)['user_id'] as int).toList()..sort();
   }
 
   factory TypingEvent.fromJson(Map<String, dynamic> json) {

lib/model/typing_status.dart

@@ -3,6 +3,7 @@ import 'dart:async';
 import 'package:flutter/foundation.dart';
 
 import '../api/model/events.dart';
+import '../log.dart';
 import 'narrow.dart';
 
 /// The model for tracking the typing status organized by narrows.
@@ -64,7 +65,7 @@ class TypingStatus extends ChangeNotifier {
   void handleTypingEvent(TypingEvent event) {
     SendableNarrow narrow = switch (event.messageType) {
       MessageType.direct => DmNarrow(
-        allRecipientIds: event.recipientIds!..sort(), selfUserId: selfUserId),
+        allRecipientIds: event.recipientIds!, selfUserId: selfUserId),
       MessageType.stream => TopicNarrow(event.streamId!, event.topic!),
     };
 

test/api/model/events_test.dart

@@ -241,5 +241,12 @@ void main() {
       check(() => TypingEvent.fromJson({
         ...baseJson, 'message_type': 'stream', 'stream_id': 123})).throws<void>();
     });
+
+    test('direct type sort recipient ids', () {
+      check(TypingEvent.fromJson({
+        ...directMessageJson,
+        'recipients': [4, 10, 8, 2, 1].map((e) => {'user_id': e, 'email': '$e@example.com'}),
+      })).recipientIds.isNotNull().deepEquals([1, 2, 4, 8, 10]);
+    });
   });
 }

test/model/typing_status_test.dart

@@ -97,23 +97,6 @@ void main() {
       checkTypists({groupNarrow: [eg.otherUser, eg.thirdUser]});
       checkNotifiedOnce();
     });
-
-    test('sort dm recipients', () {
-      prepareModel(selfUserId: 5);
-      final recipientIds = [5, 4, 10, 8, 2, 1];
-
-      final eventUnsorted = TypingEvent(id: 1, op: TypingOp.start,
-        senderId: 1,
-        messageType: MessageType.direct,
-        recipientIds: recipientIds,
-        streamId: null, topic: null);
-      // DmNarrow's constructor expects the recipient IDs to be sorted,
-      // and [model.handleTypingEvent] should handle that.
-      model.handleTypingEvent(eventUnsorted);
-      check(model.typistIdsInNarrow(
-        DmNarrow(allRecipientIds: recipientIds..sort(), selfUserId: 5),
-      )).single.equals(1);
-    });
   });
 
   group('handle typing stop events', () {