rbenv activation leaks RBENV_VERSION and RBENV_DIR into process.env of the extension host
维护者通常 1 天内回复
评估
- 难度
- 3/5
- 预计耗时
- 半天
- 新手友好度
- 45/100
- Issue 类型
- 缺陷
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- ruby, typescript, vscode
- 领域
- devtools
调研方向
Start in vscode/src/ruby.ts, where the activated environment is assigned to process.env, and in sanitizeEnvironment, which filters the dump from rbenv exec (vscode/src/ruby/rbenv.ts). Also check versionManager.ts, where the activation script is spawned with env: process.env. Done means RBENV_VERSION and RBENV_DIR no longer reach process.env after activation, while the Ruby LSP server still gets the rbenv-selected environment. Choosing between the three proposed fixes is a maintainer decision, so ask before committing to one.
由索引模型根据 Issue 内容生成。
描述
Description
After Ruby activation, the extension replaces the environment of the whole extension host:
With rbenv, env is the environment of rbenv exec ruby
(rbenv.ts).
rbenv exec exports its internal variables to the child process, so the dump contains:
RBENV_VERSION=4.0.6
RBENV_DIR=/path/to/first/workspace
RBENV_HOOK_PATH=...
RBENV_ORIG_PATH=...
sanitizeEnvironment removes only RUBY_GC*, VERBOSE and DEBUG, so these variables end up in
process.env. rbenv gives RBENV_VERSION priority over .ruby-version, and it looks for
.ruby-version from RBENV_DIR rather than from the current directory. Every process started from
the extension host after activation is therefore pinned to the Ruby version and the folder of the
first activation.
Impact
-
Other extensions. All extensions share one extension host. A CLI that another extension
starts inherits the pinned version. We hit this with the Claude Code extension: its CLI, and every
shell it opens, hadRBENV_VERSIONset. After a Ruby bump in.ruby-version, Bundler fails with
Your Ruby version is X, but your Gemfile specified Yuntil VS Code restarts. The integrated
terminal is not affected, because it does not start from the extension host. That made the cause
hard to find. -
Ruby LSP itself. Activation spawns the activation script with
env: process.env
(versionManager.ts). After the first activation,process.envalready holdsRBENV_VERSION, so
a laterrbenv exec rubygets the old version. From reading the code, we expect this for:- a second folder of a multi-root workspace with a different
.ruby-version, - "Ruby LSP: Restart" after a change of
.ruby-version.
We did not run these two cases ourselves. #3270 reports the same Bundler error with rbenv,
including in a multi-root workspace. - a second folder of a multi-root workspace with a different
Steps to reproduce
- Use rbenv, and open a project with a
.ruby-versionin VS Code with Ruby LSP. - Wait until Ruby LSP activates Ruby.
- Start a process from another extension (for example, the Claude Code extension) and run
env | grep RBENV.
Expected: no RBENV_VERSION or RBENV_DIR. rbenv selects the version from .ruby-version of
the current directory.
Actual: RBENV_VERSION and RBENV_DIR hold the values of the first activation.
Proposed fix
One of these, from the smallest change to the cleanest:
- Delete the version manager internals in
sanitizeEnvironment:RBENV_VERSION,RBENV_DIR,
RBENV_HOOK_PATHandRBENV_ORIG_PATH. Other managers can have similar variables. - Copy only the variables that other extensions need into
process.env:PATH,GEM_HOMEand
GEM_PATH. - Remove the global assignment, and keep the activated environment for the Ruby LSP server only.
In #1997, the global assignment was called "simply the easiest option" while the integrations mature.
Option 1 or 2 keeps that purpose and removes the leak.
Related
- #1997: the same
process.envassignment brokePATHfor other extensions with asdf. - #3270: stray
RBENV_VERSIONand a Bundler version mismatch with rbenv. - Shopify/vscode-ruby-lsp#699: introduced the assignment (Shadowenv only).
- #1438, #1502: applied it to all version managers. #1811: rbenv uses the same path.
Environment
- Ruby LSP extension 0.10.6 (the code on
mainatc6aec8cbb2is the same) - VS Code 1.141.1
- rbenv 1.3.2
- macOS 26
- Workaround: set
RBENV_VERSION=""andRBENV_DIR=""in the environment of the affected tool.
rbenv treats an empty value as unset.
- 主要语言
- Ruby
- 星标
- 2k
- 派生
- 286
- 平均合并
- 8 小时 37 分钟
- 30 天内合并 PR
- 12
环境准备
在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
Shopify/ruby-lsp 的其他 Issue
-
Dependencies view: `getParent` loops forever on untitled documents, extension host runs out of memory可能已有人在做 @efegokdemir 于 13 天前认领。 未关闭bug
难度 2/5 1-3 小时 新手友好度 70/100
维护者通常 1 天内回复
-
Linux file system with square brackets in the directory/filename are failing to be indexed可能已有人在做 @andriytyurnikov 于 217 天前认领。 未关闭bug help-wanted pinned
难度 2/5 1-3 小时 新手友好度 68/100
Shopify/ruby-lsp#3503 · 8 条评论 · 1 个 reaction ·
维护者通常 1 天内回复
-
Diagnostics use a stale parse_result when the request is read before its didChange is applied可能已有人在做 @efegokdemir 今天认领。 未关闭
难度 4/5 3-5 天 新手友好度 52/100
维护者通常 1 天内回复
-
Rename of a class moves its file and leaves require_relative on the old path可能已有人在做 @efegokdemir 于 15 天前认领。 未关闭
难度 4/5 3-5 天 新手友好度 22/100
维护者通常 1 天内回复
-
Paths need to be escaped可能已有人在做 @Vraiment 于 18 天前认领。 未关闭bug
难度 2/5 1-3 小时 新手友好度 25/100
维护者通常 1 天内回复
相似的 Issue
-
难度 1/5 1 小时以内 新手友好度 84/100
-
难度 2/5 1-3 小时 新手友好度 65/100
-
难度 2/5 1-3 小时 新手友好度 67/100
-
难度 2/5 1-3 小时 新手友好度 65/100
wolfi-dev/os#78773 · 2 个 reaction ·
维护者通常 2 天内回复
-
难度 1/5 1 小时以内 新手友好度 88/100
TheOdinProject/curriculum#31487 · 2 条评论 ·
维护者通常 1 天内回复