Skip to content
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

Jump to bottom

Cancel init or update workspace job of removed rootPaths #1064

Merged
merged 4 commits into from
Jun 18, 2019
Merged

Cancel init or update workspace job of removed rootPaths #1064

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9e0be06
Cancel init or update workspace job of removed rootPaths
Jun 11, 2019
aed1e27
Add test for cancel init or update workspace job
Jun 13, 2019
0594378
convert paths to hashset then do comparison
Jun 13, 2019
eac9ff4
Store the autobuild value
Jun 14, 2019
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
10 changes: 9 additions & 1 deletion org.eclipse.jdt.ls.core/src/org/eclipse/jdt/ls/core/internal/handlers/InitHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
import java.util.Collections;
import java.util.Map;
import java.util.Set;
import java.util.stream.Collectors;

import org.eclipse.core.resources.ResourcesPlugin;
import org.eclipse.core.resources.WorkspaceJob;
Expand Down Expand Up @@ -248,6 +249,7 @@ public IStatus runInWorkspace(IProgressMonitor monitor) {
connection.sendStatus(ServiceStatus.Started, "Ready");
} catch (OperationCanceledException e) {
connection.sendStatus(ServiceStatus.Error, "Initialization has been cancelled.");
return Status.CANCEL_STATUS;
} catch (Exception e) {
JavaLanguageServerPlugin.logException("Initialization failed ", e);
connection.sendStatus(ServiceStatus.Error, e.getMessage());
Expand All @@ -258,9 +260,15 @@ public IStatus runInWorkspace(IProgressMonitor monitor) {
/* (non-Javadoc)
* @see org.eclipse.core.runtime.jobs.Job#belongsTo(java.lang.Object)
*/
@SuppressWarnings("unchecked")
@Override
public boolean belongsTo(Object family) {
return JAVA_LS_INITIALIZATION_JOBS.equals(family);
Collection<IPath> rootPathsSet = roots.stream().collect(Collectors.toSet());
boolean equalToRootPaths = false;
if (family instanceof Collection<?>) {
equalToRootPaths = rootPathsSet.equals(((Collection<IPath>) family).stream().collect(Collectors.toSet()));
}
return JAVA_LS_INITIALIZATION_JOBS.equals(family) || equalToRootPaths;
}

};
Expand Down
17 changes: 15 additions & 2 deletions org.eclipse.jdt.ls.core/src/org/eclipse/jdt/ls/core/internal/managers/ProjectsManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@
import org.eclipse.jdt.ls.core.internal.ResourceUtils;
import org.eclipse.jdt.ls.core.internal.ServiceStatus;
import org.eclipse.jdt.ls.core.internal.StatusFactory;
import org.eclipse.jdt.ls.core.internal.handlers.InitHandler;
import org.eclipse.jdt.ls.core.internal.preferences.PreferenceManager;
import org.eclipse.jdt.ls.core.internal.preferences.Preferences;
import org.eclipse.jdt.ls.core.internal.preferences.Preferences.FeatureStatus;
Expand Down Expand Up @@ -138,7 +139,7 @@ public void initializeProjects(final Collection<IPath> rootPaths, IProgressMonit
subMonitor.done();
}

private void importProjects(Collection<IPath> rootPaths, IProgressMonitor monitor) throws CoreException {
private void importProjects(Collection<IPath> rootPaths, IProgressMonitor monitor) throws CoreException, OperationCanceledException {
SubMonitor subMonitor = SubMonitor.convert(monitor, rootPaths.size() * 100);
for (IPath rootPath : rootPaths) {
File rootFolder = rootPath.toFile();
Expand All @@ -151,11 +152,23 @@ private void importProjects(Collection<IPath> rootPaths, IProgressMonitor monito

public Job updateWorkspaceFolders(Collection<IPath> addedRootPaths, Collection<IPath> removedRootPaths) {
JavaLanguageServerPlugin.sendStatus(ServiceStatus.Message, "Updating workspace folders: Adding " + addedRootPaths.size() + " folder(s), removing " + removedRootPaths.size() + " folders.");
Job[] removedJobs = Job.getJobManager().find(removedRootPaths);
for (Job removedJob : removedJobs) {
if (removedJob.belongsTo(IConstants.UPDATE_WORKSPACE_FOLDERS_FAMILY) || removedJob.belongsTo(InitHandler.JAVA_LS_INITIALIZATION_JOBS)) {
removedJob.cancel();
}
}
WorkspaceJob job = new WorkspaceJob("Updating workspace folders") {

@SuppressWarnings("unchecked")
@Override
public boolean belongsTo(Object family) {
return IConstants.UPDATE_WORKSPACE_FOLDERS_FAMILY.equals(family) || IConstants.JOBS_FAMILY.equals(family);
Collection<IPath> addedRootPathsSet = addedRootPaths.stream().collect(Collectors.toSet());
boolean equalToRootPaths = false;
if (family instanceof Collection<?>) {
equalToRootPaths = addedRootPathsSet.equals(((Collection<IPath>) family).stream().collect(Collectors.toSet()));
}
return IConstants.UPDATE_WORKSPACE_FOLDERS_FAMILY.equals(family) || IConstants.JOBS_FAMILY.equals(family) || equalToRootPaths;
}

@Override
Expand Down
65 changes: 65 additions & 0 deletions ...lipse.jdt.ls.tests/src/org/eclipse/jdt/ls/core/internal/managers/ProjectsManagerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,28 @@
import static org.junit.Assert.assertTrue;
import static org.mockito.Mockito.mock;

import java.io.File;
import java.util.Collection;
import java.util.Collections;
import java.util.List;

import org.eclipse.core.resources.IFile;
import org.eclipse.core.resources.IProject;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.jobs.Job;
import org.eclipse.jdt.ls.core.internal.BuildWorkspaceStatus;
import org.eclipse.jdt.ls.core.internal.JavaClientConnection;
import org.eclipse.jdt.ls.core.internal.JavaClientConnection.JavaLanguageClient;
import org.eclipse.jdt.ls.core.internal.JavaLanguageServerPlugin;
import org.eclipse.jdt.ls.core.internal.ResourceUtils;
import org.eclipse.jdt.ls.core.internal.WorkspaceHelper;
import org.eclipse.jdt.ls.core.internal.handlers.BuildWorkspaceHandler;
import org.eclipse.jdt.ls.core.internal.handlers.JDTLanguageServer;
import org.eclipse.lsp4j.InitializeParams;
import org.junit.After;
import org.junit.Before;
import org.junit.Test;

/**
Expand All @@ -36,6 +48,28 @@ public class ProjectsManagerTest extends AbstractProjectsManagerBasedTest {

private JavaLanguageClient client = mock(JavaLanguageClient.class);
private JavaClientConnection javaClient = new JavaClientConnection(client);
private JDTLanguageServer server;
private boolean autoBuild;

@Before
public void setup() throws Exception {
autoBuild = preferenceManager.getPreferences().isAutobuildEnabled();
server = new JDTLanguageServer(projectsManager, preferenceManager);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you need to store the workspace autobuilding value

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

server.connectClient(client);
JavaLanguageServerPlugin.getInstance().setProtocol(server);
}

@After
public void tearDown() {
server.disconnectClient();
JavaLanguageServerPlugin.getInstance().setProtocol(null);
try {
projectsManager.setAutoBuilding(autoBuild);
preferenceManager.getPreferences().setAutobuildEnabled(autoBuild);
} catch (CoreException e) {
JavaLanguageServerPlugin.logException(e.getMessage(), e);
}
}

@Test
public void testCreateDefaultProject() throws Exception {
Expand Down Expand Up @@ -64,4 +98,35 @@ public void testCleanupDefaultProject() throws Exception {
assertEquals(String.format("BuildWorkspaceStatus is: %s.", result.toString()), BuildWorkspaceStatus.SUCCEED, result);
}

@Test
public void testCancelInitJob() throws Exception {
File workspaceDir = copyFiles("maven/salut", true);
String rootPathURI = workspaceDir.toURI().toString();
Collection<IPath> rootPaths = Collections.singleton(ResourceUtils.canonicalFilePathFromURI(rootPathURI));
InitializeParams params = new InitializeParams();
params.setRootUri(rootPathURI);
server.initialize(params);
Job[] initWorkspaceJobs = Job.getJobManager().find(rootPaths);
assertEquals(1, initWorkspaceJobs.length);
Job initWorkspaceJob = initWorkspaceJobs[0];
assertNotNull(initWorkspaceJob);
projectsManager.updateWorkspaceFolders(Collections.emptySet(), rootPaths);
waitForBackgroundJobs();
assertTrue("the init job hasn't been cancelled, status is: " + initWorkspaceJob.getResult().getSeverity(), initWorkspaceJob.getResult().matches(IStatus.CANCEL));
}

@Test
public void testCancelUpdateJob() throws Exception {
File workspaceDir = copyFiles("maven/salut", true);
Collection<IPath> addedRootPaths = Collections.singleton(new org.eclipse.core.runtime.Path(workspaceDir.toString()));
projectsManager.updateWorkspaceFolders(addedRootPaths, Collections.emptySet());
Job[] updateWorkspaceJobs = Job.getJobManager().find(addedRootPaths);
assertEquals(1, updateWorkspaceJobs.length);
Job updateWorkspaceJob = updateWorkspaceJobs[0];
assertNotNull(updateWorkspaceJob);
projectsManager.updateWorkspaceFolders(Collections.emptySet(), addedRootPaths);
waitForBackgroundJobs();
assertTrue("the update job hasn't been cancelled, status is: " + updateWorkspaceJob.getResult().getSeverity(), updateWorkspaceJob.getResult().matches(IStatus.CANCEL));
}

}