Fix wrong calculation of available stock during completing a payment

features/order/managing_orders/handling_order_payment/being_unable_to_finalize_order_payment_when_item_has_become_tracked.feature

@@ -0,0 +1,32 @@
+@managing_orders
+Feature: Being unable to finalize order's payment when at least one item has become tracked after the purchase
+    In order to mark order's payment state as complete when there is a sufficient reserved stock
+    As an Administrator
+    I want to be able to finalize payment only when there is a sufficient reserved stock
+
+    Background:
+        Given the store operates on a single channel in "United States"
+        And the store ships everywhere for Free
+        And the store allows paying with "Cash on Delivery"
+        And the store has a product "PHP T-Shirt"
+        And there is a customer "john@example.com" that placed an order "#00000001"
+        And the customer bought 5 "PHP T-Shirt" products
+        And the customer "John Doe" addressed it to "Seaside Fwy", "90802" "Los Angeles" in the "United States" with identical billing address
+        And the customer chose "Free" shipping method with "Cash on Delivery" payment
+        And I am logged in as an administrator
+
+    @api @ui
+    Scenario: Being unable to finalize order's payment when one item has become tracked after the purchase
+        Given I am viewing the summary of the order "#00000001"
+        And the "PHP T-Shirt" product's inventory has become tracked with 2 items
+        When I mark this order as paid
+        Then I should be notified that the order's payment could not be finalized due to insufficient stock
+        And it should have payment state "New"
+
+    @api @ui
+    Scenario: Being unable to finalize order's payment when one item has become tracked after the purchase
+        Given I am viewing the summary of the order "#00000001"
+        And the "PHP T-Shirt" product's inventory has become tracked with 6 items
+        When I mark this order as paid
+        Then I should be notified that the order's payment could not be finalized due to insufficient stock
+        And it should have payment state "New"

features/order/managing_orders/handling_order_payment/finalizing_order_payment.feature

@@ -1,43 +1,30 @@
 @managing_orders
-Feature: Finalizing order payment
+Feature: Finalizing order's payment with untracked items
     In order to mark order's payment state as complete
     As an Administrator
     I want to be able to finalize payment
 
     Background:
         Given the store operates on a single channel in "United States"
-        And the store has a product "Angel T-Shirt"
         And the store ships everywhere for Free
         And the store allows paying with "Cash on Delivery"
-        And there is a customer "lucy@teamlucifer.com" that placed an order "#00000666"
-        And the customer bought 5 "Angel T-Shirt" products
-        And the customer "Lucifer Morningstar" addressed it to "Seaside Fwy", "90802" "Los Angeles" in the "United States" with identical billing address
+        And the store has a product "PHP T-Shirt"
+        And there is a customer "john@example.com" that placed an order "#00000001"
+        And the customer bought 5 "PHP T-Shirt" products
+        And the customer "John Doe" addressed it to "Seaside Fwy", "90802" "Los Angeles" in the "United States" with identical billing address
         And the customer chose "Free" shipping method with "Cash on Delivery" payment
         And I am logged in as an administrator
 
-    @ui
+    @api @ui
     Scenario: Finalizing order's payment
-        Given I view the summary of the order "#00000666"
+        Given I am viewing the summary of the order "#00000001"
         When I mark this order as paid
         Then I should be notified that the order's payment has been successfully completed
         And it should have payment state "Completed"
 
-    @ui
-    Scenario: Finalizing order's payment when at least one item has become tracked after the purchase
-        Given I view the summary of the order "#00000666"
-        And the "Angel T-Shirt" product's inventory has become tracked with 2 items
-        When I mark this order as paid
-        Then I should be notified that the order's payment could not be finalized due to insufficient stock
-        And it should have payment state "New"
-
-    @ui
-    Scenario: Unable to finalize completed order's payment
+    @api @ui
+    Scenario: Being unable to finalize completed order's payment
         Given this order is already paid
-        When I view the summary of the order "#00000666"
-        Then I should not be able to mark this order as paid again
-
-    @ui
-    Scenario: Checking the payment state of a completed order
-        Given this order is already paid
-        When I browse orders
-        Then this order should have order payment state "Paid"
+        When I view the summary of the order "#00000001"
+        And it should have payment state "Completed"
+        And I should not be able to mark this order as paid again

features/order/managing_orders/handling_order_payment/finalizing_order_payment_with_tracked_item.feature

@@ -0,0 +1,24 @@
+@managing_orders
+Feature: Finalizing order's payment with tracked items
+    In order to mark order's payment state as complete when there is a sufficient stock
+    As an Administrator
+    I want to be able to finalize payment
+
+    Background:
+        Given the store operates on a single channel in "United States"
+        And the store ships everywhere for Free
+        And the store allows paying with "Cash on Delivery"
+        And the store has a product "PHP T-Shirt"
+        And there are 3 units of tracked product "PHP T-Shirt" available in the inventory
+        And there is a customer "john@example.com" that placed an order "#00000001"
+        And the customer bought 2 "PHP T-Shirt" products
+        And the customer "John Doe" addressed it to "Seaside Fwy", "90802" "Los Angeles" in the "United States" with identical billing address
+        And the customer chose "Free" shipping method with "Cash on Delivery" payment
+        And I am logged in as an administrator
+
+    @api @ui
+    Scenario: Finalizing order's payment
+        Given I am viewing the summary of the order "#00000001"
+        When I mark this order as paid
+        Then I should be notified that the order's payment has been successfully completed
+        And it should have payment state "Completed"

src/Sylius/Behat/Context/Api/Admin/ManagingOrdersContext.php

@@ -42,6 +42,7 @@ public function __construct(
     /**
      * @Given /^I am viewing the summary of (this order)$/
      * @When I view the summary of the order :order
+     * @Given I am viewing the summary of the order :order
      */
     public function iSeeTheOrder(OrderInterface $order): void
     {
@@ -311,4 +312,37 @@ public function theAdministratorShouldSeeThatThisOrderHasBeenPlacedIn(
 
         Assert::same($currencyCode, $currency);
     }
+
+    /**
+     * @Then I should be notified that the order's payment has been successfully completed
+     */
+    public function iShouldBeNotifiedThatTheOrdersPaymentHasBeenSuccessfullyCompleted(): void
+    {
+        Assert::true($this->responseChecker->isUpdateSuccessful($this->client->getLastResponse()));
+    }
+
+    /**
+     * @Then /^I should not be able to mark (this order) as paid again$/
+     */
+    public function iShouldNotBeAbleToMarkThisOrderAsPaidAgain(OrderInterface $order): void
+    {
+        $this->client->applyTransition(
+            Resources::PAYMENTS,
+            (string) $order->getLastPayment()->getId(),
+            PaymentTransitions::TRANSITION_COMPLETE,
+        );
+
+        Assert::false($this->responseChecker->isUpdateSuccessful($this->client->getLastResponse()));
+    }
+
+    /**
+     * @Then I should be notified that the order's payment could not be finalized due to insufficient stock
+     */
+    public function iShouldBeNotifiedThatTheOrdersPaymentCouldNotBeFinalizedDueToInsufficientStock(): void
+    {
+        Assert::contains(
+            $this->responseChecker->getError($this->client->getLastResponse()),
+            'Not enough units to decrease on hold quantity from the inventory of a variant',
+        );
+    }
 }

src/Sylius/Behat/Context/Setup/ProductContext.php

@@ -620,26 +620,25 @@ public function thisProductHasAnOptionWithoutAnyValues(ProductInterface $product
     /**
      * @Given /^there (?:is|are) (\d+) unit(?:|s) of (product "([^"]+)") available in the inventory$/
      */
-    public function thereIsQuantityOfProducts($quantity, ProductInterface $product)
+    public function thereIsQuantityOfProductAvailableInTheInventory(int $quantity, ProductInterface $product): void
     {
-        /** @var ProductVariantInterface $productVariant */
-        $productVariant = $this->defaultVariantResolver->getVariant($product);
-        $productVariant->setOnHand((int) $quantity);
+        $this->updateOnHand($product, $quantity);
+    }
 
-        $this->objectManager->flush();
+    /**
+     * @Given /^there (?:is|are) (\d+) unit(?:|s) of tracked (product "([^"]+)") available in the inventory$/
+     */
+    public function thereIsQuantityOfTrackedProductAvailableInTheInventory(int $quantity, ProductInterface $product): void
+    {
+        $this->updateOnHand($product, $quantity, true);
     }
 
     /**
      * @Given /^the (product "([^"]+)") is out of stock$/
      */
-    public function theProductIsOutOfStock(ProductInterface $product)
+    public function theProductIsOutOfStock(ProductInterface $product): void
     {
-        /** @var ProductVariantInterface $productVariant */
-        $productVariant = $this->defaultVariantResolver->getVariant($product);
-        $productVariant->setTracked(true);
-        $productVariant->setOnHand(0);
-
-        $this->objectManager->flush();
+        $this->updateOnHand($product, 0, true);
     }
 
     /**
@@ -1393,4 +1392,17 @@ private function createProductTaxon(TaxonInterface $taxon, ProductInterface $pro
 
         return $productTaxon;
     }
+
+    private function updateOnHand(ProductInterface $product, int $onHand, ?bool $tracked = null): void
+    {
+        /** @var ProductVariantInterface $productVariant */
+        $productVariant = $this->defaultVariantResolver->getVariant($product);
+        $productVariant->setOnHand($onHand);
+
+        if ($tracked !== null) {
+            $productVariant->setTracked($tracked);
+        }
+
+        $this->objectManager->flush();
+    }
 }

src/Sylius/Behat/Context/Ui/Admin/ManagingOrdersContext.php

@@ -62,9 +62,10 @@ public function iBrowseOrderHistory(OrderInterface $order)
 
     /**
      * @Given /^I am viewing the summary of (this order)$/
+     * @Given I am viewing the summary of the order :order
      * @When I view the summary of the order :order
      */
-    public function iSeeTheOrder(OrderInterface $order)
+    public function iViewTheSummaryOfTheOrder(OrderInterface $order): void
     {
         $this->showPage->open(['id' => $order->getId()]);
     }
@@ -273,7 +274,7 @@ public function itShouldBeShippedTo(
         string $countryName,
     ) {
         if (null !== $order) {
-            $this->iSeeTheOrder($order);
+            $this->iViewTheSummaryOfTheOrder($order);
         }
 
         Assert::true($this->showPage->hasShippingAddress($customerName, $street, $postcode, $city, $countryName));
@@ -305,7 +306,7 @@ public function itShouldBeBilledTo(
         string $countryName,
     ) {
         if (null !== $order) {
-            $this->iSeeTheOrder($order);
+            $this->iViewTheSummaryOfTheOrder($order);
         }
 
         Assert::true($this->showPage->hasBillingAddress($customerName, $street, $postcode, $city, $countryName));
@@ -534,7 +535,7 @@ public function iShouldBeNotifiedThatTheOrderSPaymentHasBeenSuccessfullyComplete
     /**
      * @Then I should be notified that the order's payment could not be finalized due to insufficient stock
      */
-    public function iShouldBeNotifiedThatTheOrderSPaymentCouldNotBeFinalizedDueToInsufficientStock()
+    public function iShouldBeNotifiedThatTheOrdersPaymentCouldNotBeFinalizedDueToInsufficientStock(): void
     {
         $this->notificationChecker->checkNotification(
             'The payment cannot be completed due to insufficient stock of the',

src/Sylius/Bundle/ApiBundle/Resources/config/app/config.yaml

@@ -51,6 +51,8 @@ api_platform:
         Sylius\Bundle\ApiBundle\Exception\ProvinceCannotBeRemoved: 422
         Sylius\Bundle\ApiBundle\Exception\ShippingMethodCannotBeRemoved: 422
         Sylius\Bundle\ApiBundle\Exception\ZoneCannotBeRemoved: 422
+        Sylius\Component\Core\Inventory\Exception\NotEnoughUnitsOnHandException: 422
+        Sylius\Component\Core\Inventory\Exception\NotEnoughUnitsOnHoldException: 422
         Symfony\Component\Serializer\Exception\MissingConstructorArgumentsException: 400
     collection:
         pagination:

src/Sylius/Bundle/CoreBundle/EventListener/PaymentPreCompleteListener.php

@@ -15,15 +15,10 @@
 
 use Sylius\Bundle\ResourceBundle\Event\ResourceControllerEvent;
 use Sylius\Component\Core\Model\PaymentInterface;
-use Sylius\Component\Inventory\Checker\AvailabilityCheckerInterface;
+use Sylius\Component\Core\Model\ProductVariantInterface;
 
 final class PaymentPreCompleteListener
 {
-    public function __construct(
-        private AvailabilityCheckerInterface $availabilityChecker,
-    ) {
-    }
-
     public function checkStockAvailability(ResourceControllerEvent $event): void
     {
         /** @var PaymentInterface $payment */
@@ -33,7 +28,7 @@ public function checkStockAvailability(ResourceControllerEvent $event): void
         foreach ($orderItems as $orderItem) {
             $variant = $orderItem->getVariant();
 
-            if (!$this->availabilityChecker->isStockSufficient($variant, $orderItem->getQuantity())) {
+            if (!$this->isStockSufficient($variant, $orderItem->getQuantity())) {
                 $event->setMessageType('error');
                 $event->setMessage('sylius.resource.payment.cannot_be_completed');
                 $event->setMessageParameters(['%productVariantCode%' => $variant->getCode()]);
@@ -43,4 +38,16 @@ public function checkStockAvailability(ResourceControllerEvent $event): void
             }
         }
     }
+
+    private function isStockSufficient(ProductVariantInterface $variant, int $quantity): bool
+    {
+        if (!$variant->isTracked()) {
+            return true;
+        }
+
+        return
+            $variant->getOnHold() - $quantity >= 0 &&
+            $variant->getOnHand() - $quantity >= 0
+        ;
+    }
 }

src/Sylius/Bundle/CoreBundle/Resources/config/services/listeners.xml

@@ -99,7 +99,6 @@
         </service>
 
         <service id="Sylius\Bundle\CoreBundle\EventListener\PaymentPreCompleteListener">
-            <argument type="service" id="Sylius\Component\Inventory\Checker\AvailabilityCheckerInterface" />
             <tag name="kernel.event_listener" event="sylius.payment.pre_complete" method="checkStockAvailability" />
         </service>