feature symfony#61765 [TypeInfo] Add result cache to TypeContextFactory (landure)

This PR was submitted for the 7.3 branch but it was merged into the 7.4 branch instead.

Discussion
----------

[TypeInfo] Add result cache to `TypeContextFactory`

| Q             | A
| ------------- | ---
| Branch?       | 7.4
| Bug fix?      | no
| New feature?  | no
| Deprecations? | no
| Issues        | Fix symfony#61725
| License       | MIT

Add caches to `TypeContextFactory` method to prevent multiple parsing of the same classes by PHPStan property extractor.

1. Add cache to intermediate `TypeContext` creation from `createFromClassName()` and `createFromReflection()` by adding:

   - `intermediateTypeContextCache` proprety.
   - `createIntermediateTypeContext()` create the intermediate `TypeContext` if not found in cache.

2. Add cache to `createFromClassName()` by:

   - `typeContextCache` proprety.
   - extracting `TypeContext` creation to private `createNewInstanceFromClassName()` method.
   - refactoring `createFromClassName()` to get the `TypeContext` from `$this->typeContextCache`, or creating it by calling `createNewInstanceFromClassName()` method.

3. Add a test to check that the results are cached.

This optimize deserialization and form validation.

Commits
-------

e39963f [TypeInfo] Add result cache to TypeContextFactory

Author: fabpot

src/Symfony/Component/TypeInfo/Tests/TypeContext/TypeContextFactoryTest.php

@@ -60,6 +60,13 @@ public function testCollectClassNames()
         $this->assertSame('Dummy', $typeContext->declaringClassName);
     }
 
+    public function testCacheResultWhenToStringTypeResolver()
+    {
+        $typeContext = $this->typeContextFactory->createFromClassName(Dummy::class, AbstractDummy::class);
+        $cachedtypeContext = $this->typeContextFactory->createFromClassName(Dummy::class, AbstractDummy::class);
+        $this->assertSame($typeContext, $cachedtypeContext);
+    }
+
     public function testCollectNamespace()
     {
         $namespace = 'Symfony\\Component\\TypeInfo\\Tests\\Fixtures';

src/Symfony/Component/TypeInfo/TypeContext/TypeContextFactory.php

@@ -33,6 +33,7 @@
  *
  * @author Mathias Arlaud <[email protected]>
  * @author Baptiste Leduc <[email protected]>
+ * @author Pierre-Yves Landuré <[email protected]>
  */
 final class TypeContextFactory
 {
@@ -41,6 +42,16 @@ final class TypeContextFactory
      */
     private static array $reflectionClassCache = [];
 
+    /**
+     * @var array<string,array<string,TypeContext>
+     */
+    private array $intermediateTypeContextCache = [];
+
+    /**
+     * @var array<string,array<string,TypeContext>
+     */
+    private array $typeContextCache = [];
+
     private ?Lexer $phpstanLexer = null;
     private ?PhpDocParser $phpstanParser = null;
 
@@ -57,26 +68,7 @@ public function createFromClassName(string $calledClassName, ?string $declaringC
     {
         $declaringClassName ??= $calledClassName;
 
-        $calledClassPath = explode('\\', $calledClassName);
-        $declaringClassPath = explode('\\', $declaringClassName);
-
-        $declaringClassReflection = self::$reflectionClassCache[$declaringClassName] ??= new \ReflectionClass($declaringClassName);
-
-        $typeContext = new TypeContext(
-            end($calledClassPath),
-            end($declaringClassPath),
-            trim($declaringClassReflection->getNamespaceName(), '\\'),
-            $this->collectUses($declaringClassReflection),
-        );
-
-        return new TypeContext(
-            $typeContext->calledClassName,
-            $typeContext->declaringClassName,
-            $typeContext->namespace,
-            $typeContext->uses,
-            $this->collectTemplates($declaringClassReflection, $typeContext),
-            $this->collectTypeAliases($declaringClassReflection, $typeContext),
-        );
+        return $this->typeContextCache[$declaringClassName][$calledClassName] ??= $this->createNewInstanceFromClassName($calledClassName, $declaringClassName);
     }
 
     public function createFromReflection(\Reflector $reflection): ?TypeContext
@@ -94,12 +86,7 @@ public function createFromReflection(\Reflector $reflection): ?TypeContext
             return null;
         }
 
-        $typeContext = new TypeContext(
-            $declaringClassReflection->getShortName(),
-            $declaringClassReflection->getShortName(),
-            $declaringClassReflection->getNamespaceName(),
-            $this->collectUses($declaringClassReflection),
-        );
+        $typeContext = $this->createIntermediateTypeContext($declaringClassReflection->getShortName(), $declaringClassReflection);
 
         $templates = match (true) {
             $reflection instanceof \ReflectionFunctionAbstract => $this->collectTemplates($reflection, $typeContext) + $this->collectTemplates($declaringClassReflection, $typeContext),
@@ -117,6 +104,36 @@ public function createFromReflection(\Reflector $reflection): ?TypeContext
         );
     }
 
+    private function createNewInstanceFromClassName(string $calledClassName, string $declaringClassName): TypeContext
+    {
+        $calledClassPath = explode('\\', $calledClassName);
+
+        $declaringClassReflection = self::$reflectionClassCache[$declaringClassName] ??= new \ReflectionClass($declaringClassName);
+
+        $typeContext = $this->createIntermediateTypeContext(end($calledClassPath), $declaringClassReflection);
+
+        return new TypeContext(
+            $typeContext->calledClassName,
+            $typeContext->declaringClassName,
+            $typeContext->namespace,
+            $typeContext->uses,
+            $this->collectTemplates($declaringClassReflection, $typeContext),
+            $this->collectTypeAliases($declaringClassReflection, $typeContext),
+        );
+    }
+
+    private function createIntermediateTypeContext(string $calledClassShortName, \ReflectionClass $declaringClassReflection): TypeContext
+    {
+        $declaringClassName = $declaringClassReflection->getName();
+
+        return $this->intermediateTypeContextCache[$declaringClassName][$calledClassShortName] ??= new TypeContext(
+            $calledClassShortName,
+            $declaringClassReflection->getShortName(),
+            trim($declaringClassReflection->getNamespaceName(), '\\'),
+            $this->collectUses($declaringClassReflection),
+        );
+    }
+
     /**
      * @return array<string, string>
      */