[DI][FrameworkBundle] Hide service ids that start with a dot

nicolas-grekas · nicolas-grekas · commit adf989d4daa9 · 2018-04-20T15:14:43.000+02:00
diff --git a/Compiler/AutowirePass.php b/Compiler/AutowirePass.php
@@ -90,7 +90,7 @@ private function doProcessValue($value, $isRoot = false)
 
             if (ContainerBuilder::RUNTIME_EXCEPTION_ON_INVALID_REFERENCE === $value->getInvalidBehavior()) {
                 // since the error message varies by referenced id and $this->currentId, so should the id of the dummy errored definition
-                $this->container->register($id = sprintf('_errored.%s.%s', $this->currentId, (string) $value), $value->getType())
+                $this->container->register($id = sprintf('.errored.%s.%s', $this->currentId, (string) $value), $value->getType())
                     ->addError($message);
 
                 return new TypedReference($id, $value->getType(), $value->getInvalidBehavior());
diff --git a/Compiler/ResolveInstanceofConditionalsPass.php b/Compiler/ResolveInstanceofConditionalsPass.php
@@ -77,8 +77,8 @@ private function processDefinition(ContainerBuilder $container, $id, Definition
             foreach ($instanceofDefs as $key => $instanceofDef) {
                 /** @var ChildDefinition $instanceofDef */
                 $instanceofDef = clone $instanceofDef;
-                $instanceofDef->setAbstract(true)->setParent($parent ?: 'abstract.instanceof.'.$id);
-                $parent = 'instanceof.'.$interface.'.'.$key.'.'.$id;
+                $instanceofDef->setAbstract(true)->setParent($parent ?: '.abstract.instanceof.'.$id);
+                $parent = '.instanceof.'.$interface.'.'.$key.'.'.$id;
                 $container->setDefinition($parent, $instanceofDef);
                 $instanceofTags[] = $instanceofDef->getTags();
                 $instanceofDef->setTags(array());
@@ -91,7 +91,7 @@ private function processDefinition(ContainerBuilder $container, $id, Definition
 
         if ($parent) {
             $bindings = $definition->getBindings();
-            $abstract = $container->setDefinition('abstract.instanceof.'.$id, $definition);
+            $abstract = $container->setDefinition('.abstract.instanceof.'.$id, $definition);
 
             // cast Definition to ChildDefinition
             $definition->setBindings(array());
diff --git a/Compiler/ResolveInvalidReferencesPass.php b/Compiler/ResolveInvalidReferencesPass.php
@@ -105,7 +105,7 @@ private function processValue($value, $rootLevel = 0, $level = 0)
                 $e = new ServiceNotFoundException($id, $this->currentId);
 
                 // since the error message varies by $id and $this->currentId, so should the id of the dummy errored definition
-                $this->container->register($id = sprintf('_errored.%s.%s', $this->currentId, $id), $value->getType())
+                $this->container->register($id = sprintf('.errored.%s.%s', $this->currentId, $id), $value->getType())
                     ->addError($e->getMessage());
 
                 return new TypedReference($id, $value->getType(), $value->getInvalidBehavior());
diff --git a/Compiler/ServiceLocatorTagPass.php b/Compiler/ServiceLocatorTagPass.php
@@ -54,7 +54,7 @@ protected function processValue($value, $isRoot = false)
 
         $value->setArguments($arguments);
 
-        $id = 'service_locator.'.ContainerBuilder::hash($value);
+        $id = '.service_locator.'.ContainerBuilder::hash($value);
 
         if ($isRoot) {
             if ($id !== $this->currentId) {
@@ -91,7 +91,7 @@ public static function register(ContainerBuilder $container, array $refMap, $cal
             ->setPublic(false)
             ->addTag('container.service_locator');
 
-        if (!$container->has($id = 'service_locator.'.ContainerBuilder::hash($locator))) {
+        if (!$container->has($id = '.service_locator.'.ContainerBuilder::hash($locator))) {
             $container->setDefinition($id, $locator);
         }
 
diff --git a/Container.php b/Container.php
@@ -262,6 +262,9 @@ private function make(string $id, int $invalidBehavior)
 
             $alternatives = array();
             foreach ($this->getServiceIds() as $knownId) {
+                if ('' === $knownId || '.' === $knownId[0]) {
+                    continue;
+                }
                 $lev = levenshtein($id, $knownId);
                 if ($lev <= strlen($id) / 3 || false !== strpos($knownId, $id)) {
                     $alternatives[] = $knownId;
diff --git a/Loader/Configurator/ServicesConfigurator.php b/Loader/Configurator/ServicesConfigurator.php
@@ -79,7 +79,7 @@ final public function set(?string $id, string $class = null): ServiceConfigurato
                 throw new \LogicException('Anonymous services must have a class name.');
             }
 
-            $id = sprintf('%d_%s', ++$this->anonymousCount, preg_replace('/^.*\\\\/', '', $class).'~'.$this->anonymousHash);
+            $id = sprintf('.%d_%s', ++$this->anonymousCount, preg_replace('/^.*\\\\/', '', $class).'~'.$this->anonymousHash);
             $definition->setPublic(false);
         } else {
             $definition->setPublic($defaults->isPublic());
diff --git a/Loader/XmlFileLoader.php b/Loader/XmlFileLoader.php
@@ -408,7 +408,7 @@ private function processAnonymousServices(\DOMDocument $xml, $file, $defaults)
             foreach ($nodes as $node) {
                 if ($services = $this->getChildren($node, 'service')) {
                     // give it a unique name
-                    $id = sprintf('%d_%s', ++$count, preg_replace('/^.*\\\\/', '', $services[0]->getAttribute('class')).'~'.$suffix);
+                    $id = sprintf('.%d_%s', ++$count, preg_replace('/^.*\\\\/', '', $services[0]->getAttribute('class')).'~'.$suffix);
                     $node->setAttribute('id', $id);
                     $node->setAttribute('service', $id);
 
diff --git a/Loader/YamlFileLoader.php b/Loader/YamlFileLoader.php
@@ -707,7 +707,7 @@ private function resolveServices($value, $file, $isParameter = false)
                 $instanceof = $this->instanceof;
                 $this->instanceof = array();
 
-                $id = sprintf('%d_%s', ++$this->anonymousServicesCount, preg_replace('/^.*\\\\/', '', isset($argument['class']) ? $argument['class'] : '').$this->anonymousServicesSuffix);
+                $id = sprintf('.%d_%s', ++$this->anonymousServicesCount, preg_replace('/^.*\\\\/', '', isset($argument['class']) ? $argument['class'] : '').$this->anonymousServicesSuffix);
                 $this->parseDefinition($id, $argument, $file, array());
 
                 if (!$this->container->hasDefinition($id)) {
diff --git a/Tests/Compiler/AutowirePassTest.php b/Tests/Compiler/AutowirePassTest.php
@@ -862,6 +862,6 @@ public function testErroredServiceLocator()
 
         $erroredDefinition = new Definition(MissingClass::class);
 
-        $this->assertEquals($erroredDefinition->addError('Cannot autowire service "some_locator": it has type "Symfony\Component\DependencyInjection\Tests\Compiler\MissingClass" but this class was not found.'), $container->getDefinition('_errored.some_locator.'.MissingClass::class));
+        $this->assertEquals($erroredDefinition->addError('Cannot autowire service "some_locator": it has type "Symfony\Component\DependencyInjection\Tests\Compiler\MissingClass" but this class was not found.'), $container->getDefinition('.errored.some_locator.'.MissingClass::class));
     }
 }
diff --git a/Tests/Compiler/ResolveInstanceofConditionalsPassTest.php b/Tests/Compiler/ResolveInstanceofConditionalsPassTest.php
@@ -29,7 +29,7 @@ public function testProcess()
 
         (new ResolveInstanceofConditionalsPass())->process($container);
 
-        $parent = 'instanceof.'.parent::class.'.0.foo';
+        $parent = '.instanceof.'.parent::class.'.0.foo';
         $def = $container->getDefinition('foo');
         $this->assertEmpty($def->getInstanceofConditionals());
         $this->assertInstanceOf(ChildDefinition::class, $def);
@@ -242,7 +242,7 @@ public function testMergeReset()
 
         (new ResolveInstanceofConditionalsPass())->process($container);
 
-        $abstract = $container->getDefinition('abstract.instanceof.bar');
+        $abstract = $container->getDefinition('.abstract.instanceof.bar');
 
         $this->assertEmpty($abstract->getArguments());
         $this->assertEmpty($abstract->getMethodCalls());
diff --git a/Tests/Fixtures/config/anonymous.expected.yml b/Tests/Fixtures/config/anonymous.expected.yml
@@ -8,7 +8,7 @@ services:
         class: Bar\FooClass
         public: true
         arguments: [!tagged listener]
-    2_stdClass~%s:
+    .2_stdClass~%s:
         class: stdClass
         public: false
         tags:
diff --git a/Tests/Fixtures/php/services_subscriber.php b/Tests/Fixtures/php/services_subscriber.php
@@ -54,11 +54,11 @@ public function isCompiled()
     public function getRemovedIds()
     {
         return array(
+            '.service_locator.ljJrY4L' => true,
+            '.service_locator.ljJrY4L.foo_service' => true,
             'Psr\\Container\\ContainerInterface' => true,
             'Symfony\\Component\\DependencyInjection\\ContainerInterface' => true,
             'Symfony\\Component\\DependencyInjection\\Tests\\Fixtures\\CustomDefinition' => true,
-            'service_locator.ljJrY4L' => true,
-            'service_locator.ljJrY4L.foo_service' => true,
         );
     }
 
diff --git a/Tests/Loader/YamlFileLoaderTest.php b/Tests/Loader/YamlFileLoaderTest.php
@@ -555,7 +555,7 @@ public function testAnonymousServices()
         $this->assertCount(1, $args);
         $this->assertInstanceOf(Reference::class, $args[0]);
         $this->assertTrue($container->has((string) $args[0]));
-        $this->assertRegExp('/^\d+_Bar[._A-Za-z0-9]{7}$/', (string) $args[0]);
+        $this->assertRegExp('/^\.\d+_Bar[._A-Za-z0-9]{7}$/', (string) $args[0]);
 
         $anonymous = $container->getDefinition((string) $args[0]);
         $this->assertEquals('Bar', $anonymous->getClass());
@@ -567,7 +567,7 @@ public function testAnonymousServices()
         $this->assertInternalType('array', $factory);
         $this->assertInstanceOf(Reference::class, $factory[0]);
         $this->assertTrue($container->has((string) $factory[0]));
-        $this->assertRegExp('/^\d+_Quz[._A-Za-z0-9]{7}$/', (string) $factory[0]);
+        $this->assertRegExp('/^\.\d+_Quz[._A-Za-z0-9]{7}$/', (string) $factory[0]);
         $this->assertEquals('constructFoo', $factory[1]);
 
         $anonymous = $container->getDefinition((string) $factory[0]);

Original file line number	Diff line number	Diff line change
`@@ -79,7 +79,7 @@ final public function set(?string $id, string $class = null): ServiceConfigurato`
`79`	`79`	`throw new \LogicException('Anonymous services must have a class name.');`
`80`	`80`	`}`
`81`	`81`
`82`		`- $id = sprintf('%d_%s', ++$this->anonymousCount, preg_replace('/^.*\\\\/', '', $class).'~'.$this->anonymousHash);`
	`82`	`+ $id = sprintf('.%d_%s', ++$this->anonymousCount, preg_replace('/^.*\\\\/', '', $class).'~'.$this->anonymousHash);`
`83`	`83`	`$definition->setPublic(false);`
`84`	`84`	`} else {`
`85`	`85`	`$definition->setPublic($defaults->isPublic());`
Original file line number	Diff line number	Diff line change
`@@ -862,6 +862,6 @@ public function testErroredServiceLocator()`
`862`	`862`
`863`	`863`	`$erroredDefinition = new Definition(MissingClass::class);`
`864`	`864`
`865`		`- $this->assertEquals($erroredDefinition->addError('Cannot autowire service "some_locator": it has type "Symfony\Component\DependencyInjection\Tests\Compiler\MissingClass" but this class was not found.'), $container->getDefinition('_errored.some_locator.'.MissingClass::class));`
	`865`	`+ $this->assertEquals($erroredDefinition->addError('Cannot autowire service "some_locator": it has type "Symfony\Component\DependencyInjection\Tests\Compiler\MissingClass" but this class was not found.'), $container->getDefinition('.errored.some_locator.'.MissingClass::class));`
`866`	`866`	`}`
`867`	`867`	`}`