-
Notifications
You must be signed in to change notification settings - Fork 447
/
WorkerCommand.php
279 lines (250 loc) · 8.94 KB
/
WorkerCommand.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
<?php declare(strict_types = 1);
namespace PHPStan\Command;
use Clue\React\NDJson\Decoder;
use Clue\React\NDJson\Encoder;
use PHPStan\Analyser\FileAnalyser;
use PHPStan\Analyser\NodeScopeResolver;
use PHPStan\Collectors\Registry as CollectorRegistry;
use PHPStan\DependencyInjection\Container;
use PHPStan\File\PathNotFoundException;
use PHPStan\Rules\Registry as RuleRegistry;
use PHPStan\ShouldNotHappenException;
use React\EventLoop\StreamSelectLoop;
use React\Socket\ConnectionInterface;
use React\Socket\TcpConnector;
use React\Stream\ReadableStreamInterface;
use React\Stream\WritableStreamInterface;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Throwable;
use function array_fill_keys;
use function array_filter;
use function array_values;
use function count;
use function defined;
use function is_array;
use function is_bool;
use function is_string;
use function memory_get_peak_usage;
use function sprintf;
class WorkerCommand extends Command
{
private const NAME = 'worker';
private int $errorCount = 0;
/**
* @param string[] $composerAutoloaderProjectPaths
*/
public function __construct(
private array $composerAutoloaderProjectPaths,
)
{
parent::__construct();
}
protected function configure(): void
{
$this->setName(self::NAME)
->setDescription('(Internal) Support for parallel analysis.')
->setDefinition([
new InputArgument('paths', InputArgument::OPTIONAL | InputArgument::IS_ARRAY, 'Paths with source code to run analysis on'),
new InputOption('configuration', 'c', InputOption::VALUE_REQUIRED, 'Path to project configuration file'),
new InputOption(AnalyseCommand::OPTION_LEVEL, 'l', InputOption::VALUE_REQUIRED, 'Level of rule options - the higher the stricter'),
new InputOption('autoload-file', 'a', InputOption::VALUE_REQUIRED, 'Project\'s additional autoload file path'),
new InputOption('memory-limit', null, InputOption::VALUE_REQUIRED, 'Memory limit for analysis'),
new InputOption('xdebug', null, InputOption::VALUE_NONE, 'Allow running with XDebug for debugging purposes'),
new InputOption('port', null, InputOption::VALUE_REQUIRED),
new InputOption('identifier', null, InputOption::VALUE_REQUIRED),
new InputOption('tmp-file', null, InputOption::VALUE_REQUIRED),
new InputOption('instead-of', null, InputOption::VALUE_REQUIRED),
]);
}
protected function execute(InputInterface $input, OutputInterface $output): int
{
$paths = $input->getArgument('paths');
$memoryLimit = $input->getOption('memory-limit');
$autoloadFile = $input->getOption('autoload-file');
$configuration = $input->getOption('configuration');
$level = $input->getOption(AnalyseCommand::OPTION_LEVEL);
$allowXdebug = $input->getOption('xdebug');
$port = $input->getOption('port');
$identifier = $input->getOption('identifier');
if (
!is_array($paths)
|| (!is_string($memoryLimit) && $memoryLimit !== null)
|| (!is_string($autoloadFile) && $autoloadFile !== null)
|| (!is_string($configuration) && $configuration !== null)
|| (!is_string($level) && $level !== null)
|| (!is_bool($allowXdebug))
|| !is_string($port)
|| !is_string($identifier)
) {
throw new ShouldNotHappenException();
}
/** @var string|null $tmpFile */
$tmpFile = $input->getOption('tmp-file');
/** @var string|null $insteadOfFile */
$insteadOfFile = $input->getOption('instead-of');
$singleReflectionFile = null;
if ($tmpFile !== null) {
$singleReflectionFile = $tmpFile;
}
try {
$inceptionResult = CommandHelper::begin(
$input,
$output,
$paths,
$memoryLimit,
$autoloadFile,
$this->composerAutoloaderProjectPaths,
$configuration,
null,
$level,
$allowXdebug,
false,
$singleReflectionFile,
null,
false,
);
} catch (InceptionNotSuccessfulException $e) {
return 1;
}
$loop = new StreamSelectLoop();
$container = $inceptionResult->getContainer();
try {
[$analysedFiles] = $inceptionResult->getFiles();
$analysedFiles = $this->switchTmpFile($analysedFiles, $insteadOfFile, $tmpFile);
} catch (PathNotFoundException $e) {
$inceptionResult->getErrorOutput()->writeLineFormatted(sprintf('<error>%s</error>', $e->getMessage()));
return 1;
}
/** @var NodeScopeResolver $nodeScopeResolver */
$nodeScopeResolver = $container->getByType(NodeScopeResolver::class);
$nodeScopeResolver->setAnalysedFiles($analysedFiles);
$analysedFiles = array_fill_keys($analysedFiles, true);
$tcpConector = new TcpConnector($loop);
$tcpConector->connect(sprintf('127.0.0.1:%d', $port))->done(function (ConnectionInterface $connection) use ($container, $identifier, $output, $analysedFiles, $tmpFile, $insteadOfFile): void {
// phpcs:disable SlevomatCodingStandard.Namespaces.ReferenceUsedNamesOnly
$jsonInvalidUtf8Ignore = defined('JSON_INVALID_UTF8_IGNORE') ? JSON_INVALID_UTF8_IGNORE : 0;
// phpcs:enable
$out = new Encoder($connection, $jsonInvalidUtf8Ignore);
$in = new Decoder($connection, true, 512, $jsonInvalidUtf8Ignore, $container->getParameter('parallel')['buffer']);
$out->write(['action' => 'hello', 'identifier' => $identifier]);
$this->runWorker($container, $out, $in, $output, $analysedFiles, $tmpFile, $insteadOfFile);
});
$loop->run();
if ($this->errorCount > 0) {
return 1;
}
return 0;
}
/**
* @param array<string, true> $analysedFiles
*/
private function runWorker(
Container $container,
WritableStreamInterface $out,
ReadableStreamInterface $in,
OutputInterface $output,
array $analysedFiles,
?string $tmpFile,
?string $insteadOfFile,
): void
{
$handleError = function (Throwable $error) use ($out, $output): void {
$this->errorCount++;
$output->writeln(sprintf('Error: %s', $error->getMessage()));
$out->write([
'action' => 'result',
'result' => [
'errors' => [$error->getMessage()],
'dependencies' => [],
'filesCount' => 0,
'internalErrorsCount' => 1,
],
]);
$out->end();
};
$out->on('error', $handleError);
/** @var FileAnalyser $fileAnalyser */
$fileAnalyser = $container->getByType(FileAnalyser::class);
/** @var RuleRegistry $ruleRegistry */
$ruleRegistry = $container->getByType(RuleRegistry::class);
/** @var CollectorRegistry $collectorRegistry */
$collectorRegistry = $container->getByType(CollectorRegistry::class);
$in->on('data', function (array $json) use ($fileAnalyser, $ruleRegistry, $collectorRegistry, $out, $analysedFiles, $tmpFile, $insteadOfFile, $output): void {
$action = $json['action'];
if ($action !== 'analyse') {
return;
}
$internalErrorsCount = 0;
$files = $json['files'];
$errors = [];
$collectedData = [];
$dependencies = [];
$exportedNodes = [];
foreach ($files as $file) {
try {
if ($file === $insteadOfFile) {
$file = $tmpFile;
}
$fileAnalyserResult = $fileAnalyser->analyseFile($file, $analysedFiles, $ruleRegistry, $collectorRegistry, null);
$fileErrors = $fileAnalyserResult->getErrors();
$dependencies[$file] = $fileAnalyserResult->getDependencies();
$exportedNodes[$file] = $fileAnalyserResult->getExportedNodes();
foreach ($fileErrors as $fileError) {
$errors[] = $fileError;
}
foreach ($fileAnalyserResult->getCollectedData() as $data) {
$collectedData[] = $data;
}
} catch (Throwable $t) {
$this->errorCount++;
$internalErrorsCount++;
$internalErrorMessage = sprintf('Internal error: %s in file %s', $t->getMessage(), $file);
$bugReportUrl = 'https://github.com/phpstan/phpstan/issues/new?template=Bug_report.md';
if (OutputInterface::VERBOSITY_VERBOSE <= $output->getVerbosity()) {
$internalErrorMessage .= sprintf('%sPost the following stack trace to %s: %s%s', "\n\n", $bugReportUrl, "\n", $t->getTraceAsString());
} else {
$internalErrorMessage .= sprintf('%sRun PHPStan with -v option and post the stack trace to:%s%s', "\n", "\n", $bugReportUrl);
}
$errors[] = $internalErrorMessage;
}
}
$out->write([
'action' => 'result',
'result' => [
'errors' => $errors,
'collectedData' => $collectedData,
'memoryUsage' => memory_get_peak_usage(true),
'dependencies' => $dependencies,
'exportedNodes' => $exportedNodes,
'filesCount' => count($files),
'internalErrorsCount' => $internalErrorsCount,
]]);
});
$in->on('error', $handleError);
}
/**
* @param string[] $analysedFiles
* @return string[]
*/
private function switchTmpFile(
array $analysedFiles,
?string $insteadOfFile,
?string $tmpFile,
): array
{
$analysedFiles = array_values(array_filter($analysedFiles, static function (string $file) use ($insteadOfFile): bool {
if ($insteadOfFile === null) {
return true;
}
return $file !== $insteadOfFile;
}));
if ($tmpFile !== null) {
$analysedFiles[] = $tmpFile;
}
return $analysedFiles;
}
}