Shell integration zsh hooks don't load on macOS/Linux sometimes

[roblourens]

Testing #141339

I get this error in the terminal, on Linux using zsh

/snap/code-insiders/917/usr/share/code-insiders/resources/app/out/vs/workbench/contrib/terminal/browser/media/shellIntegration-zsh.sh: 50: /snap/code-insiders/917/usr/share/code-insiders/resources/app/out/vs/workbench/contrib/terminal/browser/media/shellIntegration-zsh.sh: Syntax error: word unexpected (expecting ")")

$ zsh --version
zsh --version
zsh 5.4.2 (x86_64-ubuntu-linux-gnu)

[Tyriar]

Can repro with plain zsh installed via apt

[Tyriar]

The problem lines are:

precmd_functions+=($precmd_functions precmd)
preexec_functions+=($preexec_functions preexec)

I tried to use autoload and add-zsh-hook which I think is the more portable way to do this, but I get autoload: not found for some reason. This is with zsh 5.8.

[Tyriar]

It's a shame but let's defer, we can call out that there's a known issue with zsh in the release notes.

[Tyriar]

There's also some issue @rzhao271 was hitting which seems related to using macOS' default zsh, not the homebrew install #140784 (comment)

[gmessow-cxomni]

I had the same problem with under Linux (with oh-my-zsh, don't know if this relevant).

The following changes to the integration shell script helped:

Add as first line: #!/bin/zsh

Added at line 49:
typeset -a precmd_functions preexec_functions

Change line 50 and 51 to:
precmd_functions+=(precmd)
preexec_functions+=(preexec)

[Tyriar]

@gmessow-cxomni thanks for the info, I'm relatively new to zsh scripting so this should be handy

[Tyriar]

Spent some time looking into this and here's my understanding of what's happening. We launch zsh with shell integration using:

zsh -c '"${execInstallFolder}/out/vs/workbench/contrib/terminal/browser/media/shellIntegration.zsh"; zsh -i'

Since -c is used, autoload, add-zsh-hook, etc. aren't available which is messing everything up. I don't know why results are inconsistent across machines but that's the theory, so the fix would be to move to something closer to what bash does where we source rc/profile within the shell integration script.

[roblourens]

Can't verify, due to #143389

[Tyriar]

Added verification steps needed to deter people from trying until it's fixed (hopefully today or tomorrow: #143629)

[Tyriar]

Ready to verify after today's insiders goes out

[Tyriar]

Actually, this has the same verification steps as #143629 so adding verified here and deferring to that issue.