#118 - Add compile error when @singleton has a @request scope dependency

Author: rbygrave

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

@@ -9,6 +9,7 @@
 
 class BeanReader {
 
+  private final ProcessingContext context;
   private final TypeElement beanType;
   private final String shortName;
   private final String type;
@@ -32,6 +33,7 @@ class BeanReader {
 
   BeanReader(TypeElement beanType, ProcessingContext context, boolean factory) {
     this.beanType = beanType;
+    this.context = context;
     this.type = beanType.getQualifiedName().toString();
     this.shortName = shortName(beanType);
     this.primary = (beanType.getAnnotation(Primary.class) != null);
@@ -40,7 +42,7 @@ class BeanReader {
 
     typeReader.process();
     this.requestScopedBean = typeReader.isRequestScopeBean();
-    this.requestParams = new BeanRequestParams(type, requestScopedBean);
+    this.requestParams = new BeanRequestParams(context, type, requestScopedBean);
     this.name = typeReader.getName();
     this.injectMethods = typeReader.getInjectMethods();
     this.injectFields = typeReader.getInjectFields();
@@ -146,6 +148,9 @@ 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,22 +1,36 @@
 package io.avaje.inject.generator;
 
+import io.avaje.inject.Request;
+
+import javax.lang.model.element.TypeElement;
 import java.util.Set;
 
 /**
  * Holds detection and details of request scoped dependencies.
  */
 class BeanRequestParams {
 
+  private final ProcessingContext context;
   private final String parentType;
   private final boolean requestScopedBean;
 
   private RequestScope.Handler reqScopeHandler;
+  private String requestParamType;
 
-  BeanRequestParams(String parentType, boolean requestScopedBean) {
+  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).
    */
@@ -31,6 +45,14 @@ 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/MetaData.java

@@ -20,6 +20,7 @@ class MetaData {
 
   private String method;
   private boolean wired;
+  private boolean requestScope;
 
   /**
    * The interfaces and class annotations the bean has (to register into lists).
@@ -32,6 +33,7 @@ class MetaData {
   private List<String> dependsOn;
 
   MetaData(DependencyMeta meta) {
+    this.requestScope = meta.requestScope();
     this.type = meta.type();
     this.name = trimName(meta.name());
     this.shortType = Util.shortName(type);
@@ -101,6 +103,7 @@ private List<String> asList(String[] content) {
   }
 
   void update(BeanReader beanReader) {
+    this.requestScope = beanReader.isRequestScopedBean();
     this.provides = beanReader.getInterfaces();
     this.dependsOn = beanReader.getDependsOn();
   }
@@ -109,6 +112,10 @@ String getType() {
     return type;
   }
 
+  boolean isRequestScope() {
+    return requestScope;
+  }
+
   List<String> getProvides() {
     return provides;
   }
@@ -149,6 +156,9 @@ String buildMethod(MetaDataOrdering ordering) {
 
     StringBuilder sb = new StringBuilder(200);
     sb.append("  @DependencyMeta(type=\"").append(type).append("\"");
+    if (requestScope) {
+      sb.append(", requestScope=true");
+    }
     if (name != null) {
       sb.append(", name=\"").append(name).append("\"");
     }

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

@@ -16,7 +16,7 @@ class MetaDataOrdering {
   private final ProcessingContext context;
 
   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<>();
@@ -32,7 +32,11 @@ class MetaDataOrdering {
     this.context = context;
 
     for (MetaData metaData : values) {
-      if (metaData.noDepends()) {
+      if (metaData.isRequestScope()) {
+        // request scoped expected to have externally provided dependencies
+        requestScope.add(metaData);
+        metaData.setWired();
+      } else if (metaData.noDepends()) {
         orderedList.add(metaData);
         metaData.setWired();
       } else {
@@ -46,12 +50,10 @@ class MetaDataOrdering {
         providers.computeIfAbsent(provide, s -> new ProviderList()).add(metaData);
       }
     }
-
     // order no dependency list by ... name asc (order does not matter but for consistency)
   }
 
   int processQueue() {
-
     int count;
     do {
       count = processQueueRound();
@@ -159,11 +161,8 @@ String getTopPackage() {
   }
 
   private int processQueueRound() {
-
     // loop queue looking for entry that has all provides marked as included
-
     int count = 0;
-
     Iterator<MetaData> iterator = queue.iterator();
     while (iterator.hasNext()) {
       MetaData queuedMeta = iterator.next();
@@ -174,7 +173,6 @@ private int processQueueRound() {
         count++;
       }
     }
-
     return count;
   }
 
@@ -200,11 +198,18 @@ List<MetaData> getOrdered() {
     return orderedList;
   }
 
+  List<MetaData> getRequestScope() {
+    return requestScope;
+  }
+
   Set<String> getImportTypes() {
     Set<String> importTypes = new TreeSet<>();
     for (MetaData metaData : orderedList) {
       metaData.addImportTypes(importTypes);
     }
+    for (MetaData metaData : requestScope) {
+      metaData.addImportTypes(importTypes);
+    }
     return importTypes;
   }
 

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

@@ -153,11 +153,8 @@ private void readChangedBeans(Set<? extends Element> beans, boolean factory) {
    */
   private void mergeMetaData() {
     for (BeanReader beanReader : beanReaders) {
-      if (beanReader.isRequestScopedController()) {
-        context.logDebug("skipping request scoped processed bean " + beanReader);
-      } else {
-        String metaKey = beanReader.getMetaKey();
-        MetaData metaData = this.metaData.get(metaKey);
+      if (!beanReader.isRequestScopedController()) {
+        MetaData metaData = this.metaData.get(beanReader.getMetaKey());
         if (metaData == null) {
           addMeta(beanReader);
         } else {

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

@@ -4,6 +4,7 @@
 import javax.tools.JavaFileObject;
 import java.io.IOException;
 import java.io.Writer;
+import java.util.List;
 import java.util.Set;
 import java.util.TreeSet;
 
@@ -93,6 +94,9 @@ private void writeBuildMethods() {
     for (MetaData metaData : ordering.getOrdered()) {
       writer.append(metaData.buildMethod(ordering)).eol();
     }
+    for (MetaData metaData : ordering.getRequestScope()) {
+      writer.append(metaData.buildMethod(ordering)).eol();
+    }
   }
 
   private void writeCreateMethod() {
@@ -105,6 +109,14 @@ private void writeCreateMethod() {
     for (MetaData metaData : ordering.getOrdered()) {
       writer.append("    build_%s();", metaData.getBuildName()).eol();
     }
+    final List<MetaData> requestScope = ordering.getRequestScope();
+    if (!requestScope.isEmpty()) {
+      writer.eol();
+      writer.append("    // request scope providers").eol();
+      for (MetaData metaData : requestScope) {
+        writer.append("    build_%s();", metaData.getBuildName()).eol();
+      }
+    }
     writer.append("  }").eol();
     writer.eol();
   }

inject-test/src/test/java/org/example/requestscope/NotReqBean.java

@@ -0,0 +1,14 @@
+package org.example.requestscope;
+
+import jakarta.inject.Singleton;
+
+@Singleton
+public class NotReqBean {
+
+  //final MyReqThingWithContext myReq;
+
+  public NotReqBean() {//MyReqThingWithContext myReq) {
+    //this.myReq = myReq;
+  }
+
+}

inject/src/main/java/io/avaje/inject/spi/DependencyMeta.java

@@ -5,6 +5,11 @@
  */
 public @interface DependencyMeta {
 
+  /**
+   * Request scope
+   */
+  boolean requestScope() default false;
+
   /**
    * The bean type.
    */