#36 - Support @Inject of Javalin Context and Helidon ServerRequest/ServerResponse

Author: rbygrave

generator-core/src/main/java/io/dinject/webroutegen/BaseControllerWriter.java

@@ -30,6 +30,10 @@ public BaseControllerWriter(ControllerReader reader, ProcessingContext ctx) thro
     initWriter();
   }
 
+  protected boolean isRequestScoped() {
+    return reader.isRequestScoped();
+  }
+
   protected String initPackageName(String originName) {
     int dp = originName.lastIndexOf('.');
     return dp > -1 ? originName.substring(0, dp) : null;

generator-core/src/main/java/io/dinject/webroutegen/ControllerReader.java

@@ -46,10 +46,15 @@ class ControllerReader {
    */
   private final String produces;
 
-  private boolean docHidden;
-
   private final boolean includeValidator;
 
+  /**
+   * Flag set when the controller is dependant on a request scope type.
+   */
+  private boolean requestScope;
+
+  private boolean docHidden;
+
   ControllerReader(TypeElement beanType, ProcessingContext ctx) {
     this.beanType = beanType;
     this.ctx = ctx;
@@ -70,14 +75,11 @@ class ControllerReader {
     if (includeValidator) {
       importTypes.add(Constants.VALIDATOR);
     }
-
     this.produces = initProduces();
   }
 
   private List<Element> initInterfaces() {
-
     List<Element> interfaces = new ArrayList<>();
-
     for (TypeMirror anInterface : beanType.getInterfaces()) {
       final Element ifaceElement = ctx.asElement(anInterface);
       if (ifaceElement.getAnnotation(Path.class) != null) {
@@ -88,7 +90,6 @@ private List<Element> initInterfaces() {
   }
 
   private List<ExecutableElement> initInterfaceMethods() {
-
     List<ExecutableElement> ifaceMethods = new ArrayList<>();
     for (Element anInterface : interfaces) {
       ifaceMethods.addAll(ElementFilter.methodsIn(anInterface.getEnclosedElements()));
@@ -111,7 +112,6 @@ private <A extends Annotation> A findAnnotation(Class<A> type) {
   }
 
   <A extends Annotation> A findMethodAnnotation(Class<A> type, ExecutableElement element) {
-
     for (ExecutableElement interfaceMethod : interfaceMethods) {
       if (matchMethod(interfaceMethod, element)) {
         final A annotation = interfaceMethod.getAnnotation(type);
@@ -120,7 +120,6 @@ <A extends Annotation> A findMethodAnnotation(Class<A> type, ExecutableElement e
         }
       }
     }
-
     return null;
   }
 
@@ -157,34 +156,49 @@ boolean isIncludeValidator() {
     return includeValidator;
   }
 
+  /**
+   * Return true if the controller has request scoped dependencies.
+   * In that case a BeanFactory will have been generated.
+   */
+  boolean isRequestScoped() {
+    return requestScope;
+  }
+
   void read() {
     if (!roles.isEmpty()) {
       ctx.platform().controllerRoles(roles, this);
     }
-
     for (Element element : beanType.getEnclosedElements()) {
       if (element.getKind() == ElementKind.METHOD) {
         readMethod((ExecutableElement) element);
+      } else if (element.getKind() == ElementKind.FIELD) {
+        readField(element);
       }
     }
-
     readSuper(beanType);
   }
 
+  private void readField(Element element) {
+    if (!requestScope) {
+      final String rawType = element.asType().toString();
+      requestScope = RequestScopeTypes.isRequestType(rawType);
+    }
+  }
+
   /**
    * Read methods from superclasses taking into account generics.
    */
   private void readSuper(TypeElement beanType) {
-
     TypeMirror superclass = beanType.getSuperclass();
     if (superclass.getKind() != TypeKind.NONE) {
       DeclaredType declaredType = (DeclaredType) superclass;
-
       final Element superElement = ctx.asElement(superclass);
       if (!"java.lang.Object".equals(superElement.toString())) {
         for (Element element : superElement.getEnclosedElements()) {
           if (element.getKind() == ElementKind.METHOD) {
             readMethod((ExecutableElement) element, declaredType);
+          } else if (element.getKind() == ElementKind.FIELD) {
+            readField(element);
           }
         }
         if (superElement instanceof TypeElement) {

generator-core/src/main/java/io/dinject/webroutegen/RequestScopeTypes.java

@@ -0,0 +1,25 @@
+package io.dinject.webroutegen;
+
+import java.util.HashSet;
+import java.util.Set;
+
+class RequestScopeTypes {
+
+  private static final String JAVALIN_CONTEXT = "io.javalin.http.Context";
+  private static final String HELIDON_REQ = "io.helidon.webserver.ServerRequest";
+  private static final String HELIDON_RES = "io.helidon.webserver.ServerResponse";
+  private static final Set<String> TYPES = new HashSet<>();
+
+  static {
+    TYPES.add(JAVALIN_CONTEXT);
+    TYPES.add(HELIDON_REQ);
+    TYPES.add(HELIDON_RES);
+  }
+
+  /**
+   * Return true if the type is a request scoped type.
+   */
+  static boolean isRequestType(String rawType) {
+    return TYPES.contains(rawType);
+  }
+}

generator-helidon/src/main/java/io/dinject/webroutegen/ControllerMethodWriter.java

@@ -33,7 +33,7 @@ void writeRule() {
     }
   }
 
-  void writeHandler() {
+  void writeHandler(boolean requestScoped) {
     writer.append("  private void _%s(ServerRequest req, ServerResponse res", method.simpleName());
     final String bodyType = method.getBodyType();
     if (bodyType != null) {
@@ -66,8 +66,11 @@ void writeHandler() {
         param.writeValidate(writer);
       }
     }
-
-    writer.append("controller.");
+    if (requestScoped) {
+      writer.append("factory.create(req, res).");
+    } else {
+      writer.append("controller.");
+    }
     writer.append(method.simpleName()).append("(");
     for (int i = 0; i < params.size(); i++) {
       if (i > 0) {
@@ -81,22 +84,6 @@ void writeHandler() {
     }
     writer.append(";").eol();
     writer.append("  }").eol().eol();
-
-//    List<String> roles = method.roles();
-//    if (!roles.isEmpty()) {
-//      writer.append(", roles(");
-//      for (int i = 0; i < roles.size(); i++) {
-//        if (i > 0) {
-//          writer.append(", ");
-//        }
-//        writer.append(Util.shortName(roles.get(i)));
-//      }
-//      writer.append(")");
-//    }
-//    writer.append(");").eol().eol();
-
-//    writer.append("    res.send(\"Hello\");").eol();
-//    writer.append("  }").eol();
   }
 
   private void writeContextReturn() {

generator-helidon/src/main/java/io/dinject/webroutegen/ControllerWriter.java

@@ -40,7 +40,7 @@ private void writeAddRoutes() {
     final List<ControllerMethodWriter> methods = getWriterMethods();
     writeRoutes(methods);
     for (ControllerMethodWriter methodWriter : methods) {
-      writeHandlerMethod(methodWriter);
+      methodWriter.writeHandler(isRequestScoped());
     }
   }
 
@@ -56,29 +56,31 @@ private void writeRoutes(List<ControllerMethodWriter> methods) {
     writer.append("  }").eol().eol();
   }
 
-  private void writeHandlerMethod(ControllerMethodWriter methodWriter) {
-    methodWriter.writeHandler();
-  }
-
   private void writeClassStart() {
     if (ctx.isGeneratedAvailable()) {
       writer.append(AT_GENERATED).eol();
     }
     writer.append("@Singleton").eol();
     writer.append("public class ").append(shortName).append("$route implements Service {").eol().eol();
 
-    writer.append(" private final %s controller;", shortName).eol();
+    String controllerName = "controller";
+    String controllerType = shortName;
+    if (isRequestScoped()) {
+      controllerName = "factory";
+      controllerType += "$factory";
+    }
+    writer.append(" private final %s %s;", controllerType, controllerName).eol();
     if (reader.isIncludeValidator()) {
       writer.append(" private final Validator validator;").eol();
     }
     writer.eol();
 
-    writer.append(" public %s$route(%s controller", shortName, shortName);
+    writer.append(" public %s$route(%s %s", shortName, controllerType, controllerName);
     if (reader.isIncludeValidator()) {
       writer.append(", Validator validator");
     }
     writer.append(") {").eol();
-    writer.append("   this.controller = controller;").eol();
+    writer.append("   this.%s = %s;", controllerName, controllerName).eol();
     if (reader.isIncludeValidator()) {
       writer.append("   this.validator = validator;").eol();
     }

generator-javalin/src/main/java/io/dinject/webroutegen/ControllerMethodWriter.java

@@ -21,7 +21,7 @@ class ControllerMethodWriter {
     this.ctx = ctx;
   }
 
-  void write() {
+  void write(boolean requestScoped) {
 
     final PathSegments segments = method.getPathSegments();
     final String fullPath = segments.fullPath();
@@ -48,7 +48,11 @@ void write() {
       writeContextReturn();
     }
 
-    writer.append("controller.");
+    if (requestScoped) {
+      writer.append("factory.create(ctx).");
+    } else {
+      writer.append("controller.");
+    }
     writer.append(method.simpleName()).append("(");
     for (int i = 0; i < params.size(); i++) {
       if (i > 0) {

generator-javalin/src/main/java/io/dinject/webroutegen/ControllerWriter.java

@@ -35,7 +35,7 @@ private void writeAddRoutes() {
   }
 
   private void writeForMethod(MethodReader method) {
-    new ControllerMethodWriter(method, writer, ctx).write();
+    new ControllerMethodWriter(method, writer, ctx).write(isRequestScoped());
     if (!reader.isDocHidden()) {
       method.buildApiDocumentation(ctx);
     }
@@ -48,18 +48,25 @@ private void writeClassStart() {
     writer.append("@Singleton").eol();
     writer.append("public class ").append(shortName).append("$route implements WebRoutes {").eol().eol();
 
-    writer.append(" private final %s controller;", shortName).eol();
+    String controllerName = "controller";
+    String controllerType = shortName;
+    if (isRequestScoped()) {
+      controllerName = "factory";
+      controllerType += "$factory";
+    }
+    writer.append(" private final %s %s;", controllerType, controllerName).eol();
+
     if (reader.isIncludeValidator()) {
       writer.append(" private final Validator validator;").eol();
     }
     writer.eol();
 
-    writer.append(" public %s$route(%s controller", shortName, shortName);
+    writer.append(" public %s$route(%s %s", shortName, controllerType, controllerName);
     if (reader.isIncludeValidator()) {
       writer.append(", Validator validator");
     }
     writer.append(") {").eol();
-    writer.append("   this.controller = controller;").eol();
+    writer.append("   this.%s = %s;", controllerName, controllerName).eol();
     if (reader.isIncludeValidator()) {
       writer.append("   this.validator = validator;").eol();
     }

tests/test-helidon/pom.xml

@@ -17,7 +17,7 @@
   <properties>
     <mainClass>org.example.Main</mainClass>
     <helidon-version>2.0.1</helidon-version>
-    <dinject-version>2.2</dinject-version>
+    <dinject-version>2.3</dinject-version>
     <dinject-controller-version>1.22-SNAPSHOT</dinject-controller-version>
   </properties>
 
@@ -107,6 +107,12 @@
       <version>4.3.1</version>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>org.avaje.beta.http</groupId>
+      <artifactId>http-client</artifactId>
+      <version>0.1-SNAPSHOT</version>
+      <scope>test</scope>
+    </dependency>
 
   </dependencies>
 

tests/test-helidon/src/main/java/org/example/ReqScopedController.java

@@ -0,0 +1,27 @@
+package org.example;
+
+import io.dinject.controller.Controller;
+import io.dinject.controller.Get;
+import io.dinject.controller.Path;
+import io.dinject.controller.Produces;
+import io.helidon.webserver.ServerRequest;
+import io.helidon.webserver.ServerResponse;
+
+import javax.inject.Inject;
+
+@Controller
+@Path("/req-scoped")
+public class ReqScopedController {
+
+  @Inject
+  ServerRequest request;
+
+  @Inject
+  ServerResponse response;
+
+  @Produces("text/plain")
+  @Get
+  String getSimple() {
+    return request.uri().toString() + "-" + response.status();
+  }
+}

tests/test-helidon/src/test/java/org/example/BaseWebTest.java

@@ -1,5 +1,9 @@
 package org.example;
 
+import com.fasterxml.jackson.databind.ObjectMapper;
+import io.avaje.http.client.HttpClientContext;
+import io.avaje.http.client.JacksonBodyAdapter;
+import io.avaje.http.client.RequestLogger;
 import io.helidon.webserver.WebServer;
 import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.BeforeAll;
@@ -20,4 +24,13 @@ public static void init() {
   public static void shutdown() {
     webServer.shutdown();
   }
+
+  public static HttpClientContext client() {
+    return HttpClientContext.newBuilder()
+      .withBaseUrl(baseUrl)
+      .withRequestListener(new RequestLogger())
+      .withBodyAdapter(new JacksonBodyAdapter(new ObjectMapper()))
+      //.with(httpClient)
+      .build();
+  }
 }