Merge pull request #2533 from magento-tsg/2.2-develop-pr24

[TSG] Backporting for 2.2 (pr24) (2.2.6)

Author: viktym

app/code/Magento/Authorizenet/Model/Directpost.php

@@ -5,10 +5,9 @@
  */
 namespace Magento\Authorizenet\Model;
 
-use Magento\Framework\HTTP\ZendClientFactory;
+use Magento\Framework\App\ObjectManager;
 use Magento\Payment\Model\Method\ConfigInterface;
 use Magento\Payment\Model\Method\TransparentInterface;
-use Magento\Sales\Model\Order\Email\Sender\OrderSender;
 
 /**
  * Authorize.net DirectPost payment method model.
@@ -102,7 +101,7 @@ class Directpost extends \Magento\Authorizenet\Model\Authorizenet implements Tra
     protected $response;
 
     /**
-     * @var OrderSender
+     * @var \Magento\Sales\Model\Order\Email\Sender\OrderSender
      */
     protected $orderSender;
 
@@ -123,6 +122,16 @@ class Directpost extends \Magento\Authorizenet\Model\Authorizenet implements Tra
      */
     private $psrLogger;
 
+    /**
+     * @var \Magento\Sales\Api\PaymentFailuresInterface
+     */
+    private $paymentFailures;
+
+    /**
+     * @var \Magento\Sales\Model\Order
+     */
+    private $order;
+
     /**
      * @param \Magento\Framework\Model\Context $context
      * @param \Magento\Framework\Registry $registry
@@ -141,11 +150,12 @@ class Directpost extends \Magento\Authorizenet\Model\Authorizenet implements Tra
      * @param \Magento\Sales\Model\OrderFactory $orderFactory
      * @param \Magento\Store\Model\StoreManagerInterface $storeManager
      * @param \Magento\Quote\Api\CartRepositoryInterface $quoteRepository
-     * @param OrderSender $orderSender
+     * @param \Magento\Sales\Model\Order\Email\Sender\OrderSender $orderSender
      * @param \Magento\Sales\Api\TransactionRepositoryInterface $transactionRepository
      * @param \Magento\Framework\Model\ResourceModel\AbstractResource $resource
      * @param \Magento\Framework\Data\Collection\AbstractDb $resourceCollection
      * @param array $data
+     * @param \Magento\Sales\Api\PaymentFailuresInterface|null $paymentFailures
      * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
     public function __construct(
@@ -162,15 +172,16 @@ public function __construct(
         \Magento\Authorizenet\Model\Directpost\Request\Factory $requestFactory,
         \Magento\Authorizenet\Model\Directpost\Response\Factory $responseFactory,
         TransactionService $transactionService,
-        ZendClientFactory $httpClientFactory,
+        \Magento\Framework\HTTP\ZendClientFactory $httpClientFactory,
         \Magento\Sales\Model\OrderFactory $orderFactory,
         \Magento\Store\Model\StoreManagerInterface $storeManager,
         \Magento\Quote\Api\CartRepositoryInterface $quoteRepository,
         \Magento\Sales\Model\Order\Email\Sender\OrderSender $orderSender,
         \Magento\Sales\Api\TransactionRepositoryInterface $transactionRepository,
         \Magento\Framework\Model\ResourceModel\AbstractResource $resource = null,
         \Magento\Framework\Data\Collection\AbstractDb $resourceCollection = null,
-        array $data = []
+        array $data = [],
+        \Magento\Sales\Api\PaymentFailuresInterface $paymentFailures = null
     ) {
         $this->orderFactory = $orderFactory;
         $this->storeManager = $storeManager;
@@ -179,6 +190,8 @@ public function __construct(
         $this->orderSender = $orderSender;
         $this->transactionRepository = $transactionRepository;
         $this->_code = static::METHOD_CODE;
+        $this->paymentFailures = $paymentFailures ? : ObjectManager::getInstance()
+            ->get(\Magento\Sales\Api\PaymentFailuresInterface::class);
 
         parent::__construct(
             $context,
@@ -561,13 +574,10 @@ public function process(array $responseData)
         $this->validateResponse();
 
         $response = $this->getResponse();
-        //operate with order
-        $orderIncrementId = $response->getXInvoiceNum();
         $responseText = $this->dataHelper->wrapGatewayError($response->getXResponseReasonText());
         $isError = false;
-        if ($orderIncrementId) {
-            /* @var $order \Magento\Sales\Model\Order */
-            $order = $this->orderFactory->create()->loadByIncrementId($orderIncrementId);
+        if ($this->getOrderIncrementId()) {
+            $order = $this->getOrderFromResponse();
             //check payment method
             $payment = $order->getPayment();
             if (!$payment || $payment->getMethod() != $this->getCode()) {
@@ -632,9 +642,10 @@ public function checkResponseCode()
                 return true;
             case self::RESPONSE_CODE_DECLINED:
             case self::RESPONSE_CODE_ERROR:
-                throw new \Magento\Framework\Exception\LocalizedException(
-                    $this->dataHelper->wrapGatewayError($this->getResponse()->getXResponseReasonText())
-                );
+                $errorMessage = $this->dataHelper->wrapGatewayError($this->getResponse()->getXResponseReasonText());
+                $order = $this->getOrderFromResponse();
+                $this->paymentFailures->handle((int)$order->getQuoteId(), $errorMessage);
+                throw new \Magento\Framework\Exception\LocalizedException($errorMessage);
             default:
                 throw new \Magento\Framework\Exception\LocalizedException(
                     __('There was a payment authorization error.')
@@ -988,12 +999,40 @@ protected function getTransactionResponse($transactionId)
     private function getPsrLogger()
     {
         if (null === $this->psrLogger) {
-            $this->psrLogger = \Magento\Framework\App\ObjectManager::getInstance()
+            $this->psrLogger = ObjectManager::getInstance()
                 ->get(\Psr\Log\LoggerInterface::class);
         }
         return $this->psrLogger;
     }
 
+    /**
+     * Fetch order by increment id from response.
+     *
+     * @return \Magento\Sales\Model\Order
+     */
+    private function getOrderFromResponse(): \Magento\Sales\Model\Order
+    {
+        if (!$this->order) {
+            $this->order = $this->orderFactory->create();
+
+            if ($incrementId = $this->getOrderIncrementId()) {
+                $this->order = $this->order->loadByIncrementId($incrementId);
+            }
+        }
+
+        return $this->order;
+    }
+
+    /**
+     * Fetch order increment id from response.
+     *
+     * @return string
+     */
+    private function getOrderIncrementId(): string
+    {
+        return $this->getResponse()->getXInvoiceNum();
+    }
+
     /**
      * Checks if filter action is Report Only. Transactions that trigger this filter are processed as normal,
      * but are also reported in the Merchant Interface as triggering this filter.

app/code/Magento/Authorizenet/Test/Unit/Model/DirectpostTest.php

@@ -5,6 +5,7 @@
  */
 namespace Magento\Authorizenet\Test\Unit\Model;
 
+use Magento\Sales\Api\PaymentFailuresInterface;
 use Magento\Framework\Simplexml\Element;
 use Magento\Framework\TestFramework\Unit\Helper\ObjectManager as ObjectManagerHelper;
 use Magento\Authorizenet\Model\Directpost;
@@ -74,6 +75,14 @@ class DirectpostTest extends \PHPUnit\Framework\TestCase
      */
     protected $requestFactory;
 
+    /**
+     * @var PaymentFailuresInterface|\PHPUnit_Framework_MockObject_MockObject
+     */
+    private $paymentFailures;
+
+    /**
+     * @inheritdoc
+     */
     protected function setUp()
     {
         $this->scopeConfigMock = $this->getMockBuilder(\Magento\Framework\App\Config\ScopeConfigInterface::class)
@@ -104,6 +113,12 @@ protected function setUp()
             ->setMethods(['getTransactionDetails'])
             ->getMock();
 
+        $this->paymentFailures = $this->getMockBuilder(
+            PaymentFailuresInterface::class
+        )
+            ->disableOriginalConstructor()
+            ->getMock();
+
         $this->requestFactory = $this->getRequestFactoryMock();
         $httpClientFactoryMock = $this->getHttpClientFactoryMock();
 
@@ -117,7 +132,8 @@ protected function setUp()
                 'responseFactory' => $this->responseFactoryMock,
                 'transactionRepository' => $this->transactionRepositoryMock,
                 'transactionService' => $this->transactionServiceMock,
-                'httpClientFactory' => $httpClientFactoryMock
+                'httpClientFactory' => $httpClientFactoryMock,
+                'paymentFailures' => $this->paymentFailures,
             ]
         );
     }
@@ -313,12 +329,16 @@ public function checkResponseCodeSuccessDataProvider()
     }
 
     /**
-     * @param bool $responseCode
+     * Checks response failures behaviour.
+     *
+     * @param int $responseCode
+     * @param int $failuresHandlerCalls
+     * @return void
      *
      * @expectedException \Magento\Framework\Exception\LocalizedException
      * @dataProvider checkResponseCodeFailureDataProvider
      */
-    public function testCheckResponseCodeFailure($responseCode)
+    public function testCheckResponseCodeFailure(int $responseCode, int $failuresHandlerCalls)
     {
         $reasonText = 'reason text';
 
@@ -333,18 +353,35 @@ public function testCheckResponseCodeFailure($responseCode)
             ->with($reasonText)
             ->willReturn(__('Gateway error: %1', $reasonText));
 
+        $orderMock = $this->getMockBuilder(Order::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        $orderMock->expects($this->exactly($failuresHandlerCalls))
+            ->method('getQuoteId')
+            ->willReturn(1);
+
+        $this->paymentFailures->expects($this->exactly($failuresHandlerCalls))
+            ->method('handle')
+            ->with(1);
+
+        $reflection = new \ReflectionClass($this->directpost);
+        $order = $reflection->getProperty('order');
+        $order->setAccessible(true);
+        $order->setValue($this->directpost, $orderMock);
+
         $this->directpost->checkResponseCode();
     }
 
     /**
      * @return array
      */
-    public function checkResponseCodeFailureDataProvider()
+    public function checkResponseCodeFailureDataProvider(): array
     {
         return [
-            ['responseCode' => Directpost::RESPONSE_CODE_DECLINED],
-            ['responseCode' => Directpost::RESPONSE_CODE_ERROR],
-            ['responseCode' => 999999]
+            ['responseCode' => Directpost::RESPONSE_CODE_DECLINED, 1],
+            ['responseCode' => Directpost::RESPONSE_CODE_ERROR, 1],
+            ['responseCode' => 999999, 0],
         ];
     }