bug #25255 [Console][DI] Fail gracefully (nicolas-grekas)

This PR was merged into the 3.4 branch.

Discussion
----------

[Console][DI] Fail gracefully

| Q             | A
| ------------- | ---
| Branch?       | 3.4
| Bug fix?      | yes
| New feature?  | no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | symfony/flex#212, #25280
| License       | MIT
| Doc PR        | -

I already experienced this issue a few times without spending time digging it:
sometimes, you call `cache:clear`, and the command quits without any output, and with 255 status code.

The reason is the `@include` in `Kernel`, which makes everything silent, especially fatal errors (thanks PHP...)
So if the to-be-removed container is broken for some fatal reason, the failure is really bad.

To fix that, here are two measures:
- use `include_once` instead of `require_once` in the dumped container: that's OK there to actually not immediately load the file, any hard failure will happen later anyway, and any soft failure will allow the `cache:clear` command to complete (like when you remove a package)
- register `Application::renderException()` as the main PHP exception handler, via `Debug::ErrorHandler` when it's available

End result when it fails:
![image](https://user-images.githubusercontent.com/243674/33494543-e1d07202-d6c3-11e7-9677-bc2ae72fbba9.png)

instead of a blank output.

Commits
-------

4a5a3f52ab [Console][DI] Fail gracefully

Author: fabpot

Dumper/PhpDumper.php

@@ -217,12 +217,16 @@ public function dump(array $options = array())
 {$namespaceLine}
 // This file has been auto-generated by the Symfony Dependency Injection Component for internal use.
 
-if (!class_exists(\\Container{$hash}\\{$options['class']}::class, false)) {
-    require __DIR__.'/Container{$hash}/{$options['class']}.php';
+if (\\class_exists(\\Container{$hash}\\{$options['class']}::class, false)) {
+    // no-op
+} elseif (!include __DIR__.'/Container{$hash}/{$options['class']}.php') {
+    touch(__DIR__.'/Container{$hash}.legacy');
+
+    return;
 }
 
-if (!class_exists({$options['class']}::class, false)) {
-    class_alias(\\Container{$hash}\\{$options['class']}::class, {$options['class']}::class, false);
+if (!\\class_exists({$options['class']}::class, false)) {
+    \\class_alias(\\Container{$hash}\\{$options['class']}::class, {$options['class']}::class, false);
 }
 
 return new \\Container{$hash}\\{$options['class']}();
@@ -428,13 +432,13 @@ private function addServiceInclude($cId, Definition $definition, \SplObjectStora
             }
 
             foreach (array_diff_key(array_flip($lineage), $this->inlinedRequires) as $file => $class) {
-                $code .= sprintf("        require_once %s;\n", $file);
+                $code .= sprintf("        include_once %s;\n", $file);
             }
         }
 
         foreach ($inlinedDefinitions as $def) {
             if ($file = $def->getFile()) {
-                $code .= sprintf("        require_once %s;\n", $this->dumpValue($file));
+                $code .= sprintf("        include_once %s;\n", $this->dumpValue($file));
             }
         }
 
@@ -1233,7 +1237,7 @@ private function addInlineRequires()
         foreach ($lineage as $file) {
             if (!isset($this->inlinedRequires[$file])) {
                 $this->inlinedRequires[$file] = true;
-                $code .= sprintf("        require_once %s;\n", $file);
+                $code .= sprintf("        include_once %s;\n", $file);
             }
         }
 

Tests/Fixtures/php/services9.php

@@ -297,7 +297,7 @@ protected function getLazyContextIgnoreInvalidRefService()
      */
     protected function getMethodCall1Service()
     {
-        require_once '%path%foo.php';
+        include_once '%path%foo.php';
 
         $this->services['method_call1'] = $instance = new \Bar\FooClass();
 

Tests/Fixtures/php/services9_as_files.txt

@@ -200,7 +200,7 @@ use Symfony\Component\DependencyInjection\Argument\RewindableGenerator;
 // This file has been auto-generated by the Symfony Dependency Injection Component for internal use.
 // Returns the public 'method_call1' shared service.
 
-require_once ($this->targetDirs[0].'/Fixtures/includes/foo.php');
+include_once ($this->targetDirs[0].'/Fixtures/includes/foo.php');
 
 $this->services['method_call1'] = $instance = new \Bar\FooClass();
 
@@ -473,12 +473,16 @@ class ProjectServiceContainer extends Container
 
 // This file has been auto-generated by the Symfony Dependency Injection Component for internal use.
 
-if (!class_exists(\Container%s\ProjectServiceContainer::class, false)) {
-    require __DIR__.'/Container%s/ProjectServiceContainer.php';
+if (\class_exists(\Container%s\ProjectServiceContainer::class, false)) {
+    // no-op
+} elseif (!include __DIR__.'/Container%s/ProjectServiceContainer.php') {
+    touch(__DIR__.'/Container%s.legacy');
+
+    return;
 }
 
-if (!class_exists(ProjectServiceContainer::class, false)) {
-    class_alias(\Container%s\ProjectServiceContainer::class, ProjectServiceContainer::class, false);
+if (!\class_exists(ProjectServiceContainer::class, false)) {
+    \class_alias(\Container%s\ProjectServiceContainer::class, ProjectServiceContainer::class, false);
 }
 
 return new \Container%s\ProjectServiceContainer();

Tests/Fixtures/php/services9_compiled.php

@@ -309,7 +309,7 @@ protected function getLazyContextIgnoreInvalidRefService()
      */
     protected function getMethodCall1Service()
     {
-        require_once '%path%foo.php';
+        include_once '%path%foo.php';
 
         $this->services['method_call1'] = $instance = new \Bar\FooClass();
 

Tests/Fixtures/php/services_inline_requires.php

@@ -46,10 +46,10 @@ public function __construct()
 
         $this->aliases = array();
 
-        require_once $this->targetDirs[1].'/includes/HotPath/I1.php';
-        require_once $this->targetDirs[1].'/includes/HotPath/P1.php';
-        require_once $this->targetDirs[1].'/includes/HotPath/T1.php';
-        require_once $this->targetDirs[1].'/includes/HotPath/C1.php';
+        include_once $this->targetDirs[1].'/includes/HotPath/I1.php';
+        include_once $this->targetDirs[1].'/includes/HotPath/P1.php';
+        include_once $this->targetDirs[1].'/includes/HotPath/T1.php';
+        include_once $this->targetDirs[1].'/includes/HotPath/C1.php';
     }
 
     public function getRemovedIds()
@@ -105,8 +105,8 @@ protected function getC1Service()
      */
     protected function getC2Service()
     {
-        require_once $this->targetDirs[1].'/includes/HotPath/C2.php';
-        require_once $this->targetDirs[1].'/includes/HotPath/C3.php';
+        include_once $this->targetDirs[1].'/includes/HotPath/C2.php';
+        include_once $this->targetDirs[1].'/includes/HotPath/C3.php';
 
         return $this->services['Symfony\Component\DependencyInjection\Tests\Fixtures\includes\HotPath\C2'] = new \Symfony\Component\DependencyInjection\Tests\Fixtures\includes\HotPath\C2(${($_ = isset($this->services['Symfony\Component\DependencyInjection\Tests\Fixtures\includes\HotPath\C3']) ? $this->services['Symfony\Component\DependencyInjection\Tests\Fixtures\includes\HotPath\C3'] : $this->services['Symfony\Component\DependencyInjection\Tests\Fixtures\includes\HotPath\C3'] = new \Symfony\Component\DependencyInjection\Tests\Fixtures\includes\HotPath\C3()) && false ?: '_'});
     }
@@ -118,7 +118,7 @@ protected function getC2Service()
      */
     protected function getC3Service()
     {
-        require_once $this->targetDirs[1].'/includes/HotPath/C3.php';
+        include_once $this->targetDirs[1].'/includes/HotPath/C3.php';
 
         return $this->services['Symfony\Component\DependencyInjection\Tests\Fixtures\includes\HotPath\C3'] = new \Symfony\Component\DependencyInjection\Tests\Fixtures\includes\HotPath\C3();
     }