#24 - ENH: Add asPlainString() with 2XX range check (for Client API returning String without HttpResponse)

Author: rbygrave

http-client/client/src/main/java/io/avaje/http/client/DHttpClientContext.java

@@ -6,6 +6,7 @@
 import java.net.http.HttpHeaders;
 import java.net.http.HttpRequest;
 import java.net.http.HttpResponse;
+import java.nio.charset.StandardCharsets;
 import java.time.Duration;
 import java.util.List;
 import java.util.Map;
@@ -106,18 +107,32 @@ void checkMaybeThrow(HttpResponse<byte[]> response) {
     }
   }
 
+  @SuppressWarnings("unchecked")
+  public BodyContent readErrorContent(boolean responseAsBytes, HttpResponse<?> httpResponse) {
+    if (responseAsBytes) {
+      return readContent((HttpResponse<byte[]>) httpResponse);
+    }
+    final String contentType = getContentType(httpResponse);
+    final Object body = httpResponse.body();
+    if (body instanceof String) {
+      return new BodyContent(contentType, ((String) body).getBytes(StandardCharsets.UTF_8));
+    }
+    String type = (body == null) ? "null" : body.getClass().toString();
+    throw new IllegalStateException("Unable to translate response body to bytes? Maybe use HttpResponse directly instead?  Response body type: " + type);
+  }
+
   @Override
   public BodyContent readContent(HttpResponse<byte[]> httpResponse) {
     byte[] bodyBytes = decodeContent(httpResponse);
     final String contentType = getContentType(httpResponse);
     return new BodyContent(contentType, bodyBytes);
   }
 
-  String getContentType(HttpResponse<byte[]> httpResponse) {
+  String getContentType(HttpResponse<?> httpResponse) {
     return firstHeader(httpResponse.headers(), "Content-Type", "content-type");
   }
 
-  String getContentEncoding(HttpResponse<byte[]> httpResponse) {
+  String getContentEncoding(HttpResponse<?> httpResponse) {
     return firstHeader(httpResponse.headers(), "Content-Encoding", "content-encoding");
   }
 

http-client/client/src/main/java/io/avaje/http/client/DHttpClientRequest.java

@@ -485,6 +485,14 @@ public HttpResponse<String> asString() {
     return withHandler(HttpResponse.BodyHandlers.ofString());
   }
 
+  @Override
+  public HttpResponse<String> asPlainString() {
+    loggableResponseBody = true;
+    final HttpResponse<String> hres = withHandler(HttpResponse.BodyHandlers.ofString());
+    context.checkResponse(hres);
+    return hres;
+  }
+
   @Override
   public HttpResponse<Void> asDiscarding() {
     return withHandler(discarding());

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

@@ -113,6 +113,14 @@ public interface HttpClientResponse {
    */
   HttpResponse<String> asString();
 
+  /**
+   * Return the content as string with check for 200 range status code.
+   * <p>
+   * If the status code is in the error range then a {@link HttpException}
+   * is thrown.
+   */
+  HttpResponse<String> asPlainString();
+
   /**
    * Return the content as InputStream.
    */

http-client/client/src/main/java/io/avaje/http/client/HttpException.java

@@ -43,6 +43,7 @@
 public class HttpException extends RuntimeException {
 
   private final int statusCode;
+  private final boolean responseAsBytes;
   private DHttpClientContext context;
   private HttpResponse<?> httpResponse;
 
@@ -52,6 +53,7 @@ public class HttpException extends RuntimeException {
   public HttpException(int statusCode, String message) {
     super(message);
     this.statusCode = statusCode;
+    this.responseAsBytes = false;
   }
 
   /**
@@ -60,6 +62,7 @@ public HttpException(int statusCode, String message) {
   public HttpException(int statusCode, String message, Throwable cause) {
     super(message, cause);
     this.statusCode = statusCode;
+    this.responseAsBytes = false;
   }
 
   /**
@@ -68,20 +71,23 @@ public HttpException(int statusCode, String message, Throwable cause) {
   public HttpException(int statusCode, Throwable cause) {
     super(cause);
     this.statusCode = statusCode;
+    this.responseAsBytes = false;
   }
 
   HttpException(HttpResponse<?> httpResponse, DHttpClientContext context) {
     super();
     this.httpResponse = httpResponse;
     this.statusCode = httpResponse.statusCode();
     this.context = context;
+    this.responseAsBytes = false;
   }
 
   HttpException(DHttpClientContext context, HttpResponse<byte[]> httpResponse) {
     super();
     this.httpResponse = httpResponse;
     this.statusCode = httpResponse.statusCode();
     this.context = context;
+    this.responseAsBytes = true;
   }
 
   /**
@@ -90,27 +96,24 @@ public HttpException(int statusCode, Throwable cause) {
    * @param cls The type of bean to convert the response to
    * @return The response as a bean
    */
-  @SuppressWarnings("unchecked")
   public <T> T bean(Class<T> cls) {
-    final BodyContent body = context.readContent((HttpResponse<byte[]>) httpResponse);
+    final BodyContent body = context.readErrorContent(responseAsBytes, httpResponse);
     return context.readBean(cls, body);
   }
 
   /**
    * Return the response body content as a UTF8 string.
    */
-  @SuppressWarnings("unchecked")
   public String bodyAsString() {
-    final BodyContent body = context.readContent((HttpResponse<byte[]>) httpResponse);
+    final BodyContent body = context.readErrorContent(responseAsBytes, httpResponse);
     return new String(body.content(), StandardCharsets.UTF_8);
   }
 
   /**
    * Return the response body content as raw bytes.
    */
-  @SuppressWarnings("unchecked")
   public byte[] bodyAsBytes() {
-    final BodyContent body = context.readContent((HttpResponse<byte[]>) httpResponse);
+    final BodyContent body = context.readErrorContent(responseAsBytes, httpResponse);
     return body.content();
   }
 

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

@@ -375,6 +375,63 @@ void get_notFound() {
     assertThat(hres.body()).contains("Not found");
   }
 
+  @Test
+  void asString_200() {
+    final HttpResponse<String> hres = clientContext.request()
+      .path("hello").path("message")
+      .GET().asString();
+
+    assertThat(hres.body()).contains("hello world");
+    assertThat(hres.statusCode()).isEqualTo(200);
+  }
+
+  @Test
+  void asPlainString_200() {
+    final HttpResponse<String> hres = clientContext.request()
+      .path("hello").path("message")
+      .GET().asPlainString();
+
+    assertThat(hres.body()).contains("hello world");
+    assertThat(hres.statusCode()).isEqualTo(200);
+  }
+
+  @Test
+  void asPlainString_throwingHttpException() {
+    final HttpException httpException = assertThrows(HttpException.class, () ->
+      clientContext.request()
+      .path("hello/saveform3")
+      .formParam("name", "Bax")
+      .formParam("email", "notValidEmail")
+      .POST()
+      .asPlainString());
+
+    assertThat(httpException.statusCode()).isEqualTo(422);
+
+    // convert json error response body to a bean
+    final ErrorResponse errorResponse = httpException.bean(ErrorResponse.class);
+    final Map<String, String> errorMap = errorResponse.getErrors();
+    assertThat(errorMap.get("email")).isEqualTo("must be a well-formed email address");
+  }
+
+  @Test
+  void asString_readInvalidResponse() {
+    final HttpResponse<String> hres = clientContext.request()
+      .path("hello/saveform3")
+      .formParam("name", "Bax")
+      .formParam("email", "notValidEmail")
+      .POST()
+      .asString();
+
+    assertThat(hres.statusCode()).isEqualTo(422);
+
+    // convert json error response body to a bean
+    final ErrorResponse errorResponse = clientContext.converters()
+      .beanReader(ErrorResponse.class).readBody(hres.body());
+
+    final Map<String, String> errorMap = errorResponse.getErrors();
+    assertThat(errorMap.get("email")).isEqualTo("must be a well-formed email address");
+  }
+
   @Test
   void headers() {
     final HttpClientRequest request = clientContext.request();