Recompile classes annotated with configured annotation when dependency changes #51145

Postremus · 2025-11-20T20:13:19Z

Recompile classes annotated with configured annotation when dependency changes
This is intended to solve the problem: "If class A changed, the class generated from an Annotation Processor needs to also change."

Annotations can be configured using quarkus.dev.recompile-annotations (wip).
For classes with any of these annotations, the referenced, and indirectly referenced types are searched. If any of those types changes, then the annotated class is also recompiled during the next hot reload.

This is part of whats needed for #5956

…y changes This is intended to solve the problem: "If class A changed, the class generated from an Annotation Processor needs to also change." Annotations can be configured using quarkus.dev.recompile-annotations (wip). For classes with any of these annotations, the referenced, and indirectly referenced types are searched. If any of those types changes, then the annotated class is also recompiled during the next hot reload.

Postremus · 2025-11-20T20:13:53Z

core/deployment/src/main/java/io/quarkus/deployment/dev/AnnotationDependentClassesConfig.java

+     * FQDNs of annotations that trigger automatic recompilation of annotated classes when their dependencies change
+     * during dev mode. This is useful for annotation processors that generate code based on these classes (e.g. Mapstruct).
+     */
+    Optional<Set<String>> recompileAnnotations();


Any better suggestions for the config name?

Lets discuss this when the javadoc is clearer, I'm sure the name will follow.

quarkus.dev.recompile.annotated.classes.when.dependencies.change but that's a mouthful :(

Postremus · 2025-11-20T20:16:40Z

/cc @geoand

So this is the first part of what's needed to make the mapstruct expererience smoother.

Any suggestion on how to automatically set this config when Mapstruct is present?

quarkus-bot · 2025-11-21T00:18:09Z

Status for workflow `Quarkus CI`

This is the status report for running Quarkus CI on commit fd7ce89.

Failing Jobs

Status	Name	Step	Failures	Logs	Raw logs	Build scan
✔️	JVM Integration Tests - JDK 17			Logs	Raw logs	🚧
✔️	JVM Integration Tests - JDK 17 Windows			Logs	Raw logs	🚧
✔️	JVM Integration Tests - JDK 21			Logs	Raw logs	🚧
❌	JVM Integration Tests - JDK 25	`Build`	Failures	Logs	Raw logs	🚧

Full information is available in the Build summary check run.
You can consult the Develocity build scans.

Failures

⚙️ JVM Integration Tests - JDK 25 #

- Failing: integration-tests/oidc-wiremock

📦 integration-tests/oidc-wiremock

❌ io.quarkus.it.keycloak.CodeFlowAuthorizationTest. - History - More details - Source on GitHub

java.lang.RuntimeException: java.lang.RuntimeException: Failed to start quarkus
	at io.quarkus.test.junit.QuarkusTestExtension.throwBootFailureException(QuarkusTestExtension.java:663)
	at io.quarkus.test.junit.QuarkusTestExtension.interceptBeforeAllMethod(QuarkusTestExtension.java:730)
	at java.base/java.util.ArrayList.forEach(ArrayList.java:1604)
Caused by: java.lang.RuntimeException: Failed to start quarkus
	at io.quarkus.runner.ApplicationImpl.doStart(Unknown Source)
	at io.quarkus.runtime.Application.start(Application.java:101)
	at java.base/java.lang.reflect.Method.invoke(Method.java:565)

❌ io.quarkus.it.keycloak.CodeFlowAuthorizationTest.testCodeFlowUserInfoCachedInIdToken line 431 - History - More details - Source on GitHub

org.opentest4j.AssertionFailedError: expected: <true> but was: <false>
	at org.junit.jupiter.api.AssertionFailureBuilder.build(AssertionFailureBuilder.java:151)
	at org.junit.jupiter.api.AssertionFailureBuilder.buildAndThrow(AssertionFailureBuilder.java:132)
	at org.junit.jupiter.api.AssertTrue.failNotTrue(AssertTrue.java:63)
	at org.junit.jupiter.api.AssertTrue.assertTrue(AssertTrue.java:36)
	at org.junit.jupiter.api.AssertTrue.assertTrue(AssertTrue.java:31)
	at org.junit.jupiter.api.Assertions.assertTrue(Assertions.java:183)
	at io.quarkus.it.keycloak.CodeFlowAuthorizationTest.testCodeFlowUserInfoCachedInIdToken(CodeFlowAuthorizationTest.java:431)

Flaky tests - Develocity

⚙️ Gradle Tests - JDK 17 Windows

📦 integration-tests/gradle

❌ Conditional dependency platform enforcement (Gradle).excludeConditionalDependencyFromBom - History

Gradle build failed with exit code 1 - java.lang.AssertionError

java.lang.AssertionError: Gradle build failed with exit code 1
	at io.quarkus.gradle.QuarkusGradleWrapperTestBase.runGradleWrapper(QuarkusGradleWrapperTestBase.java:173)
	at io.quarkus.gradle.QuarkusGradleWrapperTestBase.runGradleWrapper(QuarkusGradleWrapperTestBase.java:87)
	at io.quarkus.gradle.QuarkusGradleWrapperTestBase.runGradleWrapper(QuarkusGradleWrapperTestBase.java:82)
	at io.quarkus.gradle.EnforcingPlatformForConditionalDepsTest.assertConditionalDependencies(EnforcingPlatformForConditionalDepsTest.java:137)
	at io.quarkus.gradle.EnforcingPlatformForConditionalDepsTest.excludeConditionalDependencyFromBom(EnforcingPlatformForConditionalDepsTest.java:114)
	at java.base/java.lang.reflect.Method.invoke(Method.java:569)
	at java.base/java.util.ArrayList.forEach(ArrayList.java:1511)

❌ Conditional dependency platform enforcement (Gradle).publishTestArtifacts - History

Gradle build failed with exit code 1 - java.lang.AssertionError

java.lang.AssertionError: Gradle build failed with exit code 1
	at io.quarkus.gradle.QuarkusGradleWrapperTestBase.runGradleWrapper(QuarkusGradleWrapperTestBase.java:173)
	at io.quarkus.gradle.QuarkusGradleWrapperTestBase.runGradleWrapper(QuarkusGradleWrapperTestBase.java:87)
	at io.quarkus.gradle.QuarkusGradleWrapperTestBase.runGradleWrapper(QuarkusGradleWrapperTestBase.java:82)
	at io.quarkus.gradle.EnforcingPlatformForConditionalDepsTest.publishTestArtifacts(EnforcingPlatformForConditionalDepsTest.java:52)
	at java.base/java.lang.reflect.Method.invoke(Method.java:569)
	at java.base/java.util.ArrayList.forEach(ArrayList.java:1511)
	at java.base/java.util.ArrayList.forEach(ArrayList.java:1511)

⚙️ MicroProfile TCKs Tests

📦 tcks/microprofile-lra

❌ org.eclipse.microprofile.lra.tck.TckRecoveryTests.testCancelWhenParticipantIsUnavailable - History

Expecting the metric Compensated callback was called Expected: a value equal to or greater than <1> but: <0> was less than <1> - java.lang.AssertionError

java.lang.AssertionError: 
Expecting the metric Compensated callback was called
Expected: a value equal to or greater than <1>
     but: <0> was less than <1>
	at org.hamcrest.MatcherAssert.assertThat(MatcherAssert.java:20)
	at org.eclipse.microprofile.lra.tck.TckRecoveryTests.assertMetricCallbackCalled(TckRecoveryTests.java:210)
	at org.eclipse.microprofile.lra.tck.TckRecoveryTests.testCancelWhenParticipantIsUnavailable(TckRecoveryTests.java:195)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)

Postremus · 2025-11-21T06:29:28Z

...tests/devmode/src/test/java/io/quarkus/test/reload/AnnotationDependentReloadDevModeTest.java

+        boolean found = false;
+        for (LogRecord logRecord : TEST.getLogRecords()) {
+            if (logRecord.getLoggerName().equals("io.quarkus.deployment.dev.RuntimeUpdatesProcessor")
+                    && (logRecord.getParameters()[0].equals("AddressMapper.class, ContactData.class")
+                            || logRecord.getParameters()[0].equals("ContactData.class, AddressMapper.class"))) {
+                found = true;
+            }
+        }
+        Assertions.assertTrue(found, "Did not find a log record from RuntimeUpdatesProcessor for AddressMapper class");


I also wanted to check that the class file in target/classes is updaated (refreshed timestamp).
But how can I access the target directory? The root directory for the dev mode integration tests are created dynamically.

I think it may be better to assert that the response body changed, that will guarantee a recompilation occured.

geoand · 2025-11-24T07:23:27Z

Any suggestion on how to automatically set this config when Mapstruct is present?

I assume that is something that a dedicated MapStruct extension would handle

FroMage

This looks great.

Except… I wonder if this is not tailor made for MapStruct and not necessarily useful for other dependencies?

In this case, perhaps it'd be better if the entirely config and processor logic belonged to a MapStruct extention, and we'd keep the build items and RuntimeUpdatesProcessor changes in the code?

WDYT?

FroMage · 2025-11-24T13:57:50Z

.../deployment/src/main/java/io/quarkus/deployment/dev/AnnotationDependentClassesBuildItem.java

+
+import io.quarkus.builder.item.MultiBuildItem;
+
+public final class AnnotationDependentClassesBuildItem extends MultiBuildItem {


Javadoc on build items please :)

FroMage · 2025-11-24T13:58:30Z

.../deployment/src/main/java/io/quarkus/deployment/dev/AnnotationDependentClassesBuildItem.java

+        return annotationName;
+    }
+
+    public Map<DotName, Set<DotName>> getDependencyToAnnotatedClasses() {


It's not immediately clear to me which way the dependency points, so javadoc would help explain it here.

FroMage · 2025-11-24T14:05:23Z

core/deployment/src/main/java/io/quarkus/deployment/dev/AnnotationDependentClassesConfig.java

+
+    /**
+     * FQDNs of annotations that trigger automatic recompilation of annotated classes when their dependencies change
+     * during dev mode. This is useful for annotation processors that generate code based on these classes (e.g. Mapstruct).


This is not clear to me. annotated classes, their dependencies and these classes are ambiguous to me. It sounds a bit like this is a list of annotations that trigger a recompilation of the classes that have this annotation when they change. But this is standard behaviour, so it can't be it.

I think that what this list does is:

FQDN of annotations which, when present on an annotated type X, will trigger a recompilation of all the dependencies of X whenever the type X needs a recompilation. The dependencies of X include all the types present in the X source code.
For example, given the FQDN org.example.FroMage and the following type:

@FroMage public record Munster(Ferment ferment, Milk milk){}

then, whenever Munster needs to be recompiled because it was edited, we will automatically recompile the Ferment and Milk types as well.

If… this is indeed what this does? 😅

OK, so I was wrong, and this is not what it does, reading the description below. What this does is:

FQDN of annotations which, when present on an annotated type X, will trigger a recompilation of X whenever any dependency of X needs a recompilation. The dependencies of X include all the types directly present in the X source code, but also indirectly all the types present as members of these dependencies (fields, methods) as well as all their supertypes (superclass and superinterfaces) transitively.

For example, given the FQDN org.example.FroMage and the following type:

@FroMage public record Munster(Ferment ferment, Milk milk){}

then, whenever Ferment or Milk need to be recompiled because they were edited, we will automatically recompile the Munster type as well. This would also trigger whenever an indirect dependency of Ferment or Milk was edited and needed to be recompiled.

FroMage · 2025-11-24T14:07:19Z

core/deployment/src/main/java/io/quarkus/deployment/dev/AnnotationDependentClassesConfig.java

+     * FQDNs of annotations that trigger automatic recompilation of annotated classes when their dependencies change
+     * during dev mode. This is useful for annotation processors that generate code based on these classes (e.g. Mapstruct).
+     */
+    Optional<Set<String>> recompileAnnotations();


Lets discuss this when the javadoc is clearer, I'm sure the name will follow.

FroMage · 2025-11-24T14:15:52Z

core/deployment/src/main/java/io/quarkus/deployment/dev/AnnotationDependentClassesConfig.java

+     * FQDNs of annotations that trigger automatic recompilation of annotated classes when their dependencies change
+     * during dev mode. This is useful for annotation processors that generate code based on these classes (e.g. Mapstruct).
+     */
+    Optional<Set<String>> recompileAnnotations();


quarkus.dev.recompile.annotated.classes.when.dependencies.change but that's a mouthful :(

FroMage · 2025-11-24T14:22:10Z

.../deployment/src/main/java/io/quarkus/deployment/dev/AnnotationDependentClassesProcessor.java

+
+            // search up and down the inheritance chain
+            stack.add(classInfo.superClassType().name());
+            stack.addAll(classInfo.interfaceNames());


This will likely not work with generics.

Consider these types:

class Base extends Top<Bar> { } class Top<T> { public T property; }

By going up the type hierarchy with Top<Object> (raw), you're missing a Bar public member.

FroMage · 2025-11-24T14:23:30Z

.../deployment/src/main/java/io/quarkus/deployment/dev/AnnotationDependentClassesProcessor.java

+            stack.add(classInfo.superClassType().name());
+            stack.addAll(classInfo.interfaceNames());
+
+            for (ClassInfo knownDirectSubclass : index.getKnownDirectSubclasses(currentClassName)) {


Oh, I did not realise that subtypes also had to be factored in. I guess the suggested javadoc above should reflect that.

FroMage · 2025-11-24T14:25:12Z

.../deployment/src/main/java/io/quarkus/deployment/dev/AnnotationDependentClassesProcessor.java

+                continue;
+            }
+
+            // only search upwards. The annotated class should only contain references to the public types it can see, i.e. our own and our parents public types


I'm not sure why that is different to the "referenced types".

FroMage · 2025-11-24T14:29:57Z

...tests/devmode/src/test/java/io/quarkus/test/reload/AnnotationDependentReloadDevModeTest.java

+        boolean found = false;
+        for (LogRecord logRecord : TEST.getLogRecords()) {
+            if (logRecord.getLoggerName().equals("io.quarkus.deployment.dev.RuntimeUpdatesProcessor")
+                    && (logRecord.getParameters()[0].equals("AddressMapper.class, ContactData.class")
+                            || logRecord.getParameters()[0].equals("ContactData.class, AddressMapper.class"))) {
+                found = true;
+            }
+        }
+        Assertions.assertTrue(found, "Did not find a log record from RuntimeUpdatesProcessor for AddressMapper class");


I think it may be better to assert that the response body changed, that will guarantee a recompilation occured.

quarkus-bot bot added the area/core label Nov 20, 2025

Postremus commented Nov 20, 2025

View reviewed changes

quarkus-bot bot added the triage/flaky-test label Nov 21, 2025

Postremus commented Nov 21, 2025

View reviewed changes

Postremus mentioned this pull request Nov 22, 2025

Provide an extension for MapStruct #5956

Closed

geoand requested a review from FroMage November 24, 2025 07:21

FroMage reviewed Nov 24, 2025

View reviewed changes


		import io.quarkus.builder.item.MultiBuildItem;

		public final class AnnotationDependentClassesBuildItem extends MultiBuildItem {

Recompile classes annotated with configured annotation when dependency changes #51145

Are you sure you want to change the base?

Recompile classes annotated with configured annotation when dependency changes #51145

Uh oh!

Conversation

Postremus commented Nov 20, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Postremus commented Nov 20, 2025

Uh oh!

quarkus-bot bot commented Nov 21, 2025 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Status for workflow Quarkus CI

Failing Jobs

Failures

⚙️ JVM Integration Tests - JDK 25 #

📦 integration-tests/oidc-wiremock

Flaky tests - Develocity

⚙️ Gradle Tests - JDK 17 Windows

📦 integration-tests/gradle

⚙️ MicroProfile TCKs Tests

📦 tcks/microprofile-lra

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

geoand commented Nov 24, 2025

Uh oh!

FroMage left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

quarkus-bot bot commented Nov 21, 2025 •

edited by github-actions bot

Loading

Status for workflow `Quarkus CI`