model: Fetch realm emoji from initial data.

Earlier, an API call to get_realm_emoji() was used to fetch changes
to realm emoji. This commit allows the initial update of realm emoji
directly from initial_data.
The process_realm_emoji_data() function processes the dictionary
passed to it and converts it to the NamedEmojiData type.
The existing code to obtain all_emoji_data is used in the
generate_all_emoji_data() function to create the dictionary
containing all the active emojis whenever required.

Author: mkp6781

tests/conftest.py

@@ -538,6 +538,22 @@ def initial_data(logged_on_user, users_fixture, streams_fixture):
                 }
             }
         },
+        "realm_emoji": {
+            "1": {
+                "author_id": 5,
+                "deactivated": False,
+                "id": "1",
+                "name": "green_tick",
+                "source_url": "/user_avatars/1/emoji/images/1.png"
+            },
+            "202020": {
+                "author_id": 5,
+                "deactivated": False,
+                "id": "202020",
+                "name": "joker",
+                "source_url": "/user_avatars/202020/emoji/images/202020.png"
+            },
+        },
         'last_event_id': -1,
         'muted_topics': [],
         'realm_user_groups': [],

tests/model/test_model.py

@@ -42,8 +42,6 @@ def model(self, mocker, initial_data, user_profile,
         self.client.get_profile.return_value = user_profile
         mocker.patch('zulipterminal.model.unicode_emojis',
                      EMOJI_DATA=unicode_emojis)
-        mocker.patch('zulipterminal.model.Model.fetch_custom_emojis',
-                     return_value=custom_emojis)
         model = Model(self.controller)
         return model
 
@@ -81,8 +79,10 @@ def test_init(self, model, initial_data, user_profile,
         zulip_emoji = {
                 'zulip': {'code': 'zulip', 'type': 'zulip_extra_emoji'}
         }
+        initial_realm_emoji = initial_data['realm_emoji']
+        realm_emojis = model.process_realm_emoji_data(initial_realm_emoji)
         assert model.active_emoji_data == OrderedDict(sorted(
-            {**unicode_emojis, **custom_emojis, **zulip_emoji}.items(),
+            {**unicode_emojis, **realm_emojis, **zulip_emoji}.items(),
             key=lambda e: e[0]
         ))
         # Custom emoji replaces unicode emoji with same name.
@@ -187,6 +187,7 @@ def test_register_initial_desired_events(self, mocker, initial_data):
             'muted_topics',
             'realm_user',
             'realm_user_groups',
+            'realm_emoji',
             'zulip_version',
         ]
         model.client.register.assert_called_once_with(
@@ -1995,15 +1996,25 @@ def test_user_name_from_id_invalid(self, model, user_id):
                     'id': '100',
                     'name': 'urwid',
                 },
+                '3': {
+                    'deactivated': False,
+                    'id': '3',
+                    'name': 'dancing',
+                },
                 '20': {
                     'deactivated': False,
                     'id': '20',
                     'name': 'snape',
                 },
-                '3': {
+                '202020': {
                     'deactivated': False,
-                    'id': '3',
-                    'name': 'dancing',
+                    'id': '202020',
+                    'name': 'joker',
+                },
+                '12345': {
+                    'deactivated': False,
+                    'id': '12345',
+                    'name': 'zulip',
                 },
                 '81': {  # Not included in custom_emojis because deactivated.
                     'deactivated': True,
@@ -2015,11 +2026,10 @@ def test_user_name_from_id_invalid(self, model, user_id):
             'result': 'success'
         }
     ])
-    def test_fetch_custom_emojis(self, mocker, model, custom_emojis,
-                                 response):
-        self.client.get_realm_emoji.return_value = response
-
-        fetched_custom_emojis = model.fetch_custom_emojis()
+    def test_process_realm_emoji_data(self, mocker, model,
+                                      custom_emojis, response):
+        realm_emojis = response['emoji']
+        fetched_custom_emojis = model.process_realm_emoji_data(realm_emojis)
 
         assert fetched_custom_emojis == custom_emojis
 

zulipterminal/model.py

@@ -53,7 +53,9 @@
     'stream_id': int,
     'stream_ids': List[int],  # NOTE: replaces 'stream_id' in ZFL 35 for peer*
     'value': bool,
-    'message_ids': List[int]  # Present when subject of msg(s) is updated
+    'message_ids': List[int],  # Present when subject of msg(s) is updated
+    # realm emoji:
+    'realm_emoji': Dict[str, Any]
 }, total=False)  # Each Event will only have a subset of these
 
 EditPropagateMode = Literal['change_one', 'change_all', 'change_later']
@@ -141,18 +143,9 @@ def __init__(self, controller: Any) -> None:
         self.unread_counts = classify_unread_counts(self)
 
         self._draft = None  # type: Optional[Message]
-        unicode_emoji_data = unicode_emojis.EMOJI_DATA
-        for name, data in unicode_emoji_data.items():
-            data['type'] = 'unicode_emoji'
-        typed_unicode_emoji_data = cast(NamedEmojiData, unicode_emoji_data)
-        custom_emoji_data = self.fetch_custom_emojis()
-        zulip_extra_emoji = {
-                'zulip': {'code': 'zulip', 'type': 'zulip_extra_emoji'}
-        }  # type: NamedEmojiData
-        all_emoji_data = {**typed_unicode_emoji_data,
-                          **custom_emoji_data,
-                          **zulip_extra_emoji}.items()
-        self.active_emoji_data = OrderedDict(sorted(all_emoji_data,
+        all_emoji_data = self.generate_all_emoji_data(
+                                        self.initial_data['realm_emoji'])
+        self.active_emoji_data = OrderedDict(sorted(all_emoji_data.items(),
                                                     key=lambda e: e[0]))
 
         self.new_user_input = True
@@ -397,13 +390,28 @@ def update_stream_message(self, topic: str, message_id: int,
         display_error_if_present(response, self.controller)
         return response['result'] == 'success'
 
-    def fetch_custom_emojis(self) -> NamedEmojiData:
-        response = self.client.get_realm_emoji()
+    def generate_all_emoji_data(self,
+                                custom_emoji: Dict[str,
+                                                   Any]) -> NamedEmojiData:
+        unicode_emoji_data = unicode_emojis.EMOJI_DATA
+        for name, data in unicode_emoji_data.items():
+            data['type'] = 'unicode_emoji'
+        typed_unicode_emoji_data = cast(NamedEmojiData, unicode_emoji_data)
+        custom_emoji_data = self.process_realm_emoji_data(custom_emoji)
+        zulip_extra_emoji = {
+                'zulip': {'code': 'zulip', 'type': 'zulip_extra_emoji'}
+        }  # type: NamedEmojiData
+        all_emoji_data = {**typed_unicode_emoji_data,
+                          **custom_emoji_data,
+                          **zulip_extra_emoji}
+        return all_emoji_data
+
+    def process_realm_emoji_data(self,
+                                 emoji_data: Dict[str, Any]) -> NamedEmojiData:
         custom_emojis = {emoji['name']: {'code': emoji_code,
                                          'type': 'realm_emoji'}
-                         for emoji_code, emoji in response['emoji'].items()
+                         for emoji_code, emoji in emoji_data.items()
                          if not emoji['deactivated']}  # type: NamedEmojiData
-        display_error_if_present(response, self.controller)
         return custom_emojis
 
     def get_messages(self, *,
@@ -1184,6 +1192,7 @@ def _register_desired_events(self, *, fetch_data: bool=False) -> str:
             'muted_topics',
             'realm_user',  # Enables cross_realm_bots
             'realm_user_groups',
+            'realm_emoji',
             # zulip_version and zulip_feature_level are always returned in
             # POST /register from Feature level 3.
             'zulip_version',