#59 - Support use of @roles annotation with Jex + fix for Javalin use of @roles

Author: rbygrave

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

@@ -3,10 +3,13 @@
 import javax.lang.model.element.AnnotationMirror;
 import javax.lang.model.element.AnnotationValue;
 import javax.lang.model.element.Element;
+import javax.lang.model.element.VariableElement;
 import javax.lang.model.type.DeclaredType;
 import javax.lang.model.type.TypeKind;
 import javax.lang.model.type.TypeMirror;
+import javax.lang.model.util.SimpleAnnotationValueVisitor8;
 import java.util.ArrayList;
+import java.util.Collections;
 import java.util.List;
 
 public class Util {
@@ -20,7 +23,7 @@ public static UType parse(String rawType) {
       return new UType.Basic(rawType);
     } else {
       String mainType = rawType.substring(0, pos);
-      String genericParams = rawType.substring(pos+1, rawType.length()-1);
+      String genericParams = rawType.substring(pos + 1, rawType.length() - 1);
       List<String> params = parseGenericParams(genericParams);
       return new UType.Generic(rawType, mainType, params);
     }
@@ -141,24 +144,14 @@ public static String initcapSnake(String input) {
    * @param element The bean or method
    */
   public static List<String> findRoles(Element element) {
-
-    List<String> roles = new ArrayList<>();
-
     for (AnnotationMirror annotationMirror : element.getAnnotationMirrors()) {
-      DeclaredType annotationType = annotationMirror.getAnnotationType();
-      if (isRolesAnnotation(annotationType)) {
-        for (AnnotationValue value : annotationMirror.getElementValues().values()) {
-          String raw = value.toString();
-          if (raw.startsWith("{")) {
-            raw = raw.substring(1, raw.length() - 1);
-          }
-          for (String singleRole : raw.split(",")) {
-            roles.add(singleRole.trim());
-          }
+      if (isRolesAnnotation(annotationMirror.getAnnotationType())) {
+        for (AnnotationValue annotationValue : annotationMirror.getElementValues().values()) {
+          return annotationValue.accept(new RoleReader(), annotationValue);
         }
       }
     }
-    return roles;
+    return Collections.emptyList();
   }
 
   private static boolean isRolesAnnotation(DeclaredType annotationType) {
@@ -181,4 +174,23 @@ public static UType parseType(TypeMirror returnType) {
     }
     return parse(returnType.toString());//typeDef(returnType));
   }
+
+  private static class RoleReader extends SimpleAnnotationValueVisitor8<List<String>, Object> {
+
+    private final List<String> fullRoles = new ArrayList<>();
+
+    @Override
+    public List<String> visitArray(List<? extends AnnotationValue> values, Object o) {
+      for (AnnotationValue val : values) {
+        val.accept(this, o);
+      }
+      return fullRoles;
+    }
+
+    @Override
+    public List<String> visitEnumConstant(VariableElement roleEnum, Object o) {
+      fullRoles.add(roleEnum.asType() + "." + roleEnum.getSimpleName());
+      return fullRoles;
+    }
+  }
 }

http-generator-jex/src/main/java/io/avaje/http/generator/jex/ControllerMethodWriter.java

@@ -76,14 +76,13 @@ void write(boolean requestScoped) {
 
     List<String> roles = method.roles();
     if (!roles.isEmpty()) {
-      writer.append(", roles(");
+      writer.append(").withRoles(");
       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();
   }

http-generator-jex/src/main/java/io/avaje/http/generator/jex/JexAdapter.java

@@ -10,7 +10,6 @@
 class JexAdapter implements PlatformAdapter {
 
   static final String JEX_CONTEXT = "io.avaje.jex.Context";
-  //static final String JAVALIN3_ROLES = "io.javalin.core.security.SecurityUtil.roles";
 
   @Override
   public boolean isContextType(String rawType) {
@@ -39,20 +38,19 @@ public String indent() {
 
   @Override
   public void controllerRoles(List<String> roles, ControllerReader controller) {
-    //addRoleImports(roles, controller);
+    addRoleImports(roles, controller);
   }
 
   @Override
   public void methodRoles(List<String> roles, ControllerReader controller) {
-    //addRoleImports(roles, controller);
+    addRoleImports(roles, controller);
   }
 
-//  private void addRoleImports(List<String> roles, ControllerReader controller) {
-//    controller.addStaticImportType(JAVALIN3_ROLES);
-//    for (String role : roles) {
-//      controller.addStaticImportType(role);
-//    }
-//  }
+  private void addRoleImports(List<String> roles, ControllerReader controller) {
+    for (String role : roles) {
+      controller.addStaticImportType(role);
+    }
+  }
 
   @Override
   public void writeReadParameter(Append writer, ParamType paramType, String paramName) {

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

@@ -55,6 +55,7 @@ String getPlainMessage() {
    * @return The Hello DTO given the id and name.
    * @deprecated Please migrate away
    */
+  @Roles({AppRoles.ADMIN, AppRoles.BASIC_USER})
   @Get("/:id/:date")
   HelloDto hello(int id, LocalDate date, String otherParam) {
     return new HelloDto(id, date.toString(), otherParam);
@@ -63,10 +64,11 @@ HelloDto hello(int id, LocalDate date, String otherParam) {
   /**
    * Find Hellos by name.
    *
-   * @param name       The name to search for
+   * @param name    The name to search for
    * @param myParam My option parameter
    * @return The Hellos that we found.
    */
+  @Roles(AppRoles.ADMIN)
   @Get("/findbyname/{name}")
   List<HelloDto> findByName(String name, @QueryParam("my-param") @Default("one") String myParam) {
     return new ArrayList<>();

tests/test-jex/pom.xml

@@ -16,7 +16,7 @@
 
   <properties>
     <main.class>org.example.myapp.Main</main.class>
-    <jex.version>1.3</jex.version>
+    <jex.version>1.5</jex.version>
     <swagger.version>2.0.8</swagger.version>
     <jackson.version>2.12.3</jackson.version>
     <avaje-inject.version>6.0.RC3</avaje-inject.version>
@@ -52,7 +52,7 @@
     <dependency>
       <groupId>io.avaje</groupId>
       <artifactId>avaje-http-api</artifactId>
-      <version>1.2</version>
+      <version>${avaje-http.version}</version>
     </dependency>
 
     <dependency>
@@ -123,7 +123,7 @@
       <plugin>
         <groupId>io.repaint.maven</groupId>
         <artifactId>tiles-maven-plugin</artifactId>
-        <version>2.19</version>
+        <version>2.22</version>
         <extensions>true</extensions>
         <configuration>
           <tiles>

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

@@ -0,0 +1,8 @@
+package org.example.web;
+
+
+import io.avaje.jex.Role;
+
+public enum AppRoles implements Role {
+  ANYONE, ADMIN, BASIC_USER
+}

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

@@ -6,6 +6,7 @@
 import io.avaje.http.api.Produces;
 import io.avaje.jex.Context;
 
+// @Roles(AppRoles.BASIC_USER)
 @Controller
 @Path("/")
 public class HelloController {
@@ -24,6 +25,7 @@ String getText() {
     return "something";
   }
 
+  @Roles({AppRoles.ADMIN, AppRoles.BASIC_USER})
   @Produces("text/plain")
   @Get("other/{name}")
   String name(String name) {

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

@@ -0,0 +1,21 @@
+package org.example.web;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+import static java.lang.annotation.ElementType.METHOD;
+import static java.lang.annotation.ElementType.TYPE;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
+/**
+ * Specify permitted roles.
+ */
+@Target(value={METHOD, TYPE})
+@Retention(value=RUNTIME)
+public @interface Roles {
+
+  /**
+   * Specify the permitted roles.
+   */
+  AppRoles[] value() default {};
+}