ACP2E-157: Coupon is marked used even if order doesn't create

- Fixed for a case when quote validation fails

Author: viktym

app/code/Magento/SalesRule/Plugin/CouponUsagesIncrement.php

@@ -10,6 +10,7 @@
 use Magento\Framework\Exception\NoSuchEntityException;
 use Magento\Quote\Model\Quote;
 use Magento\Quote\Model\QuoteManagement;
+use Magento\Sales\Api\Data\OrderInterface;
 use Magento\SalesRule\Model\Coupon\Quote\UpdateCouponUsages;
 
 /**
@@ -34,19 +35,26 @@ public function __construct(UpdateCouponUsages $updateCouponUsages)
      * Increments number of coupon usages before placing order
      *
      * @param QuoteManagement $subject
+     * @param \Closure $proceed
      * @param Quote $quote
      * @param array $orderData
-     * @return void
-     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     * @return OrderInterface|null
      * @throws NoSuchEntityException
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      */
-    public function beforeSubmit(QuoteManagement $subject, Quote $quote, $orderData = [])
+    public function aroundSubmit(QuoteManagement $subject, \Closure $proceed, Quote $quote, $orderData = [])
     {
         /* if coupon code has been canceled then need to notify the customer */
         if (!$quote->getCouponCode() && $quote->dataHasChangedFor('coupon_code')) {
             throw new NoSuchEntityException(__("The coupon code isn't valid. Verify the code and try again."));
         }
 
         $this->updateCouponUsages->execute($quote, true);
+        try {
+            return $proceed($quote, $orderData);
+        } catch (\Throwable $e) {
+            $this->updateCouponUsages->execute($quote, false);
+            throw $e;
+        }
     }
 }

app/code/Magento/SalesRule/etc/events.xml

@@ -39,7 +39,4 @@
     <event name="sales_quote_collect_totals_before">
         <observer name="salesrule_sales_quote_collect_totals_before" instance="\Magento\SalesRule\Observer\QuoteResetAppliedRulesObserver" />
     </event>
-    <event name="sales_model_service_quote_submit_failure">
-        <observer name="sales_rule_decrement_coupon_usage_quote_submit_failure" instance="\Magento\SalesRule\Observer\CouponUsagesDecrement" />
-    </event>
 </config>

dev/tests/integration/testsuite/Magento/SalesRule/Plugin/CouponUsagesTest.php

@@ -9,6 +9,7 @@
 use Magento\Framework\ObjectManagerInterface;
 use Magento\Quote\Model\Quote;
 use Magento\Quote\Model\QuoteManagement;
+use Magento\Quote\Model\SubmitQuoteValidator;
 use Magento\Sales\Api\OrderManagementInterface;
 use Magento\Sales\Model\Service\OrderService;
 use Magento\SalesRule\Model\Coupon;
@@ -158,14 +159,16 @@ public function testSubmitQuoteAndCancelOrder()
     /**
      * Test to decrement coupon usages after exception on order placing
      *
+     * @param array $mockObjects
      * @magentoDataFixture Magento/SalesRule/_files/coupons_limited_order.php
+     * @magentoDbIsolation disabled
+     * @dataProvider quoteSubmitFailureDataProvider
      */
-    public function testSubmitQuoteWithError()
+    public function testQuoteSubmitFailure(array $mockObjects)
     {
         $customerId = 1;
         $couponCode = 'one_usage';
         $reservedOrderId = 'test01';
-        $exceptionMessage = 'Some test exception';
 
         /** @var Coupon $coupon */
         $coupon = $this->objectManager->get(Coupon::class);
@@ -174,23 +177,16 @@ public function testSubmitQuoteWithError()
         $quote = $this->objectManager->get(Quote::class);
         $quote->load($reservedOrderId, 'reserved_order_id');
 
-        /** @var OrderManagementInterface|MockObject $orderManagement */
-        $orderManagement = $this->createMock(OrderManagementInterface::class);
-        $orderManagement->expects($this->once())
-            ->method('place')
-            ->willThrowException(new \Exception($exceptionMessage));
-
         /** @var QuoteManagement $quoteManagement */
         $quoteManagement = $this->objectManager->create(
             QuoteManagement::class,
-            ['orderManagement' => $orderManagement]
+            $mockObjects
         );
 
         try {
             $quoteManagement->submit($quote);
         } catch (\Exception $exception) {
-            $this->assertEquals($exceptionMessage, $exception->getMessage());
-
+            sleep(10); // timeout to processing queue
             $this->usage->loadByCustomerCoupon($this->couponUsage, $customerId, $coupon->getId());
             $coupon->loadByCode($couponCode);
             self::assertEquals(
@@ -203,4 +199,31 @@ public function testSubmitQuoteWithError()
             );
         }
     }
+
+    /**
+     * @return array
+     */
+    public function quoteSubmitFailureDataProvider(): array
+    {
+        /** @var OrderManagementInterface|MockObject $orderManagement */
+        $orderManagement = $this->createMock(OrderManagementInterface::class);
+        $orderManagement->expects($this->once())
+            ->method('place')
+            ->willThrowException(new \Exception());
+
+        /** @var OrderManagementInterface|MockObject $orderManagement */
+        $submitQuoteValidator = $this->createMock(SubmitQuoteValidator::class);
+        $submitQuoteValidator->expects($this->once())
+            ->method('validateQuote')
+            ->willThrowException(new \Exception());
+
+        return [
+            'order placing failure' => [
+                ['orderManagement' => $orderManagement]
+            ],
+            'quote validation failure' => [
+                ['submitQuoteValidator' => $submitQuoteValidator]
+            ],
+        ];
+    }
 }