streams: Handle remove stream events.

Author: Abhirup-99

tests/model/test_model.py

@@ -1843,6 +1843,78 @@ def test__handle_subscription_event_add_stream(
         update_left_panel.assert_called_once_with()
         model.controller.update_screen.assert_called_once_with()
 
+    @pytest.mark.parametrize(['event', 'expected_pinned_streams',
+                             'expected_unpinned_streams'], [
+        (
+            {
+                'op': 'remove',
+                'subscriptions': [{
+                    'name': 'design',
+                    'stream_id': 2
+                }]
+            },
+            [],
+            [{
+                'name': 'all',
+                'id': 4,
+                'color': '#48e',
+                'invite_only': False,
+                'description': ''
+            }]
+        ),
+        (
+            {
+                'op': 'remove',
+                'subscriptions': [{
+                    'name': 'all',
+                    'stream_id': 4
+                }]
+            },
+            [{
+                'name': 'design',
+                'id': 2,
+                'color': '#48e',
+                'invite_only': False,
+                'description': ''
+            }],
+            []
+        )], ids=[
+            'remove_2',
+            'remove_4'
+        ]
+    )
+    def test__handle_subscription_event_remove_stream(
+                                    self, model, mocker,
+                                    event,
+                                    expected_pinned_streams,
+                                    expected_unpinned_streams,
+                                    initial_pinned_streams=[{
+                                        'name': 'design',
+                                        'id': 2,
+                                        'color': '#48e',
+                                        'invite_only': False,
+                                        'description': ''
+                                    }],
+                                    initial_unpinned_streams=[{
+                                        'name': 'all',
+                                        'id': 4,
+                                        'color': '#48e',
+                                        'invite_only': False,
+                                        'description': ''
+                                    }]
+    ):
+
+        model.pinned_streams = deepcopy(initial_pinned_streams)
+        model.unpinned_streams = deepcopy(initial_unpinned_streams)
+
+        model._handle_subscription_event(event)
+
+        assert model.pinned_streams == expected_pinned_streams
+        assert model.unpinned_streams == expected_unpinned_streams
+        update_left_panel = model.controller.view.left_panel.update_stream_view
+        update_left_panel.assert_called_once_with()
+        model.controller.update_screen.assert_called_once_with()
+
     @pytest.mark.parametrize(['event', 'feature_level',
                               'stream_id', 'expected_subscribers'], [
         ({'op': 'peer_add', 'stream_id': 99, 'user_id': 12}, None,
@@ -2008,6 +2080,42 @@ def test_is_user_subscribed_to_stream(self, model, stream_dict, stream_id,
 
         assert return_value == expected_response
 
+    @pytest.mark.parametrize('stream_id, expected_response,', [
+            (2, False),
+            (4, False),
+            (3, True),
+        ],
+        ids=[
+            'subscribed_pinned_stream',
+            'subscribed_unpinned_stream',
+            'unsubscribed_stream',
+        ]
+    )
+    def test_is_user_view_in_removed_stream(self, model, stream_dict,
+                                            stream_id, expected_response,
+                                            pinned_streams=[{
+                                                'name': 'design',
+                                                'id': 2,
+                                                'color': '#48e',
+                                                'invite_only': False,
+                                                'description': ''
+                                            }],
+                                            unpinned_streams=[{
+                                                'name': 'all',
+                                                'id': 4,
+                                                'color': '#48e',
+                                                'invite_only': False,
+                                                'description': ''
+                                            }]):
+
+        model.pinned_streams = deepcopy(pinned_streams)
+        model.unpinned_streams = deepcopy(unpinned_streams)
+        return_value = model.is_user_view_in_removed_stream(stream_id)
+
+        assert model.pinned_streams == pinned_streams
+        assert model.unpinned_streams == unpinned_streams
+        assert return_value == expected_response
+
     @pytest.mark.parametrize('response', [{
         'result': 'success',
         'msg': '',

tests/ui/test_ui_tools.py

@@ -74,6 +74,7 @@ def mock_external_classes(self, mocker):
         self.model = mocker.MagicMock()
         self.view = mocker.Mock()
         self.urwid = mocker.patch(VIEWS + ".urwid")
+        self.model.is_user_view_in_removed_stream.return_value = False
 
     @pytest.fixture
     def msg_view(self, mocker, msg_box):
@@ -811,6 +812,7 @@ def mock_external_classes(self, mocker):
         self.super = mocker.patch(VIEWS + '.urwid.Frame.__init__')
         self.super_keypress = mocker.patch(VIEWS + '.urwid.Frame.keypress')
         self.model.controller == mocker.Mock()
+        self.model.is_user_view_in_removed_stream.return_value = False
 
     @pytest.fixture
     def mid_col_view(self):
@@ -1259,6 +1261,7 @@ class TestMessageBox:
     def mock_external_classes(self, mocker, initial_index):
         self.model = mocker.MagicMock()
         self.model.index = initial_index
+        self.model.is_user_view_in_removed_stream.return_value = False
 
     @pytest.mark.parametrize('message_type, set_fields', [
         ('stream',

tests/ui_tools/test_boxes.py

@@ -14,6 +14,7 @@ class TestWriteBox:
     def mock_external_classes(self, mocker, initial_index):
         self.view = mocker.Mock()
         self.view.model = mocker.Mock()
+        self.view.model.is_user_view_in_removed_stream.return_value = False
 
     @pytest.fixture()
     def write_box(self, mocker, users_fixture, user_groups_fixture,

zulipterminal/model.py

@@ -730,6 +730,15 @@ def toggle_stream_pinned_status(self, stream_id: int) -> bool:
     def is_user_subscribed_to_stream(self, stream_id: int) -> bool:
         return stream_id in self.stream_dict
 
+    def is_user_view_in_removed_stream(self, stream_id: int) -> bool:
+        for stream in self.pinned_streams:
+            if stream['id'] == stream_id:
+                return False
+        for stream in self.unpinned_streams:
+            if stream['id'] == stream_id:
+                return False
+        return True
+
     def _handle_subscription_event(self, event: Event) -> None:
         """
         Handle changes in subscription (eg. muting/unmuting,
@@ -805,6 +814,21 @@ def make_reduced_stream_data(stream: Any) -> StreamData:
             self.controller.view.left_panel.update_stream_view()
             self.controller.update_screen()
 
+        elif event['op'] == 'remove':
+            for stream_info in event['subscriptions']:
+                stream_id = stream_info['stream_id']
+                try:
+                    stream = get_stream_by_id(self.pinned_streams,
+                                              stream_id)
+                    self.pinned_streams.remove(stream)
+                except RuntimeError:
+                    stream = get_stream_by_id(self.unpinned_streams,
+                                              stream_id)
+                    self.unpinned_streams.remove(stream)
+
+            self.controller.view.left_panel.update_stream_view()
+            self.controller.update_screen()
+
         elif event['op'] in ('peer_add', 'peer_remove'):
             # NOTE: ZFL 35 commit was not atomic with API change
             #       (ZFL >=35 can use new plural style)

zulipterminal/ui_tools/boxes.py

@@ -77,6 +77,10 @@ def private_box_view(self, button: Any=None, email: str='',
 
     def stream_box_view(self, stream_id: int, caption: str='', title: str='',
                         ) -> None:
+        if(self.model.is_user_view_in_removed_stream(stream_id)):
+            self.model.controller.view.set_footer_text(
+                " You can't reply to messages from unsubscribed streams.", 3)
+            return
         self.set_editor_mode()
         self.stream_id = stream_id
         self.recipient_user_ids = self.model.get_other_subscribers_in_stream(
@@ -1133,6 +1137,11 @@ def keypress(self, size: urwid_Size, key: str) -> Optional[str]:
                     stream_id=self.stream_id,
                 )
         elif is_command_key('STREAM_MESSAGE', key):
+            if(self.model.is_user_view_in_removed_stream(self.stream_id)):
+                self.model.controller.view.set_footer_text(
+                        " You can't write messages from unsubscribed streams.",
+                        3)
+                return None
             if self.message['type'] == 'private':
                 self.model.controller.view.write_box.private_box_view(
                     email=self.recipients_emails,
@@ -1177,13 +1186,18 @@ def keypress(self, size: urwid_Size, key: str) -> Optional[str]:
                 recipient_user_ids=[self.message['sender_id']],
             )
         elif is_command_key('MENTION_REPLY', key):
-            self.keypress(size, 'enter')
-            mention = '@**' + self.message['sender_full_name'] + '** '
-            self.model.controller.view.write_box.msg_write_box.set_edit_text(
-                mention)
-            self.model.controller.view.write_box.msg_write_box.set_edit_pos(
-                len(mention))
-            self.model.controller.view.middle_column.set_focus('footer')
+            if(not self.model.is_user_view_in_removed_stream(self.stream_id)):
+                self.keypress(size, 'enter')
+                mention = '@**' + self.message['sender_full_name'] + '** '
+                write_box = self.model.controller.view.write_box.msg_write_box
+                write_box.set_edit_text(mention)
+                write_box.set_edit_pos(len(mention))
+                self.model.controller.view.middle_column.set_focus('footer')
+            else:
+                self.model.controller.view.set_footer_text(
+                    " You can't reply to messages from unsubscribed streams.",
+                    3)
+                return key
         elif is_command_key('QUOTE_REPLY', key):
             self.keypress(size, 'enter')
             quote = '```quote\n' + self.model.client.get_raw_message(
@@ -1194,6 +1208,11 @@ def keypress(self, size: urwid_Size, key: str) -> Optional[str]:
                 len(quote))
             self.model.controller.view.middle_column.set_focus('footer')
         elif is_command_key('EDIT_MESSAGE', key):
+            if(self.model.is_user_view_in_removed_stream(self.stream_id)):
+                self.model.controller.view.set_footer_text(
+                        " You can't edit messages from unsubscribed streams.",
+                        3)
+                return key
             if self.message['sender_id'] != self.model.user_id:
                 self.model.controller.view.set_footer_text(
                         " You can't edit messages sent by other users.", 3)

zulipterminal/ui_tools/views.py

@@ -538,13 +538,22 @@ def keypress(self, size: urwid_Size, key: str) -> Optional[str]:
             return key
 
         elif is_command_key('STREAM_MESSAGE', key):
+            if(self.model.is_user_view_in_removed_stream(
+               self.model.stream_id)):
+                self.model.controller.view.set_footer_text(
+                        " You can't write messages from unsubscribed streams.",
+                        3)
+                return None
             self.body.keypress(size, 'c')
+
             # For new streams with no previous conversation.
             if self.footer.focus is None:
                 stream_id = self.model.stream_id
                 stream_dict = self.model.stream_dict
                 self.footer.stream_box_view(
-                    caption=stream_dict[stream_id]['name'])
+                    caption=stream_dict[stream_id]['name'],
+                    stream_id=stream_id
+                    )
             self.set_focus('footer')
             self.footer.focus_position = 0
             return key