Merge pull request #229 from SentryMan/client-extends

Extendable Clients

Author: rbygrave

.lift.toml

@@ -0,0 +1,3 @@
+ignoreFiles="""
+tests/**
+"""

http-api/src/main/java/io/avaje/http/api/Client.java

@@ -11,40 +11,54 @@
  * Marker annotation for client.
  *
  * <pre>{@code
+ * @Client
+ * interface CustomerApi {
+ *   ...
+ *   @Get("/{id}")
+ *   Customer getById(long id);
  *
- *   @Client
- *   interface CustomerApi {
- *     ...
- *     @Get("/{id}")
- *     Customer getById(long id);
- *
- *     @Post
- *     long save(Customer customer);
- *   }
+ *   @Post
+ *   long save(Customer customer);
+ * }
  *
  * }</pre>
  *
  * <h3>Client.Import</h3>
- * <p>
- * When the client interface already exists in another module we
- * use <code>Client.Import</code> to generate the client.
- * <p>
- * Specify the <code>@Client.Import</code> on the package or class
- * to refer to the client interface we want to generate.
  *
- * <pre>{@code
+ * <p>When the client interface already exists in another module we use <code>Client.Import</code>
+ * to generate the client.
  *
- *   @Client.Import(types = OtherApi.class)
- *   package org.example;
+ * <p>Specify the <code>@Client.Import</code> on the package or class to refer to the client
+ * interface we want to generate.
+ *
+ * <pre>{@code
+ * @Client.Import(types = OtherApi.class)
+ * package org.example;
  *
  * }</pre>
  */
 @Target(value = TYPE)
 @Retention(value = RUNTIME)
 public @interface Client {
 
+  /**
+   * Flag to set whether to generate a Client Implementation. Set false if the interface exists merely to be extended by
+   * other client interfaces
+   */
+  boolean generate() default true;
+
+  /**
+   * Specify <code>@Client.Import</code> on a package or class to refer to the client interface we
+   * want to generate.
+   *
+   * <pre>{@code
+   * @Client.Import(types = OtherApi.class)
+   * package org.example;
+   *
+   * }</pre>
+   */
   @Target(value = {TYPE, PACKAGE})
-  @Retention(value = RUNTIME)
+  @Retention(RUNTIME)
   @interface Import {
 
     /**

http-generator-client/src/main/java/io/avaje/http/generator/client/ClientProcessor.java

@@ -65,7 +65,9 @@ public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment
     readModule();
     for (final Element controller :
         round.getElementsAnnotatedWith(typeElement(ClientPrism.PRISM_TYPE))) {
-      writeClient(controller);
+      if (ClientPrism.getInstanceOn(controller).generate()) {
+        writeClient(controller);
+      }
     }
     for (final var importedElement : round.getElementsAnnotatedWith(typeElement(ImportPrism.PRISM_TYPE))) {
       writeForImported(importedElement);

http-generator-client/src/test/java/io/avaje/http/generator/client/clients/ExampleClient.java

@@ -0,0 +1,10 @@
+package io.avaje.http.generator.client.clients;
+
+import io.avaje.http.api.Client;
+import io.avaje.http.api.Patch;
+
+@Client
+public interface ExampleClient extends UserClient {
+  @Patch
+  void patchy();
+}

http-generator-client/src/test/java/io/avaje/http/generator/client/clients/ExampleClient2.java

@@ -0,0 +1,10 @@
+package io.avaje.http.generator.client.clients;
+
+import io.avaje.http.api.Client;
+import io.avaje.http.api.Patch;
+
+@Client
+public interface ExampleClient2 extends ExampleClient {
+  @Patch
+  void patchy2();
+}

http-generator-client/src/test/java/io/avaje/http/generator/client/clients/UserClient.java

@@ -0,0 +1,16 @@
+package io.avaje.http.generator.client.clients;
+
+import io.avaje.http.api.BodyString;
+import io.avaje.http.api.Client;
+import io.avaje.http.api.Get;
+import io.avaje.http.api.Post;
+
+@Client(generate = false)
+public interface UserClient {
+
+  @Post("/users")
+  String createUser(@BodyString String body);
+
+  @Get("/users/{userId}")
+  String getUserById(String userId);
+}

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

@@ -10,6 +10,8 @@
 import static java.util.function.Predicate.not;
 
 import java.util.ArrayList;
+import java.util.HashSet;
+import java.util.Iterator;
 import java.util.List;
 import java.util.Optional;
 import java.util.Set;
@@ -31,10 +33,11 @@
 public final class ControllerReader {
 
   private final TypeElement beanType;
-  private final List<Element> interfaces;
+  private final List<TypeElement> interfaces;
   private final List<ExecutableElement> interfaceMethods;
   private final List<String> roles;
   private final List<MethodReader> methods = new ArrayList<>();
+  private final Set<String> seenMethods = new HashSet<>();
   private final Set<String> staticImportTypes = new TreeSet<>();
   private final Set<String> importTypes = new TreeSet<>();
   private final List<OpenAPIResponsePrism> apiResponses;
@@ -54,7 +57,7 @@ public final class ControllerReader {
 
   public ControllerReader(TypeElement beanType) {
     this.beanType = beanType;
-    this.interfaces = initInterfaces();
+    this.interfaces = initInterfaces(beanType);
     this.interfaceMethods = initInterfaceMethods();
     this.roles = buildRoles();
     if (isOpenApiAvailable()) {
@@ -115,17 +118,18 @@ void addImports(boolean withSingleton) {
     }
   }
 
-  private List<Element> initInterfaces() {
-    final List<Element> interfaces = new ArrayList<>();
-    for (final TypeMirror anInterface : beanType.getInterfaces()) {
-      final Element ifaceElement = asElement(anInterface);
+  private List<TypeElement> initInterfaces(TypeElement element) {
+    final List<TypeElement> superInterfaces = new ArrayList<>();
+    for (final TypeMirror anInterface : element.getInterfaces()) {
+      final var ifaceElement = asElement(anInterface);
       final var controller = ControllerPrism.getInstanceOn(ifaceElement);
       if (controller != null && !controller.value().isBlank()
-          || PathPrism.isPresent(ifaceElement)) {
-        interfaces.add(ifaceElement);
+          || PathPrism.isPresent(ifaceElement)
+          || ClientPrism.isPresent(ifaceElement)) {
+        superInterfaces.add(ifaceElement);
       }
     }
-    return interfaces;
+    return superInterfaces;
   }
 
   private List<ExecutableElement> initInterfaceMethods() {
@@ -221,6 +225,12 @@ public void read(boolean withSingleton) {
       }
     }
     readSuper(beanType);
+
+    if (platform().getClass().getSimpleName().contains("Client")) {
+      for (final var superInterface : interfaces) {
+        readInterfaces(superInterface);
+      }
+    }
     deriveIncludeValidation();
     addImports(withSingleton);
   }
@@ -268,6 +278,20 @@ private void readSuper(TypeElement beanType) {
     }
   }
 
+  /**
+   * Read methods from interfaces taking into account generics.
+   *
+   * @param interfaceElement
+   */
+  private void readInterfaces(TypeElement interfaceElement) {
+    for (final var element : ElementFilter.methodsIn(interfaceElement.getEnclosedElements())) {
+      readMethod(element, (DeclaredType) interfaceElement.asType());
+    }
+    for (final var element : initInterfaces(interfaceElement)) {
+      readInterfaces(element);
+    }
+  }
+
   private void readMethod(ExecutableElement element) {
     readMethod(element, null);
   }
@@ -279,7 +303,7 @@ private void readMethod(ExecutableElement method, DeclaredType declaredType) {
       actualExecutable = (ExecutableType) asMemberOf(declaredType, method);
     }
     final MethodReader methodReader = new MethodReader(this, method, actualExecutable);
-    if (methodReader.isWebMethod()) {
+    if (methodReader.isWebMethod() && seenMethods.add(method.toString())) {
       methodReader.read();
       methods.add(methodReader);
     }