bug #51198 [DependencyInjection] Fix autocasting null env values to empty string with container.env_var_processors_locator (fancyweb)

nicolas-grekas · nicolas-grekas · commit b9c30fb8c1b1 · 2023-09-20T11:40:46.000+02:00
This PR was merged into the 5.4 branch. Discussion ---------- [DependencyInjection] Fix autocasting `null` env values to empty string with `container.env_var_processors_locator` | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Tickets | #50837 (comment) | License | MIT | Doc PR | no The previous fix doesn't work when `$processors` comes from `container.env_var_processors_locator`. Commits ------- 766bc6e [DependencyInjection] Fix autocasting null env values to empty string with container.env_var_processors_locator
diff --git a/src/Symfony/Component/DependencyInjection/Container.php b/src/Symfony/Component/DependencyInjection/Container.php
@@ -391,13 +391,9 @@ protected function getEnv(string $name)
             $localName = $name;
         }
 
-        if ($processors->has($prefix)) {
-            $processor = $processors->get($prefix);
-        } else {
-            $processor = new EnvVarProcessor($this);
-            if (false === $i) {
-                $prefix = '';
-            }
+        $processor = $processors->has($prefix) ? $processors->get($prefix) : new EnvVarProcessor($this);
+        if (false === $i) {
+            $prefix = '';
         }
 
         $this->resolving[$envName] = true;
diff --git a/src/Symfony/Component/DependencyInjection/EnvVarProcessorInterface.php b/src/Symfony/Component/DependencyInjection/EnvVarProcessorInterface.php
@@ -23,7 +23,7 @@ interface EnvVarProcessorInterface
     /**
      * Returns the value of the given variable as managed by the current instance.
      *
-     * @param string   $prefix The namespace of the variable
+     * @param string   $prefix The namespace of the variable; when the empty string is passed, null values should be kept as is
      * @param string   $name   The name of the variable within the namespace
      * @param \Closure $getEnv A closure that allows fetching more env vars
      *
diff --git a/src/Symfony/Component/DependencyInjection/Tests/ContainerTest.php b/src/Symfony/Component/DependencyInjection/Tests/ContainerTest.php
@@ -14,11 +14,13 @@
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\DependencyInjection\Container;
 use Symfony\Component\DependencyInjection\ContainerInterface;
+use Symfony\Component\DependencyInjection\EnvVarProcessor;
 use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
 use Symfony\Component\DependencyInjection\Exception\ServiceCircularReferenceException;
 use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
 use Symfony\Component\DependencyInjection\ParameterBag\FrozenParameterBag;
 use Symfony\Component\DependencyInjection\ParameterBag\ParameterBag;
+use Symfony\Component\DependencyInjection\ServiceLocator;
 use Symfony\Contracts\Service\ResetInterface;
 
 class ContainerTest extends TestCase
@@ -405,6 +407,33 @@ public function testRequestAnInternalSharedPrivateService()
         $c->get('internal_dependency');
         $c->get('internal');
     }
+
+    public function testGetEnvDoesNotAutoCastNullWithDefaultEnvVarProcessor()
+    {
+        $container = new Container();
+        $container->setParameter('env(FOO)', null);
+        $container->compile();
+
+        $r = new \ReflectionMethod($container, 'getEnv');
+        $r->setAccessible(true);
+        $this->assertNull($r->invoke($container, 'FOO'));
+    }
+
+    public function testGetEnvDoesNotAutoCastNullWithEnvVarProcessorsLocatorReturningDefaultEnvVarProcessor()
+    {
+        $container = new Container();
+        $container->setParameter('env(FOO)', null);
+        $container->set('container.env_var_processors_locator', new ServiceLocator([
+            'string' => static function () use ($container): EnvVarProcessor {
+                return new EnvVarProcessor($container);
+            },
+        ]));
+        $container->compile();
+
+        $r = new \ReflectionMethod($container, 'getEnv');
+        $r->setAccessible(true);
+        $this->assertNull($r->invoke($container, 'FOO'));
+    }
 }
 
 class ProjectServiceContainer extends Container

Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ interface EnvVarProcessorInterface`
`23`	`23`	`/**`
`24`	`24`	`* Returns the value of the given variable as managed by the current instance.`
`25`	`25`	`*`
`26`		`- * @param string $prefix The namespace of the variable`
	`26`	`+ * @param string $prefix The namespace of the variable; when the empty string is passed, null values should be kept as is`
`27`	`27`	`* @param string $name The name of the variable within the namespace`
`28`	`28`	`* @param \Closure $getEnv A closure that allows fetching more env vars`
`29`	`29`	`*`