Graceful handling of YTT in YAML (#1706)

* Gracefully handle YTT in Yaml

Signed-off-by: BoykoAlex <[email protected]>

* WIP: fixing unit tests

Signed-off-by: BoykoAlex <[email protected]>

* Fix unit tests

Signed-off-by: BoykoAlex <[email protected]>

* Adjust unit tests

Signed-off-by: BoykoAlex <[email protected]>

---------

Signed-off-by: BoykoAlex <[email protected]>

Author: BoykoAlex

headless-services/commons/commons-yaml/src/main/java/org/springframework/ide/vscode/commons/yaml/ast/YamlParser.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2016-2023 Pivotal, Inc.
+ * Copyright (c) 2016-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
@@ -37,6 +37,7 @@ public YamlFileAST getAST(IDocument doc) throws Exception {
 		CharSequenceReader reader = new CharSequenceReader();
 		reader.setInput(atTokenTransformHack(doc.get()));
 		LoaderOptions loaderOpts = new LoaderOptions();
+		loaderOpts.setProcessComments(true);
 		loaderOpts.setMaxAliasesForCollections(1000);
 		Iterable<Node> nodes = new Yaml(new SafeConstructor(loaderOpts), new Representer(new DumperOptions()), new DumperOptions(), loaderOpts).composeAll(reader);
 		return new YamlFileAST(doc, ImmutableList.copyOf(nodes));

headless-services/commons/commons-yaml/src/main/java/org/springframework/ide/vscode/commons/yaml/reconcile/SchemaBasedYamlASTReconciler.java

@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2016-2017 Pivotal, Inc.
+ * Copyright (c) 2016-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
@@ -100,21 +100,23 @@ public void reconcile(YamlFileAST ast) {
 		slowDelayedConstraints.clear();
 		try {
 			List<Node> nodes = ast.getNodes();
+			boolean emptyDoc = isEmptyDoc(ast);
 			IntegerRange expectedDocs = schema.expectedNumberOfDocuments();
-			if (!expectedDocs.isInRange(nodes.size())) {
+			int numberOfDocs = emptyDoc ? 0 : nodes.size();
+			if (!expectedDocs.isInRange(numberOfDocs)) {
 				//wrong number of documents in the file. Figure out a good error message.
-				if (nodes.isEmpty()) {
+				if (emptyDoc) {
 					problem(allOf(ast.getDocument()), "'"+schema.getName()+"' must have at least some Yaml content");
-				} else if (expectedDocs.isTooLarge(nodes.size())) {
+				} else if (expectedDocs.isTooLarge(numberOfDocs)) {
 					int upperBound = expectedDocs.getUpperBound();
 					Node extraNode = nodes.get(upperBound);
 					problem(dashesAtStartOf(ast, extraNode), "'"+schema.getName()+"' should not have more than "+upperBound+" Yaml Documents");
-				} else if (expectedDocs.isTooSmall(nodes.size())) {
+				} else if (expectedDocs.isTooSmall(numberOfDocs)) {
 					int lowerBound = expectedDocs.getLowerBound();
 					problem(endOf(ast.getDocument()), "'"+schema.getName()+"' should have at least "+lowerBound+" Yaml Documents");
 				}
 			}
-			if (nodes!=null && !nodes.isEmpty()) {
+			if (!emptyDoc && nodes!=null && !nodes.isEmpty()) {
 				for (int i = 0; i < nodes.size(); i++) {
 					Node node = nodes.get(i);
 					reconcile(ast, new YamlPath(YamlPathSegment.valueAt(i)), /*parent*/null, node, schema.getTopLevelType());
@@ -127,6 +129,21 @@ public void reconcile(YamlFileAST ast) {
 			verifyDelayedConstraints();
 		}
 	}
+	
+	private static boolean isEmptyDoc(YamlFileAST ast) {
+		List<Node> nodes = ast.getNodes();
+		if (nodes != null && !nodes.isEmpty()) {
+			if (nodes.size() == 1) {
+				Node n = nodes.get(0);
+				if (n instanceof MappingNode) {
+					MappingNode mn = (MappingNode) n;
+					return mn.getValue().isEmpty();
+				}
+			}
+			return false;
+		}
+		return true;
+	}
 
 	private DocumentRegion dashesAtStartOf(YamlFileAST ast, Node node) {
 		try {
@@ -240,12 +257,31 @@ private void parse(YamlFileAST ast, Node node, YType type, ValueParser parser) {
 				parser.parse(value);
 			}
 		} catch (Exception e) {
-			ProblemType problemType = getProblemType(e);
-			DocumentRegion region = getRegion(e, ast.getDocument(), node);
-			String msg = getMessage(e);
-			valueParseError(type, region, msg, problemType, getValueReplacement(e));
+			// check for YTT
+			if (!isYttUsed(node)) {
+				ProblemType problemType = getProblemType(e);
+				DocumentRegion region = getRegion(e, ast.getDocument(), node);
+				String msg = getMessage(e);
+				valueParseError(type, region, msg, problemType, getValueReplacement(e));
+			}
 		}
 	}
+	
+	private static boolean isYttUsed(Node node) {
+		if (node.getBlockComments() != null 
+				&& node.getBlockComments().stream().anyMatch(cl -> isYttComment(cl.getValue()))) {
+			return true;
+		}
+		if (node.getInLineComments() != null
+				&& node.getInLineComments().stream().anyMatch(cl -> isYttComment(cl.getValue()))) {
+			return true;
+		}
+		return false;
+	}
+	
+	private static boolean isYttComment(String s) {
+		return s.startsWith("@ ");
+	}
 
 	protected ReplacementQuickfix getValueReplacement(Exception _e) {
 		if (_e instanceof ReconcileException) {

headless-services/commons/commons-yaml/src/main/java/org/springframework/ide/vscode/commons/yaml/reconcile/TypeBasedYamlHierarchicalSymbolHandler.java

@@ -76,7 +76,8 @@ public DocumentSymbol createSymbol(YamlFileAST currentAst, Node node, YType type
 				IDocument doc = currentAst.getDocument();
 				if (namePath!=null) {
 					Node nameNode = namePath.traverseNode(node);
-					if (nameNode!=null) {
+					// VSCode throws for DocumentSymbols having null or empty name hence do not create the symbol
+					if (nameNode!=null && !NodeUtil.asScalar(nameNode).isEmpty()) {
 						DocumentRegion nodeRegion = NodeUtil.region(doc, node);
 						DocumentRegion nameRegion = NodeUtil.region(doc, nameNode);
 						if (!nodeRegion.contains(nameRegion)) {

headless-services/concourse-language-server/src/test/java/org/springframework/ide/vscode/concourse/ConcourseEditorTest.java

@@ -371,7 +371,7 @@ void reconcileResourceTypeType() throws Exception {
                         "  type: # <- bad\n"
         );
         editor.assertProblems(
-                "^ # <- bad|cannot be blank"
+                "# <- bad\n^^|cannot be blank"
         );
 
         editor = harness.newEditor(
@@ -384,6 +384,17 @@ void reconcileResourceTypeType() throws Exception {
         );
     }
 
+    @Test
+    void reconcileYttResourceType() throws Exception {
+        Editor editor;
+        editor = harness.newEditor(
+                "resource_types:\n" +
+                        "- name: s3-multi\n" +
+                        "  type: #@ resource.type\n"
+        );
+        editor.assertProblems();
+    }
+
     @Test
     void reconcileDisplayType() throws Exception {
         Editor editor;
@@ -393,7 +404,7 @@ void reconcileDisplayType() throws Exception {
         );
 
         editor.assertProblems(
-                "^ # <- bad|String should not be empty"
+                "# <- bad\n^^|String should not be empty"
         );
     }