🔃 [Magento Community Engineering] Community Contributions - 2.4-develop latest changes

Accepted Community Pull Requests:
 - #26697: Update the product model custom option methods PHPdoc (by @hws47a)
 - #25349: Fixed issue when escape key is pressed to close prompt (by @konarshankar07)
 - #26982: Remove app/functions.php (by @Bartlomiejsz)
 - #26995: Fix typo in description node. (by @BorisovskiP)
 - #26932: Fix #26917 Tax rate zip/post range check box alignment issue (by @srsathish92)
 - #26090: Fixed issue 25910 choose drop down not close when open another (by @Usik2203)
 - #26928: Module_Cms MFTF test improvements (by @nandhini-nagaraj)
 - #26755: Fix wrong type of argument appendSummaryFieldsToCollection (by @Usik2203)
 - #25161: fixed confusing grammar in the backend formatDate() function (by @princefishthrower)
 - #26944: Unit test for CatalogProductCompareClearObserver (by @mmezhensky)
 - #26947: Unit test for AssignCouponDataAfterOrderCustomerAssignObserver (by @mmezhensky)
 - #26974: Fix: #26973 Fatal error when Product Image size is not defined (by @lbajsarowicz)
 - #26916: Move cache cleanup operation on state modification operation (by @kandy)
 - #25895: Change tag name (by @AndreyChorniy)
 - #26912: Unit test for ProductProcessUrlRewriteRemovingObserver (by @mmezhensky)
 - #26586: Improve exception message (by @oroskodias)
 - #26230: Activated "Pending Reviews" menu item when merchant opens 'Pending Reviews' section (by @rav-redchamps)
 - #26862: Removed disabled products from low stock report grid (by @Mohamed-Asar)
 - #26821: Reduce requirements for parameter in catalog product type factory (by @hws47a)


Fixed GitHub Issues:
 - #572: How do I: Bug tracking for Magento 1 + ideas for Magento 2 (reported by @seansan) has been fixed in #25349 by @konarshankar07 in 2.4-develop branch
   Related commits:
     1. a4a2ff7
     2. c42d48a
     3. b8e0c42
     4. d6995f7
     5. c9f9757
     6. 240fc19
     7. da6b361
     8. db51191
     9. 3e25bd1
     10. 633ea17
     11. 5d676b6
     12. 997959f
     13. d3aa932
     14. 65b2afe
     15. 727679d
     16. b41ea13
     17. 552eaaf
     18. ce6614e
     19. c14fbed
     20. 257eb00
     21. b1ab6a9
     22. 53fe8ee
     23. 437fab3

 - #26917: Tax rate Zip/Post range and check box alignment issue (reported by @renard123) has been fixed in #26932 by @srsathish92 in 2.4-develop branch
   Related commits:
     1. 08219e8
     2. 82e4623
     3. ff45a23

 - #25910: Choose drop down not close when open another for upload file for swatch (reported by @hasim32) has been fixed in #26090 by @Usik2203 in 2.4-develop branch
   Related commits:
     1. 423a4da
     2. 96a9f3a
     3. 2527b04
     4. 5f14e0e
     5. 7cd12dd

 - #26973: Fatal error on calling ImageFactory::create() for product_page_image_large (reported by @lbajsarowicz) has been fixed in #26974 by @lbajsarowicz in 2.4-develop branch
   Related commits:
     1. 806b4f9
     2. 74a0386

 - #25738: DOMDocument::loadHTML(): Tag date invalid in Entity (reported by @nghelo) has been fixed in #25895 by @AndreyChorniy in 2.4-develop branch
   Related commits:
     1. 1764aa8
     2. e537a76

 - #26229: Active menu is not set when opening admin path Marketing > User Content > Pending Reviews (reported by @rav-redchamps) has been fixed in #26230 by @rav-redchamps in 2.4-develop branch
   Related commits:
     1. dca6730
     2. d5cb185
     3. c8b80d0
     4. 5898776

 - #26838: Low stock report showing disabled products (reported by @Zyles) has been fixed in #26862 by @Mohamed-Asar in 2.4-develop branch
   Related commits:
     1. 6c8aa11
     2. b6f49b9

Author: magento-engcom-team

app/code/Magento/Catalog/Block/Product/ImageFactory.php

@@ -123,7 +123,7 @@ private function getLabel(Product $product, string $imageType): string
         if (empty($label)) {
             $label = $product->getName();
         }
-        return (string) $label;
+        return (string)$label;
     }
 
     /**
@@ -161,15 +161,15 @@ public function create(Product $product, string $imageId, array $attributes = nu
         }
 
         $attributes = $attributes === null ? [] : $attributes;
-        
+
         $data = [
             'data' => [
                 'template' => 'Magento_Catalog::product/image_with_borders.phtml',
                 'image_url' => $imageAsset->getUrl(),
                 'width' => $imageMiscParams['image_width'],
                 'height' => $imageMiscParams['image_height'],
                 'label' => $this->getLabel($product, $imageMiscParams['image_type']),
-                'ratio' => $this->getRatio($imageMiscParams['image_width'], $imageMiscParams['image_height']),
+                'ratio' => $this->getRatio($imageMiscParams['image_width'] ?? 0, $imageMiscParams['image_height'] ?? 0),
                 'custom_attributes' => $this->getStringCustomAttributes($attributes),
                 'class' => $this->getClass($attributes),
                 'product_id' => $product->getId()

app/code/Magento/Catalog/Model/Product.php

@@ -10,6 +10,7 @@
 use Magento\Catalog\Api\Data\ProductInterface;
 use Magento\Catalog\Api\ProductLinkRepositoryInterface;
 use Magento\Catalog\Model\Product\Attribute\Backend\Media\EntryConverterPool;
+use Magento\Catalog\Model\Product\Configuration\Item\Option\OptionInterface;
 use Magento\Catalog\Model\FilterProductCustomAttribute;
 use Magento\Framework\Api\AttributeValueFactory;
 use Magento\Framework\App\Filesystem\DirectoryList;
@@ -108,7 +109,7 @@ class Product extends \Magento\Catalog\Model\AbstractModel implements
     /**
      * Product object customization (not stored in DB)
      *
-     * @var array
+     * @var OptionInterface[]
      */
     protected $_customOptions = [];
 
@@ -2062,7 +2063,7 @@ public function addCustomOption($code, $value, $product = null)
     /**
      * Sets custom options for the product
      *
-     * @param array $options Array of options
+     * @param OptionInterface[] $options Array of options
      * @return void
      */
     public function setCustomOptions(array $options)
@@ -2073,7 +2074,7 @@ public function setCustomOptions(array $options)
     /**
      * Get all custom options of the product
      *
-     * @return array
+     * @return OptionInterface[]
      */
     public function getCustomOptions()
     {
@@ -2084,14 +2085,11 @@ public function getCustomOptions()
      * Get product custom option info
      *
      * @param   string $code
-     * @return  array
+     * @return  OptionInterface|null
      */
     public function getCustomOption($code)
     {
-        if (isset($this->_customOptions[$code])) {
-            return $this->_customOptions[$code];
-        }
-        return null;
+        return $this->_customOptions[$code] ?? null;
     }
 
     /**
@@ -2101,11 +2099,7 @@ public function getCustomOption($code)
      */
     public function hasCustomOptions()
     {
-        if (count($this->_customOptions)) {
-            return true;
-        } else {
-            return false;
-        }
+        return (bool)count($this->_customOptions);
     }
 
     /**
@@ -2405,16 +2399,14 @@ public function reloadPriceInfo()
         }
     }
 
-    // phpcs:disable PHPCompatibility.FunctionNameRestrictions.ReservedFunctionNames
     /**
      * Return Data Object data in array format.
      *
      * @return array
      * @todo refactor with converter for AbstractExtensibleModel
      */
-    public function __toArray()
+    public function __toArray() //phpcs:ignore PHPCompatibility.FunctionNameRestrictions.ReservedFunctionNames
     {
-        // phpcs:enable PHPCompatibility.FunctionNameRestrictions.ReservedFunctionNames
         $data = $this->_data;
         $hasToArray = function ($model) {
             return is_object($model) && method_exists($model, '__toArray') && is_callable([$model, '__toArray']);

app/code/Magento/Catalog/Model/Product/Type.php

@@ -6,43 +6,37 @@
 namespace Magento\Catalog\Model\Product;
 
 use Magento\Catalog\Model\Product;
+use Magento\Catalog\Model\Product\Type\Pool;
+use Magento\Catalog\Model\Product\Type\Price;
+use Magento\Catalog\Model\Product\Type\Price\Factory as PriceFactory;
+use Magento\Catalog\Model\Product\Type\Simple;
+use Magento\Catalog\Model\ProductTypes\ConfigInterface;
 use Magento\Framework\Data\OptionSourceInterface;
+use Magento\Framework\Pricing\PriceInfo\Factory as PriceInfoFactory;
 
 /**
  * Product type model
  *
+ *
  * @api
  * @since 100.0.2
  */
 class Type implements OptionSourceInterface
 {
-    /**#@+
-     * Available product types
-     */
     const TYPE_SIMPLE = 'simple';
 
     const TYPE_BUNDLE = 'bundle';
 
     const TYPE_VIRTUAL = 'virtual';
-    /**#@-*/
 
-    /**
-     * Default product type
-     */
     const DEFAULT_TYPE = 'simple';
 
-    /**
-     * Default product type model
-     */
-    const DEFAULT_TYPE_MODEL = \Magento\Catalog\Model\Product\Type\Simple::class;
+    const DEFAULT_TYPE_MODEL = Simple::class;
 
-    /**
-     * Default price model
-     */
-    const DEFAULT_PRICE_MODEL = \Magento\Catalog\Model\Product\Type\Price::class;
+    const DEFAULT_PRICE_MODEL = Price::class;
 
     /**
-     * @var \Magento\Catalog\Model\ProductTypes\ConfigInterface
+     * @var ConfigInterface
      */
     protected $_config;
 
@@ -77,35 +71,35 @@ class Type implements OptionSourceInterface
     /**
      * Product type factory
      *
-     * @var \Magento\Catalog\Model\Product\Type\Pool
+     * @var Pool
      */
     protected $_productTypePool;
 
     /**
      * Price model factory
      *
-     * @var \Magento\Catalog\Model\Product\Type\Price\Factory
+     * @var PriceFactory
      */
     protected $_priceFactory;
 
     /**
-     * @var \Magento\Framework\Pricing\PriceInfo\Factory
+     * @var PriceInfoFactory
      */
     protected $_priceInfoFactory;
 
     /**
      * Construct
      *
-     * @param \Magento\Catalog\Model\ProductTypes\ConfigInterface $config
-     * @param \Magento\Catalog\Model\Product\Type\Pool $productTypePool
-     * @param \Magento\Catalog\Model\Product\Type\Price\Factory $priceFactory
-     * @param \Magento\Framework\Pricing\PriceInfo\Factory $priceInfoFactory
+     * @param ConfigInterface $config
+     * @param Pool $productTypePool
+     * @param PriceFactory $priceFactory
+     * @param PriceInfoFactory $priceInfoFactory
      */
     public function __construct(
-        \Magento\Catalog\Model\ProductTypes\ConfigInterface $config,
-        \Magento\Catalog\Model\Product\Type\Pool $productTypePool,
-        \Magento\Catalog\Model\Product\Type\Price\Factory $priceFactory,
-        \Magento\Framework\Pricing\PriceInfo\Factory $priceInfoFactory
+        ConfigInterface $config,
+        Pool $productTypePool,
+        PriceFactory $priceFactory,
+        PriceInfoFactory $priceInfoFactory
     ) {
         $this->_config = $config;
         $this->_productTypePool = $productTypePool;
@@ -116,8 +110,8 @@ public function __construct(
     /**
      * Factory to product singleton product type instances
      *
-     * @param   \Magento\Catalog\Model\Product $product
-     * @return  \Magento\Catalog\Model\Product\Type\AbstractType
+     * @param \Magento\Catalog\Api\Data\ProductInterface $product
+     * @return \Magento\Catalog\Model\Product\Type\AbstractType
      */
     public function factory($product)
     {
@@ -139,8 +133,8 @@ public function factory($product)
     /**
      * Product type price model factory
      *
-     * @param   string $productType
-     * @return  \Magento\Catalog\Model\Product\Type\Price
+     * @param string $productType
+     * @return \Magento\Catalog\Model\Product\Type\Price
      */
     public function priceFactory($productType)
     {

app/code/Magento/Catalog/Test/Mftf/Data/ProductData.xml

@@ -212,6 +212,17 @@
         <data key="quantity">1001</data>
         <requiredEntity type="product_extension_attribute">EavStockItem</requiredEntity>
     </entity>
+    <entity name="SimpleProductDisabledStockQuantityZero" type="product">
+        <data key="sku" unique="suffix">testSku</data>
+        <data key="type_id">simple</data>
+        <data key="attribute_set_id">4</data>
+        <data key="name" unique="suffix">Simple Product Disabled Quantity Zero</data>
+        <data key="price">123.00</data>
+        <data key="visibility">4</data>
+        <data key="status">2</data>
+        <data key="quantity">0</data>
+        <requiredEntity type="product_extension_attribute">EavStock0</requiredEntity>
+    </entity>
     <entity name="SimpleProductNotVisibleIndividually" type="product">
         <data key="name" unique="suffix">Simple Product Not Visible Individually</data>
         <data key="sku" unique="suffix">simple_product_not_visible_individually</data>

app/code/Magento/Catalog/Test/Unit/Block/Product/ImageFactoryTest.php

@@ -95,6 +95,7 @@ public function createDataProvider(): array
         return [
             $this->getTestDataWithoutAttributes(),
             $this->getTestDataWithAttributes(),
+            $this->getTestDataWithoutDimensions()
         ];
     }
 
@@ -209,4 +210,21 @@ private function getTestDataWithAttributes(): array
             ],
         ];
     }
+
+    /**
+     * @return array
+     */
+    private function getTestDataWithoutDimensions(): array
+    {
+        $data = $this->getTestDataWithoutAttributes();
+
+        $data['data']['imageParamsBuilder']['image_width'] = null;
+        $data['data']['imageParamsBuilder']['image_height'] = null;
+
+        $data['expected']['data']['width'] = null;
+        $data['expected']['data']['height'] = null;
+        $data['expected']['data']['ratio'] = 1.0;
+
+        return $data;
+    }
 }