redhat-developer / redhat-developer/vscode-java

Incorrect value of classpathentry element in the .classpath file if in pom.xml the build.sourceDirectory is relative

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

Dieses Issue hat noch niemand übernommen.

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

Beschreibung

Short description:
A pom file with a source directory containing "../" isn't imported correctly

Long drescription:
We have a maven "tree" of projects in which some source files have to be shared.
The project is split into components and each component has hundredths of modules (but this doesn't matter for the bug, however that's the reason why we open the code "by components", it's too big to work at the root level).
The simplified version looks like this:

ROOT
  ├ A (component)
  | └ interface
  |   └ src
  |     ├ file1.java
  |     └ file2.java
  └ B (component)
    ├ B1 (module 1)
    | └ pom.xml (child 1)
    ├ B2 (module 2)
    | ├ src
    | |  └ file3.java
    | └ pom.xml (child 2)
    └ pom.xml (parent)

I open, in VS code, the folder B saying that I trust everything which is in the parent folder (so trusting everything which is in ROOT).
It starts importing the projects.

The B1 module is a library which doesn't contain any source files (locally) but, in its pom.xml has

<build>
   <sourceDirectory>${basedir}/../../A/interface/src</sourceDirectory>
</build>

The B2 is a normal module in which file3.java
imports A.interface.class1
The B2 module, in its pom, has a dependency on B1.

When I build on maven the build creates these:

B  [pom]
B1 [jar]
B2 [jar]

and everything works fine.

Visual studio code, however complains that file3.java has an import that can not be resolved.
This is due to the fact that the module B1 is not "common" because it doesn't have any code in the B1 folder but points to a relative path (which, by the way is one level above the one opened by vscode, but still in the trusted area)

The problem seems to be that in the .classpath file I have this wrong path:

<classpath>
	<classpathentry kind="src" output="target/classes" path="/A/interface/src">
		<attributes>
			<attribute name="optional" value="true"/>
			<attribute name="maven.pomderived" value="true"/>
		</attributes>
	</classpathentry>

which is wrong because everything with "../../" has been stripped out.

workaround tried:

  • Editing the .classpath file manually and changing the path. Doesn't work.
  • Adding the sources dynamically (with the maven build helper). Doesn't work.

The only solution is to copy everything in A/interface/src during the sources generation phase into the B1/target/generated-sources folder. This, of course, wastes lots of times if the sources to copy are a lot.

Environment
  • Operating System: Win10
  • JDK version: 1.8.0.292 (project) 11.0.10.0 (language server)
  • Visual Studio Code version: 1.62.2
  • Java extension version: 1.0.0
Steps To Reproduce

import a pom.xml which changes the sourceDirectory
Logs are too big to be attached.

Current Result

False error in sources

Expected Result

No error

Additional Informations

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, den Import mit dem beschriebenen Maven-Baum zu reproduzieren, und untersuche den generierten .classpath-Eintrag für das relative build.sourceDirectory in pom.xml. Verfolge, wie der sourceDirectory-Pfad während des Projektimports umgewandelt wird. Als erledigt gilt die Aufgabe, wenn der Classpath den relativen Quellpfad beibehält und file3.java keinen fälschlicherweise als nicht auflösbar gemeldeten Import mehr enthält.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
java
Bereich
devtools
Issue-Typ
Bug
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
38/100

Neue Issues direkt in Ihr Postfach

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