buttons/helper/model/utils: Support API migration for muted topics.

This reflects the expected response change for muted_topics, from
[stream_name, topic_name] to [stream_name, topic_name, date_muted] in
Zulip version 3.0, Feature level 1 (see zulip/zulip@9340cd1).

Given that we only used muted_topics for lookups, this introduces
muted_topics_lookup (built from muted_topics) data structure to avoid
server version/feature level checks everywhere in the codebase.

Tests amended.

Author: preetmishra

tests/core/test_core.py

@@ -86,6 +86,7 @@ def test_narrow_to_stream(self, mocker, controller,
         }
         controller.model.muted_streams = []
         controller.model.muted_topics = []
+        controller.model.muted_topics_lookup = []
 
         controller.narrow_to_stream(stream_button)
 
@@ -114,6 +115,7 @@ def test_narrow_to_topic(self, mocker, controller,
         }
         controller.model.muted_streams = []
         controller.model.muted_topics = []
+        controller.model.muted_topics_lookup = []
         controller.narrow_to_topic(msg_box)
         assert controller.model.stream_id == msg_box.stream_id
         assert controller.model.narrow == expected_narrow
@@ -158,6 +160,7 @@ def test_show_all_messages(self, mocker, controller, index_all_messages):
         }
         controller.model.muted_streams = []
         controller.model.muted_topics = []
+        controller.model.muted_topics_lookup = []
 
         controller.show_all_messages('')
 
@@ -192,6 +195,7 @@ def test_show_all_starred(self, mocker, controller, index_all_starred):
         controller.model.index = index_all_starred
         controller.model.muted_streams = set()  # FIXME Expand upon this
         controller.model.muted_topics = []  # FIXME Expand upon this
+        controller.model.muted_topics_lookup = []  # FIXME Expand upon this
         controller.model.user_email = "some@email"
         controller.model.stream_dict = {
             205: {
@@ -216,6 +220,7 @@ def test_show_all_mentions(self, mocker, controller, index_all_mentions):
         controller.model.index = index_all_mentions
         controller.model.muted_streams = set()  # FIXME Expand upon this
         controller.model.muted_topics = []  # FIXME Expand upon this
+        controller.model.muted_topics_lookup = []  # FIXME Expand upon this
         controller.model.user_email = "some@email"
         controller.model.stream_dict = {
             205: {

tests/helper/test_helper.py

@@ -212,7 +212,7 @@ def test_classify_unread_counts(mocker, initial_data, stream_dict,
     model = mocker.Mock()
     model.stream_dict = stream_dict
     model.initial_data = initial_data
-    model.muted_topics = muted_topics
+    model.muted_topics_lookup = muted_topics
     model.muted_streams = muted_streams
     assert classify_unread_counts(model) == dict(classified_unread_counts,
                                                  **vary_in_unreads)

tests/model/test_model.py

@@ -1519,7 +1519,7 @@ def test_is_muted_stream(self, muted_streams, stream_id, is_muted,
     def test_is_muted_topic(self, topic, is_muted, stream_dict, model):
         model.stream_dict = stream_dict
         model.muted_streams = [1]
-        model.muted_topics = [
+        model.muted_topics_lookup = [
             ['Stream 2', 'muted topic'],
             ['Stream 1', 'muted stream muted topic'],
         ]

tests/ui/test_ui_tools.py

@@ -630,6 +630,7 @@ def test_update_topics_list(self, mocker, topic_view, topic_name,
             86: {'name': 'PTEST'}
         }
         topic_view.view.controller.model.muted_topics = []
+        topic_view.view.controller.model.muted_topics_lookup = []
         topic_view.log = [mocker.Mock(topic_name=topic_name)
                           for topic_name in topic_initial_log]
 
@@ -2661,6 +2662,7 @@ def test_init_calls_top_button(self, mocker, width, count, title,
             14: {'name': 'GSoC'},
         }
         controller.model.muted_topics = []
+        controller.model.muted_topics_lookup = []
         top_button = mocker.patch(TOPBUTTON + '.__init__')
         params = dict(controller=controller,
                       width=width,
@@ -2692,7 +2694,7 @@ def test_init_calls_mark_muted(self, mocker, stream_name, title,
         mark_muted = mocker.patch(
             'zulipterminal.ui_tools.buttons.TopicButton.mark_muted')
         controller = mocker.Mock()
-        controller.model.muted_topics = muted_topics
+        controller.model.muted_topics_lookup = muted_topics
         controller.model.stream_dict = {
             205: {'name': stream_name}
         }

tests/ui/test_utils.py

@@ -84,7 +84,7 @@ def test_is_muted(mocker, msg, narrow, muted_streams, muted_topics, muted):
         mocker.Mock(return_value=(msg.get('stream_id', '') in muted_streams))
     )
     model.narrow = narrow
-    model.muted_topics = muted_topics
+    model.muted_topics_lookup = muted_topics
     return_value = is_muted(msg, model)
     assert return_value is muted
 

zulipterminal/helper.py

@@ -189,7 +189,7 @@ def _set_count_in_view(controller: Any, new_count: int,
                         break
             # FIXME: Update unread_counts['unread_topics']?
             if ([message['display_recipient'], msg_topic] in
-                    controller.model.muted_topics):
+                    controller.model.muted_topics_lookup):
                 add_to_counts = False
             if is_open_topic_view and stream_id == toggled_stream_id:
                 # If topic_view is open for incoming messages's stream,
@@ -443,7 +443,7 @@ def classify_unread_counts(model: Any) -> UnreadCounts:
         if stream_id not in model.stream_dict:
             continue
         if [model.stream_dict[stream_id]['name'],
-                stream['topic']] in model.muted_topics:
+                stream['topic']] in model.muted_topics_lookup:
             continue
         stream_topic = (stream_id, stream['topic'])
         unread_counts['unread_topics'][stream_topic] = count

zulipterminal/model.py

@@ -115,8 +115,18 @@ def __init__(self, controller: Any) -> None:
         (self.stream_dict, self.muted_streams,
          self.pinned_streams, self.unpinned_streams) = stream_data
 
+        # NOTE: The expected response has been upgraded from
+        # [stream_name, topic_name] to [stream_name, topic_name, date_muted] in
+        # 3.0, Feature level 1.
         self.muted_topics = (
-            self.initial_data['muted_topics'])  # type: List[List[str]]
+            self.initial_data['muted_topics']
+        )  # type: List[List[Union[str, int]]]
+        # The intent is to use the following data structure for lookups without
+        # having server version/feature level checks outside model.py.
+        self.muted_topics_lookup = [
+            [stream_name, topic_name]
+            for stream_name, topic_name, date_muted in self.muted_topics
+        ]
 
         groups = self.initial_data['realm_user_groups']
         self.user_group_by_id = {}  # type: Dict[int, Dict[str, Any]]
@@ -422,7 +432,7 @@ def is_muted_topic(self, stream_id: int, topic: str) -> bool:
             return True
         stream_name = self.stream_dict[stream_id]['name']
         topic_to_search = [stream_name, topic]  # type: List[str]
-        return topic_to_search in self.muted_topics
+        return topic_to_search in self.muted_topics_lookup
 
     def _update_initial_data(self) -> None:
         # Thread Processes to reduce start time.

zulipterminal/ui_tools/buttons.py

@@ -243,7 +243,7 @@ def __init__(self, stream_id: int, topic: str,
                          count=count)
 
         topic_pair = [self.stream_name, self.topic_name]
-        if topic_pair in controller.model.muted_topics:
+        if topic_pair in controller.model.muted_topics_lookup:
             self.mark_muted()
 
     def mark_muted(self) -> None:

zulipterminal/ui_tools/utils.py

@@ -60,7 +60,8 @@ def is_muted(msg: Message, model: Any) -> bool:
         return False
     elif model.is_muted_stream(msg['stream_id']):
         return True
-    elif [msg['display_recipient'], msg['subject']] in model.muted_topics:
+    elif ([msg['display_recipient'], msg['subject']] in
+          model.muted_topics_lookup):
         return True
     return False