Feature request: extend "microprofile(unknown)" to detect references

from property files

Fixes redhat-developer/vscode-microprofile#600

Signed-off-by: azerr <azerr@redhat.com>

Author: angelozerr

microprofile.ls/org.eclipse.lsp4mp.ls/src/main/java/org/eclipse/lsp4mp/services/properties/CompletionData.java

@@ -16,8 +16,6 @@
 import org.eclipse.lsp4j.CompletionItem;
 import org.eclipse.lsp4mp.commons.utils.JSONUtility;
 
-import com.google.gson.JsonObject;
-
 /**
  * Represents data sent to for completionItem/resolve
  *

microprofile.ls/org.eclipse.lsp4mp.ls/src/main/java/org/eclipse/lsp4mp/services/properties/PropertiesFileValidator.java

@@ -67,6 +67,7 @@ class PropertiesFileValidator {
 	private final MicroProfileValidationSettings validationSettings;
 	private final PropertiesFileExtensionRegistry extensionRegistry;
 	private final Map<String, List<Property>> existingProperties;
+	private final Map<String, Property> potentiallyUnknownProperties;
 	private Set<String> declaredProperties;
 	private Map<String, ItemMetadata> availableProperties;
 
@@ -82,6 +83,7 @@ public PropertiesFileValidator(MicroProfileProjectInfo projectInfo, List<Diagnos
 		this.validationSettings = validationSettings;
 		this.extensionRegistry = extensionRegistry;
 		this.existingProperties = new HashMap<String, List<Property>>();
+		this.potentiallyUnknownProperties = new HashMap<String, Property>();
 		// to be lazily init
 		this.declaredProperties = null;
 		this.availableProperties = null;
@@ -101,6 +103,7 @@ public void validate(PropertiesModel document, CancelChecker cancelChecker) {
 
 		addDiagnosticsForDuplicates();
 		addDiagnosticsForMissingRequired(document);
+		addDiagnosticsForUnknownProperties();
 	}
 
 	private void validateProperty(Property property, CancelChecker cancelChecker) {
@@ -196,8 +199,8 @@ private void validateUnknownProperty(String propertyName, Property property) {
 			// The unknown validation must be ignored for this property name
 			return;
 		}
-		addDiagnostic("Unrecognized property '" + propertyName + "', it is not referenced in any Java files",
-				property.getKey(), severity, ValidationType.unknown.name());
+		// Store the property for later validation after all expressions are processed
+		potentiallyUnknownProperties.put(propertyName, property);
 	}
 
 	// ---------------- Property value validation
@@ -308,24 +311,17 @@ private void validatePropertyValueExpressions(String propertyName, ItemMetadata
 		if (expressionSeverity == null || syntaxSeverity == null) {
 			return;
 		}
+
+		// Lazy initialization: collect declared properties, available properties, and referenced properties
+		// in a single pass when processing the first expression
+		if (declaredProperties == null) {
+			initializePropertiesCollections(property.getOwnerModel());
+		}
+
 		for (Node child : property.getValue().getChildren()) {
 			if (child != null && child.getNodeType() == NodeType.PROPERTY_VALUE_EXPRESSION) {
 				PropertyValueExpression propValExpr = (PropertyValueExpression) child;
 				if (expressionSeverity != null) {
-					if (declaredProperties == null) {
-						// Collect names of all properties defined in the configuration file and the
-						// project information
-						declaredProperties = property.getOwnerModel().getChildren().stream().filter(n -> {
-							return n.getNodeType() == NodeType.PROPERTY;
-						}).map(prop -> {
-							return ((Property) prop).getPropertyNameWithProfile();
-						}).collect(Collectors.toSet());
-
-						availableProperties = projectInfo.getProperties()//
-								.stream() //
-								.collect(Collectors.toMap(ItemMetadata::getName, Function.identity(), (i1, i2) -> i1));
-					}
-
 					String refdProp = propValExpr.getReferencedPropertyName();
 					if (!declaredProperties.contains(refdProp)) {
 						// The referenced property name doesn't reference a property inside the file
@@ -429,6 +425,52 @@ private void addDiagnosticsForRequiredIfNoValue(String propertyName, DiagnosticS
 		}
 	}
 
+	private void addDiagnosticsForUnknownProperties() {
+		// Properties that are referenced in expressions have already been removed from potentiallyUnknownProperties
+		potentiallyUnknownProperties.forEach((propertyName, property) -> {
+			DiagnosticSeverity severity = validationSettings.getUnknown().getDiagnosticSeverity(propertyName);
+			if (severity != null) {
+				addDiagnostic("Unrecognized property '" + propertyName + "', it is not referenced in any Java files",
+						property.getKey(), severity, ValidationType.unknown.name());
+			}
+		});
+	}
+
+	/**
+	 * Initialize properties collections in a single pass over the properties model.
+	 * Collects:
+	 * - declaredProperties: all property names defined in the file
+	 * - availableProperties: all properties from project metadata
+	 * Also removes referenced properties from potentiallyUnknownProperties
+	 */
+	private void initializePropertiesCollections(PropertiesModel model) {
+		declaredProperties = new java.util.HashSet<>();
+
+		// Single pass to collect declared properties and remove referenced ones from potentially unknown
+		for (Node node : model.getChildren()) {
+			if (node.getNodeType() == NodeType.PROPERTY) {
+				Property prop = (Property) node;
+				// Collect declared property
+				declaredProperties.add(prop.getPropertyNameWithProfile());
+
+				// Remove referenced properties from potentiallyUnknownProperties
+				if (prop.getValue() != null) {
+					for (Node child : prop.getValue().getChildren()) {
+						if (child.getNodeType() == NodeType.PROPERTY_VALUE_EXPRESSION) {
+							PropertyValueExpression expr = (PropertyValueExpression) child;
+							potentiallyUnknownProperties.remove(expr.getReferencedPropertyName());
+						}
+					}
+				}
+			}
+		}
+
+		// Collect available properties from project metadata
+		availableProperties = projectInfo.getProperties()
+				.stream()
+				.collect(Collectors.toMap(ItemMetadata::getName, Function.identity(), (i1, i2) -> i1));
+	}
+
 	Diagnostic addDiagnostic(String message, Node node, DiagnosticSeverity severity, String code) {
 		Range range = PositionUtils.createRange(node);
 		return addDiagnostic(message, range, severity, code);

microprofile.ls/org.eclipse.lsp4mp.ls/src/test/java/org/eclipse/lsp4mp/services/properties/PropertiesFileAssert.java

@@ -732,7 +732,29 @@ public static void assertDiagnostics(List<Diagnostic> actual, Diagnostic... expe
 	}
 
 	public static void assertDiagnostics(List<Diagnostic> actual, List<Diagnostic> expected) {
-		assertEquals("Unexpected diagnostics:\n", expected, actual);
+		// Sort both lists by position to make comparison order-independent
+		List<Diagnostic> sortedActual = new ArrayList<>(actual);
+		List<Diagnostic> sortedExpected = new ArrayList<>(expected);
+
+		java.util.Comparator<Diagnostic> diagnosticComparator = (d1, d2) -> {
+			int lineCompare = Integer.compare(d1.getRange().getStart().getLine(),
+					d2.getRange().getStart().getLine());
+			if (lineCompare != 0) {
+				return lineCompare;
+			}
+			int charCompare = Integer.compare(d1.getRange().getStart().getCharacter(),
+					d2.getRange().getStart().getCharacter());
+			if (charCompare != 0) {
+				return charCompare;
+			}
+			// If same position, compare by message to have stable ordering
+			return d1.getMessage().compareTo(d2.getMessage());
+		};
+
+		sortedActual.sort(diagnosticComparator);
+		sortedExpected.sort(diagnosticComparator);
+
+		assertEquals("Unexpected diagnostics:\n", sortedExpected, sortedActual);
 	}
 
 	public static Diagnostic d(int line, int startCharacter, int endCharacter, String message,

microprofile.ls/org.eclipse.lsp4mp.ls/src/test/java/org/eclipse/lsp4mp/services/properties/expressions/PropertiesFileExpressionDiagnosticsTest.java

@@ -70,8 +70,6 @@ public void validateUnclosedPropertyExpression() {
 		String value = "test.property = hello\n" + //
 				"other.property = ${test.property";
 		testDiagnosticsFor(value, //
-				d(0, 0, 13, "Unrecognized property 'test.property', it is not referenced in any Java files",
-						DiagnosticSeverity.Warning, ValidationType.unknown), //
 				d(1, 0, 14, "Unrecognized property 'other.property', it is not referenced in any Java files",
 						DiagnosticSeverity.Warning, ValidationType.unknown), //
 				d(1, 17, 32, "Missing '}'", DiagnosticSeverity.Error, ValidationType.syntax));
@@ -180,8 +178,6 @@ public void validatePropertyFilePropertyInPropertyExpression() {
 		String value = "test.property = hello\n" + //
 				"other.property = ${test.property}";
 		testDiagnosticsFor(value, //
-				d(0, 0, 13, "Unrecognized property 'test.property', it is not referenced in any Java files",
-						DiagnosticSeverity.Warning, ValidationType.unknown), //
 				d(1, 0, 14, "Unrecognized property 'other.property', it is not referenced in any Java files",
 						DiagnosticSeverity.Warning, ValidationType.unknown));
 	}
@@ -204,4 +200,12 @@ public void validateValueForLevelBasedOnRuleWithExpression() throws BadLocationE
 				d(0, 35, 38, "Bad level \"XXX\"", DiagnosticSeverity.Error, ValidationType.value));
 
 	}
+
+	@Test
+	public void validateReferencedPropertyExpressions() {
+		String value = "ENV_LEVEL=info\n" + //
+				"quarkus.log.file.level=${ENV_LEVEL}";
+		testDiagnosticsFor(value);
+	}
+
 }