rbenv activation leaks RBENV_VERSION and RBENV_DIR into process.env of the extension host
Los mantenedores suelen responder en 1 día
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- Medio día
- Aptitud para principiantes
- 45/100
- Tipo de issue
- Error
- Claridad
- Bien especificado
- Estado de actividad
- Activo
- Stack tecnológico
- ruby, typescript, vscode
- Área
- devtools
Línea de trabajo
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.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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.
- Lenguaje dominante
- Ruby
- Estrellas
- 2k
- Forks
- 283
- Merge medio
- 9 h 18 min
- PR fusionados (30 d)
- 11
Preparar el entorno
Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.
- Sin Dockerfile ni archivo de Docker Compose
- Tiene una plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de Shopify/ruby-lsp
-
Dependencies view: `getParent` loops forever on untitled documents, extension host runs out of memoryPosiblemente ocupada @efegokdemir la tomó hace 9 días. Abiertobug
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
Los mantenedores suelen responder en 1 día
-
Linux file system with square brackets in the directory/filename are failing to be indexedPosiblemente ocupada @andriytyurnikov la tomó hace 213 días. Abiertobug help-wanted pinned
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
Shopify/ruby-lsp#3503 · 8 comentarios · 1 reacción ·
Los mantenedores suelen responder en 1 día
-
Rename of a class moves its file and leaves require_relative on the old pathPosiblemente ocupada @efegokdemir la tomó hace 10 días. Abierto
Dificultad 4/5 3-5 días Aptitud para principiantes 22/100
Los mantenedores suelen responder en 1 día
-
Paths need to be escapedPosiblemente ocupada @Vraiment la tomó hace 14 días. Abiertobug
Dificultad 2/5 1-3 horas Aptitud para principiantes 25/100
Los mantenedores suelen responder en 1 día
-
check-labels intermittently fails due to the organization IP allow listPosiblemente ocupada @soutaro la tomó hace 17 días. Abierto
Shopify/ruby-lsp#4219 · 1 asignado ·
Los mantenedores suelen responder en 1 día
Todos los issues de Shopify/ruby-lsp
Issues similares
-
Unconfirmed users who reset their password are stuck on sign in with no way to send confirmationAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 79/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
Los mantenedores suelen responder en 1 día
-
L: github:actions L: javascript
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
dependabot/dependabot-core#16615 ·
Los mantenedores suelen responder en 1 día
-
Kanton Column not HiddenAbiertobug
Dificultad 2/5 1-3 horas Aptitud para principiantes 61/100
hitobito/hitobito_pfadi_de#164 ·
Los mantenedores suelen responder en 5 días
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
Los mantenedores suelen responder en 7 días