emoji: Exclude deactivated realm emoji from autocomplete

Fixes zulip#1113.
gnprice · Dec 9, 2024 · f09aab1 · f09aab1
1 parent e564806
commit f09aab1
Show file tree

Hide file tree

Showing 2 changed files with 49 additions and 5 deletions.
diff --git a/lib/model/emoji.dart b/lib/model/emoji.dart
@@ -135,9 +135,16 @@ class EmojiStoreImpl with EmojiStore {
   /// including deactivated emoji not available for new uses.
   ///
   /// These are the emoji that can have [ReactionType.realmEmoji].
-  // TODO(#1113) limit to active realm emoji where appropriate
+  ///
+  /// For emoji available to be newly used, see [activeRealmEmoji].
   Map<String, RealmEmojiItem> allRealmEmoji;
 
+  /// The realm's custom emoji that are available for new uses
+  /// in messages and reactions.
+  Iterable<RealmEmojiItem> get activeRealmEmoji {
+    return allRealmEmoji.values.where((emoji) => !emoji.deactivated);
+  }
+
   /// The realm-relative URL of the unique "Zulip extra emoji", :zulip:.
   static const kZulipEmojiUrl = '/static/generated/emoji/images/emoji/unicode/zulip.png';
 
@@ -218,7 +225,7 @@ class EmojiStoreImpl with EmojiStore {
     final results = <EmojiCandidate>[];
 
     final namesOverridden = {
-      for (final emoji in allRealmEmoji.values) emoji.name,
+      for (final emoji in activeRealmEmoji) emoji.name,
       'zulip',
     };
     // TODO(log) if _serverEmojiData missing
@@ -242,16 +249,16 @@ class EmojiStoreImpl with EmojiStore {
         aliases: aliases));
     }
 
-    for (final entry in allRealmEmoji.entries) {
-      final emojiName = entry.value.name;
+    for (final emoji in activeRealmEmoji) {
+      final emojiName = emoji.name;
       if (emojiName == 'zulip') {
         // TODO does 'zulip' really override realm emoji?
         //   (This is copied from zulip-mobile's behavior.)
         continue;
       }
       results.add(_emojiCandidateFor(
         emojiType: ReactionType.realmEmoji,
-        emojiCode: entry.key, emojiName: emojiName,
+        emojiCode: emoji.emojiCode, emojiName: emojiName,
         aliases: null));
     }
 

diff --git a/test/model/emoji_test.dart b/test/model/emoji_test.dart
@@ -123,6 +123,31 @@ void main() {
       return store;
     }
 
+    test('realm emoji included only when active', () {
+      final store = prepare(realmEmoji: {
+        '1': eg.realmEmojiItem(emojiCode: '1', emojiName: 'abc', deactivated: true),
+        '2': eg.realmEmojiItem(emojiCode: '2', emojiName: 'abcd'),
+      });
+      check(store.allEmojiCandidates()).deepEquals([
+        isRealmCandidate(emojiCode: '2', emojiName: 'abcd'),
+        isZulipCandidate(),
+      ]);
+    });
+
+    test('realm emoji tolerate name collisions', () {
+      final store = prepare(realmEmoji: {
+        '1': eg.realmEmojiItem(emojiCode: '1', emojiName: 'test', deactivated: true),
+        '2': eg.realmEmojiItem(emojiCode: '2', emojiName: 'try', deactivated: true),
+        '3': eg.realmEmojiItem(emojiCode: '3', emojiName: 'try', deactivated: true),
+        '4': eg.realmEmojiItem(emojiCode: '4', emojiName: 'try'),
+        '5': eg.realmEmojiItem(emojiCode: '5', emojiName: 'test', deactivated: true),
+      });
+      check(store.allEmojiCandidates()).deepEquals([
+        isRealmCandidate(emojiCode: '4', emojiName: 'try'),
+        isZulipCandidate(),
+      ]);
+    });
+
     test('realm emoji overrides Unicode emoji', () {
       final store = prepare(realmEmoji: {
         '1': eg.realmEmojiItem(emojiCode: '1', emojiName: 'smiley'),
@@ -137,6 +162,18 @@ void main() {
       ]);
     });
 
+    test('deactivated realm emoji cause no override of Unicode emoji', () {
+      final store = prepare(realmEmoji: {
+        '1': eg.realmEmojiItem(emojiCode: '1', emojiName: 'ant', deactivated: true),
+      }, unicodeEmoji: {
+        '1f41c': ['ant'],
+      });
+      check(store.allEmojiCandidates()).deepEquals([
+        isUnicodeCandidate('1f41c', ['ant']),
+        isZulipCandidate(),
+      ]);
+    });
+
     test('Unicode emoji with overridden aliases survives with remaining names', () {
       final store = prepare(realmEmoji: {
         '1': eg.realmEmojiItem(emojiCode: '1', emojiName: 'tangerine'),