recent_senders: Treat topics case-insensitively

Author: chrisbobbe

lib/model/recent_senders.dart

@@ -1,9 +1,12 @@
+import 'dart:collection';
+
 import 'package:collection/collection.dart';
 import 'package:flutter/foundation.dart';
 
 import '../api/model/events.dart';
 import '../api/model/model.dart';
 import 'algorithms.dart';
+import 'channel.dart';
 
 /// Tracks the latest messages sent by each user, in each stream and topic.
 ///
@@ -16,7 +19,7 @@ class RecentSenders {
 
   // topicSenders[streamId][topic][senderId] = MessageIdTracker
   @visibleForTesting
-  final Map<int, Map<TopicName, Map<int, MessageIdTracker>>> topicSenders = {};
+  final Map<int, LinkedHashMap<TopicName, Map<int, MessageIdTracker>>> topicSenders = {};
 
   /// The latest message the given user sent to the given stream,
   /// or null if no such message is known.
@@ -53,7 +56,7 @@ class RecentSenders {
     }
     for (final entry in messagesByUserInTopic.entries) {
       final (streamId, topic, senderId) = entry.key;
-      (((topicSenders[streamId] ??= {})[topic] ??= {})
+      (((topicSenders[streamId] ??= makeTopicKeyedMap())[topic] ??= {})
         [senderId] ??= MessageIdTracker()).addAll(entry.value);
     }
   }
@@ -64,7 +67,7 @@ class RecentSenders {
     final StreamMessage(:streamId, :topic, :senderId, id: int messageId) = message;
     ((streamSenders[streamId] ??= {})
       [senderId] ??= MessageIdTracker()).add(messageId);
-    (((topicSenders[streamId] ??= {})[topic] ??= {})
+    (((topicSenders[streamId] ??= makeTopicKeyedMap())[topic] ??= {})
       [senderId] ??= MessageIdTracker()).add(messageId);
   }
 

test/model/recent_senders_checks.dart

@@ -0,0 +1,7 @@
+import 'package:checks/checks.dart';
+import 'package:collection/collection.dart';
+import 'package:zulip/model/recent_senders.dart';
+
+extension MessageIdTrackerChecks on Subject<MessageIdTracker> {
+  Subject<QueueList<int>> get ids => has((x) => x.ids, 'ids');
+}

test/model/recent_senders_test.dart

@@ -1,13 +1,19 @@
+import 'dart:collection';
+
 import 'package:checks/checks.dart';
 import 'package:flutter_test/flutter_test.dart';
+import 'package:zulip/api/model/events.dart';
 import 'package:zulip/api/model/model.dart';
+import 'package:zulip/model/channel.dart';
 import 'package:zulip/model/recent_senders.dart';
 import '../example_data.dart' as eg;
+import '../stdlib_checks.dart';
+import 'recent_senders_checks.dart';
 
 /// [messages] should be sorted by [id] ascending.
 void checkMatchesMessages(RecentSenders model, List<Message> messages) {
   final Map<int, Map<int, Set<int>>> messagesByUserInStream = {};
-  final Map<int, Map<TopicName, Map<int, Set<int>>>> messagesByUserInTopic = {};
+  final Map<int, LinkedHashMap<TopicName, Map<int, Set<int>>>> messagesByUserInTopic = {};
   for (final message in messages) {
     if (message is! StreamMessage) {
       throw UnsupportedError('Message of type ${message.runtimeType} is not expected.');
@@ -17,7 +23,7 @@ void checkMatchesMessages(RecentSenders model, List<Message> messages) {
 
     ((messagesByUserInStream[streamId] ??= {})
       [senderId] ??= {}).add(messageId);
-    (((messagesByUserInTopic[streamId] ??= {})[topic] ??= {})
+    (((messagesByUserInTopic[streamId] ??= makeTopicKeyedMap())[topic] ??= {})
       [senderId] ??= {}).add(messageId);
   }
 
@@ -125,6 +131,17 @@ void main() {
         [eg.streamMessage(stream: streamA, topic: 'other', sender: userX)]);
     });
 
+    test('case-insensitive topics', () {
+      checkHandleMessages(
+        [eg.streamMessage(stream: streamA, topic: 'thing', sender: userX)],
+        [eg.streamMessage(stream: streamA, topic: 'ThInG', sender: userX)]);
+      check(model.topicSenders).values.single.entries.single
+        ..key.equals(eg.t('thing'))
+        ..value.entries.single.which((it) => it
+          ..key.equals(userX.userId)
+          ..value.isA<MessageIdTracker>().ids.length.equals(2));
+    });
+
     test('add new stream', () {
       checkHandleMessages(
         [eg.streamMessage(stream: streamA, topic: 'thing', sender: userX)],
@@ -161,6 +178,16 @@ void main() {
       Map.fromEntries(messages.map((msg) => MapEntry(msg.id, msg))));
 
     checkMatchesMessages(model, [messages[1]]);
+
+    // check case-insensitivity
+    model.handleDeleteMessageEvent(DeleteMessageEvent(
+      id: 0,
+      messageIds: [messages[1].id],
+      messageType: MessageType.stream,
+      streamId: stream.streamId,
+      topic: eg.t('oThEr'),
+    ), {messages[1].id: messages[1]});
+    checkMatchesMessages(model, []);
   });
 
   test('RecentSenders.latestMessageIdOfSenderInStream', () {
@@ -200,6 +227,9 @@ void main() {
 
     check(model.latestMessageIdOfSenderInTopic(streamId: 1,
       topic: eg.t('a'), senderId: 10)).equals(300);
+    // case-insensitivity
+    check(model.latestMessageIdOfSenderInTopic(streamId: 1,
+      topic: eg.t('A'), senderId: 10)).equals(300);
     // No message of user 20 in topic "a".
     check(model.latestMessageIdOfSenderInTopic(streamId: 1,
       topic: eg.t('a'), senderId: 20)).equals(null);