Fix compression error log (#158)

* fix compression error log

fixes an issue where the outputstream is flushed after sending a compressed response

* some docs

* Update CompressionTest.java

avaje-jex/src/main/java/io/avaje/jex/Context.java

@@ -432,10 +432,12 @@ default Context headers(Map<String, String> headers) {
   String protocol();
 
   /**
-   * Gets basic-auth credentials from the request, or throws.
+   * Gets basic-auth credentials from the request.
    *
-   * <p>Returns a wrapper object containing the Base64 decoded username and password from the
-   * Authorization header, or null if basic-auth is not properly configured
+   * @return The Base64 decoded username and password from the
+   * Authorization header, or null if no header is sent
+   *
+   * @throws IllegalStateException if the Authorization header is malformed
    */
   BasicAuthCredentials basicAuthCredentials();
 

avaje-jex/src/main/java/io/avaje/jex/core/BufferedOutStream.java

@@ -60,7 +60,9 @@ private void initialiseChunked() throws IOException {
   @Override
   public void close() throws IOException {
     if (stream != null) {
-      stream.flush();
+      if (!context.responseSent()) {
+        stream.flush();
+      }
       stream.close();
     } else {
       context.write(buffer.toByteArray());

avaje-jex/src/test/java/io/avaje/jex/compression/CompressionTest.java

@@ -2,7 +2,10 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 
+import java.io.IOException;
 import java.net.http.HttpResponse;
+import java.util.Arrays;
+import java.util.zip.GZIPInputStream;
 
 import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.Test;
@@ -43,11 +46,22 @@ static void end() {
   }
 
   @Test
-  void testCompression() {
-    HttpResponse<String> res =
-        pair.request().header(Constants.ACCEPT_ENCODING, "deflate, gzip;q=1.0, *;q=0.5").path("compress").GET().asString();
+  void testCompression() throws IOException {
+    var res =
+        pair.request()
+            .header(Constants.ACCEPT_ENCODING, "deflate, gzip;q=1.0, *;q=0.5")
+            .path("compress")
+            .GET()
+            .asInputStream();
     assertThat(res.statusCode()).isEqualTo(200);
     assertThat(res.headers().firstValue(Constants.CONTENT_ENCODING)).contains("gzip");
+
+    var expected = CompressionTest.class.getResourceAsStream("/64KB.json").readAllBytes();
+
+    final var gzipInputStream = new GZIPInputStream(res.body());
+    var decompressed = gzipInputStream.readAllBytes();
+    gzipInputStream.close();
+    assertThat(decompressed).isEqualTo(expected);
   }
 
   @Test

pom.xml

@@ -168,6 +168,13 @@
         <scope>provided</scope>
         <optional>true</optional>
       </dependency>
+      <dependency>
+        <groupId>io.ebean</groupId>
+        <version>${ebean.version}</version>
+        <artifactId>querybean-generator</artifactId>
+        <scope>provided</scope>
+        <optional>true</optional>
+      </dependency>
       <dependency>
         <groupId>io.avaje</groupId>
         <artifactId>avaje-jex</artifactId>