minor symfony#28367 [DI] Forward Container::reset() to services implementing ResetInterface (nicolas-grekas)

This PR was merged into the 4.2-dev branch.

Discussion
----------

[DI] Forward Container::reset() to services implementing ResetInterface

| Q             | A
| ------------- | ---
| Branch?       | master
| Bug fix?      | no
| New feature?  | not really
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | -
| License       | MIT
| Doc PR        | -

Should help the garbage collector during tests.

Commits
-------

5d26ba1 [DI] Forward Container::reset() to services implementing ResetInterface

Author: fabpot

src/Symfony/Component/DependencyInjection/Container.php

@@ -20,6 +20,7 @@
 use Symfony\Component\DependencyInjection\ParameterBag\EnvPlaceholderParameterBag;
 use Symfony\Component\DependencyInjection\ParameterBag\FrozenParameterBag;
 use Symfony\Component\DependencyInjection\ParameterBag\ParameterBagInterface;
+use Symfony\Contracts\Service\ResetInterface;
 
 /**
  * Container is a dependency injection container.
@@ -42,6 +43,7 @@ class Container implements ResettableContainerInterface
 {
     protected $parameterBag;
     protected $services = array();
+    protected $privates = array();
     protected $fileMap = array();
     protected $methodMap = array();
     protected $factories = array();
@@ -301,7 +303,18 @@ public function initialized($id)
      */
     public function reset()
     {
-        $this->services = $this->factories = array();
+        $services = $this->services + $this->privates;
+        $this->services = $this->factories = $this->privates = array();
+
+        foreach ($services as $service) {
+            try {
+                if ($service instanceof ResetInterface) {
+                    $service->reset();
+                }
+            } catch (\Throwable $e) {
+                continue;
+            }
+        }
     }
 
     /**

src/Symfony/Component/DependencyInjection/Dumper/PhpDumper.php

@@ -960,11 +960,6 @@ class $class extends $baseClass
     private \$parameters;
     private \$targetDirs = array();
 
-    /*{$this->docStar}
-     * @internal but protected for BC on cache:clear
-     */
-    protected \$privates = array();
-
     public function __construct()
     {
 
@@ -1011,12 +1006,6 @@ public function __construct()
         $code .= <<<EOF
     }
 
-    public function reset()
-    {
-        \$this->privates = array();
-        parent::reset();
-    }
-
     public function compile()
     {
         throw new LogicException('You cannot compile a dumped container that was already compiled.');

src/Symfony/Component/DependencyInjection/Tests/ContainerTest.php

@@ -17,6 +17,7 @@
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\DependencyInjection\ParameterBag\FrozenParameterBag;
 use Symfony\Component\DependencyInjection\ParameterBag\ParameterBag;
+use Symfony\Contracts\Service\ResetInterface;
 
 class ContainerTest extends TestCase
 {
@@ -317,11 +318,19 @@ public function testInitializedWithPrivateService()
     public function testReset()
     {
         $c = new Container();
-        $c->set('bar', new \stdClass());
+        $c->set('bar', $bar = new class() implements ResetInterface {
+            public $resetCounter = 0;
+
+            public function reset()
+            {
+                ++$this->resetCounter;
+            }
+        });
 
         $c->reset();
 
         $this->assertNull($c->get('bar', ContainerInterface::NULL_ON_INVALID_REFERENCE));
+        $this->assertSame(1, $bar->resetCounter);
     }
 
     /**

src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/custom_container_class_constructor_without_arguments.php

@@ -21,11 +21,6 @@ class ProjectServiceContainer extends \Symfony\Component\DependencyInjection\Tes
     private $parameters;
     private $targetDirs = array();
 
-    /**
-     * @internal but protected for BC on cache:clear
-     */
-    protected $privates = array();
-
     public function __construct()
     {
         parent::__construct();
@@ -36,12 +31,6 @@ public function __construct()
         $this->aliases = array();
     }
 
-    public function reset()
-    {
-        $this->privates = array();
-        parent::reset();
-    }
-
     public function compile()
     {
         throw new LogicException('You cannot compile a dumped container that was already compiled.');

src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/custom_container_class_with_mandatory_constructor_arguments.php

@@ -21,24 +21,13 @@ class ProjectServiceContainer extends \Symfony\Component\DependencyInjection\Tes
     private $parameters;
     private $targetDirs = array();
 
-    /**
-     * @internal but protected for BC on cache:clear
-     */
-    protected $privates = array();
-
     public function __construct()
     {
         $this->services = $this->privates = array();
 
         $this->aliases = array();
     }
 
-    public function reset()
-    {
-        $this->privates = array();
-        parent::reset();
-    }
-
     public function compile()
     {
         throw new LogicException('You cannot compile a dumped container that was already compiled.');

src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/custom_container_class_with_optional_constructor_arguments.php

@@ -21,11 +21,6 @@ class ProjectServiceContainer extends \Symfony\Component\DependencyInjection\Tes
     private $parameters;
     private $targetDirs = array();
 
-    /**
-     * @internal but protected for BC on cache:clear
-     */
-    protected $privates = array();
-
     public function __construct()
     {
         parent::__construct();
@@ -36,12 +31,6 @@ public function __construct()
         $this->aliases = array();
     }
 
-    public function reset()
-    {
-        $this->privates = array();
-        parent::reset();
-    }
-
     public function compile()
     {
         throw new LogicException('You cannot compile a dumped container that was already compiled.');

src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/custom_container_class_without_constructor.php

@@ -21,24 +21,13 @@ class ProjectServiceContainer extends \Symfony\Component\DependencyInjection\Tes
     private $parameters;
     private $targetDirs = array();
 
-    /**
-     * @internal but protected for BC on cache:clear
-     */
-    protected $privates = array();
-
     public function __construct()
     {
         $this->services = $this->privates = array();
 
         $this->aliases = array();
     }
 
-    public function reset()
-    {
-        $this->privates = array();
-        parent::reset();
-    }
-
     public function compile()
     {
         throw new LogicException('You cannot compile a dumped container that was already compiled.');

src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services1-1.php

@@ -21,24 +21,13 @@ class Container extends \Symfony\Component\DependencyInjection\Dump\AbstractCont
     private $parameters;
     private $targetDirs = array();
 
-    /**
-     * @internal but protected for BC on cache:clear
-     */
-    protected $privates = array();
-
     public function __construct()
     {
         $this->services = $this->privates = array();
 
         $this->aliases = array();
     }
 
-    public function reset()
-    {
-        $this->privates = array();
-        parent::reset();
-    }
-
     public function compile()
     {
         throw new LogicException('You cannot compile a dumped container that was already compiled.');

src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services1.php

@@ -19,24 +19,13 @@ class ProjectServiceContainer extends Container
     private $parameters;
     private $targetDirs = array();
 
-    /**
-     * @internal but protected for BC on cache:clear
-     */
-    protected $privates = array();
-
     public function __construct()
     {
         $this->services = $this->privates = array();
 
         $this->aliases = array();
     }
 
-    public function reset()
-    {
-        $this->privates = array();
-        parent::reset();
-    }
-
     public function compile()
     {
         throw new LogicException('You cannot compile a dumped container that was already compiled.');

src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services10.php

@@ -19,11 +19,6 @@ class ProjectServiceContainer extends Container
     private $parameters;
     private $targetDirs = array();
 
-    /**
-     * @internal but protected for BC on cache:clear
-     */
-    protected $privates = array();
-
     public function __construct()
     {
         $this->parameters = $this->getDefaultParameters();
@@ -36,12 +31,6 @@ public function __construct()
         $this->aliases = array();
     }
 
-    public function reset()
-    {
-        $this->privates = array();
-        parent::reset();
-    }
-
     public function compile()
     {
         throw new LogicException('You cannot compile a dumped container that was already compiled.');