GH-1499: add additional indexing logic to allow additional reconciling of specific files once the index is complete

Author: martinlippert

headless-services/spring-boot-language-server/src/main/java/org/springframework/ide/vscode/boot/java/reconcilers/BeanRegistrarDeclarationReconciler.java

@@ -78,6 +78,10 @@ public boolean visit(TypeDeclaration node) {
 				if (ASTUtils.findInTypeHierarchy(type, Set.of(Annotations.BEAN_REGISTRAR_INTERFACE)) == null) {
 					return true;
 				}
+				
+				if (!isIndexComplete) {
+					throw new RequiredCompleteIndexException();
+				}
 
 				List<Bean> configBeans = new ArrayList<>();
 				Path p = Path.of(docURI);

headless-services/spring-boot-language-server/src/main/java/org/springframework/ide/vscode/boot/java/reconcilers/RequiredCompleteAstException.java

@@ -10,8 +10,10 @@
  *******************************************************************************/
 package org.springframework.ide.vscode.boot.java.reconcilers;
 
+/**
+ * Indicates that a reconciler or indexer requires the full AST (including method bodies)
+ * to do its work accordingly.
+ */
 public class RequiredCompleteAstException extends RuntimeException {
-
-	private static final long serialVersionUID = 1L;
-
+	private static final long serialVersionUID = -3422411902406544588L;
 }

headless-services/spring-boot-language-server/src/main/java/org/springframework/ide/vscode/boot/java/reconcilers/RequiredCompleteIndexException.java

@@ -0,0 +1,28 @@
+/*******************************************************************************
+ * Copyright (c) 2025 Broadcom
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *     Broadcom - initial API and implementation
+ *******************************************************************************/
+package org.springframework.ide.vscode.boot.java.reconcilers;
+
+/**
+ * Indicates that a reconciler relies on the index to be complete before it can
+ * reconcile a file. As a result, the corresponding file will be re-parsed and re-reconciled
+ * once the index is complete.
+ * 
+ * A reconciler should throw this exception only in case it really requires
+ * access to the index and check other AST-related information first to avoid
+ * re-reconciling too many files when it is not really necessary.
+ * 
+ * For example the reconciler that checks BeanRegistrar implementations against
+ * Import annotations in the index should only throw this exception if the class
+ * is indeed an implementation of BeanRegistrar.
+ */
+public class RequiredCompleteIndexException extends RuntimeException {
+	private static final long serialVersionUID = -6155363860106363727L;
+}

headless-services/spring-boot-language-server/src/main/java/org/springframework/ide/vscode/boot/java/utils/SpringIndexerJava.java

@@ -35,15 +35,15 @@ public class SpringIndexerJavaContext {
 	private final long lastModified;
 	private final AtomicReference<TextDocument> docRef;
 	private final String content;
-	private final List<CachedSymbol> generatedSymbols;
-	private final List<CachedBean> beans;
 	private final IProblemCollector getProblemCollector;
 	private final List<String> nextPassFiles;
 	private final boolean fullAst;
+	private final boolean isIndexComplete;
+	private final SpringIndexerJavaScanResult scanResult;
 
 	private final Set<String> dependencies = new HashSet<>();
 	private final Set<String> scannedTypes = new HashSet<>();
-	
+
 	public SpringIndexerJavaContext(
 			IJavaProject project, 
 			CompilationUnit cu, 
@@ -52,11 +52,11 @@ public SpringIndexerJavaContext(
 			long lastModified,
 			AtomicReference<TextDocument> docRef, 
 			String content, 
-			List<CachedSymbol> generatedSymbols,
-			List<CachedBean> beans,
 			IProblemCollector problemCollector,
 			List<String> nextPassFiles,
-			boolean fullAst
+			boolean fullAst,
+			boolean isIndexComplete,
+			SpringIndexerJavaScanResult scanResult
 	) {
 		super();
 		this.project = project;
@@ -66,11 +66,11 @@ public SpringIndexerJavaContext(
 		this.lastModified = lastModified;
 		this.docRef = docRef;
 		this.content = content;
-		this.generatedSymbols = generatedSymbols;
 		this.getProblemCollector = problemCollector;
-		this.beans = beans;
 		this.nextPassFiles = nextPassFiles;
 		this.fullAst = fullAst;
+		this.isIndexComplete = isIndexComplete;
+		this.scanResult = scanResult;
 	}
 
 	public IJavaProject getProject() {
@@ -100,13 +100,17 @@ public AtomicReference<TextDocument> getDocRef() {
 	public String getContent() {
 		return content;
 	}
+	
+	public SpringIndexerJavaScanResult getResult() {
+		return scanResult;
+	}
 
 	public List<CachedSymbol> getGeneratedSymbols() {
-		return generatedSymbols;
+		return getResult().getGeneratedSymbols();
 	}
 
 	public List<CachedBean> getBeans() {
-		return beans;
+		return getResult().getGeneratedBeans();
 	}
 
 	public List<String> getNextPassFiles() {
@@ -147,15 +151,19 @@ public boolean isFullAst() {
 		return fullAst;
 	}
 
+	public boolean isIndexComplete() {
+		return isIndexComplete;
+	}
+	
 	public void resetDocumentRelatedElements(String docURI) {
-		Iterator<CachedBean> beansIterator = beans.iterator();
+		Iterator<CachedBean> beansIterator = getBeans().iterator();
 		while (beansIterator.hasNext()) {
 			if (beansIterator.next().getDocURI().equals(docURI)) {
 				beansIterator.remove();
 			}
 		}
 
-		Iterator<CachedSymbol> symbolsIterator = generatedSymbols.iterator();
+		Iterator<CachedSymbol> symbolsIterator = getGeneratedSymbols().iterator();
 		while (symbolsIterator.hasNext()) {
 			if (symbolsIterator.next().getDocURI().equals(docURI)) {
 				symbolsIterator.remove();

headless-services/spring-boot-language-server/src/main/java/org/springframework/ide/vscode/boot/java/utils/SpringIndexerJavaContext.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2019, 2020 Pivotal, Inc.
+ * Copyright (c) 2019, 2025 Pivotal, Inc.
  * All rights reserved. This program and the accompanying materials
  * are made available under the terms of the Eclipse Public License v1.0
  * which accompanies this distribution, and is available at
@@ -13,7 +13,6 @@
 import java.util.Collection;
 import java.util.Set;
 
-import org.eclipse.jdt.core.dom.ITypeBinding;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -26,10 +25,6 @@ public class SpringIndexerJavaDependencyTracker {
 
 	private Multimap<String, String> dependencies = MultimapBuilder.hashKeys().hashSetValues().build();
 
-	public void addDependency(String sourceFile, ITypeBinding dependsOn) {
-		dependencies.put(sourceFile, dependsOn.getKey());
-	}
-	
 	public void dump() {
 		log.info("=== Dependencies ===");
 		for (String sourceFile : dependencies.keySet()) {

headless-services/spring-boot-language-server/src/main/java/org/springframework/ide/vscode/boot/java/utils/SpringIndexerJavaDependencyTracker.java

@@ -0,0 +1,112 @@
+/*******************************************************************************
+ * Copyright (c) 2025 Broadcom
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *     Broadcom - initial API and implementation
+ *******************************************************************************/
+package org.springframework.ide.vscode.boot.java.utils;
+
+import java.io.File;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+import java.util.stream.Collectors;
+
+import org.eclipse.lsp4j.Diagnostic;
+import org.eclipse.lsp4j.WorkspaceSymbol;
+import org.springframework.ide.vscode.boot.java.beans.CachedBean;
+import org.springframework.ide.vscode.boot.java.reconcilers.CachedDiagnostics;
+import org.springframework.ide.vscode.commons.java.IJavaProject;
+import org.springframework.ide.vscode.commons.protocol.spring.SpringIndexElement;
+import org.springframework.ide.vscode.commons.util.UriUtil;
+
+/**
+ * Class to capture the major results of scanning one or more files
+ * for Spring symbol creation, indexing, and reconciling
+ * 
+ * @author Martin Lippert
+ */
+public class SpringIndexerJavaScanResult {
+	
+	private final Map<String, Long> markedForReconciling;
+	
+	private final List<CachedSymbol> generatedSymbols;
+	private final List<CachedBean> generatedBeans;
+	private final List<CachedDiagnostics> generatedDiagnostics;
+
+	private final IJavaProject project;
+	private final String[] javaFiles;
+	
+	public SpringIndexerJavaScanResult(IJavaProject project, String[] javaFiles) {
+		this.project = project;
+		this.javaFiles = javaFiles;
+
+		this.markedForReconciling = new HashMap<>();
+		this.generatedSymbols = new ArrayList<CachedSymbol>();
+		this.generatedBeans = new ArrayList<CachedBean>();
+		this.generatedDiagnostics = new ArrayList<CachedDiagnostics>();
+	}
+	
+	public SpringIndexerJavaScanResult(IJavaProject project, String[] javaFiles, SymbolHandler symbolHandler,
+			CachedSymbol[] symbols, CachedBean[] beans, CachedDiagnostics[] diagnostics) {
+		
+		this.project = project;
+		this.javaFiles = javaFiles;
+		
+		this.markedForReconciling = new HashMap<>();
+		this.generatedSymbols = Arrays.asList(symbols);
+		this.generatedBeans = Arrays.asList(beans);
+		this.generatedDiagnostics = Arrays.asList(diagnostics);
+	}
+
+	public Map<String, Long> getMarkedForReconcilingWithCompleteIndex() {
+		return markedForReconciling;
+	}
+	
+	public void markForReconcilingWithCompleteIndex(String file, long lastModified) {
+		this.markedForReconciling.put(file, lastModified);
+	}
+	
+	public List<CachedBean> getGeneratedBeans() {
+		return generatedBeans;
+	}
+	
+	public List<CachedSymbol> getGeneratedSymbols() {
+		return generatedSymbols;
+	}
+	
+	public List<CachedDiagnostics> getGeneratedDiagnostics() {
+		return generatedDiagnostics;
+	}
+	
+	public void publishResults(SymbolHandler symbolHandler) {
+		WorkspaceSymbol[] enhancedSymbols = generatedSymbols.stream().map(cachedSymbol -> cachedSymbol.getEnhancedSymbol()).toArray(WorkspaceSymbol[]::new);
+		Map<String, List<SpringIndexElement>> allBeans = generatedBeans.stream().filter(cachedBean -> cachedBean.getBean() != null).collect(Collectors.groupingBy(CachedBean::getDocURI, Collectors.mapping(CachedBean::getBean, Collectors.toList())));
+		Map<String, List<Diagnostic>> diagnosticsByDoc = generatedDiagnostics.stream().filter(cachedDiagnostic -> cachedDiagnostic.getDiagnostic() != null).collect(Collectors.groupingBy(CachedDiagnostics::getDocURI, Collectors.mapping(CachedDiagnostics::getDiagnostic, Collectors.toList())));
+
+		addEmptyDiagnostics(diagnosticsByDoc, javaFiles); // to make sure that files without diagnostics publish an empty array of diagnostics
+
+		symbolHandler.addSymbols(this.project, enhancedSymbols, allBeans, diagnosticsByDoc);
+	}
+	
+	private void addEmptyDiagnostics(Map<String, List<Diagnostic>> diagnosticsByDoc, String[] javaFiles) {
+		for (int i = 0; i < javaFiles.length; i++) {
+			File file = new File(javaFiles[i]);
+			String docURI = UriUtil.toUri(file).toASCIIString();
+
+			if (!diagnosticsByDoc.containsKey(docURI)) {
+				diagnosticsByDoc.put(docURI, Collections.emptyList());
+			}
+		}
+	}
+	
+}