Fixes SSHFS folder being removed from project even when unmount failed

Author: HorlogeSkynet

CHANGELOG.md

@@ -14,6 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 
 - Unmount on macOS
+- Unmount failure leading to SSHFS folder being removed from project
 - Unmount race conditions related to SSHFS mount point still present in project opened folders
 
 ### Removed

sshubl/actions.py

@@ -349,18 +349,28 @@ def run(self):
                 mount_path = mount_sshfs(
                     self.identifier, typing.cast(PurePath, self.remote_path), self.mount_path
                 )
-                if mount_path is None:
-                    return
-                add_to_project_folders(
-                    str(mount_path), f"{ssh_session}{self.remote_path}", self.view.window()
-                )
+                folder_was_in_project = False
+                is_ok = mount_path is not None
             else:
                 mount_path = typing.cast(Path, self.mount_path)
-                remove_from_project_folders(str(mount_path), self.view.window())
-                umount_sshfs(mount_path)
+                folder_was_in_project = remove_from_project_folders(
+                    str(mount_path), self.view.window()
+                )
+                is_ok = umount_sshfs(mount_path)
         finally:
             self.view.erase_status("zz_mounting_sshfs")
 
+        # in case of mounting success, add folder to project
+        # in case of unmounting failure, re-add folder to project (if it was present)
+        if (self.do_mount and is_ok) or (not self.do_mount and not is_ok and folder_was_in_project):
+            add_to_project_folders(
+                str(mount_path), f"{ssh_session}{self.remote_path}", self.view.window()
+            )
+
+        # don't update project data if action failed
+        if not is_ok:
+            return
+
         # store/remove mount path in/from SSH session metadata
         with project_data_lock:
             if self.do_mount:

sshubl/project_data.py

@@ -81,8 +81,12 @@ def add_to_project_folders(
 def remove_from_project_folders(
     old_folder: str,
     window: typing.Optional[sublime.Window] = None,
-) -> None:
-    """Mirror function of `add_folder_to_project` (see above)"""
+) -> bool:
+    """
+    Mirror function of `add_folder_to_project` (see above).
+
+    :returns bool: `True` when project has been actually removed, `False` otherwise
+    """
     if window is None:
         window = sublime.active_window()
 
@@ -94,6 +98,10 @@ def remove_from_project_folders(
             project_data["folders"] = filtered_folders
             window.set_project_data(project_data)
 
+            return True
+
+    return False
+
 
 @dataclasses.dataclass
 class SshSession:  # pylint: disable=too-many-instance-attributes

sshubl/ssh_utils.py

@@ -316,12 +316,17 @@ def mount_sshfs(
     return mount_path
 
 
-def umount_sshfs(mount_path: Path) -> None:
+def umount_sshfs(mount_path: Path) -> bool:
+    """
+    Unmount `mount_path`, considering it has been mounted using sshfs.
+
+    :returns bool: `True` on success and `False` on error
+    """
     if umount_program is None:
         _logger.warning(
             "%s has not been found, skipping unmounting of %s...", umount_program, mount_path
         )
-        return
+        return False
 
     _logger.debug("unmounting %s...", mount_path)
 
@@ -335,12 +340,15 @@ def umount_sshfs(mount_path: Path) -> None:
         _logger.warning(
             "could not unmount %s : %s", mount_path, (error.stderr or "Unknown error").rstrip()
         )
-    else:
-        _logger.debug("successfully unmounted %s, removing mount point...", mount_path)
+        return False
+
+    _logger.debug("successfully unmounted %s, removing mount point...", mount_path)
 
     with contextlib.suppress(FileNotFoundError):
         mount_path.rmdir()
 
+    return True
+
 
 def _remove_unix_domain_socket(
     identifier: uuid.UUID, socket_path: str, *, is_reverse: bool