model/api_types: Update after alert_words event.Test adapted/added.

Tests are added for _handle_alert_words_event.

Author: Subhasish-Behera

tests/model/test_model.py

@@ -227,6 +227,7 @@ def test_register_initial_desired_events(self, mocker, initial_data):
         model = Model(self.controller)
 
         event_types = [
+            "alert_words",
             "message",
             "update_message",
             "reaction",
@@ -2623,6 +2624,49 @@ def test__handle_reaction_event_for_msg_in_index(
     def update_message_flags_operation(self, request):
         return request.param
 
+    @pytest.mark.parametrize(
+        "event,initial_alerted_words, expected_alert_words",
+        [
+            case(
+                {"type": "alert_words", "alert_words": ["word1", "word2", "word3"]},
+                ["word1"],
+                ["word1", "word2", "word3"],
+                id="Add multiple alert words",
+            ),
+            case(
+                {"type": "alert_words", "alert_words": []},
+                ["word1"],
+                [],
+                id="Empty alert words",
+            ),
+            case(
+                {"type": "alert_words", "alert_words": ["word1", "word4"]},
+                ["word1"],
+                ["word1", "word4"],
+                id="Add single new alert words",
+            ),
+            case(
+                {"type": "alert_words", "alert_words": ["word1", "word2"]},
+                ["word1", "word2", "word3"],
+                ["word1", "word2"],
+                id="Delete an alert word",
+            ),
+            case(
+                {"type": "alert_words", "alert_words": ["word1", "word3"]},
+                ["word1", "word2"],
+                ["word1", "word3"],
+                id="Add and delete alert words",
+            ),
+        ],
+    )
+    def test__handle_alert_words_event(
+        self, mocker, model, event, initial_alerted_words, expected_alert_words
+    ):
+        model._handle_alert_words_event(event)
+
+        assert model._alert_words != initial_alerted_words
+        assert model._alert_words == expected_alert_words
+
     def test_update_star_status_no_index(
         self, mocker, model, update_message_flags_operation
     ):

zulipterminal/api_types.py

@@ -344,6 +344,11 @@ class UpdateGlobalNotificationsEvent(TypedDict):
     setting: Any
 
 
+class AlertWordEvent(TypedDict):
+    type: Literal["alert_words"]
+    alert_words: List[str]
+
+
 Event = Union[
     MessageEvent,
     UpdateMessageEvent,
@@ -356,6 +361,7 @@ class UpdateGlobalNotificationsEvent(TypedDict):
     UpdateUserSettingsEvent,
     UpdateGlobalNotificationsEvent,
     RealmUserEvent,
+    AlertWordEvent,
 ]
 
 ###############################################################################

zulipterminal/model.py

@@ -143,6 +143,7 @@ def __init__(self, controller: Any) -> None:
 
         # Events desired with their corresponding callback
         self.event_actions: Dict[str, Callable[[Event], None]] = {
+            "alert_words": self._handle_alert_words_event,
             "message": self._handle_message_event,
             "update_message": self._handle_update_message_event,
             "reaction": self._handle_reaction_event,
@@ -1369,6 +1370,13 @@ def get_stream_by_id(streams: List[StreamData], stream_id: int) -> StreamData:
                         for user_id in user_ids:
                             subscribers.remove(user_id)
 
+    def _handle_alert_words_event(self, event: Event) -> None:
+        """
+        Handle alert_words events
+        """
+        assert event["type"] == "alert_words"
+        self._alert_words = event["alert_words"]
+
     def _handle_typing_event(self, event: Event) -> None:
         """
         Handle typing notifications (in private messages)