Cache ast-parsing in RegexGroupParser

[staabm]

before this PR:

➜  phpstan-src git:(2.1.x) ✗ hyperfine 'php vendor/bin/phpunit tests/PHPStan/Analyser/NodeScopeResolverTest.php' --runs=5
Benchmark 1: php vendor/bin/phpunit tests/PHPStan/Analyser/NodeScopeResolverTest.php
  Time (mean ± σ):     13.665 s ±  0.175 s    [User: 13.312 s, System: 0.344 s]
  Range (min … max):   13.511 s … 13.947 s    5 runs

after this PR:

➜  phpstan-src git:(cache-regx) ✗ hyperfine 'php vendor/bin/phpunit tests/PHPStan/Analyser/NodeScopeResolverTest.php' --runs=5
Benchmark 1: php vendor/bin/phpunit tests/PHPStan/Analyser/NodeScopeResolverTest.php
  Time (mean ± σ):     12.591 s ±  0.052 s    [User: 12.248 s, System: 0.334 s]
  Range (min … max):   12.503 s … 12.636 s    5 runs

---

after this PR the runtime of NodeScopeResolverTest is now dominated by TypeTraverser and TypeCombinator:

[ondrejmirtes]

What about caching one step sooner on $regex?

[ondrejmirtes]

Running NodeScopeResolverTest is not representative of usual PHPStan analysis performance, because no rules are running. So it's still valuable to have faster tests but saying we need to optimize TypeTraverser might not be true.

[ondrejmirtes]

I'm currently running blackfire run --ignore-exit-status php bin/phpstan analyse src/Analyser/ src/Rules/ -v --debug and will post the results. Last time I did it most of the time was spent in Scope::getType() and TypeCombinator::union().

[ondrejmirtes]

Thank you!

[ondrejmirtes]

Here it is: https://blackfire.io/profiles/194a65b8-7351-443e-be57-9c936cd6d985/graph

11.6% spent in TypeCombinator::union(), 21.5% spent in resolveType. TypeTraverser is "only" 6.04 %.

2 % of that is resolveLateResolvableTypes which might still be useful to optimize/call less often.

[staabm]

php bin/phpstan analyse src/Analyser/ src/Rules/ -v --debug

looking at the expressions beeing resolved, we can see the following counts:

array(59) {
  ["PhpParser\Node\Expr\New_"]=>
  int(5981)
  ["PhpParser\Node\Expr\StaticCall"]=>
  int(22256)
  ["PhpParser\Node\Expr\PropertyFetch"]=>
  int(51125)
  ["PhpParser\Node\Expr\Variable"]=>
  int(223094)
  ["PhpParser\Node\Scalar\Int_"]=>
  int(7602)
  ["PhpParser\Node\Scalar\String_"]=>
  int(20181)
  ["PhpParser\Node\Expr\Assign"]=>
  int(18425)
  ["PhpParser\Node\Expr\Array_"]=>
  int(7970)
  ["PhpParser\Node\Expr\ConstFetch"]=>
  int(11207)
  ["PhpParser\Node\Expr\FuncCall"]=>
  int(24058)
  ["PhpParser\Node\Expr\BinaryOp\Identical"]=>
  int(11685)
  ["PhpParser\Node\Expr\BinaryOp\BooleanOr"]=>
  int(2732)
  ["PhpParser\Node\Expr\BooleanNot"]=>
  int(6644)
  ["PhpParser\Node\Expr\Instanceof_"]=>
  int(6832)
  ["PhpParser\Node\Expr\BinaryOp\BooleanAnd"]=>
  int(4831)
  ["PhpParser\Node\Expr\MethodCall"]=>
  int(128414)
  ["PhpParser\Node\Expr\BinaryOp\Plus"]=>
  int(525)
  ["PhpParser\Node\Expr\ArrayDimFetch"]=>
  int(16746)
  ["PhpParser\Node\Expr\ClassConstFetch"]=>
  int(6382)
  ["PhpParser\Node\Expr\BinaryOp\Minus"]=>
  int(423)
  ["PhpParser\Node\Expr\BinaryOp\Greater"]=>
  int(544)
  ["PhpParser\Node\Expr\BinaryOp\NotIdentical"]=>
  int(3150)
  ["PhpParser\Node\Expr\Ternary"]=>
  int(1910)
  ["PhpParser\Node\Expr\BinaryOp\Coalesce"]=>
  int(918)
  ["PhpParser\Node\Expr\Closure"]=>
  int(611)
  ["PhpParser\Node\Expr\Isset_"]=>
  int(758)
  ["PhpParser\Node\Expr\Cast\String_"]=>
  int(673)
  ["PhpParser\Node\Expr\ArrowFunction"]=>
  int(1503)
  ["PhpParser\Node\Expr\UnaryMinus"]=>
  int(115)
  ["PhpParser\Node\Expr\BinaryOp\Spaceship"]=>
  int(36)
  ["PhpParser\Node\Expr\Clone_"]=>
  int(24)
  ["PhpParser\Node\Expr\BinaryOp\Smaller"]=>
  int(254)
  ["PhpParser\Node\Expr\BinaryOp\GreaterOrEqual"]=>
  int(187)
  ["PhpParser\Node\Expr\PostInc"]=>
  int(119)
  ["PhpParser\Node\Expr\PreInc"]=>
  int(383)
  ["PHPStan\Node\IssetExpr"]=>
  int(12)
  ["PhpParser\Node\Expr\BinaryOp\BitwiseOr"]=>
  int(16)
  ["PhpParser\Node\Expr\AssignOp\Plus"]=>
  int(19)
  ["PhpParser\Node\Expr\BinaryOp\Concat"]=>
  int(1315)
  ["PhpParser\Node\Expr\BinaryOp\BitwiseAnd"]=>
  int(106)
  ["PhpParser\Node\Expr\BitwiseNot"]=>
  int(17)
  ["PhpParser\Node\Expr\AssignOp\Concat"]=>
  int(73)
  ["PhpParser\Node\Expr\AssignOp\Coalesce"]=>
  int(33)
  ["PhpParser\Node\Expr\BinaryOp\SmallerOrEqual"]=>
  int(37)
  ["PhpParser\Node\Expr\BinaryOp\LogicalXor"]=>
  int(3)
  ["PhpParser\Node\Expr\StaticPropertyFetch"]=>
  int(19)
  ["PhpParser\Node\Expr\PostDec"]=>
  int(4)
  ["PhpParser\Node\Expr\PreDec"]=>
  int(16)
  ["PhpParser\Node\Scalar\Float_"]=>
  int(10)
  ["PhpParser\Node\Expr\ErrorSuppress"]=>
  int(7)
  ["PhpParser\Node\Expr\Cast\Int_"]=>
  int(20)
  ["PhpParser\Node\Expr\Throw_"]=>
  int(10)
  ["PhpParser\Node\Expr\Cast\Bool_"]=>
  int(22)
  ["PHPStan\Node\Expr\AlwaysRememberedExpr"]=>
  int(384)
  ["PhpParser\Node\Expr\Include_"]=>
  int(27)
  ["PhpParser\Node\Expr\BinaryOp\Mul"]=>
  int(11)
  ["PhpParser\Node\Expr\AssignOp\BitwiseOr"]=>
  int(31)
  ["PhpParser\Node\Expr\BinaryOp\Mod"]=>
  int(14)
  ["PhpParser\Node\Expr\AssignOp\Minus"]=>
  int(3)
}

measured using

diff --git a/src/Analyser/MutatingScope.php b/src/Analyser/MutatingScope.php
index be05271cf1..fddabb6513 100644
--- a/src/Analyser/MutatingScope.php
+++ b/src/Analyser/MutatingScope.php
@@ -921,6 +921,15 @@ class MutatingScope implements Scope, NodeCallbackInvoker
 
        private function resolveType(string $exprString, Expr $node): Type
        {
+               static $types = [];
+               if ($types === []) {
+                       register_shutdown_function(function() use (&$types) {
+                               var_dump($types);
+                       });
+               }
+               $types[get_class($node)] ??= 0;
+               $types[get_class($node)] ++;
+
                foreach ($this->expressionTypeResolverExtensionRegistry->getExtensions() as $extension) {