ENGCOM-6941: Improve exception message #26586

 - Merge Pull Request #26586 from oroskodias/magento2:extend-shipping-information-exception
 - Merged commits:
   1. ef05fa6
   2. 162da03
   3. 9a1320b
   4. 2668433
   5. a6e0b3e
   6. 709c241
   7. eda9874

Author: magento-engcom-team

app/code/Magento/Checkout/Model/ShippingInformationManagement.php

@@ -6,28 +6,38 @@
 
 namespace Magento\Checkout\Model;
 
+use Magento\Checkout\Api\Data\PaymentDetailsInterface;
+use Magento\Checkout\Api\Data\ShippingInformationInterface;
+use Magento\Checkout\Api\ShippingInformationManagementInterface;
+use Magento\Customer\Api\AddressRepositoryInterface;
+use Magento\Framework\App\Config\ScopeConfigInterface;
+use Magento\Framework\App\ObjectManager;
 use Magento\Framework\Exception\InputException;
-use Magento\Framework\Exception\StateException;
+use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\Exception\NoSuchEntityException;
+use Magento\Framework\Exception\StateException;
+use Magento\Quote\Api\CartRepositoryInterface;
+use Magento\Quote\Api\CartTotalRepositoryInterface;
 use Magento\Quote\Api\Data\AddressInterface;
+use Magento\Quote\Api\Data\CartExtensionFactory;
 use Magento\Quote\Api\Data\CartInterface;
-use Psr\Log\LoggerInterface as Logger;
+use Magento\Quote\Api\PaymentMethodManagementInterface;
+use Magento\Quote\Model\Quote;
+use Magento\Quote\Model\Quote\TotalsCollector;
 use Magento\Quote\Model\QuoteAddressValidator;
-use Magento\Quote\Api\Data\CartExtensionFactory;
 use Magento\Quote\Model\ShippingAssignmentFactory;
 use Magento\Quote\Model\ShippingFactory;
-use Magento\Framework\App\ObjectManager;
+use Psr\Log\LoggerInterface as Logger;
 
 /**
- * Class ShippingInformationManagement
+ * Class checkout shipping information management
  *
- * @package Magento\Checkout\Model
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
-class ShippingInformationManagement implements \Magento\Checkout\Api\ShippingInformationManagementInterface
+class ShippingInformationManagement implements ShippingInformationManagementInterface
 {
     /**
-     * @var \Magento\Quote\Api\PaymentMethodManagementInterface
+     * @var PaymentMethodManagementInterface
      */
     protected $paymentMethodManagement;
 
@@ -37,12 +47,12 @@ class ShippingInformationManagement implements \Magento\Checkout\Api\ShippingInf
     protected $paymentDetailsFactory;
 
     /**
-     * @var \Magento\Quote\Api\CartTotalRepositoryInterface
+     * @var CartTotalRepositoryInterface
      */
     protected $cartTotalsRepository;
 
     /**
-     * @var \Magento\Quote\Api\CartRepositoryInterface
+     * @var CartRepositoryInterface
      */
     protected $quoteRepository;
 
@@ -57,65 +67,63 @@ class ShippingInformationManagement implements \Magento\Checkout\Api\ShippingInf
     protected $addressValidator;
 
     /**
-     * @var \Magento\Customer\Api\AddressRepositoryInterface
+     * @var AddressRepositoryInterface
      * @deprecated 100.2.0
      */
     protected $addressRepository;
 
     /**
-     * @var \Magento\Framework\App\Config\ScopeConfigInterface
+     * @var ScopeConfigInterface
      * @deprecated 100.2.0
      */
     protected $scopeConfig;
 
     /**
-     * @var \Magento\Quote\Model\Quote\TotalsCollector
+     * @var TotalsCollector
      * @deprecated 100.2.0
      */
     protected $totalsCollector;
 
     /**
-     * @var \Magento\Quote\Api\Data\CartExtensionFactory
+     * @var CartExtensionFactory
      */
     private $cartExtensionFactory;
 
     /**
-     * @var \Magento\Quote\Model\ShippingAssignmentFactory
+     * @var ShippingAssignmentFactory
      */
     protected $shippingAssignmentFactory;
 
     /**
-     * @var \Magento\Quote\Model\ShippingFactory
+     * @var ShippingFactory
      */
     private $shippingFactory;
 
     /**
-     * Constructor
-     *
-     * @param \Magento\Quote\Api\PaymentMethodManagementInterface $paymentMethodManagement
-     * @param \Magento\Checkout\Model\PaymentDetailsFactory $paymentDetailsFactory
-     * @param \Magento\Quote\Api\CartTotalRepositoryInterface $cartTotalsRepository
-     * @param \Magento\Quote\Api\CartRepositoryInterface $quoteRepository
-     * @param \Magento\Quote\Model\QuoteAddressValidator $addressValidator
+     * @param PaymentMethodManagementInterface $paymentMethodManagement
+     * @param PaymentDetailsFactory $paymentDetailsFactory
+     * @param CartTotalRepositoryInterface $cartTotalsRepository
+     * @param CartRepositoryInterface $quoteRepository
+     * @param QuoteAddressValidator $addressValidator
      * @param Logger $logger
-     * @param \Magento\Customer\Api\AddressRepositoryInterface $addressRepository
-     * @param \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig
-     * @param \Magento\Quote\Model\Quote\TotalsCollector $totalsCollector
+     * @param AddressRepositoryInterface $addressRepository
+     * @param ScopeConfigInterface $scopeConfig
+     * @param TotalsCollector $totalsCollector
      * @param CartExtensionFactory|null $cartExtensionFactory
      * @param ShippingAssignmentFactory|null $shippingAssignmentFactory
      * @param ShippingFactory|null $shippingFactory
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
     public function __construct(
-        \Magento\Quote\Api\PaymentMethodManagementInterface $paymentMethodManagement,
-        \Magento\Checkout\Model\PaymentDetailsFactory $paymentDetailsFactory,
-        \Magento\Quote\Api\CartTotalRepositoryInterface $cartTotalsRepository,
-        \Magento\Quote\Api\CartRepositoryInterface $quoteRepository,
+        PaymentMethodManagementInterface $paymentMethodManagement,
+        PaymentDetailsFactory $paymentDetailsFactory,
+        CartTotalRepositoryInterface $cartTotalsRepository,
+        CartRepositoryInterface $quoteRepository,
         QuoteAddressValidator $addressValidator,
         Logger $logger,
-        \Magento\Customer\Api\AddressRepositoryInterface $addressRepository,
-        \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig,
-        \Magento\Quote\Model\Quote\TotalsCollector $totalsCollector,
+        AddressRepositoryInterface $addressRepository,
+        ScopeConfigInterface $scopeConfig,
+        TotalsCollector $totalsCollector,
         CartExtensionFactory $cartExtensionFactory = null,
         ShippingAssignmentFactory $shippingAssignmentFactory = null,
         ShippingFactory $shippingFactory = null
@@ -141,24 +149,23 @@ public function __construct(
      * Save address information.
      *
      * @param int $cartId
-     * @param \Magento\Checkout\Api\Data\ShippingInformationInterface $addressInformation
-     * @return \Magento\Checkout\Api\Data\PaymentDetailsInterface
+     * @param ShippingInformationInterface $addressInformation
+     * @return PaymentDetailsInterface
      * @throws InputException
      * @throws NoSuchEntityException
      * @throws StateException
      */
     public function saveAddressInformation(
         $cartId,
-        \Magento\Checkout\Api\Data\ShippingInformationInterface $addressInformation
-    ) {
-        /** @var \Magento\Quote\Model\Quote $quote */
+        ShippingInformationInterface $addressInformation
+    ): PaymentDetailsInterface {
+        /** @var Quote $quote */
         $quote = $this->quoteRepository->getActive($cartId);
         $this->validateQuote($quote);
 
         $address = $addressInformation->getShippingAddress();
-        if (!$address || !$address->getCountryId()) {
-            throw new StateException(__('The shipping address is missing. Set the address and try again.'));
-        }
+        $this->validateAddress($address);
+
         if (!$address->getCustomerAddressId()) {
             $address->setCustomerAddressId(null);
         }
@@ -182,6 +189,14 @@ public function saveAddressInformation(
             $quote->setIsMultiShipping(false);
 
             $this->quoteRepository->save($quote);
+        } catch (LocalizedException $e) {
+            $this->logger->critical($e);
+            throw new InputException(
+                __(
+                    'The shipping information was unable to be saved. Error: "%message"',
+                    ['message' => $e->getMessage()]
+                )
+            );
         } catch (\Exception $e) {
             $this->logger->critical($e);
             throw new InputException(
@@ -199,26 +214,39 @@ public function saveAddressInformation(
             );
         }
 
-        /** @var \Magento\Checkout\Api\Data\PaymentDetailsInterface $paymentDetails */
+        /** @var PaymentDetailsInterface $paymentDetails */
         $paymentDetails = $this->paymentDetailsFactory->create();
         $paymentDetails->setPaymentMethods($this->paymentMethodManagement->getList($cartId));
         $paymentDetails->setTotals($this->cartTotalsRepository->get($cartId));
         return $paymentDetails;
     }
 
+    /**
+     * Validate shipping address
+     *
+     * @param AddressInterface|null $address
+     * @return void
+     * @throws StateException
+     */
+    private function validateAddress(?AddressInterface $address): void
+    {
+        if (!$address || !$address->getCountryId()) {
+            throw new StateException(__('The shipping address is missing. Set the address and try again.'));
+        }
+    }
+
     /**
      * Validate quote
      *
-     * @param \Magento\Quote\Model\Quote $quote
+     * @param Quote $quote
      * @throws InputException
-     * @throws NoSuchEntityException
      * @return void
      */
-    protected function validateQuote(\Magento\Quote\Model\Quote $quote)
+    protected function validateQuote(Quote $quote): void
     {
-        if (0 == $quote->getItemsCount()) {
+        if (!$quote->getItemsCount()) {
             throw new InputException(
-                __("The shipping method can't be set for an empty cart. Add an item to cart and try again.")
+                __('The shipping method can\'t be set for an empty cart. Add an item to cart and try again.')
             );
         }
     }
@@ -231,7 +259,7 @@ protected function validateQuote(\Magento\Quote\Model\Quote $quote)
      * @param string $method
      * @return CartInterface
      */
-    private function prepareShippingAssignment(CartInterface $quote, AddressInterface $address, $method)
+    private function prepareShippingAssignment(CartInterface $quote, AddressInterface $address, $method): CartInterface
     {
         $cartExtension = $quote->getExtensionAttributes();
         if ($cartExtension === null) {