refactor: core: Change report_error argument type to list.

Change argument type of report_error from text: str to
text: List[Union[str, Tuple[Literal["footer_contrast"], str]]].

Author: srdeotarse

tests/core/test_core.py

@@ -430,7 +430,7 @@ def test_open_in_browser_fail__no_browser_controller(
 
         controller.open_in_browser("https://chat.zulip.org/#narrow/stream/test")
 
-        mocked_report_error.assert_called_once_with(f"ERROR: {error}")
+        mocked_report_error.assert_called_once_with([f"ERROR: {error}"])
 
     def test_main(self, mocker: MockerFixture, controller: Controller) -> None:
         controller.view.palette = {"default": "theme_properties"}

tests/helper/test_helper.py

@@ -327,7 +327,7 @@ def test_display_error_if_present(
     display_error_if_present(response, controller)
 
     if footer_updated:
-        report_error.assert_called_once_with(response["msg"])
+        report_error.assert_called_once_with([response["msg"]])
     else:
         report_error.assert_not_called()
 

tests/ui/test_ui.py

@@ -459,7 +459,7 @@ def test_keypress_OPEN_DRAFT(
             view.middle_column.set_focus.assert_called_once_with("footer")
         else:
             view.controller.report_error.assert_called_once_with(
-                "No draft message was saved in this session."
+                ["No draft message was saved in this session."]
             )
 
     @pytest.mark.parametrize("key", keys_for_command("SEARCH_PEOPLE"))

tests/ui/test_ui_tools.py

@@ -2582,7 +2582,7 @@ def test_keypress_EDIT_MESSAGE(
                     [expect_footer_text[message_type]]
                 )
             else:
-                report_error.assert_called_once_with(expect_footer_text[message_type])
+                report_error.assert_called_once_with([expect_footer_text[message_type]])
 
     @pytest.mark.parametrize(
         "raw_html, expected_content",

tests/ui_tools/test_boxes.py

@@ -362,7 +362,7 @@ def test_footer_notification_on_invalid_recipients(
         size = widget_size(write_box)
         write_box.keypress(size, key)
 
-        self.view.controller.report_error.assert_called_once_with(expected_lines)
+        self.view.controller.report_error.assert_called_once_with([expected_lines])
         # If there are invalid recipients, we expect the focus
         # to remain in the to_write_box.
         assert write_box.focus_position == write_box.FOCUS_CONTAINER_HEADER

zulipterminal/core.py

@@ -400,8 +400,9 @@ def open_in_browser(self, url: str) -> None:
             and os.environ.get("TERM")
         ):
             self.report_error(
-                "No DISPLAY environment variable specified. This could "
-                "likely mean the ZT host is running without a GUI."
+                [
+                    "No DISPLAY environment variable specified. This could likely mean the ZT host is running without a GUI."
+                ]
             )
             return
         try:
@@ -418,7 +419,7 @@ def open_in_browser(self, url: str) -> None:
                 )
         except webbrowser.Error as e:
             # Set a footer text if no runnable browser is located
-            self.report_error(f"ERROR: {e}")
+            self.report_error([f"ERROR: {e}"])
 
     @asynch
     def show_typing_notification(self) -> None:
@@ -439,7 +440,11 @@ def show_typing_notification(self) -> None:
         self.is_typing_notification_in_progress = False
         self.view.set_footer_text()
 
-    def report_error(self, text: str, duration: int = 3) -> None:
+    def report_error(
+        self,
+        text: List[Union[str, Tuple[Literal["footer_contrast"], str]]],
+        duration: int = 3,
+    ) -> None:
         """
         Helper to show an error message in footer
         """

zulipterminal/helper.py

@@ -639,7 +639,7 @@ def canonicalize_color(color: str) -> str:
 
 def display_error_if_present(response: Dict[str, Any], controller: Any) -> None:
     if response["result"] == "error" and hasattr(controller, "view"):
-        controller.report_error(response["msg"])
+        controller.report_error([response["msg"]])
 
 
 def check_narrow_and_notify(

zulipterminal/ui.py

@@ -296,7 +296,7 @@ def keypress(self, size: urwid_Box, key: str) -> Optional[str]:
                 self.middle_column.set_focus("footer")
             else:
                 self.controller.report_error(
-                    "No draft message was saved in this session."
+                    ["No draft message was saved in this session."]
                 )
             return key
         elif is_command_key("ABOUT", key):

zulipterminal/ui_tools/boxes.py

@@ -329,7 +329,7 @@ def _tidy_valid_recipients_and_notify_invalid_ones(
                 ),
                 " to autocomplete.",
             ]
-            self.view.controller.report_error(invalid_recipients_error)
+            self.view.controller.report_error([invalid_recipients_error])
             return False
 
         return True
@@ -765,7 +765,7 @@ def keypress(self, size: urwid_Size, key: str) -> Optional[str]:
                         )
                     else:
                         self.view.controller.report_error(
-                            "Cannot send message without specifying recipients."
+                            ["Cannot send message without specifying recipients."]
                         )
                         success = None
             if success:
@@ -830,7 +830,7 @@ def keypress(self, size: urwid_Size, key: str) -> Optional[str]:
                                     primary_key_for_command("AUTOCOMPLETE_REVERSE"),
                                 )
                             )
-                            self.view.controller.report_error(invalid_stream_error)
+                            self.view.controller.report_error([invalid_stream_error])
                             return key
                         user_ids = self.model.get_other_subscribers_in_stream(
                             stream_name=stream_name
@@ -1844,17 +1844,20 @@ def keypress(self, size: urwid_Size, key: str) -> Optional[str]:
             ):
                 if self.message["type"] == "stream":
                     self.model.controller.report_error(
-                        " You can't edit messages sent by other users that"
-                        " already have a topic."
+                        [
+                            " You can't edit messages sent by other users that already have a topic."
+                        ]
                     )
                 else:
                     self.model.controller.report_error(
-                        " You can't edit private messages sent by other users."
+                        [" You can't edit private messages sent by other users."]
                     )
                 return key
             # Check if editing is allowed in the realm
             elif not self.model.initial_data["realm_allow_message_editing"]:
-                self.model.controller.report_error(" Editing sent message is disabled.")
+                self.model.controller.report_error(
+                    [" Editing sent message is disabled."]
+                )
                 return key
             # Check if message is still editable, i.e. within
             # the time limit. A limit of 0 signifies no limit
@@ -1870,7 +1873,9 @@ def keypress(self, size: urwid_Size, key: str) -> Optional[str]:
                     if time_since_msg_sent >= edit_time_limit:
                         if self.message["type"] == "private":
                             self.model.controller.report_error(
-                                " Time Limit for editing the message has been exceeded."
+                                [
+                                    " Time Limit for editing the message has been exceeded."
+                                ]
                             )
                             return key
                         elif self.message["type"] == "stream":
@@ -1891,8 +1896,9 @@ def keypress(self, size: urwid_Size, key: str) -> Optional[str]:
                         msg_body_edit_enabled = False
                     else:
                         self.model.controller.report_error(
-                            " You can't edit messages sent by other users that"
-                            " already have a topic."
+                            [
+                                " You can't edit messages sent by other users that already have a topic."
+                            ]
                         )
                         return key
                 else:

zulipterminal/ui_tools/buttons.py

@@ -607,7 +607,7 @@ def handle_narrow_link(self) -> None:
         error = self._validate_narrow_link(parsed_link)
 
         if error:
-            self.controller.report_error(f" {error}")
+            self.controller.report_error([f" {error}"])
         else:
             self._switch_narrow_to(parsed_link)