streams: Handle adding new stream events.

Author: Abhirup-99

tests/model/test_model.py

@@ -1735,6 +1735,114 @@ def set_from_list_of_dict(data):
         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': 'add',
+                'subscriptions': [
+                    {
+                        'name': 'all',
+                        'stream_id': 4,
+                        'description': '',
+                        'color': '#48e',
+                        'pin_to_top': False,
+                        'invite_only': False
+                    }
+                ]
+            },
+            [{
+                'name': 'test',
+                'id': 100,
+                'color': '#48a',
+                'invite_only': False,
+                'description': 'abc'
+            }],
+            [{
+                'name': 'test2',
+                'id': 101,
+                'color': '#48b',
+                'invite_only': False,
+                'description': 'lets test'
+            }, {
+                'name': 'all',
+                'id': 4,
+                'color': '#48e',
+                'invite_only': False,
+                'description': ''
+            }]
+        ),
+        (
+            {
+                'op': 'add',
+                'subscriptions': [
+                    {
+                        'name': 'design',
+                        'stream_id': 2,
+                        'description': '',
+                        'color': '#48e',
+                        'pin_to_top': True,
+                        'invite_only': False
+                    }
+                ]
+            },
+            [{
+                'name': 'test',
+                'id': 100,
+                'color': '#48a',
+                'invite_only': False,
+                'description': 'abc'
+            }, {
+                'name': 'design',
+                'id': 2,
+                'color': '#48e',
+                'invite_only': False,
+                'description': ''
+            }],
+            [{
+                'name': 'test2',
+                'id': 101,
+                'color': '#48b',
+                'invite_only': False,
+                'description': 'lets test'
+            }]
+        )], ids=[
+            'add_2',
+            'add_and_pin_4'
+        ]
+    )
+    def test__handle_subscription_event_add_stream(
+                                    self, model, mocker,
+                                    event,
+                                    expected_pinned_streams,
+                                    expected_unpinned_streams,
+                                    initial_pinned_streams=[{
+                                        'name': 'test',
+                                        'id': 100,
+                                        'color': '#48a',
+                                        'invite_only': False,
+                                        'description': 'abc'
+                                    }],
+                                    initial_unpinned_streams=[{
+                                        'name': 'test2',
+                                        'id': 101,
+                                        'color': '#48b',
+                                        'invite_only': False,
+                                        'description': 'lets test'
+                                    }]
+    ):
+
+        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,

zulipterminal/model.py

@@ -53,7 +53,8 @@
     'stream_id': int,
     'stream_ids': List[int],  # NOTE: replaces 'stream_id' in ZFL 35 for peer*
     'value': bool,
-    'message_ids': List[int]  # Present when subject of msg(s) is updated
+    'message_ids': List[int],  # Present when subject of msg(s) is updated,
+    'subscriptions': List[Dict[str, Any]]
 }, total=False)  # Each Event will only have a subset of these
 
 EditPropagateMode = Literal['change_one', 'change_all', 'change_later']
@@ -741,6 +742,14 @@ def get_stream_by_id(streams: List[StreamData], stream_id: int
                     return stream
             raise RuntimeError("Invalid stream id.")
 
+        def make_reduced_stream_data(stream: Any) -> StreamData:
+            # stream_id has been changed to id.
+            return StreamData({'name': stream['name'],
+                               'id': stream['stream_id'],
+                               'color': stream['color'],
+                               'invite_only': stream['invite_only'],
+                               'description': stream['description']})
+
         if event['op'] == 'update':
             if hasattr(self.controller, 'view'):
                 if event.get('property', None) == 'in_home_view':
@@ -785,6 +794,17 @@ def get_stream_by_id(streams: List[StreamData], stream_id: int
                     sort_streams(self.pinned_streams)
                     self.controller.view.left_panel.update_stream_view()
                     self.controller.update_screen()
+        elif event['op'] == 'add':
+            for subscription in event['subscriptions']:
+                stream_data = make_reduced_stream_data(subscription)
+                self.stream_dict[subscription['stream_id']] = subscription
+                if(subscription['pin_to_top']):
+                    self.pinned_streams.append(stream_data)
+                else:
+                    self.unpinned_streams.append(stream_data)
+            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)