Remove Avaje Spi Reliance (#217)

* remove avaje spi reliance

* Update ComponentReader.java

* Update ComponentReader.java

* Format only changes

---------

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

Author: SentryMan

blackbox-test/src/main/resources/META-INF/services/io.avaje.jsonb.JsonbComponent

@@ -29,7 +29,7 @@
     <maven.compiler.release>17</maven.compiler.release>
     <inject.version>10.0-RC7</inject.version>
     <http.version>2.0-RC2</http.version>
-    <spi.version>1.11</spi.version>
+    <spi.version>2.0-RC1</spi.version>
   </properties>
 
   <modules>

pom.xml

@@ -1,24 +1,10 @@
 package io.avaje.validation.generator;
 
-import static io.avaje.validation.generator.APContext.typeElement;
-import static io.avaje.validation.generator.APContext.filer;
-import static io.avaje.validation.generator.APContext.logNote;
-import static io.avaje.validation.generator.APContext.logWarn;
+import java.util.Objects;
 
-import java.io.FileNotFoundException;
-import java.io.LineNumberReader;
-import java.io.Reader;
-import java.nio.file.NoSuchFileException;
-import java.util.ArrayList;
-import java.util.Collections;
-import java.util.List;
-
-import javax.annotation.processing.FilerException;
 import javax.lang.model.element.AnnotationMirror;
 import javax.lang.model.element.TypeElement;
 import javax.lang.model.type.TypeMirror;
-import javax.tools.FileObject;
-import javax.tools.StandardLocation;
 
 final class ComponentReader {
 
@@ -29,17 +15,18 @@ final class ComponentReader {
   }
 
   void read() {
-    final String componentFullName = loadMetaInfServices();
-    if (componentFullName != null) {
-      final TypeElement moduleType = typeElement(componentFullName);
-      if (moduleType != null) {
-        componentMetaData.setFullName(componentFullName);
+    ProcessingContext.readExistingMetaInfServices().stream()
+      .map(APContext::typeElement)
+      .filter(Objects::nonNull)
+      .filter(t -> "io.avaje.validation.spi.GeneratedComponent".equals(t.getSuperclass().toString()))
+      .findFirst()
+      .ifPresent(moduleType -> {
+        componentMetaData.setFullName(moduleType.getQualifiedName().toString());
         readMetaData(moduleType);
-      }
-    }
+      });
   }
 
-  /** Read the existing JsonAdapters from the MetaData annotation of the generated component. */
+  /** Read the existing adapters from the MetaData annotation of the generated component. */
   private void readMetaData(TypeElement moduleType) {
     for (final AnnotationMirror annotationMirror : moduleType.getAnnotationMirrors()) {
       final MetaDataPrism metaData = MetaDataPrism.getInstance(annotationMirror);
@@ -54,47 +41,9 @@ private void readMetaData(TypeElement moduleType) {
 
       } else if (metaDataAnnotationFactory != null) {
         metaDataAnnotationFactory.value().stream()
-            .map(APContext::asTypeElement)
-            .forEach(componentMetaData::addAnnotationAdapter);
+          .map(APContext::asTypeElement)
+          .forEach(componentMetaData::addAnnotationAdapter);
       }
     }
   }
-
-  private String loadMetaInfServices() {
-    final List<String> lines = loadMetaInf();
-    return lines.isEmpty() ? null : lines.get(0);
-  }
-
-  private List<String> loadMetaInf() {
-    try {
-      final FileObject fileObject =
-    		  filer()
-              .getResource(StandardLocation.CLASS_OUTPUT, "", Constants.META_INF_COMPONENT);
-
-      if (fileObject != null) {
-        final List<String> lines = new ArrayList<>();
-        final Reader reader = fileObject.openReader(true);
-        final LineNumberReader lineReader = new LineNumberReader(reader);
-        String line;
-        while ((line = lineReader.readLine()) != null) {
-          line = line.trim();
-          if (!line.isEmpty()) {
-            lines.add(line);
-          }
-        }
-        return lines;
-      }
-
-    } catch (FileNotFoundException | NoSuchFileException e) {
-      // logDebug("no services file yet");
-
-    } catch (final FilerException e) {
-      logNote("FilerException reading services file");
-
-    } catch (final Exception e) {
-      e.printStackTrace();
-      logWarn("Error reading services file: " + e.getMessage());
-    }
-    return Collections.emptyList();
-  }
 }

validator-generator/src/main/java/io/avaje/validation/generator/ComponentReader.java

@@ -6,13 +6,18 @@
 import static io.avaje.validation.generator.APContext.logWarn;
 import static java.util.stream.Collectors.toSet;
 
+import java.io.BufferedReader;
 import java.io.IOException;
+import java.io.InputStreamReader;
 import java.net.URI;
 import java.net.URISyntaxException;
+import java.util.HashSet;
+import java.util.Set;
+import java.util.TreeSet;
+
 import javax.annotation.processing.ProcessingEnvironment;
 import javax.tools.FileObject;
 import javax.tools.StandardLocation;
-
 import io.avaje.validation.generator.ModuleInfoReader.Requires;
 
 final class ProcessingContext {
@@ -23,14 +28,13 @@ private static final class Ctx {
     private final String diAnnotation;
     private final boolean warnHttp;
     private final boolean injectPresent;
-    private final boolean spiPresent;
-    private boolean validated;
+    private final Set<String> serviceSet = new TreeSet<>();
 
     Ctx(ProcessingEnvironment env) {
       var elements = env.getElementUtils();
+
       this.injectPresent = elements.getTypeElement(Constants.COMPONENT) != null;
       this.warnHttp = elements.getTypeElement("io.avaje.http.api.Controller") != null;
-      this.spiPresent = elements.getTypeElement("io.avaje.spi.internal.ServiceProcessor") != null;
 
       final var jakarta = elements.getTypeElement(Constants.SINGLETON_JAKARTA) != null;
       diAnnotation =
@@ -48,28 +52,24 @@ static void init(ProcessingEnvironment processingEnv) {
   }
 
   static FileObject createMetaInfWriterFor(String interfaceType) throws IOException {
-    var serviceFile =
-        CTX.get().spiPresent
-            ? interfaceType.replace("META-INF/services/", "META-INF/generated-services/")
-            : interfaceType;
-
-    return filer().createResource(StandardLocation.CLASS_OUTPUT, "", serviceFile);
+    return filer().createResource(StandardLocation.CLASS_OUTPUT, "", interfaceType);
   }
 
   static String diAnnotation() {
     return CTX.get().diAnnotation;
   }
 
-  static void validateModule(String fqn) {
+  static void validateModule() {
     var module = getProjectModuleElement();
-    if (module != null && !CTX.get().validated && !module.isUnnamed()) {
-
-      CTX.get().validated = true;
+    if (module != null && !module.isUnnamed()) {
       var injectPresent = CTX.get().injectPresent;
       var warnHttp = CTX.get().warnHttp;
 
       try (var reader = getModuleInfoReader()) {
         var moduleInfo = new ModuleInfoReader(module, reader);
+
+        moduleInfo.validateServices("io.avaje.validation.spi.ValidationExtension", CTX.get().serviceSet);
+
         var buildPluginAvailable = buildPluginAvailable();
         var requireSet =
             moduleInfo.requires().stream()
@@ -90,9 +90,9 @@ static void validateModule(String fqn) {
                 && !moduleInfo.containsOnModulePath("io.avaje.validation.plugin");
 
         if (noHttpPlugin) {
-          logWarn(module, "`requires io.avaje.validation.http` must be explicity added or else avaje-inject may fail to detect the default http validator, validator, and method AOP validator", fqn);
+          logWarn(module, "`requires io.avaje.validation.http` must be explicity added or else avaje-inject may fail to detect the default http validator, validator, and method AOP validator");
         } else if (noInjectPlugin) {
-          logWarn(module, "`requires io.avaje.validation.plugin` must be explicity added or else avaje-inject may fail to detect the default validator and method AOP validator", fqn);
+          logWarn(module, "`requires io.avaje.validation.plugin` must be explicity added or else avaje-inject may fail to detect the default validator and method AOP validator");
         }
 
       } catch (Exception e) {
@@ -121,8 +121,32 @@ private static boolean resource(String relativeName, String replace) {
     }
   }
 
+  static Set<String> readExistingMetaInfServices() {
+    var services = CTX.get().serviceSet;
+    try (final var file =
+           APContext.filer()
+             .getResource(StandardLocation.CLASS_OUTPUT, "", Constants.META_INF_COMPONENT)
+             .toUri()
+             .toURL()
+             .openStream();
+         final var buffer = new BufferedReader(new InputStreamReader(file));) {
+
+      String line;
+      while ((line = buffer.readLine()) != null) {
+        line.replaceAll("\\s", "").replace(",", "\n").lines().forEach(services::add);
+      }
+    } catch (Exception e) {
+      // not a critical error
+    }
+    return services;
+  }
+
   static void clear() {
     CTX.remove();
     APContext.clear();
   }
+
+  public static void addValidatorSpi(String spi) {
+    CTX.get().serviceSet.add(spi);
+  }
 }

validator-generator/src/main/java/io/avaje/validation/generator/ProcessingContext.java

@@ -29,7 +29,7 @@ void initialise() throws IOException {
       fileObject = createSourceFile(name);
     }
     if (!metaData.isEmpty()) {
-      ProcessingContext.validateModule(name);
+      ProcessingContext.validateModule();
     }
   }
 
@@ -48,10 +48,12 @@ void write() throws IOException {
   }
 
   void writeMetaInf() throws IOException {
+    var services = ProcessingContext.readExistingMetaInfServices();
     final FileObject fileObject = createMetaInfWriterFor(Constants.META_INF_COMPONENT);
     if (fileObject != null) {
       try (Writer writer = fileObject.openWriter()) {
-        writer.write(metaData.fullName());
+        services.add(metaData.fullName());
+        writer.write(String.join("\n", services));
       }
     }
   }

validator-generator/src/main/java/io/avaje/validation/generator/SimpleComponentWriter.java

@@ -38,7 +38,8 @@
   JakartaConstraintPrism.PRISM_TYPE,
   JavaxConstraintPrism.PRISM_TYPE,
   CrossParamConstraintPrism.PRISM_TYPE,
-  ValidMethodPrism.PRISM_TYPE
+  ValidMethodPrism.PRISM_TYPE,
+  "io.avaje.spi.ServiceProvider"
 })
 public final class ValidationProcessor extends AbstractProcessor {
 
@@ -74,7 +75,7 @@ private void readModule() {
 
   @Override
   public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment round) {
-	  APContext.setProjectModuleElement(annotations, round);
+    APContext.setProjectModuleElement(annotations, round);
     readModule();
     getElements(round, AvajeConstraintPrism.PRISM_TYPE).ifPresent(this::writeConstraintAdapters);
     getElements(round, JavaxConstraintPrism.PRISM_TYPE).ifPresent(this::writeConstraintAdapters);
@@ -93,6 +94,8 @@ public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment
         .map(ElementFilter::methodsIn)
         .ifPresent(this::writeParamProviderForMethod);
     getElements(round, ImportValidPojoPrism.PRISM_TYPE).ifPresent(this::writeAdaptersForImported);
+    getElements(round, "io.avaje.spi.ServiceProvider").ifPresent(this::registerSPI);
+
     initialiseComponent();
     cascadeTypes();
     writeComponent(round.processingOver());
@@ -326,4 +329,16 @@ private void writeParamProvider(ExecutableElement typeElement) {
       logError("Error writing ValidationAdapter for %s %s", beanReader, e);
     }
   }
+
+  private void registerSPI(Set<? extends Element> beans) {
+    ElementFilter.typesIn(beans).stream()
+      .filter(this::isExtension)
+      .map(TypeElement::getQualifiedName)
+      .map(Object::toString)
+      .forEach(ProcessingContext::addValidatorSpi);
+  }
+
+  private boolean isExtension(TypeElement te) {
+    return APContext.isAssignable(te, "io.avaje.validation.spi.ValidationExtension");
+  }
 }

validator-generator/src/main/java/io/avaje/validation/generator/ValidationProcessor.java

@@ -20,13 +20,6 @@
       <optional>true</optional>
     </dependency>
 
-    <dependency>
-      <groupId>io.avaje</groupId>
-      <artifactId>avaje-spi-service</artifactId>
-      <version>${spi.version}</version>
-      <optional>true</optional>
-    </dependency>
-
     <dependency>
       <groupId>io.avaje</groupId>
       <artifactId>avaje-validator-inject-plugin</artifactId>

validator-http-plugin/pom.xml

@@ -1,7 +1,6 @@
 package io.avaje.validation.http;
 
 import io.avaje.inject.BeanScopeBuilder;
-import io.avaje.spi.ServiceProvider;
 
 import java.util.ArrayList;
 import java.util.Arrays;
@@ -10,7 +9,6 @@
 /**
  * Plugin for avaje inject that provides a default Http Validator instance.
  */
-@ServiceProvider
 public final class HttpValidatorProvider implements io.avaje.inject.spi.InjectPlugin {
 
   private static final Class<?> VALIDATOR_HTTP_CLASS = avajeHttpOnClasspath();

validator-http-plugin/src/main/java/io/avaje/validation/http/HttpValidatorProvider.java

@@ -4,7 +4,6 @@
 
   requires transitive io.avaje.validation.plugin;
   requires transitive io.avaje.http.api;
-  requires static io.avaje.spi;
 
   provides io.avaje.inject.spi.InjectExtension with io.avaje.validation.http.HttpValidatorProvider;
 }

validator-http-plugin/src/main/java/module-info.java

@@ -0,0 +1 @@
+io.avaje.validation.http.HttpValidatorProvider

validator-http-plugin/src/main/resources/META-INF/services/io.avaje.inject.spi.InjectExtension

@@ -35,13 +35,6 @@
       <scope>test</scope>
     </dependency>
 
-    <dependency>
-      <groupId>io.avaje</groupId>
-      <artifactId>avaje-spi-service</artifactId>
-      <version>${spi.version}</version>
-      <optional>true</optional>
-    </dependency>
-
     <dependency>
       <groupId>io.avaje</groupId>
       <artifactId>junit</artifactId>

validator-inject-plugin/pom.xml

@@ -11,14 +11,12 @@
 import io.avaje.inject.aop.AspectProvider;
 import io.avaje.inject.spi.GenericType;
 import io.avaje.inject.spi.InjectPlugin;
-import io.avaje.spi.ServiceProvider;
 import io.avaje.validation.ValidMethod;
 import io.avaje.validation.Validator;
 import io.avaje.validation.adapter.MethodAdapterProvider;
 import io.avaje.validation.inject.aspect.AOPMethodValidator;
 
 /** Plugin for avaje inject that provides a default Validator instance. */
-@ServiceProvider
 public final class DefaultValidatorProvider implements InjectPlugin {
 
   @Override

validator-inject-plugin/src/main/java/io/avaje/validation/inject/spi/DefaultValidatorProvider.java

@@ -3,7 +3,6 @@
   requires transitive io.avaje.validation;
   requires transitive io.avaje.inject;
   requires transitive io.avaje.inject.aop;
-  requires static io.avaje.spi;
 
   provides io.avaje.inject.spi.InjectExtension with io.avaje.validation.inject.spi.DefaultValidatorProvider;
 }

validator-inject-plugin/src/main/java/module-info.java

@@ -0,0 +1 @@
+io.avaje.validation.inject.spi.DefaultValidatorProvider