Suggest next sub ses remote (#484)

* add: custom spinner widget

* add: search remote for suggestions checkbox

* remove: minor bug

* add: tooltips for search remote checkbox

* convert fill input to a worker; add a spinner to indicate loading

* fix merge conflicts, slight refactor

* update: display popup for suggesting next sub/ses remote

* update: handle popup closing on error

* slight refactor

* rename remote to central and change tooltip

* refactor functions and some minor changes

* add: new tests for searching central for suggestions feature

* fix: failing existing tests

* first attempt at fixing tests

* Apply suggestions from code review

edit: some comments and docstrings

Co-authored-by: Joe Ziminski <[email protected]>

* refactor: apply code review changes

* fix minor bug

* first attempt at testing error popup

* minor changes

* remove: existing textual version bug

* fix: minor bug

* update: enhanced decorator for input box

* refactor: changes to decorator specifying id of clicked element

* Revert `node` rename

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Fix linting.

* Revert node->event.

* Use correct event types, and use these in the double click decorator.

---------

Co-authored-by: shrey <shrey@kali>
Co-authored-by: Joe Ziminski <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: JoeZiminski <[email protected]>

Author: 4 people

datashuttle/configs/canonical_configs.py

@@ -241,6 +241,7 @@ def get_tui_config_defaults() -> Dict:
             "bypass_validation": False,
             "overwrite_existing_files": "never",
             "dry_run": False,
+            "suggest_next_sub_ses_central": False,
         }
     }
 

datashuttle/datashuttle_class.py

@@ -1547,7 +1547,11 @@ def _update_settings_with_new_canonical_keys(self, settings: Dict):
         if "tui" not in settings:
             settings.update(canonical_tui_configs)
 
-        for key in ["overwrite_existing_files", "dry_run"]:
+        for key in [
+            "overwrite_existing_files",
+            "dry_run",
+            "suggest_next_sub_ses_central",
+        ]:
             if key not in settings["tui"]:
                 settings["tui"][key] = canonical_tui_configs["tui"][key]
 

datashuttle/tui/app.py

@@ -115,6 +115,13 @@ def load_project_page(self, interface: Interface) -> None:
     def show_modal_error_dialog(self, message: str) -> None:
         self.push_screen(modal_dialogs.MessageBox(message, border_color="red"))
 
+    def show_modal_error_dialog_from_main_thread(self, message: str) -> None:
+        """
+        Used to call `show_modal_error_dialog from main thread when executing
+        in another thread. Throws error when called from main thread.
+        """
+        self.call_from_thread(self.show_modal_error_dialog, message)
+
     def handle_open_filesystem_browser(self, path_: Path) -> None:
         """
         Open the system file browser to the path with the `showinfm`

datashuttle/tui/css/tui_menu.tcss

@@ -313,9 +313,16 @@ CreateFoldersSettingsScreen {
     width: 80%;
     background: $primary-background;
     border: tall $panel-lighten-3;
- }
+}
+#checkbox_container {
+    height: 65%;
+    overflow: hidden auto;
+}
+#toplevel_folder_select_container {
+    height: 15%;
+}
 #template_top_container {
-    height: 50%;
+    height: 70%;
     background: $primary-background;
     border: tall $panel-lighten-3;
     overflow: hidden auto;
@@ -436,6 +443,41 @@ ConfirmAndAwaitTransferPopup {
     content-align: center middle;
 }
 
+/* Suggest next subject / session loading pop up --------------------------------------------------- */
+
+SearchingCentralForNextSubSesPopup {
+    align: center middle;
+}
+
+#searching_top_container {
+    align: center middle;
+    height: 15;
+    width: 65;
+    border: tall $panel-lighten-1;
+    background: $primary-background;
+ }
+
+#searching_top_container:light {
+    background: $boost;
+    border: tall $panel-darken-3;
+}
+
+#searching_message_label {
+    align: center middle;
+    text-align: center;
+    overflow: hidden auto;
+    width: 100%;
+    margin: 1 0 0 0;
+}
+
+#searching_animated_indicator {
+    align: center middle;
+    padding: 0;
+    height: 3;
+    margin: 1 0 0 0;
+    content-align: center middle;
+}
+
 /* Light Mode Error Screen */
 
 MessageBox:light > #confirm_top_container {

datashuttle/tui/interface.py

@@ -432,28 +432,28 @@ def get_textual_compatible_project_configs(self) -> Configs:
         return cfg_to_load
 
     def get_next_sub(
-        self, top_level_folder: TopLevelFolder
+        self, top_level_folder: TopLevelFolder, include_central: bool
     ) -> InterfaceOutput:
         try:
             next_sub = self.project.get_next_sub(
                 top_level_folder,
                 return_with_prefix=True,
-                include_central=False,
+                include_central=include_central,
             )
             return True, next_sub
         except BaseException as e:
             return False, str(e)
 
     def get_next_ses(
-        self, top_level_folder: TopLevelFolder, sub: str
+        self, top_level_folder: TopLevelFolder, sub: str, include_central: bool
     ) -> InterfaceOutput:
 
         try:
             next_ses = self.project.get_next_ses(
                 top_level_folder,
                 sub,
                 return_with_prefix=True,
-                include_central=False,
+                include_central=include_central,
             )
             return True, next_ses
         except BaseException as e:

datashuttle/tui/screens/create_folder_settings.py

@@ -86,6 +86,9 @@ def compose(self) -> ComposeResult:
         """
 
         bypass_validation = self.interface.tui_settings["bypass_validation"]
+        suggest_next_sub_ses_central = self.interface.tui_settings[
+            "suggest_next_sub_ses_central"
+        ]
 
         yield Container(
             Horizontal(
@@ -97,43 +100,52 @@ def compose(self) -> ComposeResult:
                     self.interface,
                     id="create_folders_settings_toplevel_select",
                 ),
-            ),
-            Checkbox(
-                "Bypass validation",
-                value=bypass_validation,
-                id="create_folders_settings_bypass_validation_checkbox",
+                id="toplevel_folder_select_container",
             ),
             Container(
-                Horizontal(
-                    Checkbox(
-                        "Template Validation",
-                        id="template_settings_validation_on_checkbox",
-                        value=self.interface.get_name_templates()["on"],
-                    ),
-                    id="template_inner_horizontal_container",
+                Checkbox(
+                    "Search Central For Suggestions",
+                    value=suggest_next_sub_ses_central,
+                    id="suggest_next_sub_ses_central_checkbox",
+                ),
+                Checkbox(
+                    "Bypass validation",
+                    value=bypass_validation,
+                    id="create_folders_settings_bypass_validation_checkbox",
                 ),
                 Container(
-                    Label(explanation, id="template_message_label"),
+                    Horizontal(
+                        Checkbox(
+                            "Template validation",
+                            id="template_settings_validation_on_checkbox",
+                            value=self.interface.get_name_templates()["on"],
+                        ),
+                        id="template_inner_horizontal_container",
+                    ),
                     Container(
-                        RadioSet(
-                            RadioButton(
-                                "Subject",
-                                id="template_settings_subject_radiobutton",
-                                value=sub_on,
-                            ),
-                            RadioButton(
-                                "Session",
-                                id="template_settings_session_radiobutton",
-                                value=ses_on,
+                        Label(explanation, id="template_message_label"),
+                        Container(
+                            RadioSet(
+                                RadioButton(
+                                    "Subject",
+                                    id="template_settings_subject_radiobutton",
+                                    value=sub_on,
+                                ),
+                                RadioButton(
+                                    "Session",
+                                    id="template_settings_session_radiobutton",
+                                    value=ses_on,
+                                ),
+                                id="template_settings_radioset",
                             ),
-                            id="template_settings_radioset",
+                            Input(id="template_settings_input"),
+                            id="template_other_widgets_container",
                         ),
-                        Input(id="template_settings_input"),
-                        id="template_other_widgets_container",
+                        id="template_inner_container",
                     ),
-                    id="template_inner_container",
+                    id="template_top_container",
                 ),
-                id="template_top_container",
+                id="checkbox_container",
             ),
             Container(),
             Button("Close", id="create_folders_settings_close_button"),
@@ -145,6 +157,7 @@ def on_mount(self) -> None:
             "#create_folders_settings_toplevel_select",
             "#create_folders_settings_bypass_validation_checkbox",
             "#template_settings_validation_on_checkbox",
+            "#suggest_next_sub_ses_central_checkbox",
         ]:
             self.query_one(id).tooltip = get_tooltip(id)
 
@@ -235,6 +248,10 @@ def on_checkbox_changed(self, event: Checkbox.Changed) -> None:
             self.query_one("#template_inner_container").disabled = (
                 disable_container
             )
+        elif event.checkbox.id == "suggest_next_sub_ses_central_checkbox":
+            self.interface.save_tui_settings(
+                is_on, "suggest_next_sub_ses_central"
+            )
 
     def on_radio_set_changed(self, event: RadioSet.Changed) -> None:
         """

datashuttle/tui/screens/modal_dialogs.py

@@ -7,10 +7,11 @@
     from pathlib import Path
 
     from textual.app import ComposeResult
+    from textual.widgets import DirectoryTree
     from textual.worker import Worker
 
     from datashuttle.tui.app import TuiApp
-    from datashuttle.utils.custom_types import InterfaceOutput
+    from datashuttle.utils.custom_types import InterfaceOutput, Prefix
 
 from pathlib import Path
 
@@ -19,7 +20,10 @@
 from textual.widgets import Button, Input, Label, LoadingIndicator, Static
 
 from datashuttle.tui.custom_widgets import CustomDirectoryTree
-from datashuttle.tui.utils.tui_decorators import require_double_click
+from datashuttle.tui.utils.tui_decorators import (
+    ClickInfo,
+    require_double_click,
+)
 
 
 class MessageBox(ModalScreen):
@@ -137,6 +141,27 @@ async def handle_transfer_and_update_ui_when_complete(self) -> None:
             self.app.show_modal_error_dialog(output)
 
 
+class SearchingCentralForNextSubSesPopup(ModalScreen):
+    """
+    A popup to show message and a loading indicator when awaiting search next sub/ses across
+    the folders present in both local and central machines. This search happens in a separate
+    thread so as to allow TUI to display the loading indicate without freezing.
+
+    Only displayed when the `include_central` flag is checked and the connection method is "ssh".
+    """
+
+    def __init__(self, sub_or_ses: Prefix) -> None:
+        super().__init__()
+        self.message = f"Searching central for next {sub_or_ses}"
+
+    def compose(self) -> ComposeResult:
+        yield Container(
+            Label(self.message, id="searching_message_label"),
+            LoadingIndicator(id="searching_animated_indicator"),
+            id="searching_top_container",
+        )
+
+
 class SelectDirectoryTreeScreen(ModalScreen):
     """
     A modal screen that includes a DirectoryTree to browse
@@ -165,7 +190,7 @@ def __init__(
             path_ = Path().home()
         self.path_ = path_
 
-        self.prev_click_time = 0
+        self.click_info = ClickInfo()
 
     def compose(self) -> ComposeResult:
 
@@ -186,11 +211,13 @@ def compose(self) -> ComposeResult:
         )
 
     @require_double_click
-    def on_directory_tree_directory_selected(self, node) -> None:
-        if node.path.is_file():
+    def on_directory_tree_directory_selected(
+        self, event: DirectoryTree.DirectorySelected
+    ) -> None:
+        if event.path.is_file():
             return
         else:
-            self.dismiss(node.path)
+            self.dismiss(event.path)
 
     def on_button_pressed(self, event: Button.Pressed) -> None:
         if event.button.id == "cancel_button":