Feature request: type-safe role annotations with enums fix #1527

jknack · jknack · commit 657769d5d4f9 · 2020-02-05T14:28:15.000-03:00
diff --git a/modules/jooby-apt/src/main/java/io/jooby/internal/apt/ModuleCompiler.java b/modules/jooby-apt/src/main/java/io/jooby/internal/apt/ModuleCompiler.java
@@ -273,7 +273,7 @@ private void setReturnType(MethodVisitor visitor, HandlerCompiler handler)
 
       List<TypeDefinition> args = returnType.getArguments();
 
-      ArrayWriter.write(visitor, java.lang.reflect.Type.class, args, type ->
+      ArrayWriter.write(visitor, java.lang.reflect.Type.class.getName(), args, type ->
           visitor.visitLdcInsn(type.toJvmType())
       );
 
@@ -295,7 +295,7 @@ private void setReturnType(MethodVisitor visitor, HandlerCompiler handler)
   private void setContentType(MethodVisitor visitor, String methodName, List<String> mediaTypes) {
     if (mediaTypes.size() > 0) {
       visitor.visitVarInsn(ALOAD, 2);
-      ArrayWriter.write(visitor, MediaType.class, mediaTypes, mediaType -> {
+      ArrayWriter.write(visitor, MediaType.class.getName(), mediaTypes, mediaType -> {
         visitor.visitLdcInsn(mediaType);
         visitor.visitMethodInsn(INVOKESTATIC, "io/jooby/MediaType", "valueOf",
             "(Ljava/lang/String;)Lio/jooby/MediaType;", false);
diff --git a/modules/jooby-apt/src/main/java/io/jooby/internal/apt/asm/ArrayWriter.java b/modules/jooby-apt/src/main/java/io/jooby/internal/apt/asm/ArrayWriter.java
@@ -12,9 +12,9 @@
 import java.util.function.Consumer;
 
 public class ArrayWriter {
-  public static <T> void write(MethodVisitor visitor, Class componentType, List<T> items, Consumer<T> foreach) {
+  public static <T> void write(MethodVisitor visitor, String componentType, List<T> items, Consumer<T> foreach) {
     visitor.visitInsn(Opcodes.ICONST_0 + items.size());
-    visitor.visitTypeInsn(Opcodes.ANEWARRAY, componentType.getName().replace(".", "/"));
+    visitor.visitTypeInsn(Opcodes.ANEWARRAY, componentType.replace(".", "/"));
     for (int i = 0; i < items.size(); i++) {
       visitor.visitInsn(Opcodes.DUP);
       visitor.visitInsn(Opcodes.ICONST_0 + i);
diff --git a/modules/jooby-apt/src/main/java/io/jooby/internal/apt/asm/RouteAttributesWriter.java b/modules/jooby-apt/src/main/java/io/jooby/internal/apt/asm/RouteAttributesWriter.java
@@ -9,15 +9,18 @@
 import io.jooby.SneakyThrows;
 import io.jooby.internal.apt.Primitives;
 import io.jooby.internal.apt.TypeDefinition;
-import io.jooby.internal.apt.asm.ArrayWriter;
 import org.objectweb.asm.ClassWriter;
 import org.objectweb.asm.MethodVisitor;
 import org.objectweb.asm.Opcodes;
 import org.objectweb.asm.Type;
 
 import javax.lang.model.element.AnnotationMirror;
 import javax.lang.model.element.AnnotationValue;
+import javax.lang.model.element.Element;
 import javax.lang.model.element.ExecutableElement;
+import javax.lang.model.element.Name;
+import javax.lang.model.element.TypeElement;
+import javax.lang.model.element.VariableElement;
 import javax.lang.model.type.TypeMirror;
 import javax.lang.model.util.Elements;
 import javax.lang.model.util.Types;
@@ -33,6 +36,7 @@
 
 import static io.jooby.SneakyThrows.throwingConsumer;
 import static java.util.Collections.singletonList;
+import static java.util.Collections.sort;
 import static org.objectweb.asm.Opcodes.ACC_PRIVATE;
 import static org.objectweb.asm.Opcodes.ACC_STATIC;
 import static org.objectweb.asm.Opcodes.ALOAD;
@@ -59,6 +63,18 @@
 import static org.objectweb.asm.Opcodes.POP;
 
 public class RouteAttributesWriter {
+
+  private static class EnumValue {
+    private String type;
+
+    private String value;
+
+    public EnumValue(String type, String value) {
+      this.type = type;
+      this.value = value;
+    }
+  }
+
   private static final Predicate<String> HTTP_ANNOTATION = it ->
       it.startsWith("io.jooby.annotations")
           || it.startsWith("javax.ws.rs");
@@ -67,8 +83,10 @@ public class RouteAttributesWriter {
       || it.endsWith("NotNull")
       || it.endsWith("Nullable");
 
+  private static final Predicate<String> KOTLIN_ANNOTATION = it -> it.equals("kotlin.Metadata");
+
   private static final Predicate<String> ATTR_FILTER = HTTP_ANNOTATION.negate()
-      .and(NULL_ANNOTATION.negate());
+      .and(NULL_ANNOTATION.negate()).and(KOTLIN_ANNOTATION.negate());
 
   private final Elements elements;
 
@@ -147,6 +165,13 @@ private Object annotationValue(AnnotationValue annotationValue) {
     if (value instanceof AnnotationMirror) {
       Map<String, Object> annotation = annotationMap(singletonList((AnnotationMirror) value), null);
       return annotation.isEmpty() ? null : annotation;
+    } else if (value instanceof VariableElement) {
+      // enum
+      VariableElement vare = (VariableElement) annotationValue.getValue();
+      TypeMirror typeMirror = vare.asType();
+      Element element = types.asElement(typeMirror);
+      Name binaryName = elements.getBinaryName((TypeElement) element);
+      return new EnumValue(binaryName.toString(), value.toString());
     } else if (value instanceof List) {
       List<AnnotationValue> values = (List) value;
       if (values.size() > 0) {
@@ -169,8 +194,9 @@ private void annotationValue(ClassWriter writer, MethodVisitor visitor, Object v
           .visitMethodInsn(INVOKESTATIC, moduleInternalName, newMap, "()Ljava/util/Map;", false);
     } else if (value instanceof List) {
       List values = (List) value;
+      String componentType = values.get(0) instanceof EnumValue? ((EnumValue) values.get(0)).type : values.get(0).getClass().getName();
       if (values.size() > 0) {
-        ArrayWriter.write(visitor, values.get(0).getClass(), values, throwingConsumer(v ->
+        ArrayWriter.write(visitor, componentType, values, throwingConsumer(v ->
             annotationValue(writer, visitor, v)
         ));
         Method asList = Arrays.class.getDeclaredMethod("asList", Object[].class);
@@ -245,6 +271,10 @@ private void annotationSingleValue(MethodVisitor visitor, Object value)
       } else {
         visitor.visitLdcInsn(typeDef.toJvmType());
       }
+    } else if (value instanceof EnumValue) {
+      EnumValue enumValue = (EnumValue) value;
+      Type type = Type.getObjectType(enumValue.type.replace(".", "/"));
+      visitor.visitFieldInsn(GETSTATIC, type.getInternalName(), enumValue.value, type.getDescriptor());
     }
 
     Method wrapper = Primitives.wrapper(value.getClass());
diff --git a/modules/jooby-apt/src/main/java/io/jooby/internal/apt/asm/ValueWriter.java b/modules/jooby-apt/src/main/java/io/jooby/internal/apt/asm/ValueWriter.java
@@ -43,7 +43,7 @@ public void accept(ClassWriter writer, String handlerInternalName, MethodVisitor
       } else {
         visitor.visitLdcInsn(parameter.getType().toJvmType());
 
-        ArrayWriter.write(visitor, Type.class, parameter.getType().getArguments(), type ->
+        ArrayWriter.write(visitor, Type.class.getName(), parameter.getType().getArguments(), type ->
             visitor.visitLdcInsn(type.toJvmType())
         );
         reified = Reified.class.getMethod("getParameterized", Type.class, Type[].class);
diff --git a/modules/jooby-apt/src/test/java/output/MvcExtension.java b/modules/jooby-apt/src/test/java/output/MvcExtension.java
@@ -3,6 +3,7 @@
 import io.jooby.Extension;
 import io.jooby.Jooby;
 import io.jooby.MvcFactory;
+import source.Controller1527;
 
 import javax.annotation.Nonnull;
 import javax.inject.Provider;
@@ -13,8 +14,7 @@ private static void install(Jooby application, Provider<MyController> provider)
     application.get("/mypath", ctx -> {
       MyController myController = provider.get();
       return myController.controllerMethod();
-    }).setReturnType(String.class)
-        .attribute("RoleAnnotation", "User");
+    }).attribute("RequireRole", Controller1527.Role.USER);
   }
 
   @Override public boolean supports(@Nonnull Class type) {
diff --git a/modules/jooby-apt/src/test/java/source/Controller1527.java b/modules/jooby-apt/src/test/java/source/Controller1527.java
@@ -0,0 +1,36 @@
+package source;
+
+import io.jooby.annotations.GET;
+import io.jooby.annotations.Path;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Path("/hello")
+@TopAnnotation(TopEnum.FOO)
+public class Controller1527 {
+  public enum Role {USER, ADMIN}
+
+  @Target({ElementType.METHOD, ElementType.TYPE})
+  @Retention(RetentionPolicy.RUNTIME) @interface RequireRole {
+    Role value();
+  }
+
+  @GET @RequireRole(Role.ADMIN)
+  public String login() {
+    return "";
+  }
+
+  @GET @TopAnnotation({TopEnum.BAR, TopEnum.FOO})
+  public String topannotation() {
+    return "";
+  }
+
+  @GET
+  @StringArrayAnnotation({"a", "b", "c"})
+  public String classannotation() {
+    return "";
+  }
+}
diff --git a/modules/jooby-apt/src/test/java/source/StringArrayAnnotation.java b/modules/jooby-apt/src/test/java/source/StringArrayAnnotation.java
@@ -0,0 +1,12 @@
+package source;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Target({ElementType.METHOD, ElementType.TYPE})
+@Retention(RetentionPolicy.RUNTIME)
+public @interface StringArrayAnnotation {
+  String[] value();
+}
diff --git a/modules/jooby-apt/src/test/java/source/TopAnnotation.java b/modules/jooby-apt/src/test/java/source/TopAnnotation.java
@@ -0,0 +1,12 @@
+package source;
+
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Target({ElementType.METHOD, ElementType.TYPE})
+@Retention(RetentionPolicy.RUNTIME)
+public @interface TopAnnotation {
+  TopEnum[] value();
+}
diff --git a/modules/jooby-apt/src/test/java/source/TopEnum.java b/modules/jooby-apt/src/test/java/source/TopEnum.java
@@ -0,0 +1,5 @@
+package source;
+
+public enum TopEnum {
+  FOO, BAR
+}
diff --git a/modules/jooby-apt/src/test/java/tests/Issue1527.java b/modules/jooby-apt/src/test/java/tests/Issue1527.java
@@ -0,0 +1,34 @@
+package tests;
+
+import io.jooby.Route;
+import io.jooby.apt.MvcModuleCompilerRunner;
+import org.junit.jupiter.api.Test;
+import source.Controller1527;
+import source.TopEnum;
+
+import java.util.Arrays;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+public class Issue1527 {
+//  @Test
+  public void annotation() throws Exception {
+    new MvcModuleCompilerRunner(new Controller1527())
+        .module(app -> {
+          Route route0 = app.getRoutes().get(0);
+          assertEquals(2, route0.getAttributes().size(), route0.getAttributes().toString());
+          assertEquals(Controller1527.Role.ADMIN, route0.attribute("requireRole"));
+          assertEquals(Arrays.asList(TopEnum.FOO), route0.attribute("topAnnotation"));
+
+          Route route1 = app.getRoutes().get(1);
+          assertEquals(1, route1.getAttributes().size(), route1.getAttributes().toString());
+          assertEquals(Arrays.asList(TopEnum.BAR, TopEnum.FOO), route1.attribute("topAnnotation"));
+
+          Route route2 = app.getRoutes().get(2);
+          assertEquals(2, route2.getAttributes().size(), route2.getAttributes().toString());
+          assertEquals(Arrays.asList(TopEnum.FOO), route2.attribute("topAnnotation"));
+          assertEquals(Arrays.asList("a", "b", "c"), route2.attribute("stringArrayAnnotation"));
+        })
+    ;
+  }
+}
diff --git a/tests/src/test/java/io/jooby/ByteCodePrinter.java b/tests/src/test/java/io/jooby/ByteCodePrinter.java
@@ -0,0 +1,11 @@
+package io.jooby;
+
+import org.objectweb.asm.util.ASMifier;
+
+import java.io.IOException;
+
+public class ByteCodePrinter {
+  public static void main(String[] args) throws IOException {
+    ASMifier.main(new String[] {"io.jooby.internal.mvc.KotlinMvc"});
+  }
+}
