Merge pull request #1295 from hmcts/DTSPB-4818-ObjectMapper-AUTO_CLOSE_JSON_CONTENT

Dtspb 4818 object mapper auto close json content

Author: MarcusHMCTS

charts/probate-orchestrator-service/Chart.yaml

@@ -1,7 +1,7 @@
 apiVersion: v2
 name: probate-orchestrator-service
 home: https://github.com/hmcts/probate-orchestrator-service
-version: 1.0.50
+version: 1.0.51
 description: HMCTS Probate Orchestrator Service
 maintainers:
   - name: HMCTS Probate Team

src/contractTest/java/uk/gov/hmcts/probate/contract/tests/BusinessServiceConsumerTest.java

@@ -9,6 +9,7 @@
 import au.com.dius.pact.core.model.RequestResponsePact;
 import com.fasterxml.jackson.databind.DeserializationFeature;
 import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.SerializationFeature;
 import io.pactfoundation.consumer.dsl.LambdaDslJsonArray;
 import org.json.JSONException;
 import org.json.JSONObject;
@@ -258,6 +259,8 @@ public void verifyExecuteValidationErrorsLegalDeclarationPact() throws JSONExcep
     @Test
     @PactTestFor(pactMethod = "executeSuccessGetLegalDeclarationPact")
     public void verifyExecuteSuccessGetLegalDeclarationPact() throws JSONException, IOException {
+        objectMapper.configure(DeserializationFeature.UNWRAP_ROOT_VALUE, true);
+        objectMapper.configure(SerializationFeature.WRAP_ROOT_VALUE, true);
         businessServiceApi.generateLegalDeclarationPDF(SOME_AUTHORIZATION_TOKEN, SOME_SERVICE_AUTHORIZATION_TOKEN,
             getLegalDeclaration("businessDocuments/validLegalDeclaration.json"));
 
@@ -266,6 +269,8 @@ public void verifyExecuteSuccessGetLegalDeclarationPact() throws JSONException,
     @Test
     @PactTestFor(pactMethod = "executeSuccessGetBulkScanCoversheetPact")
     public void verifyExecuteSuccessGetBulkScanCoversheetPact() throws JSONException, IOException {
+        objectMapper.configure(DeserializationFeature.UNWRAP_ROOT_VALUE, true);
+        objectMapper.configure(SerializationFeature.WRAP_ROOT_VALUE, true);
         businessServiceApi.generateBulkScanCoverSheetPDF(SOME_AUTHORIZATION_TOKEN, SOME_SERVICE_AUTHORIZATION_TOKEN,
             getBulkScanCoverSheet("businessDocuments/bulkScanCoverSheet.json"));
 

src/main/java/uk/gov/hmcts/probate/client/ResponseDecorator.java

@@ -8,21 +8,26 @@
 import uk.gov.hmcts.reform.probate.model.client.ErrorResponse;
 
 import java.io.IOException;
+import java.nio.charset.StandardCharsets;
 
 @Slf4j
 public class ResponseDecorator {
 
     private Response response;
 
-    public ResponseDecorator(Response response) {
+    private ObjectMapper objectMapper;
+
+    public ResponseDecorator(Response response, ObjectMapper objectMapper) {
+
         this.response = response;
+        this.objectMapper = objectMapper;
     }
 
     public String bodyToString() {
         String apiError = "";
         try {
             if (this.response.body() != null) {
-                apiError = Util.toString(this.response.body().asReader());
+                apiError = Util.toString(this.response.body().asReader(StandardCharsets.UTF_8));
             }
         } catch (IOException ignored) {
             log.debug("Unable to read response body");
@@ -31,10 +36,9 @@ public String bodyToString() {
     }
 
     public ErrorResponse mapToErrorResponse() {
-        ObjectMapper mapper = new ObjectMapper();
         ErrorResponse errorResponse = null;
         try {
-            errorResponse = mapper.readValue(this.bodyToString(), ErrorResponse.class);
+            errorResponse = this.objectMapper.readValue(this.bodyToString(), ErrorResponse.class);
         } catch (IOException e) {
             log.debug("Response contained empty body");
         }

src/main/java/uk/gov/hmcts/probate/client/business/BusinessServiceConfiguration.java

@@ -1,5 +1,6 @@
 package uk.gov.hmcts.probate.client.business;
 
+import com.fasterxml.jackson.core.JsonGenerator;
 import com.fasterxml.jackson.databind.DeserializationFeature;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.SerializationFeature;
@@ -20,6 +21,7 @@ Encoder feignEncoder() {
         ObjectMapper objectMapper = new ObjectMapper();
         objectMapper.enable(SerializationFeature.WRAP_ROOT_VALUE);
         objectMapper.enable(DeserializationFeature.UNWRAP_ROOT_VALUE);
+        objectMapper.disable(JsonGenerator.Feature.AUTO_CLOSE_JSON_CONTENT);
         return new JacksonEncoder(objectMapper);
     }
 

src/main/java/uk/gov/hmcts/probate/client/submit/SubmitServiceApiErrorDecoder.java

@@ -1,5 +1,6 @@
 package uk.gov.hmcts.probate.client.submit;
 
+import com.fasterxml.jackson.databind.ObjectMapper;
 import feign.Response;
 import feign.codec.ErrorDecoder;
 import lombok.extern.slf4j.Slf4j;
@@ -12,11 +13,17 @@
 @Slf4j
 public class SubmitServiceApiErrorDecoder implements ErrorDecoder {
 
+    private ObjectMapper objectMapper;
+
+    public SubmitServiceApiErrorDecoder(ObjectMapper objectMapper) {
+        this.objectMapper = objectMapper;
+    }
+
     @Override
     public Exception decode(String methodKey, Response response) {
         log.error("Response status: {}", response.status());
 
-        ResponseDecorator responseDecorator = new ResponseDecorator(response);
+        ResponseDecorator responseDecorator = new ResponseDecorator(response,this.objectMapper);
         ErrorResponse errorResponse = responseDecorator.mapToErrorResponse();
 
         return new ApiClientException(response.status(), errorResponse);

src/main/java/uk/gov/hmcts/probate/client/submit/SubmitServiceConfiguration.java

@@ -17,15 +17,16 @@ public class SubmitServiceConfiguration {
     static final String INVITATION_ID = "invitationId";
     static final String CASE_ID = "caseId";
 
+
     @Bean
     @Primary
     public Decoder feignDecoder(ObjectMapper objectMapper) {
         return new JacksonDecoder(objectMapper);
     }
 
     @Bean
-    public SubmitServiceApiErrorDecoder submitServiceApiErrorDecoder() {
-        return new SubmitServiceApiErrorDecoder();
+    public SubmitServiceApiErrorDecoder submitServiceApiErrorDecoder(ObjectMapper objectMapper) {
+        return new SubmitServiceApiErrorDecoder(objectMapper);
     }
 
     @Bean

src/main/java/uk/gov/hmcts/probate/configuration/JacksonConfigurationVerifier.java

@@ -0,0 +1,16 @@
+package uk.gov.hmcts.probate.configuration;
+
+import com.fasterxml.jackson.core.JsonGenerator;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import org.springframework.stereotype.Component;
+
+@Component
+public class JacksonConfigurationVerifier {
+
+    public JacksonConfigurationVerifier(ObjectMapper objectMapper) {
+        if (objectMapper.getFactory().isEnabled(JsonGenerator.Feature.AUTO_CLOSE_JSON_CONTENT)) {
+            throw new IllegalStateException("Jackson ObjectMapper is configured with AUTO_CLOSE_JSON_CONTENT enabled. "
+                    + "This can cause issues with streaming JSON responses and must be disabled.");
+        }
+    }
+}

src/main/java/uk/gov/hmcts/probate/configuration/ObjectMapperConfiguration.java

@@ -0,0 +1,37 @@
+package uk.gov.hmcts.probate.configuration;
+
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.core.JsonGenerator;
+import com.fasterxml.jackson.databind.DeserializationFeature;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.SerializationFeature;
+import com.fasterxml.jackson.databind.json.JsonMapper;
+import com.fasterxml.jackson.datatype.jdk8.Jdk8Module;
+import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
+import com.fasterxml.jackson.module.paramnames.ParameterNamesModule;
+import lombok.RequiredArgsConstructor;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.context.annotation.Primary;
+
+@Configuration
+@RequiredArgsConstructor
+public class ObjectMapperConfiguration {
+
+
+    @Bean
+    @Primary
+    public ObjectMapper objectMapper() {
+        return JsonMapper
+                .builder()
+                .addModule(new JavaTimeModule())
+                .addModule(new Jdk8Module())
+                .addModule(new ParameterNamesModule(JsonCreator.Mode.PROPERTIES))
+                .disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS)
+                .disable(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES)
+                .disable(JsonGenerator.Feature.AUTO_CLOSE_JSON_CONTENT)
+                .build();
+
+    }
+
+}

src/test/java/uk/gov/hmcts/probate/client/ResponseDecoratorTest.java

@@ -1,10 +1,13 @@
 package uk.gov.hmcts.probate.client;
 
+import com.fasterxml.jackson.databind.ObjectMapper;
 import feign.Request;
 import feign.Response;
 import feign.Util;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
 import org.springframework.http.HttpMethod;
 import org.springframework.test.context.junit.jupiter.SpringExtension;
 import uk.gov.hmcts.probate.TestUtils;
@@ -23,12 +26,16 @@
 import static org.junit.jupiter.api.Assertions.assertEquals;
 
 @ExtendWith(SpringExtension.class)
+@SpringBootTest
 public class ResponseDecoratorTest {
 
     private Map<String, Collection<String>> headers = new LinkedHashMap<>();
 
+    @Autowired
+    private ObjectMapper objectMapper;
+
     @Test
-    public void bodyToStringShouldReturnString() {
+    public void bodyToStringShouldReturnString() throws ReflectiveOperationException {
         Response response = Response.builder()
                 .status(400)
                 .reason("Bad Request")
@@ -37,7 +44,7 @@ public void bodyToStringShouldReturnString() {
                 .body("hello world", UTF_8)
                 .build();
 
-        ResponseDecorator responseDecorator = new ResponseDecorator(response);
+        ResponseDecorator responseDecorator = new ResponseDecorator(response,objectMapper);
         String body = responseDecorator.bodyToString();
 
         assertThat(body).isEqualTo("hello world");
@@ -52,7 +59,7 @@ public void bodyToStringShouldReturnEmptyStringIfResponseBodyIsNull() {
                 .headers(headers)
                 .build();
 
-        ResponseDecorator responseDecorator = new ResponseDecorator(response);
+        ResponseDecorator responseDecorator = new ResponseDecorator(response,objectMapper);
         String body = responseDecorator.bodyToString();
 
         assertThat(response.body()).isNull();
@@ -73,7 +80,7 @@ public int read() throws IOException {
                     }
                 }, 1)
                 .build();
-        ResponseDecorator responseDecorator = new ResponseDecorator(response);
+        ResponseDecorator responseDecorator = new ResponseDecorator(response,objectMapper);
 
         String body = responseDecorator.bodyToString();
 
@@ -92,7 +99,7 @@ public void mapToErrorResponseShouldReturnValidationErrorResponse() throws IOExc
                 .body(validationErrorResponse, UTF_8)
                 .build();
 
-        ResponseDecorator responseDecorator = new ResponseDecorator(response);
+        ResponseDecorator responseDecorator = new ResponseDecorator(response,objectMapper);
         ErrorResponse errorResponse = responseDecorator.mapToErrorResponse();
 
         assertThat(errorResponse.getType()).isEqualTo(ErrorType.VALIDATION);
@@ -110,7 +117,7 @@ public void mapToErrorResponseShouldReturnApiClientErrorResponse() throws IOExce
                 .body(apiClientErrorResponse, UTF_8)
                 .build();
 
-        ResponseDecorator responseDecorator = new ResponseDecorator(response);
+        ResponseDecorator responseDecorator = new ResponseDecorator(response,objectMapper);
         ErrorResponse errorResponse = responseDecorator.mapToErrorResponse();
 
         assertThat(errorResponse.getType()).isEqualTo(ErrorType.API_CLIENT);
@@ -126,7 +133,7 @@ public void mapToErrorResponseResponseBodyIsNull() {
                 .headers(headers)
                 .build();
 
-        ResponseDecorator responseDecorator = new ResponseDecorator(response);
+        ResponseDecorator responseDecorator = new ResponseDecorator(response,objectMapper);
         ErrorResponse errorResponse = responseDecorator.mapToErrorResponse();
 
         assertThat(errorResponse).isNull();

src/test/java/uk/gov/hmcts/probate/client/SubmitServiceApiErrorDecoderTest.java

@@ -1,10 +1,15 @@
 package uk.gov.hmcts.probate.client;
 
+import com.fasterxml.jackson.databind.ObjectMapper;
 import feign.Request;
 import feign.Response;
 import feign.Util;
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
 import org.springframework.http.HttpMethod;
+import org.springframework.test.context.junit.jupiter.SpringExtension;
 import uk.gov.hmcts.probate.client.submit.SubmitServiceApiErrorDecoder;
 import uk.gov.hmcts.reform.probate.model.client.ApiClientException;
 
@@ -15,15 +20,20 @@
 
 import static org.junit.jupiter.api.Assertions.assertThrows;
 
-
+@ExtendWith(SpringExtension.class)
+@SpringBootTest
 public class SubmitServiceApiErrorDecoderTest {
 
+    @Autowired
+    private ObjectMapper objectMapper;
+
     private Map<String, Collection<String>> headers = new LinkedHashMap<>();
 
-    private SubmitServiceApiErrorDecoder errorDecoder = new SubmitServiceApiErrorDecoder();
+    private SubmitServiceApiErrorDecoder errorDecoder;
 
     @Test
     public void throwsApiClientException() throws Throwable {
+        errorDecoder = new SubmitServiceApiErrorDecoder(objectMapper);
         assertThrows(ApiClientException.class, () -> {
             Response response = Response.builder()
                     .status(500)
@@ -32,7 +42,6 @@ public void throwsApiClientException() throws Throwable {
                             "/api", Collections.emptyMap(), null, Util.UTF_8))
                     .headers(headers)
                     .build();
-
             throw errorDecoder.decode("Service#foo()", response);
         });