Refactor scopes - Removes ApplicationScope & RequestScope in favour of "custom scopes"

README.md

@@ -8,8 +8,7 @@ module org.example {
 
   requires io.avaje.inject;
 
-  // register org.example._DI$BeanScopeFactory from generated sources
-  provides io.avaje.inject.spi.BeanScopeFactory with org.example._DI$BeanScopeFactory;
+  provides io.avaje.inject.spi.Module with org.example.ExampleModule;
 }
 ```
 

inject-generator/pom.xml

@@ -4,7 +4,7 @@
   <parent>
     <groupId>io.avaje</groupId>
     <artifactId>avaje-inject-parent</artifactId>
-    <version>6.2</version>
+    <version>6.5-RC0</version>
   </parent>
 
   <artifactId>avaje-inject-generator</artifactId>
@@ -16,7 +16,7 @@
     <dependency>
       <groupId>io.avaje</groupId>
       <artifactId>avaje-inject</artifactId>
-      <version>6.2</version>
+      <version>6.5-RC0</version>
     </dependency>
 
     <!-- test dependencies -->

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

@@ -0,0 +1,124 @@
+package io.avaje.inject.generator;
+
+import io.avaje.inject.InjectModule;
+
+import javax.annotation.processing.RoundEnvironment;
+import javax.lang.model.element.Element;
+import javax.lang.model.element.TypeElement;
+import javax.tools.FileObject;
+import java.io.IOException;
+import java.io.Writer;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+class AllScopes {
+
+  private final Map<String, Data> scopeAnnotations = new HashMap<>();
+  private final ProcessingContext context;
+  private final ScopeInfo defaultScope;
+
+  AllScopes(ProcessingContext context) {
+    this.context = context;
+    this.defaultScope = new ScopeInfo(context);
+  }
+
+  ScopeInfo defaultScope() {
+    return defaultScope;
+  }
+
+  ScopeInfo addScopeAnnotation(TypeElement type) {
+    final Data data = new Data(type, context, this);
+    scopeAnnotations.put(type.getQualifiedName().toString(), data);
+    return data.scopeInfo;
+  }
+
+  boolean providedByDefaultModule(String dependency) {
+    return defaultScope.providesDependency(dependency);
+  }
+
+  void readBeans(RoundEnvironment roundEnv) {
+    for (Data data : scopeAnnotations.values()) {
+      for (Element customBean : roundEnv.getElementsAnnotatedWith(data.type)) {
+        // context.logWarn("read custom scope bean " + customBean + " for scope " + entry.getKey());
+        data.scopeInfo.read((TypeElement) customBean, false);
+      }
+    }
+  }
+
+  void write(boolean processingOver) {
+    for (Data value : scopeAnnotations.values()) {
+      value.write(processingOver);
+    }
+    if (processingOver) {
+      writeModuleCustomServicesFile();
+    }
+  }
+
+  private void writeModuleCustomServicesFile() {
+    if (scopeAnnotations.isEmpty()) {
+      return;
+    }
+    try {
+      FileObject jfo = context.createMetaInfModuleCustom();
+      if (jfo != null) {
+        Writer writer = jfo.openWriter();
+        for (Data value : scopeAnnotations.values()) {
+          writer.write(value.moduleFullName());
+          writer.write("\n");
+        }
+        writer.close();
+      }
+
+    } catch (IOException e) {
+      e.printStackTrace();
+      context.logError("Failed to write services file " + e.getMessage());
+    }
+  }
+
+  void readModules(List<String> customScopeModules) {
+    for (String customScopeModule : customScopeModules) {
+      final TypeElement module = context.element(customScopeModule);
+      if (module != null) {
+        final InjectModule injectModule = module.getAnnotation(InjectModule.class);
+        if (injectModule != null) {
+          final String customScopeType = injectModule.customScopeType();
+          final TypeElement scopeType = context.element(customScopeType);
+          if (scopeType == null) {
+            context.logError(module, "customScopeType [" + customScopeType + "] is invalid? on " + module);
+          } else {
+            final ScopeInfo scopeInfo = addScopeAnnotation(scopeType);
+            scopeInfo.readModuleMetaData(module);
+          }
+        }
+      }
+    }
+  }
+
+  /**
+   * Find the scope by scope annotation type.
+   */
+  ScopeInfo get(String fullType) {
+    final Data data = scopeAnnotations.get(fullType);
+    return data == null ? null : data.scopeInfo;
+  }
+
+  static class Data {
+    final TypeElement type;
+    final ScopeInfo scopeInfo;
+
+    Data(TypeElement type, ProcessingContext context, AllScopes allScopes) {
+      this.type = type;
+      this.scopeInfo = new ScopeInfo(context, type, allScopes);
+      this.scopeInfo.details(null, type);
+    }
+
+    void write(boolean processingOver) {
+      scopeInfo.write(processingOver);
+    }
+
+    String moduleFullName() {
+      return scopeInfo.moduleFullName();
+    }
+  }
+}

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

@@ -148,9 +148,6 @@ boolean isExtraInjectionRequired() {
   }
 
   void buildAddFor(Append writer) {
-    if (requestParams.isRequestParam()) {
-      context.logError(beanType, "@Singleton %s is not allowed to have a @Request scope dependency %s", shortName, requestParams.getRequestParamType());
-    }
     writer.append("    if (builder.isAddBeanFor(");
     if (name != null && !name.isEmpty()) {
       writer.append("\"%s\", ", name);

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

@@ -1,8 +1,6 @@
 package io.avaje.inject.generator;
 
-import io.avaje.inject.Request;
 
-import javax.lang.model.element.TypeElement;
 import java.util.Set;
 
 /**
@@ -15,22 +13,13 @@ class BeanRequestParams {
   private final boolean requestScopedBean;
 
   private RequestScope.Handler reqScopeHandler;
-  private String requestParamType;
 
   BeanRequestParams(ProcessingContext context, String parentType, boolean requestScopedBean) {
     this.context = context;
     this.parentType = parentType;
     this.requestScopedBean = requestScopedBean;
   }
 
-  boolean isRequestParam() {
-    return requestParamType != null;
-  }
-
-  String getRequestParamType() {
-    return requestParamType;
-  }
-
   /**
    * Return true if this type is a request scoped type (e.g. Javalin Context).
    */
@@ -45,14 +34,6 @@ boolean check(String paramType) {
       }
       return true;
     }
-    if (paramType != null && requestParamType == null) {
-      final TypeElement element = context.element(paramType);
-      if (element != null) {
-        if (element.getAnnotation(Request.class) != null) {
-          requestParamType = paramType;
-        }
-      }
-    }
     return false;
   }
 

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

@@ -20,7 +20,8 @@ class Constants {
 
   static final String AT_SINGLETON = "@Singleton";
   static final String AT_GENERATED = "@Generated(\"io.avaje.inject.generator\")";
-  static final String META_INF_FACTORY = "META-INF/services/io.avaje.inject.spi.BeanScopeFactory";
+  static final String META_INF_FACTORY = "META-INF/services/io.avaje.inject.spi.Module";
+  static final String META_INF_CUSTOM = "META-INF/services/io.avaje.inject.spi.Module.Custom";
 
   static final String REQUESTSCOPE = "io.avaje.inject.RequestScope";
   static final String BEANCONTEXT = "io.avaje.inject.BeanScope";
@@ -31,5 +32,5 @@ class Constants {
   static final String BEAN_FACTORY2 = "io.avaje.inject.spi.BeanFactory2";
   static final String BUILDER = "io.avaje.inject.spi.Builder";
   static final String DEPENDENCYMETA = "io.avaje.inject.spi.DependencyMeta";
-  static final String BEANSCOPEFACTORY = "io.avaje.inject.spi.BeanScopeFactory";
+  static final String MODULE = "io.avaje.inject.spi.Module";
 }

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

@@ -17,7 +17,7 @@ class MetaData {
   private final String type;
   private final String shortType;
   private final String name;
-
+  private final List<String> externallyProvided = new ArrayList<>();
   private String method;
   private boolean wired;
   private boolean requestScope;
@@ -229,4 +229,7 @@ void setMethod(String method) {
     this.method = method;
   }
 
+  void externallyProvided(String dependency) {
+    externallyProvided.add(dependency);
+  }
 }

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

@@ -11,21 +11,17 @@ class MetaDataOrdering {
       "\n See https://avaje.io/inject/#circular";
 
   private final ProcessingContext context;
-
+  private final ScopeInfo scopeInfo;
   private final List<MetaData> orderedList = new ArrayList<>();
   private final List<MetaData> requestScope = new ArrayList<>();
   private final List<MetaData> queue = new ArrayList<>();
-
   private final Map<String, ProviderList> providers = new HashMap<>();
-
   private final List<DependencyLink> circularDependencies = new ArrayList<>();
-
   private final Set<String> missingDependencyTypes = new LinkedHashSet<>();
 
-  private String topPackage;
-
-  MetaDataOrdering(Collection<MetaData> values, ProcessingContext context) {
+  MetaDataOrdering(Collection<MetaData> values, ProcessingContext context, ScopeInfo scopeInfo) {
     this.context = context;
+    this.scopeInfo = scopeInfo;
     for (MetaData metaData : values) {
       if (metaData.isRequestScope()) {
         // request scoped expected to have externally provided dependencies
@@ -37,21 +33,20 @@ class MetaDataOrdering {
       } else {
         queue.add(metaData);
       }
-      topPackage = Util.commonParent(topPackage, metaData.getTopPackage());
       // register into map keyed by provider
       providers.computeIfAbsent(metaData.getType(), s -> new ProviderList()).add(metaData);
       for (String provide : metaData.getProvides()) {
         providers.computeIfAbsent(provide, s -> new ProviderList()).add(metaData);
       }
     }
-    externallyRequiredDependencies(context);
+    externallyRequiredDependencies();
   }
 
   /**
    * These if defined are expected to be required at wiring time probably via another module.
    */
-  private void externallyRequiredDependencies(ProcessingContext context) {
-    for (String requireType : context.contextRequires()) {
+  private void externallyRequiredDependencies() {
+    for (String requireType : scopeInfo.requires()) {
       providers.computeIfAbsent(requireType, s -> new ProviderList());
     }
   }
@@ -120,32 +115,38 @@ private void errorOnCircularDependencies() {
    * Build list of specific dependencies that are missing.
    */
   void missingDependencies() {
-    for (MetaData m : queue) {
-      for (String dependency : m.getDependsOn()) {
-        if (providers.get(dependency) == null) {
-          TypeElement element = context.elementMaybe(m.getType());
-          context.logError(element, "No dependency provided for " + dependency);
-          missingDependencyTypes.add(dependency);
-        }
-      }
+    for (MetaData metaData : queue) {
+      checkMissingDependencies(metaData);
     }
     if (missingDependencyTypes.isEmpty()) {
       // only look for circular dependencies if there are no missing dependencies
       detectCircularDependency(queue);
     }
   }
 
+  private void checkMissingDependencies(MetaData metaData) {
+    for (String dependency : metaData.getDependsOn()) {
+      if (providers.get(dependency) == null && !scopeInfo.providedByOtherModule(dependency)) {
+        TypeElement element = context.elementMaybe(metaData.getType());
+        context.logError(element, "No dependency provided for " + dependency + " on " + metaData.getType());
+        missingDependencyTypes.add(dependency);
+      }
+    }
+  }
+
   /**
    * Log a warning on unsatisfied dependencies that are expected to be provided by another module.
    */
   private void warnOnDependencies() {
-    if (missingDependencyTypes.isEmpty()) {
-      context.logWarn("There are " + queue.size() + " beans with unsatisfied dependencies (assuming external dependencies)");
-      for (MetaData m : queue) {
-        context.logWarn("Unsatisfied dependencies on %s dependsOn %s", m, m.getDependsOn());
-      }
-    } else {
+    if (!missingDependencyTypes.isEmpty()) {
       context.logError("Dependencies %s are not provided - missing @Singleton or @Factory/@Bean or specify external dependency via @InjectModule requires attribute", missingDependencyTypes);
+    } else {
+      if (!queue.isEmpty()) {
+        context.logWarn("There are " + queue.size() + " beans with unsatisfied dependencies (assuming external dependencies)");
+        for (MetaData m : queue) {
+          context.logWarn("Unsatisfied dependencies on %s dependsOn %s", m, m.getDependsOn());
+        }
+      }
     }
   }
 
@@ -157,10 +158,6 @@ void logWarnings() {
     }
   }
 
-  String getTopPackage() {
-    return topPackage;
-  }
-
   private int processQueueRound() {
     // loop queue looking for entry that has all provides marked as included
     int count = 0;
@@ -183,8 +180,7 @@ private boolean allDependenciesWired(MetaData queuedMeta) {
         // check non-provider dependency is satisfied
         ProviderList providerList = providers.get(dependency);
         if (providerList == null) {
-          // dependency not yet satisfied
-          return false;
+          return scopeInfo.providedByOtherModule(dependency);
         } else {
           if (!providerList.isAllWired()) {
             return false;

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

@@ -0,0 +1,22 @@
+package io.avaje.inject.generator;
+
+import java.util.Collection;
+
+class MetaTopPackage {
+
+  private String topPackage;
+
+  static String of(Collection<MetaData> values) {
+    return new MetaTopPackage(values).value();
+  }
+
+  private String value() {
+    return topPackage;
+  }
+
+  private MetaTopPackage(Collection<MetaData> values) {
+    for (MetaData metaData : values) {
+      topPackage = Util.commonParent(topPackage, metaData.getTopPackage());
+    }
+  }
+}