bug #50517 [DependencyInjection] Fix casting scalar env vars from null (fancyweb)

nicolas-grekas · nicolas-grekas · commit 091ac2b226df · 2023-06-01T10:14:37.000+02:00
This PR was merged into the 5.4 branch. Discussion ---------- [DependencyInjection] Fix casting scalar env vars from null | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | yes | New feature? | no | Deprecations? | - | Tickets | #50415 | License | MIT | Doc PR | - Using a casting env var processor on `null` returns `null` (it doesn't cast) which is not what one could expect and not what is documented. We could allow it. Commits ------- c4b16e5 [DependencyInjection] Allow casting env var processors to cast null
diff --git a/src/Symfony/Component/DependencyInjection/EnvVarProcessor.php b/src/Symfony/Component/DependencyInjection/EnvVarProcessor.php
@@ -181,10 +181,12 @@ public function getEnv(string $prefix, string $name, \Closure $getEnv)
                 throw new RuntimeException(sprintf('Unsupported env var prefix "%s".', $prefix));
             }
 
-            return null;
+            if (!\in_array($prefix, ['string', 'bool', 'not', 'int', 'float'], true)) {
+                return null;
+            }
         }
 
-        if (!\is_scalar($env)) {
+        if (null !== $env && !\is_scalar($env)) {
             throw new RuntimeException(sprintf('Non-scalar env var "%s" cannot be cast to "%s".', $name, $prefix));
         }
 
@@ -199,15 +201,15 @@ public function getEnv(string $prefix, string $name, \Closure $getEnv)
         }
 
         if ('int' === $prefix) {
-            if (false === $env = filter_var($env, \FILTER_VALIDATE_INT) ?: filter_var($env, \FILTER_VALIDATE_FLOAT)) {
+            if (null !== $env && false === $env = filter_var($env, \FILTER_VALIDATE_INT) ?: filter_var($env, \FILTER_VALIDATE_FLOAT)) {
                 throw new RuntimeException(sprintf('Non-numeric env var "%s" cannot be cast to int.', $name));
             }
 
             return (int) $env;
         }
 
         if ('float' === $prefix) {
-            if (false === $env = filter_var($env, \FILTER_VALIDATE_FLOAT)) {
+            if (null !== $env && false === $env = filter_var($env, \FILTER_VALIDATE_FLOAT)) {
                 throw new RuntimeException(sprintf('Non-numeric env var "%s" cannot be cast to float.', $name));
             }
 
diff --git a/src/Symfony/Component/DependencyInjection/Tests/ContainerBuilderTest.php b/src/Symfony/Component/DependencyInjection/Tests/ContainerBuilderTest.php
@@ -839,8 +839,8 @@ public function testEnvAreNullable()
         $container->register('foo', 'stdClass')
             ->setPublic(true)
             ->setProperties([
-            'fake' => '%env(int:FAKE)%',
-        ]);
+                'fake' => '%env(resolve:FAKE)%',
+            ]);
 
         $container->compile(true);
 
diff --git a/src/Symfony/Component/DependencyInjection/Tests/EnvVarProcessorTest.php b/src/Symfony/Component/DependencyInjection/Tests/EnvVarProcessorTest.php
@@ -760,4 +760,22 @@ public static function provideGetEnvUrlPath()
             ['blog//', 'https://symfony.com/blog//'],
         ];
     }
+
+    /**
+     * @testWith    ["", "string"]
+     *              [false, "bool"]
+     *              [true, "not"]
+     *              [0, "int"]
+     *              [0.0, "float"]
+     */
+    public function testGetEnvCastsNull($expected, string $prefix)
+    {
+        $processor = new EnvVarProcessor(new Container());
+
+        $this->assertSame($expected, $processor->getEnv($prefix, 'default::FOO', static function () use ($processor) {
+            return $processor->getEnv('default', ':FOO', static function () {
+                return null;
+            });
+        }));
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -181,10 +181,12 @@ public function getEnv(string $prefix, string $name, \Closure $getEnv)`
`181`	`181`	`throw new RuntimeException(sprintf('Unsupported env var prefix "%s".', $prefix));`
`182`	`182`	`}`
`183`	`183`
`184`		`- return null;`
	`184`	`+ if (!\in_array($prefix, ['string', 'bool', 'not', 'int', 'float'], true)) {`
	`185`	`+ return null;`
	`186`	`+ }`
`185`	`187`	`}`
`186`	`188`
`187`		`- if (!\is_scalar($env)) {`
	`189`	`+ if (null !== $env && !\is_scalar($env)) {`
`188`	`190`	`throw new RuntimeException(sprintf('Non-scalar env var "%s" cannot be cast to "%s".', $name, $prefix));`
`189`	`191`	`}`
`190`	`192`
`@@ -199,15 +201,15 @@ public function getEnv(string $prefix, string $name, \Closure $getEnv)`
`199`	`201`	`}`
`200`	`202`
`201`	`203`	`if ('int' === $prefix) {`
`202`		`- if (false === $env = filter_var($env, \FILTER_VALIDATE_INT) ?: filter_var($env, \FILTER_VALIDATE_FLOAT)) {`
	`204`	`+ if (null !== $env && false === $env = filter_var($env, \FILTER_VALIDATE_INT) ?: filter_var($env, \FILTER_VALIDATE_FLOAT)) {`
`203`	`205`	`throw new RuntimeException(sprintf('Non-numeric env var "%s" cannot be cast to int.', $name));`
`204`	`206`	`}`
`205`	`207`
`206`	`208`	`return (int) $env;`
`207`	`209`	`}`
`208`	`210`
`209`	`211`	`if ('float' === $prefix) {`
`210`		`- if (false === $env = filter_var($env, \FILTER_VALIDATE_FLOAT)) {`
	`212`	`+ if (null !== $env && false === $env = filter_var($env, \FILTER_VALIDATE_FLOAT)) {`
`211`	`213`	`throw new RuntimeException(sprintf('Non-numeric env var "%s" cannot be cast to float.', $name));`
`212`	`214`	`}`
`213`	`215`