Add java.diagnostic.filter to exclude files from diagnostic publishing.

- Add testcase

Signed-off-by: Roland Grunberg <[email protected]>

Author: rgrunber

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

@@ -129,12 +129,18 @@ public void beginReporting() {
 
 	@Override
 	public void endReporting() {
-		JavaLanguageServerPlugin.logInfo(problems.size() + " problems reported for " + this.uri.substring(this.uri.lastIndexOf('/')));
-		boolean isDiagnosticTagSupported = JavaLanguageServerPlugin.getPreferencesManager().getClientPreferences().isDiagnosticTagSupported();
-		List<Diagnostic> diagnostics = toDiagnosticsArray(this.cu, problems, isDiagnosticTagSupported);
-		collectNonJavaProblems(diagnostics, isDiagnosticTagSupported);
-		PublishDiagnosticsParams $ = new PublishDiagnosticsParams(ResourceUtils.toClientUri(uri), diagnostics);
-		this.connection.publishDiagnostics($);
+		if (!filterURIFromDiagnostics(uri, JavaLanguageServerPlugin.getPreferencesManager().getPreferences().getDiagnosticFilter())) {
+			JavaLanguageServerPlugin.logInfo(problems.size() + " problems reported for " + this.uri.substring(this.uri.lastIndexOf('/')));
+			boolean isDiagnosticTagSupported = JavaLanguageServerPlugin.getPreferencesManager().getClientPreferences().isDiagnosticTagSupported();
+			List<Diagnostic> diagnostics = toDiagnosticsArray(this.cu, problems, isDiagnosticTagSupported);
+			collectNonJavaProblems(diagnostics, isDiagnosticTagSupported);
+			PublishDiagnosticsParams $ = new PublishDiagnosticsParams(ResourceUtils.toClientUri(uri), diagnostics);
+			this.connection.publishDiagnostics($);
+		}
+	}
+
+	public static boolean filterURIFromDiagnostics(String uri, List<String> diagnosticFilter) {
+		return JDTUtils.isExcludedFile(diagnosticFilter, uri);
 	}
 
 	/**

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

@@ -196,7 +196,9 @@ else if (projectsManager.isBuildFile(file)) {
 		}
 		if (document != null) {
 			String uri = JDTUtils.getFileURI(resource);
-			this.connection.publishDiagnostics(new PublishDiagnosticsParams(ResourceUtils.toClientUri(uri), toDiagnosticsArray(document, markers, isDiagnosticTagSupported)));
+			if (!BaseDiagnosticsHandler.filterURIFromDiagnostics(uri, JavaLanguageServerPlugin.getPreferencesManager().getPreferences().getDiagnosticFilter())) {
+				this.connection.publishDiagnostics(new PublishDiagnosticsParams(ResourceUtils.toClientUri(uri), toDiagnosticsArray(document, markers, isDiagnosticTagSupported)));
+			}
 		}
 		return false;
 	}
@@ -207,6 +209,9 @@ private void publishMarkers(IProject project, IMarker[] markers) throws CoreExce
 		List<IMarker> projectMarkers = new ArrayList<>(markers.length);
 
 		String uri = JDTUtils.getFileURI(project);
+		if (BaseDiagnosticsHandler.filterURIFromDiagnostics(uri, JavaLanguageServerPlugin.getPreferencesManager().getPreferences().getDiagnosticFilter())) {
+			return;
+		}
 		IFile pom = project.getFile("pom.xml");
 		IFile gradleWrapperProperties = project.getFile(GradleProjectImporter.GRADLE_WRAPPER_PROPERTIES_DESCRIPTOR);
 		List<IMarker> pomMarkers = new ArrayList<>();
@@ -316,6 +321,9 @@ private void publishDiagnostics(List<IMarker> markers) {
 			}
 			IDocument document = null;
 			String uri = JDTUtils.getFileURI(file);
+			if (BaseDiagnosticsHandler.filterURIFromDiagnostics(uri, JavaLanguageServerPlugin.getPreferencesManager().getPreferences().getDiagnosticFilter())) {
+				continue;
+			}
 			if (JavaCore.isJavaLikeFileName(file.getName())) {
 				ICompilationUnit cu = JDTUtils.resolveCompilationUnit(uri);
 				//ignoring working copies, they're handled in the DocumentLifecycleHandler

org.eclipse.jdt.ls.core/src/org/eclipse/jdt/ls/core/internal/preferences/Preferences.java

@@ -487,6 +487,7 @@ public class Preferences {
 	public static final String JAVA_TELEMETRY_ENABLED_KEY = "java.telemetry.enabled";
 
 	public static final String JAVA_EDIT_VALIDATE_ALL_OPEN_BUFFERS_ON_CHANGES = "java.edit.validateAllOpenBuffersOnChanges";
+	public static final String JAVA_DIAGNOSTIC_FILER = "java.diagnostic.filter";
 	/**
 	 * The preferences for generating toString method.
 	 */
@@ -696,6 +697,7 @@ public class Preferences {
 	private boolean telemetryEnabled;
 	private boolean validateAllOpenBuffersOnChanges;
 	private boolean chainCompletionEnabled;
+	private List<String> diagnosticFilter;
 
 	static {
 		JAVA_IMPORT_EXCLUSIONS_DEFAULT = new LinkedList<>();
@@ -932,6 +934,7 @@ public Preferences() {
 		extractInterfaceReplaceEnabled = false;
 		telemetryEnabled = false;
 		validateAllOpenBuffersOnChanges = true;
+		diagnosticFilter = new ArrayList<>();
 	}
 
 	private static void initializeNullAnalysisClasspathStorage() {
@@ -1325,6 +1328,8 @@ public static Preferences createFrom(Map<String, Object> configuration) {
 		prefs.setValidateAllOpenBuffersOnChanges(validateAllOpenBuffers);
 		boolean chainCompletionEnabled = getBoolean(configuration, CHAIN_COMPLETION_KEY, false);
 		prefs.setChainCompletionEnabled(chainCompletionEnabled);
+		List<String> diagnosticFilter = getList(configuration, JAVA_DIAGNOSTIC_FILER, Collections.emptyList());
+		prefs.setDiagnosticFilter(diagnosticFilter);
 		return prefs;
 	}
 
@@ -2569,4 +2574,12 @@ public boolean isValidateAllOpenBuffersOnChanges() {
 	public void setValidateAllOpenBuffersOnChanges(boolean validateAllOpenBuffersOnChanges) {
 		this.validateAllOpenBuffersOnChanges = validateAllOpenBuffersOnChanges;
 	}
+
+	public List<String> getDiagnosticFilter() {
+		return this.diagnosticFilter;
+	}
+
+	public void setDiagnosticFilter(List<String> diagnosticFilter) {
+		this.diagnosticFilter = diagnosticFilter;
+	}
 }

org.eclipse.jdt.ls.tests/src/org/eclipse/jdt/ls/core/internal/handlers/WorkspaceDiagnosticsHandlerTest.java

@@ -651,6 +651,17 @@ public void testEncoding() throws Exception {
 		}
 	}
 
+	@Test
+	public void testDiagnosticFiltering() throws Exception {
+		//		preferences.setDiagnosticFilter(List.of("**/Foo*.java"));
+		importProjects("eclipse/hello");
+		ArgumentCaptor<PublishDiagnosticsParams> captor = ArgumentCaptor.forClass(PublishDiagnosticsParams.class);
+		verify(connection, atLeastOnce()).publishDiagnostics(captor.capture());
+		for (PublishDiagnosticsParams param : captor.getAllValues()) {
+			assertTrue("Files containing 'Foo' have not been correctly filtered.", !param.getUri().matches("Foo"));
+		}
+	}
+
 	private IMarker createMarker(int severity, String msg, int line, int start, int end) {
 		IMarker m = mock(IMarker.class);
 		when(m.exists()).thenReturn(true);