Skip to content

Commit 7bc5a18

Browse files
Proper fix to handle ClassReflection refresh on ClassLike changed (#8728)
* Proper fix to handle ClassReflection refresh on ClassLike changed * [ci-review] Rector Rectify --------- Co-authored-by: GitHub Action <actions@github.com>
1 parent 9939155 commit 7bc5a18

13 files changed

Lines changed: 302 additions & 1 deletion

‎.github/workflows/rector_drupal_rector_dev.yaml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ env:
1212
jobs:
1313
rector_drupal_rector_dev:
1414
runs-on: ubuntu-latest
15+
timeout-minutes: 4
1516

1617
steps:
1718
-

‎.github/workflows/rector_laravel_rector_dev.yaml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ env:
1313
jobs:
1414
rector_laravel_rector_dev:
1515
runs-on: ubuntu-latest
16+
timeout-minutes: 4
1617

1718
steps:
1819
-

‎src/Application/ChangedNodeScopeRefresher.php‎

Lines changed: 47 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,17 +27,22 @@
2727
use PhpParser\Node\Stmt\Declare_;
2828
use PhpParser\Node\Stmt\Else_;
2929
use PhpParser\Node\Stmt\ElseIf_;
30+
use PhpParser\Node\Stmt\Enum_;
3031
use PhpParser\Node\Stmt\Expression;
3132
use PhpParser\Node\Stmt\If_;
33+
use PhpParser\Node\Stmt\Interface_;
3234
use PhpParser\Node\Stmt\Property;
3335
use PhpParser\Node\Stmt\Static_;
3436
use PhpParser\Node\Stmt\Use_;
3537
use PhpParser\Node\UseItem;
3638
use PHPStan\Analyser\MutatingScope;
39+
use PHPStan\Reflection\ClassReflection;
3740
use Rector\Exception\ShouldNotHappenException;
3841
use Rector\NodeAnalyzer\ScopeAnalyzer;
3942
use Rector\NodeTypeResolver\Node\AttributeKey;
43+
use Rector\NodeTypeResolver\PHPStan\Scope\AstClassReflectionFactory;
4044
use Rector\NodeTypeResolver\PHPStan\Scope\PHPStanNodeScopeResolver;
45+
use Rector\NodeTypeResolver\PHPStan\Scope\ScopeFactory;
4146
use Rector\PhpDocParser\NodeTraverser\SimpleCallableNodeTraverser;
4247

4348
/**
@@ -48,7 +53,9 @@
4853
public function __construct(
4954
private PHPStanNodeScopeResolver $phpStanNodeScopeResolver,
5055
private ScopeAnalyzer $scopeAnalyzer,
51-
private SimpleCallableNodeTraverser $simpleCallableNodeTraverser
56+
private SimpleCallableNodeTraverser $simpleCallableNodeTraverser,
57+
private AstClassReflectionFactory $astClassReflectionFactory,
58+
private ScopeFactory $scopeFactory
5259
) {
5360
}
5461

@@ -81,6 +88,8 @@ public function refresh(Node $node, string $filePath, ?MutatingScope $mutatingSc
8188
// a class-like scope is already inside the class, so PHPStan cannot enter it again and would fail
8289
// on the class node, leaving its methods with the class scope; process the class stmts directly instead
8390
if ($node instanceof ClassLike && $mutatingScope->isInClass()) {
91+
$mutatingScope = $this->refreshClassReflection($node, $mutatingScope);
92+
8493
// the class node itself is not part of its stmts, e.g. an Enum_ replaced by a new Class_ has no scope yet
8594
$node->setAttribute(AttributeKey::SCOPE, $mutatingScope);
8695
$this->phpStanNodeScopeResolver->processNodes($node->stmts, $filePath, $mutatingScope);
@@ -91,6 +100,43 @@ public function refresh(Node $node, string $filePath, ?MutatingScope $mutatingSc
91100
$this->phpStanNodeScopeResolver->processNodes($stmts, $filePath, $mutatingScope);
92101
}
93102

103+
/**
104+
* The in-class scope holds the class reflection of the original file, which does not know about
105+
* members the rule just added or removed; re-enter the class with the reflection of the changed node
106+
*/
107+
private function refreshClassReflection(ClassLike $classLike, MutatingScope $mutatingScope): MutatingScope
108+
{
109+
if (! $classLike instanceof Class_ && ! $classLike instanceof Interface_ && ! $classLike instanceof Enum_) {
110+
return $mutatingScope;
111+
}
112+
113+
if ($classLike instanceof Class_ && $classLike->isAnonymous()) {
114+
return $mutatingScope;
115+
}
116+
117+
$classReflection = $this->astClassReflectionFactory->create($classLike, $mutatingScope);
118+
if (! $classReflection instanceof ClassReflection) {
119+
return $mutatingScope;
120+
}
121+
122+
$currentClassReflection = $mutatingScope->getClassReflection();
123+
if (! $currentClassReflection instanceof ClassReflection || $currentClassReflection->getName() !== $classReflection->getName()) {
124+
return $mutatingScope;
125+
}
126+
127+
$classOutsideScope = $this->scopeFactory->createFromFile($mutatingScope->getFile());
128+
if ($mutatingScope->isDeclareStrictTypes()) {
129+
$classOutsideScope = $classOutsideScope->enterDeclareStrictTypes();
130+
}
131+
132+
$namespace = $mutatingScope->getNamespace();
133+
if ($namespace !== null) {
134+
$classOutsideScope = $classOutsideScope->enterNamespace($namespace);
135+
}
136+
137+
return $classOutsideScope->enterClass($classReflection);
138+
}
139+
94140
/**
95141
* @return Stmt[]
96142
*/

‎src/DependencyInjection/LazyContainerFactory.php‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,12 @@
99
use PhpParser\Lexer;
1010
use PHPStan\Analyser\NodeScopeResolver;
1111
use PHPStan\Analyser\ScopeFactory;
12+
use PHPStan\BetterReflection\Reflector\Reflector;
1213
use PHPStan\Parser\Parser;
1314
use PHPStan\Php\PhpVersionFactory;
1415
use PHPStan\PhpDoc\TypeNodeResolver;
1516
use PHPStan\PhpDocParser\ParserConfig;
17+
use PHPStan\Reflection\ClassReflectionFactory;
1618
use PHPStan\Reflection\ReflectionProvider;
1719
use Rector\Application\FileProcessor;
1820
use Rector\Application\Provider\CurrentFileProvider;
@@ -110,6 +112,8 @@ final class LazyContainerFactory
110112
NodeScopeResolver::class,
111113
ReflectionProvider::class,
112114
PhpVersionFactory::class,
115+
Reflector::class,
116+
ClassReflectionFactory::class,
113117
];
114118

115119
/**
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Rector\NodeTypeResolver\PHPStan\Scope;
6+
7+
use PhpParser\Node\Name;
8+
use PhpParser\Node\Stmt\Class_;
9+
use PhpParser\Node\Stmt\Enum_;
10+
use PhpParser\Node\Stmt\Interface_;
11+
use PhpParser\Node\Stmt\Namespace_;
12+
use PHPStan\Analyser\MutatingScope;
13+
use PHPStan\BetterReflection\Reflection\Adapter\ReflectionClass as ReflectionClassAdapter;
14+
use PHPStan\BetterReflection\Reflection\Adapter\ReflectionEnum as ReflectionEnumAdapter;
15+
use PHPStan\BetterReflection\Reflection\ReflectionClass;
16+
use PHPStan\BetterReflection\Reflection\ReflectionEnum;
17+
use PHPStan\BetterReflection\Reflector\Reflector;
18+
use PHPStan\BetterReflection\SourceLocator\Ast\Strategy\NodeToReflection;
19+
use PHPStan\BetterReflection\SourceLocator\Located\LocatedSource;
20+
use PHPStan\Reflection\ClassReflection;
21+
use PHPStan\Reflection\ClassReflectionFactory;
22+
23+
/**
24+
* The class reflection from the reflection provider is built from the original file,
25+
* so it does not know about members a rule added or removed; build it from the current class node instead
26+
*
27+
* @see \PHPStan\Analyser\StmtHandler\ClassLikeHandler::createAstClassReflection()
28+
*/
29+
final readonly class AstClassReflectionFactory
30+
{
31+
public function __construct(
32+
private Reflector $reflector,
33+
private ClassReflectionFactory $classReflectionFactory,
34+
) {
35+
}
36+
37+
public function create(Class_|Interface_|Enum_ $classLike, MutatingScope $mutatingScope): ?ClassReflection
38+
{
39+
$filePath = $mutatingScope->getFile();
40+
$namespace = $mutatingScope->getNamespace();
41+
42+
$betterReflectionClass = new NodeToReflection()->__invoke(
43+
$this->reflector,
44+
$classLike,
45+
new LocatedSource(null, null, $filePath),
46+
$namespace !== null ? new Namespace_(new Name($namespace)) : null
47+
);
48+
49+
if (! $betterReflectionClass instanceof ReflectionClass) {
50+
return null;
51+
}
52+
53+
$reflectionClassAdapter = $betterReflectionClass instanceof ReflectionEnum
54+
? new ReflectionEnumAdapter($betterReflectionClass)
55+
: new ReflectionClassAdapter($betterReflectionClass);
56+
57+
// the member caches are keyed by the class reflection cache key,
58+
// so each rebuilt reflection needs its own key not to read members of the former one
59+
return $this->classReflectionFactory->create(
60+
$betterReflectionClass->getName(),
61+
$reflectionClassAdapter,
62+
null,
63+
null,
64+
null,
65+
uniqid($filePath . ':', true)
66+
);
67+
}
68+
}
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Rector\Tests\Issues\ClassReflectionRefresh;
6+
7+
use Iterator;
8+
use PHPUnit\Framework\Attributes\DataProvider;
9+
use Rector\Testing\PHPUnit\AbstractRectorTestCase;
10+
11+
final class ClassReflectionRefreshTest extends AbstractRectorTestCase
12+
{
13+
#[DataProvider('provideData')]
14+
public function test(string $filePath): void
15+
{
16+
$this->doTestFile($filePath);
17+
}
18+
19+
public static function provideData(): Iterator
20+
{
21+
return self::yieldFilesFromDirectory(__DIR__ . '/Fixture');
22+
}
23+
24+
public function provideConfigFilePath(): string
25+
{
26+
return __DIR__ . '/config/configured_rule.php';
27+
}
28+
}
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<?php
2+
3+
namespace Rector\Tests\Issues\ClassReflectionRefresh\Fixture;
4+
5+
final class AddTraitOnce
6+
{
7+
public function run()
8+
{
9+
}
10+
}
11+
12+
?>
13+
-----
14+
<?php
15+
16+
namespace Rector\Tests\Issues\ClassReflectionRefresh\Fixture;
17+
18+
final class AddTraitOnce
19+
{
20+
use \Rector\Tests\Issues\ClassReflectionRefresh\Source\SomeTrait;
21+
public function run()
22+
{
23+
}
24+
}
25+
26+
?>
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
<?php
2+
3+
namespace Rector\Tests\Issues\ClassReflectionRefresh\Fixture;
4+
5+
use Rector\Tests\Issues\ClassReflectionRefresh\Source\SomeParentClass;
6+
7+
final class AddTraitWithImportedParent extends SomeParentClass
8+
{
9+
public function run(): SomeParentClass
10+
{
11+
return $this;
12+
}
13+
}
14+
15+
?>
16+
-----
17+
<?php
18+
19+
namespace Rector\Tests\Issues\ClassReflectionRefresh\Fixture;
20+
21+
use Rector\Tests\Issues\ClassReflectionRefresh\Source\SomeParentClass;
22+
23+
final class AddTraitWithImportedParent extends SomeParentClass
24+
{
25+
use \Rector\Tests\Issues\ClassReflectionRefresh\Source\SomeTrait;
26+
public function run(): SomeParentClass
27+
{
28+
return $this;
29+
}
30+
}
31+
32+
?>
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<?php
2+
3+
namespace Rector\Tests\Issues\ClassReflectionRefresh\Fixture;
4+
5+
use Rector\Tests\Issues\ClassReflectionRefresh\Source\SomeTrait;
6+
7+
final class SkipAlreadyUsedImportedTrait
8+
{
9+
use SomeTrait;
10+
}
Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Rector\Tests\Issues\ClassReflectionRefresh\Source;
6+
7+
use PhpParser\Node;
8+
use PhpParser\Node\Name\FullyQualified;
9+
use PhpParser\Node\Stmt\Class_;
10+
use PhpParser\Node\Stmt\TraitUse;
11+
use PHPStan\Reflection\ClassReflection;
12+
use Rector\Rector\AbstractRector;
13+
use Rector\Reflection\ReflectionResolver;
14+
use Rector\RuleDoc\RuleDefinition;
15+
16+
/**
17+
* Decides on the class reflection only, so it adds the trait again on every pass
18+
* unless the class reflection reflects the changed class node
19+
*/
20+
final class AddTraitByReflectionRector extends AbstractRector
21+
{
22+
public function __construct(
23+
private readonly ReflectionResolver $reflectionResolver
24+
) {
25+
}
26+
27+
public function getRuleDefinition(): RuleDefinition
28+
{
29+
return new RuleDefinition('', []);
30+
}
31+
32+
/**
33+
* @return array<class-string<Node>>
34+
*/
35+
public function getNodeTypes(): array
36+
{
37+
return [Class_::class];
38+
}
39+
40+
/**
41+
* @param Class_ $node
42+
*/
43+
public function refactor(Node $node): ?Class_
44+
{
45+
$classReflection = $this->reflectionResolver->resolveClassReflection($node);
46+
if (! $classReflection instanceof ClassReflection) {
47+
return null;
48+
}
49+
50+
if ($classReflection->hasTraitUse(SomeTrait::class)) {
51+
return null;
52+
}
53+
54+
$node->stmts = array_merge([new TraitUse([new FullyQualified(SomeTrait::class)])], $node->stmts);
55+
56+
return $node;
57+
}
58+
}

0 commit comments

Comments
 (0)