/
Parallelization.php
436 lines (385 loc) · 15.8 KB
/
Parallelization.php
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
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
<?php
/*
* This file is part of the Webmozarts Console Parallelization package.
*
* (c) Webmozarts GmbH <office@webmozarts.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
declare(strict_types=1);
namespace Webmozarts\Console\Parallelization;
use Symfony\Bundle\FrameworkBundle\Console\Application as FrameworkBundleApplication;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputDefinition;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Terminal;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Webmozarts\Console\Parallelization\ErrorHandler\ErrorHandler;
use Webmozarts\Console\Parallelization\ErrorHandler\LoggingErrorHandler;
use Webmozarts\Console\Parallelization\ErrorHandler\ResetServiceErrorHandler;
use Webmozarts\Console\Parallelization\ErrorHandler\ThrowableCodeErrorHandler;
use Webmozarts\Console\Parallelization\Input\ParallelizationInput;
use Webmozarts\Console\Parallelization\Logger\DebugProgressBarFactory;
use Webmozarts\Console\Parallelization\Logger\Logger;
use Webmozarts\Console\Parallelization\Logger\StandardLogger;
use Webmozarts\Console\Parallelization\Process\PhpExecutableFinder;
use function chr;
use function dirname;
use function getcwd;
use function getenv;
use function realpath;
/**
* Adds parallelization capabilities to console commands.
*
* Make sure to call configureCommand() in your configure() method!
*
* You must implement the following methods in your command:
*
* * fetchItems(): Returns all the items that you want to process as
* strings. Typically, you will return IDs of database objects here.
* * runSingleCommand(): Executes the command for a single item.
* * getItemName(): Returns a human readable name of the processed items.
*
* You can improve the performance of your command by making use of batching.
* Batching allows you to process multiple items together, for example to
* persist them in a batch to reduce the number of I/O operations.
*
* To enable batching, you will typically implement runAfterBatch() and persist
* the changes done in multiple calls of runSingleCommand().
*
* The batch size is determined by getBatchSize() and defaults to the segment
* size. The segment size is the number of items a worker (child) process
* consumes before it dies. This means that, by default, a child process will
* process all its items, persist them in a batch and then die. If you want
* to improve the performance of your command, try to tweak getSegmentSize()
* first. Optionally, you can tweak getBatchSize() to process multiple batches
* in each child process.
*/
trait Parallelization
{
/**
* @deprecated Deprecated since 2.0.0 and will be removed in 3.0.0. Override the method ::createErrorHandler() instead.
*/
private bool $logError = true;
/**
* Provided by Symfony Command class.
*
* @return string The command name
*/
abstract public function getName();
/**
* @deprecated Deprecated since 2.0.0 and will be removed in 3.0.0. Use ParallelizationInput::configureCommand() instead.
*/
protected static function configureParallelization(Command $command): void
{
ParallelizationInput::configureCommand($command);
}
/**
* Fetches the items that should be processed.
*
* Typically, you will fetch all the items of the database objects that
* you want to process here. These will be passed to runSingleCommand().
*
* This method is called exactly once in the main process.
*
* @return iterable<string> The items to process
*/
abstract protected function fetchItems(InputInterface $input, OutputInterface $output): iterable;
/**
* Processes an item in the child process.
*/
abstract protected function runSingleCommand(
string $item,
InputInterface $input,
OutputInterface $output
): void;
/**
* Returns the name of each item in lowercase letters.
*
* For example, this method could return "contact" if the count is one and
* "contacts" otherwise.
*
* @param positive-int|0|null $count The number of items (null if unknown)
*
* @return string The name of the item in the correct plurality
*/
abstract protected function getItemName(?int $count): string;
/**
* Executes the parallelized command.
*/
protected function execute(InputInterface $input, OutputInterface $output): int
{
$parallelizationInput = ParallelizationInput::fromInput($input);
$parallelExecutorFactory = $this->getParallelExecutableFactory(
fn (InputInterface $input) => $this->fetchItems($input, $output),
$this->runSingleCommand(...),
$this->getItemName(...),
$this->getName(),
$this->getDefinition(),
$this->createErrorHandler($input, $output),
);
return $this->configureParallelExecutableFactory(
$parallelExecutorFactory,
$input,
$output,
)
->build()
->execute(
$parallelizationInput,
$input,
$output,
$this->createLogger($input, $output),
);
}
/**
* @param callable(InputInterface):iterable<string> $fetchItems
* @param callable(string, InputInterface, OutputInterface):void $runSingleCommand
* @param callable(positive-int|0|null):string $getItemName
*/
protected function getParallelExecutableFactory(
callable $fetchItems,
callable $runSingleCommand,
callable $getItemName,
string $commandName,
InputDefinition $commandDefinition,
ErrorHandler $errorHandler
): ParallelExecutorFactory {
// If you are looking at this code to wonder if you should call it when
// overriding this method, it is highly recommended you don't and just
// call `ParallelExecutorFactory::create(...func_get_args())`.
//
// The only exception is if you need the whole BC layer with the API
// from 1.x.
$factory = ParallelExecutorFactory::create(
$fetchItems,
$runSingleCommand,
$getItemName,
$commandName,
$commandDefinition,
$errorHandler,
);
$container = $this->getContainer();
$progressSymbol = $this->getProgressSymbol();
$legacyDefaultProgressSymbol = chr(254);
if ($legacyDefaultProgressSymbol !== $progressSymbol) {
Deprecation::trigger(
'The method ::getProgressSymbol() is deprecated and will be removed in 3.0.0. Override the ::%s() method instead to register your progress symbol to the factory.',
__FUNCTION__,
);
$factory = $factory->withProgressSymbol($progressSymbol);
}
$phpExecutable = $this->detectPhpExecutable();
$legacyDefaultPhpExecutable = PhpExecutableFinder::tryToFind();
if ($phpExecutable !== $legacyDefaultPhpExecutable) {
Deprecation::trigger(
'The method ::detectPhpExecutable() is deprecated and will be removed in 3.0.0. Override the ::%s() method instead to register your PHP executable path to the factory.',
__FUNCTION__,
);
$factory = $factory->withPhpExecutable($phpExecutable);
}
$workingDirectory = $this->getWorkingDirectory($container);
$legacyDefaultWorkingDirectory = dirname($container->getParameter('kernel.project_dir'));
if ($workingDirectory !== $legacyDefaultWorkingDirectory) {
Deprecation::trigger(
'The method ::getWorkingDirectory() is deprecated and will be removed in 3.0.0. Override the ::%s() method instead to register your working directory path to the factory.',
__FUNCTION__,
);
$factory = $factory->withWorkingDirectory($workingDirectory);
}
$environmentVariables = $this->getEnvironmentVariables($container);
$legacyDefaultEnvironmentVariables = [
'PATH' => getenv('PATH'),
'HOME' => getenv('HOME'),
'SYMFONY_DEBUG' => $container->getParameter('kernel.debug'),
'SYMFONY_ENV' => $container->getParameter('kernel.environment'),
];
if ($environmentVariables !== $legacyDefaultEnvironmentVariables) {
Deprecation::trigger(
'The method ::getEnvironmentVariables() is deprecated and will be removed in 3.0.0. Override the ::%s() method instead to register your extra environment variables to the factory.',
__FUNCTION__,
);
$factory = $factory->withExtraEnvironmentVariables($environmentVariables);
}
$segmentSize = $this->getSegmentSize();
$legacyDefaultSegmentSize = 50;
if ($segmentSize !== $legacyDefaultSegmentSize) {
Deprecation::trigger(
'The method ::getSegmentSize() is deprecated and will be removed in 3.0.0. Override the ::%s() method instead to register your segment size to the factory.',
__FUNCTION__,
);
$factory = $factory->withSegmentSize($segmentSize);
}
$batchSize = $this->getBatchSize();
$legacyDefaultBatchSize = $segmentSize;
if ($batchSize !== $legacyDefaultBatchSize) {
Deprecation::trigger(
'The method ::getBatchSize() is deprecated and will be removed in 3.0.0. Override the ::%s() method instead to register your batch size to the factory.',
__FUNCTION__,
);
$factory = $factory->withBatchSize($batchSize);
}
$consolePath = $this->getConsolePath();
$legacyDefaultConsolePath = realpath(getcwd().'/bin/console');
if ($consolePath !== $legacyDefaultConsolePath) {
Deprecation::trigger(
'The method ::getConsolePath() is deprecated and will be removed in 3.0.0. Override the ::%s() method instead to register your script path to the factory.',
__FUNCTION__,
);
$factory = $factory->withScriptPath($consolePath);
}
return $factory
->withRunBeforeFirstCommand($this->runBeforeFirstCommand(...))
->withRunAfterLastCommand($this->runAfterLastCommand(...))
->withRunBeforeBatch($this->runBeforeBatch(...))
->withRunAfterBatch($this->runAfterBatch(...));
}
/**
* This is an alternative to overriding ::getParallelExecutableFactory() which
* is a bit less convenient due to the number of parameters.
*/
protected function configureParallelExecutableFactory(
ParallelExecutorFactory $parallelExecutorFactory,
InputInterface $input,
OutputInterface $output
): ParallelExecutorFactory {
// This method will safely never contain anything. It is only a
// placeholder for the user to override so omitting
// parent::configureParallelExecutableFactory() is perfectly safe.
return $parallelExecutorFactory;
}
protected function createErrorHandler(InputInterface $input, OutputInterface $output): ErrorHandler
{
$errorHandler = new ThrowableCodeErrorHandler(
ResetServiceErrorHandler::forContainer($this->getContainer()),
);
if (!$this->logError) {
Deprecation::trigger(
'The %s#logError property is deprecated and will be removed in 3.0.0. Override the ::%s() method instead to produce the desired error handler.',
self::class,
__FUNCTION__,
);
return $errorHandler;
}
return new LoggingErrorHandler($errorHandler);
}
protected function createLogger(InputInterface $input, OutputInterface $output): Logger
{
return new StandardLogger(
$input,
$output,
(new Terminal())->getWidth(),
new DebugProgressBarFactory(),
);
}
protected function getContainer(): ?ContainerInterface
{
// The container is required to reset the container upon failure to
// avoid things such as a broken UoW or entity manager.
//
// If no such behaviour is desired, ::createItemErrorHandler() can be
// overridden to provide a different error handler.
$application = $this->getApplication();
if ($application instanceof FrameworkBundleApplication) {
return $application->getKernel()->getContainer();
}
return null;
}
/**
* @deprecated Deprecated since 2.0.0 and will be removed in 3.0.0. Override
* ::getParallelExecutableFactory() to register the progress symbol to the factory
* instead.
*/
private static function getProgressSymbol(): string
{
return chr(254);
}
/**
* @deprecated Deprecated since 2.0.0 and will be removed in 3.0.0. Override
* ::getParallelExecutableFactory() to register the PHP executable path to the
* factory instead.
*/
private static function detectPhpExecutable(): string
{
return PhpExecutableFinder::find();
}
/**
* @deprecated Deprecated since 2.0.0 and will be removed in 3.0.0. Override
* ::getParallelExecutableFactory() to register the working directory path to the
* factory instead.
*/
private static function getWorkingDirectory(ContainerInterface $container): string
{
return dirname($container->getParameter('kernel.project_dir'));
}
/**
* @deprecated Deprecated since 2.0.0 and will be removed in 3.0.0. Override
* ::getParallelExecutableFactory() to register the working directory path to the
* factory instead.
*/
protected function getEnvironmentVariables(ContainerInterface $container): array
{
return [
'PATH' => getenv('PATH'),
'HOME' => getenv('HOME'),
'SYMFONY_DEBUG' => $container->getParameter('kernel.debug'),
'SYMFONY_ENV' => $container->getParameter('kernel.environment'),
];
}
protected function runBeforeFirstCommand(
InputInterface $input,
OutputInterface $output
): void {
}
protected function runAfterLastCommand(
InputInterface $input,
OutputInterface $output
): void {
}
/**
* @param list<string> $items
*/
protected function runBeforeBatch(
InputInterface $input,
OutputInterface $output,
array $items
): void {
}
/**
* @param list<string> $items
*/
protected function runAfterBatch(
InputInterface $input,
OutputInterface $output,
array $items
): void {
}
/**
* @deprecated Deprecated since 2.0.0 and will be removed in 3.0.0. Override
* ::getParallelExecutableFactory() to register your segment size
* to the factory instead.
*/
protected function getSegmentSize(): int
{
return 50;
}
/**
* @deprecated Deprecated since 2.0.0 and will be removed in 3.0.0. Override
* ::getParallelExecutableFactory() to register your batch size
* to the factory instead.
*/
protected function getBatchSize(): int
{
return $this->getSegmentSize();
}
/**
* @deprecated Deprecated since 2.0.0 and will be removed in 3.0.0. Override
* ::getParallelExecutableFactory() to register your console path
* to the factory instead.
*/
protected function getConsolePath(): string
{
return realpath(getcwd().'/bin/console');
}
}