redhat-developer / redhat-developer/vscode-java
Extension needs Eclipse project files upon initial import if lifecycle mapping is done for compile
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2.3k
- Forks
- 546
- Avg merge
- 20h 1m
- Merged PRs (30d)
- 11
Description
From this blog entry it seems that the old Eclipse project files; .project and .classpath, would no longer be neccessary. However, this is not the case: The files are no longer auto-generated, but if they are not present, the project won't open correctly.
Environment
- Operating System: Ubuntu Linux 20.04
- JDK version: OpenJDK 17.0.5
- Visual Studio Code version: 1.74.3
- Java extension version: 1.14.0
Steps To Reproduce
- Remove the ~/.vscode directory containing any other extensions
- Remove the ~/.config/Code directory containing all non-default VS Code settings
- Open VS Code; install the "redhat.java" extension, and close again
- Repeat step 2 to clear all settings
- Create the directory ~/.config/Code/User and unzip settings.json from the attached settings.zip into it
- Unzip both the attached project.zip and eclfiles.zip into a new directory
- Open the project in VSCode through the project file foo.code-workspace. Click that you trust the authors of the workspace.
- Observe that after the "Project are imported into the workspace" popup has appeared, you can go into the Program.java file, right-click on the word "Program" after "class" on the first line, and select Find All References from the menu; three results will appear in the References panel.
- Type Ctrl-Shift-P, Java: Open Java Extension Log File; this will be a file ~/.config/Code/User/workspaceStorage/xxx/redhat.java/client.log.yyy where xxx is a generated identifier and yyy is today's date. Similarly will Java: Open Language Server Log File give a file ~/.config/Code/User/workspaceStorage/xxx/redhat.java/jdt_ws/.metadata/.log
- Quit VS Code, and repeat step 2 and 5 to clear any settings
- Delete the .project and .classpath files in the project directory.
- Open the project again in the same way as in step 7
- Observe that the "Opening Java projects" popup appear, but "Projects are imported into the workspace" do not. If you open the Program.java file and right-click on the "Program" identifier after the "class" keyword and select Find All References you get no results.
- Quit VSCode and restore the .project and .classpath files by unzipping eclfiles.zip again
- Do not clear any settings this time, but repeat step 7
- Observe that the project now works again after the files were restored.
The issue is also reproducible if the settings are not cleared, or if the full Extension Pack for Java is installed.
Current Result
In step 13 above the language server appears broken.
Expected Result
Step 13 above should be similar to step 8.
Additional Informations
In the case where the import is successful (step 8), the language server receives a workspace/executeCommand java.project.getSettings, which it does not if the Eclipse project files are missing (step 13).
If you have a multi-module Maven project which was imported in an old version of VSCode, and had .project and .classpath generated for the existing modules at the time, and you now add a new module for instance by pulling an update from a Git repository, the project files are not automatically generated for this new module and the project looks partially broken.
project.zip
eclfiles.zip
settings.zip
step8-client.log
step8-jdt_ws.log
step13-client.log
step13-jdt_ws.log
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 with the supplied project.zip, eclfiles.zip, settings.zip, and the step 8 and step 13 client and language-server logs. Compare the import paths, especially whether workspace/executeCommand java.project.getSettings is sent when .project and .classpath are absent. Done means a project without those files imports and provides the same Java language-server references behavior as the working case.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, typescript, vscode
- Domain
- developer-experience, devtools
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100