Merge pull request #31444 from Ladicek/arc-build-compatible-extensions

ArC: initial implementation of CDI Build Compatible Extensions

Author: Ladicek

extensions/arc/deployment/src/main/java/io/quarkus/arc/deployment/ArcProcessor.java

@@ -148,6 +148,11 @@ FeatureBuildItem feature() {
         return new FeatureBuildItem(Feature.CDI);
     }
 
+    @BuildStep
+    BuildCompatibleExtensionsBuildItem buildCompatibleExtensions() {
+        return new BuildCompatibleExtensionsBuildItem();
+    }
+
     @BuildStep
     AdditionalBeanBuildItem quarkusApplication(CombinedIndexBuildItem combinedIndex) {
         List<String> quarkusApplications = new ArrayList<>();
@@ -190,6 +195,7 @@ public ContextRegistrationPhaseBuildItem initialize(
             BeanArchiveIndexBuildItem beanArchiveIndex,
             CombinedIndexBuildItem combinedIndex,
             ApplicationIndexBuildItem applicationIndex,
+            BuildCompatibleExtensionsBuildItem buildCompatibleExtensions,
             List<ExcludedTypeBuildItem> excludedTypes,
             List<AnnotationsTransformerBuildItem> annotationTransformers,
             List<InjectionPointTransformerBuildItem> injectionPointTransformers,
@@ -421,6 +427,8 @@ public Integer compute(AnnotationTarget target, Collection<StereotypeInfo> stere
             builder.addSuppressConditionGenerator(generator.getGenerator());
         }
 
+        builder.setBuildCompatibleExtensions(buildCompatibleExtensions.entrypoint);
+
         BeanProcessor beanProcessor = builder.build();
         ContextRegistrar.RegistrationContext context = beanProcessor.registerCustomContexts();
         return new ContextRegistrationPhaseBuildItem(context, beanProcessor);

extensions/arc/deployment/src/main/java/io/quarkus/arc/deployment/BeanArchiveProcessor.java

@@ -49,7 +49,8 @@ public BeanArchiveIndexBuildItem build(ArcConfig config, ApplicationArchivesBuil
             List<AdditionalBeanBuildItem> additionalBeans, List<GeneratedBeanBuildItem> generatedBeans,
             LiveReloadBuildItem liveReloadBuildItem, BuildProducer<GeneratedClassBuildItem> generatedClass,
             CustomScopeAnnotationsBuildItem customScopes, List<ExcludeDependencyBuildItem> excludeDependencyBuildItems,
-            List<BeanArchivePredicateBuildItem> beanArchivePredicates)
+            List<BeanArchivePredicateBuildItem> beanArchivePredicates,
+            BuildCompatibleExtensionsBuildItem buildCompatibleExtensions)
             throws Exception {
 
         // First build an index from application archives
@@ -63,6 +64,10 @@ public BeanArchiveIndexBuildItem build(ArcConfig config, ApplicationArchivesBuil
             additionalBeanClasses.addAll(i.getBeanClasses());
         }
 
+        Set<String> additionalBeansFromExtensions = new HashSet<>();
+        buildCompatibleExtensions.entrypoint.runDiscovery(applicationIndex, additionalBeansFromExtensions);
+        additionalBeanClasses.addAll(additionalBeansFromExtensions);
+
         // Build the index for additional beans and generated bean classes
         Set<DotName> additionalIndex = new HashSet<>();
         Set<DotName> knownMissingClasses = new HashSet<>();

extensions/arc/deployment/src/main/java/io/quarkus/arc/deployment/BuildCompatibleExtensionsBuildItem.java

@@ -0,0 +1,8 @@
+package io.quarkus.arc.deployment;
+
+import io.quarkus.arc.processor.bcextensions.ExtensionsEntryPoint;
+import io.quarkus.builder.item.SimpleBuildItem;
+
+public final class BuildCompatibleExtensionsBuildItem extends SimpleBuildItem {
+    public final ExtensionsEntryPoint entrypoint = new ExtensionsEntryPoint();
+}

independent-projects/arc/processor/src/main/java/io/quarkus/arc/processor/AssignabilityCheck.java

@@ -13,7 +13,7 @@
 import org.jboss.jandex.IndexView;
 import org.jboss.jandex.Type;
 
-final class AssignabilityCheck {
+public final class AssignabilityCheck {
 
     private final ConcurrentMap<DotName, Set<DotName>> cache;
     private final IndexView index;
@@ -23,7 +23,7 @@ public AssignabilityCheck(IndexView beanArchiveIndex, IndexView applicationIndex
         this.index = applicationIndex != null ? CompositeIndex.create(beanArchiveIndex, applicationIndex) : beanArchiveIndex;
     }
 
-    boolean isAssignableFrom(Type type1, Type type2) {
+    public boolean isAssignableFrom(Type type1, Type type2) {
         // java.lang.Object is assignable from any type
         if (type1.name().equals(DotNames.OBJECT)) {
             return true;

independent-projects/arc/processor/src/main/java/io/quarkus/arc/processor/BeanConfiguratorBase.java

@@ -201,12 +201,22 @@ public THIS targetPackageName(String name) {
         return self();
     }
 
+    /**
+     * @deprecated use {@link #alternative(boolean)} and {@link #priority(int)};
+     *             this method will be removed at some time after Quarkus 3.6
+     */
+    @Deprecated(forRemoval = true, since = "3.0")
     public THIS alternativePriority(int value) {
         this.alternative = true;
         this.priority = value;
         return self();
     }
 
+    public THIS alternative(boolean alternative) {
+        this.alternative = alternative;
+        return self();
+    }
+
     public THIS priority(int value) {
         this.priority = value;
         return self();

independent-projects/arc/processor/src/main/java/io/quarkus/arc/processor/BeanDeployment.java

@@ -48,6 +48,7 @@
 import io.quarkus.arc.processor.BeanRegistrar.RegistrationContext;
 import io.quarkus.arc.processor.BuildExtension.BuildContext;
 import io.quarkus.arc.processor.BuildExtension.Key;
+import io.quarkus.arc.processor.bcextensions.ExtensionsEntryPoint;
 import io.quarkus.gizmo.MethodCreator;
 import io.quarkus.gizmo.ResultHandle;
 
@@ -119,8 +120,11 @@ public class BeanDeployment {
 
     private final List<Predicate<ClassInfo>> excludeTypes;
 
+    private final ExtensionsEntryPoint buildCompatibleExtensions;
+
     BeanDeployment(String name, BuildContextImpl buildContext, BeanProcessor.Builder builder) {
         this.name = name;
+        this.buildCompatibleExtensions = builder.buildCompatibleExtensions;
         this.buildContext = buildContext;
         Map<DotName, BeanDefiningAnnotation> beanDefiningAnnotations = new HashMap<>();
         if (builder.additionalBeanDefiningAnnotations != null) {
@@ -269,6 +273,10 @@ BeanRegistrar.RegistrationContext registerBeans(List<BeanRegistrar> beanRegistra
         this.injectionPoints.addAll(injectionPoints);
         buildContextPut(Key.INJECTION_POINTS.asString(), Collections.unmodifiableList(this.injectionPoints));
 
+        if (buildCompatibleExtensions != null) {
+            buildCompatibleExtensions.runRegistration(beanArchiveComputingIndex, beans, observers);
+        }
+
         return registerSyntheticBeans(beanRegistrars, buildContext);
     }
 
@@ -524,6 +532,10 @@ public Collection<StereotypeInfo> getStereotypes() {
         return Collections.unmodifiableCollection(stereotypes.values());
     }
 
+    Map<DotName, StereotypeInfo> getStereotypesMap() {
+        return Collections.unmodifiableMap(stereotypes);
+    }
+
     /**
      * Returns the index that was used during discovery and type-safe resolution.
      * <p>
@@ -1231,6 +1243,10 @@ private RegistrationContext registerSyntheticBeans(List<BeanRegistrar> beanRegis
         for (BeanRegistrar registrar : beanRegistrars) {
             registrar.register(context);
         }
+        if (buildCompatibleExtensions != null) {
+            buildCompatibleExtensions.runSynthesis(beanArchiveComputingIndex);
+            buildCompatibleExtensions.registerSyntheticBeans(context);
+        }
         this.injectionPoints.addAll(context.syntheticInjectionPoints);
         return context;
     }
@@ -1243,6 +1259,10 @@ io.quarkus.arc.processor.ObserverRegistrar.RegistrationContext registerSynthetic
             registrar.register(context);
             context.extension = null;
         }
+        if (buildCompatibleExtensions != null) {
+            buildCompatibleExtensions.registerSyntheticObservers(context);
+            buildCompatibleExtensions.runRegistrationAgain(beanArchiveComputingIndex, beans, observers);
+        }
         return context;
     }
 

independent-projects/arc/processor/src/main/java/io/quarkus/arc/processor/BeanInfo.java

@@ -987,8 +987,13 @@ Builder disposer(DisposerInfo disposer) {
             return this;
         }
 
+        /**
+         * @deprecated use {@link #alternative(boolean)} and {@link #priority(Integer)};
+         *             this method will be removed at some time after Quarkus 3.6
+         */
+        @Deprecated(forRemoval = true, since = "3.0")
         Builder alternativePriority(Integer alternativePriority) {
-            return alternative(true).priority(priority);
+            return alternative(true).priority(alternativePriority);
         }
 
         Builder alternative(boolean value) {

independent-projects/arc/processor/src/main/java/io/quarkus/arc/processor/BeanProcessor.java

@@ -37,6 +37,7 @@
 import io.quarkus.arc.processor.BuildExtension.Key;
 import io.quarkus.arc.processor.ResourceOutput.Resource;
 import io.quarkus.arc.processor.ResourceOutput.Resource.SpecialType;
+import io.quarkus.arc.processor.bcextensions.ExtensionsEntryPoint;
 import io.quarkus.gizmo.BytecodeCreator;
 
 /**
@@ -85,7 +86,15 @@ public static Builder builder() {
     // Such as java.lang.Deprecated
     protected final Predicate<DotName> injectionPointAnnotationsPredicate;
 
+    private final ExtensionsEntryPoint buildCompatibleExtensions;
+
     private BeanProcessor(Builder builder) {
+        this.buildCompatibleExtensions = builder.buildCompatibleExtensions;
+        if (buildCompatibleExtensions != null) {
+            buildCompatibleExtensions.registerMetaAnnotations(builder);
+            buildCompatibleExtensions.runEnhancement(builder.beanArchiveComputingIndex, builder);
+        }
+
         this.reflectionRegistration = builder.reflectionRegistration;
         this.applicationClassPredicate = builder.applicationClassPredicate;
         this.name = builder.name;
@@ -153,7 +162,13 @@ public void initialize(Consumer<BytecodeTransformer> bytecodeTransformerConsumer
      * @return the validation context
      */
     public BeanDeploymentValidator.ValidationContext validate(Consumer<BytecodeTransformer> bytecodeTransformerConsumer) {
-        return beanDeployment.validate(beanDeploymentValidators, bytecodeTransformerConsumer);
+        ValidationContext validationContext = beanDeployment.validate(beanDeploymentValidators, bytecodeTransformerConsumer);
+        if (buildCompatibleExtensions != null) {
+            buildCompatibleExtensions.runValidation(beanDeployment.getBeanArchiveIndex(),
+                    validationContext.get(Key.BEANS), validationContext.get(Key.OBSERVERS));
+            buildCompatibleExtensions.registerValidationErrors(validationContext);
+        }
+        return validationContext;
     }
 
     public void processValidationErrors(BeanDeploymentValidator.ValidationContext validationContext) {
@@ -477,6 +492,8 @@ public static class Builder {
         AlternativePriorities alternativePriorities;
         final List<Predicate<ClassInfo>> excludeTypes;
 
+        ExtensionsEntryPoint buildCompatibleExtensions;
+
         Predicate<DotName> applicationClassPredicate;
 
         public Builder() {
@@ -785,6 +802,11 @@ public Builder addSuppressConditionGenerator(Function<BeanInfo, Consumer<Bytecod
             return this;
         }
 
+        public Builder setBuildCompatibleExtensions(ExtensionsEntryPoint buildCompatibleExtensions) {
+            this.buildCompatibleExtensions = buildCompatibleExtensions;
+            return this;
+        }
+
         public BeanProcessor build() {
             return new BeanProcessor(this);
         }

independent-projects/arc/processor/src/main/java/io/quarkus/arc/processor/Beans.java

@@ -11,6 +11,7 @@
 import java.util.HashSet;
 import java.util.Iterator;
 import java.util.List;
+import java.util.Map;
 import java.util.Set;
 import java.util.function.BiFunction;
 import java.util.function.Consumer;
@@ -313,7 +314,7 @@ static ScopeInfo initStereotypeScope(List<StereotypeInfo> stereotypes, Annotatio
         }
 
         Set<ScopeInfo> stereotypeScopes = new HashSet<>();
-        for (StereotypeInfo stereotype : stereotypesWithTransitive(stereotypes, beanDeployment)) {
+        for (StereotypeInfo stereotype : stereotypesWithTransitive(stereotypes, beanDeployment.getStereotypesMap())) {
             if (stereotype.getDefaultScope() != null) {
                 stereotypeScopes.add(stereotype.getDefaultScope());
             }
@@ -334,7 +335,7 @@ static boolean initStereotypeAlternative(List<StereotypeInfo> stereotypes, BeanD
             return false;
         }
 
-        for (StereotypeInfo stereotype : stereotypesWithTransitive(stereotypes, beanDeployment)) {
+        for (StereotypeInfo stereotype : stereotypesWithTransitive(stereotypes, beanDeployment.getStereotypesMap())) {
             if (stereotype.isAlternative()) {
                 return true;
             }
@@ -352,7 +353,7 @@ static Integer initStereotypeAlternativePriority(List<StereotypeInfo> stereotype
         }
 
         Set<Integer> priorities = new HashSet<>();
-        for (StereotypeInfo stereotype : stereotypesWithTransitive(stereotypes, beanDeployment)) {
+        for (StereotypeInfo stereotype : stereotypesWithTransitive(stereotypes, beanDeployment.getStereotypesMap())) {
             if (stereotype.getAlternativePriority() != null) {
                 priorities.add(stereotype.getAlternativePriority());
             }
@@ -374,7 +375,7 @@ static String initStereotypeName(List<StereotypeInfo> stereotypes, AnnotationTar
             return null;
         }
 
-        for (StereotypeInfo stereotype : stereotypesWithTransitive(stereotypes, beanDeployment)) {
+        for (StereotypeInfo stereotype : stereotypesWithTransitive(stereotypes, beanDeployment.getStereotypesMap())) {
             if (stereotype.isNamed()) {
                 switch (target.kind()) {
                     case CLASS:
@@ -392,21 +393,21 @@ static String initStereotypeName(List<StereotypeInfo> stereotypes, AnnotationTar
         return null;
     }
 
-    private static List<StereotypeInfo> stereotypesWithTransitive(List<StereotypeInfo> stereotypes,
-            BeanDeployment beanDeployment) {
+    public static List<StereotypeInfo> stereotypesWithTransitive(List<StereotypeInfo> stereotypes,
+            Map<DotName, StereotypeInfo> allStereotypes) {
         List<StereotypeInfo> result = new ArrayList<>();
         Set<DotName> alreadySeen = new HashSet<>(); // to guard against hypothetical stereotype cycle
         Deque<StereotypeInfo> workQueue = new ArrayDeque<>(stereotypes);
         while (!workQueue.isEmpty()) {
             StereotypeInfo stereotype = workQueue.poll();
+            if (alreadySeen.contains(stereotype.getName())) {
+                continue;
+            }
             result.add(stereotype);
             alreadySeen.add(stereotype.getName());
 
             for (AnnotationInstance parentStereotype : stereotype.getParentStereotypes()) {
-                if (alreadySeen.contains(parentStereotype.name())) {
-                    continue;
-                }
-                StereotypeInfo parent = beanDeployment.getStereotype(parentStereotype.name());
+                StereotypeInfo parent = allStereotypes.get(parentStereotype.name());
                 if (parent != null) {
                     workQueue.add(parent);
                 }

independent-projects/arc/processor/src/main/java/io/quarkus/arc/processor/ObserverConfigurator.java

@@ -44,6 +44,11 @@ public ObserverConfigurator(Consumer<ObserverConfigurator> consumer) {
         this.transactionPhase = TransactionPhase.IN_PROGRESS;
     }
 
+    @Override
+    protected ObserverConfigurator self() {
+        return this;
+    }
+
     /**
      * A unique identifier should be used for multiple synthetic observer methods with the same
      * attributes (including the bean class).