Support NullSafeProperty fetches in unused-code analysis (#5839)

* Support NullSafeProperty fetches in unused-code analysis * fix build
rectorphp · Apr 21, 2024 · 71c6dd9 · 71c6dd9
1 parent 4cd2622
commit 71c6dd9
Show file tree

Hide file tree

Showing 6 changed files with 72 additions and 9 deletions.
diff --git a/.../Rector/Property/RemoveUnusedPrivatePropertyRector/Fixture/skip_nullsafe_property.php.inc b/.../Rector/Property/RemoveUnusedPrivatePropertyRector/Fixture/skip_nullsafe_property.php.inc
@@ -0,0 +1,16 @@
+<?php
+
+namespace Rector\Tests\DeadCode\Rector\Property\RemoveUnusedPrivatePropertyRector\Fixture;
+
+final class SkipNullSafePropertyFetch
+{
+    private $myProp;
+
+    public function pubMethod() {
+        echo $this->getX()?->myProp;
+    }
+
+    public function getX(): SkipNullSafePropertyFetch|null {
+        return rand(0,1) ? new SkipNullSafePropertyFetch() : null;
+    }
+}
diff --git a/...ode/Rector/Property/RemoveUnusedPrivatePropertyRector/Fixture/skip_other_property.php.inc b/...ode/Rector/Property/RemoveUnusedPrivatePropertyRector/Fixture/skip_other_property.php.inc
@@ -0,0 +1,16 @@
+<?php
+
+namespace Rector\Tests\DeadCode\Rector\Property\RemoveUnusedPrivatePropertyRector\Fixture;
+
+final class SkipPrivateOtherProperty
+{
+    private $myProp;
+
+    public function pubMethod() {
+        echo $this->getX()->myProp;
+    }
+
+    public function getX(): self {
+        return new self();
+    }
+}
diff --git a/...or/Property/RemoveUnusedPrivatePropertyRector/Fixture/skip_self_nullsafe_property.php.inc b/...or/Property/RemoveUnusedPrivatePropertyRector/Fixture/skip_self_nullsafe_property.php.inc
@@ -0,0 +1,16 @@
+<?php
+
+namespace Rector\Tests\DeadCode\Rector\Property\RemoveUnusedPrivatePropertyRector\Fixture;
+
+final class SkipNullSafeSelfPropertyFetch
+{
+    private $myProp;
+
+    public function pubMethod() {
+        echo $this->getX()?->myProp;
+    }
+
+    public function getX(): self|null {
+        return rand(0,1) ? new self() : null;
+    }
+}
diff --git a/rules/DeadCode/NodeAnalyzer/PropertyWriteonlyAnalyzer.php b/rules/DeadCode/NodeAnalyzer/PropertyWriteonlyAnalyzer.php
@@ -6,6 +6,7 @@
 
 use PhpParser\Node;
 use PhpParser\Node\Expr;
+use PhpParser\Node\Expr\NullsafePropertyFetch;
 use PhpParser\Node\Expr\PropertyFetch;
 use PhpParser\Node\Expr\StaticPropertyFetch;
 use PhpParser\Node\Stmt\Class_;
@@ -22,7 +23,7 @@ public function __construct(
     public function hasClassDynamicPropertyNames(Class_ $class): bool
     {
         return (bool) $this->betterNodeFinder->findFirst($class, static function (Node $node): bool {
-            if (! $node instanceof PropertyFetch) {
+            if (! $node instanceof PropertyFetch && !$node instanceof NullsafePropertyFetch) {
                 return false;
             }
 
@@ -34,7 +35,7 @@ public function hasClassDynamicPropertyNames(Class_ $class): bool
     /**
      * The property fetches are always only assigned to, nothing else
      *
-     * @param array<PropertyFetch|StaticPropertyFetch> $propertyFetches
+     * @param array<PropertyFetch|StaticPropertyFetch|NullsafePropertyFetch> $propertyFetches
      */
     public function arePropertyFetchesExclusivelyBeingAssignedTo(array $propertyFetches): bool
     {

diff --git a/src/NodeAnalyzer/PropertyFetchAnalyzer.php b/src/NodeAnalyzer/PropertyFetchAnalyzer.php
@@ -7,6 +7,7 @@
 use PhpParser\Node;
 use PhpParser\Node\Expr\Assign;
 use PhpParser\Node\Expr\MethodCall;
+use PhpParser\Node\Expr\NullsafePropertyFetch;
 use PhpParser\Node\Expr\PropertyFetch;
 use PhpParser\Node\Expr\StaticCall;
 use PhpParser\Node\Expr\StaticPropertyFetch;
@@ -46,13 +47,17 @@ public function __construct(
 
     public function isLocalPropertyFetch(Node $node): bool
     {
-        if (! $node instanceof PropertyFetch && ! $node instanceof StaticPropertyFetch) {
+        if (
+            ! $node instanceof PropertyFetch
+            && ! $node instanceof StaticPropertyFetch
+            && ! $node instanceof NullsafePropertyFetch
+        ) {
             return false;
         }
 
-        $variableType = $node instanceof PropertyFetch
-            ? $this->nodeTypeResolver->getType($node->var)
-            : $this->nodeTypeResolver->getType($node->class);
+        $variableType = $node instanceof StaticPropertyFetch
+            ? $this->nodeTypeResolver->getType($node->class)
+            : $this->nodeTypeResolver->getType($node->var);
 
         if ($variableType instanceof ObjectType) {
             $classReflection = $this->reflectionResolver->resolveClassReflection($node);
@@ -72,7 +77,11 @@ public function isLocalPropertyFetch(Node $node): bool
 
     public function isLocalPropertyFetchName(Node $node, string $desiredPropertyName): bool
     {
-        if (! $node instanceof PropertyFetch && ! $node instanceof StaticPropertyFetch) {
+        if (
+            ! $node instanceof PropertyFetch
+            && ! $node instanceof StaticPropertyFetch
+            && ! $node instanceof NullsafePropertyFetch
+        ) {
             return false;
         }
 

diff --git a/src/PhpParser/NodeFinder/PropertyFetchFinder.php b/src/PhpParser/NodeFinder/PropertyFetchFinder.php
@@ -10,6 +10,7 @@
 use PhpParser\Node\Expr\Assign;
 use PhpParser\Node\Expr\FuncCall;
 use PhpParser\Node\Expr\MethodCall;
+use PhpParser\Node\Expr\NullsafePropertyFetch;
 use PhpParser\Node\Expr\PropertyFetch;
 use PhpParser\Node\Expr\StaticCall;
 use PhpParser\Node\Expr\StaticPropertyFetch;
@@ -70,18 +71,22 @@ public function findPrivatePropertyFetches(
     }
 
     /**
-     * @return PropertyFetch[]|StaticPropertyFetch[]
+     * @return PropertyFetch[]|StaticPropertyFetch[]|NullsafePropertyFetch[]
      */
     public function findLocalPropertyFetchesByName(Class_ $class, string $paramName): array
     {
-        /** @var PropertyFetch[]|StaticPropertyFetch[] $foundPropertyFetches */
+        /** @var PropertyFetch[]|StaticPropertyFetch[]|NullsafePropertyFetch[] $foundPropertyFetches */
         $foundPropertyFetches = $this->betterNodeFinder->find(
             $class->getMethods(),
             function (Node $subNode) use ($paramName): bool {
                 if ($subNode instanceof PropertyFetch) {
                     return $this->propertyFetchAnalyzer->isLocalPropertyFetchName($subNode, $paramName);
                 }
 
+                if ($subNode instanceof NullsafePropertyFetch) {
+                    return $this->propertyFetchAnalyzer->isLocalPropertyFetchName($subNode, $paramName);
+                }
+
                 if ($subNode instanceof StaticPropertyFetch) {
                     return $this->propertyFetchAnalyzer->isLocalPropertyFetchName($subNode, $paramName);
                 }