feature #53971 Cast env vars to null or bool when referencing them using #[Autowire(env: '...')] depending on the signature of the corresponding parameter (ruudk)

fabpot · fabpot · commit 50d7ce021d41 · 2024-04-13T09:23:43.000+02:00
This PR was merged into the 7.1 branch. Discussion ---------- Cast env vars to null or bool when referencing them using `#[Autowire(env: '...')]` depending on the signature of the corresponding parameter | Q | A | ------------- | --- | Branch? | 7.1 | Bug fix? | no | New feature? | yes | Deprecations? | no | Issues | Fix #53918 | License | MIT See #53918 This PR automatically adds `bool` [Environment Variable Processors](https://symfony.com/doc/current/configuration/env_var_processors.html#built-in-environment-variable-processors) on `#[Autowire(env: 'KEY')] bool $key` arguments. The idea behind this, is to prevent mistakes being made. If you omit the `bool` env var processor, passing `KEY=false` will become true-ish and thus mark `$key` as `true`. With the `bool` env processor, `KEY=false` becomes `false`. It also automatically adds the `default::` prefix if the default value of an argument is `null`. Commits ------- 5890327 [DependencyInjection] Cast env vars to null or bool when referencing them using `#[Autowire(env: '...')]` depending on the signature of the corresponding parameter
diff --git a/src/Symfony/Component/DependencyInjection/CHANGELOG.md b/src/Symfony/Component/DependencyInjection/CHANGELOG.md
@@ -12,6 +12,7 @@ CHANGELOG
  * Make `ContainerBuilder::registerAttributeForAutoconfiguration()` propagate to attribute classes that extend the registered class
  * Add argument `$prepend` to `FileLoader::construct()` to prepend loaded configuration instead of appending it
  * [BC BREAK] When used in the `prependExtension()` method, the `ContainerConfigurator::import()` method now prepends the configuration instead of appending it
+ * Cast env vars to null or bool when referencing them using `#[Autowire(env: '...')]` depending on the signature of the corresponding parameter
 
 7.0
 ---
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/AutowirePass.php b/src/Symfony/Component/DependencyInjection/Compiler/AutowirePass.php
@@ -306,6 +306,17 @@ private function autowireMethod(\ReflectionFunctionAbstract $reflectionMethod, a
 
                 foreach ($attributes as $attribute) {
                     $attribute = $attribute->newInstance();
+                    $value = $attribute instanceof Autowire ? $attribute->value : null;
+
+                    if (\is_string($value) && str_starts_with($value, '%env(') && str_ends_with($value, ')%')) {
+                        if ($parameter->getType() instanceof \ReflectionNamedType && 'bool' === $parameter->getType()->getName() && !str_starts_with($value, '%env(bool:')) {
+                            $attribute = new Autowire(substr_replace($value, 'bool:', 5, 0));
+                        }
+                        if ($parameter->isDefaultValueAvailable() && $parameter->allowsNull() && null === $parameter->getDefaultValue() && !preg_match('/(^|:)default:/', $value)) {
+                            $attribute = new Autowire(substr_replace($value, 'default::', 5, 0));
+                        }
+                    }
+
                     $invalidBehavior = $parameter->allowsNull() ? ContainerInterface::NULL_ON_INVALID_REFERENCE : ContainerBuilder::EXCEPTION_ON_INVALID_REFERENCE;
 
                     try {
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Compiler/AutowirePassTest.php b/src/Symfony/Component/DependencyInjection/Tests/Compiler/AutowirePassTest.php
@@ -1397,4 +1397,18 @@ public function testLazyNotCompatibleWithAutowire()
             $this->assertSame('Using both attributes #[Lazy] and #[Autowire] on an argument is not allowed; use the "lazy" parameter of #[Autowire] instead.', $e->getMessage());
         }
     }
+
+    public function testAutowireAttributeWithEnvVar()
+    {
+        $container = new ContainerBuilder();
+
+        $container->register('foo', AutowireAttributeEnv::class)->setAutowired(true);
+
+        (new AutowirePass())->process($container);
+
+        $definition = $container->getDefinition('foo');
+
+        $this->assertSame('%env(bool:ENABLED)%', $container->resolveEnvPlaceholders($definition->getArguments()[0]));
+        $this->assertSame('%env(default::OPTIONAL)%', $container->resolveEnvPlaceholders($definition->getArguments()[1]));
+    }
 }
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/includes/autowiring_classes_80.php b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/includes/autowiring_classes_80.php
@@ -81,6 +81,17 @@ public function __construct(
     }
 }
 
+class AutowireAttributeEnv
+{
+    public function __construct(
+        #[Autowire(env: 'ENABLED')]
+        public bool $enabled,
+        #[Autowire(env: 'OPTIONAL')]
+        public ?string $optional = null,
+    ) {
+    }
+}
+
 interface AsDecoratorInterface
 {
 }

Original file line number	Diff line number	Diff line change
`@@ -1397,4 +1397,18 @@ public function testLazyNotCompatibleWithAutowire()`
`1397`	`1397`	`$this->assertSame('Using both attributes #[Lazy] and #[Autowire] on an argument is not allowed; use the "lazy" parameter of #[Autowire] instead.', $e->getMessage());`
`1398`	`1398`	`}`
`1399`	`1399`	`}`
	`1400`	`+`
	`1401`	`+ public function testAutowireAttributeWithEnvVar()`
	`1402`	`+ {`
	`1403`	`+ $container = new ContainerBuilder();`
	`1404`	`+`
	`1405`	`+ $container->register('foo', AutowireAttributeEnv::class)->setAutowired(true);`
	`1406`	`+`
	`1407`	`+ (new AutowirePass())->process($container);`
	`1408`	`+`
	`1409`	`+ $definition = $container->getDefinition('foo');`
	`1410`	`+`
	`1411`	`+ $this->assertSame('%env(bool:ENABLED)%', $container->resolveEnvPlaceholders($definition->getArguments()[0]));`
	`1412`	`+ $this->assertSame('%env(default::OPTIONAL)%', $container->resolveEnvPlaceholders($definition->getArguments()[1]));`
	`1413`	`+ }`
`1400`	`1414`	`}`
Original file line number	Diff line number	Diff line change
`@@ -81,6 +81,17 @@ public function __construct(`
`81`	`81`	`}`
`82`	`82`	`}`
`83`	`83`
	`84`	`+class AutowireAttributeEnv`
	`85`	`+{`
	`86`	`+ public function __construct(`
	`87`	`+ #[Autowire(env: 'ENABLED')]`
	`88`	`+ public bool $enabled,`
	`89`	`+ #[Autowire(env: 'OPTIONAL')]`
	`90`	`+ public ?string $optional = null,`
	`91`	`+ ) {`
	`92`	`+ }`
	`93`	`+}`
	`94`	`+`
`84`	`95`	`interface AsDecoratorInterface`
`85`	`96`	`{`
`86`	`97`	`}`