redhat-developer / redhat-developer/vscode-java

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

未关闭
#2,216 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

configuration Maven
主要语言
TypeScript
星标
2.3k
派生
546
平均合并
20 小时 1 分钟
30 天内合并 PR
11

描述

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

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

首先,使用所述的 Maven 树重现导入,并检查为 pom.xml 中的相对 build.sourceDirectory 生成的 .classpath 条目。跟踪项目导入期间 sourceDirectory 路径的转换过程。当 classpath 保留相对源路径,并且 file3.java 不再错误地报告未解析的 import 时,即表示完成。

由索引模型根据 Issue 内容生成。

评估

技术栈
java
领域
devtools
Issue 类型
缺陷
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
38/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。