Skip to content

Add child identities to products instead of parent identities #19313

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 48 additions & 0 deletions app/code/Magento/Bundle/Model/Plugin/Frontend/Product.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);

namespace Magento\Bundle\Model\Plugin\Frontend;

use Magento\Bundle\Model\Product\Type;
use Magento\Catalog\Model\Product as CatalogProduct;

/**
* Add child identities to product identities on storefront.
*/
class Product
{
/**
* @var Type
*/
private $type;

/**
* @param Type $type
*/
public function __construct(Type $type)
{
$this->type = $type;
}

/**
* Add child identities to product identities
*
* @param CatalogProduct $product
* @param array $identities
* @return array
*/
public function afterGetIdentities(CatalogProduct $product, array $identities): array
{
foreach ($this->type->getChildrenIds($product->getEntityId()) as $childIds) {
foreach ($childIds as $childId) {
$identities[] = CatalogProduct::CACHE_TAG . '_' . $childId;
}
}

return array_unique($identities);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/

namespace Magento\Bundle\Test\Unit\Model\Plugin\Frontend;

use Magento\Bundle\Model\Plugin\Frontend\Product as ProductPlugin;
use Magento\Bundle\Model\Product\Type;
use Magento\Catalog\Model\Product;
use PHPUnit_Framework_MockObject_MockObject as MockObject;

class ProductTest extends \PHPUnit\Framework\TestCase
{
/** @var \Magento\Bundle\Model\Plugin\Product */
private $plugin;

/** @var MockObject|Type */
private $type;

/** @var MockObject|\Magento\Catalog\Model\Product */
private $product;

protected function setUp()
{
$this->product = $this->getMockBuilder(Product::class)
->disableOriginalConstructor()
->setMethods(['getEntityId'])
->getMock();

$this->type = $this->getMockBuilder(Type::class)
->disableOriginalConstructor()
->setMethods(['getChildrenIds'])
->getMock();

$this->plugin = new ProductPlugin($this->type);
}

public function testAfterGetIdentities()
{
$baseIdentities = [
'SomeCacheId',
'AnotherCacheId',
];
$id = 12345;
$childIds = [
1 => [1, 2, 5, 100500],
12 => [7, 22, 45, 24612]
];
$expectedIdentities = [
'SomeCacheId',
'AnotherCacheId',
Product::CACHE_TAG . '_' . 1,
Product::CACHE_TAG . '_' . 2,
Product::CACHE_TAG . '_' . 5,
Product::CACHE_TAG . '_' . 100500,
Product::CACHE_TAG . '_' . 7,
Product::CACHE_TAG . '_' . 22,
Product::CACHE_TAG . '_' . 45,
Product::CACHE_TAG . '_' . 24612,
];
$this->product->expects($this->once())
->method('getEntityId')
->will($this->returnValue($id));
$this->type->expects($this->once())
->method('getChildrenIds')
->with($id)
->will($this->returnValue($childIds));
$identities = $this->plugin->afterGetIdentities($this->product, $baseIdentities);
$this->assertEquals($expectedIdentities, $identities);
}
}
3 changes: 3 additions & 0 deletions app/code/Magento/Bundle/etc/frontend/di.xml
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,7 @@
</argument>
</arguments>
</type>
<type name="Magento\Catalog\Model\Product">
<plugin name="bundle" type="Magento\Bundle\Model\Plugin\Frontend\Product" sortOrder="100" />
</type>
</config>
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);

namespace Magento\ConfigurableProduct\Model\Plugin\Frontend;

use Magento\ConfigurableProduct\Model\Product\Type\Configurable;
use Magento\Catalog\Model\Product;

/**
* Extender of product identities for child of configurable products
*/
class ProductIdentitiesExtender
{
/**
* @var Configurable
*/
private $configurableType;

/**
* @param Configurable $configurableType
*/
public function __construct(Configurable $configurableType)
{
$this->configurableType = $configurableType;
}

/**
* Add child identities to product identities
*
* @param Product $subject
* @param array $identities
* @return array
*/
public function afterGetIdentities(Product $subject, array $identities): array
{
foreach ($this->configurableType->getChildrenIds($subject->getId()) as $childIds) {
foreach ($childIds as $childId) {
$identities[] = Product::CACHE_TAG . '_' . $childId;
}
}

return array_unique($identities);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);

namespace Magento\ConfigurableProduct\Test\Unit\Model\Plugin\Frontend;

use Magento\ConfigurableProduct\Model\Plugin\Frontend\ProductIdentitiesExtender;
use Magento\ConfigurableProduct\Model\Product\Type\Configurable;
use Magento\Catalog\Model\Product;

/**
* Class ProductIdentitiesExtenderTest
*/
class ProductIdentitiesExtenderTest extends \PHPUnit\Framework\TestCase
{
/**
* @var \PHPUnit_Framework_MockObject_MockObject|Configurable
*/
private $configurableTypeMock;

/**
* @var ProductIdentitiesExtender
*/
private $plugin;

/** @var MockObject|\Magento\Catalog\Model\Product */
private $product;

protected function setUp()
{
$this->product = $this->getMockBuilder(Product::class)
->disableOriginalConstructor()
->setMethods(['getId'])
->getMock();

$this->configurableTypeMock = $this->getMockBuilder(Configurable::class)
->disableOriginalConstructor()
->getMock();

$this->plugin = new ProductIdentitiesExtender($this->configurableTypeMock);
}

public function testAfterGetIdentities()
{
$identities = [
'SomeCacheId',
'AnotherCacheId',
];
$productId = 12345;
$childIdentities = [
0 => [1, 2, 5, 100500]
];
$expectedIdentities = [
'SomeCacheId',
'AnotherCacheId',
Product::CACHE_TAG . '_' . 1,
Product::CACHE_TAG . '_' . 2,
Product::CACHE_TAG . '_' . 5,
Product::CACHE_TAG . '_' . 100500,
];

$this->product->expects($this->once())
->method('getId')
->willReturn($productId);

$this->configurableTypeMock->expects($this->once())
->method('getChildrenIds')
->with($productId)
->willReturn($childIdentities);

$productIdentities = $this->plugin->afterGetIdentities($this->product, $identities);
$this->assertEquals($expectedIdentities, $productIdentities);
}
}
3 changes: 3 additions & 0 deletions app/code/Magento/ConfigurableProduct/etc/frontend/di.xml
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,7 @@
<type name="Magento\ConfigurableProduct\Model\ResourceModel\Attribute\OptionSelectBuilderInterface">
<plugin name="Magento_ConfigurableProduct_Plugin_Model_ResourceModel_Attribute_InStockOptionSelectBuilder" type="Magento\ConfigurableProduct\Plugin\Model\ResourceModel\Attribute\InStockOptionSelectBuilder"/>
</type>
<type name="Magento\Catalog\Model\Product">
<plugin name="product_identities_extender" type="Magento\ConfigurableProduct\Model\Plugin\Frontend\ProductIdentitiesExtender" />
</type>
</config>
Original file line number Diff line number Diff line change
@@ -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\Frontend;

use Magento\Catalog\Api\ProductRepositoryInterface;
use Magento\TestFramework\Helper\Bootstrap;
use Magento\TestFramework\Interception\PluginList;
use PHPUnit\Framework\TestCase;

/**
* Test bundle fronted product plugin adds children products ids to bundle product identities.
*/
class ProductTest extends TestCase
{
/**
* Check, product plugin is registered for storefront.
*
* @magentoAppArea frontend
* @return void
*/
public function testProductIsRegistered(): void
{
$pluginInfo = Bootstrap::getObjectManager()->get(PluginList::class)
->get(\Magento\Catalog\Model\Product::class, []);
$this->assertSame(Product::class, $pluginInfo['bundle']['instance']);
}

/**
* Check plugin will add children ids to bundle product identities on storefront.
*
* @magentoDataFixture Magento/Bundle/_files/product.php
* @magentoAppArea frontend
* @return void
*/
public function testGetIdentitiesForBundleProductOnStorefront(): void
{
$productRepository = Bootstrap::getObjectManager()->get(ProductRepositoryInterface::class);
$bundleProduct = $productRepository->get('bundle-product');
$simpleProduct = $productRepository->get('simple');
$expectedIdentities = [
'cat_p_' . $bundleProduct->getId(),
'cat_p',
'cat_p_' . $simpleProduct->getId(),

];
$this->assertEquals($expectedIdentities, $bundleProduct->getIdentities());
}

/**
* Check plugin won't add children ids to bundle product identities in admin area.
*
* @magentoDataFixture Magento/Bundle/_files/product.php
* @magentoAppArea adminhtml
* @return void
*/
public function testGetIdentitiesForBundleProductInAdminArea(): void
{
$productRepository = Bootstrap::getObjectManager()->get(ProductRepositoryInterface::class);
$bundleProduct = $productRepository->get('bundle-product');
$expectedIdentities = [
'cat_p_' . $bundleProduct->getId(),
];
$this->assertEquals($expectedIdentities, $bundleProduct->getIdentities());
}
}
Loading