Merge pull request #85 from AnswerConsulting/BENCH-155

AudriusPutys · web-flow · commit 2847d0a1348b · 2022-11-25T15:37:09.000Z
Bench 155 - Error handling updated to match API Contract
diff --git a/src/main/java/com/answerdigital/answerking/exception/AnswerKingException.java b/src/main/java/com/answerdigital/answerking/exception/AnswerKingException.java
@@ -1,6 +1,5 @@
 package com.answerdigital.answerking.exception;
 
-import java.util.Collection;
 import lombok.Getter;
 import org.springframework.http.HttpStatus;
 
@@ -15,20 +14,16 @@ public abstract class AnswerKingException extends RuntimeException {
 
     private final String detail;
 
-    private final Collection<String> errors;
-
     protected AnswerKingException(
             final String type,
             final String title,
             final HttpStatus status,
-            final String detail,
-            final Collection<String> errors
+            final String detail
     ) {
-        super(errors.toString());
+        super(detail);
         this.type = type;
         this.title = title;
         this.status = status;
         this.detail = detail;
-        this.errors = errors;
     }
 }
diff --git a/src/main/java/com/answerdigital/answerking/exception/custom/NameUnavailableException.java b/src/main/java/com/answerdigital/answerking/exception/custom/NameUnavailableException.java
@@ -2,12 +2,7 @@
 
 import com.answerdigital.answerking.exception.generic.BadRequestException;
 
-import java.util.Collection;
-
 public class NameUnavailableException extends BadRequestException {
-    public NameUnavailableException(final Collection<String> errors) {
-        super(errors);
-    }
 
     public NameUnavailableException(final String error) {
         super(error);
diff --git a/src/main/java/com/answerdigital/answerking/exception/custom/ProductAlreadyPresentException.java b/src/main/java/com/answerdigital/answerking/exception/custom/ProductAlreadyPresentException.java
@@ -2,12 +2,7 @@
 
 import com.answerdigital.answerking.exception.generic.BadRequestException;
 
-import java.util.Collection;
-
 public class ProductAlreadyPresentException extends BadRequestException {
-    public ProductAlreadyPresentException(final Collection<String> errors) {
-        super(errors);
-    }
 
     public ProductAlreadyPresentException(final String error) {
         super(error);
diff --git a/src/main/java/com/answerdigital/answerking/exception/custom/RetirementException.java b/src/main/java/com/answerdigital/answerking/exception/custom/RetirementException.java
@@ -3,9 +3,6 @@
 import com.answerdigital.answerking.exception.AnswerKingException;
 import org.springframework.http.HttpStatus;
 
-import java.util.Collection;
-import java.util.List;
-
 public class RetirementException extends AnswerKingException {
 
     private static final String TYPE = "https://www.rfc-editor.org/rfc/rfc7231";
@@ -14,13 +11,8 @@ public class RetirementException extends AnswerKingException {
 
     private static final HttpStatus STATUS = HttpStatus.GONE;
 
-    private static final String DETAIL = null;
-
-    public RetirementException(final Collection<String> errors) {
-        super(TYPE, TITLE, STATUS, DETAIL, errors);
-    }
-
     public RetirementException(final String error) {
-        this(List.of(error));
+        super(TYPE, TITLE, STATUS, error);
     }
+
 }
diff --git a/src/main/java/com/answerdigital/answerking/exception/custom/ValidationException.java b/src/main/java/com/answerdigital/answerking/exception/custom/ValidationException.java
@@ -0,0 +1,22 @@
+package com.answerdigital.answerking.exception.custom;
+
+import com.answerdigital.answerking.exception.generic.BadRequestException;
+import lombok.Getter;
+
+import java.util.Collection;
+import java.util.Map;
+
+@Getter
+public class ValidationException extends BadRequestException {
+
+    private static final String TITLE = "Validation Exception";
+
+    private static final String DETAIL = "One or more validation errors occurred";
+
+    private final Map<String, Collection<String>> errors;
+
+    public ValidationException(final Map<String, Collection<String>> errors) {
+        super(DETAIL);
+        this.errors = errors;
+    }
+}
diff --git a/src/main/java/com/answerdigital/answerking/exception/generic/BadRequestException.java b/src/main/java/com/answerdigital/answerking/exception/generic/BadRequestException.java
@@ -3,9 +3,6 @@
 import com.answerdigital.answerking.exception.AnswerKingException;
 import org.springframework.http.HttpStatus;
 
-import java.util.Collection;
-import java.util.List;
-
 public class BadRequestException extends AnswerKingException {
 
     private static final String TYPE = "https://www.rfc-editor.org/rfc/rfc7231";
@@ -14,13 +11,7 @@ public class BadRequestException extends AnswerKingException {
 
     private static final HttpStatus STATUS = HttpStatus.BAD_REQUEST;
 
-    private static final String DETAIL = null;
-
-    public BadRequestException(final Collection<String> errors) {
-        super(TYPE, TITLE, STATUS, DETAIL, errors);
-    }
-
     public BadRequestException(final String error) {
-        this(List.of(error));
+        super(TYPE, TITLE, STATUS, error);
     }
 }
diff --git a/src/main/java/com/answerdigital/answerking/exception/generic/ConflictException.java b/src/main/java/com/answerdigital/answerking/exception/generic/ConflictException.java
@@ -3,9 +3,6 @@
 import com.answerdigital.answerking.exception.AnswerKingException;
 import org.springframework.http.HttpStatus;
 
-import java.util.Collection;
-import java.util.List;
-
 public class ConflictException extends AnswerKingException {
 
     private static final String TYPE = "https://www.rfc-editor.org/rfc/rfc7231";
@@ -14,13 +11,8 @@ public class ConflictException extends AnswerKingException {
 
     private static final HttpStatus STATUS = HttpStatus.CONFLICT;
 
-    private static final String DETAIL = null;
-
-    public ConflictException(final Collection<String> errors) {
-        super(TYPE, TITLE, STATUS, DETAIL, errors);
-    }
-
     public ConflictException(final String error) {
-        this(List.of(error));
+        super(TYPE, TITLE, STATUS, error);
     }
+
 }
diff --git a/src/main/java/com/answerdigital/answerking/exception/generic/InternalServerErrorException.java b/src/main/java/com/answerdigital/answerking/exception/generic/InternalServerErrorException.java
@@ -3,9 +3,6 @@
 import com.answerdigital.answerking.exception.AnswerKingException;
 import org.springframework.http.HttpStatus;
 
-import java.util.Collection;
-import java.util.List;
-
 public class InternalServerErrorException extends AnswerKingException {
 
     private static final String TYPE = "https://www.rfc-editor.org/rfc/rfc7231";
@@ -14,13 +11,8 @@ public class InternalServerErrorException extends AnswerKingException {
 
     private static final HttpStatus STATUS = HttpStatus.INTERNAL_SERVER_ERROR;
 
-    private static final String DETAIL = null;
-
-    public InternalServerErrorException(final Collection<String> errors) {
-        super(TYPE, TITLE, STATUS, DETAIL, errors);
-    }
-
     public InternalServerErrorException(final String error) {
-        this(List.of(error));
+        super(TYPE, TITLE, STATUS, error);
     }
+
 }
diff --git a/src/main/java/com/answerdigital/answerking/exception/generic/NotFoundException.java b/src/main/java/com/answerdigital/answerking/exception/generic/NotFoundException.java
@@ -3,9 +3,6 @@
 import com.answerdigital.answerking.exception.AnswerKingException;
 import org.springframework.http.HttpStatus;
 
-import java.util.Collection;
-import java.util.List;
-
 public class NotFoundException extends AnswerKingException {
 
     private static final String TYPE = "https://www.rfc-editor.org/rfc/rfc7231";
@@ -14,13 +11,7 @@ public class NotFoundException extends AnswerKingException {
 
     private static final HttpStatus STATUS = HttpStatus.NOT_FOUND;
 
-    private static final String DETAIL = null;
-
-    public NotFoundException(final Collection<String> errors) {
-        super(TYPE, TITLE, STATUS, DETAIL, errors);
-    }
-
     public NotFoundException(final String error) {
-        this(List.of(error));
+        super(TYPE, TITLE, STATUS, error);
     }
 }
diff --git a/src/main/java/com/answerdigital/answerking/exception/util/ErrorResponse.java b/src/main/java/com/answerdigital/answerking/exception/util/ErrorResponse.java
@@ -5,7 +5,6 @@
 import lombok.extern.slf4j.Slf4j;
 
 import javax.servlet.http.HttpServletRequest;
-import java.util.Collection;
 
 @Slf4j
 @Getter
@@ -21,8 +20,6 @@ public class ErrorResponse {
 
     private final String instance;
 
-    private final Collection<String> errors;
-
     private final String traceId;
 
     public ErrorResponse(final AnswerKingException exception, final HttpServletRequest request) {
@@ -31,12 +28,11 @@ public ErrorResponse(final AnswerKingException exception, final HttpServletReque
         this.status = exception.getStatus().value();
         this.detail = exception.getDetail();
         this.instance = request.getRequestURI();
-        this.errors = exception.getErrors();
         this.traceId = CorrelationId.getId();
 
         log.error(String.format(
-                "RETURNING EXCEPTION - TYPE: %s - TITLE: %s - STATUS: %s - DETAIL: %s - INSTANCE: %s - ERRORS: %s - TRACEID: %s",
-                type, title, status, detail, instance, errors.toString(), traceId)
+                "RETURNING EXCEPTION - TYPE: %s - TITLE: %s - STATUS: %s - DETAIL: %s - INSTANCE: %s - TRACEID: %s",
+                type, title, status, detail, instance, traceId)
         );
     }
 }
diff --git a/src/main/java/com/answerdigital/answerking/exception/util/RestResponseEntityExceptionHandler.java b/src/main/java/com/answerdigital/answerking/exception/util/RestResponseEntityExceptionHandler.java
@@ -1,6 +1,7 @@
 package com.answerdigital.answerking.exception.util;
 
 import com.answerdigital.answerking.exception.AnswerKingException;
+import com.answerdigital.answerking.exception.custom.ValidationException;
 import com.answerdigital.answerking.exception.generic.BadRequestException;
 import com.answerdigital.answerking.exception.generic.InternalServerErrorException;
 import org.springframework.http.HttpStatus;
@@ -12,8 +13,12 @@
 import javax.servlet.http.HttpServletRequest;
 import javax.validation.ConstraintViolation;
 import javax.validation.ConstraintViolationException;
-import java.util.List;
+import java.util.ArrayList;
+import java.util.Collection;
+import java.util.HashMap;
+import java.util.Map;
 import java.util.Objects;
+import java.util.stream.StreamSupport;
 
 @RestControllerAdvice
 public class RestResponseEntityExceptionHandler {
@@ -37,13 +42,25 @@ public ResponseEntity<ErrorResponse> handleMethodArgumentNotValidException(
     @ExceptionHandler(ConstraintViolationException.class)
     public ResponseEntity<ErrorResponse> handleConstraintViolationException(
             final ConstraintViolationException exception,
-            final HttpServletRequest request ) {
+            final HttpServletRequest request) {
+
+        final Map<String, Collection<String>> errorsMap = new HashMap<>();
+        for (ConstraintViolation<?> constraintViolation : exception.getConstraintViolations()) {
+            final String mapKey = Objects.requireNonNull(StreamSupport
+                    .stream(constraintViolation.getPropertyPath().spliterator(), false)
+                    .reduce((first, second) -> second)
+                    .orElse(null)).toString();
 
-        final List<String> errorMessages = exception.getConstraintViolations().stream()
-                .map(ConstraintViolation::getMessage)
-                .toList();
+            if (errorsMap.containsKey(mapKey)) {
+                errorsMap.get(mapKey).add(constraintViolation.getMessage());
+            } else {
+                final Collection<String> newCollection = new ArrayList<>();
+                newCollection.add(constraintViolation.getMessage());
+                errorsMap.put(mapKey, newCollection);
+            }
+        }
 
-        final ErrorResponse response = new ErrorResponse(new BadRequestException(errorMessages), request);
+        final ErrorResponse response = new ValidationErrorResponse(new ValidationException(errorsMap), request);
         return new ResponseEntity<>(response, HttpStatus.BAD_REQUEST);
     }
 
diff --git a/src/main/java/com/answerdigital/answerking/exception/util/ValidationErrorResponse.java b/src/main/java/com/answerdigital/answerking/exception/util/ValidationErrorResponse.java
@@ -0,0 +1,21 @@
+package com.answerdigital.answerking.exception.util;
+
+import com.answerdigital.answerking.exception.custom.ValidationException;
+import lombok.Getter;
+import lombok.extern.slf4j.Slf4j;
+
+import javax.servlet.http.HttpServletRequest;
+import java.util.Collection;
+import java.util.Map;
+
+@Slf4j
+@Getter
+public class ValidationErrorResponse extends ErrorResponse {
+
+    private final Map<String, Collection<String>> errors;
+
+    public ValidationErrorResponse(final ValidationException exception, final HttpServletRequest request) {
+        super(exception, request);
+        this.errors = exception.getErrors();
+    }
+}
diff --git a/src/main/java/com/answerdigital/answerking/request/ProductRequest.java b/src/main/java/com/answerdigital/answerking/request/ProductRequest.java
@@ -20,7 +20,7 @@ public record ProductRequest(
         String description,
 
         @Digits(integer = 12, fraction = 2, message = "Product price is invalid")
-        @DecimalMin(value = "0.0", inclusive = false, message = "Product price is invalid")
+        @DecimalMin(value = "0.0", inclusive = false, message = "Product price cannot be less than 0")
         @NotNull
         BigDecimal price
 ) {
