Alex's review

Author: CharlesDuboisSAP

datamodel/openapi/openapi-core-apache/pom.xml

@@ -94,5 +94,15 @@
             <artifactId>junit-jupiter-params</artifactId>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.mockito</groupId>
+            <artifactId>mockito-core</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>io.vavr</groupId>
+            <artifactId>vavr</artifactId>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
-</project>
+</project>

datamodel/openapi/openapi-core-apache/src/main/java/com/sap/cloud/sdk/services/openapi/apache/apiclient/ApiClient.java

@@ -14,6 +14,7 @@
 
 import static com.sap.cloud.sdk.services.openapi.apache.apiclient.DefaultApiResponseHandler.isJsonMime;
 import static lombok.AccessLevel.PRIVATE;
+import static org.apache.hc.core5.http.HttpHeaders.CONTENT_ENCODING;
 
 import java.io.ByteArrayOutputStream;
 import java.io.File;
@@ -492,7 +493,7 @@ public <T> T invokeAPI(
         if( body != null || !formParams.isEmpty() ) {
             if( isBodyAllowed(Method.valueOf(method)) ) {
                 // Add entity if we have content and a valid method
-                builder.setEntity(serialize(body, formParams, contentTypeObj, headerParams.get("Content-Encoding")));
+                builder.setEntity(serialize(body, formParams, contentTypeObj, headerParams));
             } else {
                 throw new OpenApiRequestException("method " + method + " does not support a request body");
             }
@@ -520,6 +521,8 @@ public <T> T invokeAPI(
      *            Content type
      * @param formParams
      *            Form parameters
+     * @param headerParams
+     *            Header parameters, used to check content encoding for JSON serialization
      * @return Object
      * @throws OpenApiRequestException
      *             API exception
@@ -529,12 +532,12 @@ private HttpEntity serialize(
         @Nullable final Object body,
         @Nonnull final Map<String, Object> formParams,
         @Nonnull final ContentType contentType,
-        @Nullable final String contentEncoding )
+        @Nonnull final Map<String, String> headerParams )
         throws OpenApiRequestException
     {
         final String mimeType = contentType.getMimeType();
         if( isJsonMime(mimeType) ) {
-            return serializeJson(body, contentType, contentEncoding);
+            return serializeJson(body, contentType, headerParams);
         } else if( mimeType.equals(ContentType.MULTIPART_FORM_DATA.getMimeType()) ) {
             return serializeMultipart(formParams, contentType);
         } else if( mimeType.equals(ContentType.APPLICATION_FORM_URLENCODED.getMimeType()) ) {
@@ -551,18 +554,22 @@ private HttpEntity serialize(
     private HttpEntity serializeJson(
         @Nullable final Object body,
         @Nonnull final ContentType contentType,
-        @Nullable final String contentEncoding )
+        @Nonnull final Map<String, String> headerParams )
         throws OpenApiRequestException
     {
-        if( "gzip".equals(contentEncoding) ) {
+        if( "gzip".equalsIgnoreCase(headerParams.get(CONTENT_ENCODING))
+            || "gzip".equalsIgnoreCase(headerParams.get(CONTENT_ENCODING.toLowerCase())) ) {
             val outputStream = new ByteArrayOutputStream();
             try( val gzip = new GZIPOutputStream(outputStream) ) {
                 gzip.write(objectMapper.writeValueAsBytes(body));
             }
             catch( IOException e ) {
-                throw new OpenApiRequestException(e);
+                throw new OpenApiRequestException("Failed to GZIP compress request body", e);
             }
-            return new ByteArrayEntity(outputStream.toByteArray(), contentType.withCharset(StandardCharsets.UTF_8));
+            return new ByteArrayEntity(
+                outputStream.toByteArray(),
+                contentType.withCharset(StandardCharsets.UTF_8),
+                "gzip");
         }
         try {
             return new StringEntity(

datamodel/openapi/openapi-core-apache/src/test/java/com/sap/cloud/sdk/services/openapi/apache/apiclient/ApacheApiClientResponseHandlingTest.java

@@ -10,22 +10,30 @@
 import static com.github.tomakehurst.wiremock.client.WireMock.verify;
 import static org.assertj.core.api.Assertions.assertThat;
 
+import java.nio.charset.StandardCharsets;
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.concurrent.atomic.AtomicReference;
+import java.util.zip.GZIPInputStream;
 
+import org.apache.hc.client5.http.impl.classic.CloseableHttpClient;
+import org.apache.hc.core5.http.protocol.HttpContext;
 import org.junit.jupiter.api.Test;
+import org.mockito.Mockito;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.core.type.TypeReference;
 import com.github.tomakehurst.wiremock.junit5.WireMockRuntimeInfo;
 import com.github.tomakehurst.wiremock.junit5.WireMockTest;
+import com.sap.cloud.sdk.cloudplatform.connectivity.ApacheHttpClient5Accessor;
 import com.sap.cloud.sdk.services.openapi.apache.core.OpenApiRequestException;
 import com.sap.cloud.sdk.services.openapi.apache.core.OpenApiResponse;
 
+import io.vavr.control.Try;
 import lombok.Data;
+import lombok.SneakyThrows;
 
 @WireMockTest
 class ApacheApiClientResponseHandlingTest
@@ -88,14 +96,19 @@ void testCaseInsensitiveHeaderLookup( final WireMockRuntimeInfo wmInfo )
     }
 
     @Test
+    @SneakyThrows
     void testGzipEncodedPayload( final WireMockRuntimeInfo wmInfo )
     {
         stubFor(post(urlEqualTo(TEST_POST_PATH)).willReturn(aResponse().withStatus(200).withBody(TEST_RESPONSE_BODY)));
 
-        final ApiClient apiClient = ApiClient.create().withBasePath(wmInfo.getHttpBaseUrl());
-
+        final CloseableHttpClient client = Mockito.spy((CloseableHttpClient) ApacheHttpClient5Accessor.getHttpClient());
+        final ApiClient apiClient = ApiClient.fromHttpClient(client).withBasePath(wmInfo.getHttpBaseUrl());
         final TestPostApi api = new TestPostApi(apiClient);
         final TestResponse result = api.executeGzipRequest();
+        Mockito.verify(client, Mockito.times(1)).execute(Mockito.argThat(request -> {
+            final byte[] c = Try.of(() -> new GZIPInputStream(request.getEntity().getContent()).readAllBytes()).get();
+            return new String(c, StandardCharsets.UTF_8).contains("test payload");
+        }), Mockito.any(HttpContext.class), Mockito.any());
 
         assertThat(result).isNotNull();
         assertThat(result.getMessage()).isEqualTo("success");