Introduce help context

docs/developer-file-overview.md

@@ -8,6 +8,7 @@ Zulip Terminal uses [Zulip's API](https://zulip.com/api/) to store and retrieve
 | Folder                 | File                | Description                                                                             |
 | ---------------------- | ------------------- | ----------------------------------------------------------------------------------------|
 | zulipterminal          | api_types.py        | Types from the Zulip API, translated into python, to improve type checking              |
+|                        | contexts.py         | Tracks the currently focused widget in the UI                                           |
 |                        | core.py             | Defines the `Controller`, which sets up the `Model`, `View`, and how they interact      |
 |                        | helper.py           | Helper functions used in multiple places                                                |
 |                        | model.py            | Defines the `Model`, fetching and storing data retrieved from the Zulip server          |

docs/hotkeys.md

@@ -6,6 +6,7 @@
 |Command|Key Combination|
 | :--- | :---: |
 |Show/hide Help Menu|<kbd>?</kbd>|
+|Show/hide Contextual Help Menu|<kbd>Meta</kbd> + <kbd>c</kbd>|
 |Show/hide Markdown Help Menu|<kbd>Meta</kbd> + <kbd>m</kbd>|
 |Show/hide About Menu|<kbd>Meta</kbd> + <kbd>?</kbd>|
 |Copy information from About Menu to clipboard|<kbd>c</kbd>|

tests/config/test_keys.py

@@ -67,40 +67,61 @@ def test_is_command_key_invalid_command(invalid_command: str) -> None:
 
 def test_HELP_is_not_allowed_as_tip() -> None:
     assert keys.KEY_BINDINGS["HELP"]["excluded_from_random_tips"] is True
-    assert keys.KEY_BINDINGS["HELP"] not in keys.commands_for_random_tips()
+    commands, _ = keys.commands_for_random_tips()
+    assert keys.KEY_BINDINGS["HELP"] not in commands
 
 
-def test_commands_for_random_tips(mocker: MockerFixture) -> None:
+@pytest.mark.parametrize(
+    "context, expected_command, expected_context",
+    [
+        (None, "GAMMA", "Global"),
+        ("context_1", "BETA", "Context 1"),
+        ("context_2", "GAMMA", "Global"),
+    ],
+)
+def test_commands_for_random_tips(
+    context: str, expected_command: str, expected_context: str, mocker: MockerFixture
+) -> None:
     new_key_bindings: Dict[str, keys.KeyBinding] = {
         "ALPHA": {
             "keys": ["a"],
             "help_text": "alpha",
             "key_category": "category 1",
+            "key_contexts": ["context_1", "context_2"],
             "excluded_from_random_tips": True,
         },
         "BETA": {
             "keys": ["b"],
             "help_text": "beta",
             "key_category": "category 1",
+            "key_contexts": ["context_1"],
             "excluded_from_random_tips": False,
         },
         "GAMMA": {
             "keys": ["g"],
             "help_text": "gamma",
             "key_category": "category 1",
+            "key_contexts": ["global"],
         },
         "DELTA": {
             "keys": ["d"],
             "help_text": "delta",
             "key_category": "category 2",
+            "key_contexts": ["context_2"],
             "excluded_from_random_tips": True,
         },
     }
+    new_help_contexts: Dict[str, str] = {
+        "global": "Global",
+        "context_1": "Context 1",
+        "context_2": "Context 2",
+    }
     mocker.patch.dict(keys.KEY_BINDINGS, new_key_bindings, clear=True)
-    result = keys.commands_for_random_tips()
-    assert len(result) == 2
-    assert new_key_bindings["BETA"] in result
-    assert new_key_bindings["GAMMA"] in result
+    mocker.patch.object(keys, "HELP_CONTEXTS", new_help_contexts)
+    commands, context_display_name = keys.commands_for_random_tips(context)
+    assert len(commands) == 1
+    assert new_key_bindings[expected_command] in commands
+    assert context_display_name == expected_context
 
 
 def test_updated_urwid_command_map() -> None:

tests/core/test_core.py

@@ -39,7 +39,7 @@ def controller(self, mocker: MockerFixture) -> Controller:
         self.poll_for_events = mocker.patch(MODEL + ".poll_for_events")
         mocker.patch(MODULE + ".Controller.show_loading")
         self.main_loop = mocker.patch(
-            MODULE + ".urwid.MainLoop", return_value=mocker.Mock()
+            MODULE + ".FocusTrackingMainLoop", return_value=mocker.Mock()
         )
 
         self.config_file = "path/to/zuliprc"
@@ -589,7 +589,8 @@ def test_show_typing_notification(
         controller: Controller,
         active_conversation_info: Dict[str, str],
     ) -> None:
-        set_footer_text = mocker.patch(VIEW + ".set_footer_text")
+        set_footer_text_for_event = mocker.patch(VIEW + ".set_footer_text_for_event")
+        reset_footer_text = mocker.patch(VIEW + ".reset_footer_text")
         mocker.patch(MODULE + ".time.sleep")
         controller.active_conversation_info = active_conversation_info
 
@@ -600,16 +601,16 @@ def mock_typing() -> None:
         Thread(controller.show_typing_notification()).start()
 
         if active_conversation_info:
-            set_footer_text.assert_has_calls(
+            set_footer_text_for_event.assert_has_calls(
                 [
                     mocker.call([("footer_contrast", " hamlet "), " is typing"]),
                     mocker.call([("footer_contrast", " hamlet "), " is typing."]),
                     mocker.call([("footer_contrast", " hamlet "), " is typing.."]),
                     mocker.call([("footer_contrast", " hamlet "), " is typing..."]),
                 ]
             )
-            set_footer_text.assert_called_with()
+            reset_footer_text.assert_called_with()
         else:
-            set_footer_text.assert_called_once_with()
+            reset_footer_text.assert_called_once_with()
         assert controller.is_typing_notification_in_progress is False
         assert controller.active_conversation_info == {}

tests/ui/test_ui.py

@@ -85,39 +85,60 @@ def test_set_footer_text_same_test(
 
         view._w.footer.set_text.assert_not_called()
 
-    def test_set_footer_text_default(self, view: View, mocker: MockerFixture) -> None:
+    def test_reset_footer_text(self, view: View, mocker: MockerFixture) -> None:
         mocker.patch(VIEW + ".get_random_help", return_value=["some help text"])
 
-        view.set_footer_text()
+        view.reset_footer_text()
 
         view.frame.footer.set_text.assert_called_once_with(["some help text"])
         view.controller.update_screen.assert_called_once_with()
+        assert view._is_footer_event_running is False
 
     def test_set_footer_text_specific_text(
         self, view: View, text: str = "blah"
     ) -> None:
-        view.set_footer_text([text])
+        view.set_footer_text_for_event([text])
 
         view.frame.footer.set_text.assert_called_once_with([text])
         view.controller.update_screen.assert_called_once_with()
+        assert view._is_footer_event_running is True
 
     def test_set_footer_text_with_duration(
         self,
         view: View,
         mocker: MockerFixture,
         custom_text: str = "custom",
-        duration: Optional[float] = 5.3,
+        duration: float = 5.3,
     ) -> None:
         mocker.patch(VIEW + ".get_random_help", return_value=["some help text"])
         mock_sleep = mocker.patch("time.sleep")
 
-        view.set_footer_text([custom_text], duration=duration)
+        view.set_footer_text_for_event_duration([custom_text], duration=duration)
 
         view.frame.footer.set_text.assert_has_calls(
             [mocker.call([custom_text]), mocker.call(["some help text"])]
         )
         mock_sleep.assert_called_once_with(duration)
         assert view.controller.update_screen.call_count == 2
+        assert view._is_footer_event_running is False
+
+    @pytest.mark.parametrize(
+        "event_running, expected_call_count", [(True, 0), (False, 1)]
+    )
+    def test_set_footer_text_on_context_change(
+        self,
+        view: View,
+        mocker: MockerFixture,
+        event_running: bool,
+        expected_call_count: int,
+    ) -> None:
+        mocker.patch(VIEW + ".get_random_help", return_value=["some help text"])
+        view._is_footer_event_running = event_running
+
+        view.set_footer_text_on_context_change()
+
+        assert view.frame.footer.set_text.call_count == expected_call_count
+        assert view.controller.update_screen.call_count == expected_call_count
 
     @pytest.mark.parametrize(
         "suggestions, state, truncated, footer_text",
@@ -350,12 +371,12 @@ def test_keypress_NEW_HINT(
         widget_size: Callable[[Widget], urwid_Box],
     ) -> None:
         size = widget_size(view)
-        set_footer_text = mocker.patch(VIEW + ".set_footer_text")
+        reset_footer_text = mocker.patch(VIEW + ".reset_footer_text")
         mocker.patch(CONTROLLER + ".is_in_editor_mode", return_value=False)
 
         returned_key = view.keypress(size, key)
 
-        set_footer_text.assert_called_once_with()
+        reset_footer_text.assert_called_once_with()
         assert returned_key == key
 
     @pytest.mark.parametrize("key", keys_for_command("SEARCH_PEOPLE"))

tests/ui_tools/test_boxes.py

@@ -1583,7 +1583,7 @@ def test__keypress_typeahead_mode_autocomplete_key_footer_no_reset(
         write_box.keypress(size, key)
 
         assert write_box.is_in_typeahead_mode == expected_typeahead_mode
-        assert not self.view.set_footer_text.called
+        assert not self.view.reset_footer_text.called
 
     @pytest.mark.parametrize(
         "key, current_typeahead_mode, expected_typeahead_mode",
@@ -1611,7 +1611,7 @@ def test__keypress_typeahead_mode_autocomplete_key_footer_reset(
         assert write_box.is_in_typeahead_mode == expected_typeahead_mode
 
         # We may prefer called-once in future, but the key part is that we do reset
-        assert self.view.set_footer_text.called
+        assert self.view.reset_footer_text.called
 
     @pytest.mark.parametrize(
         [