-
Notifications
You must be signed in to change notification settings - Fork 9.4k
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
Grouped product frontend quantity validation added and code refactor #39480
Open
Mohamed-Asar
wants to merge
20
commits into
magento:2.4-develop
Choose a base branch
from
Mohamed-Asar:bug/39479-grouped-product-qty-validation
base: 2.4-develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+303
−149
Open
Changes from all commits
Commits
Show all changes
20 commits
Select commit
Hold shift + click to select a range
f990b58
Grouped product frontend quantity validation added and code refactor
Mohamed-Asar 5f2b740
Merge branch '2.4-develop' into bug/39479-grouped-product-qty-validation
Mohamed-Asar 52bd8e8
Merge branch '2.4-develop' of https://github.com/Mohamed-Asar/magento…
Mohamed-Asar 94fadc8
Ignore item qty validation if zero qty entered in grouped product
Mohamed-Asar 9ac7ef5
Merge branch 'bug/39479-grouped-product-qty-validation' of https://gi…
Mohamed-Asar eea8ae5
Merge branch '2.4-develop' of https://github.com/Mohamed-Asar/magento…
Mohamed-Asar a192377
Unit test & static test cases issues fixed
Mohamed-Asar ceb8597
Static test fixed
Mohamed-Asar 3e0c5a7
Indent issue fixed
Mohamed-Asar 4213997
Merge branch '2.4-develop' into bug/39479-grouped-product-qty-validation
engcom-Hotel 1ca6c6d
Code review changes
Mohamed-Asar 96bfa59
Merge branch '2.4-develop' of https://github.com/Mohamed-Asar/magento…
Mohamed-Asar cc2409a
Merge branch '2.4-develop' of https://github.com/Mohamed-Asar/magento…
Mohamed-Asar baeb177
Removed deprecated methods, get data using MSI and unit test added
Mohamed-Asar 9a46f52
Static test case fix
Mohamed-Asar 2e64918
Merge branch '2.4-develop' into bug/39479-grouped-product-qty-validation
engcom-Hotel b0ad802
Merge branch '2.4-develop' into bug/39479-grouped-product-qty-validation
engcom-Hotel 7545bdb
Merge branch '2.4-develop' into bug/39479-grouped-product-qty-validation
engcom-Hotel 841ffaa
Merge branch '2.4-develop' of https://github.com/Mohamed-Asar/magento…
Mohamed-Asar 559d0f8
Test case failures fix
Mohamed-Asar File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
41 changes: 17 additions & 24 deletions
41
app/code/Magento/CatalogInventory/Block/Plugin/ProductView.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,53 +1,46 @@ | ||
<?php | ||
/** | ||
* Copyright © Magento, Inc. All rights reserved. | ||
* See COPYING.txt for license details. | ||
* Copyright 2015 Adobe | ||
* All Rights Reserved. | ||
*/ | ||
namespace Magento\CatalogInventory\Block\Plugin; | ||
|
||
use Magento\CatalogInventory\Api\StockRegistryInterface; | ||
use Magento\Catalog\Block\Product\View; | ||
use Magento\CatalogInventory\Model\Product\QuantityValidator; | ||
|
||
class ProductView | ||
{ | ||
/** | ||
* @var StockRegistryInterface | ||
* @var QuantityValidator | ||
*/ | ||
private $stockRegistry; | ||
private $productQuantityValidator; | ||
|
||
/** | ||
* @param StockRegistryInterface $stockRegistry | ||
* @param QuantityValidator $productQuantityValidator | ||
*/ | ||
public function __construct( | ||
StockRegistryInterface $stockRegistry | ||
QuantityValidator $productQuantityValidator | ||
) { | ||
$this->stockRegistry = $stockRegistry; | ||
$this->productQuantityValidator = $productQuantityValidator; | ||
} | ||
|
||
/** | ||
* Adds quantities validator. | ||
* | ||
* @param \Magento\Catalog\Block\Product\View $block | ||
* @param View $block | ||
* @param array $validators | ||
* @return array | ||
*/ | ||
public function afterGetQuantityValidators( | ||
\Magento\Catalog\Block\Product\View $block, | ||
View $block, | ||
array $validators | ||
) { | ||
$stockItem = $this->stockRegistry->getStockItem( | ||
$block->getProduct()->getId(), | ||
$block->getProduct()->getStore()->getWebsiteId() | ||
return array_merge( | ||
$validators, | ||
$this->productQuantityValidator->getData( | ||
$block->getProduct()->getSku(), | ||
$block->getProduct()->getStore()->getWebsiteId() | ||
) | ||
); | ||
|
||
$params = []; | ||
if ($stockItem->getMaxSaleQty()) { | ||
$params['maxAllowed'] = (float)$stockItem->getMaxSaleQty(); | ||
} | ||
if ($stockItem->getQtyIncrements() > 0) { | ||
$params['qtyIncrements'] = (float)$stockItem->getQtyIncrements(); | ||
} | ||
$validators['validate-item-quantity'] = $params; | ||
|
||
return $validators; | ||
} | ||
} |
85 changes: 85 additions & 0 deletions
85
app/code/Magento/CatalogInventory/Model/Product/QuantityValidator.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,85 @@ | ||
<?php | ||
/** | ||
* Copyright 2024 Adobe | ||
* All Rights Reserved. | ||
*/ | ||
declare(strict_types=1); | ||
|
||
namespace Magento\CatalogInventory\Model\Product; | ||
|
||
use Magento\Framework\Exception\LocalizedException; | ||
use Magento\InventoryConfigurationApi\Api\GetStockItemConfigurationInterface; | ||
use Magento\InventorySalesApi\Api\StockResolverInterface; | ||
use Magento\InventorySalesApi\Api\Data\SalesChannelInterface; | ||
use Magento\Store\Model\StoreManagerInterface; | ||
|
||
class QuantityValidator | ||
{ | ||
/** | ||
* @param GetStockItemConfigurationInterface $getStockItemConfiguration | ||
* @param StoreManagerInterface $storeManager | ||
* @param StockResolverInterface $stockResolver | ||
*/ | ||
public function __construct( | ||
private readonly GetStockItemConfigurationInterface $getStockItemConfiguration, | ||
private readonly StoreManagerInterface $storeManager, | ||
private readonly StockResolverInterface $stockResolver | ||
) { | ||
} | ||
|
||
/** | ||
* To get quantity validators | ||
* | ||
* @param string $sku | ||
* @param int|null $websiteId | ||
* | ||
* @return array | ||
*/ | ||
public function getData(string $sku, int|null $websiteId): array | ||
{ | ||
try { | ||
$stockItemConfig = $this->getStockItemConfiguration->execute( | ||
$sku, | ||
$this->getStockId($websiteId) | ||
); | ||
|
||
$params = []; | ||
$validators = []; | ||
$params['minAllowed'] = $stockItemConfig->getMinSaleQty(); | ||
|
||
if ($stockItemConfig->getMaxSaleQty()) { | ||
$params['maxAllowed'] = $stockItemConfig->getMaxSaleQty(); | ||
} | ||
if ($stockItemConfig->getQtyIncrements() > 0) { | ||
$params['qtyIncrements'] = $stockItemConfig->getQtyIncrements(); | ||
} | ||
$validators['validate-item-quantity'] = $params; | ||
|
||
return $validators; | ||
} catch (\Exception $e) { | ||
return []; | ||
} | ||
} | ||
|
||
/** | ||
* Get Stock ID by Website ID | ||
* | ||
* @param int|null $websiteId | ||
* @return int | ||
* @throws LocalizedException | ||
*/ | ||
private function getStockId(?int $websiteId): int | ||
{ | ||
if ($websiteId === null) { | ||
$websiteId = $this->storeManager->getWebsite()->getId(); | ||
} | ||
|
||
$websiteCode = $this->storeManager->getWebsite($websiteId)->getCode(); | ||
$stock = $this->stockResolver->execute( | ||
SalesChannelInterface::TYPE_WEBSITE, | ||
$websiteCode | ||
); | ||
|
||
return (int) $stock->getStockId(); | ||
} | ||
} |
94 changes: 0 additions & 94 deletions
94
app/code/Magento/CatalogInventory/Test/Unit/Block/Plugin/ProductViewTest.php
This file was deleted.
Oops, something went wrong.
104 changes: 104 additions & 0 deletions
104
app/code/Magento/CatalogInventory/Test/Unit/Model/Product/QuantityValidatorTest.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,104 @@ | ||
<?php | ||
/** | ||
* Copyright 2025 Adobe | ||
* All Rights Reserved. | ||
*/ | ||
declare(strict_types=1); | ||
|
||
namespace Magento\CatalogInventory\Test\Unit\Model\Product; | ||
|
||
use Magento\CatalogInventory\Model\Product\QuantityValidator; | ||
use Magento\InventoryConfigurationApi\Api\GetStockItemConfigurationInterface; | ||
use Magento\InventoryConfigurationApi\Api\Data\StockItemConfigurationInterface; | ||
use Magento\InventorySalesApi\Api\Data\SalesChannelInterface; | ||
use Magento\InventoryApi\Api\Data\StockInterface; | ||
use Magento\InventorySalesApi\Api\StockResolverInterface; | ||
use Magento\Store\Api\Data\WebsiteInterface; | ||
use Magento\Store\Model\StoreManagerInterface; | ||
use PHPUnit\Framework\MockObject\MockObject; | ||
use PHPUnit\Framework\TestCase; | ||
|
||
/** | ||
* @covers \Magento\CatalogInventory\Model\Product\QuantityValidator | ||
*/ | ||
class QuantityValidatorTest extends TestCase | ||
{ | ||
private const WEBSITE_ID = 1; | ||
private const WEBSITE_CODE = 'base'; | ||
private const STOCK_ID = 1; | ||
private const TEST_SKU = 'TEST-SKU'; | ||
|
||
/** | ||
* @var QuantityValidator | ||
*/ | ||
private $quantityValidator; | ||
|
||
/** | ||
* @var GetStockItemConfigurationInterface|MockObject | ||
*/ | ||
private $getStockItemConfiguration; | ||
|
||
/** | ||
* @var StoreManagerInterface|MockObject | ||
*/ | ||
private $storeManager; | ||
|
||
/** | ||
* @var StockResolverInterface|MockObject | ||
*/ | ||
private $stockResolver; | ||
|
||
protected function setUp(): void | ||
{ | ||
$this->getStockItemConfiguration = $this->createMock(GetStockItemConfigurationInterface::class); | ||
$this->storeManager = $this->createMock(StoreManagerInterface::class); | ||
$this->stockResolver = $this->createMock(StockResolverInterface::class); | ||
|
||
$this->quantityValidator = new QuantityValidator( | ||
$this->getStockItemConfiguration, | ||
$this->storeManager, | ||
$this->stockResolver | ||
); | ||
} | ||
|
||
public function testGetDataWithValidators(): void | ||
{ | ||
$website = $this->createMock(WebsiteInterface::class); | ||
$website->method('getCode')->willReturn(self::WEBSITE_CODE); | ||
|
||
$stock = $this->createMock(StockInterface::class); | ||
$stock->method('getStockId')->willReturn(self::STOCK_ID); | ||
|
||
$stockItemConfiguration = $this->createMock(StockItemConfigurationInterface::class); | ||
$stockItemConfiguration->method('getMinSaleQty')->willReturn(2.0); | ||
$stockItemConfiguration->method('getMaxSaleQty')->willReturn(10.0); | ||
$stockItemConfiguration->method('getQtyIncrements')->willReturn(2.0); | ||
|
||
// Set expectations | ||
$this->storeManager->expects($this->once()) | ||
->method('getWebsite') | ||
->with(self::WEBSITE_ID) | ||
->willReturn($website); | ||
|
||
$this->stockResolver->expects($this->once()) | ||
->method('execute') | ||
->with(SalesChannelInterface::TYPE_WEBSITE, self::WEBSITE_CODE) | ||
->willReturn($stock); | ||
|
||
$this->getStockItemConfiguration->expects($this->once()) | ||
->method('execute') | ||
->with(self::TEST_SKU, self::STOCK_ID) | ||
->willReturn($stockItemConfiguration); | ||
|
||
$expected = [ | ||
'validate-item-quantity' => [ | ||
'minAllowed' => 2, | ||
'maxAllowed' => 10, | ||
'qtyIncrements' => 2.0 | ||
] | ||
]; | ||
|
||
$result = $this->quantityValidator->getData(self::TEST_SKU, self::WEBSITE_ID); | ||
$this->assertEquals($expected, $result); | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,14 +1,16 @@ | ||
<?xml version="1.0"?> | ||
<!-- | ||
/** | ||
* Copyright © Magento, Inc. All rights reserved. | ||
* See COPYING.txt for license details. | ||
* Copyright 2011 Adobe | ||
* All Rights Reserved. | ||
*/ | ||
--> | ||
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd"> | ||
<module name="Magento_CatalogInventory" > | ||
<sequence> | ||
<module name="Magento_Catalog"/> | ||
<module name="Magento_InventoryConfigurationApi"/> | ||
<module name="Magento_InventorySalesApi"/> | ||
</sequence> | ||
</module> | ||
</config> |
46 changes: 46 additions & 0 deletions
46
app/code/Magento/GroupedProduct/ViewModel/ValidateQuantity.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
<?php | ||
/** | ||
* Copyright 2024 Adobe | ||
* All Rights Reserved. | ||
*/ | ||
declare(strict_types=1); | ||
|
||
namespace Magento\GroupedProduct\ViewModel; | ||
|
||
use Magento\CatalogInventory\Model\Product\QuantityValidator; | ||
use Magento\Framework\Serialize\Serializer\Json; | ||
use Magento\Framework\View\Element\Block\ArgumentInterface; | ||
|
||
/** | ||
* ViewModel for Grouped Products Block | ||
*/ | ||
class ValidateQuantity implements ArgumentInterface | ||
{ | ||
/** | ||
* @param Json $serializer | ||
* @param QuantityValidator $productQuantityValidator | ||
*/ | ||
public function __construct( | ||
private readonly Json $serializer, | ||
private readonly QuantityValidator $productQuantityValidator, | ||
) { | ||
} | ||
|
||
/** | ||
* To get the quantity validators | ||
* | ||
* @param string $sku | ||
* @param int|null $websiteId | ||
* | ||
* @return string | ||
*/ | ||
public function getQuantityValidators(string $sku, int|null $websiteId): string | ||
{ | ||
return $this->serializer->serialize( | ||
array_merge( | ||
['validate-grouped-qty' => '#super-product-table'], | ||
$this->productQuantityValidator->getData($sku, $websiteId) | ||
) | ||
); | ||
} | ||
} |
14 changes: 9 additions & 5 deletions
14
app/code/Magento/GroupedProduct/view/frontend/layout/catalog_product_view_type_grouped.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
10 changes: 7 additions & 3 deletions
10
app/code/Magento/Wishlist/view/frontend/layout/wishlist_index_configure_type_grouped.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Use ObjectManager to initialize as this change is BiC.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done