openapi: support route inheritance fix #1586

Author: jknack

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

@@ -206,15 +206,26 @@ public static List<OperationExt> parse(ParserContext ctx, String prefix,
   private static List<OperationExt> parse(ParserContext ctx, String prefix, Type type) {
     List<OperationExt> result = new ArrayList<>();
     ClassNode classNode = ctx.classNode(type);
-    for (MethodNode method : classNode.methods) {
-      if (isRouter(method)) {
-        ctx.debugHandler(method);
-        result.addAll(routerMethod(ctx, prefix, classNode, method));
-      }
+    Collection<MethodNode> methods = methods(ctx, classNode).values();
+    for (MethodNode method : methods) {
+      ctx.debugHandler(method);
+      result.addAll(routerMethod(ctx, prefix, classNode, method));
     }
     return result;
   }
 
+  private static Map<String, MethodNode> methods(ParserContext ctx, ClassNode node) {
+    Map<String, MethodNode> methods = new LinkedHashMap<>();
+    if (node.superName != null && !node.superName.equals(TypeFactory.OBJECT.getInternalName())) {
+      methods.putAll(methods(ctx, ctx.classNode(Type.getObjectType(node.superName))));
+    }
+    node.methods.stream().filter(AnnotationParser::isRouter).forEach(it -> {
+      String signature = it.name + it.desc.substring(0, it.desc.indexOf(')') + 1);
+      methods.put(signature, it);
+    });
+    return methods;
+  }
+
   private static List<OperationExt> routerMethod(ParserContext ctx, String prefix,
       ClassNode classNode, MethodNode method) {
     List<OperationExt> result = new ArrayList<>();
@@ -224,7 +235,7 @@ private static List<OperationExt> routerMethod(ParserContext ctx, String prefix,
     ResponseExt response = returnTypes(method);
 
     for (String httpMethod : httpMethod(method.visibleAnnotations)) {
-      for (String pattern : httpPattern(classNode, method, httpMethod)) {
+      for (String pattern : httpPattern(ctx, classNode, method, httpMethod)) {
         OperationExt operation = new OperationExt(
             method,
             httpMethod,
@@ -397,13 +408,18 @@ private static boolean isPrimitive(String javaType) {
     return false;
   }
 
-  private static List<String> httpPattern(ClassNode classNode, MethodNode method,
+  private static List<String> httpPattern(ParserContext ctx, ClassNode classNode, MethodNode method,
       String httpMethod) {
     List<String> patterns = new ArrayList<>();
 
     List<String> rootPattern = httpPattern(httpMethod, null, classNode.visibleAnnotations);
-    if (rootPattern.size() == 0) {
-      rootPattern = Arrays.asList("/");
+    while (rootPattern.isEmpty() && classNode.superName != null) {
+      classNode = ctx.classNode(Type.getObjectType(classNode.superName));
+      rootPattern = httpPattern(httpMethod, null, classNode.visibleAnnotations);
+    }
+
+    if (rootPattern.isEmpty()) {
+      rootPattern = Collections.singletonList("/");
     }
 
     for (String prefix : rootPattern) {

modules/jooby-openapi/src/test/java/examples/BaseController.java

@@ -0,0 +1,19 @@
+package examples;
+
+import io.jooby.annotations.GET;
+import io.jooby.annotations.Path;
+import io.jooby.annotations.QueryParam;
+
+@Path("/base")
+public abstract class BaseController {
+
+  @GET
+  public String base() {
+    return "base";
+  }
+
+  @GET("/withPath")
+  public String withPath(@QueryParam String q) {
+    return "withPath";
+  }
+}

modules/jooby-openapi/src/test/java/examples/EmptySubClassController.java

@@ -0,0 +1,7 @@
+package examples;
+
+import io.jooby.annotations.Path;
+
+@Path("/override")
+public class EmptySubClassController extends BaseController {
+}

modules/jooby-openapi/src/test/java/examples/OverrideMethodSubClassController.java

@@ -0,0 +1,18 @@
+package examples;
+
+import io.jooby.annotations.GET;
+import io.jooby.annotations.Path;
+import io.jooby.annotations.QueryParam;
+
+@Path("/overrideMethod")
+public class OverrideMethodSubClassController extends BaseController {
+
+  @Override public String base() {
+    return super.base();
+  }
+
+  @GET("/newpath")
+  @Override public String withPath(@QueryParam String q) {
+    return super.withPath(q);
+  }
+}

modules/jooby-openapi/src/test/java/examples/SubController.java

@@ -0,0 +1,11 @@
+package examples;
+
+import io.jooby.annotations.GET;
+
+public class SubController extends BaseController {
+
+  @GET("/subPath")
+  public String subPath() {
+    return "subPath";
+  }
+}

modules/jooby-openapi/src/test/java/issues/App1586.java

@@ -0,0 +1,10 @@
+package issues;
+
+import examples.SubController;
+import io.jooby.Jooby;
+
+public class App1586 extends Jooby {
+  {
+    mvc(new SubController());
+  }
+}

modules/jooby-openapi/src/test/java/issues/App1586b.java

@@ -0,0 +1,10 @@
+package issues;
+
+import examples.EmptySubClassController;
+import io.jooby.Jooby;
+
+public class App1586b extends Jooby {
+  {
+    mvc(new EmptySubClassController());
+  }
+}

modules/jooby-openapi/src/test/java/issues/App1586c.java

@@ -0,0 +1,10 @@
+package issues;
+
+import examples.OverrideMethodSubClassController;
+import io.jooby.Jooby;
+
+public class App1586c extends Jooby {
+  {
+    mvc(new OverrideMethodSubClassController());
+  }
+}

modules/jooby-openapi/src/test/java/issues/Issue1585.java

@@ -11,8 +11,8 @@ public class Issue1585 {
   public void shouldAddRegex(OpenAPIResult result) {
     assertEquals("openapi: 3.0.1\n"
         + "info:\n"
-        + "  title: 1584 API\n"
-        + "  description: 1584 API description\n"
+        + "  title: 1585 API\n"
+        + "  description: 1585 API description\n"
         + "  version: \"1.0\"\n"
         + "paths:\n"
         + "  /user/{id}:\n"

modules/jooby-openapi/src/test/java/issues/Issue1586.java

@@ -0,0 +1,124 @@
+package issues;
+
+import io.jooby.openapi.OpenAPIResult;
+import io.jooby.openapi.OpenAPITest;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+
+public class Issue1586 {
+
+  @OpenAPITest(App1586.class)
+  public void shouldParseSubClass(OpenAPIResult result) {
+    assertEquals("openapi: 3.0.1\n"
+        + "info:\n"
+        + "  title: 1586 API\n"
+        + "  description: 1586 API description\n"
+        + "  version: \"1.0\"\n"
+        + "paths:\n"
+        + "  /base:\n"
+        + "    get:\n"
+        + "      operationId: base\n"
+        + "      responses:\n"
+        + "        \"200\":\n"
+        + "          description: Success\n"
+        + "          content:\n"
+        + "            application/json:\n"
+        + "              schema:\n"
+        + "                type: string\n"
+        + "  /base/withPath:\n"
+        + "    get:\n"
+        + "      operationId: withPath\n"
+        + "      parameters:\n"
+        + "      - name: q\n"
+        + "        in: query\n"
+        + "        schema:\n"
+        + "          type: string\n"
+        + "      responses:\n"
+        + "        \"200\":\n"
+        + "          description: Success\n"
+        + "          content:\n"
+        + "            application/json:\n"
+        + "              schema:\n"
+        + "                type: string\n"
+        + "  /base/subPath:\n"
+        + "    get:\n"
+        + "      operationId: subPath\n"
+        + "      responses:\n"
+        + "        \"200\":\n"
+        + "          description: Success\n"
+        + "          content:\n"
+        + "            application/json:\n"
+        + "              schema:\n"
+        + "                type: string\n", result.toYaml());
+  }
+
+  @OpenAPITest(App1586b.class)
+  public void shouldOverridePathOnSubClass(OpenAPIResult result) {
+    assertEquals("openapi: 3.0.1\n"
+        + "info:\n"
+        + "  title: 1586b API\n"
+        + "  description: 1586b API description\n"
+        + "  version: \"1.0\"\n"
+        + "paths:\n"
+        + "  /override:\n"
+        + "    get:\n"
+        + "      operationId: base\n"
+        + "      responses:\n"
+        + "        \"200\":\n"
+        + "          description: Success\n"
+        + "          content:\n"
+        + "            application/json:\n"
+        + "              schema:\n"
+        + "                type: string\n"
+        + "  /override/withPath:\n"
+        + "    get:\n"
+        + "      operationId: withPath\n"
+        + "      parameters:\n"
+        + "      - name: q\n"
+        + "        in: query\n"
+        + "        schema:\n"
+        + "          type: string\n"
+        + "      responses:\n"
+        + "        \"200\":\n"
+        + "          description: Success\n"
+        + "          content:\n"
+        + "            application/json:\n"
+        + "              schema:\n"
+        + "                type: string\n", result.toYaml());
+  }
+
+  @OpenAPITest(App1586c.class)
+  public void shouldOverrideMethodOnSubClass(OpenAPIResult result) {
+    assertEquals("openapi: 3.0.1\n"
+        + "info:\n"
+        + "  title: 1586c API\n"
+        + "  description: 1586c API description\n"
+        + "  version: \"1.0\"\n"
+        + "paths:\n"
+        + "  /overrideMethod:\n"
+        + "    get:\n"
+        + "      operationId: base\n"
+        + "      responses:\n"
+        + "        \"200\":\n"
+        + "          description: Success\n"
+        + "          content:\n"
+        + "            application/json:\n"
+        + "              schema:\n"
+        + "                type: string\n"
+        + "  /overrideMethod/newpath:\n"
+        + "    get:\n"
+        + "      operationId: withPath\n"
+        + "      parameters:\n"
+        + "      - name: q\n"
+        + "        in: query\n"
+        + "        schema:\n"
+        + "          type: string\n"
+        + "      responses:\n"
+        + "        \"200\":\n"
+        + "          description: Success\n"
+        + "          content:\n"
+        + "            application/json:\n"
+        + "              schema:\n"
+        + "                type: string\n", result.toYaml());
+  }
+}