#23 - ENH: Add CompletableFuture asByteArray(), asLines() asInputStream()

Author: rbygrave

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

@@ -1,5 +1,6 @@
 package io.avaje.http.client;
 
+import java.io.InputStream;
 import java.net.http.HttpResponse;
 import java.util.List;
 import java.util.concurrent.CompletableFuture;
@@ -13,30 +14,48 @@ class DHttpAsync implements HttpAsyncResponse {
     this.request = request;
   }
 
-  @Override
-  public <E> CompletableFuture<HttpResponse<E>> withHandler(HttpResponse.BodyHandler<E>  handler) {
+  private <E> CompletableFuture<HttpResponse<E>> with(boolean loggable, HttpResponse.BodyHandler<E>  handler) {
     return request
-      .performSendAsync(false, handler)
+      .performSendAsync(loggable, handler)
       .thenApply(request::afterAsync);
   }
 
+  @Override
+  public <E> CompletableFuture<HttpResponse<E>> withHandler(HttpResponse.BodyHandler<E>  handler) {
+    return with(false, handler);
+  }
+
   @Override
   public CompletableFuture<HttpResponse<Void>> asDiscarding() {
-    return withHandler(HttpResponse.BodyHandlers.discarding());
+    return with(false, HttpResponse.BodyHandlers.discarding());
   }
 
   @Override
   public CompletableFuture<HttpResponse<Void>> asVoid() {
+    // read the response content as bytes so that it is available for error response
     return request
       .performSendAsync(true, HttpResponse.BodyHandlers.ofByteArray())
       .thenApply(request::asyncVoid);
   }
 
   @Override
   public CompletableFuture<HttpResponse<String>> asString() {
-    return request
-      .performSendAsync(true, HttpResponse.BodyHandlers.ofString())
-      .thenApply(request::afterAsync);
+    return with(true, HttpResponse.BodyHandlers.ofString());
+  }
+
+  @Override
+  public CompletableFuture<HttpResponse<byte[]>> asByteArray() {
+    return with(true, HttpResponse.BodyHandlers.ofByteArray());
+  }
+
+  @Override
+  public CompletableFuture<HttpResponse<Stream<String>>> asLines() {
+    return with(false, HttpResponse.BodyHandlers.ofLines());
+  }
+
+  @Override
+  public CompletableFuture<HttpResponse<InputStream>> asInputStream() {
+    return with(false, HttpResponse.BodyHandlers.ofInputStream());
   }
 
   @Override

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

@@ -1,5 +1,6 @@
 package io.avaje.http.client;
 
+import java.io.InputStream;
 import java.net.http.HttpResponse;
 import java.util.List;
 import java.util.concurrent.CompletableFuture;
@@ -110,6 +111,27 @@ public interface HttpAsyncResponse {
    */
   CompletableFuture<HttpResponse<String>> asString();
 
+  /**
+   * Process as response {@literal HttpResponse<byte[]>}.
+   *
+   * @return The CompletableFuture of the response
+   */
+  CompletableFuture<HttpResponse<byte[]>> asByteArray();
+
+  /**
+   * Process as response {@literal HttpResponse<Stream<String>>}.
+   *
+   * @return The CompletableFuture of the response
+   */
+  CompletableFuture<HttpResponse<Stream<String>>> asLines();
+
+  /**
+   * Process as response {@literal HttpResponse<InputStream>}.
+   *
+   * @return The CompletableFuture of the response
+   */
+  CompletableFuture<HttpResponse<InputStream>> asInputStream();
+
   /**
    * Process with any given {@code HttpResponse.BodyHandler}.
    *
@@ -147,10 +169,10 @@ public interface HttpAsyncResponse {
    *       });
    * }</pre>
    *
-   * @param bodyHandlers The body handler to use to process the response
+   * @param bodyHandler The body handler to use to process the response
    * @return The CompletableFuture of the response
    */
-  <E> CompletableFuture<HttpResponse<E>> withHandler(HttpResponse.BodyHandler<E> bodyHandlers);
+  <E> CompletableFuture<HttpResponse<E>> withHandler(HttpResponse.BodyHandler<E> bodyHandler);
 
   /**
    * Process expecting a bean response body (typically from json content).

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

@@ -7,6 +7,7 @@
 import java.io.*;
 import java.net.http.HttpClient;
 import java.net.http.HttpResponse;
+import java.nio.charset.StandardCharsets;
 import java.nio.file.Path;
 import java.time.Duration;
 import java.time.LocalDate;
@@ -58,6 +59,22 @@ void asLines() {
     assertThat(lines.get(0)).contains("{\"id\":1, \"name\":\"one\"}");
   }
 
+  @Test
+  void asLines_async() throws ExecutionException, InterruptedException {
+    final CompletableFuture<HttpResponse<Stream<String>>> future = clientContext.request()
+      .path("hello").path("stream")
+      .GET()
+      .async()
+      .asLines();
+
+    final HttpResponse<Stream<String>> hres = future.get();
+    assertThat(hres.statusCode()).isEqualTo(200);
+    final List<String> lines = hres.body().collect(Collectors.toList());
+
+    assertThat(lines).hasSize(4);
+    assertThat(lines.get(0)).contains("{\"id\":1, \"name\":\"one\"}");
+  }
+
   @Test
   void asInputStream() throws IOException {
     final HttpResponse<InputStream> hres =
@@ -78,6 +95,26 @@ void asInputStream() throws IOException {
     assertThat(allLines.get(0)).contains("{\"id\":1, \"name\":\"one\"}");
   }
 
+  @Test
+  void asInputStream_async() throws IOException, ExecutionException, InterruptedException {
+    final CompletableFuture<HttpResponse<InputStream>> future = clientContext.request()
+      .path("hello").path("stream")
+      .GET()
+      .async().asInputStream();
+
+    final HttpResponse<InputStream> hres = future.get();
+    assertThat(hres.statusCode()).isEqualTo(200);
+    final LineNumberReader reader = new LineNumberReader(new InputStreamReader(hres.body()));
+
+    List<String> allLines = new ArrayList<>();
+    String line;
+    while ((line = reader.readLine()) != null) {
+      allLines.add(line);
+    }
+    assertThat(allLines).hasSize(4);
+    assertThat(allLines.get(0)).contains("{\"id\":1, \"name\":\"one\"}");
+  }
+
   @Test
   void asFile() throws IOException {
     final Path path = File.createTempFile("test", "dump").toPath();
@@ -241,6 +278,28 @@ void get_helloMessage() {
     assertThat(hres.statusCode()).isEqualTo(200);
   }
 
+  @Test
+  void asByteArray() {
+    final HttpResponse<byte[]> hres = clientContext.request()
+      .path("hello").path("message")
+      .GET().asByteArray();
+
+    final byte[] body = hres.body();
+    assertThat(new String(body, StandardCharsets.UTF_8)).contains("hello world");
+    assertThat(hres.statusCode()).isEqualTo(200);
+  }
+
+  @Test
+  void asByteArray_async() throws ExecutionException, InterruptedException {
+    final CompletableFuture<HttpResponse<byte[]>> future = clientContext.request()
+      .path("hello").path("message")
+      .GET().async().asByteArray();
+
+    final HttpResponse<byte[]> hres = future.get();
+    assertThat(new String(hres.body(), StandardCharsets.UTF_8)).contains("hello world");
+    assertThat(hres.statusCode()).isEqualTo(200);
+  }
+
   @Test
   void get_notFound() {
     UUID nullUUID = null;