Disable Module Validation when the Avaje Build Plugin is Detected (#513)

* disable validation when avaje build plugin is detected

* Update Processor.java

* gradle

* Update Processor.java

* Update README.md

* clean up resources

* Update ExternalProvider.java

* Update ExternalProvider.java

* Update ExternalProvider.java

* Update Processor.java

* Update code formatting, rename using performModuleValidation

---------

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

Author: SentryMan

README.md

@@ -143,7 +143,7 @@ public final class ExampleModule implements Module {
 
 ## Differences to Dagger
 
-- Specifically Aimed for server-side development (rather than Android)
+- Specifically aimed for server-side development (rather than Android)
 - Provides API to obtain all bean instances that implement an interface
 - Lifecycle methods with `@PostConstruct` and `@PreDestroy`
 - Spring-like factory classes with `@Factory` and `@Bean`

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

@@ -1,6 +1,9 @@
 package io.avaje.inject.generator;
 
 import static java.util.Map.entry;
+
+import java.net.URI;
+import java.nio.file.Paths;
 import static java.util.List.of;
 
 import java.util.List;
@@ -9,6 +12,8 @@
 import java.util.ServiceLoader;
 import java.util.Set;
 
+import javax.tools.StandardLocation;
+
 import io.avaje.inject.spi.Module;
 import io.avaje.inject.spi.Plugin;
 
@@ -43,13 +48,16 @@ private static boolean moduleCP() {
 
   static void registerModuleProvidedTypes(Set<String> providedTypes) {
     if (!injectAvailable) {
-      System.out.println("Unable to detect Avaje Inject in Annotation Processor ClassPath, use the Avaje Inject Maven/Gradle plugin for detecting Inject Modules from dependencies");
+      if (!pluginExists("build/avaje-plugin-exists.txt")
+        && !pluginExists("target/avaje-plugin-exists.txt")) {
+        APContext.logNote("Unable to detect Avaje Inject in Annotation Processor ClassPath, use the Avaje Inject Maven/Gradle plugin for detecting Inject Modules from dependencies");
+      }
       return;
     }
 
     final var iterator = ServiceLoader.load(Module.class, ExternalProvider.class.getClassLoader()).iterator();
     if (!iterator.hasNext()) {
-      System.out.println("No external modules detected");
+      APContext.logNote("No external modules detected");
       return;
     }
     while (iterator.hasNext()) {
@@ -78,7 +86,7 @@ static void registerModuleProvidedTypes(Set<String> providedTypes) {
   static void registerPluginProvidedTypes(ScopeInfo defaultScope) {
     avajePlugins.forEach((k, v) -> {
       if (APContext.typeElement(k) != null) {
-        System.out.println("Loaded Plugin: " + k);
+        APContext.logNote("Loaded Plugin: " + k);
         v.forEach(defaultScope::pluginProvided);
       }
     });
@@ -90,7 +98,7 @@ static void registerPluginProvidedTypes(ScopeInfo defaultScope) {
       if (avajePlugins.containsKey(name)) {
         continue;
       }
-      System.out.println("Loaded Plugin: " + plugin.getClass().getCanonicalName());
+      APContext.logNote("Loaded Plugin: " + plugin.getClass().getCanonicalName());
       for (final Class<?> provide : plugin.provides()) {
         defaultScope.pluginProvided(provide.getCanonicalName());
       }
@@ -99,4 +107,19 @@ static void registerPluginProvidedTypes(ScopeInfo defaultScope) {
       }
     }
   }
+
+  private static boolean pluginExists(String relativeName) {
+    try {
+      final String resource =
+        APContext.filer()
+          .getResource(StandardLocation.CLASS_OUTPUT, "", relativeName)
+          .toUri()
+          .toString()
+          .replaceFirst("/target/classes", "")
+          .replaceFirst("/build/classes/java/main", "");
+      return Paths.get(new URI(resource)).toFile().exists();
+    } catch (final Exception e) {
+      return false;
+    }
+  }
 }

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

@@ -1,7 +1,6 @@
 package io.avaje.inject.generator;
 
 import javax.annotation.processing.FilerException;
-import javax.annotation.processing.ProcessingEnvironment;
 import javax.lang.model.element.TypeElement;
 import javax.lang.model.type.TypeMirror;
 import javax.tools.FileObject;
@@ -19,9 +18,9 @@ final class ProcessingContext {
 
   private static final ThreadLocal<Ctx> CTX = new ThreadLocal<>();
   private static boolean processingOver;
+  private static boolean moduleValidation;
 
-  private ProcessingContext() {
-  }
+  private ProcessingContext() {}
 
   static final class Ctx {
     private final Set<String> uniqueModuleNames = new HashSet<>();
@@ -31,21 +30,20 @@ static final class Ctx {
     private final List<TypeElement> delayQueue = new ArrayList<>();
     private boolean validated;
 
-    public Ctx(Set<String> moduleFileProvided) {
+    Ctx(Set<String> moduleFileProvided) {
       ExternalProvider.registerModuleProvidedTypes(providedTypes);
       providedTypes.addAll(moduleFileProvided);
     }
 
-    public Ctx() {
-    }
+    Ctx() {}
   }
 
-  public static void init(ProcessingEnvironment processingEnv, Set<String> moduleFileProvided) {
+  static void init(Set<String> moduleFileProvided, boolean performModuleValidation) {
+    ProcessingContext.moduleValidation = performModuleValidation;
     CTX.set(new Ctx(moduleFileProvided));
-    APContext.init(processingEnv);
   }
 
-  public static void testInit() {
+  static void testInit() {
     CTX.set(new Ctx());
   }
 
@@ -142,18 +140,13 @@ static void addImportedAspects(Map<String, AspectImportPrism> importedMap) {
 
   static void validateModule(String injectFQN) {
     var module = getProjectModuleElement();
-    if (module != null && !CTX.get().validated && !module.isUnnamed()) {
-
+    if (moduleValidation && module != null && !CTX.get().validated && !module.isUnnamed()) {
       CTX.get().validated = true;
-
       try (var reader = getModuleInfoReader()) {
-
         var noProvides = reader.lines().noneMatch(s -> s.contains(injectFQN));
-
         if (noProvides) {
           logError(module, "Missing \"provides io.avaje.inject.spi.Module with %s;\"", injectFQN);
         }
-
       } catch (Exception e) {
         // can't read module
       }

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

@@ -13,10 +13,10 @@
 import javax.lang.model.util.ElementFilter;
 import javax.lang.model.util.Elements;
 import javax.tools.StandardLocation;
-import java.io.BufferedReader;
 import java.io.IOException;
-import java.io.InputStreamReader;
 import java.net.URI;
+import java.nio.file.Files;
+import java.nio.file.Paths;
 import java.util.*;
 import java.util.stream.Collectors;
 
@@ -47,6 +47,7 @@ public final class Processor extends AbstractProcessor {
   private boolean readModuleInfo;
   private final Set<String> pluginFileProvided = new HashSet<>();
   private final Set<String> moduleFileProvided = new HashSet<>();
+  private boolean performModuleValidation;
 
   @Override
   public SourceVersion getSupportedSourceVersion() {
@@ -56,45 +57,43 @@ public SourceVersion getSupportedSourceVersion() {
   @Override
   public synchronized void init(ProcessingEnvironment processingEnv) {
     super.init(processingEnv);
-    loadProvidedFiles(processingEnv.getFiler());
-    ProcessingContext.init(processingEnv, moduleFileProvided);
+    APContext.init(processingEnv);
+    loadProvidedFiles();
+    ProcessingContext.init(moduleFileProvided, performModuleValidation);
     this.elementUtils = processingEnv.getElementUtils();
     this.allScopes = new AllScopes();
     this.defaultScope = allScopes.defaultScope();
     ExternalProvider.registerPluginProvidedTypes(defaultScope);
     pluginFileProvided.forEach(defaultScope::pluginProvided);
   }
 
-  /**
-   * Loads provider files generated by avaje-inject-maven-plugin
-   */
-  void loadProvidedFiles(Filer filer) {
-    pluginFileProvided.addAll(lines(filer, "target/avaje-plugin-provides.txt", "/target/classes"));
-    moduleFileProvided.addAll(lines(filer, "target/avaje-module-provides.txt", "/target/classes"));
-    pluginFileProvided.addAll(lines(filer, "build/avaje-plugin-provides.txt", "/build/classes/java/main"));
-    moduleFileProvided.addAll(lines(filer, "build/avaje-module-provides.txt", "/build/classes/java/main"));
+  /** Loads provider files generated by avaje-inject-maven-plugin */
+  void loadProvidedFiles() {
+    this.performModuleValidation =
+        lines("target/avaje-plugin-exists.txt").isEmpty()
+            && lines("build/avaje-plugin-exists.txt").isEmpty();
+    pluginFileProvided.addAll(lines("target/avaje-plugin-provides.txt"));
+    moduleFileProvided.addAll(lines("target/avaje-module-provides.txt"));
+    pluginFileProvided.addAll(lines("build/avaje-plugin-provides.txt"));
+    moduleFileProvided.addAll(lines("build/avaje-module-provides.txt"));
   }
 
-  private static List<String> lines(Filer filer, String relativeName, String replace) {
+  private List<String> lines(String relativeName) {
     try {
-      final String resource = resource(filer, relativeName, replace);
-      try (var inputStream = new URI(resource).toURL().openStream();
-           var reader = new BufferedReader(new InputStreamReader(inputStream))) {
-        return reader.lines().collect(Collectors.toList());
-      }
+      final String resource =
+        processingEnv
+          .getFiler()
+          .getResource(StandardLocation.CLASS_OUTPUT, "", relativeName)
+          .toUri()
+          .toString()
+          .replaceFirst("/target/classes", "")
+          .replaceFirst("/build/classes/java/main", "");
+      return Files.readAllLines(Paths.get(new URI(resource)));
     } catch (final Exception e) {
       return Collections.emptyList();
     }
   }
 
-  private static String resource(Filer filer, String relativeName, String replace) throws IOException {
-    return filer
-      .getResource(StandardLocation.CLASS_OUTPUT, "", relativeName)
-      .toUri()
-      .toString()
-      .replace(replace, "");
-  }
-
   @Override
   public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
     APContext.setProjectModuleElement(annotations, roundEnv);