[ECP-9562] Fix the quote staying active on authorised payments (#2921)

* [ECP-9562] Disable the quote on Authorisation webhook handler

* [ECP-9562] Update and add unit tests

Author: candemiralp

Helper/Webhook/AuthorisationWebhookHandler.php

@@ -12,7 +12,6 @@
 
 namespace Adyen\Payment\Helper\Webhook;
 
-
 use Adyen\Payment\Helper\AdyenOrderPayment;
 use Adyen\Payment\Helper\CaseManagement;
 use Adyen\Payment\Helper\ChargedCurrency;
@@ -26,59 +25,35 @@
 use Adyen\Webhook\PaymentStates;
 use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\Serialize\SerializerInterface;
+use Magento\Quote\Api\CartRepositoryInterface;
 use Magento\Sales\Model\Order;
 
 class AuthorisationWebhookHandler implements WebhookHandlerInterface
 {
-    /** @var AdyenOrderPayment */
-    private $adyenOrderPaymentHelper;
-
-    /** @var OrderHelper */
-    private $orderHelper;
-
-    /** @var CaseManagement */
-    private $caseManagementHelper;
-
-    /** @var SerializerInterface */
-    private $serializer;
-
-    /** @var AdyenLogger */
-    private $adyenLogger;
-
-    /** @var ChargedCurrency */
-    private $chargedCurrency;
-
-    /** @var Config */
-    private $configHelper;
-
-    /** @var Invoice */
-    private $invoiceHelper;
-
-    /** @var PaymentMethods */
-    private $paymentMethodsHelper;
-
+    /**
+     * @param AdyenOrderPayment $adyenOrderPaymentHelper
+     * @param OrderHelper $orderHelper
+     * @param CaseManagement $caseManagementHelper
+     * @param SerializerInterface $serializer
+     * @param AdyenLogger $adyenLogger
+     * @param ChargedCurrency $chargedCurrency
+     * @param Config $configHelper
+     * @param Invoice $invoiceHelper
+     * @param PaymentMethods $paymentMethodsHelper
+     * @param CartRepositoryInterface $cartRepository
+     */
     public function __construct(
-        AdyenOrderPayment $adyenOrderPayment,
-        OrderHelper $orderHelper,
-        CaseManagement $caseManagementHelper,
-        SerializerInterface $serializer,
-        AdyenLogger $adyenLogger,
-        ChargedCurrency $chargedCurrency,
-        Config $configHelper,
-        Invoice $invoiceHelper,
-        PaymentMethods $paymentMethodsHelper
-    )
-    {
-        $this->adyenOrderPaymentHelper = $adyenOrderPayment;
-        $this->orderHelper = $orderHelper;
-        $this->caseManagementHelper = $caseManagementHelper;
-        $this->serializer = $serializer;
-        $this->adyenLogger = $adyenLogger;
-        $this->chargedCurrency = $chargedCurrency;
-        $this->configHelper = $configHelper;
-        $this->invoiceHelper = $invoiceHelper;
-        $this->paymentMethodsHelper = $paymentMethodsHelper;
-    }
+        private readonly AdyenOrderPayment $adyenOrderPaymentHelper,
+        private readonly OrderHelper $orderHelper,
+        private readonly CaseManagement $caseManagementHelper,
+        private readonly SerializerInterface $serializer,
+        private readonly AdyenLogger $adyenLogger,
+        private readonly ChargedCurrency $chargedCurrency,
+        private readonly Config $configHelper,
+        private readonly Invoice $invoiceHelper,
+        private readonly PaymentMethods $paymentMethodsHelper,
+        private readonly CartRepositoryInterface $cartRepository
+    ) { }
 
     /**
      * @param Order $order
@@ -149,6 +124,13 @@ private function handleSuccessfulAuthorisation(Order $order, Notification $notif
             $this->orderHelper->createShipment($order);
         }
 
+        // Disable the quote if it's still active
+        $quote = $this->cartRepository->get($order->getQuoteId());
+        if ($quote->getIsActive()) {
+            $quote->setIsActive(false);
+            $this->cartRepository->save($quote);
+        }
+
         return $order;
     }
 

Test/Unit/Helper/Webhook/AuthorisationWebhookHandlerTest.php

@@ -8,6 +8,8 @@
 use Adyen\Payment\Model\Notification;
 use Adyen\Webhook\PaymentStates;
 use Magento\Framework\Exception\LocalizedException;
+use Magento\Quote\Api\CartRepositoryInterface;
+use Magento\Quote\Model\Quote;
 use Magento\Sales\Model\Order;
 use PHPUnit\Framework\MockObject\MockObject;
 use Adyen\Payment\Helper\Order as OrderHelper;
@@ -27,6 +29,7 @@ class AuthorisationWebhookHandlerTest extends AbstractAdyenTestCase
     private AdyenAmountCurrency|MockObject $orderAmountCurrency;
     private Notification|MockObject $notificationMock;
     private Order|MockObject $orderMock;
+    private Quote|MockObject $quoteMock;
 
     protected function setUp(): void
     {
@@ -54,6 +57,7 @@ protected function setUp(): void
             'getPaymentMethod' => $paymentMethod,
             'isSuccessful' => true
         ]);
+        $this->quoteMock = $this->createMock(Quote::class);
     }
 
     /**
@@ -89,6 +93,9 @@ public function testHandleWebhook(): void
 
         $transitionState = PaymentStates::STATE_PAID;
 
+        $cartRepositoryMock = $this->createMock(CartRepositoryInterface::class);
+        $cartRepositoryMock->expects($this->once())->method('get')->willReturn($this->quoteMock);
+
         $handler = $this->createAuthorisationWebhookHandler(
             null,
             $this->orderHelperMock,
@@ -98,7 +105,8 @@ public function testHandleWebhook(): void
             $mockChargedCurrency,
             null,
             null,
-            $paymentMethodsHelperMock
+            $paymentMethodsHelperMock,
+            $cartRepositoryMock
         );
 
         // Call the function to be tested
@@ -160,6 +168,9 @@ public function testHandleSuccessfulAuthorisation($isAutoCapture): void
             ]
         );
 
+        $cartRepositoryMock = $this->createMock(CartRepositoryInterface::class);
+        $cartRepositoryMock->expects($this->once())->method('get')->willReturn($this->quoteMock);
+
         $authorisationWebhookHandler = $this->createAuthorisationWebhookHandler(
             $this->adyenOrderPaymentMock,
             $this->orderHelperMock,
@@ -169,7 +180,8 @@ public function testHandleSuccessfulAuthorisation($isAutoCapture): void
             $mockChargedCurrency,
             null,
             null,
-            $paymentMethodsMock
+            $paymentMethodsMock,
+            $cartRepositoryMock
         );
 
         // Invoke the private method
@@ -257,6 +269,36 @@ public function testHandleAutoCapture(): void
         $this->assertInstanceOf(Order::class, $result);
     }
 
+    public function testDisableQuote()
+    {
+        $this->orderMock->expects($this->any())->method('getPayment')->willReturn($this->orderMock);
+        $this->orderMock->expects($this->any())->method('getConfig')->willReturnSelf();
+
+        $this->quoteMock->expects($this->any())->method('getIsActive')->willReturn(true);
+        $this->quoteMock->expects($this->any())->method('setIsActive')->with(false);
+
+        $cartRepositoryMock = $this->createMock(CartRepositoryInterface::class);
+        $cartRepositoryMock->expects($this->once())->method('get')->willReturn($this->quoteMock);
+        $cartRepositoryMock->expects($this->once())->method('save')->with($this->quoteMock);
+
+        // Create an instance of AuthorisationWebhookHandler
+        $webhookHandler = $this->createAuthorisationWebhookHandler(
+            null,
+            null,
+            null,
+            null,
+            null,
+            null,
+            null,
+            null,
+            null,
+            $cartRepositoryMock
+        );
+
+        $result = $webhookHandler->handleWebhook($this->orderMock, $this->notificationMock, 'paid');
+        $this->assertInstanceOf(Order::class, $result);
+    }
+
     /**
      * @throws ReflectionExceptionAlias
      */
@@ -358,9 +400,9 @@ protected function createAuthorisationWebhookHandler(
         $mockChargedCurrency = null,
         $mockConfigHelper = null,
         $mockInvoiceHelper = null,
-        $mockPaymentMethodsHelper = null
-    ): AuthorisationWebhookHandler
-    {
+        $mockPaymentMethodsHelper = null,
+        $mockCartRepositoryMock = null
+    ): AuthorisationWebhookHandler {
         if (is_null($mockAdyenOrderPayment)) {
             $mockAdyenOrderPayment = $this->createMock(AdyenOrderPayment::class);
         }
@@ -397,6 +439,10 @@ protected function createAuthorisationWebhookHandler(
             $mockPaymentMethodsHelper = $this->createMock(PaymentMethods::class);
         }
 
+        if (is_null($mockCartRepositoryMock)) {
+            $mockCartRepositoryMock = $this->createMock(CartRepositoryInterface::class);
+        }
+
         return new AuthorisationWebhookHandler(
             $mockAdyenOrderPayment,
             $mockOrderHelper,
@@ -406,7 +452,8 @@ protected function createAuthorisationWebhookHandler(
             $mockChargedCurrency,
             $mockConfigHelper,
             $mockInvoiceHelper,
-            $mockPaymentMethodsHelper
+            $mockPaymentMethodsHelper,
+            $mockCartRepositoryMock
         );
     }
 }