bug #24418 [DI] Allow setting any public non-initialized services (nicolas-grekas)

This PR was merged into the 3.3 branch.

Discussion
----------

[DI] Allow setting any public non-initialized services

| Q             | A
| ------------- | ---
| Branch?       | 3.3
| Bug fix?      | yes
| New feature?  | no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | #23311, #23772
| License       | MIT
| Doc PR        | -

I think we went a but too far with this deprecation and that we should relax the rule: setting a pre-defined service is OK *if* it has not already been initialized.
This will allow setting them in test cases, as reported several times (see linked issues).

Commits
-------

d314b1f [DI] Allow setting any public non-initialized services
This commit is contained in:
Nicolas Grekas 2017-10-04 13:52:46 +02:00
commit b7f1daabed
3 changed files with 27 additions and 9 deletions

View File

@ -190,6 +190,7 @@ class Container implements ResettableContainerInterface
unset($this->aliases[$id]); unset($this->aliases[$id]);
} }
$wasSet = isset($this->services[$id]);
$this->services[$id] = $service; $this->services[$id] = $service;
if (null === $service) { if (null === $service) {
@ -203,11 +204,11 @@ class Container implements ResettableContainerInterface
} else { } else {
@trigger_error(sprintf('Setting the "%s" private service is deprecated since Symfony 3.2 and won\'t be supported anymore in Symfony 4.0.', $id), E_USER_DEPRECATED); @trigger_error(sprintf('Setting the "%s" private service is deprecated since Symfony 3.2 and won\'t be supported anymore in Symfony 4.0.', $id), E_USER_DEPRECATED);
} }
} elseif (isset($this->methodMap[$id])) { } elseif ($wasSet && isset($this->methodMap[$id])) {
if (null === $service) { if (null === $service) {
@trigger_error(sprintf('Unsetting the "%s" pre-defined service is deprecated since Symfony 3.3 and won\'t be supported anymore in Symfony 4.0.', $id), E_USER_DEPRECATED); @trigger_error(sprintf('Unsetting the "%s" service after it\'s been initialized is deprecated since Symfony 3.3 and won\'t be supported anymore in Symfony 4.0.', $id), E_USER_DEPRECATED);
} else { } else {
@trigger_error(sprintf('Setting the "%s" pre-defined service is deprecated since Symfony 3.3 and won\'t be supported anymore in Symfony 4.0.', $id), E_USER_DEPRECATED); @trigger_error(sprintf('Setting the "%s" service after it\'s been initialized is deprecated since Symfony 3.3 and won\'t be supported anymore in Symfony 4.0.', $id), E_USER_DEPRECATED);
} }
} }
} }

View File

@ -186,15 +186,29 @@ class ContainerTest extends TestCase
/** /**
* @group legacy * @group legacy
* @expectedDeprecation Unsetting the "bar" pre-defined service is deprecated since Symfony 3.3 and won't be supported anymore in Symfony 4.0. * @expectedDeprecation Unsetting the "bar" service after it's been initialized is deprecated since Symfony 3.3 and won't be supported anymore in Symfony 4.0.
*/ */
public function testSetWithNullResetPredefinedService() public function testSetWithNullOnInitializedPredefinedService()
{ {
$sc = new Container(); $sc = new Container();
$sc->set('foo', new \stdClass()); $sc->set('foo', new \stdClass());
$sc->set('foo', null); $sc->set('foo', null);
$this->assertFalse($sc->has('foo'), '->set() with null service resets the service'); $this->assertFalse($sc->has('foo'), '->set() with null service resets the service');
$sc = new ProjectServiceContainer();
$sc->get('bar');
$sc->set('bar', null);
$this->assertTrue($sc->has('bar'), '->set() with null service resets the pre-defined service');
}
public function testSetWithNullOnUninitializedPredefinedService()
{
$sc = new Container();
$sc->set('foo', new \stdClass());
$sc->get('foo', null);
$sc->set('foo', null);
$this->assertFalse($sc->has('foo'), '->set() with null service resets the service');
$sc = new ProjectServiceContainer(); $sc = new ProjectServiceContainer();
$sc->set('bar', null); $sc->set('bar', null);
$this->assertTrue($sc->has('bar'), '->set() with null service resets the pre-defined service'); $this->assertTrue($sc->has('bar'), '->set() with null service resets the pre-defined service');
@ -481,7 +495,7 @@ class ContainerTest extends TestCase
/** /**
* @group legacy * @group legacy
* @expectedDeprecation Setting the "bar" pre-defined service is deprecated since Symfony 3.3 and won't be supported anymore in Symfony 4.0. * @expectedDeprecation Setting the "bar" service after it's been initialized is deprecated since Symfony 3.3 and won't be supported anymore in Symfony 4.0.
*/ */
public function testReplacingAPreDefinedServiceIsDeprecated() public function testReplacingAPreDefinedServiceIsDeprecated()
{ {

View File

@ -269,7 +269,7 @@ class PhpDumperTest extends TestCase
/** /**
* @group legacy * @group legacy
* @expectedDeprecation Setting the "bar" pre-defined service is deprecated since Symfony 3.3 and won't be supported anymore in Symfony 4.0. * @expectedDeprecation Setting the "bar" service after it's been initialized is deprecated since Symfony 3.3 and won't be supported anymore in Symfony 4.0.
*/ */
public function testOverrideServiceWhenUsingADumpedContainer() public function testOverrideServiceWhenUsingADumpedContainer()
{ {
@ -277,15 +277,16 @@ class PhpDumperTest extends TestCase
require_once self::$fixturesPath.'/includes/foo.php'; require_once self::$fixturesPath.'/includes/foo.php';
$container = new \ProjectServiceContainer(); $container = new \ProjectServiceContainer();
$container->set('bar', $bar = new \stdClass());
$container->setParameter('foo_bar', 'foo_bar'); $container->setParameter('foo_bar', 'foo_bar');
$container->get('bar');
$container->set('bar', $bar = new \stdClass());
$this->assertSame($bar, $container->get('bar'), '->set() overrides an already defined service'); $this->assertSame($bar, $container->get('bar'), '->set() overrides an already defined service');
} }
/** /**
* @group legacy * @group legacy
* @expectedDeprecation Setting the "bar" pre-defined service is deprecated since Symfony 3.3 and won't be supported anymore in Symfony 4.0. * @expectedDeprecation Setting the "bar" service after it's been initialized is deprecated since Symfony 3.3 and won't be supported anymore in Symfony 4.0.
*/ */
public function testOverrideServiceWhenUsingADumpedContainerAndServiceIsUsedFromAnotherOne() public function testOverrideServiceWhenUsingADumpedContainerAndServiceIsUsedFromAnotherOne()
{ {
@ -294,6 +295,8 @@ class PhpDumperTest extends TestCase
require_once self::$fixturesPath.'/includes/classes.php'; require_once self::$fixturesPath.'/includes/classes.php';
$container = new \ProjectServiceContainer(); $container = new \ProjectServiceContainer();
$container->setParameter('foo_bar', 'foo_bar');
$container->get('bar');
$container->set('bar', $bar = new \stdClass()); $container->set('bar', $bar = new \stdClass());
$this->assertSame($bar, $container->get('foo')->bar, '->set() overrides an already defined service'); $this->assertSame($bar, $container->get('foo')->bar, '->set() overrides an already defined service');