#60 - Validation for bean params for controller class @get method

Author: rbygrave

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

@@ -12,6 +12,7 @@
 
 import javax.lang.model.element.Element;
 import javax.lang.model.element.TypeElement;
+import javax.validation.Valid;
 
 public class ElementReader {
 
@@ -179,8 +180,16 @@ void buildApiDocumentation(MethodDocBuilder methodDoc) {
 
   void writeValidate(Append writer) {
     if (!isPlatformContext() && typeHandler == null) {
-      writer.append("validator.validate(%s);", varName).eol();
-      writer.append("      ");
+      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("      ");
+      }
     }
   }
 

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

@@ -233,7 +233,7 @@ public String getFullPath() {
   }
 
   public boolean includeValidate() {
-    return bean.isIncludeValidator() && webMethod != WebMethod.GET;
+    return bean.isIncludeValidator();
   }
 
   public String simpleName() {

tests/test-javalin/src/main/java/org/example/myapp/web/GetBeanForm.java

@@ -0,0 +1,29 @@
+package org.example.myapp.web;
+
+import javax.validation.Valid;
+import javax.validation.constraints.Email;
+import javax.validation.constraints.NotNull;
+import javax.validation.constraints.Size;
+
+@Valid
+public class GetBeanForm {
+
+  @NotNull @Size(min = 2, max = 150)
+  String name;
+
+  @Email @Size(max = 100)
+  String email;
+
+  public GetBeanForm(String name, String email) {
+    this.name = name;
+    this.email = email;
+  }
+
+  @Override
+  public String toString() {
+    return "HelloForm{" +
+      "name='" + name + '\'' +
+      ", email='" + email + '\'' +
+      '}';
+  }
+}

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

@@ -1,20 +1,12 @@
 package org.example.myapp.web;
 
-import io.avaje.http.api.Controller;
-import io.avaje.http.api.Default;
-import io.avaje.http.api.Delete;
-import io.avaje.http.api.Form;
-import io.avaje.http.api.Get;
-import io.avaje.http.api.MediaType;
-import io.avaje.http.api.Path;
-import io.avaje.http.api.Post;
-import io.avaje.http.api.Produces;
-import io.avaje.http.api.QueryParam;
+import io.avaje.http.api.*;
 import io.javalin.http.Context;
 import io.swagger.v3.oas.annotations.Hidden;
 import org.example.myapp.service.MyService;
 
 import jakarta.inject.Inject;
+
 import javax.validation.Valid;
 import java.time.LocalDate;
 import java.util.ArrayList;
@@ -126,6 +118,12 @@ HelloDto saveForm3(HelloForm helloForm) {
     return new HelloDto(52, helloForm.name, helloForm.email);
   }
 
+  @Produces("text/plain")
+  @Get("withValidBean")
+  String getGetBeanForm(@BeanParam GetBeanForm bean) {
+    return "ok name:" + bean.name;
+  }
+
   @Hidden
   @Get
   List<HelloDto> getAll() {

tests/test-javalin/src/test/java/org/example/myapp/HelloControllerTest.java

@@ -41,6 +41,7 @@ class HelloControllerTest extends BaseWebTest {
       .with(httpClient)
       .build();
   }
+
   @Test
   void hello() {
     final Response response = get(baseUrl + "/hello/message");
@@ -214,9 +215,9 @@ void postForm_validation_expect_badRequest() {
         .asVoid();
 
     } catch (HttpException e) {
-      assertEquals(422, e.getStatusCode());
+      assertEquals(422, e.statusCode());
 
-      final HttpResponse<?> httpResponse = e.getHttpResponse();
+      final HttpResponse<?> httpResponse = e.httpResponse();
       assertNotNull(httpResponse);
       assertEquals(422, httpResponse.statusCode());
 
@@ -229,6 +230,29 @@ void postForm_validation_expect_badRequest() {
     }
   }
 
+  @Test
+  void get_validate_bean_expect422() {
+    final HttpResponse<String> hres = clientContext.request()
+      .path("hello/withValidBean")
+      .queryParam("email", "user@foo.com")
+      .GET()
+      .asString();
+
+    assertThat(hres.statusCode()).isEqualTo(422);
+  }
+
+  @Test
+  void get_validate_bean_expect200() {
+    final HttpResponse<String> hres = clientContext.request()
+      .path("hello/withValidBean")
+      .queryParam("name", "hello")
+      .queryParam("email", "user@foo.com")
+      .GET()
+      .asString();
+
+    assertThat(hres.statusCode()).isEqualTo(200);
+  }
+
   @Test
   void delete() {
     given().delete(baseUrl + "/hello/52")