openapi: lambda routes can't be hidden fix #3575

Author: jknack

modules/jooby-openapi/src/main/java/io/jooby/internal/openapi/AnnotationParser.java

@@ -32,8 +32,6 @@
 import io.jooby.annotation.Path;
 import io.jooby.annotation.PathParam;
 import io.jooby.annotation.QueryParam;
-import io.swagger.v3.oas.annotations.Hidden;
-import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.models.media.Content;
 import io.swagger.v3.oas.models.media.ObjectSchema;
 import io.swagger.v3.oas.models.media.Schema;
@@ -265,26 +263,18 @@ private static Map<String, MethodNode> methods(ParserContext ctx, ClassNode node
 
   private static List<OperationExt> routerMethod(
       ParserContext ctx, String prefix, ClassNode classNode, MethodNode method) {
-    List<OperationExt> result = new ArrayList<>();
 
     AtomicReference<RequestBodyExt> requestBody = new AtomicReference<>();
     List<ParameterExt> arguments = routerArguments(ctx, method, requestBody::set);
     ResponseExt response = returnTypes(method);
 
-    // If the method is hidden, don't generate an operation for it
-    if (isHidden(method.visibleAnnotations)) {
-      return result;
-    }
-
+    List<OperationExt> result = new ArrayList<>();
     for (String httpMethod : httpMethod(method.visibleAnnotations)) {
       for (String pattern : httpPattern(ctx, classNode, method, httpMethod)) {
         OperationExt operation =
             new OperationExt(
                 method, httpMethod, RoutePath.path(prefix, pattern), arguments, response);
         operation.setOperationId(method.name);
-        if (isDeprecated(method.visibleAnnotations)) {
-          operation.setDeprecated(true);
-        }
         Optional.ofNullable(requestBody.get()).ifPresent(operation::setRequestBody);
 
         result.add(operation);
@@ -294,31 +284,6 @@ private static List<OperationExt> routerMethod(
     return result;
   }
 
-  private static boolean isDeprecated(List<AnnotationNode> annotations) {
-    if (annotations != null) {
-      return annotations.stream()
-          .anyMatch(a -> a.desc.equals(Type.getDescriptor(Deprecated.class)));
-    }
-    return false;
-  }
-
-  private static boolean isHidden(List<AnnotationNode> annotations) {
-    if (annotations != null) {
-      // If the method is annotated with @Hidden, it's always hidden
-      boolean hiddenAnnotationExists =
-          annotations.stream().anyMatch(a -> a.desc.equals(Type.getDescriptor(Hidden.class)));
-
-      if (hiddenAnnotationExists) {
-        return true;
-      }
-
-      // If the method is annotated with @Operation, and the value of "hidden" is true, it's hidden
-      return findAnnotationByType(annotations, Operation.class).stream()
-          .anyMatch(it -> boolValue(toMap(it), "hidden"));
-    }
-    return false;
-  }
-
   private static ResponseExt returnTypes(MethodNode method) {
     Signature signature = Signature.create(method);
     String desc = Optional.ofNullable(method.signature).orElse(method.desc);
@@ -393,9 +358,7 @@ private static List<ParameterExt> routerArguments(
         ParamType paramType = ParamType.find(annotations);
 
         /* Required: */
-        boolean required =
-            isPrimitive(javaType)
-                || !isNullable(method, i); // !javaType.startsWith("java.util.Optional");
+        boolean required = isPrimitive(javaType) || !isNullable(method, i);
 
         if (paramType == ParamType.BODY) {
           RequestBodyExt body = new RequestBodyExt();

modules/jooby-openapi/src/main/java/io/jooby/internal/openapi/OpenAPIParser.java

@@ -39,10 +39,7 @@
 import io.jooby.MediaType;
 import io.swagger.v3.core.util.Json;
 import io.swagger.v3.core.util.RefUtils;
-import io.swagger.v3.oas.annotations.OpenAPIDefinition;
-import io.swagger.v3.oas.annotations.Operation;
-import io.swagger.v3.oas.annotations.Parameter;
-import io.swagger.v3.oas.annotations.Parameters;
+import io.swagger.v3.oas.annotations.*;
 import io.swagger.v3.oas.annotations.enums.Explode;
 import io.swagger.v3.oas.annotations.enums.ParameterIn;
 import io.swagger.v3.oas.annotations.extensions.Extension;
@@ -184,6 +181,25 @@ private static void flow(
     consumer.accept(flow);
   }
 
+  private static Boolean isHidden(List<AnnotationNode> annotations) {
+    if (annotations != null) {
+      // If the method is annotated with @Hidden, it's always hidden
+      return annotations.stream().anyMatch(a -> a.desc.equals(Type.getDescriptor(Hidden.class)))
+          ? true
+          : null;
+    }
+    return null;
+  }
+
+  private static Boolean isDeprecated(List<AnnotationNode> annotations) {
+    if (annotations != null) {
+      return annotations.stream().anyMatch(a -> a.desc.equals(Type.getDescriptor(Deprecated.class)))
+          ? true
+          : null;
+    }
+    return null;
+  }
+
   public static void parse(ParserContext ctx, OperationExt operation) {
     /** Tags: */
     MethodNode method = operation.getNode();
@@ -196,6 +212,8 @@ public static void parse(ParserContext ctx, OperationExt operation) {
         .findFirst()
         .ifPresent(it -> tags(singletonList(toMap(it)), operation::addTag));
 
+    operation.setHidden(isHidden(annotations));
+    operation.setDeprecated(isDeprecated(annotations));
     /**
      * @Operation:
      */
@@ -392,9 +410,15 @@ private static void operation(
 
     stringValue(annotation, "method", operation::setMethod);
 
-    boolValue(annotation, "deprecated", operation::setDeprecated);
+    if (operation.getDeprecated() != Boolean.TRUE) {
+      // Don't override deprecated
+      boolValue(annotation, "deprecated", operation::setDeprecated);
+    }
 
-    boolValue(annotation, "hidden", operation::setHidden);
+    if (operation.getHidden() != Boolean.TRUE) {
+      // Don't override hidden
+      boolValue(annotation, "hidden", operation::setHidden);
+    }
 
     stringValue(annotation, "summary", operation::setSummary);
 

modules/jooby-openapi/src/main/java/io/jooby/internal/openapi/RouteParser.java

@@ -253,9 +253,15 @@ private String patternToOperationId(String pattern) {
   }
 
   private void cleanup(List<OperationExt> operations) {
-    for (OperationExt operation : operations) {
-      if (operation.getParameters().isEmpty()) {
-        operation.setParameters(null);
+    var it = operations.iterator();
+    while (it.hasNext()) {
+      var operation = it.next();
+      if (operation.getHidden() == Boolean.TRUE) {
+        it.remove();
+      } else {
+        if (operation.getParameters().isEmpty()) {
+          operation.setParameters(null);
+        }
       }
     }
   }
@@ -326,8 +332,7 @@ private List<OperationExt> routeHandler(ParserContext ctx, String prefix, Method
     AbstractInsnNode instructionTo = null;
     int routeIndex = -1;
     for (AbstractInsnNode it : method.instructions) {
-      if (it instanceof MethodInsnNode && ctx.process(it)) {
-        MethodInsnNode node = (MethodInsnNode) it;
+      if (it instanceof MethodInsnNode node && ctx.process(it)) {
         Signature signature = Signature.create(node);
         if (ctx.isRouter(signature.getOwner().orElse(null))) {
           if (signature.matches("mvc")) {

modules/jooby-openapi/src/test/java/issues/i3575/App3575.java

@@ -0,0 +1,30 @@
+/*
+ * Jooby https://jooby.io
+ * Apache License Version 2.0 https://jooby.io/LICENSE.txt
+ * Copyright 2014 Edgar Espina
+ */
+package issues.i3575;
+
+import io.jooby.Context;
+import io.jooby.Jooby;
+import io.swagger.v3.oas.annotations.Hidden;
+import io.swagger.v3.oas.annotations.Operation;
+
+public class App3575 extends Jooby {
+  {
+    get("/", this::home);
+    get("/hide-op", this::hideOp);
+
+    mvc(Controller3575.class);
+  }
+
+  @Operation(hidden = true)
+  private Object hideOp(Context context) {
+    return null;
+  }
+
+  @Hidden
+  private Object home(Context context) {
+    return null;
+  }
+}

modules/jooby-openapi/src/test/java/issues/i3575/Controller3575.java

@@ -0,0 +1,20 @@
+/*
+ * Jooby https://jooby.io
+ * Apache License Version 2.0 https://jooby.io/LICENSE.txt
+ * Copyright 2014 Edgar Espina
+ */
+package issues.i3575;
+
+import io.jooby.annotation.GET;
+import io.jooby.annotation.Path;
+import io.swagger.v3.oas.annotations.Hidden;
+
+@Path("/3575")
+public class Controller3575 {
+
+  @GET("/mvc")
+  @Hidden
+  public String sayHi() {
+    return "hi";
+  }
+}

modules/jooby-openapi/src/test/java/issues/i3575/Issue3575.java

@@ -0,0 +1,26 @@
+/*
+ * Jooby https://jooby.io
+ * Apache License Version 2.0 https://jooby.io/LICENSE.txt
+ * Copyright 2014 Edgar Espina
+ */
+package issues.i3575;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+import io.jooby.openapi.OpenAPIResult;
+import io.jooby.openapi.OpenAPITest;
+
+public class Issue3575 {
+
+  @OpenAPITest(value = App3575.class)
+  public void shouldHideFromLambdaReference(OpenAPIResult result) {
+    assertEquals(
+        "openapi: 3.0.1\n"
+            + "info:\n"
+            + "  title: 3575 API\n"
+            + "  description: 3575 API description\n"
+            + "  version: \"1.0\"\n"
+            + "paths: {}\n",
+        result.toYaml());
+  }
+}