Enable GZIP compression.

Author: hikingc

src/main/java/io/github/hikingc/matrixsdk/api/MatrixAuth.java

@@ -159,12 +159,14 @@ public TokenMetadata performOAuthLogin(String clientName, int port, String devic
     // Send the payload using the aforementioned record obtained and get the client_id
     var responseBody =
         httpTransport.postRequest(metadata.registrationEndpoint(), mappedInput, null);
-    logger.info("Registration response: {}", responseBody);
+    String responseBodyString = new String(responseBody);
+    logger.info("Registration response: {}", responseBodyString);
 
     var clientId = Mapper.getStringValueOfAJsonKey(responseBody, "client_id");
     if (clientId.isBlank()) {
       throw new MatrixIOException(
-          "Dynamic client registration failed or returned no client_id. Response: " + responseBody);
+          "Dynamic client registration failed or returned no client_id. Response: "
+              + Arrays.toString(responseBody));
     }
 
     // Finish registering client, now we do the login flow

src/main/java/io/github/hikingc/matrixsdk/services/utils/HttpTransport.java

@@ -1,22 +1,24 @@
 package io.github.hikingc.matrixsdk.services.utils;
 
 import io.github.hikingc.matrixsdk.exceptions.*;
+import java.io.ByteArrayInputStream;
 import java.io.IOException;
 import java.net.URI;
 import java.net.URISyntaxException;
 import java.net.URLEncoder;
 import java.net.http.HttpClient;
+import java.net.http.HttpHeaders;
 import java.net.http.HttpRequest;
 import java.net.http.HttpResponse;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
 import java.nio.file.Path;
-import java.util.Arrays;
 import java.util.List;
 import java.util.Map;
 import java.util.Objects;
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
+import java.util.zip.GZIPInputStream;
 import org.jspecify.annotations.NullMarked;
 import org.jspecify.annotations.Nullable;
 import org.slf4j.Logger;
@@ -52,21 +54,20 @@ public HttpTransport(HttpClient httpClient) {
   ///
   /// @param response the client response.
   /// @throws MatrixApiException when the server responds with an unsuccessful HTTP Code.
-  private void validateResponse(HttpResponse<byte[]> response) {
-    var code = response.statusCode();
-    var body = response.body();
-    var headers = response.headers();
+  private void validateResponse(byte[] response, int code, HttpHeaders headers) {
+    var body = new String(response, StandardCharsets.UTF_8);
+
     logger.debug("Validate response code: {}, for body: {} and headers: {}", code, body, headers);
     if (code >= 200 && code < 300) {
       return;
     }
 
-    if (Arrays.toString(body).isBlank()) {
+    if (body.isBlank()) {
       throw new MatrixException("Server returned with HTTP Code:" + code);
     }
     ErrorResponse errorResponse;
     try {
-      errorResponse = Mapper.getObjectFromString(body, ErrorResponse.class);
+      errorResponse = Mapper.getObjectFromString(response, ErrorResponse.class);
     } catch (MatrixSerializationException e) {
       throw new MatrixApiException(
           "Server returned unparseable error body, HTTP code: " + code, code, e);
@@ -99,13 +100,15 @@ private void validateResponse(HttpResponse<byte[]> response) {
   /// @throws MatrixApiException when the response from the server is not successful.
   public byte[] getRequest(URI path, @Nullable String authToken) {
     var builderRequest =
-        HttpRequest.newBuilder().uri(path).header(CONTENT_TYPE, APPLICATION_JSON).GET();
-
+        HttpRequest.newBuilder()
+            .uri(path)
+            .header(CONTENT_TYPE, APPLICATION_JSON)
+            .header("Accept-Encoding", "gzip")
+            .GET();
     if (authToken != null) {
       builderRequest.header(AUTHORIZATION, BEARER + authToken);
     }
     var request = builderRequest.build();
-
     HttpResponse<byte[]> response;
     try {
       response = client.send(request, HttpResponse.BodyHandlers.ofByteArray());
@@ -116,8 +119,9 @@ public byte[] getRequest(URI path, @Nullable String authToken) {
       Thread.currentThread().interrupt();
       throw new MatrixInterruptedException("This request has been interrupted", e);
     }
-    this.validateResponse(response);
-    return response.body();
+    var uncResponse = decompressIfNeeded(response);
+    this.validateResponse(uncResponse, response.statusCode(), response.headers());
+    return uncResponse;
   }
 
   /// Sends a `POST` request to the given endpoint.
@@ -130,7 +134,7 @@ public byte[] getRequest(URI path, @Nullable String authToken) {
   /// @throws MatrixInterruptedException if the operation has been interrupted.
   /// @throws MatrixApiException when the response from the server is not successful.
   public byte[] postRequest(URI path, @Nullable String body, @Nullable String authToken) {
-    var builderRequest = HttpRequest.newBuilder().uri(path);
+    var builderRequest = HttpRequest.newBuilder().header("Accept-Encoding", "gzip").uri(path);
 
     if (body != null) {
       builderRequest.header(CONTENT_TYPE, APPLICATION_JSON);
@@ -156,8 +160,9 @@ public byte[] postRequest(URI path, @Nullable String body, @Nullable String auth
       Thread.currentThread().interrupt();
       throw new MatrixInterruptedException("This request has been interrupted", e);
     }
-    this.validateResponse(response);
-    return response.body();
+    var uncResponse = decompressIfNeeded(response);
+    this.validateResponse(uncResponse, response.statusCode(), response.headers());
+    return uncResponse;
   }
 
   /// Sends a `POST` request to the given endpoint.
@@ -172,7 +177,7 @@ public byte[] postRequest(URI path, @Nullable String body, @Nullable String auth
   ///   with unsuccessful HTTP Code.
   /// @throws MatrixApiException when the response from the server is not successful.
   public byte[] postAuth(URI path, @Nullable String body) {
-    var builderRequest = HttpRequest.newBuilder().uri(path);
+    var builderRequest = HttpRequest.newBuilder().header("Accept-Encoding", "gzip").uri(path);
 
     builderRequest.header(CONTENT_TYPE, "application/x-www-form-urlencoded");
 
@@ -193,8 +198,9 @@ public byte[] postAuth(URI path, @Nullable String body) {
       Thread.currentThread().interrupt();
       throw new MatrixInterruptedException("This request has been interrupted", e);
     }
-    this.validateResponse(response);
-    return response.body();
+    var uncResponse = decompressIfNeeded(response);
+    this.validateResponse(uncResponse, response.statusCode(), response.headers());
+    return uncResponse;
   }
 
   /// Sends a `PUT` request to the given endpoint.
@@ -211,6 +217,7 @@ public byte[] putRequest(URI path, @Nullable String body, String authToken) {
 
     var builderRequest =
         HttpRequest.newBuilder()
+            .header("Accept-Encoding", "gzip")
             .uri(path)
             .headers(AUTHORIZATION, BEARER + authToken, CONTENT_TYPE, APPLICATION_JSON);
 
@@ -230,8 +237,9 @@ public byte[] putRequest(URI path, @Nullable String body, String authToken) {
       Thread.currentThread().interrupt();
       throw new MatrixInterruptedException("This request has been interrupted", e);
     }
-    this.validateResponse(response);
-    return response.body();
+    var uncResponse = decompressIfNeeded(response);
+    this.validateResponse(uncResponse, response.statusCode(), response.headers());
+    return uncResponse;
   }
 
   /// Sends a `PUT` request to the given endpoint to upload a resource.
@@ -251,6 +259,7 @@ public byte[] putResource(URI path, Path resource, String authToken) {
     try {
       uploadRequest =
           HttpRequest.newBuilder()
+              .header("Accept-Encoding", "gzip")
               .uri(path)
               .headers(
                   AUTHORIZATION, BEARER + authToken, CONTENT_TYPE, Files.probeContentType(resource))
@@ -271,8 +280,9 @@ public byte[] putResource(URI path, Path resource, String authToken) {
       Thread.currentThread().interrupt();
       throw new MatrixInterruptedException("This request has been interrupted", e);
     }
-    this.validateResponse(response);
-    return response.body();
+    var uncResponse = decompressIfNeeded(response);
+    this.validateResponse(uncResponse, response.statusCode(), response.headers());
+    return uncResponse;
   }
 
   /// Sends a `DELETE` request to the given endpoint.
@@ -287,6 +297,7 @@ public byte[] putResource(URI path, Path resource, String authToken) {
   public byte[] deleteRequest(URI path, String authToken) {
     HttpRequest deleteRequest =
         HttpRequest.newBuilder()
+            .header("Accept-Encoding", "gzip")
             .uri(path)
             .header(AUTHORIZATION, BEARER + authToken)
             .DELETE()
@@ -302,8 +313,9 @@ public byte[] deleteRequest(URI path, String authToken) {
       Thread.currentThread().interrupt();
       throw new MatrixInterruptedException("This request has been interrupted", e);
     }
-    this.validateResponse(response);
-    return response.body();
+    var uncResponse = decompressIfNeeded(response);
+    this.validateResponse(uncResponse, response.statusCode(), response.headers());
+    return uncResponse;
   }
 
   /// URL-encodes a string using UTF-8.
@@ -333,6 +345,23 @@ public URI generateEncodedURI(String baseUrl, String path, @Nullable Map<String,
     }
   }
 
+  /// Method to check if the server did return response as GZIP and then decompress it.
+  ///
+  /// @param response an HTTP Response.
+  /// @return a `byte` array.
+  private byte[] decompressIfNeeded(HttpResponse<byte[]> response) {
+    String encoding = response.headers().firstValue("Content-Encoding").orElse("");
+    if (!encoding.equalsIgnoreCase("gzip")) {
+      return response.body();
+    }
+    try (var gzip = new GZIPInputStream(new ByteArrayInputStream(response.body()))) {
+      logger.debug("Server has returned with GZIP compression. Decompressing response");
+      return gzip.readAllBytes();
+    } catch (IOException e) {
+      throw new MatrixIOException("Failed to decompress gzip response body", e);
+    }
+  }
+
   /// Builds a [URI] from a base, path, and query parameters. This method WON'T encode to UTF-8 the
   /// queries
   ///