redhat-developer / redhat-developer/vscode-java
Installing this extension in codespaces monkey patches fs which can break other extensions.
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- TypeScript
- Estrellas
- 2.3k
- Forks
- 546
- Merge medio
- 20 h 1 min
- PR fusionados (30 d)
- 11
Descripción
Installing both this vscode-java in a codespace breaks the codeql extension.
Environment
- Operating System: codespaces
- JDK version:
- Visual Studio Code version:
- Java extension version:
Steps To Reproduce
- Install both extensions
- Open the codeql pane (load codeql extension)
- Wait for codeql to startup (can take some time due to needing to download
codeqlitself). - In codeql extension choose download a database from lgtm; Pick
g/apache/maven, thenjava. - Open the codeql pane (load codeql extension again)
- Open a java file (load java extension)
- In the workspace root look in the newly added top level root starting
apache_maven_... - An error about accessing
pipesonundefinedhappens.
Additional Informations
This is a very complex 3 way interaction between the 2 extensions and codespaces. The underlying bug is https://github.com/isaacs/node-graceful-fs/issues/170 which is fixed with newer versions of graceful-fs. This is still used by vscode-java so things break I can't quite work out how an old version ends up in vscode-java as the only runtime dependency is optional but specifying --no-optional doesn't fix it (I am not a js/npm expert).
The full issue happens due to the following steps:
- Basically codespaces patches
fs(usinggraceful-fs) so that some values become computed properties. vscode-codeql"subclasses" classes infsdue to (usinggraceful-fs) internally.- The broken version of graceful-fs in
vscode-javais loaded and accidentally mutatesfs(due to the use of computed properties in the patched version offs). - The "classes" in
vscode-codeqldon't have the new prototype in the chain so the new constructors from the broken version offscreate new objects rather than modifyingthis.
Note that the issues with fs having properties is also the case with node 15+ but vscode is on 14 so this will break in future whenever vscode updates nodejs that far.
To fix it you need to ensure the version of graceful-fs is greater than 4.2.2 where the bug is fixed.
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.
Línea de trabajo
Comienza inspeccionando las declaraciones de dependencias npm de vscode-java y cómo se resuelve graceful-fs; después, reproduce la interacción de Codespaces con la extensión CodeQL descrita en el issue. Confirma que la versión resuelta de graceful-fs es mayor que 4.2.2 y verifica que abrir un archivo Java ya no provoque el error del workspace de la base de datos de CodeQL.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- node.js, typescript
- Área
- devtools, tooling
- Tipo de issue
- Error
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100