[CodeQuality] Skip Request param used by caller method on RemoveUnusedRequestParamRector (#675)

Author: samsonasik

rules-tests/CodeQuality/Rector/ClassMethod/RemoveUnusedRequestParamRector/Fixture/skip_used_request_param_on_caller.php.inc

@@ -0,0 +1,18 @@
+<?php
+
+namespace Rector\Symfony\Tests\CodeQuality\Rector\ClassMethod\RemoveUnusedRequestParamRector\Fixture;
+
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Bundle\FrameworkBundle\Controller\Controller;
+
+final class SkipUsedRequestParamOnCaller extends Controller
+{
+    public function run(Request $request)
+    {
+        $this->verify($request);
+    }
+
+    public function verify(Request $request)
+    {
+    }
+}

rules/CodeQuality/Rector/ClassMethod/RemoveUnusedRequestParamRector.php

@@ -6,12 +6,15 @@
 
 use PhpParser\Node;
 use PhpParser\Node\Expr\Variable;
+use PhpParser\Node\Stmt\Class_;
 use PhpParser\Node\Stmt\ClassMethod;
+use PHPStan\Analyser\Scope;
 use PHPStan\Reflection\ClassReflection;
 use PHPStan\Type\ObjectType;
+use Rector\DeadCode\NodeAnalyzer\IsClassMethodUsedAnalyzer;
 use Rector\FamilyTree\NodeAnalyzer\ClassChildAnalyzer;
 use Rector\PhpParser\Node\BetterNodeFinder;
-use Rector\Rector\AbstractRector;
+use Rector\Rector\AbstractScopeAwareRector;
 use Rector\Reflection\ReflectionResolver;
 use Rector\Symfony\TypeAnalyzer\ControllerAnalyzer;
 use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
@@ -20,13 +23,14 @@
 /**
  * @see \Rector\Symfony\Tests\CodeQuality\Rector\ClassMethod\RemoveUnusedRequestParamRector\RemoveUnusedRequestParamRectorTest
  */
-final class RemoveUnusedRequestParamRector extends AbstractRector
+final class RemoveUnusedRequestParamRector extends AbstractScopeAwareRector
 {
     public function __construct(
         private readonly ControllerAnalyzer $controllerAnalyzer,
         private readonly ReflectionResolver $reflectionResolver,
         private readonly ClassChildAnalyzer $classChildAnalyzer,
         private readonly BetterNodeFinder $betterNodeFinder,
+        private readonly IsClassMethodUsedAnalyzer $isClassMethodUsedAnalyzer
     ) {
     }
 
@@ -69,56 +73,68 @@ public function run(int $id)
      */
     public function getNodeTypes(): array
     {
-        return [ClassMethod::class];
+        return [Class_::class];
     }
 
     /**
-     * @param ClassMethod $node
+     * @param Class_ $node
      */
-    public function refactor(Node $node): ?Node
+    public function refactorWithScope(Node $node, Scope $scope): ?Node
     {
-        if (! $node->isPublic()) {
-            return null;
-        }
-
-        if ($node->isAbstract() || $this->hasAbstractParentClassMethod($node)) {
-            return null;
-        }
-
         if (! $this->controllerAnalyzer->isInsideController($node)) {
             return null;
         }
 
-        if ($node->getParams() === []) {
-            return null;
-        }
+        $hasChanged = false;
 
-        // skip empty method
-        if ($node->stmts === null) {
-            return null;
-        }
+        foreach ($node->getMethods() as $classMethod) {
+            if (! $classMethod->isPublic()) {
+                continue;
+            }
+
+            if ($classMethod->isAbstract() || $this->hasAbstractParentClassMethod($classMethod)) {
+                continue;
+            }
 
-        foreach ($node->getParams() as $paramPosition => $param) {
-            if (! $param->type instanceof Node) {
+            if ($classMethod->getParams() === []) {
                 continue;
             }
 
-            if (! $this->isObjectType($param->type, new ObjectType('Symfony\Component\HttpFoundation\Request'))) {
+            // skip empty method
+            if ($classMethod->stmts === null) {
                 continue;
             }
 
-            /** @var string $requestParamName */
-            $requestParamName = $this->getName($param);
+            foreach ($classMethod->getParams() as $paramPosition => $param) {
+                if (! $param->type instanceof Node) {
+                    continue;
+                }
 
-            // we have request param here
-            $requestVariable = $this->betterNodeFinder->findVariableOfName($node->stmts, $requestParamName);
+                if (! $this->isObjectType($param->type, new ObjectType('Symfony\Component\HttpFoundation\Request'))) {
+                    continue;
+                }
 
-            // is variable used?
-            if ($requestVariable instanceof Variable) {
-                return null;
+                /** @var string $requestParamName */
+                $requestParamName = $this->getName($param);
+
+                // we have request param here
+                $requestVariable = $this->betterNodeFinder->findVariableOfName($classMethod->stmts, $requestParamName);
+
+                // is variable used?
+                if ($requestVariable instanceof Variable) {
+                    continue 2;
+                }
+
+                if ($this->isClassMethodUsedAnalyzer->isClassMethodUsed($node, $classMethod, $scope)) {
+                    continue 2;
+                }
+
+                unset($classMethod->params[$paramPosition]);
+                $hasChanged = true;
             }
+        }
 
-            unset($node->params[$paramPosition]);
+        if ($hasChanged) {
             return $node;
         }