Repository navigation
Expand file tree
/
Copy pathParallelFileProcessor.php
More file actions
316 lines (267 loc) · 11.3 KB
/
Copy pathParallelFileProcessor.php
File metadata and controls
316 lines (267 loc) · 11.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
<?php
declare(strict_types=1);
namespace Rector\Parallel\Application;
use Clue\React\NDJson\Decoder;
use Clue\React\NDJson\Encoder;
use Nette\Utils\Random;
use React\EventLoop\StreamSelectLoop;
use React\Socket\ConnectionInterface;
use React\Socket\TcpServer;
use Rector\Configuration\Option;
use Rector\Configuration\Parameter\SimpleParameterProvider;
use Rector\Console\Command\ProcessCommand;
use Rector\Parallel\Command\WorkerCommandLineFactory;
use Rector\Parallel\Enum\Action;
use Rector\Parallel\Enum\Content;
use Rector\Parallel\Enum\ReactCommand;
use Rector\Parallel\Enum\ReactEvent;
use Rector\Parallel\Enum\StreamFormat;
use Rector\Parallel\ValueObject\Bridge;
use Rector\Parallel\ValueObject\ParallelProcess;
use Rector\Parallel\ValueObject\ProcessPool;
use Rector\Parallel\ValueObject\Schedule;
use Rector\ValueObject\Error\SystemError;
use Rector\ValueObject\ProcessResult;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputInterface;
use Throwable;
/**
* Workers keep their caches for the whole run and process their own balanced bucket first.
* Idle workers take pending chunks from the largest remaining queue.
* Each chunk advances progress and re-arms the per-job timeout.
*/
final class ParallelFileProcessor
{
private const int SYSTEM_ERROR_LIMIT = 50;
private ProcessPool $processPool;
public function __construct(
private readonly WorkerCommandLineFactory $workerCommandLineFactory,
) {
}
/**
* @param callable(int $stepCount): void $postFileCallback Used for progress bar jump
*/
public function process(
Schedule $schedule,
string $mainScript,
callable $postFileCallback,
InputInterface $input
): ProcessResult {
// reversed, so that array_pop() hands out the biggest files first
$jobsPerWorker = array_map(
array_reverse(...),
$schedule->getJobsPerWorker()
);
/** @var array<string, int> $bucketKeyByIdentifier */
$bucketKeyByIdentifier = [];
$streamSelectLoop = new StreamSelectLoop();
$parallelResultCollector = new ParallelResultCollector();
$tcpServer = new TcpServer('127.0.0.1:0', $streamSelectLoop);
$this->processPool = new ProcessPool($tcpServer);
$tcpServer->on(ReactEvent::CONNECTION, function (ConnectionInterface $connection) use (
&$jobsPerWorker,
&$bucketKeyByIdentifier
): void {
$inDecoder = new Decoder($connection, true, StreamFormat::DEPTH, 0, StreamFormat::MAX_LENGTH);
$outEncoder = new Encoder($connection);
$inDecoder->on(ReactEvent::DATA, function (array $data) use (
&$jobsPerWorker,
&$bucketKeyByIdentifier,
$inDecoder,
$outEncoder
): void {
$action = $data[ReactCommand::ACTION];
if ($action !== Action::HELLO) {
return;
}
$processIdentifier = $data[Option::PARALLEL_IDENTIFIER];
$parallelProcess = $this->processPool->getProcess($processIdentifier);
$parallelProcess->bindConnection($inDecoder, $outEncoder);
$jobsChunk = $this->popJobChunk($processIdentifier, $jobsPerWorker, $bucketKeyByIdentifier);
if ($jobsChunk === null) {
$this->processPool->quitProcess($processIdentifier);
return;
}
$parallelProcess->request([
ReactCommand::ACTION => Action::MAIN,
Content::FILES => $jobsChunk,
]);
});
});
/** @var string $serverAddress */
$serverAddress = $tcpServer->getAddress();
/** @var int $serverPort */
$serverPort = parse_url($serverAddress, PHP_URL_PORT);
$scheduledFilesCount = 0;
foreach ($jobsPerWorker as $jobs) {
$scheduledFilesCount += array_sum(array_map(count(...), $jobs));
}
$processedFilesCount = 0;
$systemErrorsCount = 0;
$reachedSystemErrorsCountLimit = false;
$handleErrorCallable = function (Throwable $throwable) use (
$parallelResultCollector,
&$systemErrorsCount,
&$reachedSystemErrorsCountLimit
): void {
$parallelResultCollector->collectSystemError(new SystemError(
$throwable->getMessage(),
$throwable->getFile(),
$throwable->getLine(),
));
++$systemErrorsCount;
$reachedSystemErrorsCountLimit = $systemErrorsCount >= self::SYSTEM_ERROR_LIMIT;
$this->processPool->quitAll();
// give the child processes time to actually die, they can still write to cache meanwhile
// @see https://github.com/rectorphp/rector-src/pull/3834/files#r1231696531
sleep(1);
};
$timeoutInSeconds = SimpleParameterProvider::provideIntParameter(Option::PARALLEL_JOB_TIMEOUT_IN_SECONDS);
$processSpawner = function (int $bucketKey) use (
$parallelResultCollector,
&$jobsPerWorker,
&$bucketKeyByIdentifier,
$postFileCallback,
&$systemErrorsCount,
&$reachedSystemErrorsCountLimit,
$mainScript,
$input,
$serverPort,
$streamSelectLoop,
$timeoutInSeconds,
$handleErrorCallable,
&$processedFilesCount
): void {
$processIdentifier = Random::generate();
$bucketKeyByIdentifier[$processIdentifier] = $bucketKey;
$workerCommandLine = $this->workerCommandLineFactory->create(
$mainScript,
ProcessCommand::class,
'worker',
$input,
$processIdentifier,
$serverPort,
);
$parallelProcess = new ParallelProcess($workerCommandLine, $streamSelectLoop, $timeoutInSeconds);
$parallelProcess->start(
// 1. callable on data
function (array $json) use (
$parallelProcess,
$parallelResultCollector,
&$jobsPerWorker,
&$bucketKeyByIdentifier,
$postFileCallback,
&$systemErrorsCount,
&$reachedSystemErrorsCountLimit,
$processIdentifier,
&$processedFilesCount
): void {
/** @var array{
* total_changed: int,
* system_errors: mixed[],
* file_diffs: array<string, mixed>,
* files_count: int,
* system_errors_count: int,
* used_skips: array<string, string[]>
* } $json */
$filesCount = $parallelResultCollector->collectWorkerResult($json);
$postFileCallback($filesCount);
$processedFilesCount += $filesCount;
$systemErrorsCount += $json[Bridge::SYSTEM_ERRORS_COUNT];
if ($systemErrorsCount >= self::SYSTEM_ERROR_LIMIT) {
$reachedSystemErrorsCountLimit = true;
$this->processPool->quitAll();
return;
}
$jobsChunk = $this->popJobChunk($processIdentifier, $jobsPerWorker, $bucketKeyByIdentifier);
if ($jobsChunk === null) {
// bucket done, this worker has nothing left to do
$this->processPool->quitProcess($processIdentifier);
return;
}
$parallelProcess->request([
ReactCommand::ACTION => Action::MAIN,
Content::FILES => $jobsChunk,
]);
},
// 2. callable on error
$handleErrorCallable,
// 3. callable on exit
function ($exitCode, string $stdErr) use ($parallelResultCollector, $processIdentifier): void {
$this->processPool->tryQuitProcess($processIdentifier);
if ($exitCode === Command::SUCCESS) {
return;
}
if ($exitCode === null) {
return;
}
$parallelResultCollector->collectSystemError(new SystemError(
'Child process error: ' . $stdErr
));
}
);
$this->processPool->attachProcess($processIdentifier, $parallelProcess);
};
foreach (array_keys($jobsPerWorker) as $bucketKey) {
($processSpawner)($bucketKey);
}
$streamSelectLoop->run();
if ($reachedSystemErrorsCountLimit) {
$parallelResultCollector->collectSystemError(new SystemError(sprintf(
'Reached system errors count limit of %d, exiting...',
self::SYSTEM_ERROR_LIMIT
)));
}
// Workers may exit without reporting their assigned files.
if ($processedFilesCount < $scheduledFilesCount) {
$parallelResultCollector->collectSystemError(new SystemError(sprintf(
'Some parallel jobs have not finished, results for %d of %d files are missing',
$scheduledFilesCount - $processedFilesCount,
$scheduledFilesCount
)));
}
return $parallelResultCollector->createProcessResult();
}
/**
* @param array<int, array<int, array<string>>> $jobsPerWorker
* @param array<string, int> $bucketKeyByIdentifier
* @return array<string>|null
*/
private function popJobChunk(
string $processIdentifier,
array &$jobsPerWorker,
array $bucketKeyByIdentifier
): ?array {
$bucketKey = $bucketKeyByIdentifier[$processIdentifier] ?? null;
if ($bucketKey !== null && ($jobsPerWorker[$bucketKey] ?? []) !== []) {
return array_pop($jobsPerWorker[$bucketKey]);
}
return $this->stealJobChunk($jobsPerWorker);
}
/**
* Own bucket drained while others still have work. Byte size only estimates the cost of a file, and
* not every core is equally fast - on a big.LITTLE CPU (Apple silicon, recent Intel) a bucket handed
* to an efficiency core takes several times longer. Take over a chunk from whoever has the most left,
* so the run is not held up by one straggler.
*
* @param array<int, array<int, array<string>>> $jobsPerWorker
* @return array<string>|null
*/
private function stealJobChunk(array &$jobsPerWorker): ?array
{
$fattestBucketKey = null;
$fattestJobCount = 0;
foreach ($jobsPerWorker as $currentBucketKey => $jobs) {
$jobCount = count($jobs);
if ($jobCount <= $fattestJobCount) {
continue;
}
$fattestJobCount = $jobCount;
$fattestBucketKey = $currentBucketKey;
}
if ($fattestBucketKey === null) {
return null;
}
return array_pop($jobsPerWorker[$fattestBucketKey]);
}
}