Make the debounce time of publish diagnostic job adaptive

Signed-off-by: Sheng Chen <[email protected]>

Author: jdneo

org.eclipse.jdt.ls.core/src/org/eclipse/jdt/ls/core/internal/handlers/BaseDocumentLifeCycleHandler.java

@@ -39,6 +39,7 @@
 import org.eclipse.core.runtime.Status;
 import org.eclipse.core.runtime.SubMonitor;
 import org.eclipse.core.runtime.jobs.ISchedulingRule;
+import org.eclipse.core.runtime.jobs.Job;
 import org.eclipse.core.runtime.jobs.MultiRule;
 import org.eclipse.jdt.core.IBuffer;
 import org.eclipse.jdt.core.ICompilationUnit;
@@ -92,12 +93,23 @@ public abstract class BaseDocumentLifeCycleHandler {
 	 */
 	private static final long DOCUMENT_LIFECYCLE_MAX_DEBOUNCE = 400; /*ms*/
 
+	/**
+	 * The min & init value of adaptive debounce time for publish diagnostic job.
+	 */
+	private static final long PUBLISH_DIAGNOSTICS_MIN_DEBOUNCE = 400; /*ms*/
+
+	/**
+	 * The max value of adaptive debounce time for publish diagnostic job.
+	 */
+	private static final long PUBLISH_DIAGNOSTICS_MAX_DEBOUNCE = 3000; /*ms*/
+
 	private CoreASTProvider sharedASTProvider;
 	private WorkspaceJob validationTimer;
 	private WorkspaceJob publishDiagnosticsJob;
 	private Set<ICompilationUnit> toReconcile = new HashSet<>();
 	private Map<String, Integer> documentVersions = new HashMap<>();
-	private MovingAverage movingAverage = new MovingAverage(DOCUMENT_LIFECYCLE_MAX_DEBOUNCE);
+	private MovingAverage movingAverageForValidation = new MovingAverage(DOCUMENT_LIFECYCLE_MAX_DEBOUNCE);
+	private MovingAverage movingAverageForDiagnostics = new MovingAverage(PUBLISH_DIAGNOSTICS_MIN_DEBOUNCE);
 
 	public BaseDocumentLifeCycleHandler(boolean delayValidation) {
 		this.sharedASTProvider = CoreASTProvider.getInstance();
@@ -107,7 +119,7 @@ public BaseDocumentLifeCycleHandler(boolean delayValidation) {
 				public IStatus runInWorkspace(IProgressMonitor monitor) throws CoreException {
 					long start = System.currentTimeMillis();
 					IStatus status = performValidation(monitor);
-					movingAverage.update(System.currentTimeMillis() - start);
+					movingAverageForValidation.update(System.currentTimeMillis() - start);
 					return status;
 				}
 
@@ -156,7 +168,18 @@ protected void triggerValidation(ICompilationUnit cu, long delay) throws JavaMod
 	}
 
 	private long getDocumentLifecycleDelay() {
-		return Math.min(DOCUMENT_LIFECYCLE_MAX_DEBOUNCE, Math.round(1.5 * movingAverage.value));
+		return Math.min(DOCUMENT_LIFECYCLE_MAX_DEBOUNCE, Math.round(1.5 * movingAverageForValidation.value));
+	}
+
+	/**
+	 * @return the delay time of the publish diagnostics job. The value ranges in
+	 * ({@link #PUBLISH_DIAGNOSTICS_MIN_DEBOUNCE}, {@link #PUBLISH_DIAGNOSTICS_MAX_DEBOUNCE}) ms.
+	 */
+	private long getPublishDiagnosticsDelay() {
+		return Math.min(
+			Math.max(PUBLISH_DIAGNOSTICS_MIN_DEBOUNCE, Math.round(1.5 * movingAverageForDiagnostics.value)), 
+			PUBLISH_DIAGNOSTICS_MAX_DEBOUNCE
+		);
 	}
 
 	private ISchedulingRule getRule(Set<ICompilationUnit> units) {
@@ -209,7 +232,7 @@ private IStatus performValidation(IProgressMonitor monitor) throws JavaModelExce
 			if (monitor.isCanceled()) {
 				return Status.CANCEL_STATUS;
 			}
-			publishDiagnosticsJob.schedule(400);
+			schedulePublishDiagnosticJob();
 		} else {
 			return publishDiagnostics(new NullProgressMonitor());
 		}
@@ -280,6 +303,26 @@ public IProblemRequestor getProblemRequestor(ICompilationUnit workingCopy) {
 		unit.reconcile(ICompilationUnit.NO_AST, flags, wcOwner, monitor);
 	}
 
+	/**
+	 * Cancel the publish diagnostic job when it's <code>Job.WAITING</code> or <code>Job.SLEEPING</code>.
+	 * Do nothing for other job states.
+	 * @return <code>true</code> if the job is cancelled, otherwise return <code>false</code>
+	 */
+	public boolean cancelPublishDiagnosticJob() {
+		if (publishDiagnosticsJob.getState() == Job.WAITING || publishDiagnosticsJob.getState() == Job.SLEEPING) {
+			publishDiagnosticsJob.cancel();
+			return true;
+		}
+		return false;
+	}
+
+	/**
+	 * Schedule the publish diagnostic job.
+	 */
+	public void schedulePublishDiagnosticJob() {
+		publishDiagnosticsJob.schedule(getPublishDiagnosticsDelay());
+	}
+
 	public void didClose(DidCloseTextDocumentParams params) {
 		documentVersions.remove(params.getTextDocument().getUri());
 		ISchedulingRule rule = JDTUtils.getRule(params.getTextDocument().getUri());
@@ -652,7 +695,10 @@ private PublishDiagnosticJob(ISchedulingRule rule) {
 
 		@Override
 		public IStatus runInWorkspace(IProgressMonitor monitor) throws CoreException {
-			return publishDiagnostics(monitor);
+			long start = System.currentTimeMillis();
+			IStatus status = publishDiagnostics(monitor);
+			movingAverageForDiagnostics.update(System.currentTimeMillis() - start);
+			return status;
 		}
 
 		/* (non-Javadoc)

org.eclipse.jdt.ls.core/src/org/eclipse/jdt/ls/core/internal/handlers/JDTLanguageServer.java

@@ -572,20 +572,29 @@ public CompletableFuture<Object> executeCommand(ExecuteCommandParams params) {
 	@Override
 	public CompletableFuture<Either<List<CompletionItem>, CompletionList>> completion(CompletionParams position) {
 		logInfo(">> document/completion");
-		CompletionHandler handler = new CompletionHandler(preferenceManager);
-		final IProgressMonitor[] monitors = new IProgressMonitor[1];
-		CompletableFuture<Either<List<CompletionItem>, CompletionList>> result = computeAsync((monitor) -> {
-			monitors[0] = monitor;
-			if (Boolean.getBoolean(JAVA_LSP_JOIN_ON_COMPLETION)) {
-				waitForLifecycleJobs(monitor);
+		// postpone the publish diagnostic jobs during completion since the job will lock the whole workspace.
+		boolean cancelled = documentLifeCycleHandler.cancelPublishDiagnosticJob();
+		try {
+			CompletionHandler handler = new CompletionHandler(preferenceManager);
+			final IProgressMonitor[] monitors = new IProgressMonitor[1];
+			CompletableFuture<Either<List<CompletionItem>, CompletionList>> result = computeAsync((monitor) -> {
+				monitors[0] = monitor;
+				if (Boolean.getBoolean(JAVA_LSP_JOIN_ON_COMPLETION)) {
+					waitForLifecycleJobs(monitor);
+				}
+				return handler.completion(position, monitor);
+			});
+			result.join();
+			if (monitors[0].isCanceled()) {
+				result.cancel(true);
+			}
+			return result;
+		} finally {
+			if (cancelled) {
+				documentLifeCycleHandler.schedulePublishDiagnosticJob();
 			}
-			return handler.completion(position, monitor);
-		});
-		result.join();
-		if (monitors[0].isCanceled()) {
-			result.cancel(true);
 		}
-		return result;
+		
 	}
 
 	/* (non-Javadoc)