refactor: api_types/model: Remove deprecated event types.

Remove `update_display_settings` and `update_global_notifications`
legacy event types.

Handle `twenty_four_hour_time` and `pm_content_in_desktop_notifications`
user settings inside the Model._handle_user_settings_event.

Update tests.

Author: mubarak-mustopha

tests/model/test_model.py

@@ -247,8 +247,6 @@ def test_register_initial_desired_events(self, mocker, initial_data):
             "subscription",
             "typing",
             "update_message_flags",
-            "update_global_notifications",
-            "update_display_settings",
             "user_settings",
             "realm_emoji",
             "realm_user",
@@ -263,8 +261,6 @@ def test_register_initial_desired_events(self, mocker, initial_data):
             "muted_topics",
             "realm_user",
             "realm_user_groups",
-            "update_global_notifications",
-            "update_display_settings",
             "user_settings",
             "realm_emoji",
             "custom_profile_fields",
@@ -4444,38 +4440,41 @@ def test__handle_user_settings_event(self, mocker, model, value):
         model._handle_user_settings_event(event)
         assert model.user_settings()[setting] == value
 
-    @pytest.mark.parametrize("setting", [True, False])
-    def test_update_pm_content_in_desktop_notifications(self, mocker, model, setting):
-        setting_name = "pm_content_in_desktop_notifications"
+    @pytest.mark.parametrize("value", [True, False])
+    def test_update_pm_content_in_desktop_notifications(self, mocker, model, value):
+        setting = "pm_content_in_desktop_notifications"
         event = {
-            "type": "update_global_notifications",
-            "notification_name": setting_name,
-            "setting": setting,
+            "type": "user_settings",
+            "op": "update",
+            "property": setting,
+            "value": value,
         }
-        model._user_settings[setting_name] = not setting
+        model._user_settings[setting] = not value
 
-        model._handle_update_global_notifications_event(event)
+        model._handle_user_settings_event(event)
 
-        assert model.user_settings()[setting_name] == setting
+        assert model.user_settings()[setting] == event["value"]
 
-    @pytest.mark.parametrize("setting", [True, False])
-    def test_update_twenty_four_hour_format(self, mocker, model, setting):
+    @pytest.mark.parametrize("value", [True, False])
+    def test_update_twenty_four_hour_format(self, mocker, model, value):
+        setting = "twenty_four_hour_time"
         event = {
-            "type": "update_display_settings",
-            "setting_name": "twenty_four_hour_time",
-            "setting": setting,
+            "type": "user_settings",
+            "op": "update",
+            "property": setting,
+            "value": value,
         }
         first_msg_w = mocker.Mock()
         second_msg_w = mocker.Mock()
         first_msg_w.original_widget.message = {"id": 1}
         second_msg_w.original_widget.message = {"id": 2}
         self.controller.view.message_view = mocker.Mock(log=[first_msg_w, second_msg_w])
         create_msg_box_list = mocker.patch(MODULE + ".create_msg_box_list")
-        model._user_settings["twenty_four_hour_format"] = not setting
+        model._user_settings["twenty_four_hour_format"] = not value
 
-        model._handle_update_display_settings_event(event)
+        model._handle_user_settings_event(event)
 
-        assert model.user_settings()["twenty_four_hour_time"] == event["setting"]
+        assert model.user_settings()["twenty_four_hour_time"] == event["value"]
         assert create_msg_box_list.call_count == len(
             self.controller.view.message_view.log
         )

zulipterminal/api_types.py

@@ -589,7 +589,11 @@ class UpdateRealmEmojiEvent(TypedDict):
 # -----------------------------------------------------------------------------
 # See https://zulip.com/api/get-events#user_settings-update
 # This is specifically only those supported by ZT
-SupportedUserSettings = Literal["send_private_typing_notifications"]
+SupportedUserSettings = Literal[
+    "send_private_typing_notifications",
+    "twenty_four_hour_time",
+    "pm_content_in_desktop_notifications",
+]
 
 
 class UpdateUserSettingsEvent(TypedDict):
@@ -599,30 +603,6 @@ class UpdateUserSettingsEvent(TypedDict):
     value: Any
 
 
-# -----------------------------------------------------------------------------
-# See https://zulip.com/api/get-events#update_global_notifications
-# This is specifically only those supported by ZT
-SupportedGlobalNotificationSettings = Literal["pm_content_in_desktop_notifications"]
-
-
-class UpdateGlobalNotificationsEvent(TypedDict):
-    type: Literal["update_global_notifications"]
-    notification_name: SupportedGlobalNotificationSettings
-    setting: Any
-
-
-# -----------------------------------------------------------------------------
-# See https://zulip.com/api/get-events#update_display_settings
-# This is specifically only those supported by ZT
-SupportedDisplaySettings = Literal["twenty_four_hour_time"]
-
-
-class UpdateDisplaySettingsEvent(TypedDict):
-    type: Literal["update_display_settings"]
-    setting_name: SupportedDisplaySettings
-    setting: bool
-
-
 # -----------------------------------------------------------------------------
 Event = Union[
     MessageEvent,
@@ -634,10 +614,8 @@ class UpdateDisplaySettingsEvent(TypedDict):
     SubscriptionPeerAddRemoveEvent,
     TypingEvent,
     UpdateMessageFlagsEvent,
-    UpdateDisplaySettingsEvent,
     UpdateRealmEmojiEvent,
     UpdateUserSettingsEvent,
-    UpdateGlobalNotificationsEvent,
     RealmUserEvent,
 ]
 

zulipterminal/model.py

@@ -138,8 +138,6 @@ def __init__(self, controller: Any) -> None:
             "muted_topics",
             "realm_user",  # Enables cross_realm_bots
             "realm_user_groups",
-            "update_global_notifications",
-            "update_display_settings",
             "user_settings",
             "realm_emoji",
             "custom_profile_fields",
@@ -157,8 +155,6 @@ def __init__(self, controller: Any) -> None:
             "subscription": self._handle_subscription_event,
             "typing": self._handle_typing_event,
             "update_message_flags": self._handle_update_message_flags_event,
-            "update_global_notifications": self._handle_update_global_notifications_event,  # noqa: E501
-            "update_display_settings": self._handle_update_display_settings_event,
             "user_settings": self._handle_user_settings_event,
             "realm_emoji": self._handle_update_emoji_event,
             "realm_user": self._handle_realm_user_event,
@@ -2056,29 +2052,22 @@ def _handle_user_settings_event(self, event: Event) -> None:
         # Update the setting (property) to the value, but only if already initialized
         if event["property"] in self._user_settings:
             setting = event["property"]
+            if setting == "twenty_four_hour_time":
+                self._update_display()
             self._user_settings[setting] = event["value"]
 
-    def _handle_update_global_notifications_event(self, event: Event) -> None:
-        assert event["type"] == "update_global_notifications"
-        to_update = event["notification_name"]
-        if to_update == "pm_content_in_desktop_notifications":
-            self._user_settings[to_update] = event["setting"]
-
-    def _handle_update_display_settings_event(self, event: Event) -> None:
+    def _update_display(self) -> None:
         """
         Handle change to user display setting (Eg: Time format)
         """
-        assert event["type"] == "update_display_settings"
         view = self.controller.view
-        if event["setting_name"] == "twenty_four_hour_time":
-            self._user_settings["twenty_four_hour_time"] = event["setting"]
-            for msg_w in view.message_view.log:
-                msg_box = msg_w.original_widget
-                msg_id = msg_box.message["id"]
-                last_msg = msg_box.last_message
-                msg_pos = view.message_view.log.index(msg_w)
-                msg_w_list = create_msg_box_list(self, [msg_id], last_message=last_msg)
-                view.message_view.log[msg_pos] = msg_w_list[0]
+        for msg_w in view.message_view.log:
+            msg_box = msg_w.original_widget
+            msg_id = msg_box.message["id"]
+            last_msg = msg_box.last_message
+            msg_pos = view.message_view.log.index(msg_w)
+            msg_w_list = create_msg_box_list(self, [msg_id], last_message=last_msg)
+            view.message_view.log[msg_pos] = msg_w_list[0]
         self.controller.update_screen()
 
     def _handle_realm_user_event(self, event: Event) -> None: