[Generator] Refactor Metadata Parsing (#646)

* validate qualifiers at compile time

* remove transitive aop and events from inject test

* fix tests

* fix optional types

* final test

* fix event publishers not getting detected

* refactor reading external modules

* Revert "refactor reading external modules"

This reverts commit 96c3a94.

* Add Util.addQualifierSuffix() helper methods

* refactor reading external modules

* refactor reading external modules

* Formatting

* Formatting and tidy unused

* Formatting and tidy unused

---------

Co-authored-by: Rob Bygrave <[email protected]>

Author: SentryMan

inject-generator/src/main/java/io/avaje/inject/generator/Dependency.java

@@ -7,25 +7,32 @@ final class Dependency {
 
   private final String name;
   private boolean softDependency;
-  private final boolean conditionalDependency;
 
   Dependency(String type) {
-    this(type, "");
+    final String nameStr;
+    if (type.startsWith(SOFT_DEPENDENCY)) {
+      this.softDependency = true;
+      nameStr = type.substring(5);
+    } else if (type.startsWith(CONDITIONAL_DEPENDENCY)) {
+      this.softDependency = true;
+      nameStr = type.substring(4);
+    } else {
+      this.softDependency = false;
+      nameStr = type;
+    }
+    this.name = nameStr.replace(", ", ",");
   }
 
   Dependency(String type, String qualifier) {
     String nameStr;
     if (type.startsWith(SOFT_DEPENDENCY)) {
       this.softDependency = true;
-      this.conditionalDependency = false;
       nameStr = ProcessorUtils.trimAnnotations(type.substring(5));
     } else if (type.startsWith(CONDITIONAL_DEPENDENCY)) {
       this.softDependency = true;
-      this.conditionalDependency = true;
       nameStr = ProcessorUtils.trimAnnotations(type.substring(4));
     } else {
       this.softDependency = false;
-      this.conditionalDependency = false;
       nameStr = ProcessorUtils.trimAnnotations(type);
     }
     this.name = Util.addQualifierSuffixTrim(qualifier, nameStr);
@@ -34,7 +41,6 @@ final class Dependency {
   Dependency(String name, String qualifier, boolean softDependency) {
     this.name = Util.addQualifierSuffixTrim(qualifier, ProcessorUtils.trimAnnotations(name));
     this.softDependency = softDependency;
-    this.conditionalDependency = false;
   }
 
   @Override
@@ -55,15 +61,6 @@ boolean isSoftDependency() {
     return softDependency;
   }
 
-  /**
-   * Return true if a conditional dependency which can be empty.
-   *
-   * <p>A conditional dependency isn't absolutely required to wire beans.
-   */
-  public boolean isConditionalDependency() {
-    return conditionalDependency;
-  }
-
   String dependsOn() {
     return toString();
   }

inject-generator/src/main/java/io/avaje/inject/generator/ExternalProvider.java

@@ -6,17 +6,19 @@
 import java.lang.reflect.Type;
 import java.util.ArrayList;
 import java.util.Arrays;
+import java.util.Collection;
 
-import java.net.URI;
-import java.nio.file.Paths;
 import static java.util.List.of;
 
 import java.util.List;
 import java.util.Map;
+import java.util.Objects;
+import java.util.Optional;
 import java.util.Set;
+import java.util.stream.Stream;
 
-import javax.tools.StandardLocation;
-
+import javax.lang.model.element.TypeElement;
+import javax.lang.model.util.ElementFilter;
 import io.avaje.inject.spi.AvajeModule;
 import io.avaje.inject.spi.InjectPlugin;
 
@@ -42,6 +44,7 @@ final class ExternalProvider {
         "io.avaje.validation.Validator",
         "io.avaje.inject.aop.AspectProvider<io.avaje.validation.ValidMethod>")),
     entry("io.avaje.validation.http.HttpValidatorProvider", of("io.avaje.http.api.Validator")));
+  private static final List<MetaData> externalMeta = new ArrayList<>();
 
   private ExternalProvider() {}
 
@@ -69,21 +72,10 @@ static void registerModuleProvidedTypes(Set<String> providedTypes) {
     }
     for (final var module : modules) {
       final var name = module.getClass().getTypeName();
-      final var provides = new ArrayList<String>();
       APContext.logNote("Detected Module: " + name);
-      for (final var provide : module.provides()) {
-        providedTypes.add(provide.getTypeName());
-        provides.add(provide.getTypeName());
-      }
-      for (final var provide : module.autoProvides()) {
-        providedTypes.add(provide.getTypeName());
-        provides.add(provide.getTypeName());
-      }
-      for (final var provide : module.autoProvidesAspects()) {
-        final var aspectType = Util.wrapAspect(provide.getTypeName());
-        providedTypes.add(aspectType);
-        provides.add(aspectType);
-      }
+      registerExternalMetaData(name);
+      readMetaDataProvides(providedTypes);
+      final var provides = new ArrayList<>(providedTypes);
       final var requires = Arrays.stream(module.requires()).map(Type::getTypeName).collect(toList());
 
       Arrays.stream(module.autoRequires()).map(Type::getTypeName).forEach(requires::add);
@@ -133,4 +125,25 @@ private static boolean pluginExists(String relativeName) {
       return false;
     }
   }
+
+  static void registerExternalMetaData(String name) {
+    Optional.ofNullable(APContext.typeElement(name))
+      .map(TypeElement::getEnclosedElements)
+      .map(ElementFilter::methodsIn)
+      .stream()
+      .flatMap(List::stream)
+      .map(DependencyMetaPrism::getInstanceOn)
+      .filter(Objects::nonNull)
+      .map(MetaData::new)
+      .forEach(externalMeta::add);
+  }
+
+  static void readMetaDataProvides(Collection<String> providedTypes) {
+    externalMeta.forEach(meta -> {
+      providedTypes.add(meta.key());
+      providedTypes.add(meta.type());
+      providedTypes.addAll(Util.addQualifierSuffix(meta.provides(), meta.name()));
+      providedTypes.addAll(Util.addQualifierSuffix(meta.autoProvides(), meta.name()));
+    });
+  }
 }

inject-generator/src/main/java/io/avaje/inject/generator/InjectProcessor.java

@@ -15,7 +15,6 @@
 import javax.lang.model.util.Elements;
 
 import static java.util.stream.Collectors.joining;
-
 import java.io.IOException;
 import java.nio.file.Files;
 import java.nio.file.StandardOpenOption;
@@ -54,6 +53,7 @@ public final class InjectProcessor extends AbstractProcessor {
   private final Set<String> pluginFileProvided = new HashSet<>();
   private final Set<String> moduleFileProvided = new HashSet<>();
   private boolean performModuleValidation;
+  private final List<ModuleData> moduleData = new ArrayList<>();
 
   @Override
   public SourceVersion getSupportedSourceVersion() {
@@ -66,7 +66,7 @@ public synchronized void init(ProcessingEnvironment processingEnv) {
     APContext.init(processingEnv);
     loadProvidedFiles();
     ProcessingContext.init(moduleFileProvided, performModuleValidation);
-    loadOrderFiles();
+    moduleData.forEach(ProcessingContext::addModule);
     this.elementUtils = processingEnv.getElementUtils();
     this.allScopes = new AllScopes();
     this.defaultScope = allScopes.defaultScope();
@@ -98,21 +98,18 @@ public synchronized void init(ProcessingEnvironment processingEnv) {
   void loadProvidedFiles() {
     performModuleValidation = lines("avaje-plugin-exists.txt").isEmpty();
     pluginFileProvided.addAll(lines("avaje-plugin-provides.txt"));
-    moduleFileProvided.addAll(lines("avaje-module-provides.txt"));
-  }
 
-  /**
-   * Loads order files generated by avaje-inject-maven-plugin
-   */
-  private void loadOrderFiles() {
-    Stream.concat(
-        lines("avaje-module-dependencies.csv").stream().skip(1),
-        lines("avaje-module-dependencies.csv").stream().skip(1))
+    lines("avaje-module-dependencies.csv").stream()
+      .skip(1)
       .filter(s -> !s.startsWith("External Module Type"))
       .distinct()
       .map(l -> l.split("\\|"))
       .map(ModuleData::new)
-      .forEach(ProcessingContext::addModule);
+      .forEach(m -> {
+        ExternalProvider.registerExternalMetaData(m.name());
+        ExternalProvider.readMetaDataProvides(moduleFileProvided);
+        this.moduleData.add(m);
+      });
   }
 
   private List<String> lines(String relativeName) {

inject-generator/src/main/java/io/avaje/inject/generator/MetaData.java

@@ -138,6 +138,10 @@ void update(BeanReader beanReader) {
     this.importedComponent = beanReader.importedComponent();
   }
 
+  String name() {
+    return name;
+  }
+
   String type() {
     return type;
   }
@@ -282,7 +286,7 @@ void setProvides(List<String> provides) {
     this.provides = provides;
   }
 
-  void setDependsOn(List<String> dependsOn, String name) {
+  void setDependsOn(List<String> dependsOn) {
     this.dependsOn = dependsOn.stream().map(Dependency::new).collect(Collectors.toList());
   }
 

inject-generator/src/main/java/io/avaje/inject/generator/MethodReader.java

@@ -3,17 +3,13 @@
 import javax.lang.model.element.*;
 import javax.lang.model.type.TypeKind;
 import javax.lang.model.type.TypeMirror;
-
-import static java.util.stream.Collectors.toList;
-
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
 import java.util.Set;
-import java.util.stream.Stream;
 
+import static io.avaje.inject.generator.Constants.CONDITIONAL_DEPENDENCY;
 import static io.avaje.inject.generator.ProcessingContext.asElement;
-import static io.avaje.inject.generator.Constants.*;
 
 final class MethodReader {
 
@@ -166,7 +162,7 @@ MetaData createMeta() {
       var dep = Util.addQualifierSuffix(param.named, Util.trimWildcard(param.paramType));
       dependsOn.add(dep);
     }
-    metaData.setDependsOn(dependsOn, name);
+    metaData.setDependsOn(dependsOn);
     metaData.setProvides(
       typeReader == null
         ? Collections.emptyList()
@@ -228,7 +224,7 @@ void builderAddBeanProvider(Append writer) {
     writer.indent(indent).append("  builder");
     if (prototype) {
       writer.append(".asPrototype()");
-    } else if(secondary) {
+    } else if (secondary) {
       writer.append(".asSecondary()");
     }
 

inject-generator/src/test/java/io/avaje/inject/generator/models/valid/IncorrectCircularDependency.java

@@ -0,0 +1,26 @@
+package io.avaje.inject.generator.models.valid;
+
+import io.avaje.inject.Bean;
+import io.avaje.inject.Factory;
+import jakarta.inject.Named;
+
+@Factory
+public class IncorrectCircularDependency {
+
+  @Bean
+  @Named("parent") // for clarity, not necessary
+  public String parent(@Named("child") String child) {
+    throw new AssertionError("Method body unimportant");
+  }
+
+  @Bean
+  @Named("child")
+  public String child() {
+    throw new AssertionError("Method body unimportant");
+  }
+
+//  @Bean compilation rightly fails when this is uncommented
+//  public String child1(@Named("child2") String child) {
+//    throw new AssertionError("Method body unimportant");
+//  }
+}

inject-generator/src/test/java/io/avaje/inject/generator/models/valid/TestCircleFactory.java

@@ -0,0 +1,20 @@
+package io.avaje.inject.generator.models.valid;
+
+import jakarta.inject.Inject;
+import jakarta.inject.Named;
+import jakarta.inject.Singleton;
+
+@Singleton
+public class TestCircleFactory {
+
+  private final String parent;
+
+  @Inject
+  public TestCircleFactory(@Named("parent") String parent) {
+    this.parent = parent;
+  }
+
+  public String getParent() {
+    return parent;
+  }
+}

inject-gradle-plugin/src/main/java/io/avaje/inject/plugin/AvajeInjectPlugin.java

@@ -47,14 +47,10 @@ private void writeProvides(Project project) {
     }
 
     try (var classLoader = classLoader(project);
-        var moduleWriter = createFileWriter(outputDir.getPath(), "avaje-module-provides.txt");
         var pluginWriter = createFileWriter(outputDir.getPath(), "avaje-plugin-provides.txt");
         var moduleCSV = createFileWriter(outputDir.getPath(), "avaje-module-dependencies.csv")) {
-
         writeProvidedPlugins(classLoader, pluginWriter);
-        writeProvidedModules(classLoader, moduleWriter);
-        writeModuleCSV(moduleCSV);
-
+        writeModuleCSV(classLoader, moduleCSV);
     } catch (IOException e) {
       throw new GradleException("Failed to write avaje-module-provides", e);
     }
@@ -91,7 +87,29 @@ private void writeProvidedPlugins(ClassLoader classLoader, FileWriter pluginWrit
     }
   }
 
-  private void writeProvidedModules(ClassLoader classLoader, FileWriter moduleWriter) throws IOException {
+  private static String wrapAspect(String aspect) {
+    return "io.avaje.inject.aop.AspectProvider<" + aspect + ">";
+  }
+
+  private URLClassLoader classLoader(Project project) {
+    final URL[] urls = createClassPath(project);
+    return new URLClassLoader(urls, Thread.currentThread().getContextClassLoader());
+  }
+
+  private static URL[] createClassPath(Project project) {
+    try {
+      Set<File> compileClasspath = project.getConfigurations().getByName("compileClasspath").resolve();
+      final List<URL> urls = new ArrayList<>(compileClasspath.size());
+      for (File file : compileClasspath) {
+        urls.add(file.toURI().toURL());
+      }
+      return urls.toArray(new URL[0]);
+    } catch (MalformedURLException e) {
+      throw new GradleException("Error building classpath", e);
+    }
+  }
+
+  private void writeModuleCSV(ClassLoader classLoader, FileWriter moduleWriter) throws IOException {
     final Set<String> providedTypes = new HashSet<>();
 
     final List<AvajeModule> avajeModules = new ArrayList<>();
@@ -134,35 +152,6 @@ private void writeProvidedModules(ClassLoader classLoader, FileWriter moduleWrit
       modules.add(new ModuleData(name, provides, requires));
     }
 
-    for (final String providedType : providedTypes) {
-      moduleWriter.write(providedType);
-      moduleWriter.write("\n");
-    }
-  }
-
-  private static String wrapAspect(String aspect) {
-    return "io.avaje.inject.aop.AspectProvider<" + aspect + ">";
-  }
-
-  private URLClassLoader classLoader(Project project) {
-    final URL[] urls = createClassPath(project);
-    return new URLClassLoader(urls, Thread.currentThread().getContextClassLoader());
-  }
-
-  private static URL[] createClassPath(Project project) {
-    try {
-      Set<File> compileClasspath = project.getConfigurations().getByName("compileClasspath").resolve();
-      final List<URL> urls = new ArrayList<>(compileClasspath.size());
-      for (File file : compileClasspath) {
-        urls.add(file.toURI().toURL());
-      }
-      return urls.toArray(new URL[0]);
-    } catch (MalformedURLException e) {
-      throw new GradleException("Error building classpath", e);
-    }
-  }
-
-  private void writeModuleCSV(FileWriter moduleWriter) throws IOException {
     moduleWriter.write("\nExternal Module Type|Provides|Requires");
     for (ModuleData avajeModule : modules) {
       moduleWriter.write("\n");