core/views: Stack inner popups, add support for exiting all popups.

Support 2 functions.
- Exiting the current popup - goes back to the previous popup.
- Exiting all popups - clears all popups.

Why stack popups?
Currently, we create a new popup even when closing the uppermost popups.
With stacking, we can re-use the popups.
This allows us to not pass the entire data for creating the inner popups
to the outer popups.

Currently, the only popup that opens other popups is the MsgInfoView.
Affected widgets: EditHistoryView, FullRenderedMsgView, FullRawMsgView.
Updated them to use the newly added functions to exit popups.

Hotkey behavior (from the widget):
- Press Esc or respective command -> go to MsgInfoView popup
- Press i from the widget -> close all popups (EXIT_POPUP command)
By adding new keypress handling to their parent PopupView, we can
pass their respective commands without having to implement custom
keypress handlers.

Tests updated.
Renamed tests:
- test_keypress_show_msg_info -> test_keypress_exit_to_msg_info.
- test_keypress_exit_popup -> test_keypress_exit_all_popups.

Author: Niloth-p

tests/ui_tools/test_popups.py

@@ -520,14 +520,14 @@ def test_init(self, msg_box: MessageBox) -> None:
         assert self.full_rendered_message.footer.widget_list == msg_box.footer
 
     @pytest.mark.parametrize("key", keys_for_command("MSG_INFO"))
-    def test_keypress_exit_popup(
+    def test_keypress_exit_all_popups(
         self, key: str, widget_size: Callable[[Widget], urwid_Size]
     ) -> None:
         size = widget_size(self.full_rendered_message)
 
         self.full_rendered_message.keypress(size, key)
 
-        assert self.controller.exit_popup.called
+        assert self.controller.exit_all_popups.called
 
     def test_keypress_exit_popup_invalid_key(
         self, widget_size: Callable[[Widget], urwid_Size]
@@ -546,19 +546,14 @@ def test_keypress_exit_popup_invalid_key(
             *keys_for_command("EXIT_POPUP"),
         },
     )
-    def test_keypress_show_msg_info(
+    def test_keypress_exit_to_msg_info(
         self, key: str, widget_size: Callable[[Widget], urwid_Size]
     ) -> None:
         size = widget_size(self.full_rendered_message)
 
         self.full_rendered_message.keypress(size, key)
 
-        self.controller.show_msg_info.assert_called_once_with(
-            msg=self.message,
-            topic_links=OrderedDict(),
-            message_links=OrderedDict(),
-            time_mentions=list(),
-        )
+        assert self.controller.exit_popup.called
 
 
 class TestFullRawMsgView:
@@ -596,14 +591,14 @@ def test_init(self, msg_box: MessageBox) -> None:
         assert self.full_raw_message.footer.widget_list == msg_box.footer
 
     @pytest.mark.parametrize("key", keys_for_command("MSG_INFO"))
-    def test_keypress_exit_popup(
+    def test_keypress_exit_all_popups(
         self, key: str, widget_size: Callable[[Widget], urwid_Size]
     ) -> None:
         size = widget_size(self.full_raw_message)
 
         self.full_raw_message.keypress(size, key)
 
-        assert self.controller.exit_popup.called
+        assert self.controller.exit_all_popups.called
 
     def test_keypress_exit_popup_invalid_key(
         self, widget_size: Callable[[Widget], urwid_Size]
@@ -622,19 +617,14 @@ def test_keypress_exit_popup_invalid_key(
             *keys_for_command("EXIT_POPUP"),
         },
     )
-    def test_keypress_show_msg_info(
+    def test_keypress_exit_to_msg_info(
         self, key: str, widget_size: Callable[[Widget], urwid_Size]
     ) -> None:
         size = widget_size(self.full_raw_message)
 
         self.full_raw_message.keypress(size, key)
 
-        self.controller.show_msg_info.assert_called_once_with(
-            msg=self.message,
-            topic_links=OrderedDict(),
-            message_links=OrderedDict(),
-            time_mentions=list(),
-        )
+        assert self.controller.exit_popup.called
 
 
 class TestEditHistoryView:
@@ -671,14 +661,14 @@ def test_init(self) -> None:
         )
 
     @pytest.mark.parametrize("key", keys_for_command("MSG_INFO"))
-    def test_keypress_exit_popup(
+    def test_keypress_exit_all_popups(
         self, key: str, widget_size: Callable[[Widget], urwid_Size]
     ) -> None:
         size = widget_size(self.edit_history_view)
 
         self.edit_history_view.keypress(size, key)
 
-        assert self.controller.exit_popup.called
+        assert self.controller.exit_all_popups.called
 
     def test_keypress_exit_popup_invalid_key(
         self, widget_size: Callable[[Widget], urwid_Size]
@@ -700,12 +690,7 @@ def test_keypress_show_msg_info(
 
         self.edit_history_view.keypress(size, key)
 
-        self.controller.show_msg_info.assert_called_once_with(
-            msg=self.message,
-            topic_links=OrderedDict(),
-            message_links=OrderedDict(),
-            time_mentions=list(),
-        )
+        assert self.controller.exit_popup.called
 
     @pytest.mark.parametrize(
         "snapshot",

zulipterminal/core.py

@@ -86,6 +86,7 @@ def __init__(
         self.notify_enabled = notify
         self.maximum_footlinks = maximum_footlinks
         self.editor_command = editor_command
+        self.popup_stack: List[urwid.Widget] = []
 
         self.debug_path = debug_path
 
@@ -226,6 +227,8 @@ def clamp(n: int, minn: int, maxn: int) -> int:
         return max_popup_cols, max_popup_rows
 
     def show_pop_up(self, to_show: Any, style: str) -> None:
+        self.popup_stack.append(self.loop.widget)
+
         text = urwid.Text(to_show.title, align="center")
         title_map = urwid.AttrMap(urwid.Filler(text), style)
         title_box_adapter = urwid.BoxAdapter(title_map, height=1)
@@ -249,6 +252,10 @@ def is_any_popup_open(self) -> bool:
         return isinstance(self.loop.widget, urwid.Overlay)
 
     def exit_popup(self) -> None:
+        self.loop.widget = self.popup_stack.pop()
+
+    def exit_all_popups(self) -> None:
+        self.popup_stack.clear()
         self.loop.widget = self.view
 
     def show_help(self) -> None:

zulipterminal/ui_tools/views.py

@@ -959,12 +959,14 @@ def __init__(
         title: str,
         header: Optional[Any] = None,
         footer: Optional[Any] = None,
+        command_full_exit: Optional[str] = None,
     ) -> None:
         self.controller = controller
         self.command = command
         self.title = title
         self.log = urwid.SimpleFocusListWalker(body)
         self.body = urwid.ListBox(self.log)
+        self.command_full_exit = command_full_exit
 
         max_cols, max_rows = controller.maximum_popup_dimensions()
 
@@ -1060,7 +1062,8 @@ def make_table_with_categories(
     def keypress(self, size: urwid_Size, key: str) -> str:
         if is_command_key("EXIT_POPUP", key) or is_command_key(self.command, key):
             self.controller.exit_popup()
-
+        elif self.command_full_exit and is_command_key(self.command_full_exit, key):
+            self.controller.exit_all_popups()
         return super().keypress(size, key)
 
 
@@ -1831,7 +1834,14 @@ def __init__(
             ]
             widgets.append(urwid.Text(feedback, align="center"))
 
-        super().__init__(controller, widgets, "MSG_INFO", width, title)
+        super().__init__(
+            controller,
+            widgets,
+            "EDIT_HISTORY",
+            width,
+            title,
+            command_full_exit="MSG_INFO",
+        )
 
     def _make_edit_block(self, snapshot: Dict[str, Any], tag: EditHistoryTag) -> Any:
         content = snapshot["content"]
@@ -1896,17 +1906,6 @@ def _get_author_prefix(snapshot: Dict[str, Any], tag: EditHistoryTag) -> str:
 
         return author_prefix
 
-    def keypress(self, size: urwid_Size, key: str) -> str:
-        if is_command_key("EXIT_POPUP", key) or is_command_key("EDIT_HISTORY", key):
-            self.controller.show_msg_info(
-                msg=self.message,
-                topic_links=self.topic_links,
-                message_links=self.message_links,
-                time_mentions=self.time_mentions,
-            )
-            return key
-        return super().keypress(size, key)
-
 
 class FullRenderedMsgView(PopUpView):
     def __init__(
@@ -1931,26 +1930,14 @@ def __init__(
         super().__init__(
             controller,
             [msg_box.content],
-            "MSG_INFO",
+            "FULL_RENDERED_MESSAGE",
             max_cols,
             title,
             urwid.Pile(msg_box.header),
             urwid.Pile(msg_box.footer),
+            command_full_exit="MSG_INFO",
         )
 
-    def keypress(self, size: urwid_Size, key: str) -> str:
-        if is_command_key("EXIT_POPUP", key) or is_command_key(
-            "FULL_RENDERED_MESSAGE", key
-        ):
-            self.controller.show_msg_info(
-                msg=self.message,
-                topic_links=self.topic_links,
-                message_links=self.message_links,
-                time_mentions=self.time_mentions,
-            )
-            return key
-        return super().keypress(size, key)
-
 
 class FullRawMsgView(PopUpView):
     def __init__(
@@ -1983,24 +1970,14 @@ def __init__(
         super().__init__(
             controller,
             body_list,
-            "MSG_INFO",
+            "FULL_RAW_MESSAGE",
             max_cols,
             title,
             urwid.Pile(msg_box.header),
             urwid.Pile(msg_box.footer),
+            command_full_exit="MSG_INFO",
         )
 
-    def keypress(self, size: urwid_Size, key: str) -> str:
-        if is_command_key("EXIT_POPUP", key) or is_command_key("FULL_RAW_MESSAGE", key):
-            self.controller.show_msg_info(
-                msg=self.message,
-                topic_links=self.topic_links,
-                message_links=self.message_links,
-                time_mentions=self.time_mentions,
-            )
-            return key
-        return super().keypress(size, key)
-
 
 class EmojiPickerView(PopUpView):
     """