NotificationsYou must be signed in to change notification settings
Fork9.7k
Star30.7k

[FrameworkBundle] Add`resolve-env` option to debug:config command#46821

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.

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

Already on GitHub?Sign in to your account

Jump to bottom

Merged

fabpot merged 1 commit intosymfony:6.2fromalexandre-daubois:feat-resolve-env

Jul 21, 2022

Merged

[FrameworkBundle] Add`resolve-env` option to debug:config command#46821

fabpot merged 1 commit intosymfony:6.2fromalexandre-daubois:feat-resolve-env

Jul 21, 2022

Conversation

Copy link

Member

alexandre-daubois commentedJul 1, 2022•
edited
Loading

Q	A
Branch?	6.2
Bug fix?	no
New feature?	yes
Deprecations?	no
Tickets	Fix#40582
License	MIT
Doc PR	NA

Add--resolve-env option todebug:config command to display actual values of environment variables in dumped configuration.

This main purpose of this command is debugging as its name suggests. In order to help the developer to debug its configuration, it is convenient to display the actual value of environment variables present in the dumped configuration, instead of placeholders.

Here is the result:

$ symfony console debug:config framework | grep secret    secret: '%env(APP_SECRET)%'    secrets:        vault_directory: '/home/alexandredaubois/(...)/config/secrets/%env(default:kernel.environment:APP_RUNTIME_ENV)%'$ symfony console debug:config framework --resolve-env | grep secret    secret: 90d83502629d64dec4cd6e33c9b31267    secrets:        vault_directory: /home/alexandredaubois/(...)/config/secrets/dev

carsonbot added Status: Needs Review Feature FrameworkBundle labels

Jul 1, 2022

carsonbot added this to the6.2 milestone

Jul 1, 2022

alexandre-daubois mentioned this pull request

Jul 1, 2022

[FrameworkBundle] Added resolve-env option to debug:config command#40688

Closed

alexandre-daubois force-pushed thefeat-resolve-env branch fromf93623d toaf3940eCompare

July 1, 2022 07:18

Copy link

carsonbot commentedJul 2, 2022

Hey!

I think@jack-worman has recently worked with this code. Maybe they can help review this?

Cheers!

Carsonbot

alamirault approved these changes

Jul 2, 2022

View reviewed changes

carsonbot added Status: Reviewed and removed Status: Needs Review labels

Jul 2, 2022

GromNaN approved these changes

Jul 13, 2022

View reviewed changes

Copy link

Member

GromNaN left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Very nice feature. It simplifies debug of env var processing.

Thanks to it, I found something that looks like a bug.

$SYMFONY_DECRYPTION_SECRET=Zm9v bin/console debug:config framework secrets.decryption_env_var --resolve-envCurrent configuration for "framework.secrets.decryption_env_var"================================================================'base64:default::SYMFONY_DECRYPTION_SECRET'

src/Symfony/Bundle/FrameworkBundle/Command/ConfigDebugCommand.php OutdatedShow resolvedHide resolved

alexandre-daubois force-pushed thefeat-resolve-env branch fromaf3940e to8f593c6Compare

July 13, 2022 14:45

Copy link

MemberAuthor

alexandre-daubois commentedJul 13, 2022

Didn't think of this case@GromNaN, thank you! I'm taking a look at it soon.

Copy link

Member

GromNaN commentedJul 13, 2022•
edited
Loading

That seems to be a special feature made by@nicolas-grekas. The value is correctly resolved by the command from a config pov.

symfony/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php

Lines 1725 to 1735 in517530c

	if ($config['decryption_env_var']) {
	if (!preg_match('/^(?:[-.\w\\\\]+:)+\w++$/',$config['decryption_env_var'])) {
	thrownewInvalidArgumentException(sprintf('Invalid value "%s" set as "decryption_env_var": only "word" characters are allowed.',$config['decryption_env_var']));
	}

	if (ContainerBuilder::willBeAvailable('symfony/string', LazyString::class, ['symfony/framework-bundle'])) {
	$container->getDefinition('secrets.decryption_key')->replaceArgument(1,$config['decryption_env_var']);
	}else {
	$container->getDefinition('secrets.vault')->replaceArgument(1,"%env({$config['decryption_env_var']})%");
	$container->removeDefinition('secrets.decryption_key');
	}