model: Update index['unread_msgs'] when appending messages.

Entries are added to unread message datastructure when new messsages are
added, so that unread count can be updated.

Tests amended.

Author: kaustubh-nair

tests/model/test_model.py

@@ -650,7 +650,7 @@ def test__handle_message_event_with_Falsey_log(self, mocker,
         model.found_newest = True
         mocker.patch('zulipterminal.model.Model._update_topic_index')
         index_msg = mocker.patch('zulipterminal.model.index_messages',
-                                 return_value={})
+                                 return_value=initial_index)
         model.msg_list = mocker.Mock(log=[])
         create_msg_box_list = mocker.patch('zulipterminal.model.'
                                            'create_msg_box_list',
@@ -671,7 +671,7 @@ def test__handle_message_event_with_valid_log(self, mocker,
         model.found_newest = True
         mocker.patch('zulipterminal.model.Model._update_topic_index')
         index_msg = mocker.patch('zulipterminal.model.index_messages',
-                                 return_value={})
+                                 return_value=initial_index)
         model.msg_list = mocker.Mock(log=[mocker.Mock()])
         create_msg_box_list = mocker.patch('zulipterminal.model.'
                                            'create_msg_box_list',
@@ -689,12 +689,37 @@ def test__handle_message_event_with_valid_log(self, mocker,
          assert_called_once_with(model, [message_fixture['id']],
                                  last_message=expected_last_msg))
 
+    @pytest.mark.parameter('unread_msgs', [
+        ({'type': 'stream', 'stream_id': 5140,
+          'subject': 'Test', 'display_recipient': 'PTEST'}),
+        ({'type': 'private', 'sender_id': '5140'}),
+        ({'type': 'private', 'display_recipient':
+            [{
+                'id': 5179,
+                'is_mirror_dummy': False,
+                'full_name': 'Boo Boo',
+                'short_name': 'boo',
+                'email': 'boo@zulip.com',
+            }, {
+                'short_name': 'foo',
+                'id': 5140,
+                'is_mirror_dummy': False,
+                'full_name': 'Foo Foo',
+                'email': 'foo@zulip.com',
+            }, {
+                'short_name': 'bar',
+                'id': 5180,
+                'is_mirror_dummy': False,
+                'full_name': 'Bar Bar',
+                'email': 'bar@zulip.com',
+            }]}),
+        ])
     def test__handle_message_event_with_flags(self, mocker,
                                               model, message_fixture):
         model.found_newest = True
         mocker.patch('zulipterminal.model.Model._update_topic_index')
         index_msg = mocker.patch('zulipterminal.model.index_messages',
-                                 return_value={})
+                                 return_value=initial_index)
         model.msg_list = mocker.Mock()
         create_msg_box_list = mocker.patch('zulipterminal.model.'
                                            'create_msg_box_list',
@@ -720,8 +745,9 @@ def test__handle_message_event_with_flags(self, mocker,
 
     @pytest.mark.parametrize('response, narrow, recipients, log', [
         ({'type': 'stream', 'stream_id': 1, 'subject': 'FOO',
-          'id': 1}, [], frozenset(), ['msg_w']),
-        ({'type': 'private', 'id': 1},
+          'id': 1, 'display_recipient': 'a'}, [], frozenset(), ['msg_w']),
+        ({'type': 'private', 'id': 1, 'sender_id': 1,
+          'display_recipient': []},
          [['is', 'private']], frozenset(), ['msg_w']),
         ({'type': 'stream', 'id': 1, 'stream_id': 1, 'subject': 'FOO',
           'display_recipient': 'a'},
@@ -734,14 +760,15 @@ def test__handle_message_event_with_flags(self, mocker,
           'display_recipient': 'a'},
          [['stream', 'c'], ['topic', 'b']],
          frozenset(), []),
-        ({'type': 'private', 'id': 1,
+        ({'type': 'private', 'id': 1, 'sender_id': 5827,
           'display_recipient': [{'id': 5827}, {'id': 5}]},
          [['pm_with', 'notification-bot@zulip.com']],
          frozenset({5827, 5}), ['msg_w']),
-        ({'type': 'private', 'id': 1},
+        ({'type': 'private', 'id': 1, 'sender_id': 5827,
+          'display_recipient': []},
          [['is', 'search']],
          frozenset(), []),
-        ({'type': 'private', 'id': 1,
+        ({'type': 'private', 'id': 1, 'sender_id': 5827,
           'display_recipient': [{'id': 5827}, {'id': 3212}]},
          [['pm_with', 'notification-bot@zulip.com']],
          frozenset({5827, 5}), []),
@@ -759,7 +786,7 @@ def test__handle_message_event(self, mocker, user_profile, response,
         model.found_newest = True
         mocker.patch('zulipterminal.model.Model._update_topic_index')
         index_msg = mocker.patch('zulipterminal.model.index_messages',
-                                 return_value={})
+                                 return_value=initial_index)
         create_msg_box_list = mocker.patch('zulipterminal.model.'
                                            'create_msg_box_list',
                                            return_value=["msg_w"])

zulipterminal/model.py

@@ -732,9 +732,28 @@ def _handle_message_event(self, event: Event) -> None:
             self.controller.update_screen()
             self._notified_user_of_notification_failure = True
 
-        # Index messages before calling set_count.
         self.index = index_messages([message], self, self.index)
         if 'read' not in message['flags']:
+            if message['type'] == 'stream':
+                unread_data = {'type': 'stream', 'display_recipient':
+                               message['display_recipient'],
+                               'stream_id': message['stream_id'],
+                               'subject': message['subject'],
+                               'flags': message['flags']}
+            elif len(message['display_recipient']) <= 2:
+                # pm and self-pm
+                unread_data = {'type': 'private',
+                               'sender_id': message['sender_id'],
+                               'flags': message['flags']}
+            else:
+                # huddles
+                message_recipients = frozenset(
+                    [user['id'] for user in message['display_recipient']])
+                unread_data = {'type': 'private',
+                               'display_recipient': message_recipients,
+                               'flags': message['flags']}
+            self.index['unread_msgs'].update(
+                            {int(message['id']): unread_data})
             set_count([message['id']], self.controller, 1)
 
         if hasattr(self.controller, 'view') and self.found_newest: