bug symfony#28182 [DI] Fix dumping service locators (nicolas-grekas)

This PR was merged into the 4.2-dev branch.

Discussion
----------

[DI] Fix dumping service locators

| Q             | A
| ------------- | ---
| Branch?       | master
| Bug fix?      | yes (master only)
| New feature?  | no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | symfony#28180
| License       | MIT
| Doc PR        | -

Services need to be visited to populate `$this->loadedIds` before using the property decide what needs to be dumped or not.

Commits
-------

e17f650 [DI] Fix dumping service locators

Author: nicolas-grekas

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

@@ -207,7 +207,7 @@ public function dump(array $options = array())
 
         $code =
             $this->startClass($options['class'], $baseClass, $baseClassWithNamespace).
-            $this->addServices().
+            $this->addServices($services).
             $this->addDefaultParametersMethod()
         ;
 
@@ -238,7 +238,7 @@ public function dump(array $options = array())
                 $files['removed-ids.php'] = $c .= ");\n";
             }
 
-            foreach ($this->generateServiceFiles() as $file => $c) {
+            foreach ($this->generateServiceFiles($services) as $file => $c) {
                 $files[$file] = $fileStart.$c;
             }
             foreach ($this->generateProxyClasses() as $file => $c) {
@@ -708,7 +708,7 @@ private function addServiceConfigurator(Definition $definition, string $variable
         return sprintf("        %s(\$%s);\n", $callable, $variableName);
     }
 
-    private function addService(string $id, Definition $definition, string &$file = null): string
+    private function addService(string $id, Definition $definition): array
     {
         $this->definitionVariables = new \SplObjectStorage();
         $this->referenceVariables = array();
@@ -759,6 +759,7 @@ private function addService(string $id, Definition $definition, string &$file =
             $file = $methodName.'.php';
             $code = "        // Returns the $public '$id'$shared$autowired service.\n\n";
         } else {
+            $file = null;
             $code = <<<EOF
 
     /*{$this->docStar}
@@ -825,36 +826,38 @@ protected function {$methodName}($lazyInitialization)
         $this->definitionVariables = null;
         $this->referenceVariables = null;
 
-        return $code;
+        return array($file, $code);
     }
 
-    private function addServices(): string
+    private function addServices(array &$services = null): string
     {
         $publicServices = $privateServices = '';
         $definitions = $this->container->getDefinitions();
         ksort($definitions);
         foreach ($definitions as $id => $definition) {
-            if ($definition->isSynthetic() || ($this->asFiles && !$this->isHotPath($definition))) {
+            $services[$id] = $definition->isSynthetic() ? null : $this->addService($id, $definition);
+        }
+
+        foreach ($definitions as $id => $definition) {
+            if (!(list($file, $code) = $services[$id]) || null !== $file) {
                 continue;
             }
             if ($definition->isPublic()) {
-                $publicServices .= $this->addService($id, $definition);
+                $publicServices .= $code;
             } elseif (!$this->isTrivialInstance($definition) || isset($this->locatedIds[$id])) {
-                $privateServices .= $this->addService($id, $definition);
+                $privateServices .= $code;
             }
         }
 
         return $publicServices.$privateServices;
     }
 
-    private function generateServiceFiles()
+    private function generateServiceFiles(array $services)
     {
         $definitions = $this->container->getDefinitions();
         ksort($definitions);
         foreach ($definitions as $id => $definition) {
-            if (!$definition->isSynthetic() && !$this->isHotPath($definition) && ($definition->isPublic() || !$this->isTrivialInstance($definition) || isset($this->locatedIds[$id]))) {
-                $code = $this->addService($id, $definition, $file);
-
+            if ((list($file, $code) = $services[$id]) && null !== $file && ($definition->isPublic() || !$this->isTrivialInstance($definition) || isset($this->locatedIds[$id]))) {
                 if (!$definition->isShared()) {
                     $i = strpos($code, "\n\ninclude_once ");
                     if (false !== $i && false !== $i = strpos($code, "\n\n", 2 + $i)) {

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

@@ -86,4 +86,14 @@ protected function getFooServiceService()
             'baz' => array('privates', 'Symfony\\Component\\DependencyInjection\\Tests\\Fixtures\\CustomDefinition', 'getCustomDefinitionService', false),
         )))->withContext('foo_service', $this));
     }
+
+    /**
+     * Gets the private 'Symfony\Component\DependencyInjection\Tests\Fixtures\CustomDefinition' shared service.
+     *
+     * @return \Symfony\Component\DependencyInjection\Tests\Fixtures\CustomDefinition
+     */
+    protected function getCustomDefinitionService()
+    {
+        return $this->privates['Symfony\Component\DependencyInjection\Tests\Fixtures\CustomDefinition'] = new \Symfony\Component\DependencyInjection\Tests\Fixtures\CustomDefinition();
+    }
 }