qute(NoMatchingTemplate) if using @CheckedTemplate with basePath

Fixes redhat-developer/vscode-quarkus#787 Signed-off-by: azerr <[email protected]>
redhat-developer · Jul 12, 2024 · 16f2691 · 16f2691
1 parent 52de798
commit 16f2691
Show file tree

Hide file tree

Showing 18 changed files with 356 additions and 56 deletions.
diff --git a/...edhat/microprofile/jdt/internal/quarkus/core/properties/QuarkusConfigMappingProvider.java b/...edhat/microprofile/jdt/internal/quarkus/core/properties/QuarkusConfigMappingProvider.java
@@ -23,7 +23,7 @@
 import static io.quarkus.runtime.util.StringUtil.hyphenate;
 import static io.quarkus.runtime.util.StringUtil.join;
 import static io.quarkus.runtime.util.StringUtil.lowerCase;
-import static org.eclipse.lsp4mp.jdt.core.utils.AnnotationUtils.getAnnotation;
+import static org.eclipse.lsp4mp.jdt.core.utils.AnnotationUtils.getFirstAnnotation;
 import static org.eclipse.lsp4mp.jdt.core.utils.AnnotationUtils.getAnnotationMemberValue;
 import static org.eclipse.lsp4mp.jdt.core.utils.AnnotationUtils.hasAnnotation;
 import static org.eclipse.lsp4mp.jdt.core.utils.JDTTypeUtils.findType;
@@ -254,7 +254,7 @@ private static String convertName(IMember member, IAnnotation configMappingAnnot
 		// @WithName("name")
 		// String host();
 		// --> See https://quarkus.io/guides/config-mappings#withname
-		IAnnotation withNameAnnotation = getAnnotation((IAnnotatable) member, WITH_NAME_ANNOTATION);
+		IAnnotation withNameAnnotation = getFirstAnnotation((IAnnotatable) member, WITH_NAME_ANNOTATION);
 		if (withNameAnnotation != null) {
 			String name = getAnnotationMemberValue(withNameAnnotation, WITH_NAME_ANNOTATION_VALUE);
 			if (StringUtils.isNotEmpty(name)) {
@@ -304,7 +304,7 @@ private static String convertName(IMember member, IAnnotation configMappingAnnot
 	 */
 	private static String getWithDefault(IMember member) {
 		try {
-			IAnnotation withDefaultAnnotation = getAnnotation((IAnnotatable) member, WITH_DEFAULT_ANNOTATION);
+			IAnnotation withDefaultAnnotation = getFirstAnnotation((IAnnotatable) member, WITH_DEFAULT_ANNOTATION);
 			if (withDefaultAnnotation != null) {
 				String defaultValue = getAnnotationMemberValue(withDefaultAnnotation, WITH_DEFAULT_ANNOTATION_VALUE);
 				if (StringUtils.isNotEmpty(defaultValue)) {

diff --git a/...at/microprofile/jdt/internal/quarkus/core/properties/QuarkusConfigPropertiesProvider.java b/...at/microprofile/jdt/internal/quarkus/core/properties/QuarkusConfigPropertiesProvider.java
@@ -14,7 +14,7 @@
 import static io.quarkus.runtime.util.StringUtil.join;
 import static io.quarkus.runtime.util.StringUtil.lowerCase;
 import static io.quarkus.runtime.util.StringUtil.withoutSuffix;
-import static org.eclipse.lsp4mp.jdt.core.utils.AnnotationUtils.getAnnotation;
+import static org.eclipse.lsp4mp.jdt.core.utils.AnnotationUtils.getFirstAnnotation;
 import static org.eclipse.lsp4mp.jdt.core.utils.AnnotationUtils.getAnnotationMemberValue;
 import static org.eclipse.lsp4mp.jdt.core.utils.JDTTypeUtils.findType;
 import static org.eclipse.lsp4mp.jdt.core.utils.JDTTypeUtils.getEnclosedType;
@@ -189,7 +189,7 @@ private void processConfigProperties(IJavaElement javaElement, IAnnotation confi
 						}
 						String name = null;
 						String defaultValue = null;
-						IAnnotation configPropertyAnnotation = getAnnotation(method,
+						IAnnotation configPropertyAnnotation = getFirstAnnotation(method,
 							MicroProfileConfigConstants.CONFIG_PROPERTY_ANNOTATION);
 						if (configPropertyAnnotation != null) {
 							name = getAnnotationMemberValue(configPropertyAnnotation,

diff --git a/...m/redhat/microprofile/jdt/internal/quarkus/core/properties/QuarkusConfigRootProvider.java b/...m/redhat/microprofile/jdt/internal/quarkus/core/properties/QuarkusConfigRootProvider.java
@@ -15,7 +15,7 @@
 import static io.quarkus.runtime.util.StringUtil.lowerCaseFirst;
 import static io.quarkus.runtime.util.StringUtil.toList;
 import static io.quarkus.runtime.util.StringUtil.withoutSuffix;
-import static org.eclipse.lsp4mp.jdt.core.utils.AnnotationUtils.getAnnotation;
+import static org.eclipse.lsp4mp.jdt.core.utils.AnnotationUtils.getFirstAnnotation;
 import static org.eclipse.lsp4mp.jdt.core.utils.AnnotationUtils.getAnnotationMemberValue;
 import static org.eclipse.lsp4mp.jdt.core.utils.JDTTypeUtils.findType;
 import static org.eclipse.lsp4mp.jdt.core.utils.JDTTypeUtils.getEnclosedType;
@@ -413,7 +413,7 @@ private void processConfigGroup(String extensionName, IJavaElement javaElement,
 						continue;
 					}
 
-					final IAnnotation configItemAnnotation = getAnnotation((IAnnotatable) field,
+					final IAnnotation configItemAnnotation = getFirstAnnotation((IAnnotatable) field,
 							QuarkusConstants.CONFIG_ITEM_ANNOTATION);
 					String name = configItemAnnotation == null ? hyphenate(field.getElementName())
 							: getAnnotationMemberValue(configItemAnnotation,
@@ -437,7 +437,7 @@ private void processConfigGroup(String extensionName, IJavaElement javaElement,
 
 					String fieldTypeName = getResolvedTypeName(field);
 					IType fieldClass = findType(field.getJavaProject(), fieldTypeName);
-					final IAnnotation configGroupAnnotation = getAnnotation((IAnnotatable) fieldClass,
+					final IAnnotation configGroupAnnotation = getFirstAnnotation((IAnnotatable) fieldClass,
 							QuarkusConstants.CONFIG_GROUP_ANNOTATION);
 					if (configGroupAnnotation != null) {
 						processConfigGroup(extensionName, fieldClass, subKey, configPhase, javadocCache, quarkusContext,

diff --git a/...cts/maven/qute-quickstart/src/main/java/org/acme/qute/ItemResourceWithCustomBasePath.java b/...cts/maven/qute-quickstart/src/main/java/org/acme/qute/ItemResourceWithCustomBasePath.java
@@ -0,0 +1,39 @@
+package org.acme.qute;
+
+import java.math.BigDecimal;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
+
+import javax.ws.rs.GET;
+import javax.ws.rs.Path;
+import javax.ws.rs.Produces;
+import javax.ws.rs.core.MediaType;
+
+import io.quarkus.qute.CheckedTemplate;
+import io.quarkus.qute.TemplateExtension;
+import io.quarkus.qute.TemplateInstance;
+
+@Path("items3")
+public class ItemResourceWithCustomBasePath {
+
+	@CheckedTemplate(basePath="ItemResourceWithFragment")
+	static class Templates {
+		static native TemplateInstance items(List<Item> items);
+		static native TemplateInstance items$id1(List<Item> items);		
+		static native TemplateInstance items3$id2(List<Item> items);
+		static native TemplateInstance items3$(List<Item> items);
+	}
+
+	@GET
+	@Produces(MediaType.TEXT_HTML)
+	public TemplateInstance get() {
+		List<Item> items = new ArrayList<>();
+		items.add(new Item(new BigDecimal(10), "Apple"));
+		items.add(new Item(new BigDecimal(16), "Pear"));
+		items.add(new Item(new BigDecimal(30), "Orange"));
+		return Templates.items(items);
+	}
+
+
+}
diff --git a/...ojects/maven/qute-quickstart/src/main/java/org/acme/qute/ItemTemplatesCustomBasePath.java b/...ojects/maven/qute-quickstart/src/main/java/org/acme/qute/ItemTemplatesCustomBasePath.java
@@ -0,0 +1,15 @@
+package org.acme.qute;
+
+import java.util.List;
+import io.quarkus.qute.CheckedTemplate;
+import io.quarkus.qute.TemplateInstance;
+
+@CheckedTemplate(basePath="ItemResourceWithFragment")
+public class ItemTemplatesCustomBasePath {
+
+	static native TemplateInstance items(List<Item> items);
+	static native TemplateInstance items$id1(List<Item> items);
+	static native TemplateInstance items3$id2(List<Item> items);
+	static native TemplateInstance items3$(List<Item> items);
+
+}
diff --git a/...jdt/com.redhat.qute.jdt.test/src/main/java/com/redhat/qute/jdt/java/JavaCodeLensTest.java b/...jdt/com.redhat.qute.jdt.test/src/main/java/com/redhat/qute/jdt/java/JavaCodeLensTest.java
@@ -198,6 +198,92 @@ public void checkedTemplateInInnerClass() throws CoreException, Exception {
 						"qute.command.generate.template.file", Arrays.asList(items2Uri)));
 	}
 
+	@Test
+	public void checkedTemplateWithCustomBasePath() throws Exception {
+
+		// @CheckedTemplate(basePath="ItemResourceWithFragment")
+		// public class ItemTemplatesCustomBasePath {
+		//
+		// static native TemplateInstance items(List<Item> items);
+		// static native TemplateInstance items$id1(List<Item> items);
+		// static native TemplateInstance items3$id2(List<Item> items);
+		// static native TemplateInstance items3$(List<Item> items);
+		// }
+
+		IJavaProject javaProject = loadMavenProject(QuteMavenProjectName.qute_quickstart);
+
+		QuteJavaCodeLensParams params = new QuteJavaCodeLensParams();
+		IFile javaFile = javaProject.getProject()
+				.getFile(new Path("src/main/java/org/acme/qute/ItemTemplatesCustomBasePath.java"));
+		params.setUri(javaFile.getLocation().toFile().toURI().toString());
+
+		List<? extends CodeLens> lenses = QuteSupportForJava.getInstance().codeLens(params, getJDTUtils(),
+				new NullProgressMonitor());
+		assertEquals(3, lenses.size());
+
+		String itemsUri = javaProject.getProject()
+				.getFile("src/main/resources/templates/ItemResourceWithFragment/items.html").getLocationURI()
+				.toString();
+		String items3Uri = javaProject.getProject()
+				.getFile("src/main/resources/templates/ItemResourceWithFragment/items3.html").getLocationURI()
+				.toString();
+
+		assertCodeLens(lenses, //
+				cl(r(9, 1, 9, 56), //
+						"Open `src/main/resources/templates/ItemResourceWithFragment/items.html`", //
+						"qute.command.open.uri", Arrays.asList(itemsUri)), //
+				cl(r(10, 1, 10, 60), //
+						"Open `id1` fragment of `src/main/resources/templates/ItemResourceWithFragment/items.html`", //
+						"qute.command.open.uri", Arrays.asList(itemsUri, "id1")), //
+				cl(r(11, 1, 11, 61), //
+						"Create `src/main/resources/templates/ItemResourceWithFragment/items3.html`", //
+						"qute.command.generate.template.file", Arrays.asList(items3Uri)));
+
+	}
+
+	@Test
+	public void checkedTemplateInInnerClassWithCustomBasePath() throws Exception {
+
+		// @CheckedTemplate(basePath="ItemResourceWithFragment")
+		// public class ItemTemplatesCustomBasePath {
+		//
+		// static native TemplateInstance items(List<Item> items);
+		// static native TemplateInstance items$id1(List<Item> items);
+		// static native TemplateInstance items3$id2(List<Item> items);
+		// static native TemplateInstance items3$(List<Item> items);
+		// }
+
+		IJavaProject javaProject = loadMavenProject(QuteMavenProjectName.qute_quickstart);
+
+		QuteJavaCodeLensParams params = new QuteJavaCodeLensParams();
+		IFile javaFile = javaProject.getProject()
+				.getFile(new Path("src/main/java/org/acme/qute/ItemTemplatesCustomBasePath.java"));
+		params.setUri(javaFile.getLocation().toFile().toURI().toString());
+
+		List<? extends CodeLens> lenses = QuteSupportForJava.getInstance().codeLens(params, getJDTUtils(),
+				new NullProgressMonitor());
+		assertEquals(3, lenses.size());
+
+		String itemsUri = javaProject.getProject()
+				.getFile("src/main/resources/templates/ItemResourceWithFragment/items.html").getLocationURI()
+				.toString();
+		String items3Uri = javaProject.getProject()
+				.getFile("src/main/resources/templates/ItemResourceWithFragment/items3.html").getLocationURI()
+				.toString();
+
+		assertCodeLens(lenses, //
+				cl(r(9, 1, 9, 56), //
+						"Open `src/main/resources/templates/ItemResourceWithFragment/items.html`", //
+						"qute.command.open.uri", Arrays.asList(itemsUri)), //
+				cl(r(10, 1, 10, 60), //
+						"Open `id1` fragment of `src/main/resources/templates/ItemResourceWithFragment/items.html`", //
+						"qute.command.open.uri", Arrays.asList(itemsUri, "id1")), //
+				cl(r(11, 1, 11, 61), //
+						"Create `src/main/resources/templates/ItemResourceWithFragment/items3.html`", //
+						"qute.command.generate.template.file", Arrays.asList(items3Uri)));
+
+	}
+
 	@Test
 	public void checkedTemplateWithFragment() throws CoreException, Exception {
 

diff --git a/.../com.redhat.qute.jdt.test/src/main/java/com/redhat/qute/jdt/java/JavaDiagnosticsTest.java b/.../com.redhat.qute.jdt.test/src/main/java/com/redhat/qute/jdt/java/JavaDiagnosticsTest.java
@@ -195,6 +195,41 @@ public void checkedTemplateInWithFragment() throws CoreException, Exception {
 						DiagnosticSeverity.Error, "qute", QuteErrorCode.NoMatchingTemplate.name()));
 	}
 
+	@Test
+	public void checkedTemplateWithCustomBasePath() throws Exception {
+
+		// @CheckedTemplate(basePath="ItemResourceWithFragment")
+		// public class ItemTemplatesCustomBasePath {
+		//
+		// static native TemplateInstance items(List<Item> items);
+		// static native TemplateInstance items$id1(List<Item> items);
+		// static native TemplateInstance items3$id2(List<Item> items);
+		// static native TemplateInstance items3$(List<Item> items);
+		// }
+
+		IJavaProject javaProject = loadMavenProject(QuteMavenProjectName.qute_quickstart);
+
+		QuteJavaDiagnosticsParams params = new QuteJavaDiagnosticsParams();
+		IFile javaFile = javaProject.getProject()
+				.getFile(new Path("src/main/java/org/acme/qute/ItemTemplatesCustomBasePath.java"));
+		params.setUris(Arrays.asList(javaFile.getLocation().toFile().toURI().toString()));
+
+		List<PublishDiagnosticsParams> publishDiagnostics = QuteSupportForJava.getInstance().diagnostics(params,
+				getJDTUtils(), new NullProgressMonitor());
+		assertEquals(1, publishDiagnostics.size());
+
+		List<Diagnostic> diagnostics = publishDiagnostics.get(0).getDiagnostics();
+		assertEquals(2, diagnostics.size());
+
+		assertDiagnostic(diagnostics, //
+				new Diagnostic(r(11, 32, 11, 42),
+						"No template matching the path ItemResourceWithFragment/items3 could be found for: org.acme.qute.ItemTemplatesCustomBasePath",
+						DiagnosticSeverity.Error, "qute", QuteErrorCode.NoMatchingTemplate.name()), //
+				new Diagnostic(r(12, 32, 12, 39),
+						"Fragment [] not defined in template ItemResourceWithFragment/items3$",
+						DiagnosticSeverity.Error, "qute", QuteErrorCode.FragmentNotDefined.name()));
+	}
+
 	public static Range r(int line, int startChar, int endChar) {
 		return r(line, startChar, line, endChar);
 	}

diff --git a/...com.redhat.qute.jdt.test/src/main/java/com/redhat/qute/jdt/java/JavaDocumentLinkTest.java b/...com.redhat.qute.jdt.test/src/main/java/com/redhat/qute/jdt/java/JavaDocumentLinkTest.java
@@ -200,6 +200,42 @@ public void checkedTemplateWithFragment() throws CoreException, Exception {
 						"Open `src/main/resources/templates/ItemResourceWithFragment/items2$id2.html`"));
 	}
 
+	@Test
+	public void checkedTemplateWithCustomBasePath() throws Exception {
+
+		// @CheckedTemplate(basePath="ItemResourceWithFragment")
+		// public class ItemTemplatesCustomBasePath {
+		//
+		// static native TemplateInstance items(List<Item> items);
+		// static native TemplateInstance items$id1(List<Item> items);
+		// static native TemplateInstance items3$id2(List<Item> items);
+		// static native TemplateInstance items3$(List<Item> items);
+		// }
+
+		IJavaProject javaProject = loadMavenProject(QuteMavenProjectName.qute_quickstart);
+
+		QuteJavaDocumentLinkParams params = new QuteJavaDocumentLinkParams();
+		IFile javaFile = javaProject.getProject()
+				.getFile(new Path("src/main/java/org/acme/qute/ItemTemplatesCustomBasePath.java"));
+		params.setUri(javaFile.getLocation().toFile().toURI().toString());
+
+		List<DocumentLink> links = QuteSupportForJava.getInstance().documentLink(params, getJDTUtils(),
+				new NullProgressMonitor());
+		assertEquals(3, links.size());
+
+		String templateFileUri = javaProject.getProject()
+				.getFile("src/main/resources/templates/ItemResourceWithFragment/items.html").getLocationURI()
+				.toString();
+
+		assertDocumentLink(links, //
+				dl(r(9, 32, 9, 37), //
+						templateFileUri, "Open `src/main/resources/templates/ItemResourceWithFragment/items.html`"), //
+				dl(r(10, 32, 10, 41), //
+						templateFileUri, "Open `src/main/resources/templates/ItemResourceWithFragment/items.html`"), //
+				dl(r(11, 32, 11, 42), //
+						templateFileUri, "Create `src/main/resources/templates/ItemResourceWithFragment/items3.html`"));
+	}
+
 	public static Range r(int line, int startChar, int endChar) {
 		return r(line, startChar, line, endChar);
 	}

diff --git a/...jdt/com.redhat.qute.jdt/src/main/java/com/redhat/qute/jdt/internal/QuteJavaConstants.java b/...jdt/com.redhat.qute.jdt/src/main/java/com/redhat/qute/jdt/internal/QuteJavaConstants.java
@@ -49,6 +49,7 @@ public class QuteJavaConstants {
 	public static final String OLD_CHECKED_TEMPLATE_ANNOTATION = "io.quarkus.qute.api.CheckedTemplate";
 
 	public static final String CHECKED_TEMPLATE_ANNOTATION_IGNORE_FRAGMENTS = "ignoreFragments";
+	public static final String CHECKED_TEMPLATE_ANNOTATION_BASE_PATH = "basePath";
 
 	// @TemplateExtension