MC-42187: Configurable products with multiple dropdown attributes, do not show out of stock options, regarless configuration

- Initial commit and adding test

Author: arnobsh

app/code/Magento/ConfigurableProduct/Block/Product/View/Type/Configurable.php

@@ -13,8 +13,10 @@
 use Magento\Customer\Helper\Session\CurrentCustomer;
 use Magento\Customer\Model\Session;
 use Magento\Framework\App\ObjectManager;
+use Magento\Framework\Exception\NoSuchEntityException;
 use Magento\Framework\Locale\Format;
 use Magento\Framework\Pricing\PriceCurrencyInterface;
+use Magento\Store\Model\Store;
 
 /**
  * Confugurable product view type
@@ -198,7 +200,8 @@ public function getAllowProducts()
     /**
      * Retrieve current store
      *
-     * @return \Magento\Store\Model\Store
+     * @return Store
+     * @throws NoSuchEntityException
      */
     public function getCurrentStore()
     {
@@ -239,6 +242,8 @@ public function getJsonConfig()
             'chooseText' => __('Choose an Option...'),
             'images' => $this->getOptionImages(),
             'index' => isset($options['index']) ? $options['index'] : [],
+            'salable' => $options['salable'] ?? [],
+            'canDisplayShowOutOfStockStatus' => $options['canDisplayShowOutOfStockStatus'] ?? false
         ];
 
         if ($currentProduct->hasPreconfiguredValues() && !empty($attributesData['defaultValues'])) {

app/code/Magento/ConfigurableProduct/Helper/Data.php

@@ -8,6 +8,7 @@
 
 use Magento\Catalog\Model\Product\Image\UrlBuilder;
 use Magento\ConfigurableProduct\Model\Product\Type\Configurable;
+use Magento\Framework\App\Config\ScopeConfigInterface;
 use Magento\Framework\App\ObjectManager;
 use Magento\Catalog\Helper\Image as ImageHelper;
 use Magento\Catalog\Api\Data\ProductInterface;
@@ -33,14 +34,24 @@ class Data
      */
     private $imageUrlBuilder;
 
+    /**
+     * @var ScopeConfigInterface
+     */
+    private $scopeConfig;
+
     /**
      * @param ImageHelper $imageHelper
-     * @param UrlBuilder $urlBuilder
+     * @param UrlBuilder|null $urlBuilder
+     * @param ScopeConfigInterface|null $scopeConfig
      */
-    public function __construct(ImageHelper $imageHelper, UrlBuilder $urlBuilder = null)
-    {
+    public function __construct(
+        ImageHelper $imageHelper,
+        UrlBuilder $urlBuilder = null,
+        ?ScopeConfigInterface $scopeConfig = null
+    ) {
         $this->imageHelper = $imageHelper;
         $this->imageUrlBuilder = $urlBuilder ?? ObjectManager::getInstance()->get(UrlBuilder::class);
+        $this->scopeConfig = $scopeConfig ?? ObjectManager::getInstance()->get(ScopeConfigInterface::class);
     }
 
     /**
@@ -90,12 +101,20 @@ public function getOptions($currentProduct, $allowedProducts)
                 $productAttribute = $attribute->getProductAttribute();
                 $productAttributeId = $productAttribute->getId();
                 $attributeValue = $product->getData($productAttribute->getAttributeCode());
-                if ($product->isSalable()) {
+                if ($this->canDisplayShowOutOfStockStatus()) {
+                    if ($product->isSalable()) {
+                        $options['salable'][$productAttributeId][$attributeValue][] = $productId;
+                    }
                     $options[$productAttributeId][$attributeValue][] = $productId;
+                } else {
+                    if ($product->isSalable()) {
+                        $options[$productAttributeId][$attributeValue][] = $productId;
+                    }
                 }
                 $options['index'][$productId][$productAttributeId] = $attributeValue;
             }
         }
+        $options['canDisplayShowOutOfStockStatus'] = $this->canDisplayShowOutOfStockStatus();
         return $options;
     }
 
@@ -111,4 +130,14 @@ public function getAllowAttributes($product)
             ? $product->getTypeInstance()->getConfigurableAttributes($product)
             : [];
     }
+
+    /**
+     * Returns if display out of stock status set or not in catalog inventory
+     *
+     * @return bool
+     */
+    private function canDisplayShowOutOfStockStatus(): bool
+    {
+        return (bool) $this->scopeConfig->getValue('cataloginventory/options/show_out_of_stock');
+    }
 }

app/code/Magento/ConfigurableProduct/Test/Unit/Block/Product/View/Type/ConfigurableTest.php

@@ -435,6 +435,8 @@ private function getExpectedArray($productId, $amount, $priceQty, $percentage):
             'chooseText' => __('Choose an Option...'),
             'images' => [],
             'index' => [],
+            'salable' => [],
+            'canDisplayShowOutOfStockStatus' => false
         ];
 
         return $expectedArray;

app/code/Magento/ConfigurableProduct/Test/Unit/Helper/DataTest.php

@@ -13,6 +13,7 @@
 use Magento\Catalog\Model\Product\Image\UrlBuilder;
 use Magento\ConfigurableProduct\Helper\Data;
 use Magento\ConfigurableProduct\Model\Product\Type\Configurable;
+use Magento\Framework\App\Config\ScopeConfigInterface;
 use Magento\Framework\Data\Collection;
 use Magento\Framework\DataObject;
 use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
@@ -41,19 +42,26 @@ class DataTest extends TestCase
      */
     protected $imageUrlBuilder;
 
+    /**
+     * @var ScopeConfigInterface|MockObject
+     */
+    private $scopeConfigMock;
+
     protected function setUp(): void
     {
         $objectManager = new ObjectManager($this);
         $this->imageUrlBuilder = $this->getMockBuilder(UrlBuilder::class)
             ->disableOriginalConstructor()
             ->getMock();
+        $this->scopeConfigMock = $this->getMockForAbstractClass(ScopeConfigInterface::class);
         $this->_imageHelperMock = $this->createMock(Image::class);
         $this->_productMock = $this->createMock(Product::class);
         $this->_productMock->setTypeId(Configurable::TYPE_CODE);
         $this->_model = $objectManager->getObject(
             Data::class,
             [
-                '_imageHelper' => $this->_imageHelperMock
+                '_imageHelper' => $this->_imageHelperMock,
+                'scopeConfig' => $this->scopeConfigMock
             ]
         );
         $objectManager->setBackwardCompatibleProperty($this->_model, 'imageUrlBuilder', $this->imageUrlBuilder);
@@ -131,7 +139,9 @@ public function getOptionsDataProvider(): array
         );
         $provider = [];
         $provider[] = [
-            [],
+            [
+                'canDisplayShowOutOfStockStatus' => false
+            ],
             [
                 'allowed_products' => [],
                 'current_product_mock' => $currentProductMock,
@@ -213,6 +223,7 @@ public function getOptionsDataProvider(): array
                 'attribute_id_2' => [
                     'attribute_code_value_2' => ['product_id_1', 'product_id_2'],
                 ],
+                'canDisplayShowOutOfStockStatus' => false
             ],
             [
                 'allowed_products' => $allowedProducts,

app/code/Magento/ConfigurableProduct/view/frontend/web/js/configurable.js

@@ -432,7 +432,9 @@ define([
                 allowedOptions = [],
                 indexKey,
                 allowedProductMinPrice,
-                allowedProductsAllMinPrice;
+                allowedProductsAllMinPrice,
+                canDisplayOutOfStockProducts = false,
+                filteredSalableProducts;
 
             this._clearSelect(element);
             element.options[0] = new Option('', '');
@@ -506,11 +508,17 @@ define([
                         options[i].allowedProducts = allowedProducts;
                         element.options[index] = new Option(this._getOptionLabel(options[i]), options[i].id);
 
+                        if (this.options.spConfig.canDisplayShowOutOfStockStatus) {
+                            filteredSalableProducts = $(this.options.spConfig.salable[attributeId][options[i].id]).
+                            filter(options[i].allowedProducts);
+                            canDisplayOutOfStockProducts = filteredSalableProducts.length === 0;
+                        }
+
                         if (typeof options[i].price !== 'undefined') {
                             element.options[index].setAttribute('price', options[i].price);
                         }
 
-                        if (allowedProducts.length === 0) {
+                        if (allowedProducts.length === 0 || canDisplayOutOfStockProducts) {
                             element.options[index].disabled = true;
                         }
 

app/code/Magento/ConfigurableProductGraphQl/Model/Options/ConfigurableOptionsMetadata.php

@@ -54,13 +54,14 @@ public function getAvailableSelections(ProductInterface $product, array $options
         $availableSelections = [];
 
         foreach ($options as $attributeId => $option) {
-            if ($attributeId === 'index' || isset($selectedOptions[$attributeId])) {
+            if (in_array($attributeId, ['index','salable','canDisplayShowOutOfStockStatus'])
+                || isset($selectedOptions[$attributeId])) {
                 continue;
             }
 
             $availableSelections[] = $this->configurableOptionsFormatter->format(
                 $attributes[$attributeId],
-                $options[$attributeId] ?? []
+                $option ?? []
             );
         }