Skip to content
This repository has been archived by the owner on Jan 31, 2024. It is now read-only.

Cancel initialize job when removing workspace #60

Closed
wants to merge 5 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,12 @@

public class BuildPathHelper {

private final IPath root;
private final InfoRecorder rootInfoRecorder;
private JavaClientConnection connection;

public BuildPathHelper(IPath rootPath, JavaClientConnection connection) {
this.root = rootPath;
this.rootInfoRecorder = new InfoRecorder(rootPath.toFile());
this.connection = connection;
}
Expand All @@ -61,7 +63,7 @@ public IStatus runInWorkspace(IProgressMonitor monitor) {

@Override
public boolean belongsTo(Object family) {
return InitHandler.JAVA_LS_INITIALIZATION_JOBS.equals(family);
return ExtendedInitHandler.JAVA_LS_INITIALIZATION_JOBS.equals(family) || root.equals(family);
}

};
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@
import org.eclipse.core.runtime.OperationCanceledException;
import org.eclipse.core.runtime.jobs.Job;
import org.eclipse.jdt.ls.core.internal.CancellableProgressMonitor;
import org.eclipse.jdt.ls.core.internal.handlers.InitHandler;
import org.eclipse.jdt.ls.core.internal.handlers.DocumentLifeCycleHandler;
import org.eclipse.jdt.ls.core.internal.handlers.JDTLanguageServer;
import org.eclipse.jdt.ls.core.internal.managers.ProjectsManager;
Expand All @@ -25,10 +24,10 @@
import org.eclipse.lsp4j.Hover;
import org.eclipse.lsp4j.InitializeParams;
import org.eclipse.lsp4j.InitializeResult;
import org.eclipse.lsp4j.InitializedParams;
import org.eclipse.lsp4j.Location;
import org.eclipse.lsp4j.ReferenceParams;
import org.eclipse.lsp4j.TextDocumentPositionParams;
import org.eclipse.lsp4j.WorkspaceFolder;
import org.eclipse.lsp4j.jsonrpc.CancelChecker;
import org.eclipse.lsp4j.jsonrpc.CompletableFutures;
import org.eclipse.lsp4j.jsonrpc.services.JsonRequest;
Expand All @@ -52,27 +51,31 @@ public ElasticJDTLanguageServer(ProjectsManager projects, PreferenceManager pref
@Override
public CompletableFuture<InitializeResult> initialize(InitializeParams params) {
logInfo("Elastic Java Language Server version: " + ElasticJavaLanguageServerPlugin.getVersion());
CompletableFuture<InitializeResult> result = super.initialize(params);
ExtendedInitHandler handler = new ExtendedInitHandler(pm, preferenceManager);
InitializeResult result = handler.initialize(params);
BuildPathHelper pathHelper = new BuildPathHelper(ResourceUtils.canonicalFilePathFromURI(params.getRootUri()), super.getClientConnection());
pathHelper.IncludeAllJavaFiles();
// change this method to a synchronized way
try {
Job.getJobManager().join(InitHandler.JAVA_LS_INITIALIZATION_JOBS, null);
Job.getJobManager().join(ExtendedInitHandler.JAVA_LS_INITIALIZATION_JOBS, null);
} catch (OperationCanceledException | InterruptedException e) {
JavaLanguageServerPlugin.logException(e.getMessage(), e);
}
return result;
return CompletableFuture.completedFuture(result);
}

@Override
public void didChangeWorkspaceFolders(DidChangeWorkspaceFoldersParams params) {
logInfo(">> java/didChangeWorkspaceFolders");
// cancel the removed workspace initialization
List<WorkspaceFolder> removed = params.getEvent().getRemoved();
removed.forEach(w -> ExtendedInitHandler.cancelInitJobFromURI(w.getUri()));
SynchronizedWorkspaceFolderChangeHandler handler = new SynchronizedWorkspaceFolderChangeHandler(pm);
handler.update(params);
BuildPathHelper pathHelper = new BuildPathHelper(ResourceUtils.canonicalFilePathFromURI(params.getEvent().getAdded().get(0).getUri()), super.getClientConnection());
pathHelper.IncludeAllJavaFiles();
try {
Job.getJobManager().join(InitHandler.JAVA_LS_INITIALIZATION_JOBS, null);
Job.getJobManager().join(ExtendedInitHandler.JAVA_LS_INITIALIZATION_JOBS, null);
} catch (OperationCanceledException | InterruptedException e) {
JavaLanguageServerPlugin.logException(e.getMessage(), e);
}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,290 @@
package org.elastic.jdt.ls.core.internal;

import static org.elastic.jdt.ls.core.internal.ElasticJavaLanguageServerPlugin.logInfo;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
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;
import org.eclipse.core.runtime.CoreException;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.OperationCanceledException;
import org.eclipse.core.runtime.Status;
import org.eclipse.core.runtime.SubMonitor;
import org.eclipse.core.runtime.jobs.Job;
import org.eclipse.jdt.ls.core.internal.JSONUtility;
import org.eclipse.jdt.ls.core.internal.JavaClientConnection;
import org.eclipse.jdt.ls.core.internal.JavaLanguageServerPlugin;
import org.eclipse.jdt.ls.core.internal.ResourceUtils;
import org.eclipse.jdt.ls.core.internal.ServiceStatus;
import org.eclipse.jdt.ls.core.internal.handlers.BundleUtils;
import org.eclipse.jdt.ls.core.internal.handlers.CompletionHandler;
import org.eclipse.jdt.ls.core.internal.handlers.InitHandler;
import org.eclipse.jdt.ls.core.internal.handlers.RenameHandler;
import org.eclipse.jdt.ls.core.internal.handlers.SignatureHelpHandler;
import org.eclipse.jdt.ls.core.internal.handlers.WorkspaceExecuteCommandHandler;
import org.eclipse.jdt.ls.core.internal.highlighting.SemanticHighlightingService;
import org.eclipse.jdt.ls.core.internal.managers.ProjectsManager;
import org.eclipse.jdt.ls.core.internal.preferences.PreferenceManager;
import org.eclipse.jdt.ls.core.internal.preferences.Preferences;
import org.eclipse.lsp4j.ClientCapabilities;
import org.eclipse.lsp4j.CodeLensOptions;
import org.eclipse.lsp4j.DocumentOnTypeFormattingOptions;
import org.eclipse.lsp4j.ExecuteCommandOptions;
import org.eclipse.lsp4j.InitializeParams;
import org.eclipse.lsp4j.InitializeResult;
import org.eclipse.lsp4j.SaveOptions;
import org.eclipse.lsp4j.SemanticHighlightingServerCapabilities;
import org.eclipse.lsp4j.ServerCapabilities;
import org.eclipse.lsp4j.TextDocumentSyncKind;
import org.eclipse.lsp4j.TextDocumentSyncOptions;
import org.eclipse.lsp4j.WorkspaceFoldersOptions;
import org.eclipse.lsp4j.WorkspaceServerCapabilities;

/**
* Handler for the VS Code extension initialization
*/
final public class ExtendedInitHandler {

public static final String JAVA_LS_INITIALIZATION_JOBS = "java-ls-initialization-jobs";
private static final String BUNDLES_KEY = "bundles";
public static final String SETTINGS_KEY = "settings";

private ProjectsManager projectsManager;
private PreferenceManager preferenceManager;

public ExtendedInitHandler(ProjectsManager manager, PreferenceManager preferenceManager) {
this.projectsManager = manager;
this.preferenceManager = preferenceManager;
}

@SuppressWarnings("unchecked")
public InitializeResult initialize(InitializeParams param) {
logInfo("Initializing Java Language Server " + JavaLanguageServerPlugin.getVersion());
Map<?, ?> initializationOptions = this.getInitializationOptions(param);
Map<String, Object> extendedClientCapabilities = getInitializationOption(initializationOptions, "extendedClientCapabilities", Map.class);
if (param.getCapabilities() == null) {
preferenceManager.updateClientPrefences(new ClientCapabilities(), extendedClientCapabilities);
} else {
preferenceManager.updateClientPrefences(param.getCapabilities(), extendedClientCapabilities);
}


Collection<IPath> rootPaths = new ArrayList<>();
Collection<String> workspaceFolders = getInitializationOption(initializationOptions, "workspaceFolders", Collection.class);
if (workspaceFolders != null && !workspaceFolders.isEmpty()) {
for (String uri : workspaceFolders) {
IPath filePath = ResourceUtils.canonicalFilePathFromURI(uri);
if (filePath != null) {
rootPaths.add(filePath);
}
}
} else {
String rootPath = param.getRootUri();
if (rootPath == null) {
rootPath = param.getRootPath();
if (rootPath != null) {
logInfo("In LSP 3.0, InitializeParams.rootPath is deprecated in favour of InitializeParams.rootUri!");
}
}
if (rootPath != null) {
IPath filePath = ResourceUtils.canonicalFilePathFromURI(rootPath);
if (filePath != null) {
rootPaths.add(filePath);
}
}
}
if (rootPaths.isEmpty()) {
IPath workspaceLocation = ResourcesPlugin.getWorkspace().getRoot().getLocation();
logInfo("No workspace folders or root uri was defined. Falling back on " + workspaceLocation);
rootPaths.add(workspaceLocation);
}
if (initializationOptions.get(SETTINGS_KEY) instanceof Map) {
Object settings = initializationOptions.get(SETTINGS_KEY);
@SuppressWarnings("unchecked")
Preferences prefs = Preferences.createFrom((Map<String, Object>) settings);
preferenceManager.update(prefs);
}
preferenceManager.getPreferences().setRootPaths(rootPaths);

Collection<IPath> triggerPaths = new ArrayList<>();
Collection<String> triggerFiles = getInitializationOption(initializationOptions, "triggerFiles", Collection.class);
if (triggerFiles != null) {
for (String uri : triggerFiles) {
IPath filePath = ResourceUtils.canonicalFilePathFromURI(uri);
if (filePath != null) {
triggerPaths.add(filePath);
}
}
}
preferenceManager.getPreferences().setTriggerFiles(triggerPaths);

triggerInitialization(rootPaths);
Integer processId = param.getProcessId();
if (processId != null) {
JavaLanguageServerPlugin.getLanguageServer().setParentProcessId(processId.longValue());
}
try {
Collection<String> bundleList = getInitializationOption(initializationOptions, BUNDLES_KEY, Collection.class);
BundleUtils.loadBundles(bundleList);
} catch (CoreException e) {
// The additional plug-ins should not affect the main language server loading.
JavaLanguageServerPlugin.logException("Failed to load extension bundles ", e);
}
InitializeResult result = new InitializeResult();
ServerCapabilities capabilities = new ServerCapabilities();
if (!preferenceManager.getClientPreferences().isCompletionDynamicRegistered()) {
capabilities.setCompletionProvider(CompletionHandler.DEFAULT_COMPLETION_OPTIONS);
}
if (!preferenceManager.getClientPreferences().isFormattingDynamicRegistrationSupported()) {
capabilities.setDocumentFormattingProvider(Boolean.TRUE);
}
if (!preferenceManager.getClientPreferences().isRangeFormattingDynamicRegistrationSupported()) {
capabilities.setDocumentRangeFormattingProvider(Boolean.TRUE);
}
if (!preferenceManager.getClientPreferences().isOnTypeFormattingDynamicRegistrationSupported()) {
capabilities.setDocumentOnTypeFormattingProvider(new DocumentOnTypeFormattingOptions(";", Arrays.asList("\n", "}")));
}
if (!preferenceManager.getClientPreferences().isCodeLensDynamicRegistrationSupported()) {
capabilities.setCodeLensProvider(new CodeLensOptions(true));
}
if (!preferenceManager.getClientPreferences().isSignatureHelpDynamicRegistrationSupported()) {
capabilities.setSignatureHelpProvider(SignatureHelpHandler.createOptions());
}
if (!preferenceManager.getClientPreferences().isRenameDynamicRegistrationSupported()) {
capabilities.setRenameProvider(RenameHandler.createOptions());
}
if (!preferenceManager.getClientPreferences().isCodeActionDynamicRegistered()) {
capabilities.setCodeActionProvider(Boolean.TRUE);
}
if (!preferenceManager.getClientPreferences().isExecuteCommandDynamicRegistrationSupported()) {
Set<String> commands = WorkspaceExecuteCommandHandler.getCommands();
capabilities.setExecuteCommandProvider(new ExecuteCommandOptions(new ArrayList<>(commands)));
}
if (!preferenceManager.getClientPreferences().isWorkspaceSymbolDynamicRegistered()) {
capabilities.setWorkspaceSymbolProvider(Boolean.TRUE);
}
if (!preferenceManager.getClientPreferences().isDocumentSymbolDynamicRegistered()) {
capabilities.setDocumentSymbolProvider(Boolean.TRUE);
}
if (!preferenceManager.getClientPreferences().isDefinitionDynamicRegistered()) {
capabilities.setDefinitionProvider(Boolean.TRUE);
}
if (!preferenceManager.getClientPreferences().isTypeDefinitionDynamicRegistered()) {
capabilities.setTypeDefinitionProvider(Boolean.TRUE);
}
if (!preferenceManager.getClientPreferences().isHoverDynamicRegistered()) {
capabilities.setHoverProvider(Boolean.TRUE);
}
if (!preferenceManager.getClientPreferences().isReferencesDynamicRegistered()) {
capabilities.setReferencesProvider(Boolean.TRUE);
}
if (!preferenceManager.getClientPreferences().isDocumentHighlightDynamicRegistered()) {
capabilities.setDocumentHighlightProvider(Boolean.TRUE);
}
if (!preferenceManager.getClientPreferences().isFoldgingRangeDynamicRegistered()) {
capabilities.setFoldingRangeProvider(Boolean.TRUE);
}
if (!preferenceManager.getClientPreferences().isImplementationDynamicRegistered()) {
capabilities.setImplementationProvider(Boolean.TRUE);
}
TextDocumentSyncOptions textDocumentSyncOptions = new TextDocumentSyncOptions();
textDocumentSyncOptions.setOpenClose(Boolean.TRUE);
textDocumentSyncOptions.setSave(new SaveOptions(Boolean.TRUE));
textDocumentSyncOptions.setChange(TextDocumentSyncKind.Incremental);
if (preferenceManager.getClientPreferences().isWillSaveRegistered()) {
textDocumentSyncOptions.setWillSave(Boolean.TRUE);
}

if (preferenceManager.getClientPreferences().isWillSaveWaitUntilRegistered()) {
textDocumentSyncOptions.setWillSaveWaitUntil(Boolean.TRUE);
}
capabilities.setTextDocumentSync(textDocumentSyncOptions);

if (preferenceManager.getClientPreferences().isSemanticHighlightingSupported()) {
SemanticHighlightingServerCapabilities semanticHighlightingCapabilities = new SemanticHighlightingServerCapabilities();
semanticHighlightingCapabilities.setScopes(SemanticHighlightingService.getAllScopes());
capabilities.setSemanticHighlighting(semanticHighlightingCapabilities);
}

WorkspaceServerCapabilities wsCapabilities = new WorkspaceServerCapabilities();
WorkspaceFoldersOptions wsFoldersOptions = new WorkspaceFoldersOptions();
wsFoldersOptions.setSupported(Boolean.TRUE);
wsFoldersOptions.setChangeNotifications(Boolean.TRUE);
wsCapabilities.setWorkspaceFolders(wsFoldersOptions);
capabilities.setWorkspace(wsCapabilities);

result.setCapabilities(capabilities);
return result;
}

public static void cancelInitJobFromURI(String uri) {
IPath rootName = ResourceUtils.canonicalFilePathFromURI(uri);
Job[] jobs = Job.getJobManager().find(rootName);
for (Job job: jobs) {
JavaLanguageServerPlugin.logInfo("Cancel init job: " + job.toString());
job.cancel();
}
}

private void triggerInitialization(Collection<IPath> roots) {
Job job = new WorkspaceJob("Initialize Workspace") {
@Override
public IStatus runInWorkspace(IProgressMonitor monitor) {
long start = System.currentTimeMillis();
SubMonitor subMonitor = SubMonitor.convert(monitor, 100);
try {
JavaLanguageServerPlugin.logInfo("Start initialization");
projectsManager.setAutoBuilding(false);
projectsManager.initializeProjects(roots, subMonitor);
projectsManager.setAutoBuilding(preferenceManager.getPreferences().isAutobuildEnabled());
JavaLanguageServerPlugin.logInfo("Workspace initialized in " + (System.currentTimeMillis() - start) + "ms");
} catch (OperationCanceledException e) {
} catch (Exception e) {
JavaLanguageServerPlugin.logException("Initialization failed ", e);
}
return Status.OK_STATUS;
}

/* (non-Javadoc)
* @see org.eclipse.core.runtime.jobs.Job#belongsTo(java.lang.Object)
*/
@Override
public boolean belongsTo(Object family) {
boolean belongsToAnyRoot = false;
for (IPath root: roots) {
belongsToAnyRoot |= root.equals(family);
}
return JAVA_LS_INITIALIZATION_JOBS.equals(family) || belongsToAnyRoot;
}

};
job.setPriority(Job.BUILD);
job.setRule(ResourcesPlugin.getWorkspace().getRoot());
job.schedule();
}

private Map<?, ?> getInitializationOptions(InitializeParams params) {
Map<?, ?> initOptions = JSONUtility.toModel(params.getInitializationOptions(), Map.class);
return initOptions == null ? Collections.emptyMap() : initOptions;
}

private <T> T getInitializationOption(Map<?, ?> initializationOptions, String key, Class<T> clazz) {
if (initializationOptions != null) {
Object bundleObject = initializationOptions.get(key);
if (clazz.isInstance(bundleObject)) {
return clazz.cast(bundleObject);
}
}
return null;
}

}

Choose a reason for hiding this comment

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

Please leave a new line at the end of the file. It's optional.

Loading