Merge pull request #361 from magento-l3/L3-PR-2023-09-06

L3 pr 2023 09 06

Author: internal-magento-queue-manager[bot]

InventoryCatalog/Plugin/CatalogInventory/Observer/ParentItemProcessor/SkipParentItemProcessorOnMultipleSourceMode.php

@@ -0,0 +1,51 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\InventoryCatalog\Plugin\CatalogInventory\Observer\ParentItemProcessor;
+
+use Closure;
+use Magento\Catalog\Api\Data\ProductInterface;
+use Magento\CatalogInventory\Observer\ParentItemProcessorInterface;
+use Magento\InventoryCatalogApi\Model\IsSingleSourceModeInterface;
+
+/**
+ * Process composite product stock status.
+ */
+class SkipParentItemProcessorOnMultipleSourceMode
+{
+    /**
+     * @var IsSingleSourceModeInterface
+     */
+    private $isSingleSourceMode;
+
+    /**
+     * @param IsSingleSourceModeInterface $isSingleSourceMode
+     */
+    public function __construct(
+        IsSingleSourceModeInterface $isSingleSourceMode
+    ) {
+        $this->isSingleSourceMode = $isSingleSourceMode;
+    }
+
+    /**
+     * Process composite product stock status considering source mode.
+     *
+     * @param ParentItemProcessorInterface $subject
+     * @param Closure $proceed
+     * @param ProductInterface $product
+     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     */
+    public function aroundProcess(
+        ParentItemProcessorInterface $subject,
+        Closure $proceed,
+        ProductInterface $product
+    ): void {
+        if ($this->isSingleSourceMode->execute()) {
+            $proceed($product);
+        }
+    }
+}

InventoryCatalog/etc/di.xml

@@ -198,4 +198,7 @@
     <type name="Magento\Catalog\Model\ResourceModel\Product\Collection">
         <plugin name="outOfStockSorting" type="Magento\InventoryCatalog\Plugin\Catalog\Model\ResourceModel\Product\CollectionPlugin"/>
     </type>
+    <type name="Magento\CatalogInventory\Observer\ParentItemProcessorInterface">
+        <plugin name="skip_parent_stock_processors" type="Magento\InventoryCatalog\Plugin\CatalogInventory\Observer\ParentItemProcessor\SkipParentItemProcessorOnMultipleSourceMode"/>
+    </type>
 </config>

InventoryConfigurableProduct/Plugin/CatalogInventory/Observer/ParentItemProcessor/AdaptParentItemProcessorPlugin.php renamed to InventoryConfigurableProduct/Plugin/Model/UpdateParentStockStatus.php

@@ -5,63 +5,68 @@
  */
 declare(strict_types=1);
 
-namespace Magento\InventoryConfigurableProduct\Plugin\CatalogInventory\Observer\ParentItemProcessor;
+namespace Magento\InventoryConfigurableProduct\Plugin\Model;
 
-use Closure;
-use Magento\Catalog\Api\Data\ProductInterface;
 use Magento\CatalogInventory\Api\StockRegistryInterface;
-use Magento\CatalogInventory\Observer\ParentItemProcessorInterface;
 use Magento\ConfigurableProduct\Model\Product\Type\Configurable;
+use Magento\Framework\Exception\NoSuchEntityException;
+use Magento\Inventory\Model\SourceItem\Command\Handler\SourceItemsSaveHandler;
+use Magento\InventoryCatalogApi\Model\GetProductIdsBySkusInterface;
 use Magento\InventoryCatalogApi\Model\GetSkusByProductIdsInterface;
 use Magento\InventoryCatalogApi\Model\IsSingleSourceModeInterface;
 use Magento\InventoryIndexer\Model\ResourceModel\UpdateLegacyStockStatus;
 
-/**
- * Process configurable product stock status.
- */
-class AdaptParentItemProcessorPlugin
+class UpdateParentStockStatus
 {
     /**
      * @var IsSingleSourceModeInterface
      */
-    private $isSingleSourceMode;
+    private IsSingleSourceModeInterface $isSingleSourceMode;
 
     /**
      * @var GetSkusByProductIdsInterface
      */
-    private $getSkusByProductIds;
+    private GetSkusByProductIdsInterface $getSkusByProductIds;
+
+    /**
+     * @var GetProductIdsBySkusInterface
+     */
+    private GetProductIdsBySkusInterface $getProductIdsBySkus;
 
     /**
      * @var Configurable
      */
-    private $configurableType;
+    private Configurable $configurableType;
 
     /**
      * @var UpdateLegacyStockStatus
      */
-    private $updateLegacyStockStatus;
+    private UpdateLegacyStockStatus $updateLegacyStockStatus;
 
     /**
      * @var StockRegistryInterface
      */
-    private $stockRegistry;
+    private StockRegistryInterface $stockRegistry;
 
     /**
      * @param IsSingleSourceModeInterface $isSingleSourceMode
      * @param GetSkusByProductIdsInterface $getSkusByProductIds
+     * @param GetProductIdsBySkusInterface $getProductIdsBySkus
      * @param Configurable $configurableType
      * @param UpdateLegacyStockStatus $updateLegacyStockStatus
      * @param StockRegistryInterface $stockRegistry
      */
     public function __construct(
         IsSingleSourceModeInterface $isSingleSourceMode,
         GetSkusByProductIdsInterface $getSkusByProductIds,
+        GetProductIdsBySkusInterface $getProductIdsBySkus,
         Configurable $configurableType,
         UpdateLegacyStockStatus $updateLegacyStockStatus,
         StockRegistryInterface $stockRegistry
     ) {
         $this->isSingleSourceMode = $isSingleSourceMode;
         $this->getSkusByProductIds = $getSkusByProductIds;
+        $this->getProductIdsBySkus = $getProductIdsBySkus;
         $this->configurableType = $configurableType;
         $this->updateLegacyStockStatus = $updateLegacyStockStatus;
         $this->stockRegistry = $stockRegistry;
@@ -70,20 +75,21 @@ public function __construct(
     /**
      * Process configurable product stock status considering source mode.
      *
-     * @param ParentItemProcessorInterface $subject
-     * @param Closure $proceed
-     * @param ProductInterface $product
+     * @param SourceItemsSaveHandler $subject
+     * @param void $result
+     * @param array $sourceItems
+     * @return void
+     * @throws NoSuchEntityException
      * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      */
-    public function aroundProcess(
-        ParentItemProcessorInterface $subject,
-        Closure $proceed,
-        ProductInterface $product
+    public function afterExecute(
+        SourceItemsSaveHandler $subject,
+        $result,
+        array $sourceItems
     ): void {
-        if ($this->isSingleSourceMode->execute()) {
-            $proceed($product);
-        } else {
-            $parentIds = $this->configurableType->getParentIdsByChild($product->getId());
+        if (!$this->isSingleSourceMode->execute()) {
+            $productIds = $this->getProductIds($sourceItems);
+            $parentIds = $this->configurableType->getParentIdsByChild($productIds);
             $skus = $this->getSkusByProductIds->execute($parentIds);
 
             $dataForUpdate = [];
@@ -93,7 +99,31 @@ public function aroundProcess(
                     $dataForUpdate[$skus[$parentId]] = true;
                 }
             }
-            $this->updateLegacyStockStatus->execute($dataForUpdate);
+            if (count($dataForUpdate)) {
+                $this->updateLegacyStockStatus->execute($dataForUpdate);
+            }
+        }
+    }
+
+    /**
+     * Get product ids
+     *
+     * @param array $sourceItems
+     * @return array
+     */
+    private function getProductIds(array $sourceItems): array
+    {
+        $productIds = [];
+        foreach ($sourceItems as $sourceItem) {
+            if ($sourceItem->getStatus()) {
+                try {
+                    $sku = $sourceItem->getSku();
+                    $productIds[$sku] ??= (int) $this->getProductIdsBySkus->execute([$sku])[$sku];
+                } catch (NoSuchEntityException $e) {
+                    continue;
+                }
+            }
         }
+        return $productIds;
     }
 }

InventoryConfigurableProduct/Test/Api/ConfigurableProductShouldBeInStockWhenChildProductInStockTest.php

@@ -8,18 +8,31 @@
 namespace Magento\InventoryConfigurableProduct\Test\Api;
 
 use Magento\Catalog\Api\ProductRepositoryInterface;
+use Magento\Catalog\Model\ResourceModel\Product\Collection;
+use Magento\Catalog\Model\ResourceModel\Product\CollectionFactory;
+use Magento\Catalog\Test\Fixture\Product;
 use Magento\CatalogInventory\Api\StockRegistryInterface;
+use Magento\CatalogInventory\Helper\Stock;
+use Magento\ConfigurableProduct\Test\Fixture\Attribute;
+use Magento\ConfigurableProduct\Test\Fixture\Product as ConfigurableProductFixture;
 use Magento\Framework\Api\SearchCriteria;
 use Magento\Framework\ObjectManagerInterface;
 use Magento\Framework\Webapi\Rest\Request;
 use Magento\InventoryApi\Api\Data\SourceItemInterface;
+use Magento\InventoryApi\Test\Fixture\Source;
 use Magento\InventoryCatalogApi\Model\GetProductIdsBySkusInterface;
 use Magento\Store\Model\StoreManagerInterface;
+use Magento\TestFramework\Fixture\AppArea;
+use Magento\TestFramework\Fixture\DataFixture;
+use Magento\TestFramework\Fixture\DataFixtureStorage;
+use Magento\TestFramework\Fixture\DataFixtureStorageManager;
 use Magento\TestFramework\Helper\Bootstrap;
 use Magento\TestFramework\TestCase\WebapiAbstract;
 
 /**
  * Test validation on add source to child product of configurable product.
+ *
+ * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 class ConfigurableProductShouldBeInStockWhenChildProductInStockTest extends WebapiAbstract
 {
@@ -60,6 +73,11 @@ class ConfigurableProductShouldBeInStockWhenChildProductInStockTest extends Weba
      */
     private $storeCodeBefore;
 
+    /**
+     * @var DataFixtureStorage
+     */
+    private $fixtures;
+
     /**
      * @var array[]
      */
@@ -82,6 +100,12 @@ class ConfigurableProductShouldBeInStockWhenChildProductInStockTest extends Weba
             SourceItemInterface::QUANTITY => 0,
             SourceItemInterface::STATUS => SourceItemInterface::STATUS_OUT_OF_STOCK,
         ],
+        [
+            SourceItemInterface::SOURCE_CODE => 'default',
+            SourceItemInterface::SKU => self::CONFIGURABLE_CHILD_PRODUCT_SKU2,
+            SourceItemInterface::QUANTITY => 0,
+            SourceItemInterface::STATUS => SourceItemInterface::STATUS_OUT_OF_STOCK,
+        ],
     ];
     /**
      * @inheritdoc
@@ -94,6 +118,7 @@ protected function setUp(): void
         $this->getProductIdsBySkus = $this->objectManager->get(GetProductIdsBySkusInterface::class);
         $this->storeManager = $this->objectManager->get(StoreManagerInterface::class);
         $this->storeCodeBefore = $this->storeManager->getStore()->getCode();
+        $this->fixtures = DataFixtureStorageManager::getStorage();
     }
 
     protected function tearDown(): void
@@ -130,6 +155,70 @@ public function testConfigurableProductIsInStockAfterSave()
         self::assertEquals(0, $actualData['items'][0]['quantity']);
     }
 
+    /**
+     * Test if configurable product back in stock if child product is in stock again
+     *
+     */
+    #[
+        AppArea('frontend'),
+        DataFixture(Source::class, as: 'src'),
+        DataFixture(Attribute::class, ['options' => [['label' => 'option', 'sort_order' => 0]]], as:'attribute'),
+        DataFixture(Product::class, as: 'simple'),
+        DataFixture(
+            ConfigurableProductFixture::class,
+            ['_options' => ['$attribute$'], '_links' => ['$simple$']],
+            as: 'configurable'
+        )
+    ]
+    public function testConfigurableProductIsInStockOnDefaultSourceAfterSave()
+    {
+        $simpleProduct = $this->fixtures->get('simple');
+        $configurableProduct = $this->fixtures->get('configurable');
+
+        $collection = $this->getLayerProductCollection($configurableProduct->getSku());
+        self::assertEquals(1, $collection->count());
+
+        $this->addSourceItems([
+            [
+                SourceItemInterface::SOURCE_CODE => 'default',
+                SourceItemInterface::SKU => $simpleProduct->getSku(),
+                SourceItemInterface::QUANTITY => 0,
+                SourceItemInterface::STATUS => SourceItemInterface::STATUS_OUT_OF_STOCK
+            ]
+        ]);
+
+        $collection = $this->getLayerProductCollection($configurableProduct->getSku());
+        self::assertEquals(0, $collection->count());
+
+        $this->addSourceItems([
+            [
+                SourceItemInterface::SOURCE_CODE => 'default',
+                SourceItemInterface::SKU => $simpleProduct->getSku(),
+                SourceItemInterface::QUANTITY => 100,
+                SourceItemInterface::STATUS => SourceItemInterface::STATUS_IN_STOCK,
+            ]
+        ]);
+
+        $collection = $this->getLayerProductCollection($configurableProduct->getSku());
+        self::assertEquals(1, $collection->count());
+    }
+
+    /**
+     * Get layer product collection for frontend
+     *
+     * @param string $sku
+     * @return Collection
+     */
+    private function getLayerProductCollection(string $sku): Collection
+    {
+        $collection = $this->objectManager->get(CollectionFactory::class)->create();
+        $collection->addAttributeToFilter('sku', $sku)
+            ->addMinimalPrice()
+            ->addFinalPrice()
+            ->addTaxPercents();
+        return $collection;
+    }
+
     /**
      * Add source items data for the configurable product
      *

InventoryConfigurableProduct/Test/Integration/CatalogInventory/Observer/ParentItemProcessor/AdaptParentItemProcessorPluginTest.php renamed to InventoryConfigurableProduct/Test/Integration/CatalogInventory/ConfigurableProductShouldBeInStockWhenChildProductInStockTest.php

@@ -5,23 +5,23 @@
  */
 declare(strict_types=1);
 
-namespace Magento\InventoryConfigurableProduct\Test\Integration\CatalogInventory\Observer\ParentItemProcessor;
+namespace Magento\InventoryConfigurableProduct\Test\Integration\CatalogInventory;
 
 use Magento\Catalog\Api\ProductRepositoryInterface;
-use Magento\CatalogInventory\Api\StockItemRepositoryInterface;
-use Magento\InventorySalesApi\Api\AreProductsSalableInterface;
 use Magento\Catalog\Test\Fixture\Product as ProductFixture;
+use Magento\CatalogInventory\Api\StockItemRepositoryInterface;
 use Magento\ConfigurableProduct\Test\Fixture\Attribute as AttributeFixture;
 use Magento\ConfigurableProduct\Test\Fixture\Product as ConfigurableProductFixture;
 use Magento\InventoryApi\Test\Fixture\SourceItem as SourceItemFixture;
+use Magento\InventorySalesApi\Api\AreProductsSalableInterface;
 use Magento\TestFramework\Fixture\DataFixture;
 use Magento\TestFramework\Fixture\DataFixtureStorage;
 use Magento\TestFramework\Fixture\DataFixtureStorageManager;
 use Magento\TestFramework\Fixture\DbIsolation;
 use Magento\TestFramework\Helper\Bootstrap;
 use PHPUnit\Framework\TestCase;
 
-class AdaptParentItemProcessorPluginTest extends TestCase
+class ConfigurableProductShouldBeInStockWhenChildProductInStockTest extends TestCase
 {
     /**
      * @var DataFixtureStorage

InventoryConfigurableProduct/etc/di.xml

@@ -24,9 +24,6 @@
             <argument name="baseSelectProcessor" xsi:type="object">Magento\InventoryConfigurableProduct\Pricing\Price\LowestPriceOptionsProvider\StockStatusBaseSelectProcessor</argument>
         </arguments>
     </type>
-    <type name="Magento\CatalogInventory\Observer\ParentItemProcessorInterface">
-        <plugin name="adapt_parent_stock_processor" type="Magento\InventoryConfigurableProduct\Plugin\CatalogInventory\Observer\ParentItemProcessor\AdaptParentItemProcessorPlugin"/>
-    </type>
     <type name="Magento\ConfigurableProduct\Model\ResourceModel\Product\Indexer\Price\OptionsSelectBuilder">
         <arguments>
             <argument name="selectProcessor" xsi:type="object">Magento\InventoryConfigurableProduct\Pricing\Price\Indexer\BaseStockStatusSelectProcessor</argument>
@@ -56,4 +53,7 @@
             </argument>
         </arguments>
     </type>
+    <type name="Magento\Inventory\Model\SourceItem\Command\Handler\SourceItemsSaveHandler">
+        <plugin name="update_parent_stock_status" type="Magento\InventoryConfigurableProduct\Plugin\Model\UpdateParentStockStatus"/>
+    </type>
 </config>