#42 - Support @Valid per methods rather than per controller

Author: rbygrave

http-generator-core/src/main/java/io/avaje/http/generator/core/ControllerReader.java

@@ -26,33 +26,25 @@
 public class ControllerReader {
 
   private final ProcessingContext ctx;
-
   private final TypeElement beanType;
-
   private final List<Element> interfaces;
-
   private final List<ExecutableElement> interfaceMethods;
-
   private final List<String> roles;
-
   private final List<MethodReader> methods = new ArrayList<>();
-
   private final Set<String> staticImportTypes = new TreeSet<>();
-
   private final Set<String> importTypes = new TreeSet<>();
 
   /**
    * The produces media type for the controller. Null implies JSON.
    */
   private final String produces;
-
-  private final boolean includeValidator;
+  private final boolean hasValid;
+  private boolean methodHasValid;
 
   /**
    * Flag set when the controller is dependant on a request scope type.
    */
   private boolean requestScope;
-
   private boolean docHidden;
 
   public ControllerReader(TypeElement beanType, ProcessingContext ctx) {
@@ -64,14 +56,14 @@ public ControllerReader(TypeElement beanType, ProcessingContext ctx) {
     if (ctx.isOpenApiAvailable()) {
       docHidden = initDocHidden();
     }
-    includeValidator = initIncludeValidator();
+    this.hasValid = initHasValid();
     this.produces = initProduces();
   }
 
   protected void addImports(boolean withSingleton) {
     importTypes.add(Constants.IMPORT_HTTP_API);
     importTypes.add(beanType.getQualifiedName().toString());
-    if (includeValidator) {
+    if (hasValid || methodHasValid) {
       importTypes.add(Constants.VALIDATOR);
     }
     if (withSingleton) {
@@ -137,7 +129,7 @@ private boolean initDocHidden() {
     return findAnnotation(Hidden.class) != null;
   }
 
-  private boolean initIncludeValidator() {
+  private boolean initHasValid() {
     return findAnnotation(Valid.class) != null;
   }
 
@@ -154,7 +146,11 @@ public boolean isDocHidden() {
   }
 
   public boolean isIncludeValidator() {
-    return includeValidator;
+    return hasValid || methodHasValid;
+  }
+
+  public boolean hasValid() {
+    return hasValid;
   }
 
   /**
@@ -166,7 +162,6 @@ boolean isRequestScoped() {
   }
 
   public void read(boolean withSingleton) {
-    addImports(withSingleton);
     if (!roles.isEmpty()) {
       ctx.platform().controllerRoles(roles, this);
     }
@@ -178,6 +173,21 @@ public void read(boolean withSingleton) {
       }
     }
     readSuper(beanType);
+    deriveIncludeValidation();
+    addImports(withSingleton);
+  }
+
+  private void deriveIncludeValidation() {
+    methodHasValid = methodHasValid();
+  }
+
+  private boolean methodHasValid() {
+    for (MethodReader method : methods) {
+      if (method.hasValid()) {
+        return true;
+      }
+    }
+    return false;
   }
 
   private void readField(Element element) {
@@ -215,13 +225,11 @@ private void readMethod(ExecutableElement element) {
   }
 
   private void readMethod(ExecutableElement method, DeclaredType declaredType) {
-
     ExecutableType actualExecutable = null;
     if (declaredType != null) {
       // actual taking into account generics
       actualExecutable = (ExecutableType) ctx.asMemberOf(declaredType, method);
     }
-
     MethodReader methodReader = new MethodReader(this, method, actualExecutable, ctx);
     if (methodReader.isWebMethod()) {
       methodReader.read();

http-generator-core/src/main/java/io/avaje/http/generator/core/ElementReader.java

@@ -1,12 +1,6 @@
 package io.avaje.http.generator.core;
 
-import io.avaje.http.api.BeanParam;
-import io.avaje.http.api.Cookie;
-import io.avaje.http.api.Default;
-import io.avaje.http.api.Form;
-import io.avaje.http.api.FormParam;
-import io.avaje.http.api.Header;
-import io.avaje.http.api.QueryParam;
+import io.avaje.http.api.*;
 import io.avaje.http.generator.core.openapi.MethodDocBuilder;
 import io.avaje.http.generator.core.openapi.MethodParamDocBuilder;
 
@@ -26,6 +20,7 @@ public class ElementReader {
   private final String snakeName;
   private final boolean formMarker;
   private final boolean contextType;
+  private final boolean useValidation;
 
   private String paramName;
   private ParamType paramType;
@@ -53,11 +48,21 @@ public class ElementReader {
     this.paramName = varName;
     if (!contextType) {
       readAnnotations(element, defaultType);
+      useValidation = useValidation();
     } else {
       paramType = ParamType.CONTEXT;
+      useValidation = false;
     }
   }
 
+  private boolean useValidation() {
+    if (typeHandler != null) {
+      return false;
+    }
+    TypeElement elementType = ctx.getTypeElement(rawType);
+    return elementType != null && elementType.getAnnotation(Valid.class) != null;
+  }
+
   private void readAnnotations(Element element, ParamType defaultType) {
 
     notNullKotlin = (element.getAnnotation(org.jetbrains.annotations.NotNull.class) != null);
@@ -179,17 +184,13 @@ void buildApiDocumentation(MethodDocBuilder methodDoc) {
   }
 
   void writeValidate(Append writer) {
-    if (!isPlatformContext() && typeHandler == null) {
-      TypeElement formBeanType = ctx.getTypeElement(rawType);
-      if (formBeanType != null) {
-        final Valid valid = formBeanType.getAnnotation(Valid.class);
-        if (valid != null) {
-          writer.append("validator.validate(%s);", varName).eol();
-        } else {
-          writer.append("// no validation required on %s", varName).eol();
-        }
-        writer.append("      ");
+    if (!contextType && typeHandler == null) {
+      if (useValidation) {
+        writer.append("validator.validate(%s);", varName).eol();
+      } else {
+        writer.append("// no validation required on %s", varName).eol();
       }
+      writer.append("      ");
     }
   }
 

http-generator-core/src/main/java/io/avaje/http/generator/core/MethodReader.java

@@ -18,6 +18,7 @@
 import javax.lang.model.type.ExecutableType;
 import javax.lang.model.type.TypeKind;
 import javax.lang.model.type.TypeMirror;
+import javax.validation.Valid;
 import java.lang.annotation.Annotation;
 import java.util.ArrayList;
 import java.util.List;
@@ -49,6 +50,7 @@ public class MethodReader {
   private final List<? extends TypeMirror> actualParams;
 
   private final PathSegments pathSegments;
+  private final boolean hasValid;
 
   MethodReader(ControllerReader bean, ExecutableElement element, ExecutableType actualExecutable, ProcessingContext ctx) {
     this.ctx = ctx;
@@ -60,11 +62,12 @@ public class MethodReader {
     this.methodRoles = Util.findRoles(element);
     this.javadoc = Javadoc.parse(ctx.getDocComment(element));
     this.produces = produces(bean);
-
     initWebMethodViaAnnotation();
     if (isWebMethod()) {
+      this.hasValid = findAnnotation(Valid.class) != null;
       this.pathSegments = PathSegments.parse(Util.combinePath(bean.getPath(), webMethodPath));
     } else {
+      this.hasValid = false;
       this.pathSegments = null;
     }
   }
@@ -233,7 +236,11 @@ public String getFullPath() {
   }
 
   public boolean includeValidate() {
-    return bean.isIncludeValidator();
+    return bean.hasValid() || hasValid;
+  }
+
+  boolean hasValid() {
+    return hasValid;
   }
 
   public String simpleName() {

tests/test-javalin/src/main/resources/public/openapi.json

@@ -482,6 +482,32 @@
         }
       }
     },
+    "/hello/withValidBean" : {
+      "get" : {
+        "tags" : [ ],
+        "summary" : "",
+        "description" : "",
+        "parameters" : [ {
+          "name" : "bean",
+          "in" : "bean",
+          "schema" : {
+            "$ref" : "#/components/schemas/GetBeanForm"
+          }
+        } ],
+        "responses" : {
+          "200" : {
+            "description" : "",
+            "content" : {
+              "text/plain" : {
+                "schema" : {
+                  "type" : "string"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/hello/{id}" : {
       "delete" : {
         "tags" : [ ],
@@ -602,6 +628,22 @@
           }
         }
       },
+      "GetBeanForm" : {
+        "type" : "object",
+        "properties" : {
+          "name" : {
+            "maxLength" : 150,
+            "minLength" : 2,
+            "type" : "string",
+            "nullable" : false
+          },
+          "email" : {
+            "maxLength" : 100,
+            "type" : "string",
+            "format" : "email"
+          }
+        }
+      },
       "HelloDto" : {
         "type" : "object",
         "properties" : {

tests/test-jex/src/main/java/org/example/Main.java

@@ -1,10 +1,14 @@
 package org.example;
 
+import io.avaje.http.api.ValidationException;
 import io.avaje.inject.ApplicationScope;
 import io.avaje.inject.BeanScope;
 import io.avaje.jex.Jex;
 import io.avaje.jex.Routing;
 
+import java.util.LinkedHashMap;
+import java.util.Map;
+
 public class Main {
 
   public static void main(String[] args) {
@@ -18,6 +22,15 @@ public static Jex.Server start(int port) {
   public static Jex.Server start(int port, BeanScope context) {
     final Jex jex = Jex.create();
     jex.routing().addAll(context.list(Routing.Service.class));
+
+    jex.exception(ValidationException.class, (exception, ctx) -> {
+      Map<String, Object> map = new LinkedHashMap<>();
+      map.put("message", exception.getMessage());
+      map.put("errors", exception.getErrors());
+      ctx.status(exception.getStatus());
+      ctx.json(map);
+    });
+
     return jex.port(port).start();
   }
 }

tests/test-jex/src/main/java/org/example/web/HelloController.java

@@ -1,11 +1,10 @@
 package org.example.web;
 
-import io.avaje.http.api.Controller;
-import io.avaje.http.api.Get;
-import io.avaje.http.api.Path;
-import io.avaje.http.api.Produces;
+import io.avaje.http.api.*;
 import io.avaje.jex.Context;
 
+import javax.validation.Valid;
+
 // @Roles(AppRoles.BASIC_USER)
 @Controller
 @Path("/")
@@ -37,4 +36,10 @@ String name(String name) {
   String splat(String name, Context ctx) {
     return "got name:" + name + " splat0:" + ctx.splat(0) + " splat1:" + ctx.splat(1);
   }
+
+  @Valid
+  @Put
+  void put(HelloDto dto) {
+    dto.hashCode();
+  }
 }

tests/test-jex/src/main/java/org/example/web/HelloDto.java

@@ -1,6 +1,11 @@
 package org.example.web;
 
+import javax.validation.Valid;
+import javax.validation.constraints.NotNull;
+
+@Valid
 public class HelloDto {
   public int id;
+  @NotNull
   public String name;
 }

tests/test-jex/src/main/resources/public/openapi.json

@@ -22,6 +22,26 @@
             }
           }
         }
+      },
+      "put" : {
+        "tags" : [ ],
+        "summary" : "",
+        "description" : "",
+        "requestBody" : {
+          "content" : {
+            "application/json" : {
+              "schema" : {
+                "$ref" : "#/components/schemas/HelloDto"
+              }
+            }
+          },
+          "required" : true
+        },
+        "responses" : {
+          "204" : {
+            "description" : "No content"
+          }
+        }
       }
     },
     "/other/{name}" : {

tests/test-jex/src/test/java/org/example/web/BaseWebTest.java

@@ -9,6 +9,8 @@
 import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.BeforeAll;
 
+import java.time.Duration;
+
 public class BaseWebTest {
 
   static Jex.Server webServer;
@@ -29,6 +31,7 @@ public static void shutdown() {
   public static HttpClientContext client() {
     return HttpClientContext.newBuilder()
       .withBaseUrl(baseUrl)
+      .withRequestTimeout(Duration.ofMinutes(2))
       .withRequestListener(new RequestLogger())
       .withBodyAdapter(new JacksonBodyAdapter(new ObjectMapper()))
       .build();