redhat-developer / redhat-developer/vscode-java

Installing this extension in codespaces monkey patches fs which can break other extensions.

Aperta
#2,134 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

extension-start
Lingua principale
TypeScript
Stelle
2.3k
Fork
546
Merge medio
20h 1m
PR unite (30g)
11

Descrizione

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
  1. Install both extensions
  2. Open the codeql pane (load codeql extension)
  3. Wait for codeql to startup (can take some time due to needing to download codeql itself).
  4. In codeql extension choose download a database from lgtm; Pick g/apache/maven, then java.
  5. Open the codeql pane (load codeql extension again)
  6. Open a java file (load java extension)
  7. In the workspace root look in the newly added top level root starting apache_maven_...
  8. An error about accessing pipes on undefined happens.
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 (using graceful-fs) so that some values become computed properties.
  • vscode-codeql "subclasses" classes in fs due to (using graceful-fs) internally.
  • The broken version of graceful-fs in vscode-java is loaded and accidentally mutates fs (due to the use of computed properties in the patched version of fs).
  • The "classes" in vscode-codeql don't have the new prototype in the chain so the new constructors from the broken version of fs create new objects rather than modifying this.

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.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia esaminando le dichiarazioni delle dipendenze npm di vscode-java e il modo in cui viene risolto graceful-fs, quindi riproduci l’interazione di Codespaces con l’estensione CodeQL descritta nell’issue. Conferma che la versione risolta di graceful-fs sia maggiore di 4.2.2 e verifica che l’apertura di un file Java non causi più l’errore del workspace del database CodeQL.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
node.js, typescript
Ambito
devtools, tooling
Tipo di issue
Bug
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.