bug #59262 [DependencyInjection] Fix env default processor with scalar node (tBibaut)

fabpot · fabpot · commit 06b9c3168125 · 2025-02-07T09:11:35.000+01:00
This PR was merged into the 6.4 branch. Discussion ---------- [DependencyInjection] Fix env default processor with scalar node | Q | A | ------------- | --- | Branch? | 6.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Issues | | License | MIT When a `default` processor was used, the provided type was `bool|int|float|string|array` It was too wide when validated by a scalarNode. For example, switching a config from : ```yaml scalar_node: "%env(FOO_ENV)%" ``` to : ```yaml scalar_node: "%env(default:foo_param:FOO_ENV)%" ``` Would throw this exception : ``` [Symfony\Component\Config\Definition\Exception\InvalidTypeException] Invalid type for path "scalar_node". Expected one of "bool", "int", "float", "string", but got one of "bool", "int", "float", "string", "array". ``` This fix narrows the provided type to the combination of the parameter and the environment variable types. Commits ------- 80eb609 [DependencyInjection] Fix env default processor with scalar node
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/ValidateEnvPlaceholdersPass.php b/src/Symfony/Component/DependencyInjection/Compiler/ValidateEnvPlaceholdersPass.php
@@ -49,17 +49,8 @@ public function process(ContainerBuilder $container)
         $defaultBag = new ParameterBag($resolvingBag->all());
         $envTypes = $resolvingBag->getProvidedTypes();
         foreach ($resolvingBag->getEnvPlaceholders() + $resolvingBag->getUnusedEnvPlaceholders() as $env => $placeholders) {
-            $values = [];
-            if (false === $i = strpos($env, ':')) {
-                $default = $defaultBag->has("env($env)") ? $defaultBag->get("env($env)") : self::TYPE_FIXTURES['string'];
-                $defaultType = null !== $default ? get_debug_type($default) : 'string';
-                $values[$defaultType] = $default;
-            } else {
-                $prefix = substr($env, 0, $i);
-                foreach ($envTypes[$prefix] ?? ['string'] as $type) {
-                    $values[$type] = self::TYPE_FIXTURES[$type] ?? null;
-                }
-            }
+            $values = $this->getPlaceholderValues($env, $defaultBag, $envTypes);
+
             foreach ($placeholders as $placeholder) {
                 BaseNode::setPlaceholder($placeholder, $values);
             }
@@ -100,4 +91,50 @@ public function getExtensionConfig(): array
             $this->extensionConfig = [];
         }
     }
+
+    /**
+     * @param array<string, list<string>> $envTypes
+     *
+     * @return array<string, mixed>
+     */
+    private function getPlaceholderValues(string $env, ParameterBag $defaultBag, array $envTypes): array
+    {
+        if (false === $i = strpos($env, ':')) {
+            [$default, $defaultType] = $this->getParameterDefaultAndDefaultType("env($env)", $defaultBag);
+
+            return [$defaultType => $default];
+        }
+
+        $prefix = substr($env, 0, $i);
+        if ('default' === $prefix) {
+            $parts = explode(':', $env);
+            array_shift($parts); // Remove 'default' prefix
+            $parameter = array_shift($parts); // Retrieve and remove parameter
+
+            [$defaultParameter, $defaultParameterType] = $this->getParameterDefaultAndDefaultType($parameter, $defaultBag);
+
+            return [
+                $defaultParameterType => $defaultParameter,
+                ...$this->getPlaceholderValues(implode(':', $parts), $defaultBag, $envTypes),
+            ];
+        }
+
+        $values = [];
+        foreach ($envTypes[$prefix] ?? ['string'] as $type) {
+            $values[$type] = self::TYPE_FIXTURES[$type] ?? null;
+        }
+
+        return $values;
+    }
+
+    /**
+     * @return array{0: string, 1: string}
+     */
+    private function getParameterDefaultAndDefaultType(string $name, ParameterBag $defaultBag): array
+    {
+        $default = $defaultBag->has($name) ? $defaultBag->get($name) : self::TYPE_FIXTURES['string'];
+        $defaultType = null !== $default ? get_debug_type($default) : 'string';
+
+        return [$default, $defaultType];
+    }
 }
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Compiler/ValidateEnvPlaceholdersPassTest.php b/src/Symfony/Component/DependencyInjection/Tests/Compiler/ValidateEnvPlaceholdersPassTest.php
@@ -73,6 +73,36 @@ public function testDefaultEnvWithoutPrefixIsValidatedInConfig()
         $this->doProcess($container);
     }
 
+    public function testDefaultProcessorWithScalarNode()
+    {
+        $container = new ContainerBuilder();
+        $container->setParameter('parameter_int', 12134);
+        $container->setParameter('env(FLOATISH)', 4.2);
+        $container->registerExtension($ext = new EnvExtension());
+        $container->prependExtensionConfig('env_extension', $expected = [
+            'scalar_node' => '%env(default:parameter_int:FLOATISH)%',
+        ]);
+
+        $this->doProcess($container);
+        $this->assertSame($expected, $container->resolveEnvPlaceholders($ext->getConfig()));
+    }
+
+    public function testDefaultProcessorAndAnotherProcessorWithScalarNode()
+    {
+        $this->expectException(InvalidTypeException::class);
+        $this->expectExceptionMessageMatches('/^Invalid type for path "env_extension\.scalar_node"\. Expected one of "bool", "int", "float", "string", but got one of "int", "array"\.$/');
+
+        $container = new ContainerBuilder();
+        $container->setParameter('parameter_int', 12134);
+        $container->setParameter('env(JSON)', '{ "foo": "bar" }');
+        $container->registerExtension($ext = new EnvExtension());
+        $container->prependExtensionConfig('env_extension', [
+            'scalar_node' => '%env(default:parameter_int:json:JSON)%',
+        ]);
+
+        $this->doProcess($container);
+    }
+
     public function testEnvsAreValidatedInConfigWithInvalidPlaceholder()
     {
         $this->expectException(InvalidTypeException::class);
