redhat-developer / redhat-developer/vscode-java

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

Offen
#2,134 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

extension-start
Vorherrschende Sprache
TypeScript
Sterne
2.3k
Forks
546
Ø Merge
20 Std. 1 Min.
Gemergte PRs (30 T.)
11

Beschreibung

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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, die npm-Abhängigkeitserklärungen von vscode-java und die Auflösung von graceful-fs zu untersuchen, und reproduziere anschließend die in der Issue beschriebene Interaktion von Codespaces mit der CodeQL-Erweiterung. Bestätige, dass die aufgelöste graceful-fs-Version größer als 4.2.2 ist, und überprüfe, dass das Öffnen einer Java-Datei nicht mehr den CodeQL-Datenbank-Workspace-Fehler verursacht.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
node.js, typescript
Bereich
devtools, tooling
Issue-Typ
Bug
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.