MAGETWO-53457: [COMMUNITY] [FEEDBACK] Improve error reporting for failed order placement (checkout) #4682

added exception logging

Author: Serhiy Shkolyarenko

app/code/Magento/Authorizenet/Controller/Directpost/Payment/Place.php

@@ -16,6 +16,8 @@
 use Magento\Payment\Model\IframeConfigProvider;
 use Magento\Quote\Api\CartManagementInterface;
 use Magento\Framework\Exception\LocalizedException;
+use Psr\Log\LoggerInterface;
+use Magento\Framework\App\ObjectManager;
 
 /**
  * Class Place
@@ -44,26 +46,36 @@ class Place extends Payment
      */
     protected $jsonHelper;
 
+    /**
+     * Logger for exception details
+     *
+     * @var LoggerInterface
+     */
+    private $logger;
+
     /**
      * @param Context $context
      * @param Registry $coreRegistry
      * @param DataFactory $dataFactory
      * @param CartManagementInterface $cartManagement
      * @param Onepage $onepageCheckout
      * @param JsonHelper $jsonHelper
+     * @param LoggerInterface|null $logger
      */
     public function __construct(
         Context $context,
         Registry $coreRegistry,
         DataFactory $dataFactory,
         CartManagementInterface $cartManagement,
         Onepage $onepageCheckout,
-        JsonHelper $jsonHelper
+        JsonHelper $jsonHelper,
+        LoggerInterface $logger = null
     ) {
         $this->eventManager = $context->getEventManager();
         $this->cartManagement = $cartManagement;
         $this->onepageCheckout = $onepageCheckout;
         $this->jsonHelper = $jsonHelper;
+        $this->logger = $logger ?: ObjectManager::getInstance()->get(LoggerInterface::class);
         parent::__construct($context, $coreRegistry, $dataFactory);
     }
 
@@ -127,9 +139,11 @@ protected function placeCheckoutOrder()
                 ]
             );
         } catch (LocalizedException $exception) {
+            $this->logger->critical($exception);
             $result->setData('error', true);
             $result->setData('error_messages', $exception->getMessage());
         } catch (\Exception $exception) {
+            $this->logger->critical($exception);
             $result->setData('error', true);
             $result->setData(
                 'error_messages',

app/code/Magento/Braintree/Controller/Paypal/PlaceOrder.php

@@ -11,6 +11,8 @@
 use Magento\Framework\Controller\ResultFactory;
 use Magento\Framework\Exception\LocalizedException;
 use Magento\Braintree\Gateway\Config\PayPal\Config;
+use Psr\Log\LoggerInterface;
+use Magento\Framework\App\ObjectManager;
 
 /**
  * Class PlaceOrder
@@ -22,22 +24,32 @@ class PlaceOrder extends AbstractAction
      */
     private $orderPlace;
 
+    /**
+     * Logger for exception details
+     *
+     * @var LoggerInterface
+     */
+    private $logger;
+
     /**
      * Constructor
      *
      * @param Context $context
      * @param Config $config
      * @param Session $checkoutSession
      * @param Helper\OrderPlace $orderPlace
+     * @param LoggerInterface|null $logger
      */
     public function __construct(
         Context $context,
         Config $config,
         Session $checkoutSession,
-        Helper\OrderPlace $orderPlace
+        Helper\OrderPlace $orderPlace,
+        LoggerInterface $logger = null
     ) {
         parent::__construct($context, $config, $checkoutSession);
         $this->orderPlace = $orderPlace;
+        $this->logger = $logger ?: ObjectManager::getInstance()->get(LoggerInterface::class);
     }
 
     /**
@@ -58,6 +70,7 @@ public function execute()
             /** @var \Magento\Framework\Controller\Result\Redirect $resultRedirect */
             return $resultRedirect->setPath('checkout/onepage/success', ['_secure' => true]);
         } catch (\Exception $e) {
+            $this->logger->critical($e);
             $this->messageManager->addExceptionMessage($e, $e->getMessage());
         }
 

app/code/Magento/Payment/Model/Method/Adapter.php

@@ -17,6 +17,8 @@
 use Magento\Payment\Gateway\Data\PaymentDataObjectFactory;
 use Magento\Payment\Gateway\Config\ValueHandlerPoolInterface;
 use Magento\Payment\Gateway\Validator\ValidatorPoolInterface;
+use Psr\Log\LoggerInterface;
+use Magento\Framework\App\ObjectManager;
 
 /**
  * Payment method facade. Abstract method adapter
@@ -81,16 +83,24 @@ class Adapter implements MethodInterface
      */
     private $commandExecutor;
 
+    /**
+     * Logger for exception details
+     *
+     * @var LoggerInterface
+     */
+    private $logger;
+
     /**
      * @param ManagerInterface $eventManager
      * @param ValueHandlerPoolInterface $valueHandlerPool
      * @param PaymentDataObjectFactory $paymentDataObjectFactory
      * @param string $code
      * @param string $formBlockType
      * @param string $infoBlockType
-     * @param CommandPoolInterface $commandPool
-     * @param ValidatorPoolInterface $validatorPool
-     * @param CommandManagerInterface $commandExecutor
+     * @param CommandPoolInterface|null $commandPool
+     * @param ValidatorPoolInterface|null $validatorPool
+     * @param CommandManagerInterface|null $commandExecutor
+     * @param LoggerInterface|null $logger
      */
     public function __construct(
         ManagerInterface $eventManager,
@@ -101,7 +111,8 @@ public function __construct(
         $infoBlockType,
         CommandPoolInterface $commandPool = null,
         ValidatorPoolInterface $validatorPool = null,
-        CommandManagerInterface $commandExecutor = null
+        CommandManagerInterface $commandExecutor = null,
+        LoggerInterface $logger = null
     ) {
         $this->valueHandlerPool = $valueHandlerPool;
         $this->validatorPool = $validatorPool;
@@ -112,6 +123,7 @@ public function __construct(
         $this->eventManager = $eventManager;
         $this->paymentDataObjectFactory = $paymentDataObjectFactory;
         $this->commandExecutor = $commandExecutor;
+        $this->logger = $logger ?: ObjectManager::getInstance()->get(LoggerInterface::class);
     }
 
     /**
@@ -382,6 +394,7 @@ public function validate()
         try {
             $validator = $this->getValidatorPool()->get('global');
         } catch (\Exception $e) {
+            $this->logger->critical($e);
             return $this;
         }