Updated Rector to commit a60e3ac320

a60e3ac320 warn about infinite loop node modification (#51)
This commit is contained in:
Tomas Votruba 2021-05-16 18:32:58 +00:00
parent fdfd45b0a0
commit 6d32da57f9
12 changed files with 97 additions and 34 deletions

View File

@ -160,4 +160,9 @@ final class AttributeKey
* @var string
*/
public const HAS_PHP_DOC_INFO_JUST_CHANGED = 'has_php_doc_info_just_changed';
/**
* Helps with infinite loop detection
* @var string
*/
public const CREATED_BY_RULE = 'created_by_rule';
}

View File

@ -52,7 +52,7 @@ final class NodesToAddCollector implements \Rector\PostRector\Contract\Collector
$message = \sprintf('Switch arguments in "%s()" method', __METHOD__);
throw new \Rector\Core\Exception\ShouldNotHappenException($message);
}
$position = $this->resolveNearestExpressionPosition($positionNode);
$position = $this->resolveNearestStmtPosition($positionNode);
$this->nodesToAddBefore[$position][] = $this->wrapToExpression($addedNode);
$this->rectorChangeCollector->notifyNodeFileInfo($positionNode);
}
@ -61,7 +61,7 @@ final class NodesToAddCollector implements \Rector\PostRector\Contract\Collector
*/
public function addNodesAfterNode(array $addedNodes, \PhpParser\Node $positionNode) : void
{
$position = $this->resolveNearestExpressionPosition($positionNode);
$position = $this->resolveNearestStmtPosition($positionNode);
foreach ($addedNodes as $addedNode) {
// prevent fluent method weird indent
$addedNode->setAttribute(\Rector\NodeTypeResolver\Node\AttributeKey::ORIGINAL_NODE, null);
@ -71,7 +71,7 @@ final class NodesToAddCollector implements \Rector\PostRector\Contract\Collector
}
public function addNodeAfterNode(\PhpParser\Node $addedNode, \PhpParser\Node $positionNode) : void
{
$position = $this->resolveNearestExpressionPosition($positionNode);
$position = $this->resolveNearestStmtPosition($positionNode);
$this->nodesToAddAfter[$position][] = $this->wrapToExpression($addedNode);
$this->rectorChangeCollector->notifyNodeFileInfo($positionNode);
}
@ -111,9 +111,9 @@ final class NodesToAddCollector implements \Rector\PostRector\Contract\Collector
}
$this->rectorChangeCollector->notifyNodeFileInfo($positionNode);
}
private function resolveNearestExpressionPosition(\PhpParser\Node $node) : string
private function resolveNearestStmtPosition(\PhpParser\Node $node) : string
{
if ($node instanceof \PhpParser\Node\Stmt\Expression || $node instanceof \PhpParser\Node\Stmt) {
if ($node instanceof \PhpParser\Node\Stmt) {
return \spl_object_hash($node);
}
$currentStmt = $node->getAttribute(\Rector\NodeTypeResolver\Node\AttributeKey::CURRENT_STATEMENT);
@ -124,7 +124,7 @@ final class NodesToAddCollector implements \Rector\PostRector\Contract\Collector
if ($parent instanceof \PhpParser\Node\Stmt\Return_) {
return \spl_object_hash($parent);
}
$foundNode = $this->betterNodeFinder->findParentTypes($node, [\PhpParser\Node\Stmt\Expression::class, \PhpParser\Node\Stmt::class]);
$foundNode = $this->betterNodeFinder->findParentType($node, \PhpParser\Node\Stmt::class);
if (!$foundNode instanceof \PhpParser\Node\Stmt) {
$printedNode = $this->betterStandardPrinter->print($node);
$errorMessage = \sprintf('Could not find parent Stmt of "%s" node', $printedNode);

View File

@ -61,7 +61,7 @@ CODE_SAMPLE
*/
public function refactor(\PhpParser\Node $node) : ?array
{
if ((bool) $node->elseifs) {
if ($node->elseifs) {
return null;
}
$condition = $this->conditionResolver->resolveFromExpr($node->cond);

View File

@ -56,6 +56,7 @@ CODE_SAMPLE
$tempVarName = $this->variableNaming->resolveFromNodeWithScopeCountAndFallbackName($node->var, $node->getAttribute(\Rector\NodeTypeResolver\Node\AttributeKey::SCOPE), '_');
$variable = new \PhpParser\Node\Expr\Variable($tempVarName);
$called = $node instanceof \PhpParser\Node\Expr\NullsafeMethodCall ? new \PhpParser\Node\Expr\MethodCall($variable, $node->name, $node->args) : new \PhpParser\Node\Expr\PropertyFetch($variable, $node->name);
return new \PhpParser\Node\Expr\Ternary(new \PhpParser\Node\Expr\Assign($variable, $node->var), $called, $this->nodeFactory->createNull());
$assign = new \PhpParser\Node\Expr\Assign($variable, $node->var);
return new \PhpParser\Node\Expr\Ternary($assign, $called, $this->nodeFactory->createNull());
}
}

View File

@ -178,6 +178,8 @@ final class PhpFileProcessor implements \Rector\Core\Contract\Processor\FileProc
return;
}
$callback($file);
} catch (\Rector\Core\Exception\ShouldNotHappenException $shouldNotHappenException) {
throw $shouldNotHappenException;
} catch (\PHPStan\AnalysedCodeException $analysedCodeException) {
// inform about missing classes in tests
if (\Rector\Testing\PHPUnit\StaticPHPUnitEnvironment::isPHPUnitRun()) {

View File

@ -0,0 +1,9 @@
<?php
declare (strict_types=1);
namespace Rector\Core\Exception\NodeTraverser;
use Exception;
final class InfiniteLoopTraversingException extends \Exception
{
}

View File

@ -24,6 +24,7 @@ use Rector\Core\Application\FileSystem\RemovedAndAddedFilesCollector;
use Rector\Core\Configuration\CurrentNodeProvider;
use Rector\Core\Configuration\Option;
use Rector\Core\Contract\Rector\PhpRectorInterface;
use Rector\Core\Exception\NodeTraverser\InfiniteLoopTraversingException;
use Rector\Core\Exception\ShouldNotHappenException;
use Rector\Core\Exclusion\ExclusionManager;
use Rector\Core\Logging\CurrentRectorProvider;
@ -37,6 +38,7 @@ use Rector\Core\PhpParser\Printer\BetterStandardPrinter;
use Rector\Core\Provider\CurrentFileProvider;
use Rector\Core\ValueObject\Application\File;
use Rector\Core\ValueObject\ProjectType;
use Rector\DowngradePhp80\Rector\NullsafeMethodCall\DowngradeNullsafeToTernaryOperatorRector;
use Rector\NodeCollector\NodeCollector\NodeRepository;
use Rector\NodeNameResolver\NodeNameResolver;
use Rector\NodeRemoval\NodeRemover;
@ -177,7 +179,7 @@ abstract class AbstractRector extends \PhpParser\NodeVisitorAbstract implements
*/
private $changedNodeAnalyzer;
/**
* @var array<string, Node[]>
* @var array<string, Node[]|Node>
*/
private $nodesToReturn = [];
/**
@ -228,7 +230,7 @@ abstract class AbstractRector extends \PhpParser\NodeVisitorAbstract implements
return parent::beforeTraverse($nodes);
}
/**
* @return Expression|Node|Node[]|null
* @return Expression|Node|Node[]|int|null
*/
public final function enterNode(\PhpParser\Node $node)
{
@ -250,7 +252,7 @@ abstract class AbstractRector extends \PhpParser\NodeVisitorAbstract implements
if (\is_array($node)) {
$originalNodeHash = \spl_object_hash($originalNode);
$this->nodesToReturn[$originalNodeHash] = $node;
if (($node !== []) > 0) {
if ($node !== []) {
\reset($node);
$firstNodeKey = \key($node);
$this->mirrorComments($node[$firstNodeKey], $originalNode);
@ -266,21 +268,63 @@ abstract class AbstractRector extends \PhpParser\NodeVisitorAbstract implements
if ($this->changedNodeAnalyzer->hasNodeChanged($originalNode, $node)) {
$rectorWithLineChange = new \Rector\ChangesReporting\ValueObject\RectorWithLineChange($this, $originalNode->getLine());
$this->file->addRectorClassWithLine($rectorWithLineChange);
// update parents relations
$this->connectParentNodes($node);
// update parents relations - must run before connectParentNodes()
$this->mirrorAttributes($originalAttributes, $node);
$this->connectParentNodes($node);
// is different node type? do not traverse children to avoid looping
if (\get_class($originalNode) !== \get_class($node)) {
$createdByRule = $originalNode->getAttribute(\Rector\NodeTypeResolver\Node\AttributeKey::CREATED_BY_RULE);
// special case
if ($createdByRule === static::class && static::class !== \Rector\DowngradePhp80\Rector\NullsafeMethodCall\DowngradeNullsafeToTernaryOperatorRector::class) {
// does it contain the same node type as input?
$hasNestedOriginalNodeType = $this->betterNodeFinder->findInstanceOf($node, \get_class($originalNode));
if ($hasNestedOriginalNodeType !== []) {
throw new \Rector\Core\Exception\NodeTraverser\InfiniteLoopTraversingException(static::class);
}
}
// hacking :)
$nodeTraverser = new \PhpParser\NodeTraverser();
$nodeTraverser->addVisitor(new class(static::class) extends \PhpParser\NodeVisitorAbstract
{
/**
* @var string
*/
private $rectorClass;
public function __construct(string $rectorClass)
{
$this->rectorClass = $rectorClass;
}
public function enterNode(\PhpParser\Node $node)
{
$node->setAttribute(\Rector\NodeTypeResolver\Node\AttributeKey::CREATED_BY_RULE, $this->rectorClass);
return $node;
}
});
$nodeTraverser->traverse([$originalNode]);
// search "infinite recursion" in https://github.com/nikic/PHP-Parser/blob/master/doc/component/Walking_the_AST.markdown
$originalNodeHash = \spl_object_hash($originalNode);
if ($originalNode instanceof \PhpParser\Node\Stmt && $node instanceof \PhpParser\Node\Expr) {
$node = new \PhpParser\Node\Stmt\Expression($node);
}
$this->nodesToReturn[$originalNodeHash] = $node;
return $node;
}
}
// if stmt ("$value;") was replaced by expr ("$value"), add the ending ";" (Expression) to prevent breaking the code
// if Stmt ("$value;") was replaced by Expr ("$value"), add Expression (the ending ";") to prevent breaking the code
if ($originalNode instanceof \PhpParser\Node\Stmt && $node instanceof \PhpParser\Node\Expr) {
return new \PhpParser\Node\Stmt\Expression($node);
$node = new \PhpParser\Node\Stmt\Expression($node);
}
return $node;
}
/**
* Replacing nodes in leaveNode() method avoids infinite recursion
* see"infinite recursion" in https://github.com/nikic/PHP-Parser/blob/master/doc/component/Walking_the_AST.markdown
*/
public function leaveNode(\PhpParser\Node $node)
{
$objectHash = \spl_object_hash($node);
// update parents relations
return $this->nodesToReturn[$objectHash] ?? null;
// update parents relations!!!
return $this->nodesToReturn[$objectHash] ?? $node;
}
protected function isName(\PhpParser\Node $node, string $name) : bool
{

2
vendor/autoload.php vendored
View File

@ -4,4 +4,4 @@
require_once __DIR__ . '/composer/autoload_real.php';
return ComposerAutoloaderInit963e7a858a12877c62609128dfc56900::getLoader();
return ComposerAutoloaderInita3a01dcabb577976ff00f21b50974d48::getLoader();

View File

@ -1713,6 +1713,7 @@ return array(
'Rector\\Core\\Exception\\Application\\FileProcessingException' => $baseDir . '/src/Exception/Application/FileProcessingException.php',
'Rector\\Core\\Exception\\Configuration\\InvalidConfigurationException' => $baseDir . '/src/Exception/Configuration/InvalidConfigurationException.php',
'Rector\\Core\\Exception\\InvalidNodeTypeException' => $baseDir . '/src/Exception/InvalidNodeTypeException.php',
'Rector\\Core\\Exception\\NodeTraverser\\InfiniteLoopTraversingException' => $baseDir . '/src/Exception/NodeTraverser/InfiniteLoopTraversingException.php',
'Rector\\Core\\Exception\\NotImplementedYetException' => $baseDir . '/src/Exception/NotImplementedYetException.php',
'Rector\\Core\\Exception\\ShouldNotHappenException' => $baseDir . '/src/Exception/ShouldNotHappenException.php',
'Rector\\Core\\Exception\\Testing\\SuperfluousAfterContentFixtureException' => $baseDir . '/src/Exception/Testing/SuperfluousAfterContentFixtureException.php',

View File

@ -2,7 +2,7 @@
// autoload_real.php @generated by Composer
class ComposerAutoloaderInit963e7a858a12877c62609128dfc56900
class ComposerAutoloaderInita3a01dcabb577976ff00f21b50974d48
{
private static $loader;
@ -22,15 +22,15 @@ class ComposerAutoloaderInit963e7a858a12877c62609128dfc56900
return self::$loader;
}
spl_autoload_register(array('ComposerAutoloaderInit963e7a858a12877c62609128dfc56900', 'loadClassLoader'), true, true);
spl_autoload_register(array('ComposerAutoloaderInita3a01dcabb577976ff00f21b50974d48', 'loadClassLoader'), true, true);
self::$loader = $loader = new \Composer\Autoload\ClassLoader(\dirname(\dirname(__FILE__)));
spl_autoload_unregister(array('ComposerAutoloaderInit963e7a858a12877c62609128dfc56900', 'loadClassLoader'));
spl_autoload_unregister(array('ComposerAutoloaderInita3a01dcabb577976ff00f21b50974d48', 'loadClassLoader'));
$useStaticLoader = PHP_VERSION_ID >= 50600 && !defined('HHVM_VERSION') && (!function_exists('zend_loader_file_encoded') || !zend_loader_file_encoded());
if ($useStaticLoader) {
require __DIR__ . '/autoload_static.php';
call_user_func(\Composer\Autoload\ComposerStaticInit963e7a858a12877c62609128dfc56900::getInitializer($loader));
call_user_func(\Composer\Autoload\ComposerStaticInita3a01dcabb577976ff00f21b50974d48::getInitializer($loader));
} else {
$classMap = require __DIR__ . '/autoload_classmap.php';
if ($classMap) {
@ -42,19 +42,19 @@ class ComposerAutoloaderInit963e7a858a12877c62609128dfc56900
$loader->register(true);
if ($useStaticLoader) {
$includeFiles = Composer\Autoload\ComposerStaticInit963e7a858a12877c62609128dfc56900::$files;
$includeFiles = Composer\Autoload\ComposerStaticInita3a01dcabb577976ff00f21b50974d48::$files;
} else {
$includeFiles = require __DIR__ . '/autoload_files.php';
}
foreach ($includeFiles as $fileIdentifier => $file) {
composerRequire963e7a858a12877c62609128dfc56900($fileIdentifier, $file);
composerRequirea3a01dcabb577976ff00f21b50974d48($fileIdentifier, $file);
}
return $loader;
}
}
function composerRequire963e7a858a12877c62609128dfc56900($fileIdentifier, $file)
function composerRequirea3a01dcabb577976ff00f21b50974d48($fileIdentifier, $file)
{
if (empty($GLOBALS['__composer_autoload_files'][$fileIdentifier])) {
require $file;

View File

@ -4,7 +4,7 @@
namespace Composer\Autoload;
class ComposerStaticInit963e7a858a12877c62609128dfc56900
class ComposerStaticInita3a01dcabb577976ff00f21b50974d48
{
public static $files = array (
'a4a119a56e50fbb293281d9a48007e0e' => __DIR__ . '/..' . '/symfony/polyfill-php80/bootstrap.php',
@ -2042,6 +2042,7 @@ class ComposerStaticInit963e7a858a12877c62609128dfc56900
'Rector\\Core\\Exception\\Application\\FileProcessingException' => __DIR__ . '/../..' . '/src/Exception/Application/FileProcessingException.php',
'Rector\\Core\\Exception\\Configuration\\InvalidConfigurationException' => __DIR__ . '/../..' . '/src/Exception/Configuration/InvalidConfigurationException.php',
'Rector\\Core\\Exception\\InvalidNodeTypeException' => __DIR__ . '/../..' . '/src/Exception/InvalidNodeTypeException.php',
'Rector\\Core\\Exception\\NodeTraverser\\InfiniteLoopTraversingException' => __DIR__ . '/../..' . '/src/Exception/NodeTraverser/InfiniteLoopTraversingException.php',
'Rector\\Core\\Exception\\NotImplementedYetException' => __DIR__ . '/../..' . '/src/Exception/NotImplementedYetException.php',
'Rector\\Core\\Exception\\ShouldNotHappenException' => __DIR__ . '/../..' . '/src/Exception/ShouldNotHappenException.php',
'Rector\\Core\\Exception\\Testing\\SuperfluousAfterContentFixtureException' => __DIR__ . '/../..' . '/src/Exception/Testing/SuperfluousAfterContentFixtureException.php',
@ -3447,9 +3448,9 @@ class ComposerStaticInit963e7a858a12877c62609128dfc56900
public static function getInitializer(ClassLoader $loader)
{
return \Closure::bind(function () use ($loader) {
$loader->prefixLengthsPsr4 = ComposerStaticInit963e7a858a12877c62609128dfc56900::$prefixLengthsPsr4;
$loader->prefixDirsPsr4 = ComposerStaticInit963e7a858a12877c62609128dfc56900::$prefixDirsPsr4;
$loader->classMap = ComposerStaticInit963e7a858a12877c62609128dfc56900::$classMap;
$loader->prefixLengthsPsr4 = ComposerStaticInita3a01dcabb577976ff00f21b50974d48::$prefixLengthsPsr4;
$loader->prefixDirsPsr4 = ComposerStaticInita3a01dcabb577976ff00f21b50974d48::$prefixDirsPsr4;
$loader->classMap = ComposerStaticInita3a01dcabb577976ff00f21b50974d48::$classMap;
}, null, ClassLoader::class);
}

View File

@ -21,8 +21,8 @@ if (!class_exists('SomeTestCase', false) && !interface_exists('SomeTestCase', fa
if (!class_exists('CheckoutEntityFactory', false) && !interface_exists('CheckoutEntityFactory', false) && !trait_exists('CheckoutEntityFactory', false)) {
spl_autoload_call('RectorPrefix20210516\CheckoutEntityFactory');
}
if (!class_exists('ComposerAutoloaderInit963e7a858a12877c62609128dfc56900', false) && !interface_exists('ComposerAutoloaderInit963e7a858a12877c62609128dfc56900', false) && !trait_exists('ComposerAutoloaderInit963e7a858a12877c62609128dfc56900', false)) {
spl_autoload_call('RectorPrefix20210516\ComposerAutoloaderInit963e7a858a12877c62609128dfc56900');
if (!class_exists('ComposerAutoloaderInita3a01dcabb577976ff00f21b50974d48', false) && !interface_exists('ComposerAutoloaderInita3a01dcabb577976ff00f21b50974d48', false) && !trait_exists('ComposerAutoloaderInita3a01dcabb577976ff00f21b50974d48', false)) {
spl_autoload_call('RectorPrefix20210516\ComposerAutoloaderInita3a01dcabb577976ff00f21b50974d48');
}
if (!class_exists('Doctrine\Inflector\Inflector', false) && !interface_exists('Doctrine\Inflector\Inflector', false) && !trait_exists('Doctrine\Inflector\Inflector', false)) {
spl_autoload_call('RectorPrefix20210516\Doctrine\Inflector\Inflector');
@ -95,9 +95,9 @@ if (!function_exists('print_node')) {
return \RectorPrefix20210516\print_node(...func_get_args());
}
}
if (!function_exists('composerRequire963e7a858a12877c62609128dfc56900')) {
function composerRequire963e7a858a12877c62609128dfc56900() {
return \RectorPrefix20210516\composerRequire963e7a858a12877c62609128dfc56900(...func_get_args());
if (!function_exists('composerRequirea3a01dcabb577976ff00f21b50974d48')) {
function composerRequirea3a01dcabb577976ff00f21b50974d48() {
return \RectorPrefix20210516\composerRequirea3a01dcabb577976ff00f21b50974d48(...func_get_args());
}
}
if (!function_exists('parseArgs')) {