Skip to content

Add support for env processor #200

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
merged 4 commits into from
Feb 3, 2022
Merged

Add support for env processor #200

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fe10d57
Add support for env processor
VincentLanglet Oct 8, 2021
5bf02f7
Cs
VincentLanglet Oct 8, 2021
b5a9373
Use type string resolver
VincentLanglet Jan 22, 2022
58b5a97
Add class_exists check
VincentLanglet Jan 22, 2022
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
51 changes: 49 additions & 2 deletions src/Type/Symfony/ParameterDynamicReturnTypeExtension.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

use PhpParser\Node\Expr\MethodCall;
use PHPStan\Analyser\Scope;
use PHPStan\PhpDoc\TypeStringResolver;
use PHPStan\Reflection\MethodReflection;
use PHPStan\Reflection\ParametersAcceptorSelector;
use PHPStan\ShouldNotHappenException;
Expand All @@ -22,8 +23,10 @@
use PHPStan\Type\NullType;
use PHPStan\Type\StringType;
use PHPStan\Type\Type;
use PHPStan\Type\TypeCombinator;
use PHPStan\Type\TypeTraverser;
use PHPStan\Type\UnionType;
use Symfony\Component\DependencyInjection\EnvVarProcessor;
use function in_array;

final class ParameterDynamicReturnTypeExtension implements DynamicMethodReturnTypeExtension
Expand All @@ -44,13 +47,24 @@ final class ParameterDynamicReturnTypeExtension implements DynamicMethodReturnTy
/** @var \PHPStan\Symfony\ParameterMap */
private $parameterMap;

public function __construct(string $className, ?string $methodGet, ?string $methodHas, Configuration $configuration, ParameterMap $symfonyParameterMap)
/** @var \PHPStan\PhpDoc\TypeStringResolver */
private $typeStringResolver;

public function __construct(
string $className,
?string $methodGet,
?string $methodHas,
Configuration $configuration,
ParameterMap $symfonyParameterMap,
TypeStringResolver $typeStringResolver
)
{
$this->className = $className;
$this->methodGet = $methodGet;
$this->methodHas = $methodHas;
$this->constantHassers = $configuration->hasConstantHassers();
$this->parameterMap = $symfonyParameterMap;
$this->typeStringResolver = $typeStringResolver;
}

public function getClass(): string
Expand Down Expand Up @@ -102,13 +116,46 @@ private function getGetTypeFromMethodCall(
if ($parameterKey !== null) {
$parameter = $this->parameterMap->getParameter($parameterKey);
if ($parameter !== null) {
return $this->generalizeType($scope->getTypeFromValue($parameter->getValue()));
return $this->generalizeTypeFromValue($scope, $parameter->getValue());
}
}

return $returnType;
}

/**
* @param Scope $scope
* @param array<mixed>|bool|float|int|string $value
*/
private function generalizeTypeFromValue(Scope $scope, $value): Type
{
if (is_array($value) && $value !== []) {
return $this->generalizeType(
new ArrayType(
TypeCombinator::union(...array_map(function ($item) use ($scope): Type {
return $this->generalizeTypeFromValue($scope, $item);
}, array_keys($value))),
TypeCombinator::union(...array_map(function ($item) use ($scope): Type {
return $this->generalizeTypeFromValue($scope, $item);
}, array_values($value)))
)
);
}

if (
class_exists(EnvVarProcessor::class)
&& is_string($value)
&& preg_match('/%env\((.*)\:.*\)%/U', $value, $matches) === 1
&& strlen($matches[0]) === strlen($value)
) {
$providedTypes = EnvVarProcessor::getProvidedTypes();
Copy link
Collaborator

@lookyman lookyman Jan 9, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

This introduces a hard dependency on symfony/dependency-injection in composer.json. I get the idea about not duplicating Symfony's internal code here, but if we want to do it like that, we need to use something like call_user_func(['\Symfony\Component\DependencyInjection\EnvVarProcessor', 'getProvidedTypes']), and probably even wrap it in some class_exists. Might be easier just to copy that array.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I got the opposite review here: #200 (comment)

So I'll go with the class_exists solution.

Does

if (
			is_string($value)
			&& preg_match('/%env\((.*)\:.*\)%/U', $value, $matches) === 1
			&& strlen($matches[0]) === strlen($value)
			&& class_exists(EnvVarProcessor::class)
		) {
			$providedTypes = EnvVarProcessor::getProvidedTypes();

			return $this->typeStringResolver->resolve($providedTypes[$matches[1]] ?? 'bool|int|float|string|array');
		}

wouldn't be enough ?


return $this->typeStringResolver->resolve($providedTypes[$matches[1]] ?? 'bool|int|float|string|array');
}

return $this->generalizeType($scope->getTypeFromValue($value));
}

private function generalizeType(Type $type): Type
{
return TypeTraverser::map($type, function (Type $type, callable $traverse): Type {
Expand Down
13 changes: 13 additions & 0 deletions tests/Type/Symfony/container.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,28 @@
<parameter key="app.string">abcdef</parameter>
<parameter key="app.int">123</parameter>
<parameter key="app.int_as_string" type="string">123</parameter>
<parameter key="app.int_as_processor">%env(int:APP_INT)%</parameter>
<parameter key="app.float">123.45</parameter>
<parameter key="app.float_as_string" type="string">123.45</parameter>
<parameter key="app.float_as_processor">%env(float:APP_FLOAT)%</parameter>
<parameter key="app.boolean">true</parameter>
<parameter key="app.boolean_as_string" type="string">true</parameter>
<parameter key="app.boolean_as_processor">%env(bool:APP_BOOL)%</parameter>
<parameter key="app.list" type="collection">
<parameter>en</parameter>
<parameter>es</parameter>
<parameter>fr</parameter>
</parameter>
<parameter key="app.list_of_int" type="collection">
<parameter>123</parameter>
<parameter>456</parameter>
<parameter>789</parameter>
</parameter>
<parameter key="app.list_of_int_as_processor" type="collection">
<parameter>%env(int:APP_INT)%</parameter>
<parameter>%env(int:APP_INT)%</parameter>
<parameter>%env(int:APP_INT)%</parameter>
</parameter>
<parameter key="app.list_of_list" type="collection">
<parameter type="collection">
<parameter key="name">the name</parameter>
Expand Down
11 changes: 11 additions & 0 deletions tests/Type/Symfony/data/ExampleAbstractController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,9 @@ public function parameters(ContainerInterface $container, ParameterBagInterface
assertType("string", $container->getParameter('app.int_as_string'));
assertType("string", $parameterBag->get('app.int_as_string'));
assertType("string", $this->getParameter('app.int_as_string'));
assertType('int', $container->getParameter('app.int_as_processor'));
assertType('int', $parameterBag->get('app.int_as_processor'));
assertType('int', $this->getParameter('app.int_as_processor'));
assertType('float', $container->getParameter('app.float'));
assertType('float', $parameterBag->get('app.float'));
assertType('float', $this->getParameter('app.float'));
Expand All @@ -54,6 +57,12 @@ public function parameters(ContainerInterface $container, ParameterBagInterface
assertType("array<int, string>", $container->getParameter('app.list'));
assertType("array<int, string>", $parameterBag->get('app.list'));
assertType("array<int, string>", $this->getParameter('app.list'));
assertType("array<int, int>", $container->getParameter('app.list_of_int'));
assertType("array<int, int>", $parameterBag->get('app.list_of_int'));
assertType("array<int, int>", $this->getParameter('app.list_of_int'));
assertType("array<int, int>", $container->getParameter('app.list_of_int_as_processor'));
assertType("array<int, int>", $parameterBag->get('app.list_of_int_as_processor'));
assertType("array<int, int>", $this->getParameter('app.list_of_int_as_processor'));
assertType("array<int, array<string, string>>", $container->getParameter('app.list_of_list'));
assertType("array<int, array<string, string>>", $parameterBag->get('app.list_of_list'));
assertType("array<int, array<string, string>>", $this->getParameter('app.list_of_list'));
Expand All @@ -77,6 +86,8 @@ public function parameters(ContainerInterface $container, ParameterBagInterface
assertType('true', $parameterBag->has('app.int'));
assertType('true', $container->hasParameter('app.int_as_string'));
assertType('true', $parameterBag->has('app.int_as_string'));
assertType('true', $container->hasParameter('app.int_as_processor'));
assertType('true', $parameterBag->has('app.int_as_processor'));
assertType('true', $container->hasParameter('app.float'));
assertType('true', $parameterBag->has('app.float'));
assertType('true', $container->hasParameter('app.float_as_string'));
Expand Down
15 changes: 15 additions & 0 deletions tests/Type/Symfony/data/ExampleAbstractControllerWithoutContainer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,18 +38,27 @@ public function parameters(ContainerInterface $container, ParameterBagInterface
assertType('array|bool|float|int|string|null', $container->getParameter('app.int_as_string'));
assertType('array|bool|float|int|string|null', $parameterBag->get('app.int_as_string'));
assertType('array|bool|float|int|string|null', $this->getParameter('app.int_as_string'));
assertType('array|bool|float|int|string|null', $container->getParameter('app.int_as_processor'));
assertType('array|bool|float|int|string|null', $parameterBag->get('app.int_as_processor'));
assertType('array|bool|float|int|string|null', $this->getParameter('app.int_as_processor'));
assertType('array|bool|float|int|string|null', $container->getParameter('app.float'));
assertType('array|bool|float|int|string|null', $parameterBag->get('app.float'));
assertType('array|bool|float|int|string|null', $this->getParameter('app.float'));
assertType('array|bool|float|int|string|null', $container->getParameter('app.float_as_string'));
assertType('array|bool|float|int|string|null', $parameterBag->get('app.float_as_string'));
assertType('array|bool|float|int|string|null', $this->getParameter('app.float_as_string'));
assertType('array|bool|float|int|string|null', $container->getParameter('app.float_as_processor'));
assertType('array|bool|float|int|string|null', $parameterBag->get('app.float_as_processor'));
assertType('array|bool|float|int|string|null', $this->getParameter('app.float_as_processor'));
assertType('array|bool|float|int|string|null', $container->getParameter('app.boolean'));
assertType('array|bool|float|int|string|null', $parameterBag->get('app.boolean'));
assertType('array|bool|float|int|string|null', $this->getParameter('app.boolean'));
assertType('array|bool|float|int|string|null', $container->getParameter('app.boolean_as_string'));
assertType('array|bool|float|int|string|null', $parameterBag->get('app.boolean_as_string'));
assertType('array|bool|float|int|string|null', $this->getParameter('app.boolean_as_string'));
assertType('array|bool|float|int|string|null', $container->getParameter('app.boolean_as_processor'));
assertType('array|bool|float|int|string|null', $parameterBag->get('app.boolean_as_processor'));
assertType('array|bool|float|int|string|null', $this->getParameter('app.boolean_as_processor'));
assertType('array|bool|float|int|string|null', $container->getParameter('app.list'));
assertType('array|bool|float|int|string|null', $parameterBag->get('app.list'));
assertType('array|bool|float|int|string|null', $this->getParameter('app.list'));
Expand All @@ -74,14 +83,20 @@ public function parameters(ContainerInterface $container, ParameterBagInterface
assertType('bool', $parameterBag->has('app.int'));
assertType('bool', $container->hasParameter('app.int_as_string'));
assertType('bool', $parameterBag->has('app.int_as_string'));
assertType('bool', $container->hasParameter('app.int_as_processor'));
assertType('bool', $parameterBag->has('app.int_as_processor'));
assertType('bool', $container->hasParameter('app.float'));
assertType('bool', $parameterBag->has('app.float'));
assertType('bool', $container->hasParameter('app.float_as_string'));
assertType('bool', $parameterBag->has('app.float_as_string'));
assertType('bool', $container->hasParameter('app.float_as_processor'));
assertType('bool', $parameterBag->has('app.float_as_processor'));
assertType('bool', $container->hasParameter('app.boolean'));
assertType('bool', $parameterBag->has('app.boolean'));
assertType('bool', $container->hasParameter('app.boolean_as_string'));
assertType('bool', $parameterBag->has('app.boolean_as_string'));
assertType('bool', $container->hasParameter('app.boolean_as_processor'));
assertType('bool', $parameterBag->has('app.boolean_as_processor'));
assertType('bool', $container->hasParameter('app.list'));
assertType('bool', $parameterBag->has('app.list'));
assertType('bool', $container->hasParameter('app.list_of_list'));
Expand Down
15 changes: 15 additions & 0 deletions tests/Type/Symfony/data/ExampleController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,18 +39,27 @@ public function parameters(ContainerInterface $container, ParameterBagInterface
assertType("string", $container->getParameter('app.int_as_string'));
assertType("string", $parameterBag->get('app.int_as_string'));
assertType("string", $this->getParameter('app.int_as_string'));
assertType('int', $container->getParameter('app.int_as_processor'));
assertType('int', $parameterBag->get('app.int_as_processor'));
assertType('int', $this->getParameter('app.int_as_processor'));
assertType('float', $container->getParameter('app.float'));
assertType('float', $parameterBag->get('app.float'));
assertType('float', $this->getParameter('app.float'));
assertType("string", $container->getParameter('app.float_as_string'));
assertType("string", $parameterBag->get('app.float_as_string'));
assertType("string", $this->getParameter('app.float_as_string'));
assertType('float', $container->getParameter('app.float_as_processor'));
assertType('float', $parameterBag->get('app.float_as_processor'));
assertType('float', $this->getParameter('app.float_as_processor'));
assertType('bool', $container->getParameter('app.boolean'));
assertType('bool', $parameterBag->get('app.boolean'));
assertType('bool', $this->getParameter('app.boolean'));
assertType("string", $container->getParameter('app.boolean_as_string'));
assertType("string", $parameterBag->get('app.boolean_as_string'));
assertType("string", $this->getParameter('app.boolean_as_string'));
assertType('bool', $container->getParameter('app.boolean_as_processor'));
assertType('bool', $parameterBag->get('app.boolean_as_processor'));
assertType('bool', $this->getParameter('app.boolean_as_processor'));
assertType("array<int, string>", $container->getParameter('app.list'));
assertType("array<int, string>", $parameterBag->get('app.list'));
assertType("array<int, string>", $this->getParameter('app.list'));
Expand All @@ -75,14 +84,20 @@ public function parameters(ContainerInterface $container, ParameterBagInterface
assertType('true', $parameterBag->has('app.int'));
assertType('true', $container->hasParameter('app.int_as_string'));
assertType('true', $parameterBag->has('app.int_as_string'));
assertType('true', $container->hasParameter('app.int_as_processor'));
assertType('true', $parameterBag->has('app.int_as_processor'));
assertType('true', $container->hasParameter('app.float'));
assertType('true', $parameterBag->has('app.float'));
assertType('true', $container->hasParameter('app.float_as_string'));
assertType('true', $parameterBag->has('app.float_as_string'));
assertType('true', $container->hasParameter('app.float_as_processor'));
assertType('true', $parameterBag->has('app.float_as_processor'));
assertType('true', $container->hasParameter('app.boolean'));
assertType('true', $parameterBag->has('app.boolean'));
assertType('true', $container->hasParameter('app.boolean_as_string'));
assertType('true', $parameterBag->has('app.boolean_as_string'));
assertType('true', $container->hasParameter('app.boolean_as_processor'));
assertType('true', $parameterBag->has('app.boolean_as_processor'));
assertType('true', $container->hasParameter('app.list'));
assertType('true', $parameterBag->has('app.list'));
assertType('true', $container->hasParameter('app.list_of_list'));
Expand Down
15 changes: 15 additions & 0 deletions tests/Type/Symfony/data/ExampleControllerWithoutContainer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,18 +38,27 @@ public function parameters(ContainerInterface $container, ParameterBagInterface
assertType('array|bool|float|int|string|null', $container->getParameter('app.int_as_string'));
assertType('array|bool|float|int|string|null', $parameterBag->get('app.int_as_string'));
assertType('array|bool|float|int|string|null', $this->getParameter('app.int_as_string'));
assertType('array|bool|float|int|string|null', $container->getParameter('app.int_as_processor'));
assertType('array|bool|float|int|string|null', $parameterBag->get('app.int_as_processor'));
assertType('array|bool|float|int|string|null', $this->getParameter('app.int_as_processor'));
assertType('array|bool|float|int|string|null', $container->getParameter('app.float'));
assertType('array|bool|float|int|string|null', $parameterBag->get('app.float'));
assertType('array|bool|float|int|string|null', $this->getParameter('app.float'));
assertType('array|bool|float|int|string|null', $container->getParameter('app.float_as_string'));
assertType('array|bool|float|int|string|null', $parameterBag->get('app.float_as_string'));
assertType('array|bool|float|int|string|null', $this->getParameter('app.float_as_string'));
assertType('array|bool|float|int|string|null', $container->getParameter('app.float_as_processor'));
assertType('array|bool|float|int|string|null', $parameterBag->get('app.float_as_processor'));
assertType('array|bool|float|int|string|null', $this->getParameter('app.float_as_processor'));
assertType('array|bool|float|int|string|null', $container->getParameter('app.boolean'));
assertType('array|bool|float|int|string|null', $parameterBag->get('app.boolean'));
assertType('array|bool|float|int|string|null', $this->getParameter('app.boolean'));
assertType('array|bool|float|int|string|null', $container->getParameter('app.boolean_as_string'));
assertType('array|bool|float|int|string|null', $parameterBag->get('app.boolean_as_string'));
assertType('array|bool|float|int|string|null', $this->getParameter('app.boolean_as_string'));
assertType('array|bool|float|int|string|null', $container->getParameter('app.boolean_as_processor'));
assertType('array|bool|float|int|string|null', $parameterBag->get('app.boolean_as_processor'));
assertType('array|bool|float|int|string|null', $this->getParameter('app.boolean_as_processor'));
assertType('array|bool|float|int|string|null', $container->getParameter('app.list'));
assertType('array|bool|float|int|string|null', $parameterBag->get('app.list'));
assertType('array|bool|float|int|string|null', $this->getParameter('app.list'));
Expand All @@ -74,14 +83,20 @@ public function parameters(ContainerInterface $container, ParameterBagInterface
assertType('bool', $parameterBag->has('app.int'));
assertType('bool', $container->hasParameter('app.int_as_string'));
assertType('bool', $parameterBag->has('app.int_as_string'));
assertType('bool', $container->hasParameter('app.int_as_processor'));
assertType('bool', $parameterBag->has('app.int_as_processor'));
assertType('bool', $container->hasParameter('app.float'));
assertType('bool', $parameterBag->has('app.float'));
assertType('bool', $container->hasParameter('app.float_as_string'));
assertType('bool', $parameterBag->has('app.float_as_string'));
assertType('bool', $container->hasParameter('app.float_as_processor'));
assertType('bool', $parameterBag->has('app.float_as_processor'));
assertType('bool', $container->hasParameter('app.boolean'));
assertType('bool', $parameterBag->has('app.boolean'));
assertType('bool', $container->hasParameter('app.boolean_as_string'));
assertType('bool', $parameterBag->has('app.boolean_as_string'));
assertType('bool', $container->hasParameter('app.boolean_as_processor'));
assertType('bool', $parameterBag->has('app.boolean_as_processor'));
assertType('bool', $container->hasParameter('app.list'));
assertType('bool', $parameterBag->has('app.list'));
assertType('bool', $container->hasParameter('app.list_of_list'));
Expand Down