Skip to content

Support HCR for gradle build server projects #555

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
testforstephen merged 6 commits into from
Jun 14, 2024
+120 −37
Merged

Support HCR for gradle build server projects #555

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
32960d6
Support HCR for gradle build server projects
jdneo Jun 3, 2024
ddb956a
Fix checkstyle violations
jdneo Jun 3, 2024
b09c23b
Fix NPE when auto build is disabled
jdneo Jun 4, 2024
d82ecb8
Address comments
jdneo Jun 14, 2024
d47cf07
Fix checkstyle violations
jdneo Jun 14, 2024
615b666
Use isNotBlank()
jdneo Jun 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 46 additions & 29 deletions ...oft.java.debug.plugin/src/main/java/com/microsoft/java/debug/plugin/internal/Compile.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
package com.microsoft.java.debug.plugin.internal;

import java.util.ArrayList;
import java.util.LinkedList;
import java.util.List;
import java.util.logging.Logger;

Expand All @@ -28,14 +29,16 @@
import org.eclipse.core.resources.ResourcesPlugin;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.OperationCanceledException;
import org.eclipse.jdt.core.IJavaProject;
import org.eclipse.jdt.core.IType;
import org.eclipse.jdt.ls.core.internal.BuildWorkspaceStatus;
import org.eclipse.jdt.ls.core.internal.JavaLanguageServerPlugin;
import org.eclipse.jdt.ls.core.internal.ProjectUtils;
import org.eclipse.jdt.ls.core.internal.ResourceUtils;
import org.eclipse.jdt.ls.core.internal.handlers.BuildWorkspaceHandler;
import org.eclipse.jdt.ls.core.internal.managers.ProjectsManager;
import org.eclipse.lsp4j.TextDocumentIdentifier;
import org.eclipse.lsp4j.extended.ProjectBuildParams;

import com.microsoft.java.debug.core.Configuration;

Expand All @@ -45,10 +48,15 @@ public class Compile {
private static final int GRADLE_BS_COMPILATION_ERROR = 100;

public static Object compile(CompileParams params, IProgressMonitor monitor) {
IProject mainProject = params == null ? null : ProjectUtils.getProject(params.getProjectName());
if (mainProject == null) {
if (params == null) {
throw new IllegalArgumentException("The compile parameters should not be null.");
}

IProject mainProject = null;
if (StringUtils.isNotBlank(params.getProjectName())) {
mainProject = ProjectUtils.getProject(params.getProjectName());
} else if (mainProject == null && StringUtils.isNotBlank(params.getMainClass())) {
Comment thread
jdneo marked this conversation as resolved.
Outdated
try {
// Q: is infer project by main class name necessary? perf impact?
List<IJavaProject> javaProjects = ResolveClasspathsHandler.getJavaProjectFromType(params.getMainClass());
if (javaProjects.size() == 1) {
mainProject = javaProjects.get(0).getProject();
Expand All @@ -58,7 +66,7 @@ public static Object compile(CompileParams params, IProgressMonitor monitor) {
}
}

if (isBspProject(mainProject) && !ProjectUtils.isGradleProject(mainProject)) {
if (JdtUtils.isBspProject(mainProject) && !ProjectUtils.isGradleProject(mainProject)) {
// Just need to trigger a build for the target project, the Gradle build server will
// handle the build dependencies for us.
try {
Expand All @@ -78,20 +86,37 @@ public static Object compile(CompileParams params, IProgressMonitor monitor) {
return BuildWorkspaceStatus.SUCCEED;
}

try {
if (monitor.isCanceled()) {
return BuildWorkspaceStatus.CANCELLED;
}
if (monitor.isCanceled()) {
return BuildWorkspaceStatus.CANCELLED;
}

long compileAt = System.currentTimeMillis();
if (params != null && params.isFullBuild()) {
ResourcesPlugin.getWorkspace().build(IncrementalProjectBuilder.CLEAN_BUILD, monitor);
ResourcesPlugin.getWorkspace().build(IncrementalProjectBuilder.FULL_BUILD, monitor);
} else {
ResourcesPlugin.getWorkspace().build(IncrementalProjectBuilder.INCREMENTAL_BUILD, monitor);
ProjectBuildParams buildParams = new ProjectBuildParams();
List<TextDocumentIdentifier> identifiers = new LinkedList<>();
buildParams.setFullBuild(params.isFullBuild);
for (IJavaProject javaProject : ProjectUtils.getJavaProjects()) {
if (ProjectsManager.getDefaultProject().equals(javaProject.getProject())) {
continue;
}
// we only build project which is not a BSP project, in case that the compile request is triggered by
// HCR with auto-build disabled, the build for BSP projects will be triggered by JavaHotCodeReplaceProvider.
if (!JdtUtils.isBspProject(javaProject.getProject())) {
identifiers.add(new TextDocumentIdentifier(javaProject.getProject().getLocationURI().toString()));
}
logger.info("Time cost for ECJ: " + (System.currentTimeMillis() - compileAt) + "ms");
}
if (identifiers.size() == 0) {
return BuildWorkspaceStatus.SUCCEED;
}

buildParams.setIdentifiers(identifiers);
long compileAt = System.currentTimeMillis();
BuildWorkspaceHandler buildWorkspaceHandler = new BuildWorkspaceHandler(JavaLanguageServerPlugin.getProjectsManager());
BuildWorkspaceStatus status = buildWorkspaceHandler.buildProjects(buildParams, monitor);
logger.info("Time cost for ECJ: " + (System.currentTimeMillis() - compileAt) + "ms");
if (status == BuildWorkspaceStatus.FAILED || status == BuildWorkspaceStatus.CANCELLED) {
return status;
}

try {
IResource currentResource = mainProject;
if (isUnmanagedFolder(mainProject) && StringUtils.isNotBlank(params.getMainClass())) {
IType mainType = ProjectUtils.getJavaProject(mainProject).findType(params.getMainClass());
Expand Down Expand Up @@ -135,29 +160,21 @@ public static Object compile(CompileParams params, IProgressMonitor monitor) {
}
}

if (problemMarkers.isEmpty()) {
return BuildWorkspaceStatus.SUCCEED;
if (!problemMarkers.isEmpty()) {
return BuildWorkspaceStatus.WITH_ERROR;
}

return BuildWorkspaceStatus.WITH_ERROR;
} catch (CoreException e) {
JavaLanguageServerPlugin.logException("Failed to build workspace.", e);
return BuildWorkspaceStatus.FAILED;
} catch (OperationCanceledException e) {
return BuildWorkspaceStatus.CANCELLED;
JavaLanguageServerPlugin.log(e);
}

return BuildWorkspaceStatus.SUCCEED;
}

private static boolean isUnmanagedFolder(IProject project) {
return project != null && ProjectUtils.isUnmanagedFolder(project)
&& ProjectUtils.isJavaProject(project);
}

private static boolean isBspProject(IProject project) {
return project != null && ProjectUtils.isJavaProject(project)
&& ProjectUtils.hasNature(project, "com.microsoft.gradle.bs.importer.GradleBuildServerProjectNature");
}

private static IProject getDefaultProject() {
return getWorkspaceRoot().getProject(ProjectsManager.DEFAULT_PROJECT_NAME);
}
Expand Down
24 changes: 24 additions & 0 deletions ...in/src/main/java/com/microsoft/java/debug/plugin/internal/JavaHotCodeReplaceProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,16 +34,20 @@
import java.util.logging.Level;
import java.util.logging.Logger;

import org.eclipse.core.resources.IBuildConfiguration;
import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IMarker;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.resources.IResource;
import org.eclipse.core.resources.IResourceChangeEvent;
import org.eclipse.core.resources.IResourceChangeListener;
import org.eclipse.core.resources.IResourceDelta;
import org.eclipse.core.resources.IResourceDeltaVisitor;
import org.eclipse.core.resources.IncrementalProjectBuilder;
import org.eclipse.core.resources.ResourcesPlugin;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.NullProgressMonitor;
import org.eclipse.core.runtime.Path;
import org.eclipse.jdt.core.ICompilationUnit;
import org.eclipse.jdt.core.IJavaElement;
Expand All @@ -54,6 +58,7 @@
import org.eclipse.jdt.core.util.IClassFileReader;
import org.eclipse.jdt.core.util.ISourceAttribute;
import org.eclipse.jdt.internal.core.util.Util;
import org.eclipse.jdt.ls.core.internal.JavaLanguageServerPlugin;
import org.eclipse.jdt.ls.core.internal.JobHelpers;

import com.microsoft.java.debug.core.Configuration;
Expand Down Expand Up @@ -319,6 +324,25 @@ public void onClassRedefined(Consumer<List<String>> consumer) {

@Override
public CompletableFuture<List<String>> redefineClasses() {
try {
IProject mainProject = null;
List<IJavaProject> javaProjects = ResolveClasspathsHandler.getJavaProjectFromType(context.getMainClass());
Comment thread
jdneo marked this conversation as resolved.
Outdated
if (javaProjects.size() == 1) {
mainProject = javaProjects.get(0).getProject();
}

if (mainProject != null && JdtUtils.isBspProject(mainProject)) {
ResourcesPlugin.getWorkspace().build(
new IBuildConfiguration[]{mainProject.getActiveBuildConfig()},
IncrementalProjectBuilder.INCREMENTAL_BUILD,
false /*buildReference*/,
new NullProgressMonitor()
);
}
} catch (CoreException e) {
JavaLanguageServerPlugin.log(e);
}

JobHelpers.waitForBuildJobs(10 * 1000);
return CompletableFuture.supplyAsync(() -> {
List<String> classNames = new ArrayList<>();
Expand Down
9 changes: 9 additions & 0 deletions ...ft.java.debug.plugin/src/main/java/com/microsoft/java/debug/plugin/internal/JdtUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
import org.eclipse.jdt.launching.JavaRuntime;
import org.eclipse.jdt.launching.sourcelookup.containers.JavaProjectSourceContainer;
import org.eclipse.jdt.launching.sourcelookup.containers.PackageFragmentRootSourceContainer;
import org.eclipse.jdt.ls.core.internal.ProjectUtils;

import com.microsoft.java.debug.core.DebugException;
import com.microsoft.java.debug.core.StackFrameUtility;
Expand Down Expand Up @@ -415,4 +416,12 @@ public static boolean isSameFile(IResource resource1, IResource resource2) {

return Objects.equals(resource1.getLocation(), resource2.getLocation());
}

/**
* Check if the project is managed by Gradle Build Server.
*/
public static boolean isBspProject(IProject project) {
return project != null && ProjectUtils.isJavaProject(project)
&& ProjectUtils.hasNature(project, "com.microsoft.gradle.bs.importer.GradleBuildServerProjectNature");
}
}