bug #50837 [DependencyInjection] Fix autocasting null env values to empty string (fancyweb)

nicolas-grekas · nicolas-grekas · commit 1e1d91eca1d0 · 2023-07-03T14:55:49.000+02:00
This PR was merged into the 5.4 branch. Discussion ---------- [DependencyInjection] Fix autocasting null env values to empty string | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | yes | New feature? | - | Deprecations? | - | Tickets | #50815 (comment) | License | MIT | Doc PR | - This PR fixes autocasting `null` env values to `''`. We continue to autocast all other values to string when there's no prefix. It doesn't revert #50517, it just fixes an unintended side effect. It doesn't fix #50815 request, it confirms the behavior: the solution for this issue would be to remove the `string:` prefix. There's still no solution to have the "keep null as null" and "cast if not null" behavior. Commits ------- 2c0815d [DependencyInjection] Fix autocasting null env values to empty string
diff --git a/src/Symfony/Component/DependencyInjection/Container.php b/src/Symfony/Component/DependencyInjection/Container.php
@@ -390,7 +390,15 @@ protected function getEnv(string $name)
             $prefix = 'string';
             $localName = $name;
         }
-        $processor = $processors->has($prefix) ? $processors->get($prefix) : new EnvVarProcessor($this);
+
+        if ($processors->has($prefix)) {
+            $processor = $processors->get($prefix);
+        } else {
+            $processor = new EnvVarProcessor($this);
+            if (false === $i) {
+                $prefix = '';
+            }
+        }
 
         $this->resolving[$envName] = true;
         try {
diff --git a/src/Symfony/Component/DependencyInjection/EnvVarProcessor.php b/src/Symfony/Component/DependencyInjection/EnvVarProcessor.php
@@ -126,6 +126,12 @@ public function getEnv(string $prefix, string $name, \Closure $getEnv)
             }
         }
 
+        $returnNull = false;
+        if ('' === $prefix) {
+            $returnNull = true;
+            $prefix = 'string';
+        }
+
         if (false !== $i || 'string' !== $prefix) {
             $env = $getEnv($name);
         } elseif (isset($_ENV[$name])) {
@@ -177,6 +183,10 @@ public function getEnv(string $prefix, string $name, \Closure $getEnv)
         }
 
         if (null === $env) {
+            if ($returnNull) {
+                return null;
+            }
+
             if (!isset($this->getProvidedTypes()[$prefix])) {
                 throw new RuntimeException(sprintf('Unsupported env var prefix "%s".', $prefix));
             }
diff --git a/src/Symfony/Component/DependencyInjection/Tests/EnvVarProcessorTest.php b/src/Symfony/Component/DependencyInjection/Tests/EnvVarProcessorTest.php
@@ -763,12 +763,13 @@ public static function provideGetEnvUrlPath()
 
     /**
      * @testWith    ["", "string"]
+     *              [null, ""]
      *              [false, "bool"]
      *              [true, "not"]
      *              [0, "int"]
      *              [0.0, "float"]
      */
-    public function testGetEnvCastsNull($expected, string $prefix)
+    public function testGetEnvCastsNullBehavior($expected, string $prefix)
     {
         $processor = new EnvVarProcessor(new Container());
 
@@ -778,4 +779,17 @@ public function testGetEnvCastsNull($expected, string $prefix)
             });
         }));
     }
+
+    public function testGetEnvWithEmptyStringPrefixCastsToString()
+    {
+        $processor = new EnvVarProcessor(new Container());
+        unset($_ENV['FOO']);
+        $_ENV['FOO'] = 4;
+
+        try {
+            $this->assertSame('4', $processor->getEnv('', 'FOO', function () { $this->fail('Should not be called'); }));
+        } finally {
+            unset($_ENV['FOO']);
+        }
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -126,6 +126,12 @@ public function getEnv(string $prefix, string $name, \Closure $getEnv)`
`126`	`126`	`}`
`127`	`127`	`}`
`128`	`128`
	`129`	`+ $returnNull = false;`
	`130`	`+ if ('' === $prefix) {`
	`131`	`+ $returnNull = true;`
	`132`	`+ $prefix = 'string';`
	`133`	`+ }`
	`134`	`+`
`129`	`135`	`if (false !== $i \|\| 'string' !== $prefix) {`
`130`	`136`	`$env = $getEnv($name);`
`131`	`137`	`} elseif (isset($_ENV[$name])) {`
`@@ -177,6 +183,10 @@ public function getEnv(string $prefix, string $name, \Closure $getEnv)`
`177`	`183`	`}`
`178`	`184`
`179`	`185`	`if (null === $env) {`
	`186`	`+ if ($returnNull) {`
	`187`	`+ return null;`
	`188`	`+ }`
	`189`	`+`
`180`	`190`	`if (!isset($this->getProvidedTypes()[$prefix])) {`
`181`	`191`	`throw new RuntimeException(sprintf('Unsupported env var prefix "%s".', $prefix));`
`182`	`192`	`}`