Merge branch '2.4-develop' into mhidalgo/fix-handlers-not-being-merged-correctly

Author: Gabriel da Gama

app/code/Magento/Bundle/Model/Plugin/Frontend/Product.php renamed to app/code/Magento/Bundle/Model/Plugin/Frontend/ProductIdentitiesExtender.php

@@ -7,23 +7,28 @@
 
 namespace Magento\Bundle\Model\Plugin\Frontend;
 
-use Magento\Bundle\Model\Product\Type;
+use Magento\Bundle\Model\Product\Type as BundleType;
 use Magento\Catalog\Model\Product as CatalogProduct;
 
 /**
  * Add child identities to product identities on storefront.
  */
-class Product
+class ProductIdentitiesExtender
 {
     /**
-     * @var Type
+     * @var BundleType
      */
     private $type;
 
     /**
-     * @param Type $type
+     * @var array
      */
-    public function __construct(Type $type)
+    private $cacheChildrenIds = [];
+
+    /**
+     * @param BundleType $type
+     */
+    public function __construct(BundleType $type)
     {
         $this->type = $type;
     }
@@ -37,12 +42,30 @@ public function __construct(Type $type)
      */
     public function afterGetIdentities(CatalogProduct $product, array $identities): array
     {
-        foreach ($this->type->getChildrenIds($product->getEntityId()) as $childIds) {
+        if ($product->getTypeId() !== BundleType::TYPE_CODE) {
+            return $identities;
+        }
+        foreach ($this->getChildrenIds($product->getEntityId()) as $childIds) {
             foreach ($childIds as $childId) {
                 $identities[] = CatalogProduct::CACHE_TAG . '_' . $childId;
             }
         }
 
         return array_unique($identities);
     }
+
+    /**
+     * Get children ids with cache use
+     *
+     * @param mixed $entityId
+     * @return array
+     */
+    private function getChildrenIds($entityId): array
+    {
+        if (!isset($this->cacheChildrenIds[$entityId])) {
+            $this->cacheChildrenIds[$entityId] = $this->type->getChildrenIds($entityId);
+        }
+
+        return $this->cacheChildrenIds[$entityId];
+    }
 }

app/code/Magento/Bundle/Model/Plugin/Product.php

@@ -0,0 +1,71 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\Bundle\Model\Plugin;
+
+use Magento\Bundle\Model\Product\Type as BundleType;
+use Magento\Catalog\Model\Product as CatalogProduct;
+
+/**
+ * Add parent identities to product identities.
+ */
+class ProductIdentitiesExtender
+{
+    /**
+     * @var BundleType
+     */
+    private $type;
+
+    /**
+     * @var array
+     */
+    private $cacheParentIdsByChild = [];
+
+    /**
+     * @param BundleType $type
+     */
+    public function __construct(BundleType $type)
+    {
+        $this->type = $type;
+    }
+
+    /**
+     * Add parent identities to product identities
+     *
+     * @param CatalogProduct $product
+     * @param array $identities
+     * @return string[]
+     */
+    public function afterGetIdentities(
+        CatalogProduct $product,
+        array $identities
+    ) {
+        if ($product->getTypeId() !== BundleType::TYPE_CODE) {
+            return $identities;
+        }
+        foreach ($this->getParentIdsByChild($product->getEntityId()) as $parentId) {
+            $identities[] = CatalogProduct::CACHE_TAG . '_' . $parentId;
+        }
+
+        return $identities;
+    }
+
+    /**
+     * Get parent ids by child with cache use
+     *
+     * @param mixed $entityId
+     * @return array
+     */
+    private function getParentIdsByChild($entityId): array
+    {
+        if (!isset($this->cacheParentIdsByChild[$entityId])) {
+            $this->cacheParentIdsByChild[$entityId] = $this->type->getParentIdsByChild($entityId);
+        }
+
+        return $this->cacheParentIdsByChild[$entityId];
+    }
+}

app/code/Magento/Bundle/Model/Plugin/ProductIdentitiesExtender.php

@@ -36,8 +36,10 @@
         <!-- Create a product to appear in the widget, fill in basic info first -->
 
         <actionGroup ref="AdminOpenProductIndexPageActionGroup" stepKey="amOnProductList"/>
-        <click selector="{{AdminProductGridActionSection.addProductToggle}}" stepKey="clickAddProductToggle"/>
-        <click selector="{{AdminProductGridActionSection.addBundleProduct}}" stepKey="clickAddBundleProduct"/>
+        <comment userInput="Adding the comment to replace clickAddProductToggle action for preserving Backward Compatibility" stepKey="clickAddProductToggle"/>
+        <actionGroup ref="AdminClickAddProductToggleAndSelectProductTypeActionGroup" stepKey="clickAddBundleProduct">
+            <argument name="productType" value="bundle"/>
+        </actionGroup>
         <fillField selector="{{AdminProductFormSection.productName}}" userInput="{{_defaultProduct.name}}" stepKey="fillProductName"/>
         <fillField selector="{{AdminProductFormSection.productSku}}" userInput="{{_defaultProduct.sku}}" stepKey="fillProductSku"/>
         <fillField selector="{{AdminProductFormSection.setProductAsNewFrom}}" userInput="01/1/2000" stepKey="fillProductNewFrom"/>

app/code/Magento/Bundle/Test/Mftf/Test/NewProductsListWidgetBundleProductTest.xml

@@ -7,28 +7,34 @@
 
 namespace Magento\Bundle\Test\Unit\Model\Plugin\Frontend;
 
-use Magento\Bundle\Model\Plugin\Frontend\Product as ProductPlugin;
+use Magento\Bundle\Model\Plugin\Frontend\ProductIdentitiesExtender as ProductPlugin;
 use Magento\Bundle\Model\Product\Type;
 use Magento\Catalog\Model\Product;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 
-class ProductTest extends TestCase
+/**
+ * Unit test for \Magento\Bundle\Model\Plugin\Frontend\ProductIdentitiesExtender
+ */
+class ProductIdentitiesExtenderTest extends TestCase
 {
-    /** @var  \Magento\Bundle\Model\Plugin\Product */
+    /** @var ProductPlugin */
     private $plugin;
 
-    /** @var  MockObject|Type */
+    /** @var MockObject|Type */
     private $type;
 
-    /** @var  MockObject|\Magento\Catalog\Model\Product */
+    /** @var MockObject|Product */
     private $product;
 
+    /**
+     * @inheritdoc
+     */
     protected function setUp(): void
     {
         $this->product = $this->getMockBuilder(Product::class)
             ->disableOriginalConstructor()
-            ->setMethods(['getEntityId'])
+            ->setMethods(['getEntityId', 'getTypeId'])
             ->getMock();
 
         $this->type = $this->getMockBuilder(Type::class)
@@ -39,7 +45,7 @@ protected function setUp(): void
         $this->plugin = new ProductPlugin($this->type);
     }
 
-    public function testAfterGetIdentities()
+    public function testAfterGetIdentities(): void
     {
         $baseIdentities = [
             'SomeCacheId',
@@ -62,14 +68,24 @@ public function testAfterGetIdentities()
             Product::CACHE_TAG . '_' . 45,
             Product::CACHE_TAG . '_' . 24612,
         ];
-        $this->product->expects($this->once())
+        $this->product->expects($this->exactly(2))
             ->method('getEntityId')
             ->willReturn($id);
+        $this->product->expects($this->exactly(2))
+            ->method('getTypeId')
+            ->willReturn(Type::TYPE_CODE);
         $this->type->expects($this->once())
             ->method('getChildrenIds')
             ->with($id)
             ->willReturn($childIds);
         $identities = $this->plugin->afterGetIdentities($this->product, $baseIdentities);
         $this->assertEquals($expectedIdentities, $identities);
+
+        $this->type->expects($this->never())
+            ->method('getChildrenIds')
+            ->with($id)
+            ->willReturn($childIds);
+        $identities = $this->plugin->afterGetIdentities($this->product, $baseIdentities);
+        $this->assertEquals($expectedIdentities, $identities);
     }
 }

app/code/Magento/Bundle/Test/Unit/Model/Plugin/Frontend/ProductTest.php renamed to app/code/Magento/Bundle/Test/Unit/Model/Plugin/Frontend/ProductIdentitiesExtenderTest.php

@@ -8,14 +8,18 @@
 namespace Magento\Bundle\Test\Unit\Model\Plugin;
 
 use Magento\Bundle\Model\Product\Type;
+use Magento\Bundle\Model\Plugin\ProductIdentitiesExtender as Plugin;
 use Magento\Catalog\Model\Product;
 use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 
-class ProductTest extends TestCase
+/**
+ * Unit test for \Magento\Bundle\Model\Plugin\ProductIdentitiesExtender
+ */
+class ProductIdentitiesExtenderTest extends TestCase
 {
-    /** @var  \Magento\Bundle\Model\Plugin\Product */
+    /** @var Plugin */
     private $plugin;
 
     /** @var  MockObject|Type */
@@ -24,27 +28,35 @@ class ProductTest extends TestCase
     /** @var  MockObject|Product */
     private $product;
 
+    /**
+     * @inheritdoc
+     */
     protected function setUp(): void
     {
         $objectManager = new ObjectManager($this);
 
         $this->product = $this->getMockBuilder(Product::class)
             ->disableOriginalConstructor()
-            ->setMethods(['getEntityId'])
+            ->setMethods(['getEntityId', 'getTypeId'])
             ->getMock();
         $this->type = $this->getMockBuilder(Type::class)
             ->disableOriginalConstructor()
             ->setMethods(['getParentIdsByChild'])
             ->getMock();
 
         $this->plugin = $objectManager->getObject(
-            \Magento\Bundle\Model\Plugin\Product::class,
+            Plugin::class,
             [
                 'type' => $this->type,
             ]
         );
     }
 
+    /**
+     * Verify after get identities
+     *
+     * @return void
+     */
     public function testAfterGetIdentities()
     {
         $baseIdentities = [
@@ -61,14 +73,24 @@ public function testAfterGetIdentities()
             Product::CACHE_TAG . '_' . 5,
             Product::CACHE_TAG . '_' . 100500,
         ];
-        $this->product->expects($this->once())
+        $this->product->expects($this->exactly(2))
             ->method('getEntityId')
             ->willReturn($id);
+        $this->product->expects($this->exactly(2))
+            ->method('getTypeId')
+            ->willReturn(Type::TYPE_CODE);
         $this->type->expects($this->once())
             ->method('getParentIdsByChild')
             ->with($id)
             ->willReturn($parentIds);
         $identities = $this->plugin->afterGetIdentities($this->product, $baseIdentities);
         $this->assertEquals($expectedIdentities, $identities);
+
+        $this->type->expects($this->never())
+            ->method('getParentIdsByChild')
+            ->with($id)
+            ->willReturn($parentIds);
+        $identities = $this->plugin->afterGetIdentities($this->product, $baseIdentities);
+        $this->assertEquals($expectedIdentities, $identities);
     }
 }

app/code/Magento/Bundle/Test/Unit/Model/Plugin/ProductTest.php renamed to app/code/Magento/Bundle/Test/Unit/Model/Plugin/ProductIdentitiesExtenderTest.php

@@ -86,7 +86,7 @@
         <plugin name="bundle" type="Magento\Bundle\Model\Plugin\PriceBackend" sortOrder="100" />
     </type>
     <type name="Magento\Catalog\Model\Product">
-        <plugin name="bundle" type="Magento\Bundle\Model\Plugin\Product" sortOrder="100" />
+        <plugin name="add_bundle_parent_identities" type="Magento\Bundle\Model\Plugin\ProductIdentitiesExtender" sortOrder="100" />
     </type>
     <type name="Magento\Sales\Model\Order\Item">
         <plugin name="bundle" type="Magento\Bundle\Model\Sales\Order\Plugin\Item" sortOrder="100" />

app/code/Magento/Bundle/etc/di.xml

@@ -14,6 +14,6 @@
         </arguments>
     </type>
     <type name="Magento\Catalog\Model\Product">
-        <plugin name="bundle" type="Magento\Bundle\Model\Plugin\Frontend\Product" sortOrder="100" />
+        <plugin name="add_bundle_child_identities" type="Magento\Bundle\Model\Plugin\Frontend\ProductIdentitiesExtender" sortOrder="100"/>
     </type>
 </config>