feature #18547 DX: better error message if factory class is empty (dbu)

nicolas-grekas · nicolas-grekas · commit 2824db3da80a · 2016-04-18T14:53:30.000+02:00
This PR was merged into the 3.1-dev branch. Discussion ---------- DX: better error message if factory class is empty | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | ? | Fixed tickets | - | License | MIT | Doc PR | - i was trying to debug this service configuration: ```xml <service id="repository.user" class="Doctrine\ORM\EntityRepository"> <argument>%user_entity_class%</argument> <factory id="doctrine.orm.default_entity_manager" method="getRepository"/> </service> ``` Turns out i should have used `<factory service=...` instead of `<factory id=...` but the error message does not even tell which service is wrong. The same happens when only specifying the `method=` attribute. The current exception message tells: Cannot dump definition because of invalid class name ('') With this change, the message at least tells the context, hopefully helping the developer debug the issue: Empty class for factory of service repository.user and no factory service specified Commits ------- 0999326 better error message if factory class is empty
diff --git a/src/Symfony/Component/DependencyInjection/Dumper/PhpDumper.php b/src/Symfony/Component/DependencyInjection/Dumper/PhpDumper.php
@@ -330,7 +330,7 @@ private function addServiceInlinedDefinitions($id, $definition)
                     throw new ServiceCircularReferenceException($id, array($id));
                 }
 
-                $code .= $this->addNewInstance($sDefinition, '$'.$name, ' = ');
+                $code .= $this->addNewInstance($sDefinition, '$'.$name, ' = ', $id);
 
                 if (!$this->hasReference($id, $sDefinition->getMethodCalls(), true) && !$this->hasReference($id, $sDefinition->getProperties(), true)) {
                     $code .= $this->addServiceMethodCalls(null, $sDefinition, $name);
@@ -404,7 +404,7 @@ private function addServiceInstance($id, $definition)
             $instantiation .= ' = ';
         }
 
-        $code = $this->addNewInstance($definition, $return, $instantiation);
+        $code = $this->addNewInstance($definition, $return, $instantiation, $id);
 
         if (!$simple) {
             $code .= "\n";
@@ -692,7 +692,7 @@ private function addServices()
         return $publicServices.$privateServices;
     }
 
-    private function addNewInstance(Definition $definition, $return, $instantiation)
+    private function addNewInstance(Definition $definition, $return, $instantiation, $id)
     {
         $class = $this->dumpValue($definition->getClass());
 
@@ -716,6 +716,10 @@ private function addNewInstance(Definition $definition, $return, $instantiation)
                 $class = $this->dumpValue($callable[0]);
                 // If the class is a string we can optimize call_user_func away
                 if (strpos($class, "'") === 0) {
+                    if ("''" === $class) {
+                        throw new RuntimeException(sprintf('Cannot dump definition: The "%s" service is defined to be created by a factory but is missing the service reference, did you forget to define the factory service id or class?', $id));
+                    }
+
                     return sprintf("        $return{$instantiation}%s::%s(%s);\n", $this->dumpLiteralClass($class), $callable[1], $arguments ? implode(', ', $arguments) : '');
                 }
 

Original file line number	Diff line number	Diff line change
`@@ -330,7 +330,7 @@ private function addServiceInlinedDefinitions($id, $definition)`
`330`	`330`	`throw new ServiceCircularReferenceException($id, array($id));`
`331`	`331`	`}`
`332`	`332`
`333`		`- $code .= $this->addNewInstance($sDefinition, '$'.$name, ' = ');`
	`333`	`+ $code .= $this->addNewInstance($sDefinition, '$'.$name, ' = ', $id);`
`334`	`334`
`335`	`335`	`if (!$this->hasReference($id, $sDefinition->getMethodCalls(), true) && !$this->hasReference($id, $sDefinition->getProperties(), true)) {`
`336`	`336`	`$code .= $this->addServiceMethodCalls(null, $sDefinition, $name);`
`@@ -404,7 +404,7 @@ private function addServiceInstance($id, $definition)`
`404`	`404`	`$instantiation .= ' = ';`
`405`	`405`	`}`
`406`	`406`
`407`		`- $code = $this->addNewInstance($definition, $return, $instantiation);`
	`407`	`+ $code = $this->addNewInstance($definition, $return, $instantiation, $id);`
`408`	`408`
`409`	`409`	`if (!$simple) {`
`410`	`410`	`$code .= "\n";`
`@@ -692,7 +692,7 @@ private function addServices()`
`692`	`692`	`return $publicServices.$privateServices;`
`693`	`693`	`}`
`694`	`694`
`695`		`- private function addNewInstance(Definition $definition, $return, $instantiation)`
	`695`	`+ private function addNewInstance(Definition $definition, $return, $instantiation, $id)`
`696`	`696`	`{`
`697`	`697`	`$class = $this->dumpValue($definition->getClass());`
`698`	`698`
`@@ -716,6 +716,10 @@ private function addNewInstance(Definition $definition, $return, $instantiation)`
`716`	`716`	`$class = $this->dumpValue($callable[0]);`
`717`	`717`	`// If the class is a string we can optimize call_user_func away`
`718`	`718`	`if (strpos($class, "'") === 0) {`
	`719`	`+ if ("''" === $class) {`
	`720`	`+ throw new RuntimeException(sprintf('Cannot dump definition: The "%s" service is defined to be created by a factory but is missing the service reference, did you forget to define the factory service id or class?', $id));`
	`721`	`+ }`
	`722`	`+`
`719`	`723`	`return sprintf(" $return{$instantiation}%s::%s(%s);\n", $this->dumpLiteralClass($class), $callable[1], $arguments ? implode(', ', $arguments) : '');`
`720`	`724`	`}`
`721`	`725`