[Unsupported Products] Removing inventory requirement for bundle/group products (#491)

* Removing inventory check for unsupported products - these items in Magento do not have any inventory associated with them as they are logical groups, however stock status is still relevant as controls whether the items are displayed on the seller website.

* Incorporating new unit tests and adding features for grouped product stock

* Removing inventory check for unsupported products - these items in Magento do not have any inventory associated with them as they are logical groups, however stock status is still relevant as controls whether the items are displayed on the seller website.

* Fixing review comments

* Reformat

* Fix test failure

Author: ladders-meta

app/code/Meta/Catalog/Model/Product/Feed/Builder/Inventory.php

@@ -26,7 +26,7 @@
 use Magento\CatalogInventory\Api\StockItemCriteriaInterfaceFactory;
 use Magento\CatalogInventory\Api\StockItemRepositoryInterface;
 
-class Inventory implements InventoryInterface
+class Inventory extends InventoryRequirements implements InventoryInterface
 {
     /**
      * @var StockItemRepositoryInterface
@@ -59,9 +59,9 @@ class Inventory implements InventoryInterface
      * @param SystemConfig $systemConfig
      */
     public function __construct(
-        StockItemRepositoryInterface $stockItemRepository,
+        StockItemRepositoryInterface      $stockItemRepository,
         StockItemCriteriaInterfaceFactory $stockItemCriteriaInterfaceFactory,
-        SystemConfig $systemConfig
+        SystemConfig                      $systemConfig
     ) {
         $this->stockItemRepository = $stockItemRepository;
         $this->stockItemCriteriaInterfaceFactory = $stockItemCriteriaInterfaceFactory;
@@ -108,8 +108,9 @@ public function getAvailability(): string
         if ($inventory === self::UNMANAGED_STOCK_QTY) {
             return self::STATUS_IN_STOCK;
         }
+
         return $this->productStock && $this->productStock->getIsInStock()
-        && ($inventory > 0)
+        && $this->meetsInventoryRequirementsToBeInStock($this->product)
             ? self::STATUS_IN_STOCK : self::STATUS_OUT_OF_STOCK;
     }
 

app/code/Meta/Catalog/Model/Product/Feed/Builder/InventoryInterface.php

@@ -17,6 +17,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 namespace Meta\Catalog\Model\Product\Feed\Builder;
 
 use Magento\Catalog\Model\Product;

app/code/Meta/Catalog/Model/Product/Feed/Builder/InventoryRequirements.php

@@ -0,0 +1,66 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace Meta\Catalog\Model\Product\Feed\Builder;
+
+use Magento\Catalog\Model\Product;
+
+abstract class InventoryRequirements implements InventoryInterface
+{
+    /**
+     * Validates if the item meets inventory requirements to be flagged as in stock.
+     *
+     * This will pass if either the item does not require inventory, or the available inventory is greater than zero.
+     *
+     * @param ?Product $product
+     * @return bool
+     */
+    public function meetsInventoryRequirementsToBeInStock(?Product $product): bool
+    {
+        if (!$product) {
+            return false;
+        }
+
+        if (!$this->isInventoryRequired($product)) {
+            return true;
+        }
+
+        return $this->getInventory() > 0;
+    }
+
+    /**
+     * Identifies if inventory is applicable and should be checked as part of generating item availability.
+     * For some aggregate product types, such as grouped products and bundles, inventory isn't applicable.
+     * Therefore, for these types of products, we should not incorporate inventory into stock status checks
+     *
+     * @param Product $product
+     * @return bool
+     */
+    private function isInventoryRequired(Product $product): bool
+    {
+        switch ($product->getTypeId()) {
+            case 'bundle':
+            case 'grouped':
+                return false;
+            default:
+                return true;
+        }
+    }
+}

app/code/Meta/Catalog/Model/Product/Feed/Builder/MultiSourceInventory.php

@@ -27,7 +27,7 @@
 use Magento\InventorySalesApi\Model\StockByWebsiteIdResolverInterface;
 use Meta\BusinessExtension\Model\System\Config as SystemConfig;
 
-class MultiSourceInventory implements InventoryInterface
+class MultiSourceInventory extends InventoryRequirements implements InventoryInterface
 {
     /**
      * @var Product
@@ -77,11 +77,11 @@ class MultiSourceInventory implements InventoryInterface
      * @param GetIsManageStockForProduct $getIsManageStockForProduct
      */
     public function __construct(
-        IsProductSalableInterface $isProductSalableInterface,
-        GetProductSalableQtyInterface $getProductSalableQtyInterface,
-        SystemConfig $systemConfig,
+        IsProductSalableInterface         $isProductSalableInterface,
+        GetProductSalableQtyInterface     $getProductSalableQtyInterface,
+        SystemConfig                      $systemConfig,
         StockByWebsiteIdResolverInterface $stockByWebsiteIdResolver,
-        GetIsManageStockForProduct $getIsManageStockForProduct
+        GetIsManageStockForProduct        $getIsManageStockForProduct
     ) {
         $this->isProductSalableInterface = $isProductSalableInterface;
         $this->getProductSalableQtyInterface = $getProductSalableQtyInterface;
@@ -151,7 +151,7 @@ public function isStockManagedForProduct(): bool
      */
     public function initInventoryForProduct(Product $product): MultiSourceInventory
     {
-        $websiteId = (int) $product->getStore()->getWebsiteId();
+        $websiteId = (int)$product->getStore()->getWebsiteId();
         $stockId = $this->stockByWebsiteIdResolver->execute($websiteId)->getStockId();
         $this->product = $product;
         $this->stockStatus = $this->isInStock($product, $stockId);
@@ -170,7 +170,9 @@ public function getAvailability(): string
         if (!$this->isStockManagedForProduct()) {
             return self::STATUS_IN_STOCK;
         }
-        return $this->getInventory() && $this->stockStatus ? self::STATUS_IN_STOCK : self::STATUS_OUT_OF_STOCK;
+
+        return $this->meetsInventoryRequirementsToBeInStock($this->product)
+        && $this->stockStatus ? self::STATUS_IN_STOCK : self::STATUS_OUT_OF_STOCK;
     }
 
     /**
@@ -183,11 +185,13 @@ public function getInventory(): int
         if (!$this->product) {
             return 0;
         }
+
         if (!$this->isStockManagedForProduct()) {
             return self::UNMANAGED_STOCK_QTY;
         }
+
         $outOfStockThreshold = $this->systemConfig->getOutOfStockThreshold($this->product->getStoreId());
-        $quantityAvailableForCatalog = (int) $this->stockQty - $outOfStockThreshold;
+        $quantityAvailableForCatalog = (int)$this->stockQty - $outOfStockThreshold;
         return $quantityAvailableForCatalog > 0 ? $quantityAvailableForCatalog : 0;
     }
 }

app/code/Meta/Catalog/Test/Unit/Model/Product/Feed/Builder/InventoryRequirementsTest.php

@@ -0,0 +1,78 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace Meta\Catalog\Test\Unit\Model\Product\Feed\Builder;
+
+require_once __DIR__ . "/../../../../../../Model/Product/Feed/Builder/InventoryInterface.php";
+require_once __DIR__ . "/../../../../../../Model/Product/Feed/Builder/InventoryRequirements.php";
+
+use Magento\Catalog\Model\Product;
+use Meta\Catalog\Model\Product\Feed\Builder\InventoryRequirements;
+use PHPUnit\Framework\TestCase;
+
+class InventoryRequirementsTest extends TestCase
+{
+    /**
+     * @var Product
+     */
+    private Product $product;
+
+    /**
+     * Used to set the values before running a test
+     *
+     * @return void
+     */
+    public function setUp(): void
+    {
+        $this->product = $this->createStub(Product::class);
+    }
+
+    public function dataProvider(): array
+    {
+        return [
+            'grouped products: no required inventory' => ['grouped', 0, true],
+            'bundle products: no required inventory' => ['grouped', 0, true],
+            'simple products: require inventory, zero inventory available,' => ['simple', 0, false],
+            'simple products: require inventory, non-zero inventory available,' => ['simple', 1, true],
+        ];
+    }
+
+    /**
+     * @dataProvider dataProvider
+     */
+    public function testProductsMeetInventoryRequirements(string $productTypeId, int $inventoryCount, bool $expected)
+    {
+        // Arrange
+        $this->product->method('getTypeId')->willReturn($productTypeId);
+
+        $inventoryMethod = 'getInventory';
+        $mock = $this->getMockForAbstractClass(InventoryRequirements::class);
+
+        $mock->expects($this->any())
+            ->method($inventoryMethod)
+            ->will($this->returnValue($inventoryCount));
+
+        // Act
+        $meetsInventoryRequirements = $mock->meetsInventoryRequirementsToBeInStock($this->product);
+
+        // Assert
+        $this->assertEquals($expected, $meetsInventoryRequirements);
+    }
+}