Skip to content

[4.17] App::env() + parseEnv() improvements #17949

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
brandonkelly merged 2 commits into from
Oct 15, 2025
Merged

[4.17] App::env() + parseEnv() improvements #17949

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d694cc3
Backport env improvements from #17794
brandonkelly Oct 15, 2025
9e6e344
Release note
brandonkelly Oct 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG-WIP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
### Administration
- Added the “View user” GraphQL schema option for Craft Solo. ([#17863](https://github.com/craftcms/cms/pull/17863))

### Development
- Added support for referencing environment variables anywhere within settings that support them (e.g. `foo/$ENV_NAME/bar` or `foo-${ENV_NAME}-bar`). ([#17949](https://github.com/craftcms/cms/pull/17949))

### Extensibility
- Added `craft\web\GqlResponseFormatter`.
- Added `craft\web\Response::FORMAT_GQL`.
Expand Down
31 changes: 18 additions & 13 deletions src/helpers/App.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,12 @@ public static function env(string $name): mixed
}

if (($env = getenv($name)) !== false) {
return static::normalizeValue($env);
$value = static::normalizeValue($env);
if (is_string($value)) {
// parse nested variables
$value = self::parseNestedEnv($value);
}
return $value;
}

if (defined($name)) {
Expand All @@ -138,6 +143,11 @@ public static function env(string $name): mixed
return null;
}

private static function parseNestedEnv(string $value): string
{
return preg_replace_callback('/\$\{(\w+)}/', fn(array $m) => static::env($m[1]), $value);
}

/**
* Returns a config array for a given class, based on any environment variables or PHP constants named based on its
* public properties.
Expand Down Expand Up @@ -198,20 +208,15 @@ public static function envConfig(string $class, ?string $envPrefix = null): arra
*/
public static function parseEnv(?string $value): bool|string|null
{
if ($value === null) {
return null;
if ($value === null || $value === '') {
return $value;
}

if (preg_match('/^\$(\w+)(\/.*)?/', $value, $matches)) {
$env = static::env($matches[1]);
// …${VAR}…
$value = self::parseNestedEnv($value);

if ($env === null) {
// starts with $ but not an environment variable/constant, so just give up, it's hopeless!
return $value;
}

$value = $env . ($matches[2] ?? '');
}
// …/$VAR/…
$value = preg_replace_callback('/(?<=^|\/)\$(\w+)(?=$|\/)?/', fn($m) => static::env($m[1]) ?? sprintf('$%s', $m[1]), $value);

if (is_string($value) && str_starts_with($value, '@')) {
$value = Craft::getAlias($value, false) ?: $value;
Expand Down Expand Up @@ -244,7 +249,7 @@ public static function parseBooleanEnv(mixed $value): ?bool
return (bool)$value;
}

if (!is_string($value)) {
if (!is_string($value) || $value === '') {
return null;
}

Expand Down
57 changes: 41 additions & 16 deletions tests/unit/helpers/AppHelperTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,24 +36,28 @@ public function testEnv(): void
self::assertSame('server', App::env('TEST_SERVER_ENV'));
unset($_SERVER['TEST_SERVER_ENV']);

putenv('TEST_GETENV_ENV=getenv');
self::assertSame('getenv', App::env('TEST_GETENV_ENV'));
putenv('TEST_GETENV_ENV');
$variables = [
'TEST_1' => 'testing1',
'TEST_2' => 'foo-${TEST_1}-bar',
'TEST_3' => 'true',
'TEST_4' => 'false',
];

foreach ($variables as $name => $value) {
putenv("$name=$value");
}

putenv('TEST_GETENV_TRUE_ENV=true');
self::assertTrue(App::env('TEST_GETENV_TRUE_ENV'));
putenv('TEST_GETENV_TRUE_ENV');
self::assertSame('testing1', App::env('TEST_1'));
self::assertSame('foo-testing1-bar', App::env('TEST_2'));
self::assertTrue(App::env('TEST_3'));
self::assertFalse(App::env('TEST_4'));

putenv('TEST_GETENV_FALSE_ENV=false');
self::assertFalse(App::env('TEST_GETENV_FALSE_ENV'));
putenv('TEST_GETENV_FALSE_ENV');
foreach (array_keys($variables) as $name) {
putenv($name);
}

self::assertSame(CRAFT_TESTS_PATH, App::env('CRAFT_TESTS_PATH'));
self::assertNull(App::env('TEST_NONEXISTENT_ENV'));

putenv('SHH=foo');
self::assertSame('foo', App::env('SHH'));
putenv('SHH');
}

/**
Expand Down Expand Up @@ -91,12 +95,33 @@ public function testEnvConfig(mixed $expected, string $paramName, string $overri
*/
public function testParseEnv(): void
{
self::assertNull(App::parseEnv(null));
$variables = [
'TEST_1' => 'testing1',
'TEST_2' => 'foo${TEST_1}bar',
'TEST_DEFAULT_SITE_API_KEY' => 'abcdef',
];

foreach ($variables as $name => $value) {
putenv("$name=$value");
}

self::assertSame('testing1', App::parseEnv('$TEST_1'));
self::assertSame('testing1', App::parseEnv('${TEST_1}'));
self::assertSame('testing1/foo/bar', App::parseEnv('$TEST_1/foo/bar'));
self::assertSame('foo/testing1/bar', App::parseEnv('foo/$TEST_1/bar'));
self::assertSame('footesting1bar', App::parseEnv('$TEST_2'));
self::assertSame('footesting1bar', App::parseEnv('${TEST_2}'));
self::assertSame('foo/footesting1bar/bar', App::parseEnv('foo/$TEST_2/bar'));
self::assertSame(CRAFT_TESTS_PATH, App::parseEnv('$CRAFT_TESTS_PATH'));
self::assertSame(CRAFT_TESTS_PATH . '/foo/bar', App::parseEnv('$CRAFT_TESTS_PATH/foo/bar'));
self::assertSame('CRAFT_TESTS_PATH', App::parseEnv('CRAFT_TESTS_PATH'));
self::assertSame('$TEST_MISSING', App::parseEnv('$TEST_MISSING'));
self::assertSame(Craft::getAlias('@vendor/foo/bar'), App::parseEnv('@vendor/foo/bar'));
self::assertSame('$TEST_MISSING', App::parseEnv('$TEST_MISSING'));
self::assertNull(App::parseEnv(null));

foreach (array_keys($variables) as $name) {
putenv($name);
}
}

/**
Expand Down Expand Up @@ -429,7 +454,7 @@ public function parseBooleanEnvDataProvider(): array
[false, '0'],
[true, 'true'],
[false, 'false'],
[false, ''],
[null, ''],
[null, 'whatever'],
[true, 1],
[false, 0],
Expand Down