Merge pull request magento#3142 from arnobsh/MC-35306

MC-35306 Incorrect qty is returned for "Backorders with Notify Customer"

Author: Stanislav Idolov

InventorySales/Model/IsProductSalableCondition/BackOrderNotifyCustomerCondition.php

@@ -7,16 +7,18 @@
 
 namespace Magento\InventorySales\Model\IsProductSalableCondition;
 
+use Magento\Framework\App\ObjectManager;
 use Magento\InventoryConfigurationApi\Api\Data\StockItemConfigurationInterface;
 use Magento\InventoryConfigurationApi\Api\GetStockItemConfigurationInterface;
 use Magento\InventorySalesApi\Api\Data\ProductSalabilityErrorInterfaceFactory;
 use Magento\InventorySalesApi\Api\Data\ProductSalableResultInterface;
 use Magento\InventorySalesApi\Api\Data\ProductSalableResultInterfaceFactory;
 use Magento\InventorySalesApi\Api\IsProductSalableForRequestedQtyInterface;
 use Magento\InventorySalesApi\Model\GetStockItemDataInterface;
+use Magento\InventorySalesApi\Api\GetProductSalableQtyInterface;
 
 /**
- * @inheritdoc
+ * Get back order notify for customer condition
  */
 class BackOrderNotifyCustomerCondition implements IsProductSalableForRequestedQtyInterface
 {
@@ -40,22 +42,31 @@ class BackOrderNotifyCustomerCondition implements IsProductSalableForRequestedQt
      */
     private $productSalabilityErrorFactory;
 
+    /**
+     * @var GetProductSalableQtyInterface
+     */
+    private $getProductSalableQty;
+
     /**
      * @param GetStockItemConfigurationInterface $getStockItemConfiguration
      * @param GetStockItemDataInterface $getStockItemData
      * @param ProductSalableResultInterfaceFactory $productSalableResultFactory
      * @param ProductSalabilityErrorInterfaceFactory $productSalabilityErrorFactory
+     * @param GetProductSalableQtyInterface|null $getProductSalableQty
      */
     public function __construct(
         GetStockItemConfigurationInterface $getStockItemConfiguration,
         GetStockItemDataInterface $getStockItemData,
         ProductSalableResultInterfaceFactory $productSalableResultFactory,
-        ProductSalabilityErrorInterfaceFactory $productSalabilityErrorFactory
+        ProductSalabilityErrorInterfaceFactory $productSalabilityErrorFactory,
+        ?GetProductSalableQtyInterface $getProductSalableQty = null
     ) {
         $this->getStockItemConfiguration = $getStockItemConfiguration;
         $this->getStockItemData = $getStockItemData;
         $this->productSalableResultFactory = $productSalableResultFactory;
         $this->productSalabilityErrorFactory = $productSalabilityErrorFactory;
+        $this->getProductSalableQty = $getProductSalableQty
+            ?? ObjectManager::getInstance()->get(GetProductSalableQtyInterface::class);
     }
 
     /**
@@ -73,15 +84,18 @@ public function execute(string $sku, int $stockId, float $requestedQty): Product
                 return $this->productSalableResultFactory->create(['errors' => []]);
             }
 
-            $backOrderQty = $requestedQty - $stockItemData[GetStockItemDataInterface::QUANTITY];
-            if ($backOrderQty > 0) {
+            $salableQty = $this->getProductSalableQty->execute($sku, $stockId);
+            $backOrderQty = $requestedQty - $salableQty;
+            $displayQty = $this->getDisplayQty($backOrderQty, $salableQty, $requestedQty);
+
+            if ($displayQty > 0) {
                 $errors = [
                     $this->productSalabilityErrorFactory->create([
                             'code' => 'back_order-not-enough',
                             'message' => __(
                                 'We don\'t have as many quantity as you requested, '
                                 . 'but we\'ll back order the remaining %1.',
-                                $backOrderQty * 1
+                                $displayQty * 1
                             )])
                 ];
                 return $this->productSalableResultFactory->create(['errors' => $errors]);
@@ -90,4 +104,23 @@ public function execute(string $sku, int $stockId, float $requestedQty): Product
 
         return $this->productSalableResultFactory->create(['errors' => []]);
     }
+
+    /**
+     * Get display quantity to show the number of quantity customer can backorder
+     *
+     * @param float $backOrderQty
+     * @param float $salableQty
+     * @param float $requestedQty
+     * @return float
+     */
+    private function getDisplayQty(float $backOrderQty, float $salableQty, float $requestedQty): float
+    {
+        $displayQty = 0;
+        if ($backOrderQty > 0 && $salableQty > 0) {
+            $displayQty = $backOrderQty;
+        } elseif ($requestedQty > $salableQty) {
+            $displayQty = $requestedQty;
+        }
+        return $displayQty;
+    }
 }

InventorySales/Test/Unit/Model/IsProductSalableCondition/BackOrderNotifyCustomerConditionTest.php

@@ -7,6 +7,7 @@
 
 namespace Magento\InventorySales\Test\Unit\Model\IsProductSalableCondition;
 
+use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
 use Magento\InventoryConfigurationApi\Api\Data\StockItemConfigurationInterface;
 use Magento\InventoryConfigurationApi\Api\GetStockItemConfigurationInterface;
@@ -15,6 +16,7 @@
 use Magento\InventorySalesApi\Api\Data\ProductSalabilityErrorInterfaceFactory;
 use Magento\InventorySalesApi\Api\Data\ProductSalableResultInterface;
 use Magento\InventorySalesApi\Api\Data\ProductSalableResultInterfaceFactory;
+use Magento\InventorySalesApi\Api\GetProductSalableQtyInterface;
 use Magento\InventorySalesApi\Model\GetStockItemDataInterface;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
@@ -28,15 +30,22 @@ class BackOrderNotifyCustomerConditionTest extends TestCase
      * @var BackOrderNotifyCustomerCondition
      */
     private $model;
+
     /**
      * @var StockItemConfigurationInterface|MockObject
      */
     private $stockItemConfiguration;
+
     /**
      * @var array|null
      */
     private $stockItemData;
 
+    /**
+     * @var GetProductSalableQtyInterface|MockObject
+     */
+    private $getProductSalableQty;
+
     /**
      * @inheritDoc
      */
@@ -47,6 +56,9 @@ protected function setUp()
         $productSalableResultFactory = $this->createMock(
             ProductSalableResultInterfaceFactory::class
         );
+        $this->getProductSalableQty = $this->createMock(
+            GetProductSalableQtyInterface::class
+        );
         $productSalableResultFactory->method('create')
             ->willReturnCallback(
                 function ($args) {
@@ -94,6 +106,7 @@ function () {
                 'getStockItemData' => $getStockItemData,
                 'productSalableResultFactory' => $productSalableResultFactory,
                 'productSalabilityErrorFactory' => $productSalabilityErrorFactory,
+                'getProductSalableQty' => $this->getProductSalableQty
             ]
         );
     }
@@ -104,17 +117,26 @@ function () {
      * @dataProvider executeDataProvider
      * @param array|null $stockData
      * @param int $reqQty
+     * @param int $salableQty
      * @param int $backOrders
      * @param bool $manageStock
      * @param array $errors
-     * @throws \Magento\Framework\Exception\LocalizedException
+     * @throws LocalizedException
      */
-    public function testExecute(?array $stockData, int $reqQty, int $backOrders, bool $manageStock, array $errors): void
-    {
+    public function testExecute(
+        ?array $stockData,
+        int $reqQty,
+        int $salableQty,
+        int $backOrders,
+        bool $manageStock,
+        array $errors
+    ): void {
         $this->stockItemConfiguration->method('isManageStock')
             ->willReturn($manageStock);
         $this->stockItemConfiguration->method('getBackorders')
             ->willReturn($backOrders);
+        $this->getProductSalableQty->method('execute')
+            ->willReturn($salableQty);
         $this->stockItemData = $stockData;
         $actualErrors = [];
         foreach ($this->model->execute('simple', 1, $reqQty)->getErrors() as $error) {
@@ -125,14 +147,16 @@ public function testExecute(?array $stockData, int $reqQty, int $backOrders, boo
 
     /**
      * @return array
+     * @SuppressWarnings(PHPMD.ExcessiveMethodLength)
      */
     public function executeDataProvider(): array
     {
         return [
-            'StockQty=0, ReqQty=1, Backorders=YesNotify, ManageStock=Yes' => [
+            'StockQty=1, ReqQty=2, SalableQty=1, Backorders=YesNotify, ManageStock=Yes' => [
                 [
-                    GetStockItemDataInterface::QUANTITY => 0,
+                    GetStockItemDataInterface::QUANTITY => 1,
                 ],
+                2,
                 1,
                 StockItemConfigurationInterface::BACKORDERS_YES_NOTIFY,
                 true,
@@ -144,45 +168,82 @@ public function executeDataProvider(): array
                     ]
                 ],
             ],
-            'StockQty=1, ReqQty=1, Backorders=YesNotify, ManageStock=Yes' => [
+            'StockQty=10, ReqQty=20, SalableQty=0, Backorders=YesNotify, ManageStock=Yes' => [
+                [
+                    GetStockItemDataInterface::QUANTITY => 10,
+                ],
+                20,
+                0,
+                StockItemConfigurationInterface::BACKORDERS_YES_NOTIFY,
+                true,
+                [
+                    [
+                        'code' => 'back_order-not-enough',
+                        'message' => 'We don\'t have as many quantity as you requested,'
+                            . ' but we\'ll back order the remaining 20.'
+                    ]
+                ],
+            ],
+            'StockQty=10, ReqQty=20, SalableQty=15, Backorders=YesNotify, ManageStock=Yes' => [
+                [
+                    GetStockItemDataInterface::QUANTITY => 10,
+                ],
+                20,
+                15,
+                StockItemConfigurationInterface::BACKORDERS_YES_NOTIFY,
+                true,
+                [
+                    [
+                        'code' => 'back_order-not-enough',
+                        'message' => 'We don\'t have as many quantity as you requested,'
+                            . ' but we\'ll back order the remaining 5.'
+                    ]
+                ],
+            ],
+            'StockQty=1, ReqQty=1, SalableQty=1, Backorders=YesNotify, ManageStock=Yes' => [
                 [
                     GetStockItemDataInterface::QUANTITY => 1,
                 ],
                 1,
+                1,
                 StockItemConfigurationInterface::BACKORDERS_YES_NOTIFY,
                 true,
                 [],
             ],
-            'StockQty=?, ReqQty=1, Backorders=YesNotify, ManageStock=Yes' => [
+            'StockQty=?, ReqQty=1, SalableQty=1, Backorders=YesNotify, ManageStock=Yes' => [
                 null,
                 1,
+                1,
                 StockItemConfigurationInterface::BACKORDERS_YES_NOTIFY,
                 true,
                 [],
             ],
-            'StockQty=0, ReqQty=1, Backorders=No, ManageStock=Yes' => [
+            'StockQty=0, ReqQty=1, SalableQty=1, Backorders=No, ManageStock=Yes' => [
                 [
                     GetStockItemDataInterface::QUANTITY => 0,
                 ],
                 1,
+                1,
                 StockItemConfigurationInterface::BACKORDERS_NO,
                 true,
                 [],
             ],
-            'StockQty=0, ReqQty=1, Backorders=Yes, ManageStock=Yes' => [
+            'StockQty=0, ReqQty=1, SalableQty=1, Backorders=Yes, ManageStock=Yes' => [
                 [
                     GetStockItemDataInterface::QUANTITY => 0,
                 ],
                 1,
+                1,
                 StockItemConfigurationInterface::BACKORDERS_YES_NONOTIFY,
                 true,
                 [],
             ],
-            'StockQty=0, ReqQty=1, Backorders=YesNotify, ManageStock=No' => [
+            'StockQty=0, ReqQty=1, SalableQty=1, Backorders=YesNotify, ManageStock=No' => [
                 [
                     GetStockItemDataInterface::QUANTITY => 0,
                 ],
                 1,
+                1,
                 StockItemConfigurationInterface::BACKORDERS_YES_NOTIFY,
                 false,
                 [],