Validation annotation in @CheckedTemplate

[luca-bassoricci]

Snippet of our code:

@CheckedTemplate(basePath = "")
@RequestScoped
@Slf4j
public class FTPReleaseUploadEventManagerBean
{
	static native TemplateInstance notifyAbandonedRelease(@NotNull Release release);
	static native TemplateInstance notifyCompletedRelease(@NotNull Release release);
   /* other code */
}

cause deployment failure during Qute processing

2022-10-05 17:20:31,388 ERROR [io.qua.dep.dev.IsolatedDevModeMain] (Quarkus Terminal Reader) Failed to start quarkus: java.lang.RuntimeException: io.quarkus.builder.BuildException: Build failure: Build failed due to errors
	[error]: Build step io.quarkus.qute.deployment.QuteProcessor#validateExpressions threw an exception: io.quarkus.qute.TemplateException: Class [@Valid com.zucchetti.mercurio.entity.Release] used in the parameter declaration in template [notifyAbandonedRelease.txt] on line 2 was not found in the application index. Make sure it is spelled correctly.
	at io.quarkus.qute.deployment.TypeInfos.getClassInfo(TypeInfos.java:116)
	at io.quarkus.qute.deployment.TypeInfos.create(TypeInfos.java:83)
	at io.quarkus.qute.deployment.TypeInfos.create(TypeInfos.java:42)
	at io.quarkus.qute.deployment.QuteProcessor.validateNestedExpressions(QuteProcessor.java:911)
	at io.quarkus.qute.deployment.QuteProcessor.validateExpressions(QuteProcessor.java:674)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
	at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at java.base/java.lang.reflect.Method.invoke(Method.java:566)
	at io.quarkus.deployment.ExtensionLoader$3.execute(ExtensionLoader.java:909)
	at io.quarkus.builder.BuildContext.run(BuildContext.java:281)
	at org.jboss.threads.ContextHandler$1.runWith(ContextHandler.java:18)
	at org.jboss.threads.EnhancedQueueExecutor$Task.run(EnhancedQueueExecutor.java:2449)
	at org.jboss.threads.EnhancedQueueExecutor$ThreadBody.run(EnhancedQueueExecutor.java:1478)
	at java.base/java.lang.Thread.run(Thread.java:834)
	at org.jboss.threads.JBossThread.run(JBossThread.java:501)

	at io.quarkus.runner.bootstrap.AugmentActionImpl.runAugment(AugmentActionImpl.java:332)
	at io.quarkus.runner.bootstrap.AugmentActionImpl.reloadExistingApplication(AugmentActionImpl.java:265)
	at io.quarkus.runner.bootstrap.AugmentActionImpl.reloadExistingApplication(AugmentActionImpl.java:60)
	at io.quarkus.deployment.dev.IsolatedDevModeMain.restartApp(IsolatedDevModeMain.java:221)
	at io.quarkus.deployment.dev.IsolatedDevModeMain.restartCallback(IsolatedDevModeMain.java:204)
	at io.quarkus.deployment.dev.RuntimeUpdatesProcessor.doScan(RuntimeUpdatesProcessor.java:536)
	at io.quarkus.deployment.console.ConsoleStateManager.forceRestart(ConsoleStateManager.java:141)
	at io.quarkus.deployment.console.ConsoleStateManager.lambda$installBuiltins$0(ConsoleStateManager.java:98)
	at io.quarkus.deployment.console.ConsoleStateManager$1.accept(ConsoleStateManager.java:73)
	at io.quarkus.deployment.console.ConsoleStateManager$1.accept(ConsoleStateManager.java:46)
	at io.quarkus.dev.console.BasicConsole$2.run(BasicConsole.java:83)
	at java.base/java.lang.Thread.run(Thread.java:834)

Add empty beans.xml or add jandex plugin to pom.xml or mark com.zucchetti.mercurio.entity.Release with @TemplateData doesn't solve the problem; are validation annotations supposed to work in this case?

Best regards
Luca

[mkouba]

Hi Luca, so first of all the validation annotations such as @NotNull are not supported in Qute type-safe templates. Do you use any library that would handle those annotations during the compile time, i.e. modify the resulting bytecode?

In any case, the error message is clear that @Valid com.zucchetti.mercurio.entity.Release class is not available and this is due to the fact that Qute build step is using org.jboss.jandex.Type.toString() here, and toString() includes type annotations - hence the @Valid.

I'd recommend to use a separate class for @CheckedTemplate, i.e. something like:

@RequestScoped
@Slf4j
public class FTPReleaseUploadEventManagerBean {

      @CheckedTemplate(basePath = "")
      static class Templates {
	  static native TemplateInstance notifyAbandonedRelease(Release release);
	  static native TemplateInstance notifyCompletedRelease(Release release);
      }
}

@FroMage it seems that JandexUtil#getBoxedTypeName() would deserve an update ;-)

[mkouba]

I fixed the link above (the main branch moved the lines a little). JandexUtil.getBoxedTypeName() is used there and it's your code ;-). IDK what getBoxedTypeName() actually means but I guess that type.name().toString() would make more sense.

[gsmet]

That ^. Type.toString() should never be used directly to get a type name.

[FroMage]

So… do we open an issue and fix this or…

[gsmet]

I'm creating a PR. Not sure if it's worth adding tests for that given how simple it is and it's fixed now.

[gsmet]

#28536