From 1d6f7959c3ee8743f957356b9c8e00e6dd7db625 Mon Sep 17 00:00:00 2001 From: Nicolas Grekas Date: Wed, 24 Jan 2024 19:53:26 +0100 Subject: [PATCH] [DependencyInjection] Fix loading all env vars from secrets when only a subset is needed --- .../FrameworkBundle/Secrets/SodiumVault.php | 10 +++++++++- .../EnvVarLoaderInterface.php | 2 +- .../DependencyInjection/EnvVarProcessor.php | 20 +++++++++++++++---- .../Tests/EnvVarProcessorTest.php | 15 ++++++++++++++ src/Symfony/Component/String/LazyString.php | 2 +- 5 files changed, 42 insertions(+), 7 deletions(-) diff --git a/src/Symfony/Bundle/FrameworkBundle/Secrets/SodiumVault.php b/src/Symfony/Bundle/FrameworkBundle/Secrets/SodiumVault.php index 9b8208d90c886..dcf79869f6cf5 100644 --- a/src/Symfony/Bundle/FrameworkBundle/Secrets/SodiumVault.php +++ b/src/Symfony/Bundle/FrameworkBundle/Secrets/SodiumVault.php @@ -12,6 +12,7 @@ namespace Symfony\Bundle\FrameworkBundle\Secrets; use Symfony\Component\DependencyInjection\EnvVarLoaderInterface; +use Symfony\Component\String\LazyString; use Symfony\Component\VarExporter\VarExporter; /** @@ -169,7 +170,14 @@ public function list(bool $reveal = false): array public function loadEnvVars(): array { - return $this->list(true); + $envs = []; + $reveal = $this->reveal(...); + + foreach ($this->list() as $name => $value) { + $envs[$name] = LazyString::fromCallable($reveal, $name); + } + + return $envs; } private function loadKeys(): void diff --git a/src/Symfony/Component/DependencyInjection/EnvVarLoaderInterface.php b/src/Symfony/Component/DependencyInjection/EnvVarLoaderInterface.php index 0c547f8a5fae2..803156be2364b 100644 --- a/src/Symfony/Component/DependencyInjection/EnvVarLoaderInterface.php +++ b/src/Symfony/Component/DependencyInjection/EnvVarLoaderInterface.php @@ -19,7 +19,7 @@ interface EnvVarLoaderInterface { /** - * @return string[] Key/value pairs that can be accessed using the regular "%env()%" syntax + * @return array Key/value pairs that can be accessed using the regular "%env()%" syntax */ public function loadEnvVars(): array; } diff --git a/src/Symfony/Component/DependencyInjection/EnvVarProcessor.php b/src/Symfony/Component/DependencyInjection/EnvVarProcessor.php index 32315b8d20059..f2495044ce1ef 100644 --- a/src/Symfony/Component/DependencyInjection/EnvVarProcessor.php +++ b/src/Symfony/Component/DependencyInjection/EnvVarProcessor.php @@ -164,10 +164,16 @@ public function getEnv(string $prefix, string $name, \Closure $getEnv): mixed if (false !== $i || 'string' !== $prefix) { $env = $getEnv($name); } elseif ('' === ($env = $_ENV[$name] ?? (str_starts_with($name, 'HTTP_') ? null : ($_SERVER[$name] ?? null))) - || (false !== $env && false === ($env = $env ?? getenv($name) ?? false)) // null is a possible value because of thread safety issues + || (false !== $env && false === $env ??= getenv($name) ?? false) // null is a possible value because of thread safety issues ) { - foreach ($this->loadedVars as $vars) { - if (false !== ($env = ($vars[$name] ?? $env)) && '' !== $env) { + foreach ($this->loadedVars as $i => $vars) { + if (false === $env = $vars[$name] ?? $env) { + continue; + } + if ($env instanceof \Stringable) { + $this->loadedVars[$i][$name] = $env = (string) $env; + } + if ('' !== ($env ?? '')) { break; } } @@ -185,7 +191,13 @@ public function getEnv(string $prefix, string $name, \Closure $getEnv): mixed continue; } $this->loadedVars[] = $vars = $loader->loadEnvVars(); - if (false !== ($env = ($vars[$name] ?? $env)) && '' !== $env) { + if (false === $env = $vars[$name] ?? $env) { + continue; + } + if ($env instanceof \Stringable) { + $this->loadedVars[array_key_last($this->loadedVars)][$name] = $env = (string) $env; + } + if ('' !== ($env ?? '')) { $ended = false; break; } diff --git a/src/Symfony/Component/DependencyInjection/Tests/EnvVarProcessorTest.php b/src/Symfony/Component/DependencyInjection/Tests/EnvVarProcessorTest.php index 1b8dfdde6c5f1..5e66f149cbf5d 100644 --- a/src/Symfony/Component/DependencyInjection/Tests/EnvVarProcessorTest.php +++ b/src/Symfony/Component/DependencyInjection/Tests/EnvVarProcessorTest.php @@ -808,6 +808,12 @@ public function loadEnvVars(): array return [ 'FOO_ENV_LOADER' => '123', 'BAZ_ENV_LOADER' => '', + 'LAZY_ENV_LOADER' => new class() { + public function __toString() + { + return ''; + } + }, ]; } }; @@ -819,6 +825,12 @@ public function loadEnvVars(): array 'FOO_ENV_LOADER' => '234', 'BAR_ENV_LOADER' => '456', 'BAZ_ENV_LOADER' => '567', + 'LAZY_ENV_LOADER' => new class() { + public function __toString() + { + return '678'; + } + }, ]; } }; @@ -841,6 +853,9 @@ public function loadEnvVars(): array $result = $processor->getEnv('string', 'FOO_ENV_LOADER', function () {}); $this->assertSame('123', $result); // check twice + $result = $processor->getEnv('string', 'LAZY_ENV_LOADER', function () {}); + $this->assertSame('678', $result); + unset($_ENV['BAZ_ENV_LOADER']); unset($_ENV['BUZ_ENV_LOADER']); } diff --git a/src/Symfony/Component/String/LazyString.php b/src/Symfony/Component/String/LazyString.php index 3128ebb361747..1af376908aa6d 100644 --- a/src/Symfony/Component/String/LazyString.php +++ b/src/Symfony/Component/String/LazyString.php @@ -39,7 +39,7 @@ public static function fromCallable(callable|array $callback, mixed ...$argument $callback[1] ??= '__invoke'; } $value = $callback(...$arguments); - $callback = self::getPrettyName($callback); + $callback = !\is_scalar($value) && !$value instanceof \Stringable ? self::getPrettyName($callback) : 'callable'; $arguments = null; }