mirror of
https://github.com/rectorphp/rector.git
synced 2024-05-28 15:00:50 +00:00
9a2931cbe4
bdc2fc9963 [NodeManipulator] Remove parent lookup on PropertyFetchAssignManipulator (#4037)
287 lines
12 KiB
PHP
287 lines
12 KiB
PHP
<?php
|
|
|
|
declare (strict_types=1);
|
|
namespace Rector\Core\Application;
|
|
|
|
use PHPStan\Analyser\NodeScopeResolver;
|
|
use Rector\Caching\Detector\ChangedFilesDetector;
|
|
use Rector\Core\Application\FileDecorator\FileDiffFileDecorator;
|
|
use Rector\Core\Application\FileSystem\RemovedAndAddedFilesProcessor;
|
|
use Rector\Core\Configuration\Option;
|
|
use Rector\Core\Configuration\Parameter\ParameterProvider;
|
|
use Rector\Core\Contract\Console\OutputStyleInterface;
|
|
use Rector\Core\Contract\Processor\FileProcessorInterface;
|
|
use Rector\Core\Util\ArrayParametersMerger;
|
|
use Rector\Core\ValueObject\Application\File;
|
|
use Rector\Core\ValueObject\Configuration;
|
|
use Rector\Core\ValueObject\Error\SystemError;
|
|
use Rector\Core\ValueObject\Reporting\FileDiff;
|
|
use Rector\Core\ValueObjectFactory\Application\FileFactory;
|
|
use Rector\Parallel\Application\ParallelFileProcessor;
|
|
use Rector\Parallel\ValueObject\Bridge;
|
|
use RectorPrefix202306\Symfony\Component\Console\Input\InputInterface;
|
|
use RectorPrefix202306\Symfony\Component\Filesystem\Filesystem;
|
|
use RectorPrefix202306\Symplify\EasyParallel\CpuCoreCountProvider;
|
|
use RectorPrefix202306\Symplify\EasyParallel\Exception\ParallelShouldNotHappenException;
|
|
use RectorPrefix202306\Symplify\EasyParallel\ScheduleFactory;
|
|
final class ApplicationFileProcessor
|
|
{
|
|
/**
|
|
* @var string
|
|
*/
|
|
private const ARGV = 'argv';
|
|
/**
|
|
* @var SystemError[]
|
|
*/
|
|
private $systemErrors = [];
|
|
/**
|
|
* @readonly
|
|
* @var \Symfony\Component\Filesystem\Filesystem
|
|
*/
|
|
private $filesystem;
|
|
/**
|
|
* @readonly
|
|
* @var \Rector\Core\Application\FileDecorator\FileDiffFileDecorator
|
|
*/
|
|
private $fileDiffFileDecorator;
|
|
/**
|
|
* @readonly
|
|
* @var \Rector\Core\Application\FileSystem\RemovedAndAddedFilesProcessor
|
|
*/
|
|
private $removedAndAddedFilesProcessor;
|
|
/**
|
|
* @readonly
|
|
* @var \Rector\Core\Contract\Console\OutputStyleInterface
|
|
*/
|
|
private $rectorOutputStyle;
|
|
/**
|
|
* @readonly
|
|
* @var \Rector\Core\ValueObjectFactory\Application\FileFactory
|
|
*/
|
|
private $fileFactory;
|
|
/**
|
|
* @readonly
|
|
* @var \PHPStan\Analyser\NodeScopeResolver
|
|
*/
|
|
private $nodeScopeResolver;
|
|
/**
|
|
* @readonly
|
|
* @var \Rector\Core\Util\ArrayParametersMerger
|
|
*/
|
|
private $arrayParametersMerger;
|
|
/**
|
|
* @readonly
|
|
* @var \Rector\Parallel\Application\ParallelFileProcessor
|
|
*/
|
|
private $parallelFileProcessor;
|
|
/**
|
|
* @readonly
|
|
* @var \Rector\Core\Configuration\Parameter\ParameterProvider
|
|
*/
|
|
private $parameterProvider;
|
|
/**
|
|
* @readonly
|
|
* @var \Symplify\EasyParallel\ScheduleFactory
|
|
*/
|
|
private $scheduleFactory;
|
|
/**
|
|
* @readonly
|
|
* @var \Symplify\EasyParallel\CpuCoreCountProvider
|
|
*/
|
|
private $cpuCoreCountProvider;
|
|
/**
|
|
* @readonly
|
|
* @var \Rector\Caching\Detector\ChangedFilesDetector
|
|
*/
|
|
private $changedFilesDetector;
|
|
/**
|
|
* @var FileProcessorInterface[]
|
|
* @readonly
|
|
*/
|
|
private $fileProcessors = [];
|
|
/**
|
|
* @param FileProcessorInterface[] $fileProcessors
|
|
*/
|
|
public function __construct(Filesystem $filesystem, FileDiffFileDecorator $fileDiffFileDecorator, RemovedAndAddedFilesProcessor $removedAndAddedFilesProcessor, OutputStyleInterface $rectorOutputStyle, FileFactory $fileFactory, NodeScopeResolver $nodeScopeResolver, ArrayParametersMerger $arrayParametersMerger, ParallelFileProcessor $parallelFileProcessor, ParameterProvider $parameterProvider, ScheduleFactory $scheduleFactory, CpuCoreCountProvider $cpuCoreCountProvider, ChangedFilesDetector $changedFilesDetector, array $fileProcessors = [])
|
|
{
|
|
$this->filesystem = $filesystem;
|
|
$this->fileDiffFileDecorator = $fileDiffFileDecorator;
|
|
$this->removedAndAddedFilesProcessor = $removedAndAddedFilesProcessor;
|
|
$this->rectorOutputStyle = $rectorOutputStyle;
|
|
$this->fileFactory = $fileFactory;
|
|
$this->nodeScopeResolver = $nodeScopeResolver;
|
|
$this->arrayParametersMerger = $arrayParametersMerger;
|
|
$this->parallelFileProcessor = $parallelFileProcessor;
|
|
$this->parameterProvider = $parameterProvider;
|
|
$this->scheduleFactory = $scheduleFactory;
|
|
$this->cpuCoreCountProvider = $cpuCoreCountProvider;
|
|
$this->changedFilesDetector = $changedFilesDetector;
|
|
$this->fileProcessors = $fileProcessors;
|
|
}
|
|
/**
|
|
* @return array{system_errors: SystemError[], file_diffs: FileDiff[]}
|
|
*/
|
|
public function run(Configuration $configuration, InputInterface $input) : array
|
|
{
|
|
$filePaths = $this->fileFactory->findFilesInPaths($configuration->getPaths(), $configuration);
|
|
// no files found
|
|
if ($filePaths === []) {
|
|
return [Bridge::SYSTEM_ERRORS => [], Bridge::FILE_DIFFS => []];
|
|
}
|
|
$this->configureCustomErrorHandler();
|
|
if ($configuration->isParallel()) {
|
|
$systemErrorsAndFileDiffs = $this->runParallel($filePaths, $configuration, $input);
|
|
} else {
|
|
// 1. collect all files from files+dirs provided paths
|
|
$files = $this->fileFactory->createFromPaths($filePaths);
|
|
// 2. PHPStan has to know about all files too
|
|
$this->configurePHPStanNodeScopeResolver($filePaths, $configuration);
|
|
$systemErrorsAndFileDiffs = $this->processFiles($files, $configuration);
|
|
if ($configuration->shouldShowDiffs()) {
|
|
$this->fileDiffFileDecorator->decorate($files);
|
|
}
|
|
$this->printFiles($files, $configuration);
|
|
}
|
|
$systemErrorsAndFileDiffs[Bridge::SYSTEM_ERRORS] = \array_merge($systemErrorsAndFileDiffs[Bridge::SYSTEM_ERRORS], $this->systemErrors);
|
|
$this->restoreErrorHandler();
|
|
return $systemErrorsAndFileDiffs;
|
|
}
|
|
/**
|
|
* @api use only for tests
|
|
*
|
|
* @param File[] $files
|
|
* @return array{system_errors: SystemError[], file_diffs: FileDiff[]}
|
|
*/
|
|
public function processFiles(array $files, Configuration $configuration) : array
|
|
{
|
|
$shouldShowProgressBar = $configuration->shouldShowProgressBar();
|
|
if ($shouldShowProgressBar) {
|
|
$fileCount = \count($files);
|
|
$this->rectorOutputStyle->progressStart($fileCount);
|
|
$this->rectorOutputStyle->progressAdvance(0);
|
|
}
|
|
$systemErrorsAndFileDiffs = [Bridge::SYSTEM_ERRORS => [], Bridge::FILE_DIFFS => []];
|
|
foreach ($files as $file) {
|
|
foreach ($this->fileProcessors as $fileProcessor) {
|
|
if (!$fileProcessor->supports($file, $configuration)) {
|
|
continue;
|
|
}
|
|
$result = $fileProcessor->process($file, $configuration);
|
|
$systemErrorsAndFileDiffs = $this->arrayParametersMerger->merge($systemErrorsAndFileDiffs, $result);
|
|
}
|
|
if ($systemErrorsAndFileDiffs[Bridge::SYSTEM_ERRORS] !== []) {
|
|
$this->changedFilesDetector->invalidateFile($file->getFilePath());
|
|
} elseif (!$configuration->isDryRun()) {
|
|
$this->changedFilesDetector->cacheFileWithDependencies($file->getFilePath());
|
|
}
|
|
// progress bar +1
|
|
if ($shouldShowProgressBar) {
|
|
$this->rectorOutputStyle->progressAdvance();
|
|
}
|
|
}
|
|
$this->removedAndAddedFilesProcessor->run($configuration);
|
|
return $systemErrorsAndFileDiffs;
|
|
}
|
|
/**
|
|
* @param string[] $filePaths
|
|
*/
|
|
public function configurePHPStanNodeScopeResolver(array $filePaths, Configuration $configuration) : void
|
|
{
|
|
$fileExtensions = $configuration->getFileExtensions();
|
|
$fileWithExtensionsFilter = static function (string $filePath) use($fileExtensions) : bool {
|
|
$filePathExtension = \pathinfo($filePath, \PATHINFO_EXTENSION);
|
|
return \in_array($filePathExtension, $fileExtensions, \true);
|
|
};
|
|
$filePaths = \array_filter($filePaths, $fileWithExtensionsFilter);
|
|
$this->nodeScopeResolver->setAnalysedFiles($filePaths);
|
|
}
|
|
/**
|
|
* @param File[] $files
|
|
*/
|
|
private function printFiles(array $files, Configuration $configuration) : void
|
|
{
|
|
if ($configuration->isDryRun()) {
|
|
return;
|
|
}
|
|
foreach ($files as $file) {
|
|
if (!$file->hasChanged()) {
|
|
continue;
|
|
}
|
|
$this->printFile($file);
|
|
}
|
|
}
|
|
private function printFile(File $file) : void
|
|
{
|
|
$filePath = $file->getFilePath();
|
|
$this->filesystem->dumpFile($filePath, $file->getFileContent());
|
|
// @todo how to keep original chmod rights?
|
|
// $this->filesystem->chmod($filePath, $smartFileInfo->getPerms());
|
|
}
|
|
/**
|
|
* Inspired by @see https://github.com/phpstan/phpstan-src/blob/89af4e7db257750cdee5d4259ad312941b6b25e8/src/Analyser/Analyser.php#L134
|
|
*/
|
|
private function configureCustomErrorHandler() : void
|
|
{
|
|
$errorHandlerCallback = function (int $code, string $message, string $file, int $line) : bool {
|
|
if ((\error_reporting() & $code) === 0) {
|
|
// silence @ operator
|
|
return \true;
|
|
}
|
|
// not relevant for us
|
|
if (\in_array($code, [\E_DEPRECATED, \E_WARNING], \true)) {
|
|
return \true;
|
|
}
|
|
$this->systemErrors[] = new SystemError($message, $file, $line);
|
|
return \true;
|
|
};
|
|
\set_error_handler($errorHandlerCallback);
|
|
}
|
|
private function restoreErrorHandler() : void
|
|
{
|
|
\restore_error_handler();
|
|
}
|
|
/**
|
|
* @param string[] $filePaths
|
|
* @return array{system_errors: SystemError[], file_diffs: FileDiff[]}
|
|
*/
|
|
private function runParallel(array $filePaths, Configuration $configuration, InputInterface $input) : array
|
|
{
|
|
// @todo possibly relative paths?
|
|
// must be a string, otherwise the serialization returns empty arrays
|
|
// $filePaths // = $this->filePathNormalizer->resolveFilePathsFromFileInfos($filePaths);
|
|
$schedule = $this->scheduleFactory->create($this->cpuCoreCountProvider->provide(), $this->parameterProvider->provideIntParameter(Option::PARALLEL_JOB_SIZE), $this->parameterProvider->provideIntParameter(Option::PARALLEL_MAX_NUMBER_OF_PROCESSES), $filePaths);
|
|
$postFileCallback = static function (int $stepCount) : void {
|
|
};
|
|
if ($configuration->shouldShowProgressBar()) {
|
|
$fileCount = \count($filePaths);
|
|
$this->rectorOutputStyle->progressStart($fileCount);
|
|
$this->rectorOutputStyle->progressAdvance(0);
|
|
$postFileCallback = function (int $stepCount) : void {
|
|
$this->rectorOutputStyle->progressAdvance($stepCount);
|
|
// running in parallel here → nothing else to do
|
|
};
|
|
}
|
|
$mainScript = $this->resolveCalledRectorBinary();
|
|
if ($mainScript === null) {
|
|
throw new ParallelShouldNotHappenException('[parallel] Main script was not found');
|
|
}
|
|
// mimics see https://github.com/phpstan/phpstan-src/commit/9124c66dcc55a222e21b1717ba5f60771f7dda92#diff-387b8f04e0db7a06678eb52ce0c0d0aff73e0d7d8fc5df834d0a5fbec198e5daR139
|
|
return $this->parallelFileProcessor->process($schedule, $mainScript, $postFileCallback, $input);
|
|
}
|
|
/**
|
|
* Path to called "rector" binary file, e.g. "vendor/bin/rector" returns "vendor/bin/rector" This is needed to re-call the
|
|
* ecs binary in sub-process in the same location.
|
|
*/
|
|
private function resolveCalledRectorBinary() : ?string
|
|
{
|
|
if (!isset($_SERVER[self::ARGV][0])) {
|
|
return null;
|
|
}
|
|
$potentialEcsBinaryPath = $_SERVER[self::ARGV][0];
|
|
if (!\file_exists($potentialEcsBinaryPath)) {
|
|
return null;
|
|
}
|
|
return $potentialEcsBinaryPath;
|
|
}
|
|
}
|