Skip to content

Commit 3f7a728

Browse files
mslabkomslabko
authored
Merge pull request #13 from magento-troll/MDEE-40-tests
Cover stock status data export with tests
2 parents bfff3a4 + 1cbfd19 commit 3f7a728

15 files changed

+1088
-50
lines changed

‎InventoryDataExporter/Model/Provider/StockStatus.php

+1-3
Original file line numberDiff line numberDiff line change
@@ -80,18 +80,16 @@ public function get(array $values): array
8080
$output = [];
8181

8282
try {
83-
$processedSkus = [];
8483
$select = $this->query->getQuery($skus);
8584
// $select can be null if no stocks exists except default
8685
if ($select) {
8786
$cursor = $connection->query($select);
8887
while ($row = $cursor->fetch()) {
89-
$processedSkus[] = $row['sku'];
9088
$output[] = $this->fillWithDefaultValues($row);
9189
}
9290
}
9391

94-
$select = $this->query->getQueryForDefaultStock(\array_diff($skus, $processedSkus));
92+
$select = $this->query->getQueryForDefaultStock($skus);
9593
$cursor = $connection->query($select);
9694
while ($row = $cursor->fetch()) {
9795
$output[] = $this->fillWithDefaultValues($row);

‎InventoryDataExporter/Model/Query/InventoryStockQuery.php

+13
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,17 @@ class InventoryStockQuery
2121
* @var ResourceConnection
2222
*/
2323
private $resourceConnection;
24+
2425
/**
2526
* @var DefaultStockProviderInterface
2627
*/
2728
private $defaultStockProvider;
2829

30+
private const DEFAULT_STOCK_SOURCE = 'default';
31+
2932
/**
3033
* @param ResourceConnection $resourceConnection
34+
* @param DefaultStockProviderInterface $defaultStockProvider
3135
*/
3236
public function __construct(
3337
ResourceConnection $resourceConnection,
@@ -131,6 +135,15 @@ public function getQueryForDefaultStock(array $skus): Select
131135
],
132136
'stock_item.product_id = isi.product_id',
133137
[]
138+
)->joinInner(
139+
[
140+
'source_item' => 'inventory_source_item'
141+
],
142+
$connection->quoteInto(
143+
'source_item.source_code = ? and source_item.sku = isi.sku',
144+
self::DEFAULT_STOCK_SOURCE
145+
),
146+
[]
134147
)->columns(
135148
[
136149
'qty' => "isi.quantity",

‎InventoryDataExporter/Model/Query/StockStatusDeleteQuery.php

+98-8
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@
99

1010
use Magento\DataExporter\Model\Indexer\FeedIndexMetadata;
1111
use Magento\Framework\App\ResourceConnection;
12+
use Magento\Framework\Serialize\SerializerInterface;
13+
use Magento\Framework\Stdlib\DateTime;
1214

1315
/**
1416
* Stock Status mark as deleted query builder
@@ -25,16 +27,32 @@ class StockStatusDeleteQuery
2527
*/
2628
private $metadata;
2729

30+
/**
31+
* @var SerializerInterface
32+
*/
33+
private $serializer;
34+
35+
/**
36+
* @var DateTime
37+
*/
38+
private $dateTime;
39+
2840
/**
2941
* @param ResourceConnection $resourceConnection
3042
* @param FeedIndexMetadata $metadata
43+
* @param SerializerInterface $serializer
44+
* @param DateTime $dateTime
3145
*/
3246
public function __construct(
3347
ResourceConnection $resourceConnection,
34-
FeedIndexMetadata $metadata
48+
FeedIndexMetadata $metadata,
49+
SerializerInterface $serializer,
50+
DateTime $dateTime
3551
) {
3652
$this->resourceConnection = $resourceConnection;
3753
$this->metadata = $metadata;
54+
$this->serializer = $serializer;
55+
$this->dateTime = $dateTime;
3856
}
3957

4058
/**
@@ -49,10 +67,11 @@ public function getStocksAssignedToSkus(array $skus): array
4967
$select = $connection->select()
5068
->from(
5169
['source_item' => $this->resourceConnection->getTableName('inventory_source_item')],
52-
['source_item.sku', 'source_stock_link.stock_id']
70+
['source_item.sku', 'source_stock_link.stock_id', 'source_stock_link.source_code']
5371
)->joinLeft(
5472
['source_stock_link' => $this->resourceConnection->getTableName('inventory_source_stock_link')],
55-
'source_item.source_code = source_stock_link.source_code'
73+
'source_item.source_code = source_stock_link.source_code',
74+
[]
5675
)->where('source_item.sku IN (?)', $skus);
5776

5877
$fetchedSourceItems = [];
@@ -63,21 +82,92 @@ public function getStocksAssignedToSkus(array $skus): array
6382
return $fetchedSourceItems;
6483
}
6584

85+
/**
86+
* Get stocks which are assigned to the list of provided SKUs
87+
*
88+
* @param array $sourceCodes
89+
* @return array
90+
*/
91+
public function getStocksWithSources(array $sourceCodes): array
92+
{
93+
$connection = $this->resourceConnection->getConnection();
94+
$sourceLinkTableName = $this->resourceConnection->getTableName('inventory_source_stock_link');
95+
$select = $connection->select()
96+
->from(
97+
['source_stock_link' => $sourceLinkTableName],
98+
['source_stock_link.stock_id', 'source_stock_link_all_sources.source_code']
99+
)->joinInner(
100+
['source_stock_link_all_sources' => $sourceLinkTableName],
101+
'source_stock_link_all_sources.stock_id = source_stock_link.stock_id',
102+
[]
103+
)->where(
104+
'source_stock_link.source_code IN (?)',
105+
$sourceCodes
106+
)->group(
107+
['source_stock_link.stock_id',
108+
'source_stock_link_all_sources.source_code'
109+
]
110+
);
111+
$stocks = [];
112+
foreach ($connection->fetchAll($select) as $stockData) {
113+
$stocks[$stockData['stock_id']][] = $stockData['source_code'];
114+
}
115+
return $stocks;
116+
}
117+
66118
/**
67119
* Mark stock statuses as deleted
68120
*
69121
* @param array $idsToDelete
70122
*/
71123
public function markStockStatusesAsDeleted(array $idsToDelete): void
72124
{
125+
$records = [];
126+
foreach ($idsToDelete as $deletedItemId => $stockStatusData) {
127+
$records[] = $this->buildFeedData($deletedItemId, $stockStatusData);
128+
}
73129
$connection = $this->resourceConnection->getConnection();
74130
$feedTableName = $this->resourceConnection->getTableName($this->metadata->getFeedTableName());
75-
$connection->update(
131+
$connection->insertOnDuplicate(
76132
$feedTableName,
77-
['is_deleted' => new \Zend_Db_Expr('1')],
78-
[
79-
'id IN (?)' => $idsToDelete
80-
]
133+
$records
81134
);
82135
}
136+
137+
/**
138+
* @param string $stockStatusId
139+
* @param array $stockIdAndSku
140+
* @return array
141+
*/
142+
private function buildFeedData(string $stockStatusId, array $stockIdAndSku): array
143+
{
144+
if (!isset($stockIdAndSku['stock_id'], $stockIdAndSku['sku'])) {
145+
throw new \RuntimeException(
146+
sprintf(
147+
"inventory_data_exporter_stock_status indexer error: cannot build unique id from %s",
148+
\var_export($stockIdAndSku, true)
149+
)
150+
);
151+
}
152+
$feedData = [
153+
'id' => $stockStatusId,
154+
'stockId' => $stockIdAndSku['stock_id'],
155+
'sku' => $stockIdAndSku['sku'],
156+
'qty' => 0,
157+
'qtyForSale' => 0,
158+
'infiniteStock' => false,
159+
'isSalable' => false,
160+
'updatedAt' => $this->dateTime->formatDate(time())
161+
162+
];
163+
164+
return [
165+
'id' => $stockStatusId,
166+
'stock_id' => $stockIdAndSku['stock_id'],
167+
'sku' => $stockIdAndSku['sku'],
168+
'feed_data' => $this->serializer->serialize($feedData),
169+
'is_deleted' => 1,
170+
'modified_at' => $this->dateTime->formatDate(time())
171+
];
172+
}
83173
}

‎InventoryDataExporter/Plugin/BulkSourceUnassign.php

+37-16
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
*/
66
namespace Magento\InventoryDataExporter\Plugin;
77

8+
use Magento\InventoryCatalogApi\Api\BulkSourceUnassignInterface;
89
use Magento\InventoryDataExporter\Model\Provider\StockStatusIdBuilder;
910
use Magento\InventoryDataExporter\Model\Query\StockStatusDeleteQuery;
1011

@@ -30,49 +31,69 @@ public function __construct(
3031
/**
3132
* Check which stocks will be unassigned from products and mark them as deleted in feed table
3233
*
33-
* @param \Magento\InventoryCatalog\Model\ResourceModel\BulkSourceUnassign $subject
34+
* * @param BulkSourceUnassignInterface $subject
35+
* @param int $result
3436
* @param array $skus
3537
* @param array $sourceCodes
36-
* @return void
38+
* @return int
3739
*
3840
* @SuppressWarnings(PHPMD.UnusedFormalParameter)
3941
*/
40-
public function beforeExecute(
41-
\Magento\InventoryCatalog\Model\ResourceModel\BulkSourceUnassign $subject,
42+
public function afterExecute(
43+
BulkSourceUnassignInterface $subject,
44+
int $result,
4245
array $skus,
4346
array $sourceCodes
44-
): void {
45-
$fetchedSourceItems = $this->stockStatusDeleteQuery->getStocksAssignedToSkus($skus);
46-
$stocksToDelete = $this->getStocksToDelete($skus, $sourceCodes, $fetchedSourceItems);
47+
): int {
48+
$sourcesAssignedToProducts = $this->stockStatusDeleteQuery->getStocksAssignedToSkus($skus);
49+
$sourcesByStocks = $this->stockStatusDeleteQuery->getStocksWithSources($sourceCodes);
50+
$stocksToDelete = $this->getStocksToDelete($skus, $sourcesByStocks, $sourcesAssignedToProducts);
4751

4852
if (!empty($stocksToDelete)) {
4953
$this->stockStatusDeleteQuery->markStockStatusesAsDeleted($stocksToDelete);
5054
}
55+
56+
return $result;
5157
}
5258

5359
/**
5460
* @param array $affectedSkus
55-
* @param array $deletedSources
56-
* @param $fetchedSourceItems
61+
* @param array $sourcesByStocks
62+
* @param array $sourcesAssignedToProducts
5763
* @return array
5864
*/
59-
private function getStocksToDelete(array $affectedSkus, array $deletedSources, array $fetchedSourceItems): array
60-
{
65+
private function getStocksToDelete(
66+
array $affectedSkus,
67+
array $sourcesByStocks,
68+
array $sourcesAssignedToProducts
69+
): array {
6170
$stocksToDelete = [];
6271
foreach ($affectedSkus as $deletedItemSku) {
63-
if (!isset($fetchedSourceItems[$deletedItemSku])) {
72+
foreach (array_keys($sourcesByStocks) as $stockId) {
73+
$stockStatusId = StockStatusIdBuilder::build(
74+
['stockId' => (string)$stockId, 'sku' => $deletedItemSku]
75+
);
76+
$stocksToDelete[$stockStatusId] = [
77+
'stock_id' => (string)$stockId,
78+
'sku' => $deletedItemSku
79+
];
80+
}
81+
if (!isset($sourcesAssignedToProducts[$deletedItemSku])) {
6482
continue ;
6583
}
66-
foreach ($fetchedSourceItems[$deletedItemSku] as $fetchedItemStockId => $fetchedItemSources) {
67-
if ($this->getContainsAllKeys($fetchedItemSources, $deletedSources)) {
68-
$stocksToDelete[] = StockStatusIdBuilder::build(
84+
85+
foreach ($sourcesAssignedToProducts[$deletedItemSku] as $fetchedItemStockId => $fetchedItemSources) {
86+
if (isset($sourcesByStocks[$fetchedItemStockId])
87+
&& $this->getContainsAllKeys($fetchedItemSources, $sourcesByStocks[$fetchedItemStockId])) {
88+
$stockStatusId = StockStatusIdBuilder::build(
6989
['stockId' => (string)$fetchedItemStockId, 'sku' => $deletedItemSku]
7090
);
91+
unset($stocksToDelete[$stockStatusId]);
7192
}
7293
}
7394
}
7495

75-
return $stocksToDelete;
96+
return array_filter($stocksToDelete);
7697
}
7798

7899
/**

‎InventoryDataExporter/Plugin/MarkItemsAsDeleted.php

+5-1
Original file line numberDiff line numberDiff line change
@@ -66,9 +66,13 @@ private function getStocksToDelete(array $deletedSourceItems, $fetchedSourceItem
6666
foreach ($deletedSourceItems as $deletedItemSku => $deletedItemSources) {
6767
foreach ($fetchedSourceItems[$deletedItemSku] as $fetchedItemStockId => $fetchedItemSources) {
6868
if ($this->getContainsAllKeys($fetchedItemSources, $deletedItemSources)) {
69-
$stocksToDelete[] = StockStatusIdBuilder::build(
69+
$stockStatusId = StockStatusIdBuilder::build(
7070
['stockId' => (string)$fetchedItemStockId, 'sku' => $deletedItemSku]
7171
);
72+
$stocksToDelete[$stockStatusId] = [
73+
'stock_id' => (string)$fetchedItemStockId,
74+
'sku' => $deletedItemSku
75+
];
7276
}
7377
}
7478
}

‎InventoryDataExporter/Plugin/SourceItem/SourceItemUpdate.php

+1-2
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,7 @@ public function afterExecute(
4343
SourceItemsSaveInterface $subject,
4444
$result,
4545
array $sourceItems
46-
): void
47-
{
46+
): void {
4847
$stockStatusIndexer = $this->indexer->load(self::STOCK_STATUS_FEED_INDEXER);
4948
if (!$stockStatusIndexer->isScheduled()) {
5049
$skus = \array_map(

‎InventoryDataExporter/README.md

+8-7
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
1-
## Release notes
1+
*Magento_InventoryDataExporter* module is responsible for collecting inventory data
22

3-
*Magento_InventoryDataExporter* module
3+
## Stock Status
44

5-
https://docs.magento.com/user-guide/catalog/inventory-backorders.html?itm_source=devdocs&itm_medium=quick_search&itm_campaign=federated_search&itm_term=backorer
6-
7-
8-
Zero
9-
With Backorders enabled, entering 0 allows for infinite backorders.
5+
- Collects aggregated value of Stock Status described in [et_schema.xml](etc/et_schema.xml)
6+
- Depends on Inventory indexer which is used to get `isSalable` status and `qty` in stock.
7+
- `qtyForSale` calculated based on Reservations API
8+
- Stock is considered as infinite in the following cases:
9+
- Manage Stock disabled
10+
- [Backorders](https://docs.magento.com/user-guide/catalog/inventory-backorders.html?itm_source=devdocs&itm_medium=quick_search&itm_campaign=federated_search&itm_term=backorer) enabled and Out-of-Stock threshold is set to 0.

0 commit comments

Comments
 (0)