shell crashes with start-tmux enabled

Question

shell crashes with start-tmux enabled

owittek opened this issue a year ago · comments

Hey!

A while ago I've opened an issue here about the exact same issue.

When spawning a sub-shell with zstyle ':z4h:' start-tmux command tmux -u new -A -D -t main in my .zshrc, the shell crashes/closes itself.

I could confirm this issue happening with the following tools/commands:

poetry (poetry shell)
fedora toolbox (toolbox enter <xyz>)

I have absolutely no idea why that happens, all I can say is that it happens and I can reproduce it 100% of the times on macOS, Windows & Linux. And I can also confirm that it's not a tmux issue since I can reload my .zshrc with exec zsh after commenting the line at the top out and then I'm able to run the commands without any issues.

I'd really appreciate it if there's a solution other than disabling this feature since I work in tmux 100% of the time.

Roman Perepelitsa · Answer 1 · Tue May 02 2023 03:49:33 GMT+0800 (China Standard Time)

It sounds like you want a different command for starting tmux. Go ahead and specify it, or leave the setting at no and start tmux manually.

Oli · Answer 2 · Tue May 02 2023 03:51:50 GMT+0800 (China Standard Time)

could you please elaborate how it's related to the tmux command? It does exactly what it's supposed to aside of those edge-cases where a sub-shell spawns.

Roman Perepelitsa · Answer 3 · Tue May 02 2023 04:07:02 GMT+0800 (China Standard Time)

Can you describe what you do, what you expect, and what actually happens?

Oli · Answer 4 · Tue May 02 2023 04:11:53 GMT+0800 (China Standard Time)

Sure!

I have my terminal open with tmux & z4h. Then I run one of the commands mentioned above, let's go with poetry subshell for example.

I run poetry subshell to source the python-venv file and I expect my shell to now be running from within the virtual env. What actually happens is that the shell suddenly closes without any indicator of why it happens. If I only have a single tmux window open it also closes my terminal.

EDIT:
more concise:

I run poetry subshell or toolbox enter <xyz>
I expect to enter a subshell (virtual env or a container)
My shell or my entire terminal just suddenly closes instead

Roman Perepelitsa · Answer 5 · Tue May 02 2023 04:30:34 GMT+0800 (China Standard Time)

What happens if you set the setting to no and manually run exec tmux -u new -A -D -t main first in the top-level shell, and then in the subshell?

Oli · Answer 6 · Tue May 02 2023 04:45:13 GMT+0800 (China Standard Time)

It closes when I run that command in the subshell. So you're definitely right on the part that the command is the issue, not z4h itself.

But I can't find any fixes to that just by googling and reading the tmux manual.

Roman Perepelitsa · Answer 7 · Tue May 02 2023 05:09:40 GMT+0800 (China Standard Time)

I don't use tmux myself, so I cannot help you there. If you can figure out which command you want to run, z4h can automate that for you.

Oli · Answer 8 · Tue May 02 2023 05:16:02 GMT+0800 (China Standard Time)

Alright, thank you for your help! I'll be closing the issue and look for a solution. Since you're an expert at shell scripting may I ask if you have an idea on how to conditionally run the command? Should I look for env variable or something similar to figure out if I'm in entering a subshell or if tmux has already been run?

Thanks again!

Oli · Answer 9 · Tue May 02 2023 05:18:25 GMT+0800 (China Standard Time)

I don't use tmux myself, so I cannot help you there. If you can figure out which command you want to run, z4h can automate that for you.

Actually, is there a solution to not run this command with exec? It seems like tmux automatically detecs potential nesting and warns against it when $TMUX is set but it crashes when run with exec.

Roman Perepelitsa · Answer 10 · Tue May 02 2023 05:25:21 GMT+0800 (China Standard Time)

If tmux can detect nesting, so can you. Looking for env vars is the way.

By the way, make sure you are on the newest version of zsh (run z4h update). There was a fix a few weeks ago that might be relevant.

Oli · Answer 11 · Tue May 02 2023 05:28:07 GMT+0800 (China Standard Time)

Thanks for the heads-up! I've updated z4h just before creating this issue just to be sure. Should I still be using zstyle ':z4h:' start-tmux command tmux -u new -A -D -t main or just go with a simple tmux -u new -A -D -t main instead?

Roman Perepelitsa · Answer 12 · Tue May 02 2023 05:31:25 GMT+0800 (China Standard Time)

The best solution is to use the zstyle but set it conditionally.

Oli · Answer 13 · Tue May 02 2023 16:32:16 GMT+0800 (China Standard Time)

Hey @romkatv! I think the cause for this issue might be that the $TMUX env variable is not being set properly when running exec tmux instead of just tmux. Maybe you could add your own variable to z4h to prevent this case from happening to other people?

I fixed it like that:

if [[ -z "$IN_TMUX" ]]; then
    zstyle ':z4h:' start-tmux command tmux -u new -A -D -t main
    export IN_TMUX=1
fi

Greetings!

Roman Perepelitsa · Answer 14 · Tue May 02 2023 17:38:14 GMT+0800 (China Standard Time)

How can I reproduce this? Suppose I use this setting:

if [[ -z "$IN_TMUX" ]]; then
  zstyle ':z4h:' start-tmux command tmux -u new -A -D -t main
  export IN_TMUX=1
fi

What do I need to do to get IN_TMUX set and TMUX unset at the same time?

Oli · Answer 15 · Tue May 02 2023 17:57:21 GMT+0800 (China Standard Time)

I'm not sure what you mean. The issue is that $TMUX is not being set in the first place when running exec tmux instead of tmux. That is why I've just made up my own env variable to check if I'm within tmux. I've also opened an issue so it might just be a temporary solution

Roman Perepelitsa · Answer 16 · Tue May 02 2023 17:58:30 GMT+0800 (China Standard Time)

The issue is that $TMUX is not being set in the first place when running exec tmux instead of tmux.

What steps do I need to perform to reproduce this?

Oli · Answer 17 · Tue May 02 2023 18:03:37 GMT+0800 (China Standard Time)

run exec tmux in a fresh shell (outside of a tmux session)
echo $TMUX

it sets no env variable for me.

Roman Perepelitsa · Answer 18 · Tue May 02 2023 18:07:07 GMT+0800 (China Standard Time)

Thank you! I've reproduced this. This is a bug in zsh4humans. Will try to fix later this week.

Oli · Answer 19 · Tue May 02 2023 18:15:54 GMT+0800 (China Standard Time)

I'm thanking you for your hard work and this amazing shell setup! Feel free to contact me if I can help you somehow.

Oli · Answer 20 · Tue May 02 2023 18:16:40 GMT+0800 (China Standard Time)

Also I'm reopening it while you're working on a fix.

Roman Perepelitsa · Answer 21 · Tue May 02 2023 19:52:43 GMT+0800 (China Standard Time)

Thank you! I've reproduced this. This is a bug in zsh4humans. Will try to fix later this week.

I've fixed this issue. I don't know if this also fixes the original issue you were having (you didn't provide instructions for that, so I cannot try to reproduce it).

Oli · Answer 22 · Tue May 02 2023 19:55:12 GMT+0800 (China Standard Time)

Thank you! I've reproduced this. This is a bug in zsh4humans. Will try to fix later this week.

I've fixed this issue. I don't know if this also fixes the original issue you were having (you didn't provide instructions for that, so I cannot try to reproduce it).

I assume that the original issue has been occuring due to the env variable missing. Are the changed available via z4h update?

EDIT: I've also provided the steps for the original issue up here.

Roman Perepelitsa · Answer 23 · Tue May 02 2023 19:56:08 GMT+0800 (China Standard Time)

I assume that the original issue has been occuring due to the env variable missing.

Maybe. I cannot confirm or deny this.

Are the changed available via z4h update?

Yes.

Oli · Answer 24 · Tue May 02 2023 19:58:36 GMT+0800 (China Standard Time)

$TMUX seems to be available now but the issue with my shell/terminal closing is still persistent.

Roman Perepelitsa · Answer 25 · Tue May 02 2023 20:00:42 GMT+0800 (China Standard Time)

Make sure you know which tmux commands you want to be executed in each shell and are able to execute them manually. If it works fine when doing things manually but you cannot force z4h execute these commands for you, provide instructions how to reproduce the issue and I'll take a look.

Oli · Answer 26 · Tue May 02 2023 20:04:01 GMT+0800 (China Standard Time)

Make sure you know which tmux commands you want to be executed in each shell and are able to execute them manually. If it works fine when doing things manually but you cannot force z4h execute these commands for you, provide instructions how to reproduce the issue and I'll take a look.

Tmux crashes for me even if I run the commands manually, but only if I use exec as to why I think it's an issue with tmux itself.

steps to reproduce:

run a clean shell
exec tmux
exec tmux (inside of tmux)

If I remove the exec keyword it warns me about nesting but like that it just crashes.

Roman Perepelitsa · Answer 27 · Tue May 02 2023 20:06:42 GMT+0800 (China Standard Time)

This is working as intended. Simply don't run tmux when you are already in tmux.

Oli · Answer 28 · Tue May 02 2023 20:11:25 GMT+0800 (China Standard Time)

Please compare the difference in behavior between

tmux
tmux

and

exec tmux
exec tmux

In the first case I get a warning and no nesting happens. In the 2nd case it crashes. This is an issue because when using z4h with the tmux autorun it will always crash when entering a subshell because it tries to run exec tmux ... when I'm already in tmux.

Roman Perepelitsa · Answer 29 · Tue May 02 2023 20:18:00 GMT+0800 (China Standard Time)

Plain tmux and exec tmux are working as intended. There is no issue there. If you are using tmux manually, simply don't run tmux when you are already in tmux.

My previous comment still stands: #268 (comment). So far, you didn't seem to have found which manual commands you want executed. The ones that you tried either exit your shell or print errors. You need to find commands that actually work.

Roman Perepelitsa · Answer 30 · Tue May 02 2023 20:18:48 GMT+0800 (China Standard Time)

This is an issue because when using z4h with the tmux autorun it will always crash when entering a subshell because it tries to run exec tmux ... when I'm already in tmux.

How can I reproduce this?

Oli · Answer 31 · Tue May 02 2023 20:21:15 GMT+0800 (China Standard Time)

My previous comment still stands: #268 (comment). So far, you didn't seem to have found which manual commands you want executed. The ones that you tried either exit your shell or print errors. You need to find commands that actually work.

The issue is that I'm NOT using tmux manually. z4h runs exec tmux ... again when I enter a subshell which crashes the entire session.

This is an issue because when using z4h with the tmux autorun it will always crash when entering a subshell because it tries to run exec tmux ... when I'm already in tmux.

How can I reproduce this?

run exec tmux inside of a tmux session and see what happens to your session.

EDIT: Running exec tmux manually is just for demonstration. If you want to see what I'm experiencing you would have to install poetry & run poetry shell inside of a poetry python project.

Roman Perepelitsa · Answer 32 · Tue May 02 2023 20:24:13 GMT+0800 (China Standard Time)

run exec tmux inside of a tmux session and see what happens to your session.

Simply don't do that.

You earlier said that z4h runs exec tmux automatically when the shell is already in tmux. How can I reproduce this?

Oli · Answer 33 · Tue May 02 2023 20:27:47 GMT+0800 (China Standard Time)

run exec tmux inside of a tmux session and see what happens to your session.

Simply don't do that.

You earlier said that z4h runs exec tmux automatically when the shell is already in tmux. How can I reproduce this?

Gotchu, try using any cli tool that spawns a subshell with its command while having the tmux autostart enabled in z4h.

I have a python project that uses poetry for dependency management and running poetry shell enters the python virtual environment which triggers a reload of the rc file within the subshell.

Roman Perepelitsa · Answer 34 · Tue May 02 2023 20:35:07 GMT+0800 (China Standard Time)

I don't use poetry but I'm willing to install it if there is no other way to reproduce the problem. Could you list all steps that are necessary to reproduce the problem? It should look like this:

Install poetry. Make sure that which poetry works.
Run this command: ....
Run this command: ....
Etc.
Run this command poetry shell. Notice that the shell dies. This is the problem. I want this shell to not die.

Oli · Answer 35 · Tue May 02 2023 20:42:05 GMT+0800 (China Standard Time)

Sure! I'm assuming you have python installed on your system.

Install poetry: curl -sSL https://install.python-poetry.org | python3 - Taken from here in case you want to double-check the command
cd into your test directory, e.g.: mkdir /tmp/test && cd /tmp/test
poetry init & choose the default options, it doesn't really matter
poetry install
poetry shell -> this will trigger kill the shell.

Roman Perepelitsa · Answer 36 · Wed May 03 2023 00:31:54 GMT+0800 (China Standard Time)

Thanks for the instructions. I didn't reproduce the exact problem but I see how various bad things can happen when poetry shell creates a TTY (I wonder why it does that).

Does this do what you want?

if [[ $POETRY_ACTIVE == 1 ]]; then
  zstyle ':z4h:' start-tmux no
else
  zstyle ':z4h:' start-tmux command tmux -u new -A -D -t main
fi

Oli · Answer 37 · Wed May 03 2023 01:08:38 GMT+0800 (China Standard Time)

Thanks for looking into this!

I'd rather stick to the solution I mentioned above of setting my own env variable since this is a more general problem. As written in the initial issue, I have also experienced this behavior in toolbox and there might be other tools that also cause this issue.

Roman Perepelitsa · Answer 38 · Wed May 03 2023 01:10:15 GMT+0800 (China Standard Time)

Ah, so you already have a config that does what you need? So there is no problem?

Oli · Answer 39 · Wed May 03 2023 01:20:24 GMT+0800 (China Standard Time)

I figured this out yesterday and shared it here haha, maybe it's worth adding directly to z4h to prevent this case from happening.

Roman Perepelitsa · Answer 40 · Wed May 03 2023 01:34:18 GMT+0800 (China Standard Time)

I cannot add this to z4h because it'll work incorrectly when you launch a terminal from another terminal.

Closing as there is nothing to do here.