Repository navigation
Expand file tree
/
Copy pathProcessLauncherTask.php
More file actions
356 lines (309 loc) · 13.2 KB
/
Copy pathProcessLauncherTask.php
File metadata and controls
356 lines (309 loc) · 13.2 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
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
<?php
declare(strict_types=1);
/*
* This file is part of the CleverAge/ProcessBundle package.
*
* Copyright (c) Clever-Age
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace CleverAge\ProcessBundle\Task\Process;
use CleverAge\ProcessBundle\Exception\InvalidArgumentException;
use CleverAge\ProcessBundle\Exception\RuntimeException;
use CleverAge\ProcessBundle\Model\AbstractConfigurableTask;
use CleverAge\ProcessBundle\Model\FinalizableTaskInterface;
use CleverAge\ProcessBundle\Model\FlushableTaskInterface;
use CleverAge\ProcessBundle\Model\IterableTaskInterface;
use CleverAge\ProcessBundle\Model\ProcessState;
use CleverAge\ProcessBundle\Model\SubprocessInstance;
use CleverAge\ProcessBundle\Registry\ProcessConfigurationRegistry;
use Psr\Log\LoggerInterface;
use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
use Symfony\Component\Filesystem\Filesystem;
use Symfony\Component\HttpKernel\KernelInterface;
use Symfony\Component\OptionsResolver\Options;
use Symfony\Component\OptionsResolver\OptionsResolver;
/**
* Launch a new process for each input received, input must be a scalar, a resource or a \Traversable.
*
* @final since 5.4
*/
class ProcessLauncherTask extends AbstractConfigurableTask implements FlushableTaskInterface, IterableTaskInterface, FinalizableTaskInterface
{
/** Seconds given to the sub-processes to stop after SIGTERM, before SIGKILL */
protected const STOP_TIMEOUT = 5;
/** The value of SIGTERM, whose constant is defined by the pcntl extension */
private const SIGTERM = 15;
/**
* @var SubprocessInstance[]
*/
protected array $launchedProcesses = [];
/**
* @var \SplQueue<string>
*/
protected \SplQueue $finishedBuffers;
protected bool $flushMode = false;
/**
* @deprecated since 5.4, only set when the kernel is passed to the constructor
*/
protected ?KernelInterface $kernel = null;
protected string $consolePath;
/**
* @param string|KernelInterface $consolePath path of the Symfony console running the sub-processes; passing the
* kernel is deprecated since 5.4
* @param string|null $environment environment of the sub-processes (--env), the default one of the
* console if null; taken from the kernel when it is passed
*/
public function __construct(
protected LoggerInterface $logger,
protected ProcessConfigurationRegistry $processRegistry,
KernelInterface|string $consolePath,
protected ?string $environment = null,
) {
$this->finishedBuffers = new \SplQueue();
if ($consolePath instanceof KernelInterface) {
trigger_deprecation(
'cleverage/process-bundle',
'5.4',
'Passing a "%s" to "%s::__construct()" is deprecated, pass the path of the console and the environment instead. The argument will only accept a string in v6.0.',
KernelInterface::class,
self::class,
);
// @phpstan-ignore property.deprecated (kept for BC until v6.0)
$this->kernel = $consolePath;
$this->environment ??= $consolePath->getEnvironment();
$consolePath = $consolePath->getProjectDir().'/bin/console';
}
$this->consolePath = $consolePath;
}
public function execute(ProcessState $state): void
{
// TODO still not perfect, optimize and secure it
$this->handleProcesses($state); // Handler processes first
if (!$this->flushMode) {
$this->handleInput($state);
$state->setSkipped(true);
} elseif (!$this->finishedBuffers->isEmpty()) {
$state->setOutput($this->finishedBuffers->dequeue());
// After dequeue, stop flush
if ($this->finishedBuffers->isEmpty()) {
$this->flushMode = false;
}
} else {
$state->setSkipped(true);
}
}
public function flush(ProcessState $state): void
{
// A stopped process does not wait for its sub-processes: they are stopped when the task is finalized
if ($state->getProcessHistory()->isStopped()) {
$this->flushMode = false;
$state->setSkipped(true);
return;
}
$this->flushMode = true;
if (!$this->finishedBuffers->isEmpty()) {
$state->setOutput($this->finishedBuffers->dequeue());
} else {
$state->setSkipped(true);
}
// After dequeue, stop flush
if ($this->finishedBuffers->isEmpty() && [] === $this->launchedProcesses) {
$this->flushMode = false;
}
}
public function next(ProcessState $state): bool
{
if ($state->getProcessHistory()->isStopped()) {
$this->flushMode = false;
return false;
}
$this->handleProcesses($state);
// if there is some data waiting, handle it in priority
if ($this->finishedBuffers->count() > 0) {
$this->flushMode = true;
return true;
}
// if we are in flush mode, we should wait for process to finish
if ($this->flushMode) {
return [] !== $this->launchedProcesses;
}
usleep($this->getOption($state, 'sleep_on_finalize_interval'));
return false;
}
/**
* Stop the sub-processes still running at the end of the process, and remove the buffers that will never be
* output. Only when the process has failed or has been stopped: otherwise, the task has waited for every
* sub-process. The sub-processes went on with their side effects, their error output no longer read.
*/
public function finalize(ProcessState $state): void
{
$running = \count(array_filter($this->launchedProcesses, static fn (SubprocessInstance $process): bool => !$process->getProcess()->isTerminated()));
$this->stopProcesses($this->launchedProcesses);
foreach ($this->launchedProcesses as $process) {
$process->removeBuffer();
}
if ($running > 0) {
$this->logger->warning("{$running} sub-process(es) still running at the end of the process have been stopped");
}
// Buffers of the terminated sub-processes, not output yet
$filesystem = new Filesystem();
foreach ($this->finishedBuffers as $bufferPath) {
$filesystem->remove($bufferPath);
}
$this->launchedProcesses = [];
$this->finishedBuffers = new \SplQueue();
$this->flushMode = false;
}
protected function handleInput(ProcessState $state): void
{
$options = $this->getOptions($state);
while (\count($this->launchedProcesses) >= $options['max_processes']) {
$this->handleProcesses($state);
usleep($options['sleep_interval']);
}
$process = $this->launchProcess($state);
$this->launchedProcesses[] = $process;
$logContext = [
'input' => $process->getProcess()
->getInput(),
];
$this->logger->debug("Running command: {$process->getProcess()->getCommandLine()}", $logContext);
usleep($options['sleep_interval_after_launch']);
}
protected function launchProcess(ProcessState $state): SubprocessInstance
{
$input = null !== $state->getInput() ? (string) $state->getInput() : null;
$subprocess = new SubprocessInstance(
$this->consolePath,
$this->getOption($state, 'process'),
$input,
$this->getOption($state, 'context'),
[
SubprocessInstance::OPTION_JSON_BUFFERING => $this->getOption($state, 'json_buffering'),
],
$this->environment,
);
return $subprocess->buildProcess()
->start();
}
protected function handleProcesses(ProcessState $state): void
{
foreach ($this->launchedProcesses as $key => $process) {
if (!$process->getProcess()->isTerminated()) {
// @todo handle incremental error output properly, specially for terminal where logs are lost
echo $process->getProcess()
->getIncrementalErrorOutput();
continue;
}
$logContext = [
'cmd' => $process->getProcess()
->getCommandLine(),
'input' => $process->getProcess()
->getInput(),
'exit_code' => $process->getProcess()
->getExitCode(),
'exit_code_text' => $process->getProcess()
->getExitCodeText(),
];
$this->logger->debug('Command terminated', $logContext);
unset($this->launchedProcesses[$key]);
if (0 !== $process->getProcess()->getExitCode()) {
$process->removeBuffer();
$this->logger->critical($process->getProcess()->getErrorOutput(), $logContext);
$this->killProcesses();
throw new RuntimeException("Sub-process has failed: {$process->getProcess()->getExitCodeText()}");
}
$result = $process->getResult();
if (isset($result)) {
$this->finishedBuffers->enqueue($result);
}
}
}
protected function configureOptions(OptionsResolver $resolver): void
{
$resolver->setRequired(['process']);
$resolver->setNormalizer(
'process',
function (Options $options, $value) {
if (!$this->processRegistry->hasProcessConfiguration($value)) {
throw new InvalidConfigurationException("Unknown process {$value}");
}
return $value;
}
);
$resolver->setDefaults(
[
'max_processes' => 3,
'sleep_interval' => 1,
'sleep_interval_after_launch' => 1,
'sleep_on_finalize_interval' => 1,
'process_options' => [],
'context' => [],
'json_buffering' => false,
]
);
$resolver->setAllowedTypes('max_processes', ['integer']);
$resolver->setAllowedTypes('sleep_interval', ['integer', 'double']);
$resolver->setAllowedTypes('sleep_interval_after_launch', ['integer', 'double']);
$resolver->setAllowedTypes('sleep_on_finalize_interval', ['integer', 'double']);
$microsecondNormalizer = static fn (Options $options, $value): int => (int) ($value * 1_000_000);
$resolver->setNormalizer('sleep_interval', $microsecondNormalizer);
$resolver->setNormalizer('sleep_interval_after_launch', $microsecondNormalizer);
$resolver->setNormalizer('sleep_on_finalize_interval', $microsecondNormalizer);
$resolver->setAllowedTypes('context', ['array']);
$resolver->setAllowedTypes('json_buffering', ['boolean']);
$resolver->setAllowedTypes('process_options', ['array']);
$resolver->setNormalizer(
'process_options',
static function (Options $options, array $value): array {
if ([] !== $value) {
// Deprecated option, removed in v6.0: a non-empty value is not supported anymore
throw new InvalidArgumentException('Deprecated option, please contact support for help');
}
return $value;
}
);
}
/**
* Kill all running processes.
*/
protected function killProcesses(): void
{
// An already terminated sub-process keeps its buffer: it is handled normally at the next call
$running = array_filter($this->launchedProcesses, static fn (SubprocessInstance $process): bool => !$process->getProcess()->isTerminated());
$this->stopProcesses($running);
foreach ($running as $process) {
$process->removeBuffer();
}
}
/**
* Stops the sub-processes together: SIGTERM to all of them, then SIGKILL to the ones still running after the
* timeout. Stopped one after the other, each one waiting up to the timeout, 8 sub-processes took up to 40 seconds,
* longer than the grace period of docker stop (10 s) or Kubernetes (30 s).
*
* @param array<SubprocessInstance> $processes
*/
protected function stopProcesses(array $processes, float $timeout = self::STOP_TIMEOUT): void
{
foreach ($processes as $process) {
if ($process->getProcess()->isRunning()) {
try {
$process->getProcess()->signal(self::SIGTERM);
} catch (\Throwable) {
// Terminated in the meantime, or a signal not supported (Windows): stopped below
}
}
}
$deadline = microtime(true) + $timeout;
while (microtime(true) < $deadline
&& [] !== array_filter($processes, static fn (SubprocessInstance $process): bool => $process->getProcess()->isRunning())) {
usleep(10_000);
}
foreach ($processes as $process) {
// SIGKILL if still running
$process->stop(0);
}
}
}