Skip to content

Commit f5a4b0f

Browse files
slavvkaslavvka
authored
ENGCOM-7158: Save Asynchronous Operations with one Batch improvement #27257 
2 parents 566a83b + c2603ce commit f5a4b0f

File tree

10 files changed

+222
-8
lines changed

10 files changed

+222
-8
lines changed

‎app/code/Magento/AsynchronousOperations/Api/SaveMultipleOperationsInterface.php

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<?php
2+
/**
3+
* Copyright © Magento, Inc. All rights reserved.
4+
* See COPYING.txt for license details.
5+
*/
6+
7+
declare(strict_types=1);
8+
9+
namespace Magento\AsynchronousOperations\Api;
10+
11+
use Magento\AsynchronousOperations\Api\Data\OperationInterface;
12+
13+
/**
14+
* Interface for saving multiple operations
15+
*
16+
* @api
17+
*/
18+
interface SaveMultipleOperationsInterface
19+
{
20+
/**
21+
* Save Operations for Bulk
22+
*
23+
* @param OperationInterface[] $operations
24+
* @return void
25+
*/
26+
public function execute(array $operations): void;
27+
}

‎app/code/Magento/AsynchronousOperations/Model/BulkManagement.php

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,6 @@ public function scheduleBulk($bulkUuid, array $operations, $description, $userId
117117
$bulkSummary->setUserId($userId);
118118
$bulkSummary->setUserType($userType);
119119
$bulkSummary->setOperationCount((int)$bulkSummary->getOperationCount() + count($operations));
120-
121120
$this->entityManager->save($bulkSummary);
122121

123122
$connection->commit();

‎app/code/Magento/AsynchronousOperations/Model/MassSchedule.php

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
use Magento\Framework\Bulk\BulkManagementInterface;
1717
use Magento\Framework\DataObject\IdentityGeneratorInterface;
1818
use Magento\Framework\Encryption\Encryptor;
19+
use Magento\AsynchronousOperations\Api\SaveMultipleOperationsInterface;
1920
use Magento\Framework\Exception\BulkException;
2021
use Magento\Framework\Exception\LocalizedException;
2122
use Psr\Log\LoggerInterface;
@@ -67,6 +68,11 @@ class MassSchedule
6768
*/
6869
private $encryptor;
6970

71+
/**
72+
* @var SaveMultipleOperationsInterface
73+
*/
74+
private $saveMultipleOperations;
75+
7076
/**
7177
* Initialize dependencies.
7278
*
@@ -78,6 +84,7 @@ class MassSchedule
7884
* @param OperationRepositoryInterface $operationRepository
7985
* @param UserContextInterface $userContext
8086
* @param Encryptor $encryptor
87+
* @param SaveMultipleOperationsInterface $saveMultipleOperations
8188
*/
8289
public function __construct(
8390
IdentityGeneratorInterface $identityService,
@@ -87,7 +94,8 @@ public function __construct(
8794
LoggerInterface $logger,
8895
OperationRepositoryInterface $operationRepository,
8996
UserContextInterface $userContext,
90-
Encryptor $encryptor
97+
Encryptor $encryptor,
98+
SaveMultipleOperationsInterface $saveMultipleOperations
9199
) {
92100
$this->identityService = $identityService;
93101
$this->itemStatusInterfaceFactory = $itemStatusInterfaceFactory;
@@ -97,6 +105,7 @@ public function __construct(
97105
$this->operationRepository = $operationRepository;
98106
$this->userContext = $userContext;
99107
$this->encryptor = $encryptor;
108+
$this->saveMultipleOperations = $saveMultipleOperations;
100109
}
101110

102111
/**
@@ -159,6 +168,7 @@ public function publishMass($topicName, array $entitiesArray, $groupId = null, $
159168
}
160169
}
161170

171+
$this->saveMultipleOperations->execute($operations);
162172
if (!$this->bulkManagement->scheduleBulk($groupId, $operations, $bulkDescription, $userId)) {
163173
throw new LocalizedException(
164174
__('Something went wrong while processing the request.')

‎app/code/Magento/AsynchronousOperations/Model/OperationManagement.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
use Magento\Framework\EntityManager\EntityManager;
1111

1212
/**
13-
* Class OperationManagement
13+
* Class for managing Bulk Operations
1414
*/
1515
class OperationManagement implements \Magento\Framework\Bulk\OperationManagementInterface
1616
{
@@ -45,7 +45,7 @@ public function __construct(
4545
$this->operationFactory = $operationFactory;
4646
$this->logger = $logger;
4747
}
48-
48+
4949
/**
5050
* @inheritDoc
5151
*/

‎app/code/Magento/AsynchronousOperations/Model/ResourceModel/Operation.php

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,21 @@
77
namespace Magento\AsynchronousOperations\Model\ResourceModel;
88

99
/**
10-
* Class Operation
10+
* Resource class for Bulk Operations
1111
*/
1212
class Operation extends \Magento\Framework\Model\ResourceModel\Db\AbstractDb
1313
{
14+
15+
public const TABLE_NAME = "magento_operation";
16+
public const TABLE_PRIMARY_KEY = "id";
17+
1418
/**
1519
* Initialize banner sales rule resource model
1620
*
1721
* @return void
1822
*/
1923
protected function _construct()
2024
{
21-
$this->_init('magento_operation', 'id');
25+
$this->_init(self::TABLE_NAME, self::TABLE_PRIMARY_KEY);
2226
}
2327
}

‎app/code/Magento/AsynchronousOperations/Model/ResourceModel/Operation/OperationRepository.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ public function createByTopic($topicName, $entityParams, $groupId)
9898

9999
/** @var OperationInterface $operation */
100100
$operation = $this->operationFactory->create($data);
101-
return $this->entityManager->save($operation);
101+
return $operation;
102102
}
103103

104104
/**

‎app/code/Magento/AsynchronousOperations/Model/SaveMultipleOperations.php

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
<?php
2+
/**
3+
* Copyright © Magento, Inc. All rights reserved.
4+
* See COPYING.txt for license details.
5+
*/
6+
7+
declare(strict_types=1);
8+
9+
namespace Magento\AsynchronousOperations\Model;
10+
11+
use Magento\AsynchronousOperations\Api\SaveMultipleOperationsInterface;
12+
use Magento\AsynchronousOperations\Model\ResourceModel\Operation as OperationResource;
13+
use Magento\Framework\Exception\CouldNotSaveException;
14+
15+
/**
16+
* Implementation for saving multiple operations
17+
*/
18+
class SaveMultipleOperations implements SaveMultipleOperationsInterface
19+
{
20+
21+
/**
22+
* @var OperationResource
23+
*/
24+
private $operationResource;
25+
26+
/**
27+
* BulkSummary constructor.
28+
*
29+
* @param OperationResource $operationResource
30+
*/
31+
public function __construct(
32+
OperationResource $operationResource
33+
) {
34+
$this->operationResource = $operationResource;
35+
}
36+
37+
/**
38+
* @inheritDoc
39+
*/
40+
public function execute(array $operations): void
41+
{
42+
try {
43+
$operationsToInsert = array_map(function ($operation) {
44+
return $operation->getData();
45+
}, $operations);
46+
47+
$connection = $this->operationResource->getConnection();
48+
$connection->insertMultiple(
49+
$this->operationResource->getTable(OperationResource::TABLE_NAME),
50+
$operationsToInsert
51+
);
52+
} catch (\Exception $exception) {
53+
throw new CouldNotSaveException(__($exception->getMessage()));
54+
}
55+
}
56+
}

‎app/code/Magento/AsynchronousOperations/etc/di.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
-->
88
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
99
<preference for="Magento\AsynchronousOperations\Api\Data\BulkSummaryInterface" type="Magento\AsynchronousOperations\Model\BulkSummary" />
10+
<preference for="Magento\AsynchronousOperations\Api\SaveMultipleOperationsInterface" type="Magento\AsynchronousOperations\Model\SaveMultipleOperations" />
1011
<preference for="Magento\AsynchronousOperations\Api\Data\OperationInterface" type="Magento\AsynchronousOperations\Model\Operation" />
1112
<preference for="Magento\AsynchronousOperations\Api\Data\OperationListInterface" type="Magento\AsynchronousOperations\Model\OperationList" />
1213
<preference for="Magento\Framework\Bulk\BulkManagementInterface" type="Magento\AsynchronousOperations\Model\BulkManagement" />

‎app/code/Magento/WebapiAsync/Model/OperationRepository.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,6 @@ public function create($topicName, $entityParams, $groupId, $operationId): Opera
9797

9898
/** @var OperationInterface $operation */
9999
$operation = $this->operationFactory->create($data);
100-
return $this->entityManager->save($operation);
100+
return $operation;
101101
}
102102
}

‎dev/tests/integration/testsuite/Magento/AsynchronousOperations/Model/SaveMultipleOperationsTest.php

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
<?php
2+
/**
3+
* Copyright © Magento, Inc. All rights reserved.
4+
* See COPYING.txt for license details.
5+
*/
6+
7+
namespace Magento\AsynchronousOperations\Model;
8+
9+
use Magento\AsynchronousOperations\Api\Data\OperationInterface;
10+
use Magento\AsynchronousOperations\Api\Data\OperationInterfaceFactory;
11+
use Magento\AsynchronousOperations\Api\SaveMultipleOperationsInterface;
12+
use Magento\AsynchronousOperations\Model\BulkStatus;
13+
use Magento\AsynchronousOperations\Api\Data\BulkSummaryInterface;
14+
use Magento\AsynchronousOperations\Api\Data\BulkSummaryInterfaceFactory;
15+
use Magento\Framework\EntityManager\EntityManager;
16+
17+
class SaveMultipleOperationsTest extends \PHPUnit\Framework\TestCase
18+
{
19+
20+
private const BULK_UUID = "bulk-uuid-multiple-0";
21+
22+
/**
23+
* @var BulkStatus
24+
*/
25+
private $bulkStatusManagement;
26+
27+
/**
28+
* @var OperationInterfaceFactory
29+
*/
30+
private $operationFactory;
31+
32+
/**
33+
* @var SaveMultipleOperationsInterface
34+
*/
35+
private $saveMultipleOperationsInterface;
36+
37+
/**
38+
* @var EntityManager
39+
*/
40+
private $entityManager;
41+
42+
/**
43+
* @var BulkSummaryInterfaceFactory
44+
*/
45+
private $bulkSummaryFactory;
46+
47+
/**
48+
* Set Up the test
49+
*/
50+
protected function setUp()
51+
{
52+
$this->saveMultipleOperationsInterface = \Magento\TestFramework\Helper\Bootstrap::getObjectManager()->create(
53+
SaveMultipleOperationsInterface::class
54+
);
55+
$this->operationFactory = \Magento\TestFramework\Helper\Bootstrap::getObjectManager()->create(
56+
OperationInterfaceFactory::class
57+
);
58+
$this->bulkStatusManagement = \Magento\TestFramework\Helper\Bootstrap::getObjectManager()->create(
59+
BulkStatus::class
60+
);
61+
$this->bulkSummaryFactory = \Magento\TestFramework\Helper\Bootstrap::getObjectManager()->create(
62+
BulkSummaryInterfaceFactory::class
63+
);
64+
$this->entityManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager()->create(
65+
EntityManager::class
66+
);
67+
}
68+
69+
/**
70+
* Test execute() of SaveMultipleOperations
71+
*/
72+
public function testExecute()
73+
{
74+
$operation = $this->createOperation();
75+
$operations = [$operation, $operation, $operation];
76+
77+
$bulkSummary = $this->bulkSummaryFactory->create();
78+
$this->entityManager->load($bulkSummary, self::BULK_UUID);
79+
$bulkSummary->setBulkId(self::BULK_UUID);
80+
$bulkSummary->setDescription("Test Bulk");
81+
$bulkSummary->setUserId(1);
82+
$bulkSummary->setUserType(1);
83+
$bulkSummary->setOperationCount(count($operations));
84+
$this->entityManager->save($bulkSummary);
85+
86+
$this->saveMultipleOperationsInterface->execute($operations);
87+
$operationsCount = $this->bulkStatusManagement
88+
->getOperationsCountByBulkIdAndStatus(self::BULK_UUID, OperationInterface::STATUS_TYPE_OPEN);
89+
$this->assertEquals($operationsCount, 3);
90+
}
91+
92+
/**
93+
* Create Operation object and pre-fill with test data
94+
* @return OperationInterface
95+
*/
96+
public function createOperation()
97+
{
98+
$serializedData = [
99+
'entity_id' => null,
100+
'entity_link' => '',
101+
'meta_information' => json_encode([
102+
'entity_id' => 5,
103+
'meta_information' => 'Test'
104+
])
105+
];
106+
107+
$data = [
108+
'data' => [
109+
OperationInterface::BULK_ID => self::BULK_UUID,
110+
OperationInterface::TOPIC_NAME => "topic-4",
111+
OperationInterface::SERIALIZED_DATA => json_encode($serializedData),
112+
OperationInterface::STATUS => OperationInterface::STATUS_TYPE_OPEN,
113+
],
114+
];
115+
return $this->operationFactory->create($data);
116+
}
117+
}

0 commit comments

Comments
 (0)