Add call().asVoid() option

Author: rbygrave

client/src/main/java/io/avaje/http/client/DHttpCall.java

@@ -13,6 +13,11 @@ class DHttpCall implements HttpCallResponse {
     this.request = request;
   }
 
+  @Override
+  public HttpCall<HttpResponse<Void>> asVoid() {
+    return new CallVoid();
+  }
+
   @Override
   public HttpCall<HttpResponse<Void>> asDiscarding() {
     return new CallDiscarding();
@@ -43,12 +48,23 @@ public <E> HttpCall<Stream<E>> stream(Class<E> type) {
     return new CallStream<>(type);
   }
 
-  private class CallDiscarding implements HttpCall<HttpResponse<Void>> {
+  private class CallVoid implements HttpCall<HttpResponse<Void>> {
     @Override
     public HttpResponse<Void> execute() {
       return request.asVoid();
     }
     @Override
+    public CompletableFuture<HttpResponse<Void>> async() {
+      return request.async().asVoid();
+    }
+  }
+
+  private class CallDiscarding implements HttpCall<HttpResponse<Void>> {
+    @Override
+    public HttpResponse<Void> execute() {
+      return request.asDiscarding();
+    }
+    @Override
     public CompletableFuture<HttpResponse<Void>> async() {
       return request.async().asDiscarding();
     }

client/src/main/java/io/avaje/http/client/HttpCallResponse.java

@@ -10,8 +10,44 @@
  */
 public interface HttpCallResponse {
 
+  /**
+   * Process the response with check for 200 range status code
+   * returning as {@literal HttpResponse<Void>}.
+   * <p>
+   * Unlike {@link #asDiscarding()} this request will read any response
+   * content as bytes with the view that the response content can be
+   * an error message that could be read via for example
+   * {@link HttpException#bean(Class)}.
+   * <p>
+   * Will throw an HttpException if the status code is in the
+   * error range allowing the caller to access the error message
+   * body via for example {@link HttpException#bean(Class)}
+   * <p>
+   * This is intended to be used for POST, PUT, DELETE requests
+   * where the caller is only interested in the response body
+   * when an error occurs (status code not in 200 range).
+   *
+   * <pre>{@code
+   *
+   *   HttpCall<HttpResponse<Void>> call =
+   *     clientContext.request()
+   *       .path("hello/world")
+   *       .GET()
+   *       .call().asVoid();
+   *
+   * }</pre>
+   *
+   * @return The HttpCall to allow sync or async execution
+   */
+  HttpCall<HttpResponse<Void>> asVoid();
+
   /**
    * Process discarding response body as {@literal HttpResponse<Void>}.
+   * <p>
+   * Unlike {@link #asVoid()} this will discard any response body including
+   * any error response body. We should instead use {@link #asVoid()} if we
+   * might get an error response body that we want to read via
+   * for example {@link HttpException#bean(Class)}.
    *
    * <pre>{@code
    *

client/src/main/java/io/avaje/http/client/HttpClientResponse.java

@@ -98,18 +98,21 @@ public interface HttpClientResponse {
    */
   HttpResponse<Void> asVoid();
 
-  /**
-   * Return the content as string.
-   */
-  HttpResponse<String> asString();
-
   /**
    * Return the response discarding the response content.
    * <p>
-   * Unlike {@link #asVoid()} this does not check the response status code.
+   * Unlike {@link #asVoid()} this will discard any response body including
+   * any error response body. We should instead use {@link #asVoid()} if we
+   * might get an error response body that we want to read via
+   * for example {@link HttpException#bean(Class)}.
    */
   HttpResponse<Void> asDiscarding();
 
+  /**
+   * Return the content as string.
+   */
+  HttpResponse<String> asString();
+
   /**
    * Return the content as InputStream.
    */

client/src/test/java/io/avaje/http/client/HelloControllerTest.java

@@ -613,6 +613,66 @@ void asyncAsVoid_extractError() throws InterruptedException {
     }
   }
 
+  @Test
+  void callAsVoid_async_extractError() throws InterruptedException {
+    AtomicReference<HttpException> ref = new AtomicReference<>();
+
+    final CompletableFuture<HttpResponse<Void>> future =
+      clientContext.request()
+        .path("hello/saveform")
+        .formParam("email", "user@foo.com")
+        .formParam("url", "notAValidUrl")
+        .POST()
+        .call()
+        .asVoid()
+        .async()
+        .whenComplete((hres, throwable) -> {
+
+          final HttpException cause = (HttpException) throwable.getCause();
+          ref.set(cause);
+
+          final HttpResponse<?> httpResponse = cause.getHttpResponse();
+          assertNotNull(httpResponse);
+          assertEquals(422, httpResponse.statusCode());
+
+          final ErrorResponse errorResponse = cause.bean(ErrorResponse.class);
+          final Map<String, String> errorMap = errorResponse.getErrors();
+          assertThat(errorMap.get("url")).isEqualTo("must be a valid URL");
+          assertThat(errorMap.get("name")).isEqualTo("must not be null");
+        });
+
+    try {
+      future.get();
+    } catch (ExecutionException e) {
+      assertThat(ref.get()).isNotNull();
+    }
+  }
+
+  @Test
+  void callAsVoid_extractError() {
+    try {
+      clientContext.request()
+        .path("hello/saveform")
+        .formParam("email", "user@foo.com")
+        .formParam("url", "notAValidUrl")
+        .POST()
+        .call()
+        .asVoid()
+        .execute();
+
+      fail();
+    } catch (HttpException e) {
+      final HttpResponse<?> httpResponse = e.getHttpResponse();
+      assertNotNull(httpResponse);
+      assertEquals(422, httpResponse.statusCode());
+
+      final ErrorResponse errorResponse = e.bean(ErrorResponse.class);
+      final Map<String, String> errorMap = errorResponse.getErrors();
+      assertThat(errorMap.get("url")).isEqualTo("must be a valid URL");
+      assertThat(errorMap.get("name")).isEqualTo("must not be null");
+    }
+  }
+
   @Test
   void postForm_asBytes_validation_expect_badRequest_extractError() {
     try {
@@ -655,16 +715,37 @@ void delete() {
     assertThat(res.statusCode()).isEqualTo(204);
   }
 
+  @Test
+  void callAsVoid() {
+    final HttpResponse<Void> res =
+      clientContext.request()
+        .path("hello/52")
+        .DELETE()
+        .call().asVoid().execute();
+
+    assertThat(res.statusCode()).isEqualTo(204);
+  }
+
+  @Test
+  void callAsVoid_async() throws ExecutionException, InterruptedException {
+    final HttpResponse<Void> res =
+      clientContext.request()
+        .path("hello/52")
+        .DELETE()
+        .call().asVoid().async().get();
+
+    assertThat(res.statusCode()).isEqualTo(204);
+  }
 
   @Test
   void callAsDiscarding() {
-    final HttpResponse<Void> res2 =
+    final HttpResponse<Void> res =
       clientContext.request()
         .path("hello/52")
         .DELETE()
         .call().asDiscarding().execute();
 
-    assertThat(res2.statusCode()).isEqualTo(204);
+    assertThat(res.statusCode()).isEqualTo(204);
   }
 
   @Test