Merge pull request #384 from Adyen/feature/AD-219-1

AD-219 Enhance Error Handling for Payment and Order Placement Steps
Adyen · Apr 3, 2024 · 5ce94dc · 5ce94dc
2 parents b98b70d + 360d1c4
commit 5ce94dc
Show file tree

Hide file tree

Showing 38 changed files with 495 additions and 107 deletions.
diff --git a/...eleratoraddon/web/src/com/adyen/commerce/constants/AdyencheckoutaddonapiWebConstants.java b/...eleratoraddon/web/src/com/adyen/commerce/constants/AdyencheckoutaddonapiWebConstants.java
@@ -4,7 +4,7 @@
 package com.adyen.commerce.constants;
 
 /**
- * Global class for all Adyenv6b2ccheckoutaddonv2 web constants. You can add global constants for your extension into this class.
+ * Global class for all adyencheckoutaddonapi web constants. You can add global constants for your extension into this class.
  */
 public final class AdyencheckoutaddonapiWebConstants
 {

diff --git a/...i/acceleratoraddon/web/src/com/adyen/commerce/controllers/api/AdyenAddressController.java b/...i/acceleratoraddon/web/src/com/adyen/commerce/controllers/api/AdyenAddressController.java
@@ -1,5 +1,8 @@
 package com.adyen.commerce.controllers.api;
 
+import com.adyen.commerce.exceptions.AdyenControllerException;
+
+import com.adyen.commerce.response.ErrorResponse;
 import de.hybris.platform.acceleratorstorefrontcommons.annotations.RequireHardLogIn;
 import de.hybris.platform.acceleratorstorefrontcommons.forms.AddressForm;
 import de.hybris.platform.acceleratorstorefrontcommons.forms.validation.AddressValidator;
@@ -55,11 +58,11 @@ public ResponseEntity<List<AddressData>> getAllDeliveryAddresses() {
 
     @RequireHardLogIn
     @PostMapping(value = "/delivery-address")
-    public ResponseEntity<AddressData> addDeliveryAddress(@RequestBody AddressForm addressForm) {
+    public ResponseEntity<Void> addDeliveryAddress(@RequestBody AddressForm addressForm) {
         final Errors errors = new BeanPropertyBindingResult(addressForm, "address");
         addressValidator.validate(addressForm, errors);
         if (errors.hasErrors()) {
-            return ResponseEntity.status(HttpStatus.BAD_REQUEST).build();
+            throw new AdyenControllerException("checkout.deliveryAddress.notSelected");
         }
 
         AddressData addressData = addressDataUtil.convertToAddressData(addressForm);
@@ -82,17 +85,17 @@ public ResponseEntity<AddressData> addDeliveryAddress(@RequestBody AddressForm a
 
             return ResponseEntity.status(HttpStatus.CREATED).build();
         } else {
-            return ResponseEntity.status(HttpStatus.BAD_REQUEST).build();
+            throw new AdyenControllerException();
         }
     }
 
     @RequireHardLogIn
     @PutMapping(value = "/delivery-address")
-    public ResponseEntity<AddressData> updateDeliveryAddress(@RequestBody AddressForm addressForm) {
+    public ResponseEntity<Void> updateDeliveryAddress(@RequestBody AddressForm addressForm) {
         final Errors errors = new BeanPropertyBindingResult(addressForm, "address");
         addressValidator.validate(addressForm, errors);
         if (errors.hasErrors()) {
-            return ResponseEntity.status(HttpStatus.BAD_REQUEST).build();
+            throw new AdyenControllerException("checkout.deliveryAddress.notSelected");
         }
 
         AddressData addressData = addressDataUtil.convertToAddressData(addressForm);
@@ -105,16 +108,16 @@ public ResponseEntity<AddressData> updateDeliveryAddress(@RequestBody AddressFor
 
                 return ResponseEntity.status(HttpStatus.OK).build();
             } else {
-                return ResponseEntity.status(HttpStatus.BAD_REQUEST).build();
+                throw new AdyenControllerException();
             }
         } else {
-            return ResponseEntity.status(HttpStatus.BAD_REQUEST).build();
+            throw new AdyenControllerException();
         }
     }
 
     @RequireHardLogIn
     @DeleteMapping(value = "/delivery-address/{addressId}")
-    public ResponseEntity<HttpStatus> removeDeliveryAddress(@PathVariable String addressId) {
+    public ResponseEntity<Void> removeDeliveryAddress(@PathVariable String addressId) {
         if (userFacade.getAddressBook().stream().anyMatch(ad -> Objects.equals(ad.getId(), addressId))) {
             AddressData addressData = userFacade.getAddressForCode(addressId);
 
@@ -123,7 +126,7 @@ public ResponseEntity<HttpStatus> removeDeliveryAddress(@PathVariable String add
 
             return ResponseEntity.status(HttpStatus.NO_CONTENT).build();
         } else {
-            return ResponseEntity.status(HttpStatus.BAD_REQUEST).build();
+            throw new AdyenControllerException();
         }
     }
 

diff --git a/...e/controllers/api/TempCartController.java → .../controllers/api/AdyenCartController.java b/...e/controllers/api/TempCartController.java → .../controllers/api/AdyenCartController.java
@@ -10,7 +10,7 @@
 
 @Controller
 @RequestMapping(value = "/api/checkout")
-public class TempCartController {
+public class AdyenCartController {
 
     @Autowired
     private CartFacade cartFacade;

diff --git a/...eratoraddon/web/src/com/adyen/commerce/controllers/api/AdyenDeliveryAddressContoller.java b/...eratoraddon/web/src/com/adyen/commerce/controllers/api/AdyenDeliveryAddressContoller.java
@@ -1,5 +1,8 @@
 package com.adyen.commerce.controllers.api;
 
+
+import com.adyen.commerce.exceptions.AdyenControllerException;
+import com.adyen.commerce.response.ErrorResponse;
 import de.hybris.platform.acceleratorstorefrontcommons.annotations.RequireHardLogIn;
 import de.hybris.platform.commercefacades.order.CheckoutFacade;
 import de.hybris.platform.commercefacades.user.UserFacade;
@@ -27,29 +30,24 @@ public class AdyenDeliveryAddressContoller {
 
     @PostMapping(value = "/delivery-address")
     @RequireHardLogIn
-    public ResponseEntity<HttpStatus>  doSelectDeliveryAddress(@RequestBody final String selectedAddressCode)
-    {
-        if (StringUtils.isNotBlank(selectedAddressCode))
-        {
+    public ResponseEntity<Void> doSelectDeliveryAddress(@RequestBody final String selectedAddressCode) {
+        if (StringUtils.isNotBlank(selectedAddressCode)) {
             final AddressData selectedAddressData = getCheckoutFacade().getDeliveryAddressForCode(selectedAddressCode);
             final boolean hasSelectedAddressData = selectedAddressData != null;
-            if (hasSelectedAddressData)
-            {
+            if (hasSelectedAddressData) {
                 setDeliveryAddress(selectedAddressData);
                 return ResponseEntity.status(HttpStatus.ACCEPTED).build();
             }
             return ResponseEntity.status(HttpStatus.NOT_FOUND).build();
         }
-        return ResponseEntity.status(HttpStatus.BAD_REQUEST).build();
+        throw new AdyenControllerException("checkout.deliveryAddress.notSelected");
     }
 
     @GetMapping(value = "/delivery-address")
     @RequireHardLogIn
-    public ResponseEntity<AddressData> getSelectedDeliveryAddress()
-    {
+    public ResponseEntity<AddressData> getSelectedDeliveryAddress() {
         final AddressData selectedAddressData = getCheckoutFacade().getCheckoutCart().getDeliveryAddress();
-        if (selectedAddressData != null)
-        {
+        if (selectedAddressData != null) {
             return ResponseEntity.status(HttpStatus.OK).body(selectedAddressData);
         }
         return ResponseEntity.status(HttpStatus.NOT_FOUND).build();
@@ -65,8 +63,7 @@ protected void setDeliveryAddress(final AddressData selectedAddressData) {
         }
     }
 
-    protected boolean isAddressIdChanged(final AddressData cartCheckoutDeliveryAddress, final AddressData selectedAddressData)
-    {
+    protected boolean isAddressIdChanged(final AddressData cartCheckoutDeliveryAddress, final AddressData selectedAddressData) {
         return cartCheckoutDeliveryAddress == null || !selectedAddressData.getId().equals(cartCheckoutDeliveryAddress.getId());
     }
 

diff --git a/...ratoraddon/web/src/com/adyen/commerce/controllers/api/AdyenDeliveryMethodsController.java b/...ratoraddon/web/src/com/adyen/commerce/controllers/api/AdyenDeliveryMethodsController.java
@@ -1,10 +1,10 @@
 package com.adyen.commerce.controllers.api;
 
+import com.adyen.commerce.exceptions.AdyenControllerException;
+import com.adyen.commerce.response.ErrorResponse;
 import de.hybris.platform.acceleratorstorefrontcommons.annotations.RequireHardLogIn;
 import de.hybris.platform.commercefacades.order.CheckoutFacade;
-import de.hybris.platform.commercefacades.order.data.CartData;
 import de.hybris.platform.commercefacades.order.data.DeliveryModeData;
-import java.util.List;
 import org.apache.commons.lang.StringUtils;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.HttpStatus;
@@ -15,6 +15,8 @@
 import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RequestMapping;
 
+import java.util.List;
+
 
 @Controller
 @RequestMapping(value = "/api/checkout")
@@ -31,12 +33,12 @@ public ResponseEntity<List<? extends DeliveryModeData>> getAllDeliveryMethods()
 
     @RequireHardLogIn
     @PostMapping(value = "/select-delivery-method")
-    public ResponseEntity<CartData> selectDeliveryMethod(@RequestBody String deliveryMethodCode) {
+    public ResponseEntity selectDeliveryMethod(@RequestBody String deliveryMethodCode) {
         if (StringUtils.isNotEmpty(deliveryMethodCode)) {
             checkoutFacade.setDeliveryMode(deliveryMethodCode);
             return ResponseEntity.ok(checkoutFacade.getCheckoutCart());
         } else {
-            return ResponseEntity.status(HttpStatus.BAD_REQUEST).build();
+            throw new AdyenControllerException("checkout.deliveryMethod.notSelected");
         }
     }
 

diff --git a/...cceleratoraddon/web/src/com/adyen/commerce/controllers/api/AdyenPlaceOrderController.java b/...cceleratoraddon/web/src/com/adyen/commerce/controllers/api/AdyenPlaceOrderController.java
@@ -1,5 +1,6 @@
 package com.adyen.commerce.controllers.api;
 
+import com.adyen.commerce.exceptions.AdyenControllerException;
 import com.adyen.commerce.response.PlaceOrderResponse;
 import com.adyen.constants.ApiConstants;
 import com.adyen.model.checkout.PaymentResponse;
@@ -82,17 +83,13 @@ public ResponseEntity<PlaceOrderResponse> placeOrder(@RequestBody AdyenPaymentFo
         final boolean selectPaymentMethodSuccess = selectPaymentMethod(adyenPaymentForm);
 
         if (!selectPaymentMethodSuccess) {
-            PlaceOrderResponse placeOrderResponse = new PlaceOrderResponse();
-            placeOrderResponse.setError(CHECKOUT_ERROR_FORM_ENTRY_INVALID);
             LOGGER.warn("Payment form is invalid.");
-            return ResponseEntity.badRequest().body(placeOrderResponse);
+            throw new AdyenControllerException(CHECKOUT_ERROR_FORM_ENTRY_INVALID);
         }
 
         if (!isCartValid()) {
             LOGGER.warn("Cart is invalid.");
-            PlaceOrderResponse placeOrderResponse = new PlaceOrderResponse();
-            placeOrderResponse.setError(CHECKOUT_ERROR_AUTHORIZATION_FAILED);
-            return ResponseEntity.badRequest().body(placeOrderResponse);
+            throw new AdyenControllerException(CHECKOUT_ERROR_AUTHORIZATION_FAILED);
         }
 
         final CartData cartData = cartFacade.getSessionCart();
@@ -140,9 +137,7 @@ private ResponseEntity<PlaceOrderResponse> handleRatepay(HttpServletRequest requ
             LOGGER.error(ExceptionUtils.getStackTrace(e));
         }
 
-        PlaceOrderResponse placeOrderResponse = new PlaceOrderResponse();
-        placeOrderResponse.setError(errorMessage);
-        return ResponseEntity.badRequest().body(placeOrderResponse);
+        throw new AdyenControllerException(errorMessage);
     }
 
     private ResponseEntity<PlaceOrderResponse> handlePOS(HttpServletRequest request, CartData cartData) {
@@ -190,9 +185,7 @@ private ResponseEntity<PlaceOrderResponse> handlePOS(HttpServletRequest request,
             LOGGER.error("Exception", e);
         }
 
-        PlaceOrderResponse placeOrderResponse = new PlaceOrderResponse();
-        placeOrderResponse.setError(errorMessage);
-        return ResponseEntity.badRequest().body(placeOrderResponse);
+        throw new AdyenControllerException(errorMessage);
     }
 
     private ResponseEntity<PlaceOrderResponse> handleOther(HttpServletRequest request, CartData cartData, String adyenPaymentMethod) {
@@ -236,9 +229,7 @@ private ResponseEntity<PlaceOrderResponse> handleOther(HttpServletRequest reques
             LOGGER.error(ExceptionUtils.getStackTrace(e));
         }
 
-        PlaceOrderResponse placeOrderResponse = new PlaceOrderResponse();
-        placeOrderResponse.setError(errorMessage);
-        return ResponseEntity.badRequest().body(placeOrderResponse);
+        throw new AdyenControllerException(errorMessage);
     }
 
     private boolean selectPaymentMethod(AdyenPaymentForm adyenPaymentForm) {

diff --git a/...src/com/adyen/commerce/controllers/exceptionhandlers/AdyenControllerExceptionHandler.java b/...src/com/adyen/commerce/controllers/exceptionhandlers/AdyenControllerExceptionHandler.java
@@ -0,0 +1,16 @@
+package com.adyen.commerce.controllers.exceptionhandlers;
+
+import com.adyen.commerce.exceptions.AdyenControllerException;
+import com.adyen.commerce.response.ErrorResponse;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.ControllerAdvice;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+
+@ControllerAdvice
+public class AdyenControllerExceptionHandler {
+
+    @ExceptionHandler(value = AdyenControllerException.class)
+    public ResponseEntity<ErrorResponse> handleAdyenControllerException(AdyenControllerException exception) {
+        return ResponseEntity.badRequest().body(exception.getErrorResponse());
+    }
+}
diff --git a/...napi/acceleratoraddon/web/src/com/adyen/commerce/exceptions/AdyenControllerException.java b/...napi/acceleratoraddon/web/src/com/adyen/commerce/exceptions/AdyenControllerException.java
@@ -0,0 +1,27 @@
+package com.adyen.commerce.exceptions;
+
+import com.adyen.commerce.response.ErrorResponse;
+
+import java.util.ArrayList;
+import java.util.List;
+
+public class AdyenControllerException extends RuntimeException {
+
+    private final ErrorResponse errorResponse;
+
+    public AdyenControllerException(String errorCode, List<String> invalidFields) {
+        errorResponse = new ErrorResponse(errorCode, invalidFields);
+    }
+
+    public AdyenControllerException() {
+        errorResponse = new ErrorResponse("checkout.error.default", new ArrayList<>());
+    }
+
+    public AdyenControllerException(String errorCode) {
+        errorResponse = new ErrorResponse(errorCode);
+    }
+
+    public ErrorResponse getErrorResponse() {
+        return errorResponse;
+    }
+}
diff --git a/...ncheckoutaddonapi/acceleratoraddon/web/src/com/adyen/commerce/response/ErrorResponse.java b/...ncheckoutaddonapi/acceleratoraddon/web/src/com/adyen/commerce/response/ErrorResponse.java
@@ -0,0 +1,33 @@
+package com.adyen.commerce.response;
+
+import java.util.ArrayList;
+import java.util.List;
+
+public class ErrorResponse {
+    private String errorCode;
+    private List<String> invalidFields;
+
+    public ErrorResponse(String errorCode, List<String> invalidFields) {
+        this.errorCode = errorCode;
+        this.invalidFields = invalidFields;
+    }
+
+    public ErrorResponse() {
+        this.errorCode = "checkout.error.default";
+        this.invalidFields = new ArrayList<>();
+    }
+
+    public ErrorResponse(String errorCode) {
+        this.errorCode = errorCode;
+        this.invalidFields = new ArrayList<>();
+    }
+
+    public String getErrorCode() {
+        return errorCode;
+    }
+
+    public List<String> getInvalidFields() {
+        return invalidFields;
+    }
+
+}
diff --git a/...koutaddonapi/acceleratoraddon/web/src/com/adyen/commerce/response/PlaceOrderResponse.java b/...koutaddonapi/acceleratoraddon/web/src/com/adyen/commerce/response/PlaceOrderResponse.java
@@ -3,7 +3,6 @@
 
 public class PlaceOrderResponse {
     private String orderNumber;
-    private String error;
     private boolean isRedirectTo3DS;
 
     public String getOrderNumber() {
@@ -14,14 +13,6 @@ public void setOrderNumber(String orderNumber) {
         this.orderNumber = orderNumber;
     }
 
-    public String getError() {
-        return error;
-    }
-
-    public void setError(String error) {
-        this.error = error;
-    }
-
     public boolean isRedirectTo3DS() {
         return isRedirectTo3DS;
     }

diff --git a/adyencheckoutaddonapi/acceleratoraddon/web/webroot/WEB-INF/messages/base_de.properties b/adyencheckoutaddonapi/acceleratoraddon/web/webroot/WEB-INF/messages/base_de.properties
@@ -13,4 +13,6 @@ checkout.error.authorization.payment.success=Bezahlung erfolgreich
 checkout.error.authorization.payment.failed=Bezahlung fehlgeschlagen
 checkout.error.authorization.payment.rejected=Ihre Zahlung wurde abgelehnt
 checkout.error.authorization.payment.timeout=Die Zahlungsabwicklung dauerte länger als erwartet. Bitte versuchen Sie es in ein paar Minuten noch einmal.
-checkout.error.authorization.payment.pending=Ihre Zahlung wird bearbeitet
+checkout.error.authorization.payment.pending=Ihre Zahlung wird bearbeitet
+
+checkout.error.default=Es tut uns leid, es ist ein Problem aufgetreten. Bitte versuchen Sie es später noch einmal
diff --git a/adyencheckoutaddonapi/acceleratoraddon/web/webroot/WEB-INF/messages/base_en.properties b/adyencheckoutaddonapi/acceleratoraddon/web/webroot/WEB-INF/messages/base_en.properties
@@ -15,3 +15,6 @@ checkout.error.authorization.payment.failed=Payment failed
 checkout.error.authorization.payment.rejected=Your payment was rejected
 checkout.error.authorization.payment.timeout=Payment processing took longer than expected. Please check again in few minutes.
 checkout.error.authorization.payment.pending=Your payment is being processed
+
+checkout.error.default=Sorry, there was a problem, please try again later
+
diff --git a/...addonspa/acceleratoraddon/web/webroot/_ui/responsive/common/css/adyencheckoutaddonapi.css b/...addonspa/acceleratoraddon/web/webroot/_ui/responsive/common/css/adyencheckoutaddonapi.css
@@ -21,4 +21,8 @@
     margin-top: 30px;
     padding: 15px;
     border-radius: 12px;
+}
+
+.alert {
+    scroll-margin-top: 10px;
 }
diff --git a/...eb/webroot/_ui/responsive/common/js/adyen-checkout/src/components/common/ErrorHandler.tsx b/...eb/webroot/_ui/responsive/common/js/adyen-checkout/src/components/common/ErrorHandler.tsx
@@ -0,0 +1,22 @@
+import {AxiosError} from "axios";
+import {ErrorResponse} from "../../types/errorResponse";
+import {isEmpty} from "../../util/stringUtil";
+import {store} from "../../store/store";
+import {createDefaultResponseData, createError} from "../../util/notificationUtil";
+
+export class ErrorHandler {
+
+    public static handleError(error?: AxiosError<ErrorResponse>) {
+        let errorResponseData
+        if (!error) {
+            errorResponseData = createDefaultResponseData()
+        } else {
+            errorResponseData = error.response.data;
+
+            if (!errorResponseData || isEmpty(errorResponseData.errorCode)) {
+                errorResponseData = createDefaultResponseData()
+            }
+        }
+        store.dispatch({type: "notifications/addNotification", payload: createError(errorResponseData)})
+    }
+}