bug #60584 [DependencyInjection] Make YamlDumper quote resolved env vars if necessary (MatTheCat)

nicolas-grekas · nicolas-grekas · commit 37a619f583a4 · 2025-05-30T10:29:38.000+02:00
This PR was merged into the 6.4 branch. Discussion ---------- [DependencyInjection] Make `YamlDumper` quote resolved env vars if necessary | Q | A | ------------- | --- | Branch? | 6.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Issues | Fix #60573 | License | MIT Commits ------- 558202c [DependencyInjection] Make `YamlDumper` quote resolved env vars if necessary
diff --git a/src/Symfony/Component/DependencyInjection/Dumper/YamlDumper.php b/src/Symfony/Component/DependencyInjection/Dumper/YamlDumper.php
@@ -50,18 +50,18 @@ public function dump(array $options = []): string
 
         $this->dumper ??= new YmlDumper();
 
-        return $this->container->resolveEnvPlaceholders($this->addParameters()."\n".$this->addServices());
+        return $this->addParameters()."\n".$this->addServices();
     }
 
     private function addService(string $id, Definition $definition): string
     {
-        $code = "    $id:\n";
+        $code = "    {$this->dumper->dump($id)}:\n";
         if ($class = $definition->getClass()) {
             if (str_starts_with($class, '\\')) {
                 $class = substr($class, 1);
             }
 
-            $code .= sprintf("        class: %s\n", $this->dumper->dump($class));
+            $code .= sprintf("        class: %s\n", $this->dumper->dump($this->container->resolveEnvPlaceholders($class)));
         }
 
         if (!$definition->isPrivate()) {
@@ -87,7 +87,7 @@ private function addService(string $id, Definition $definition): string
         }
 
         if ($definition->getFile()) {
-            $code .= sprintf("        file: %s\n", $this->dumper->dump($definition->getFile()));
+            $code .= sprintf("        file: %s\n", $this->dumper->dump($this->container->resolveEnvPlaceholders($definition->getFile())));
         }
 
         if ($definition->isSynthetic()) {
@@ -238,7 +238,7 @@ private function dumpCallable(mixed $callable): mixed
             }
         }
 
-        return $callable;
+        return $this->container->resolveEnvPlaceholders($callable);
     }
 
     /**
@@ -299,7 +299,7 @@ private function dumpValue(mixed $value): mixed
         if (\is_array($value)) {
             $code = [];
             foreach ($value as $k => $v) {
-                $code[$k] = $this->dumpValue($v);
+                $code[$this->container->resolveEnvPlaceholders($k)] = $this->dumpValue($v);
             }
 
             return $code;
@@ -319,7 +319,7 @@ private function dumpValue(mixed $value): mixed
             throw new RuntimeException(sprintf('Unable to dump a service container if a parameter is an object or a resource, got "%s".', get_debug_type($value)));
         }
 
-        return $value;
+        return $this->container->resolveEnvPlaceholders($value);
     }
 
     private function getServiceCall(string $id, ?Reference $reference = null): string
@@ -359,7 +359,7 @@ private function prepareParameters(array $parameters, bool $escape = true): arra
             $filtered[$key] = $value;
         }
 
-        return $escape ? $this->escape($filtered) : $filtered;
+        return $escape ? $this->container->resolveEnvPlaceholders($this->escape($filtered)) : $filtered;
     }
 
     private function escape(array $arguments): array
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Dumper/YamlDumperTest.php b/src/Symfony/Component/DependencyInjection/Tests/Dumper/YamlDumperTest.php
@@ -215,6 +215,26 @@ public function testDumpNonScalarTags()
         $this->assertEquals(file_get_contents(self::$fixturesPath.'/yaml/services_with_array_tags.yml'), $dumper->dump());
     }
 
+    public function testDumpResolvedEnvPlaceholders()
+    {
+        $container = new ContainerBuilder();
+        $container->setParameter('%env(PARAMETER_NAME)%', '%env(PARAMETER_VALUE)%');
+        $container
+            ->register('service', '%env(SERVICE_CLASS)%')
+            ->setFile('%env(SERVICE_FILE)%')
+            ->addArgument('%env(SERVICE_ARGUMENT)%')
+            ->setProperty('%env(SERVICE_PROPERTY_NAME)%', '%env(SERVICE_PROPERTY_VALUE)%')
+            ->addMethodCall('%env(SERVICE_METHOD_NAME)%', ['%env(SERVICE_METHOD_ARGUMENT)%'])
+            ->setFactory('%env(SERVICE_FACTORY)%')
+            ->setConfigurator('%env(SERVICE_CONFIGURATOR)%')
+            ->setPublic(true)
+        ;
+        $container->compile();
+        $dumper = new YamlDumper($container);
+
+        $this->assertEquals(file_get_contents(self::$fixturesPath.'/yaml/container_with_env_placeholders.yml'), $dumper->dump());
+    }
+
     private function assertEqualYamlStructure(string $expected, string $yaml, string $message = '')
     {
         $parser = new Parser();
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/yaml/container_with_env_placeholders.yml b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/yaml/container_with_env_placeholders.yml
@@ -0,0 +1,19 @@
+parameters:
+    '%env(PARAMETER_NAME)%': '%env(PARAMETER_VALUE)%'
+
+services:
+    service_container:
+        class: Symfony\Component\DependencyInjection\ContainerInterface
+        public: true
+        synthetic: true
+    service:
+        class: '%env(SERVICE_CLASS)%'
+        public: true
+        file: '%env(SERVICE_FILE)%'
+        arguments: ['%env(SERVICE_ARGUMENT)%']
+        properties: { '%env(SERVICE_PROPERTY_NAME)%': '%env(SERVICE_PROPERTY_VALUE)%' }
+        calls:
+            - ['%env(SERVICE_METHOD_NAME)%', ['%env(SERVICE_METHOD_ARGUMENT)%']]
+
+        factory: '%env(SERVICE_FACTORY)%'
+        configurator: '%env(SERVICE_CONFIGURATOR)%'

Original file line number	Diff line number	Diff line change
`@@ -50,18 +50,18 @@ public function dump(array $options = []): string`
`50`	`50`
`51`	`51`	`$this->dumper ??= new YmlDumper();`
`52`	`52`
`53`		`- return $this->container->resolveEnvPlaceholders($this->addParameters()."\n".$this->addServices());`
	`53`	`+ return $this->addParameters()."\n".$this->addServices();`
`54`	`54`	`}`
`55`	`55`
`56`	`56`	`private function addService(string $id, Definition $definition): string`
`57`	`57`	`{`
`58`		`- $code = " $id:\n";`
	`58`	`+ $code = " {$this->dumper->dump($id)}:\n";`
`59`	`59`	`if ($class = $definition->getClass()) {`
`60`	`60`	`if (str_starts_with($class, '\\')) {`
`61`	`61`	`$class = substr($class, 1);`
`62`	`62`	`}`
`63`	`63`
`64`		`- $code .= sprintf(" class: %s\n", $this->dumper->dump($class));`
	`64`	`+ $code .= sprintf(" class: %s\n", $this->dumper->dump($this->container->resolveEnvPlaceholders($class)));`
`65`	`65`	`}`
`66`	`66`
`67`	`67`	`if (!$definition->isPrivate()) {`
`@@ -87,7 +87,7 @@ private function addService(string $id, Definition $definition): string`
`87`	`87`	`}`
`88`	`88`
`89`	`89`	`if ($definition->getFile()) {`
`90`		`- $code .= sprintf(" file: %s\n", $this->dumper->dump($definition->getFile()));`
	`90`	`+ $code .= sprintf(" file: %s\n", $this->dumper->dump($this->container->resolveEnvPlaceholders($definition->getFile())));`
`91`	`91`	`}`
`92`	`92`
`93`	`93`	`if ($definition->isSynthetic()) {`
`@@ -238,7 +238,7 @@ private function dumpCallable(mixed $callable): mixed`
`238`	`238`	`}`
`239`	`239`	`}`
`240`	`240`
`241`		`- return $callable;`
	`241`	`+ return $this->container->resolveEnvPlaceholders($callable);`
`242`	`242`	`}`
`243`	`243`
`244`	`244`	`/**`
`@@ -299,7 +299,7 @@ private function dumpValue(mixed $value): mixed`
`299`	`299`	`if (\is_array($value)) {`
`300`	`300`	`$code = [];`
`301`	`301`	`foreach ($value as $k => $v) {`
`302`		`- $code[$k] = $this->dumpValue($v);`
	`302`	`+ $code[$this->container->resolveEnvPlaceholders($k)] = $this->dumpValue($v);`
`303`	`303`	`}`
`304`	`304`
`305`	`305`	`return $code;`
`@@ -319,7 +319,7 @@ private function dumpValue(mixed $value): mixed`
`319`	`319`	`throw new RuntimeException(sprintf('Unable to dump a service container if a parameter is an object or a resource, got "%s".', get_debug_type($value)));`
`320`	`320`	`}`
`321`	`321`
`322`		`- return $value;`
	`322`	`+ return $this->container->resolveEnvPlaceholders($value);`
`323`	`323`	`}`
`324`	`324`
`325`	`325`	`private function getServiceCall(string $id, ?Reference $reference = null): string`
`@@ -359,7 +359,7 @@ private function prepareParameters(array $parameters, bool $escape = true): arra`
`359`	`359`	`$filtered[$key] = $value;`
`360`	`360`	`}`
`361`	`361`
`362`		`- return $escape ? $this->escape($filtered) : $filtered;`
	`362`	`+ return $escape ? $this->container->resolveEnvPlaceholders($this->escape($filtered)) : $filtered;`
`363`	`363`	`}`
`364`	`364`
`365`	`365`	`private function escape(array $arguments): array`