Shell integration turns off after first command when installed with another PS1-affecting PROMPT_COMMAND

Thanks for filing an issue! Please answer the questions below so I can help you.

• iTerm2 version: 3.1.beta.6
• OS version: 10.12.6
• Attach ~/Library/Preferences/com.googlecode.iterm2.plist here (drag-drop from finder into this window): N/A
• Attach a debug log, if possible. Instructions at https://iterm2.com/debuglog: N/A

Detailed steps to reproduce the problem:

1. Install shell integration
2. Open new shell session
3. Run any command

What happened: shell integration escape codes aren't added to prompt

What should have happened: shell integration escape codes should've been added to prompt

Here's the PROMPT_COMMAND I have and the code that sets it:

set_prompt() {
    ...
    export PS1="stuff"
}

if [ -n "$PROMPT_COMMAND" ]; then
  PROMPT_COMMAND="$PROMPT_COMMAND; set_prompt"
else
  PROMPT_COMMAND="set_prompt"
fi

My ~/.profile:

if [ -n "$BASH_VERSION" ]; then
  . $HOME/.bashrc
fi

test -e ${HOME}/.iterm2_shell_integration.bash && source ${HOME}/.iterm2_shell_integration.bash

Additional debug info:

$ echo $PROMPT_COMMAND
__bp_precmd_invoke_cmd; another_command; set_prompt; __bp_interactive_mode

As far as I can tell, this is set up the way the shell integration wants it to, according to .iterm2_shell_integration.bash:306:

PROMPT_COMMAND="__bp_precmd_invoke_cmd; ${existing_prompt_command} __bp_interactive_mode"

Still, it seems as if my PS1-setting prompt command is overwriting iTerm's.

Shell integration changes PS1 from within __bp_precmd_invokecmd. If you need to change it after that, then do something like this:

export PS1="\[$iterm2_prompt_prefix_value\]Your PS1 goes here\[$(iterm2_prompt_suffix)\]"
export ITERM_PREV_PS1="$PS1"

The second line is needed so shell integration won't notice what you did.

I suppose I should add a hook for folks who want to dynamically generate their PS1s.

changed milestone to %Review for next version

Thanks, I'll manually add those to my prompt.

Would it work to instead add the pre/suffix in __bp_interactive_mode instead of in __bp_invoke_precmd? Then custom-generated PS1s wouldn't get overridden.

I also noticed there's an explicit note about this case on .iterm2_shell_integration.bash:435-437:

427 # Runs after interactively edited command but before execution
428 __iterm2_preexec() {
429     # Save the returned value from our last command
430     __iterm2_last_ret_value="$?"
431 
432     iterm2_begin_osc
433     printf "133;C;"
434     iterm2_end_osc
435     # If PS1 still has the value we set it to in iterm2_preexec_invoke_cmd then
436     # restore it to its original value. It might have changed if you have
437     # another PROMPT_COMMAND (like liquidprompt) that modifies PS1.
438     if [ -n "${ITERM_ORIG_PS1+xxx}" -a "$PS1" = "$ITERM_PREV_PS1" ]
439     then
440       export PS1="$ITERM_ORIG_PS1"
441     fi
442     iterm2_ran_preexec="yes"
443 
444     __bp_set_ret_value "$__iterm2_last_ret_value" "$__bp_last_argument_prev_command"
445 }

Is that accounting for a different case?

Adding those didn't fix the issue.

One other thing I noticed:

$ printf '%q' "$(iterm2_prompt_suffix)\n"
$'\E]133;B\a'
$ printf '%q' "$iterm2_prompt_prefix_value\n"
''
$ [ -z "$iterm2_prompt_prefix_value" ] && echo true
true

What could be making the prefix be empty?

I think that to achieve your goal, you need to load your script after shell integration, and have it insert itself earlier in PROMPT_COMMAND. Something like:

source $HOME/.iterm2_shell_integration.bash
export PROMPT_COMMAND="set_prompt; $PROMPT_COMMAND"

But to answer your questions:

__bp_interactive_mode is part of the framework for adding precmd support to bash, so I shouldn't really be modifying it. I think the reason you'd prefer I use it is because it'll run after your prompt command. If that were all you needed you could load your script before shell integration.

iterm2_prompt_prefix_value is empty because it's local to __iterm2_precmd.

Running PROMPT_COMMAND="set_prompt; $PROMPT_COMMAND" doesn't seem to work. It seems that when I change ~/.profile to the following, my PROMPT_COMMAND ends up containing __bp_install, which then modifies PROMPT_COMMAND after every command:

#~/.profile
test -e ${HOME}/.iterm2_shell_integration.bash && source ${HOME}/.iterm2_shell_integration.bash

if [ -n "$BASH_VERSION" ]; then
  . $HOME/.bashrc
fi

$ echo $PROMPT_COMMAND
__bp_precmd_invoke_cmd; __bp_install ; another_command; set_prompt; __bp_interactive_mode

Here's a patch to the bash shell integration script you can try:

diff --git a/source/shell_integration/bash b/source/shell_integration/bash
index e3e5103..2ac22bd 100755
--- a/source/shell_integration/bash
+++ b/source/shell_integration/bash
@@ -490,6 +490,14 @@ function __iterm2_precmd () {
       export ITERM_ORIG_PS1="$PS1"
     fi

+    # If you want to generate PS1 dynamically from PROMPT_COMMAND, the best way
+    # to do it is to define a function named iterm2_generate_ps1 that sets PS1.
+    # Issue 5964. Other shells don't have this issue because they don't need
+    # such extremes to get precmd and preexec.
+    if [ -n "$(type -t iterm2_generate_ps1)" ] && [ "$(type -t iterm2_generate_ps1)" = function ]; then
+      iterm2_generate_ps1
+    fi
+
     if [[ "$PS1" != "$ITERM_PREV_PS1" ]]
     then
       export ITERM_ORIG_PS1="$PS1"

To use it, define a function named iterm2_generate_ps1 that sets PS1.

That seems to fix it! Thanks.

Hello! I have faced with the same issue after upgrade to 3.1.1 from 3.0 version. But my problem related with external function. I'm using git-prompt.sh provided by git brew package for git info in terminal. My bash profile looks like this:

[ -f /usr/local/etc/bash_completion ] && . /usr/local/etc/bash_completion

PROMPT_COMMAND='__git_ps1 "\u@\h:\w" "\\\$ "'

test -e "${HOME}/.iterm2_shell_integration.bash" && source "${HOME}/.iterm2_shell_integration.bash"

__git_ps1 also modifies PS1 and it leads to issue with iterm2 integration. In this case my PROMPT_COMMAND looks like this:

$ echo $PROMPT_COMMAND
__bp_precmd_invoke_cmd; __git_ps1 "\u@\h:\w" "\\\$ "; __bp_interactive_mode

@gnachman As far as I understand you suggest to move __git_ps1 "\u@\h:\w" "\\\$ " (and all PS1 modification functions) into iterm2_generate_ps1 function to fix integration. Is it correct? But it leads to support custom bash config for iterm2. I think it is bad idea. In my point of view integration should be done without manual modifications in bash config or external scripts. I have seen precmd_functions array, but it is also custom iterm config. It will not work on native bash linux console without additional actions, but I want to use one config for all systems and terminals (early it works).

I have set PROMPT_COMMAND to following value and iterm2 integration (command statuses) return:

PROMPT_COMMAND='__git_ps1 "\u@\h:\w" "\\\$ "; __bp_precmd_invoke_cmd; __bp_interactive_mode'

So I have following question: is it possible to move PS1 modification from __bp_precmd_invoke_cmd function to last function in PROMPT_COMMAND? Why should we have __bp_precmd_invoke_cmd on the first place in PROMPT_COMMAND? I think it is Ok, if item2 integrations will update PS1 at the end. What do you think?

Thanks :)