[Config] Make ClassExistenceResource throw on invalid parents

nicolas-grekas · nicolas-grekas · commit 9a2cde27cab2 · 2017-07-18T16:30:05.000+02:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/LoggingTranslatorPass.php b/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Compiler/LoggingTranslatorPass.php
@@ -34,7 +34,7 @@ public function process(ContainerBuilder $container)
             $definition = $container->getDefinition((string) $translatorAlias);
             $class = $container->getParameterBag()->resolveValue($definition->getClass());
 
-            if (!$r = $container->getReflectionClass($class)) {
+            if (!$r = $container->getReflectionClass($class, true)) {
                 throw new InvalidArgumentException(sprintf('Class "%s" used for service "%s" cannot be found.', $class, $translatorAlias));
             }
             if ($r->isSubclassOf(TranslatorInterface::class) && $r->isSubclassOf(TranslatorBagInterface::class)) {
diff --git a/src/Symfony/Component/Config/Resource/ClassExistenceResource.php b/src/Symfony/Component/Config/Resource/ClassExistenceResource.php
@@ -25,6 +25,7 @@ class ClassExistenceResource implements SelfCheckingResourceInterface, \Serializ
     private $exists;
 
     private static $autoloadLevel = 0;
+    private static $autoloadedClass;
     private static $existsCache = array();
 
     /**
@@ -57,6 +58,8 @@ public function getResource()
 
     /**
      * {@inheritdoc}
+     *
+     * @throws \ReflectionException when a parent class/interface/trait is not found
      */
     public function isFresh($timestamp)
     {
@@ -68,12 +71,13 @@ public function isFresh($timestamp)
             if (!self::$autoloadLevel++) {
                 spl_autoload_register(__CLASS__.'::throwOnRequiredClass');
             }
+            $autoloadedClass = self::$autoloadedClass;
+            self::$autoloadedClass = $this->resource;
 
             try {
                 $exists = class_exists($this->resource) || interface_exists($this->resource, false) || trait_exists($this->resource, false);
-            } catch (\ReflectionException $e) {
-                $exists = false;
             } finally {
+                self::$autoloadedClass = $autoloadedClass;
                 if (!--self::$autoloadLevel) {
                     spl_autoload_unregister(__CLASS__.'::throwOnRequiredClass');
                 }
@@ -112,7 +116,10 @@ public function unserialize($serialized)
      */
     private static function throwOnRequiredClass($class)
     {
-        $e = new \ReflectionException("Class $class does not exist");
+        if (self::$autoloadedClass === $class) {
+            return;
+        }
+        $e = new \ReflectionException("Class $class not found");
         $trace = $e->getTrace();
         $autoloadFrame = array(
             'function' => 'spl_autoload_call',
@@ -138,6 +145,18 @@ private static function throwOnRequiredClass($class)
                 case 'is_callable':
                     return;
             }
+
+            $props = array(
+                'file' => $trace[$i]['file'],
+                'line' => $trace[$i]['line'],
+                'trace' => array_slice($trace, 0, 1 + $i),
+            );
+
+            foreach ($props as $p => $v) {
+                $r = new \ReflectionProperty('Exception', $p);
+                $r->setAccessible(true);
+                $r->setValue($e, $v);
+            }
         }
 
         throw $e;
diff --git a/src/Symfony/Component/Console/DependencyInjection/AddConsoleCommandPass.php b/src/Symfony/Component/Console/DependencyInjection/AddConsoleCommandPass.php
@@ -32,7 +32,7 @@ public function process(ContainerBuilder $container)
             $definition = $container->getDefinition($id);
             $class = $container->getParameterBag()->resolveValue($definition->getClass());
 
-            if (!$r = $container->getReflectionClass($class)) {
+            if (!$r = $container->getReflectionClass($class, true)) {
                 throw new InvalidArgumentException(sprintf('Class "%s" used for service "%s" cannot be found.', $class, $id));
             }
             if (!$r->isSubclassOf(Command::class)) {
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/AbstractRecursivePass.php b/src/Symfony/Component/DependencyInjection/Compiler/AbstractRecursivePass.php
@@ -115,7 +115,7 @@ protected function getConstructor(Definition $definition, $required)
 
         $class = $definition->getClass();
 
-        if (!$r = $this->container->getReflectionClass($class)) {
+        if (!$r = $this->container->getReflectionClass($class, true)) {
             throw new RuntimeException(sprintf('Unable to resolve service "%s": class "%s" does not exist.', $this->currentId, $class));
         }
         if (!$r = $r->getConstructor()) {
@@ -147,7 +147,7 @@ protected function getReflectionMethod(Definition $definition, $method)
             throw new RuntimeException(sprintf('Unable to resolve service "%s": the class is not set.', $this->currentId));
         }
 
-        if (!$r = $this->container->getReflectionClass($class)) {
+        if (!$r = $this->container->getReflectionClass($class, true)) {
             throw new RuntimeException(sprintf('Unable to resolve service "%s": class "%s" does not exist.', $this->currentId, $class));
         }
 
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/AutowirePass.php b/src/Symfony/Component/DependencyInjection/Compiler/AutowirePass.php
@@ -125,7 +125,7 @@ private function doProcessValue($value, $isRoot = false)
             return $value;
         }
         if (!$reflectionClass = $this->container->getReflectionClass($value->getClass())) {
-            $this->container->log($this, sprintf('Skipping service "%s": Class or interface "%s" does not exist.', $this->currentId, $value->getClass()));
+            $this->container->log($this, sprintf('Skipping service "%s": Class or interface "%s" cannot be loaded.', $this->currentId, $value->getClass()));
 
             return $value;
         }
@@ -479,7 +479,7 @@ private function createAutowiredDefinition($type)
     private function createTypeNotFoundMessage(TypedReference $reference, $label)
     {
         if (!$r = $this->container->getReflectionClass($type = $reference->getType())) {
-            $message = sprintf('has type "%s" but this class does not exist.', $type);
+            $message = sprintf('has type "%s" but this class cannot be loaded.', $type);
         } else {
             $message = $this->container->has($type) ? 'this service is abstract' : 'no such service exists';
             $message = sprintf('references %s "%s" but %s.%s', $r->isInterface() ? 'interface' : 'class', $type, $message, $this->createTypeAlternatives($reference));
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/ResolveInstanceofConditionalsPass.php b/src/Symfony/Component/DependencyInjection/Compiler/ResolveInstanceofConditionalsPass.php
@@ -133,7 +133,7 @@ private function mergeConditionals(array $autoconfiguredInstanceof, array $insta
 
         foreach ($instanceofConditionals as $interface => $instanceofDef) {
             // make sure the interface/class exists (but don't validate automaticInstanceofConditionals)
-            if (!$container->getReflectionClass($interface)) {
+            if (!$container->getReflectionClass($interface, true)) {
                 throw new RuntimeException(sprintf('"%s" is set as an "instanceof" conditional, but it does not exist.', $interface));
             }
 
diff --git a/src/Symfony/Component/DependencyInjection/ContainerBuilder.php b/src/Symfony/Component/DependencyInjection/ContainerBuilder.php
@@ -337,12 +337,15 @@ public function addClassResource(\ReflectionClass $class)
      * Retrieves the requested reflection class and registers it for resource tracking.
      *
      * @param string $class
+     * @param bool   $throw
      *
      * @return \ReflectionClass|null
      *
+     * @throws \ReflectionException when a parent class/interface/trait is not found and $throw is true
+     *
      * @final
      */
-    public function getReflectionClass($class)
+    public function getReflectionClass($class, $throw = false)
     {
         if (!$class = $this->getParameterBag()->resolveValue($class)) {
             return;
@@ -357,6 +360,9 @@ public function getReflectionClass($class)
                 $classReflector = $resource->isFresh(0) ? false : new \ReflectionClass($class);
             }
         } catch (\ReflectionException $e) {
+            if ($throw) {
+                throw $e;
+            }
             $classReflector = false;
         }
 
@@ -732,7 +738,7 @@ public function compile(/*$resolveEnvPlaceholders = false*/)
 
         foreach ($this->definitions as $id => $definition) {
             if ($this->trackResources && $definition->isLazy()) {
-                $this->getReflectionClass($definition->getClass());
+                $this->getReflectionClass($definition->getClass(), true);
             }
         }
 
diff --git a/src/Symfony/Component/DependencyInjection/Dumper/PhpDumper.php b/src/Symfony/Component/DependencyInjection/Dumper/PhpDumper.php
@@ -1627,7 +1627,7 @@ private function initializeMethodNamesMap($class)
         $this->serviceIdToMethodNameMap = array();
         $this->usedMethodNames = array();
 
-        if ($reflectionClass = $this->container->getReflectionClass($class)) {
+        if ($reflectionClass = $this->container->getReflectionClass($class, true)) {
             foreach ($reflectionClass->getMethods() as $method) {
                 $this->usedMethodNames[strtolower($method->getName())] = true;
             }
diff --git a/src/Symfony/Component/DependencyInjection/Extension/Extension.php b/src/Symfony/Component/DependencyInjection/Extension/Extension.php
@@ -79,7 +79,7 @@ public function getConfiguration(array $config, ContainerBuilder $container)
     {
         $class = get_class($this);
         $class = substr_replace($class, '\Configuration', strrpos($class, '\\'));
-        $class = $container->getReflectionClass($class);
+        $class = $container->getReflectionClass($class, true);
         $constructor = $class ? $class->getConstructor() : null;
 
         if ($class && (!$constructor || !$constructor->getNumberOfRequiredParameters())) {
diff --git a/src/Symfony/Component/DependencyInjection/Loader/FileLoader.php b/src/Symfony/Component/DependencyInjection/Loader/FileLoader.php
@@ -129,7 +129,7 @@ private function findClasses($namespace, $pattern, $excludePattern)
                 continue;
             }
             // check to make sure the expected class exists
-            if (!$r = $this->container->getReflectionClass($class)) {
+            if (!$r = $this->container->getReflectionClass($class, true)) {
                 throw new InvalidArgumentException(sprintf('Expected to find class "%s" in file "%s" while importing services from resource "%s", but it was not found! Check the namespace prefix used with the resource.', $class, $path, $pattern));
             }
 
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Compiler/AutowirePassTest.php b/src/Symfony/Component/DependencyInjection/Tests/Compiler/AutowirePassTest.php
@@ -359,7 +359,7 @@ public function testDontTriggerAutowiring()
 
     /**
      * @expectedException \Symfony\Component\DependencyInjection\Exception\AutowiringFailedException
-     * @expectedExceptionMessage Cannot autowire service "a": argument "$r" of method "Symfony\Component\DependencyInjection\Tests\Compiler\BadTypeHintedArgument::__construct()" has type "Symfony\Component\DependencyInjection\Tests\Compiler\NotARealClass" but this class does not exist.
+     * @expectedExceptionMessage Cannot autowire service "a": argument "$r" of method "Symfony\Component\DependencyInjection\Tests\Compiler\BadTypeHintedArgument::__construct()" has type "Symfony\Component\DependencyInjection\Tests\Compiler\NotARealClass" but this class cannot be loaded.
      */
     public function testClassNotFoundThrowsException()
     {
@@ -374,7 +374,7 @@ public function testClassNotFoundThrowsException()
 
     /**
      * @expectedException \Symfony\Component\DependencyInjection\Exception\AutowiringFailedException
-     * @expectedExceptionMessage Cannot autowire service "a": argument "$r" of method "Symfony\Component\DependencyInjection\Tests\Compiler\BadParentTypeHintedArgument::__construct()" has type "Symfony\Component\DependencyInjection\Tests\Compiler\OptionalServiceClass" but this class does not exist.
+     * @expectedExceptionMessage Cannot autowire service "a": argument "$r" of method "Symfony\Component\DependencyInjection\Tests\Compiler\BadParentTypeHintedArgument::__construct()" has type "Symfony\Component\DependencyInjection\Tests\Compiler\OptionalServiceClass" but this class cannot be loaded.
      */
     public function testParentClassNotFoundThrowsException()
     {
@@ -744,7 +744,7 @@ public function testNotWireableCalls($method, $expectedMsg)
     public function provideNotWireableCalls()
     {
         return array(
-            array('setNotAutowireable', 'Cannot autowire service "foo": argument "$n" of method "Symfony\Component\DependencyInjection\Tests\Compiler\NotWireable::setNotAutowireable()" has type "Symfony\Component\DependencyInjection\Tests\Compiler\NotARealClass" but this class does not exist.'),
+            array('setNotAutowireable', 'Cannot autowire service "foo": argument "$n" of method "Symfony\Component\DependencyInjection\Tests\Compiler\NotWireable::setNotAutowireable()" has type "Symfony\Component\DependencyInjection\Tests\Compiler\NotARealClass" but this class cannot be loaded.'),
             array('setDifferentNamespace', 'Cannot autowire service "foo": argument "$n" of method "Symfony\Component\DependencyInjection\Tests\Compiler\NotWireable::setDifferentNamespace()" references class "stdClass" but no such service exists. It cannot be auto-registered because it is from a different root namespace.'),
             array(null, 'Cannot autowire service "foo": method "Symfony\Component\DependencyInjection\Tests\Compiler\NotWireable::setProtectedMethod()" must be public.'),
         );
diff --git a/src/Symfony/Component/HttpKernel/DependencyInjection/FragmentRendererPass.php b/src/Symfony/Component/HttpKernel/DependencyInjection/FragmentRendererPass.php
@@ -50,7 +50,7 @@ public function process(ContainerBuilder $container)
             $def = $container->getDefinition($id);
             $class = $container->getParameterBag()->resolveValue($def->getClass());
 
-            if (!$r = $container->getReflectionClass($class)) {
+            if (!$r = $container->getReflectionClass($class, true)) {
                 throw new InvalidArgumentException(sprintf('Class "%s" used for service "%s" cannot be found.', $class, $id));
             }
             if (!$r->isSubclassOf(FragmentRendererInterface::class)) {
diff --git a/src/Symfony/Component/HttpKernel/DependencyInjection/RegisterControllerArgumentLocatorsPass.php b/src/Symfony/Component/HttpKernel/DependencyInjection/RegisterControllerArgumentLocatorsPass.php
@@ -60,7 +60,7 @@ public function process(ContainerBuilder $container)
             }
             $class = $parameterBag->resolveValue($class);
 
-            if (!$r = $container->getReflectionClass($class)) {
+            if (!$r = $container->getReflectionClass($class, true)) {
                 throw new InvalidArgumentException(sprintf('Class "%s" used for service "%s" cannot be found.', $class, $id));
             }
             $isContainerAware = $r->implementsInterface(ContainerAwareInterface::class) || is_subclass_of($class, AbstractController::class);

Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ public function process(ContainerBuilder $container)`
`34`	`34`	`$definition = $container->getDefinition((string) $translatorAlias);`
`35`	`35`	`$class = $container->getParameterBag()->resolveValue($definition->getClass());`
`36`	`36`
`37`		`- if (!$r = $container->getReflectionClass($class)) {`
	`37`	`+ if (!$r = $container->getReflectionClass($class, true)) {`
`38`	`38`	`throw new InvalidArgumentException(sprintf('Class "%s" used for service "%s" cannot be found.', $class, $translatorAlias));`
`39`	`39`	`}`
`40`	`40`	`if ($r->isSubclassOf(TranslatorInterface::class) && $r->isSubclassOf(TranslatorBagInterface::class)) {`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ public function process(ContainerBuilder $container)`
`32`	`32`	`$definition = $container->getDefinition($id);`
`33`	`33`	`$class = $container->getParameterBag()->resolveValue($definition->getClass());`
`34`	`34`
`35`		`- if (!$r = $container->getReflectionClass($class)) {`
	`35`	`+ if (!$r = $container->getReflectionClass($class, true)) {`
`36`	`36`	`throw new InvalidArgumentException(sprintf('Class "%s" used for service "%s" cannot be found.', $class, $id));`
`37`	`37`	`}`
`38`	`38`	`if (!$r->isSubclassOf(Command::class)) {`
Original file line number	Diff line number	Diff line change
`@@ -115,7 +115,7 @@ protected function getConstructor(Definition $definition, $required)`
`115`	`115`
`116`	`116`	`$class = $definition->getClass();`
`117`	`117`
`118`		`- if (!$r = $this->container->getReflectionClass($class)) {`
	`118`	`+ if (!$r = $this->container->getReflectionClass($class, true)) {`
`119`	`119`	`throw new RuntimeException(sprintf('Unable to resolve service "%s": class "%s" does not exist.', $this->currentId, $class));`
`120`	`120`	`}`
`121`	`121`	`if (!$r = $r->getConstructor()) {`
`@@ -147,7 +147,7 @@ protected function getReflectionMethod(Definition $definition, $method)`
`147`	`147`	`throw new RuntimeException(sprintf('Unable to resolve service "%s": the class is not set.', $this->currentId));`
`148`	`148`	`}`
`149`	`149`
`150`		`- if (!$r = $this->container->getReflectionClass($class)) {`
	`150`	`+ if (!$r = $this->container->getReflectionClass($class, true)) {`
`151`	`151`	`throw new RuntimeException(sprintf('Unable to resolve service "%s": class "%s" does not exist.', $this->currentId, $class));`
`152`	`152`	`}`
`153`	`153`
Original file line number	Diff line number	Diff line change
`@@ -125,7 +125,7 @@ private function doProcessValue($value, $isRoot = false)`
`125`	`125`	`return $value;`
`126`	`126`	`}`
`127`	`127`	`if (!$reflectionClass = $this->container->getReflectionClass($value->getClass())) {`
`128`		`- $this->container->log($this, sprintf('Skipping service "%s": Class or interface "%s" does not exist.', $this->currentId, $value->getClass()));`
	`128`	`+ $this->container->log($this, sprintf('Skipping service "%s": Class or interface "%s" cannot be loaded.', $this->currentId, $value->getClass()));`
`129`	`129`
`130`	`130`	`return $value;`
`131`	`131`	`}`
`@@ -479,7 +479,7 @@ private function createAutowiredDefinition($type)`
`479`	`479`	`private function createTypeNotFoundMessage(TypedReference $reference, $label)`
`480`	`480`	`{`
`481`	`481`	`if (!$r = $this->container->getReflectionClass($type = $reference->getType())) {`
`482`		`- $message = sprintf('has type "%s" but this class does not exist.', $type);`
	`482`	`+ $message = sprintf('has type "%s" but this class cannot be loaded.', $type);`
`483`	`483`	`} else {`
`484`	`484`	`$message = $this->container->has($type) ? 'this service is abstract' : 'no such service exists';`
`485`	`485`	`$message = sprintf('references %s "%s" but %s.%s', $r->isInterface() ? 'interface' : 'class', $type, $message, $this->createTypeAlternatives($reference));`
Original file line number	Diff line number	Diff line change
`@@ -133,7 +133,7 @@ private function mergeConditionals(array $autoconfiguredInstanceof, array $insta`
`133`	`133`
`134`	`134`	`foreach ($instanceofConditionals as $interface => $instanceofDef) {`
`135`	`135`	`// make sure the interface/class exists (but don't validate automaticInstanceofConditionals)`
`136`		`- if (!$container->getReflectionClass($interface)) {`
	`136`	`+ if (!$container->getReflectionClass($interface, true)) {`
`137`	`137`	`throw new RuntimeException(sprintf('"%s" is set as an "instanceof" conditional, but it does not exist.', $interface));`
`138`	`138`	`}`
`139`	`139`
Original file line number	Diff line number	Diff line change
`@@ -337,12 +337,15 @@ public function addClassResource(\ReflectionClass $class)`
`337`	`337`	`* Retrieves the requested reflection class and registers it for resource tracking.`
`338`	`338`	`*`
`339`	`339`	`* @param string $class`
	`340`	`+ * @param bool $throw`
`340`	`341`	`*`
`341`	`342`	`* @return \ReflectionClass\|null`
`342`	`343`	`*`
	`344`	`+ * @throws \ReflectionException when a parent class/interface/trait is not found and $throw is true`
	`345`	`+ *`
`343`	`346`	`* @final`
`344`	`347`	`*/`
`345`		`- public function getReflectionClass($class)`
	`348`	`+ public function getReflectionClass($class, $throw = false)`
`346`	`349`	`{`
`347`	`350`	`if (!$class = $this->getParameterBag()->resolveValue($class)) {`
`348`	`351`	`return;`
`@@ -357,6 +360,9 @@ public function getReflectionClass($class)`
`357`	`360`	`$classReflector = $resource->isFresh(0) ? false : new \ReflectionClass($class);`
`358`	`361`	`}`
`359`	`362`	`} catch (\ReflectionException $e) {`
	`363`	`+ if ($throw) {`
	`364`	`+ throw $e;`
	`365`	`+ }`
`360`	`366`	`$classReflector = false;`
`361`	`367`	`}`
`362`	`368`
`@@ -732,7 +738,7 @@ public function compile(/$resolveEnvPlaceholders = false/)`
`732`	`738`
`733`	`739`	`foreach ($this->definitions as $id => $definition) {`
`734`	`740`	`if ($this->trackResources && $definition->isLazy()) {`
`735`		`- $this->getReflectionClass($definition->getClass());`
	`741`	`+ $this->getReflectionClass($definition->getClass(), true);`
`736`	`742`	`}`
`737`	`743`	`}`
`738`	`744`
Original file line number	Diff line number	Diff line change
`@@ -1627,7 +1627,7 @@ private function initializeMethodNamesMap($class)`
`1627`	`1627`	`$this->serviceIdToMethodNameMap = array();`
`1628`	`1628`	`$this->usedMethodNames = array();`
`1629`	`1629`
`1630`		`- if ($reflectionClass = $this->container->getReflectionClass($class)) {`
	`1630`	`+ if ($reflectionClass = $this->container->getReflectionClass($class, true)) {`
`1631`	`1631`	`foreach ($reflectionClass->getMethods() as $method) {`
`1632`	`1632`	`$this->usedMethodNames[strtolower($method->getName())] = true;`
`1633`	`1633`	`}`
Original file line number	Diff line number	Diff line change
`@@ -79,7 +79,7 @@ public function getConfiguration(array $config, ContainerBuilder $container)`
`79`	`79`	`{`
`80`	`80`	`$class = get_class($this);`
`81`	`81`	`$class = substr_replace($class, '\Configuration', strrpos($class, '\\'));`
`82`		`- $class = $container->getReflectionClass($class);`
	`82`	`+ $class = $container->getReflectionClass($class, true);`
`83`	`83`	`$constructor = $class ? $class->getConstructor() : null;`
`84`	`84`
`85`	`85`	`if ($class && (!$constructor \|\| !$constructor->getNumberOfRequiredParameters())) {`
Original file line number	Diff line number	Diff line change
`@@ -129,7 +129,7 @@ private function findClasses($namespace, $pattern, $excludePattern)`
`129`	`129`	`continue;`
`130`	`130`	`}`
`131`	`131`	`// check to make sure the expected class exists`
`132`		`- if (!$r = $this->container->getReflectionClass($class)) {`
	`132`	`+ if (!$r = $this->container->getReflectionClass($class, true)) {`
`133`	`133`	`throw new InvalidArgumentException(sprintf('Expected to find class "%s" in file "%s" while importing services from resource "%s", but it was not found! Check the namespace prefix used with the resource.', $class, $path, $pattern));`
`134`	`134`	`}`
`135`	`135`