Optimise checking the node types allowed for each rule

Author: carlos-granados

composer.json

@@ -139,7 +139,8 @@
                 "https://raw.githubusercontent.com/rectorphp/vendor-patches/main/patches/nikic-php-parser-lib-phpparser-node-stmt-if-php.patch",
                 "https://raw.githubusercontent.com/rectorphp/vendor-patches/main/patches/nikic-php-parser-lib-phpparser-node-stmt-case-php.patch",
                 "https://raw.githubusercontent.com/rectorphp/vendor-patches/main/patches/nikic-php-parser-lib-phpparser-node-stmt-elseif-php.patch",
-                "https://raw.githubusercontent.com/rectorphp/vendor-patches/main/patches/nikic-php-parser-lib-phpparser-node-stmt-namespace-php.patch"
+                "https://raw.githubusercontent.com/rectorphp/vendor-patches/main/patches/nikic-php-parser-lib-phpparser-node-stmt-namespace-php.patch",
+                "patches/nikic-php-parser-lib-phpparser-nodetraverser-php.patch"
             ]
         },
         "composer-exit-on-patch-failure": true,

patches/nikic-php-parser-lib-phpparser-nodetraverser-php.patch

@@ -0,0 +1,55 @@
+--- /dev/null
++++ ../lib/PhpParser/NodeTraverser.php
+@@ -119,7 +119,8 @@
+                 $traverseChildren = true;
+                 $breakVisitorIndex = null;
+ 
+-                foreach ($this->visitors as $visitorIndex => $visitor) {
++                $visitors = $this->getVisitorsForNode($subNode);
++                foreach ($visitors as $visitorIndex => $visitor) {
+                     $return = $visitor->enterNode($subNode);
+                     if (null !== $return) {
+                         if ($return instanceof Node) {
+@@ -149,7 +150,7 @@
+                     }
+                 }
+ 
+-                foreach ($this->visitors as $visitorIndex => $visitor) {
++                foreach ($visitors as $visitorIndex => $visitor) {
+                     $return = $visitor->leaveNode($subNode);
+ 
+                     if (null !== $return) {
+@@ -196,7 +197,8 @@
+                 $traverseChildren = true;
+                 $breakVisitorIndex = null;
+ 
+-                foreach ($this->visitors as $visitorIndex => $visitor) {
++                $visitors = $this->getVisitorsForNode($node);
++                foreach ($visitors as $visitorIndex => $visitor) {
+                     $return = $visitor->enterNode($node);
+                     if (null !== $return) {
+                         if ($return instanceof Node) {
+@@ -226,7 +228,7 @@
+                     }
+                 }
+ 
+-                foreach ($this->visitors as $visitorIndex => $visitor) {
++                foreach ($visitors as $visitorIndex => $visitor) {
+                     $return = $visitor->leaveNode($node);
+ 
+                     if (null !== $return) {
+@@ -270,6 +272,14 @@
+         }
+ 
+         return $nodes;
++    }
++
++    /**
++     * @return NodeVisitor[]
++     */
++    protected function getVisitorsForNode(Node $node)
++    {
++        return $this->visitors;
+     }
+ 
+     private function ensureReplacementReasonable($old, $new) {

src/PhpParser/NodeTraverser/RectorNodeTraverser.php

@@ -4,15 +4,22 @@
 
 namespace Rector\PhpParser\NodeTraverser;
 
+use PhpParser\Node;
 use PhpParser\Node\Stmt;
 use PhpParser\NodeTraverser;
+use PhpParser\NodeVisitor;
 use Rector\Contract\Rector\RectorInterface;
 use Rector\VersionBonding\PhpVersionedFilter;
 
 final class RectorNodeTraverser extends NodeTraverser
 {
     private bool $areNodeVisitorsPrepared = false;
 
+    /**
+     * @var array<class-string<Node>,RectorInterface[]>
+     */
+    private array $visitorsPerNodeClass;
+
     /**
      * @param RectorInterface[] $rectors
      */
@@ -46,6 +53,31 @@ public function refreshPhpRectors(array $rectors): void
         $this->areNodeVisitorsPrepared = false;
     }
 
+    /**
+     * We return the list of visitors (rector rules) that can be applied to each node class
+     * This list is cached so that we don't need to continually check if a rule can be applied to a node
+     *
+     * @return NodeVisitor[]
+     */
+    protected function getVisitorsForNode(Node $node): array
+    {
+        $nodeClass = $node::class;
+        if (! isset($this->visitorsPerNodeClass[$nodeClass])) {
+            $this->visitorsPerNodeClass[$nodeClass] = [];
+            foreach ($this->visitors as $visitor) {
+                assert($visitor instanceof RectorInterface);
+                foreach ($visitor->getNodeTypes() as $nodeType) {
+                    if (is_a($nodeClass, $nodeType, true)) {
+                        $this->visitorsPerNodeClass[$nodeClass][] = $visitor;
+                        break;
+                    }
+                }
+            }
+        }
+
+        return $this->visitorsPerNodeClass[$nodeClass];
+    }
+
     /**
      * This must happen after $this->configuration is set after ProcessCommand::execute() is run,
      * otherwise we get default false positives.
@@ -60,6 +92,7 @@ private function prepareNodeVisitors(): void
 
         // filer out by version
         $this->visitors = $this->phpVersionedFilter->filter($this->rectors);
+        $this->visitorsPerNodeClass = [];
         $this->areNodeVisitorsPrepared = true;
     }
 }