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
- フォーク
- 283
- 平均マージ
- 9時間 18分
- マージ済み PR(30日)
- 11
環境構築
このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
Shopify/ruby-lsp のほかの issue
-
Dependencies view: `getParent` loops forever on untitled documents, extension host runs out of memory対応中かも @efegokdemir が 9 日前に担当しました。 オープンbug
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
メンテナーはふだん 1 日以内に返信
-
Linux file system with square brackets in the directory/filename are failing to be indexed対応中かも @andriytyurnikov が 213 日前に担当しました。 オープンbug help-wanted pinned
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
Shopify/ruby-lsp#3503 · コメント 8 件 · リアクション 1 件 ·
メンテナーはふだん 1 日以内に返信
-
Rename of a class moves its file and leaves require_relative on the old path対応中かも @efegokdemir が 10 日前に担当しました。 オープン
難易度 4/5 3〜5日 初心者へのやさしさ 22/100
メンテナーはふだん 1 日以内に返信
-
Paths need to be escaped対応中かも @Vraiment が 14 日前に担当しました。 オープンbug
難易度 2/5 1〜3時間 初心者へのやさしさ 25/100
メンテナーはふだん 1 日以内に返信
-
check-labels intermittently fails due to the organization IP allow list対応中かも @soutaro が 17 日前に担当しました。 オープン
Shopify/ruby-lsp#4219 · 担当者 1 名 ·
メンテナーはふだん 1 日以内に返信
Shopify/ruby-lsp の issue をすべて見る
似ている issue
-
Unconfirmed users who reset their password are stuck on sign in with no way to send confirmationオープン
難易度 2/5 1〜3時間 初心者へのやさしさ 79/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
メンテナーはふだん 1 日以内に返信
-
L: github:actions L: javascript
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
dependabot/dependabot-core#16615 ·
メンテナーはふだん 1 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 61/100
hitobito/hitobito_pfadi_de#164 ·
メンテナーはふだん 5 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
メンテナーはふだん 7 日以内に返信