redhat-developer / redhat-developer/vscode-java
Installing this extension in codespaces monkey patches fs which can break other extensions.
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2.3k
- Forks
- 546
- Avg merge
- 20h 1m
- Merged PRs (30d)
- 11
Description
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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by inspecting vscode-java's npm dependency declarations and how graceful-fs is resolved, then reproduce the Codespaces interaction with the CodeQL extension described in the issue. Confirm that the resolved graceful-fs version is greater than 4.2.2 and verify that opening a Java file no longer causes the CodeQL database workspace error.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- node.js, typescript
- Domain
- devtools, tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100