feat(cwd-pane): Keeping the cwd when opening new panes #691

spacemaison · 2021-09-04T02:22:54Z

This is a resurrected pull request for PR #277 and issue #102. It keeps the current working directory when creating new panes/tabs. All tests/lints are passing on my machine.

I might be committing a faux pas here though. I didn't try to rebase #277 on top of the current main because they're was 600+ changes. Instead I added @qrasmont's as co-author to all of my commits. If that's not the appropriate way to handle this I'll be happy to change it.

Co-authored-by: Quentin Rasmont <qrasmont@gmail.com>

imsnif

This is looking really good! I tried it out and it completely works as expected. Great work. I also very much appreciate you making an effort to give credit in the commits to the previous PR - that's definitely the right thing to do.

I left some truly minor comments in the PR. Looking forward to having this merged soon.

imsnif · 2021-09-06T08:56:26Z

zellij-server/src/os_input_output.rs

+/// # Panics
+///
+/// This function will panic if a close operation on one of the file descriptors fails or if the
+/// write operation fails.


I'm a little iffy about this tbh. This seems like the sort of error we should be able to recover from. If for some reason anything in this process doesn't work, we could open a pane without the CWD like we did before - no?

Sure, I refactored it to never fail and to just fallback to the previous behavior.

imsnif · 2021-09-06T08:57:40Z

zellij-server/src/os_input_output.rs

@@ -145,11 +207,11 @@ fn handle_terminal(cmd: RunCommand, orig_termios: termios::Termios) -> (RawFd, P
 /// This function will panic if both the `EDITOR` and `VISUAL` environment variables are not
 /// set.
 pub fn spawn_terminal(
-    terminal_action: Option<TerminalAction>,
+    terminal_action: TerminalAction,


Removing the Option here and using the TerminalAction to move the cwd around is a really elegant solution.

imsnif · 2021-09-06T08:58:30Z

zellij-server/src/os_input_output.rs

@@ -215,7 +275,7 @@ pub trait ServerOsApi: Send + Sync {
    /// Sets the size of the terminal associated to file descriptor `fd`.
    fn set_terminal_size_using_fd(&self, fd: RawFd, cols: u16, rows: u16);
    /// Spawn a new terminal, with a terminal action.
-    fn spawn_terminal(&self, terminal_action: Option<TerminalAction>) -> (RawFd, Pid);
+    fn spawn_terminal(&self, terminal_action: TerminalAction) -> (RawFd, Pid, RawFd);


Can we add some comments here explaining what we're returning? It's starting to be a little confusing to me at least :)

Yeah it was apparently confusing for me too given that the method was actually supposed to be returning a (RawFd, Pid, Pid). I actually refactored it to return a (RawFd, ChildId) and wrote a (hopefully) better documentation explaining what it is. Take a look and see if it's clear to you what's happening.

imsnif · 2021-09-06T08:59:49Z

zellij-server/src/os_input_output.rs

+            Err(_) => None,
+        }
+    }
+    #[cfg(target_os = "linux")]


We don't have a lot of (any?) places in the code base that specifically require linux rather than unix. This might be a problem for those using Zellij on eg. FreeBSD. Do you think there can be a unix variant here? If not, can we have a unix variant that doesn't use this feature and will at least compile?

I resolved this by just returning None for non Linux/MacOS systems. I know very little about alternative Unixes so I don't really feel confident doing anything else here. I did quickly google whether or not FreeBSD has a /proc directory and apparently it does but you have to mount it first. Given that, it's probably not trivial to support everything.

That's a good solution, but correct me if I'm wrong - right now in those systems it won't compile though right? Because there is no specific function with the correct "is unix" conditional compilation? Or am I missing something?

Right, I resolved that here 5f13c95 by using:

#[cfg(all(not(target_os = "linux"), not(target_os = "macos")))]

Which is admittedly a bit confusing. I couldn't just use #[cfg(target_family = "unix")] because Linux is considered a Unix by Rust, and it'll throw a duplicate definition error. The boolean logic there matches everything that's not either Linux or MacOS, which includes the larger family of Unix OS's Rust supports as well as Windows, Android, ..etc.

No no, that's good - I missed it before, sorry!

imsnif · 2021-09-06T09:03:02Z

zellij-server/src/pty.rs

@@ -54,8 +63,9 @@ impl From<&PtyInstruction> for PtyContext {
 }

 pub(crate) struct Pty {
+    pub active_pane: Option<PaneId>,


I'm not too wild about this solution. I think essentially duplicating the state between the Pty and the Screen/Tab is a little error prone. One of those things the developer needs to know about.

That being said, given our current architecture of going through the Pty first before going to the Screen when spawning terminals - I can't think of a trivial way around it. If you have an idea, that would be great. Otherwise we can keep this (I want to say "for now", but if I'm being honest I don't see us changing this ever :) ).

The only thing I can think of (without a large refactor) is adding a screen action with an out parameter via a channel. Is that a different kinda of ugly though? Sorry I'm short on ideas here...

I think the "right" thing to do would be to change the architecture, or at least formalize some of these paths with a non-blocking shared state somehow... but I feel the right (no-quotation-marks) thing to do for now is to keep your original solution. :)

imsnif · 2021-09-06T09:14:58Z

zellij-server/src/os_input_output.rs

@@ -29,6 +33,7 @@ use zellij_utils::{

 use async_std::io::ReadExt;
 pub use async_trait::async_trait;
+use byteorder::{BigEndian, ByteOrder};


What are we usingByteOrder for?

The Unix pipe API we use to send the terminal process id back to our parent process needs a &[u8]. So we have to encode the u32 process id returned by the std::process::Child into a &[u8; 4] array to send it. The byteorder crate does that for us, ByteOrder is just the trait that implements the method to do so.

Instead of panicking when transfering the process id of the forked child command we just return an empty process id.

This will allow Zellij to compile on non Linux/MacOS targets without having an inherited cwd.

The spawn_terminal methods been refactored to use the ChildId struct in order to clarify what the Pid's returned by it are. The documentation for the ChildId struct was improved as well.

imsnif · 2021-09-09T08:17:08Z

@spacemaison - I think this is good to go! Only one minor thing I commented about above (the unix conditional compilation) and we can merge this. I'll give this fix priority and merge it ASAP when it's done.

imsnif

Looks great! Thank you very much for this much needed feature.

Jesse Tuchsen and others added 7 commits September 3, 2021 18:46

feat(cwd-pane): Add a new trait to get the cwd of a given pid

c22e815

Co-authored-by: Quentin Rasmont <qrasmont@gmail.com>

feat(cwd-pane): Allow for setting the cwd when spawning a new terminal

9dee9c3

Co-authored-by: Quentin Rasmont <qrasmont@gmail.com>

feat(cwd-pane): Add an active_pane field to the Pty struct

8d187ad

Co-authored-by: Quentin Rasmont <qrasmont@gmail.com>

feat(cwd-pane): Update Pty with Tab's active pane id

6a63bb5

Co-authored-by: Quentin Rasmont <qrasmont@gmail.com>

feat(cwd-pane): Refactor spawn_terminal to use cwd by default

c2b86db

Co-authored-by: Quentin Rasmont <qrasmont@gmail.com>

feat(cwd-pane): Fix tests and lints

6952972

Co-authored-by: Quentin Rasmont <qrasmont@gmail.com>

feat(cwd-pane): Fix formatting

5b1f970

imsnif requested changes Sep 6, 2021

View reviewed changes

Jesse Tuchsen added 4 commits September 6, 2021 22:18

feat(cwd-pane): Refactor child pid fetching to handle errors better

1653cab

Instead of panicking when transfering the process id of the forked child command we just return an empty process id.

feat(cwd-pane): Add non Linux/MacOS targets for the get_cwd method.

5f13c95

This will allow Zellij to compile on non Linux/MacOS targets without having an inherited cwd.

feat(cwd-pane): Refactor spawn_terminal method to use ChildId struct.

db65a0d

The spawn_terminal methods been refactored to use the ChildId struct in order to clarify what the Pid's returned by it are. The documentation for the ChildId struct was improved as well.

feat(cwd-pane): Fix tests/lints

6adddce

imsnif approved these changes Sep 10, 2021

View reviewed changes

imsnif merged commit 4f94f95 into zellij-org:main Sep 10, 2021

This was referenced Sep 19, 2021

feat(cwd-pane): Allow to open a new pane from the current working directory #277

Closed

Feature: Shortcut for opening a new pane in current working directory #102

Closed

New pane starts with a different local folder #249

Closed

Integralist mentioned this pull request Aug 8, 2022

New tabs/panes don't keep the current working directory #1641

Closed

n8henrie mentioned this pull request Jan 17, 2024

cwd is lost when opening new pane with nushell #3068

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(cwd-pane): Keeping the cwd when opening new panes #691

feat(cwd-pane): Keeping the cwd when opening new panes #691

spacemaison commented Sep 4, 2021 •

edited

imsnif left a comment

imsnif Sep 6, 2021

spacemaison Sep 7, 2021

imsnif Sep 6, 2021

imsnif Sep 6, 2021

spacemaison Sep 7, 2021

imsnif Sep 6, 2021

spacemaison Sep 7, 2021

imsnif Sep 9, 2021

spacemaison Sep 9, 2021

imsnif Sep 10, 2021

imsnif Sep 6, 2021

spacemaison Sep 7, 2021

imsnif Sep 9, 2021

imsnif Sep 6, 2021

spacemaison Sep 7, 2021

imsnif commented Sep 9, 2021

imsnif left a comment

feat(cwd-pane): Keeping the cwd when opening new panes #691

feat(cwd-pane): Keeping the cwd when opening new panes #691

Conversation

spacemaison commented Sep 4, 2021 • edited

imsnif left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

imsnif commented Sep 9, 2021

imsnif left a comment

Choose a reason for hiding this comment

spacemaison commented Sep 4, 2021 •

edited