Merge pull request #168 from SentryMan/timeout

Add Request Timeout Annotation

Author: rbygrave

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

@@ -0,0 +1,29 @@
+package io.avaje.http.api;
+
+import static java.lang.annotation.ElementType.METHOD;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+import java.time.temporal.ChronoUnit;
+
+/**
+ * Overrides global request timeout for this endpoint.
+ *
+ * <pre>{@code
+ * @Client
+ * interface CustomerApi {
+ *   @Get("/{id}")
+ *   @RequestTimeout(value = 1, ChronoUnit.SECONDS)
+ *   Customer getById(long id);
+ * }
+ *
+ * }</pre>
+ */
+@Target(METHOD)
+@Retention(RUNTIME)
+public @interface RequestTimeout {
+  long value();
+
+  ChronoUnit chronoUnit() default ChronoUnit.MILLIS;
+}

http-client/pom.xml

@@ -83,7 +83,7 @@
     <dependency>
       <groupId>io.avaje</groupId>
       <artifactId>avaje-http-api</artifactId>
-      <version>1.20</version>
+      <version>${project.version}</version>
       <scope>test</scope>
     </dependency>
 

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

@@ -3,6 +3,7 @@
 import io.avaje.http.generator.core.*;
 
 import javax.lang.model.element.TypeElement;
+import java.util.Optional;
 import java.util.Set;
 import java.util.stream.Collectors;
 
@@ -24,6 +25,7 @@ class ClientMethodWriter {
   private MethodParam bodyHandlerParam;
   private String methodGenericParams = "";
   private final boolean useJsonb;
+  private final Optional<RequestTimeoutPrism> timeout;
 
   ClientMethodWriter(MethodReader method, Append writer, ProcessingContext ctx, boolean useJsonb) {
     this.method = method;
@@ -32,6 +34,7 @@ class ClientMethodWriter {
     this.ctx = ctx;
     this.returnType = Util.parseType(method.returnType());
     this.useJsonb = useJsonb;
+    this.timeout = method.timeout();
   }
 
   void addImportTypes(ControllerReader reader) {
@@ -86,12 +89,18 @@ void write() {
     writeQueryParams(pathSegments);
     writeBeanParams(pathSegments);
     writeFormParams(pathSegments);
+    timeout.ifPresent(this::writeTimeout);
     writeBody();
     writeEnd();
   }
 
-  private void writeEnd() {
-    WebMethod webMethod = method.webMethod();
+  private void writeTimeout(RequestTimeoutPrism p) {
+
+    writer.append("      .requestTimeout(of(%s, %s))", p.value(), p.chronoUnit()).eol();
+  }
+
+private void writeEnd() {
+    final var webMethod = method.webMethod();
     writer.append("      .%s()", webMethod.name()).eol();
     if (returnType == UType.VOID) {
       writer.append("      .asVoid();").eol();

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

@@ -3,16 +3,14 @@
 import java.io.IOException;
 import java.io.Writer;
 import java.util.LinkedHashSet;
-import java.util.List;
+import java.util.Objects;
 import java.util.Set;
 
 import javax.annotation.processing.AbstractProcessor;
 import javax.annotation.processing.ProcessingEnvironment;
 import javax.annotation.processing.RoundEnvironment;
 import javax.annotation.processing.SupportedAnnotationTypes;
 import javax.lang.model.SourceVersion;
-import javax.lang.model.element.AnnotationMirror;
-import javax.lang.model.element.AnnotationValue;
 import javax.lang.model.element.Element;
 import javax.lang.model.element.TypeElement;
 import javax.tools.FileObject;
@@ -84,22 +82,11 @@ private void writeServicesFile() {
   }
 
   private void writeForImported(Element importedElement) {
-    for (AnnotationMirror annotationMirror : importedElement.getAnnotationMirrors()) {
-      for (AnnotationValue value : annotationMirror.getElementValues().values()) {
-        for (Object apiClassDef : (List<?>) value.getValue()) {
-          writeImported(apiClassDef.toString());
-        }
-      }
-    }
-  }
 
-  private void writeImported(String fullName) {
-    // trim .class suffix
-    String apiClassName = fullName.substring(0, fullName.length() - 6);
-    TypeElement typeElement = ctx.typeElement(apiClassName);
-    if (typeElement != null) {
-      writeClient(typeElement);
-    }
+    ImportPrism.getInstanceOn(importedElement).types().stream()
+        .map(ctx::asElement)
+        .filter(Objects::nonNull)
+        .forEach(this::writeClient);
   }
 
   private void writeClient(Element controller) {

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

@@ -39,6 +39,7 @@ public class MethodReader {
   private final PathSegments pathSegments;
   private final boolean hasValid;
   private final List<ExecutableElement> superMethods;
+  private final Optional<RequestTimeoutPrism> timeout;
 
   private WebMethod webMethod;
   private String webMethodPath;
@@ -62,7 +63,12 @@ public class MethodReader {
     this.securityRequirements = readSecurityRequirements();
     this.apiResponses = buildApiResponses();
     this.javadoc = buildJavadoc(element, ctx);
-
+    this.timeout = RequestTimeoutPrism.getOptionalOn(element);
+    timeout.ifPresent(
+        p -> {
+          bean.addStaticImportType("java.time.temporal.ChronoUnit." + p.chronoUnit());
+          bean.addStaticImportType("java.time.Duration.of");
+        });
     if (isWebMethod()) {
       this.hasValid = initValid();
       this.pathSegments = PathSegments.parse(Util.combinePath(bean.path(), webMethodPath));
@@ -366,4 +372,8 @@ public String bodyName() {
     }
     return "body";
   }
+
+  public Optional<RequestTimeoutPrism> timeout() {
+    return timeout;
+  }
 }

http-generator-core/src/main/java/io/avaje/http/generator/core/package-info.java

@@ -31,6 +31,7 @@
 @GeneratePrism(value = org.jetbrains.annotations.NotNull.class, publicAccess = true)
 @GeneratePrism(value = io.avaje.http.api.Client.class, publicAccess = true)
 @GeneratePrism(value = io.avaje.http.api.Client.Import.class, publicAccess = true)
+@GeneratePrism(value = io.avaje.http.api.RequestTimeout.class, publicAccess = true)
 package io.avaje.http.generator.core;
 
 import io.avaje.prism.GeneratePrism;