helper: Store unread message data in index.

Add 'unread_msgs' attribute in index to store all data pertaining to
unread messages obtained from initial_data.

Modify classify_unread_counts to return this unread_msgs data structure.

Tests amended.

Author: kaustubh-nair

tests/conftest.py

@@ -481,7 +481,8 @@ def empty_index():
             stream_msg_template['id']: stream_msg_template,
             pm_template['id']: pm_template,
             group_pm_template['id']: group_pm_template,
-        })
+        }),
+        'unread_msgs': defaultdict(dict),
     })
 
 
@@ -720,10 +721,10 @@ def stream_dict(streams_fixture):
 @pytest.fixture
 def classified_unread_counts():
     """
-    Unread counts return by
-    helper.classify_unread_counts function.
+    Tuple of unread counts and unread_msg data
+    returned by helper.classify_unread_counts function.
     """
-    return {
+    return ({
         'all_msg': 12,
         'all_pms': 8,
         'unread_topics': {
@@ -742,4 +743,17 @@ def classified_unread_counts():
             1000: 3,
             99: 1
         }
-    }
+    }, {
+        1: {'category': 'pm', 'sender_id': 1},
+        2: {'category': 'pm', 'sender_id': 1},
+        3: {'category': 'pm', 'sender_id': 2},
+        4: {'category': 'stream', 'stream_id': 1000},
+        5: {'category': 'stream', 'stream_id': 1000},
+        6: {'category': 'stream', 'stream_id': 1000},
+        7: {'category': 'stream', 'stream_id': 99},
+        11: {'category': 'huddle', 'user_ids': frozenset({11, 12, 1001})},
+        12: {'category': 'huddle', 'user_ids': frozenset({11, 12, 1001})},
+        13: {'category': 'huddle', 'user_ids': frozenset({11, 12, 1001})},
+        101: {'category': 'huddle', 'user_ids': frozenset({11, 12, 13, 1001})},
+        102: {'category': 'huddle', 'user_ids': frozenset({11, 12, 13, 1001})},
+    })

tests/helper/test_helper.py

@@ -213,8 +213,9 @@ def test_classify_unread_counts(mocker, initial_data, stream_dict,
     model.initial_data = initial_data
     model.muted_topics = muted_topics
     model.muted_streams = muted_streams
-    assert classify_unread_counts(model) == dict(classified_unread_counts,
-                                                 **vary_in_unreads)
+    assert classify_unread_counts(model) == (dict(classified_unread_counts[0],
+                                                  **vary_in_unreads),
+                                             classified_unread_counts[1])
 
 
 @pytest.mark.parametrize('color', [

tests/model/test_model.py

@@ -34,7 +34,7 @@ def model(self, mocker, initial_data, user_profile):
         # NOTE: PATCH WHERE USED NOT WHERE DEFINED
         self.classify_unread_counts = mocker.patch(
             'zulipterminal.model.classify_unread_counts',
-            return_value=[])
+            return_value=([], {}))
         self.client.get_profile.return_value = user_profile
         model = Model(self.controller)
         return model
@@ -82,7 +82,7 @@ def test_init_InvalidAPIKey_response(self, mocker, initial_data):
                      return_value=({}, set(), [], []))
         self.classify_unread_counts = mocker.patch(
             'zulipterminal.model.classify_unread_counts',
-            return_value=[])
+            return_value=([], {}))
 
         with pytest.raises(ServerConnectionFailure) as e:
             model = Model(self.controller)
@@ -104,7 +104,7 @@ def test_init_ZulipError_exception(self, mocker, initial_data,
                      return_value=({}, set(), [], []))
         self.classify_unread_counts = mocker.patch(
             'zulipterminal.model.classify_unread_counts',
-            return_value=[])
+            return_value=([], {}))
 
         with pytest.raises(ServerConnectionFailure) as e:
             model = Model(self.controller)
@@ -441,7 +441,7 @@ def test_success_get_messages(self, mocker, messages_successful_response,
                      return_value=({}, set(), [], []))
         self.classify_unread_counts = mocker.patch(
             'zulipterminal.model.classify_unread_counts',
-            return_value=[])
+            return_value=([], {}))
 
         # Setup mocks before calling get_messages
         self.client.get_messages.return_value = messages_successful_response
@@ -481,7 +481,7 @@ def test_get_message_false_first_anchor(
                      return_value=({}, set(), [], []))
         self.classify_unread_counts = mocker.patch(
             'zulipterminal.model.classify_unread_counts',
-            return_value=[])
+            return_value=([], {}))
 
         # Setup mocks before calling get_messages
         messages_successful_response['anchor'] = 0
@@ -514,7 +514,7 @@ def test_fail_get_messages(self, mocker, error_response,
                      return_value=({}, set(), [], []))
         self.classify_unread_counts = mocker.patch(
             'zulipterminal.model.classify_unread_counts',
-            return_value=[])
+            return_value=([], {}))
 
         # Setup mock before calling get_messages
         # FIXME This has no influence on the result
@@ -593,7 +593,7 @@ def test__update_initial_data_raises_exception(self, mocker, initial_data):
                      return_value=({}, set(), [], []))
         self.classify_unread_counts = mocker.patch(
             'zulipterminal.model.classify_unread_counts',
-            return_value=[])
+            return_value=([], {}))
 
         # Setup mocks before calling get_messages
         self.client.register.return_value = initial_data
@@ -627,7 +627,7 @@ def test_get_all_users(self, mocker, initial_data, user_list, user_dict,
                      return_value=({}, set(), [], []))
         self.classify_unread_counts = mocker.patch(
             'zulipterminal.model.classify_unread_counts',
-            return_value=[])
+            return_value=([], {}))
         model = Model(self.controller)
         assert model.user_dict == user_dict
         assert model.users == user_list

zulipterminal/helper.py

@@ -39,6 +39,7 @@
     'search': Set[int],  # {message_id, ...}
     # Downloaded message data
     'messages': Dict[int, Message],  # message_id: Message
+    'unread_msgs': Dict[int, Dict[str, Any]],  # message_id: Dict
 })
 
 initial_index = Index(
@@ -54,6 +55,7 @@
     topics=defaultdict(list),
     search=set(),
     messages=defaultdict(dict),
+    unread_msgs=defaultdict(dict),
 )
 
 
@@ -362,9 +364,11 @@ def index_messages(messages: List[Message],
     return index
 
 
-def classify_unread_counts(model: Any) -> UnreadCounts:
+def classify_unread_counts(model: Any) -> Tuple[UnreadCounts,
+                                                Dict[int, Dict[str, Any]]]:
     # TODO: support group pms
     unread_msg_counts = model.initial_data['unread_msgs']
+    unread_msgs = {}  # type: Dict[int, Dict[str, Any]]
 
     unread_counts = UnreadCounts(
         all_msg=0,
@@ -376,14 +380,21 @@ def classify_unread_counts(model: Any) -> UnreadCounts:
     )
 
     for pm in unread_msg_counts['pms']:
-        count = len(pm['unread_message_ids'])
-        unread_counts['unread_pms'][pm['sender_id']] = count
+        unread_message_ids = pm['unread_message_ids']
+        count = len(unread_message_ids)
+        sender_id = pm['sender_id']
+        pm_data = {'category': 'pm', 'sender_id': sender_id}
+        unread_msgs.update(dict(zip(unread_message_ids, [pm_data]*count)))
+        unread_counts['unread_pms'][sender_id] = count
         unread_counts['all_msg'] += count
         unread_counts['all_pms'] += count
 
     for stream in unread_msg_counts['streams']:
-        count = len(stream['unread_message_ids'])
+        unread_message_ids = stream['unread_message_ids']
+        count = len(unread_message_ids)
         stream_id = stream['stream_id']
+        stream_data = {'category': 'stream', 'stream_id': stream_id}
+        unread_msgs.update(dict(zip(unread_message_ids, [stream_data]*count)))
         if [model.stream_dict[stream_id]['name'],
                 stream['topic']] in model.muted_topics:
             continue
@@ -397,14 +408,17 @@ def classify_unread_counts(model: Any) -> UnreadCounts:
 
     # store unread count of group pms in `unread_huddles`
     for group_pm in unread_msg_counts['huddles']:
-        count = len(group_pm['unread_message_ids'])
+        unread_message_ids = group_pm['unread_message_ids']
+        count = len(unread_message_ids)
         user_ids = group_pm['user_ids_string'].split(',')
         user_ids = frozenset(map(int, user_ids))
+        huddle_data = {'category': 'huddle', 'user_ids': user_ids}
+        unread_msgs.update(dict(zip(unread_message_ids, [huddle_data]*count)))
         unread_counts['unread_huddles'][user_ids] = count
         unread_counts['all_msg'] += count
         unread_counts['all_pms'] += count
 
-    return unread_counts
+    return unread_counts, unread_msgs
 
 
 def match_user(user: Any, text: str) -> bool:

zulipterminal/model.py

@@ -116,7 +116,8 @@ def __init__(self, controller: Any) -> None:
         self.user_group_by_id = {}  # type: Dict[int, Dict[str, Any]]
         self.user_group_names = self._group_info_from_realm_user_groups(groups)
 
-        self.unread_counts = classify_unread_counts(self)
+        unread_data = classify_unread_counts(self)
+        self.unread_counts, self.index['unread_msgs'] = unread_data
 
         self.fetch_all_topics(workers=5)