Execution Model Validation: properly discover Dev UI JSON RPC classes

The `JsonRPCProvidersBuildItem` often used to be produced only in dev mode
(but note that some extensions produce it always already). This disallowed
using this build item to discover Dev UI JSON RPC classes properly, so
we used to ship a gross hack in the execution model annotation validation.

It is time to fix that. The `JsonRPCProvidersBuildItem` is always produced,
so we can rely on it for discovering all the Dev UI JSON RPC classes.

Author: Ladicek

core/deployment/src/main/java/io/quarkus/deployment/execannotations/ExecutionModelAnnotationsProcessor.java

@@ -86,6 +86,11 @@ private void doCheck(StringBuilder message, IndexView index,
         }
     }
 
+    /**
+     * @deprecated this method will be removed in Quarkus 3.24, which gives extensions 2 releases
+     *             to start producing {@code JsonRPCProvidersBuildItem} always, not just in dev mode
+     */
+    @Deprecated(since = "3.22", forRemoval = true)
     @BuildStep
     ExecutionModelAnnotationsAllowedBuildItem devuiJsonRpcServices() {
         return new ExecutionModelAnnotationsAllowedBuildItem(new Predicate<MethodInfo>() {

docs/src/main/asciidoc/dev-ui.adoc

@@ -876,14 +876,13 @@ You must register the `JsonPRCService` in your processor in the deployment modul
 
 [source,java]
 ----
-@BuildStep(onlyIf = IsDevelopment.class)// <1>
-JsonRPCProvidersBuildItem createJsonRPCServiceForCache() {// <2>
-    return new JsonRPCProvidersBuildItem(CacheJsonRPCService.class);// <3>
+@BuildStep
+JsonRPCProvidersBuildItem createJsonRPCServiceForCache() {// <1>
+    return new JsonRPCProvidersBuildItem(CacheJsonRPCService.class);// <2>
 }
 ----
-<1> Always only do this in Dev Mode
-<2> Produce or return a `JsonRPCProvidersBuildItem`
-<3> Define the class in your runtime module that will contain methods that make data available in the UI
+<1> Produce or return a `JsonRPCProvidersBuildItem`
+<2> Define the class in your runtime module that will contain methods that make data available in the UI
 
 https://github.com/quarkusio/quarkus/blob/main/extensions/cache/deployment/src/main/java/io/quarkus/cache/deployment/devui/CacheDevUiProcessor.java[Example code]
 

extensions/agroal/deployment/src/main/java/io/quarkus/agroal/deployment/devui/AgroalDevUIProcessor.java

@@ -18,7 +18,6 @@ class AgroalDevUIProcessor {
     @BuildStep
     void devUI(DataSourcesJdbcBuildTimeConfig config,
             BuildProducer<CardPageBuildItem> cardPageProducer,
-            BuildProducer<JsonRPCProvidersBuildItem> jsonRPCProviderProducer,
             LaunchModeBuildItem launchMode) {
 
         if (launchMode.getDevModeType().isPresent() && launchMode.getDevModeType().get().equals(DevModeType.LOCAL)) {
@@ -34,8 +33,12 @@ void devUI(DataSourcesJdbcBuildTimeConfig config,
                         .metadata("allowedHost", config.devui().allowedDBHost().orElse(null)));
 
                 cardPageProducer.produce(cardPageBuildItem);
-                jsonRPCProviderProducer.produce(new JsonRPCProvidersBuildItem(DatabaseInspector.class));
             }
         }
     }
+
+    @BuildStep
+    JsonRPCProvidersBuildItem createJsonRPCService() {
+        return new JsonRPCProvidersBuildItem(DatabaseInspector.class);
+    }
 }

extensions/arc/deployment/src/main/java/io/quarkus/arc/deployment/devui/ArcDevUIProcessor.java

@@ -102,7 +102,7 @@ public CardPageBuildItem pages(ArcBeanInfoBuildItem arcBeanInfoBuildItem, ArcCon
         return pageBuildItem;
     }
 
-    @BuildStep(onlyIf = IsDevelopment.class)
+    @BuildStep
     JsonRPCProvidersBuildItem createJsonRPCService() {
         return new JsonRPCProvidersBuildItem(ArcJsonRPCService.class);
     }

extensions/arc/deployment/src/main/java/io/quarkus/arc/deployment/devui/JsonRpcMethodsProcessor.java

@@ -0,0 +1,31 @@
+package io.quarkus.arc.deployment.devui;
+
+import java.util.HashSet;
+import java.util.List;
+import java.util.Set;
+import java.util.function.Predicate;
+
+import org.jboss.jandex.MethodInfo;
+
+import io.quarkus.deployment.annotations.BuildStep;
+import io.quarkus.deployment.execannotations.ExecutionModelAnnotationsAllowedBuildItem;
+import io.quarkus.devui.spi.JsonRPCProvidersBuildItem;
+
+// this class is present in the `arc/deployment` module, because it has to be present always
+// and cannot be in the `core/deployment` module, as it depends on `quarkus-vertx-http-dev-ui-spi`
+public class JsonRpcMethodsProcessor {
+    @BuildStep
+    ExecutionModelAnnotationsAllowedBuildItem jsonRpcMethods(List<JsonRPCProvidersBuildItem> rpcProviders) {
+        Set<String> classes = new HashSet<>();
+        for (JsonRPCProvidersBuildItem rpcProvider : rpcProviders) {
+            classes.add(rpcProvider.getJsonRPCMethodProviderClass().getName());
+        }
+
+        return new ExecutionModelAnnotationsAllowedBuildItem(new Predicate<MethodInfo>() {
+            @Override
+            public boolean test(MethodInfo method) {
+                return classes.contains(method.declaringClass().name().toString());
+            }
+        });
+    }
+}

extensions/cache/deployment/src/main/java/io/quarkus/cache/deployment/devui/CacheDevUiProcessor.java

@@ -21,7 +21,7 @@ CardPageBuildItem create(CurateOutcomeBuildItem bi) {
         return pageBuildItem;
     }
 
-    @BuildStep(onlyIf = IsDevelopment.class)
+    @BuildStep
     JsonRPCProvidersBuildItem createJsonRPCServiceForCache() {
         return new JsonRPCProvidersBuildItem(CacheJsonRPCService.class);
     }

extensions/container-image/deployment/src/main/java/io/quarkus/container/image/deployment/devui/ContainerImageDevUiProcessor.java

@@ -37,7 +37,7 @@ CardPageBuildItem create(List<AvailableContainerImageExtensionBuildItem> extensi
         return card;
     }
 
-    @BuildStep(onlyIf = IsDevelopment.class)
+    @BuildStep
     JsonRPCProvidersBuildItem createJsonRPCServiceForContainerBuild() {
         DevConsoleManager.register("container-image-build-action", build());
         return new JsonRPCProvidersBuildItem(ContainerBuilderJsonRpcService.class);

extensions/datasource/deployment/src/main/java/io/quarkus/datasource/deployment/devui/DevUIDatasourceProcessor.java

@@ -30,7 +30,7 @@ CardPageBuildItem create(DataSourcesBuildTimeConfig dataSourceBuildTimeConfig) {
         return card;
     }
 
-    @BuildStep(onlyIf = IsDevelopment.class)
+    @BuildStep
     JsonRPCProvidersBuildItem registerJsonRpcBackend() {
         return new JsonRPCProvidersBuildItem(DatasourceJsonRpcService.class);
     }

extensions/flyway/deployment/src/main/java/io/quarkus/flyway/deployment/devui/FlywayDevUIProcessor.java

@@ -45,7 +45,7 @@ CardPageBuildItem create(FlywayDevUIRecorder recorder, FlywayBuildTimeConfig bui
         return card;
     }
 
-    @BuildStep(onlyIf = IsDevelopment.class)
+    @BuildStep
     JsonRPCProvidersBuildItem registerJsonRpcBackend() {
         return new JsonRPCProvidersBuildItem(FlywayJsonRpcService.class);
     }

extensions/grpc/deployment/src/main/java/io/quarkus/grpc/deployment/GrpcMethodsProcessor.java

@@ -2,18 +2,35 @@
 
 import java.util.function.Predicate;
 
+import org.jboss.jandex.ClassInfo;
+import org.jboss.jandex.IndexView;
 import org.jboss.jandex.MethodInfo;
 
 import io.quarkus.deployment.annotations.BuildStep;
+import io.quarkus.deployment.builditem.CombinedIndexBuildItem;
 import io.quarkus.deployment.execannotations.ExecutionModelAnnotationsAllowedBuildItem;
 
 public class GrpcMethodsProcessor {
     @BuildStep
-    ExecutionModelAnnotationsAllowedBuildItem grpcMethods() {
+    ExecutionModelAnnotationsAllowedBuildItem grpcMethods(CombinedIndexBuildItem combinedIndex) {
+        IndexView index = combinedIndex.getIndex();
+
         return new ExecutionModelAnnotationsAllowedBuildItem(new Predicate<MethodInfo>() {
             @Override
             public boolean test(MethodInfo method) {
-                return method.declaringClass().hasDeclaredAnnotation(GrpcDotNames.GRPC_SERVICE);
+                // either the method is on a `@GrpcService` class
+                if (method.declaringClass().hasDeclaredAnnotation(GrpcDotNames.GRPC_SERVICE)) {
+                    return true;
+                }
+
+                // or the method is inherited by a `@GrpcService` class
+                for (ClassInfo subclass : index.getAllKnownSubclasses(method.declaringClass().name())) {
+                    if (subclass.hasDeclaredAnnotation(GrpcDotNames.GRPC_SERVICE)) {
+                        return true;
+                    }
+                }
+
+                return false;
             }
         });
     }