Ovverride default ApiError message with the error message from the API response (#1447)

* Improve comments

* Refactor to expose the error message

Author: gcatanese

src/main/java/com/adyen/service/exception/ApiException.java

@@ -25,16 +25,19 @@
 import com.adyen.model.ApiError;
 
 /**
- * API Exception class
+ * API Exception thrown when there is an API error
+ *
+ * Check ApiError object to obtain the information about the error
  */
 public class ApiException extends Exception {
-    //Describes the error
+    // Object with the information about the error
     private ApiError error;
 
-    //HTTP status code
+    // HTTP status code
     private int statusCode;
 
     private Map<String, List<String>> responseHeaders;
+    // error JSON response
     private String responseBody;
 
     public ApiException(String message, int statusCode) {

src/main/java/com/adyen/service/resource/Resource.java

@@ -23,15 +23,11 @@
 import com.adyen.Config;
 import com.adyen.Service;
 import com.adyen.constants.ApiConstants;
-import com.adyen.enums.Environment;
 import com.adyen.httpclient.ClientInterface;
 import com.adyen.httpclient.HTTPClientException;
 import com.adyen.model.ApiError;
 import com.adyen.model.RequestOptions;
 import com.adyen.service.exception.ApiException;
-import com.fasterxml.jackson.core.JacksonException;
-import com.fasterxml.jackson.databind.exc.MismatchedInputException;
-import com.google.gson.Gson;
 
 import java.io.IOException;
 import java.util.List;
@@ -97,14 +93,14 @@ public String request(String json, RequestOptions requestOptions, ApiConstants.H
     /**
      * Request using json String with additional request parameters like idempotency-key
      *
-     * @param json   json
+     * @param json body of the request
      * @param requestOptions request options
      * @param httpMethod http method
      * @param pathParams path parameters
      * @param queryString query string parameters
-     * @throws ApiException apiException
-     * @throws IOException  IOException
-     * @return request
+     * @throws ApiException apiException when an API error is returned
+     * @throws IOException IOException when an unexpected error occurs
+     * @return JSON response
      */
     public String request(String json, RequestOptions requestOptions, ApiConstants.HttpMethod httpMethod, Map<String, String> pathParams, Map<String, String> queryString) throws ApiException, IOException {
         ClientInterface clientInterface = service.getClient().getHttpClient();
@@ -113,12 +109,19 @@ public String request(String json, RequestOptions requestOptions, ApiConstants.H
         try {
             return clientInterface.request(resolve(pathParams), json, config, service.isApiKeyRequired(), requestOptions, httpMethod, queryString);
         } catch (HTTPClientException e) {
-            apiException = new ApiException(e.getMessage(), e.getCode(), e.getResponseHeaders());
-            apiException.setResponseBody(e.getResponseBody());
             try {
-                apiException.setError(ApiError.fromJson(e.getResponseBody()));
+                // build ApiException
+                ApiError apiError = ApiError.fromJson(e.getResponseBody());
+                String message = apiError.getMessage() + " ErrorCode: "+ apiError.getErrorCode();
+
+                apiException = new ApiException(message, e.getCode(), e.getResponseHeaders());
+                apiException.setResponseBody(e.getResponseBody());
+                apiException.setError(apiError);
+
             } catch (Exception ignore) {
                 // Response body could not be parsed (e.g. not JSON), raw response body available in ApiException#responseBody
+                apiException = new ApiException(e.getMessage(), e.getCode(), e.getResponseHeaders());
+                apiException.setResponseBody(e.getResponseBody());
             }
         }
         throw apiException;

src/test/java/com/adyen/BaseTest.java

@@ -304,15 +304,16 @@ protected PaymentRequest3ds2 create3DS2PaymentRequest() {
     }
 
     /**
-     * Returns a Client that has a mocked error response from fileName
+     * Returns a Client that throws an exception with a given status and response
      */
     protected Client createMockClientForErrors(int status, String fileName) {
         String response = getFileContents(fileName);
 
         AdyenHttpClient adyenHttpClient = mock(AdyenHttpClient.class);
         HTTPClientException httpClientException = new HTTPClientException(status, "An error occured", new HashMap<>(), response);
         try {
-            when(adyenHttpClient.request(anyString(), anyString(), any(Config.class), anyBoolean(), isNull(), any(), any())).thenThrow(httpClientException);
+            when(adyenHttpClient.request(anyString(), anyString(), any(Config.class), anyBoolean(), isNull(), any(), any()))
+                    .thenThrow(httpClientException);
         } catch (IOException | HTTPClientException e) {
             fail("Unexpected exception: " + e.getMessage());
         }

src/test/java/com/adyen/service/ResourceTest.java

@@ -142,6 +142,7 @@ public void testValidationException() throws IOException {
             fail("Expected exception");
         } catch (ApiException e) {
             assertEquals(422, e.getStatusCode());
+            assertEquals("Required field 'reference' is not provided. ErrorCode: 130", e.getMessage());
             assertNotNull(e.getError());
             assertEquals("validation", e.getError().getErrorType());
             assertEquals("Required field 'reference' is not provided.", e.getError().getMessage());
@@ -160,10 +161,28 @@ public void testErrorRfc7807ValidationException() throws IOException {
             fail("Expected exception");
         } catch (ApiException e) {
             assertEquals(422, e.getStatusCode());
+            assertEquals("Invalid legal entity information provided ErrorCode: 30_102", e.getMessage());
             assertNotNull(e.getError());
             assertEquals("https://docs.adyen.com/errors/validation", e.getError().getErrorType());
             assertEquals("Invalid legal entity information provided", e.getError().getMessage());
             assertEquals(1, e.getError().getInvalidFields().size());
         }
     }
+
+    // test error parsing when the JSON response is invalid
+    @Test
+    public void testValidationExceptionWithInvalidJsonResponse() throws IOException {
+        Client client = createMockClientForErrors(422, "mocks/response-validation-error-invalid-json.json");
+
+        when(serviceMock.getClient()).thenReturn(client);
+        try {
+            Resource resource = new Resource(serviceMock, "", null);
+            resource.request("request");
+
+            fail("Expected exception");
+        } catch (ApiException e) {
+            assertEquals(422, e.getStatusCode());
+            assertNull(e.getError());
+        }
+    }
 }

src/test/resources/mocks/response-validation-error-invalid-json.json

@@ -0,0 +1,9 @@
+{
+  "status" : 422,
+  "errorCode" : "130",
+  "message" : "Required field 'reference' is not provided.",
+  "errorType" : "validation",
+  "pspReference" : "ABCDEFGHIJKLMNO",
+  ...
+  // testing invalid JSON
+}