.zshrc is overriding the environment variable set by shell integration on macOS

[karrtikr]

Does this issue occur when all extensions are disabled?: Yes/No

Reporting on behalf of @pquadri: microsoft/vscode-python#22901

VS Code version: Code 1.86.1 (Universal) (31c37ee, 2024-02-07T09:09:01.236Z)
OS version: Darwin arm64 23.3.0

Steps to Reproduce:

1. Python extension sets the environment variable collection using EnvironmentCollection.prepend API, by using options: {"applyAtShellIntegration":true,"applyAtProcessCreation":true}:

Prepending environment variable PATH in collection with value "<prepend>"

2. Value of PATH in zsh terminal:

/Users/paolo.quadri/.local/bin:/Users/paolo.quadri/.asdf/shims:/opt/homebrew/opt/asdf/libexec/bin:<prepend>:/opt/homebrew/bin:/opt/homebrew/sbin:/usr/local/bin:/System/Cryptexes/App/usr/bin:/usr/bin:/bin:/usr/sbin:/sbin:/var/run/com.apple.security.cryptexd/codex.system/bootstrap/usr/local/bin:/var/run/com.apple.security.cryptexd/codex.system/bootstrap/usr/bin:/var/run/com.apple.security.cryptexd/codex.system/bootstrap/usr/appleinternal/bin:<prepend>

As one can notice <prepend> is appearing twice, which is expected, but .zshrc seems to be running after it which is why <prepend> isn't the first entry in PATH.

shell integration:

[Tyriar]

As one can notice is appearing twice, which is expected, but .zshrc seems to be running after it which is why isn't the first entry in PATH.

.zshrc is meant to be called before here:

vscode/src/vs/workbench/contrib/terminal/browser/media/shellIntegration-rc.zsh

Lines 25 to 33 in e4a37b2

	# Only fix up ZDOTDIR if shell integration was injected (not manually installed) and has not been called yet
	if [[ "$VSCODE_INJECTION" == "1" ]]; then
	if [[ $options[norcs] = off && -f $USER_ZDOTDIR/.zshrc ]]; then
	VSCODE_ZDOTDIR=$ZDOTDIR
	ZDOTDIR=$USER_ZDOTDIR
	# A user's custom HISTFILE location might be set when their .zshrc file is sourced below
	. $USER_ZDOTDIR/.zshrc
	fi
	fi

@meganrogge might know more as she's the main maintainer of the zsh script and daily drives it.

[meganrogge]

I cannot reproduce the issue, so it seems likely that the user's configuration is causing this.

I've added export PATH="/path-appended-in-zshrc:$PATH" to my .zshrc.

In the extension sample, I've added:

const collection = context.environmentVariableCollection;
collection.prepend('PATH', 'path-prepended-in-extension', { applyAtShellIntegration: true });

The below shows that this works. I am guessing there's some issue happening for certain configurations that causes our shell integration script to fail / not get run.

[karrtikr]

@pquadri Is this still an issue for you?

[VSCodeTriageBot]

This issue has been closed automatically because it needs more information and has not had recent activity. See also our issue reporting guidelines.

Happy Coding!