model: Support API migration for muted topics.

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

Test updated with support for multiple server versions.

Author: preetmishra

tests/model/test_model.py

@@ -1516,11 +1516,20 @@ def test_is_muted_stream(self, muted_streams, stream_id, is_muted,
         ((1, 'muted stream muted topic'), True),
         ((2, 'unmuted topic'), False),
     ])
-    def test_is_in_muted_topics(self, topic, is_muted, stream_dict, model):
+    def test_is_in_muted_topics(self, topic, is_muted, stream_dict, model,
+                                zulip_version):
         model.stream_dict = stream_dict
-        model.muted_topics = [
-            ['Stream 2', 'muted topic'],
-            ['Stream 1', 'muted stream muted topic'],
-        ]
+        server_version, server_feature_level = zulip_version
+        if server_version == '3.0' and server_feature_level >= 1:
+            model.muted_topics = [
+                ['Stream 2', 'muted topic', 1530129122],
+                ['Stream 1', 'muted stream muted topic', 1530129122],
+            ]
+        elif server_version == '2.1':
+            model.muted_topics = [
+                ['Stream 2', 'muted topic'],
+                ['Stream 1', 'muted stream muted topic'],
+            ]
+
         assert model.is_in_muted_topics(stream_id=topic[0],
                                         topic=topic[1]) == is_muted

zulipterminal/model.py

@@ -115,8 +115,12 @@ 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] to [stream_name, topic, 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]]]
 
         groups = self.initial_data['realm_user_groups']
         self.user_group_by_id = {}  # type: Dict[int, Dict[str, Any]]
@@ -423,7 +427,14 @@ def is_in_muted_topics(self, stream_id: int, topic: str) -> bool:
         """
         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
+        # The intent is to use the following data structure locally for lookups
+        # without having server version & feature level checks throughout the
+        # codebase.
+        muted_topics_lookup = [
+            [stream_name, topic]
+            for stream_name, topic, *_ in self.muted_topics
+        ]
+        return topic_to_search in muted_topics_lookup
 
     def _update_initial_data(self) -> None:
         # Thread Processes to reduce start time.