Merge pull request #869 from magento-folks/exception_logger

[Folks] Exception logger

Author: Alexander Akimov

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/Authorizenet/Test/Unit/Controller/Directpost/Payment/PlaceTest.php

@@ -20,6 +20,7 @@
 use Magento\Payment\Model\IframeConfigProvider;
 use Magento\Quote\Api\CartManagementInterface;
 use Magento\Quote\Model\Quote;
+use Magento\Framework\Exception\LocalizedException;
 
 /**
  * Class PlaceTest
@@ -94,6 +95,11 @@ class PlaceTest extends \PHPUnit_Framework_TestCase
      */
     protected $quoteMock;
 
+    /**
+     * @var \PHPUnit_Framework_MockObject_MockObject
+     */
+    private $loggerMock;
+
     /**
      * @var CheckoutSession|\PHPUnit_Framework_MockObject_MockObject
      */
@@ -152,6 +158,9 @@ protected function setUp()
             ->getMockBuilder(\Magento\Framework\App\Response\Http::class)
             ->disableOriginalConstructor()
             ->getMockForAbstractClass();
+        $this->loggerMock = $this
+            ->getMockBuilder(\Psr\Log\LoggerInterface::class)
+            ->getMock();
 
         $this->objectManager = new ObjectManager($this);
         $this->placeOrderController = $this->objectManager->getObject(
@@ -165,6 +174,7 @@ protected function setUp()
                 'cartManagement' => $this->cartManagementMock,
                 'onepageCheckout' => $this->onepageCheckout,
                 'jsonHelper' => $this->jsonHelperMock,
+                'logger' => $this->loggerMock,
             ]
         );
     }
@@ -214,13 +224,15 @@ public function testExecute(
      * @param $controller
      * @param $quoteId
      * @param $result
+     * @param \Exception $exception Exception to check
      * @dataProvider textExecuteFailedPlaceOrderDataProvider
      */
     public function testExecuteFailedPlaceOrder(
         $paymentMethod,
         $controller,
         $quoteId,
-        $result
+        $result,
+        $exception
     ) {
         $this->requestMock->expects($this->at(0))
             ->method('getParam')
@@ -238,7 +250,11 @@ public function testExecuteFailedPlaceOrder(
 
         $this->cartManagementMock->expects($this->once())
             ->method('placeOrder')
-            ->willThrowException(new \Exception());
+            ->willThrowException($exception);
+
+        $this->loggerMock->expects($this->once())
+            ->method('critical')
+            ->with($exception);
 
         $this->jsonHelperMock->expects($this->any())
             ->method('jsonEncode')
@@ -278,19 +294,35 @@ public function textExecuteDataProvider()
      */
     public function textExecuteFailedPlaceOrderDataProvider()
     {
-        $objectFailed = new \Magento\Framework\DataObject();
-        $objectFailed->setData('error', true);
-        $objectFailed->setData(
-            'error_messages',
-            __('An error occurred on the server. Please try to place the order again.')
+        $objectFailed1 = new \Magento\Framework\DataObject(
+            [
+                'error' => true,
+                'error_messages' => __('An error occurred on the server. Please try to place the order again.')
+            ]
+        );
+        $generalException = new \Exception('Exception logging will save the world!');
+        $localizedException = new LocalizedException(__('Electronic payments save the trees.'));
+        $objectFailed2 = new \Magento\Framework\DataObject(
+            [
+                'error' => true,
+                'error_messages' => $localizedException->getMessage()
+            ]
         );
 
         return [
             [
                 ['method' => 'authorizenet_directpost'],
                 IframeConfigProvider::CHECKOUT_IDENTIFIER,
                 1,
-                $objectFailed
+                $objectFailed1,
+                $generalException,
+            ],
+            [
+                ['method' => 'authorizenet_directpost'],
+                IframeConfigProvider::CHECKOUT_IDENTIFIER,
+                1,
+                $objectFailed2,
+                $localizedException,
             ],
         ];
     }

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/Braintree/Test/Unit/Controller/Paypal/PlaceOrderTest.php

@@ -60,6 +60,11 @@ class PlaceOrderTest extends \PHPUnit_Framework_TestCase
      */
     private $placeOrder;
 
+    /**
+     * @var \PHPUnit_Framework_MockObject_MockObject
+     */
+    private $loggerMock;
+
     protected function setUp()
     {
         /** @var Context|\PHPUnit_Framework_MockObject_MockObject $contextMock */
@@ -94,11 +99,15 @@ protected function setUp()
             ->method('getMessageManager')
             ->willReturn($this->messageManagerMock);
 
+        $this->loggerMock = $this->getMockBuilder(\Psr\Log\LoggerInterface::class)
+            ->disableOriginalConstructor()
+            ->getMock();
         $this->placeOrder = new PlaceOrder(
             $contextMock,
             $this->configMock,
             $this->checkoutSessionMock,
-            $this->orderPlaceMock
+            $this->orderPlaceMock,
+            $this->loggerMock
         );
     }
 

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,25 @@ 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
+     * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
     public function __construct(
         ManagerInterface $eventManager,
@@ -101,7 +112,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 +124,7 @@ public function __construct(
         $this->eventManager = $eventManager;
         $this->paymentDataObjectFactory = $paymentDataObjectFactory;
         $this->commandExecutor = $commandExecutor;
+        $this->logger = $logger ?: ObjectManager::getInstance()->get(LoggerInterface::class);
     }
 
     /**
@@ -382,6 +395,7 @@ public function validate()
         try {
             $validator = $this->getValidatorPool()->get('global');
         } catch (\Exception $e) {
+            $this->logger->critical($e);
             return $this;
         }
 

app/code/Magento/Payment/Test/Unit/Model/Method/AdapterTest.php

@@ -50,6 +50,11 @@ class AdapterTest extends \PHPUnit_Framework_TestCase
      */
     private $paymentDataObjectFactory;
 
+    /**
+     * @var MockObject
+     */
+    private $logger;
+
     /**
      * @var string
      */
@@ -84,6 +89,8 @@ protected function setUp()
         $this->formBlockType = '\FormBlock';
         $this->infoBlockType = '\InfoBlock';
 
+        $this->logger = $this->getMockBuilder(\Psr\Log\LoggerInterface::class)
+            ->getMock();
         $this->adapter = new Adapter(
             $this->eventManager,
             $this->valueHandlerPool,
@@ -92,7 +99,9 @@ protected function setUp()
             $this->formBlockType,
             $this->infoBlockType,
             $this->commandPool,
-            $this->validatorPool
+            $this->validatorPool,
+            null,
+            $this->logger
         );
     }
 
@@ -221,7 +230,8 @@ public function testExecuteCommandWithCommandExecutor()
             '\InfoBlock',
             null,
             null,
-            $commandManager
+            $commandManager,
+            $this->logger
         );
 
         $valueHandler = $this->getMock(ValueHandlerInterface::class);
@@ -274,7 +284,10 @@ public function testExecuteCommandWithCommandPool()
             'CODE',
             '\FormBlock',
             '\InfoBlock',
-            $commandPool
+            $commandPool,
+            null,
+            null,
+            $this->logger
         );
 
         $valueHandler = $this->getMock(ValueHandlerInterface::class);
@@ -305,4 +318,18 @@ public function testExecuteCommandWithCommandPool()
 
         $adapter->authorize($paymentInfo, 10);
     }
+
+    public function testValidationExceptionLogged()
+    {
+        $exception = new \Exception('We can test exception logging!');
+
+        $this->validatorPool->expects(static::once())
+            ->method('get')
+            ->with('global')
+            ->willThrowException($exception);
+        $this->logger->expects(static::once())
+            ->method('critical')
+            ->with($exception);
+        $this->adapter->validate();
+    }
 }