ExpressionTypeResolverExtension

janedbal · ondrejmirtes · commit aa35eecbe990 · 2023-12-01T15:31:09.000+01:00
diff --git a/conf/config.neon b/conf/config.neon
@@ -588,6 +588,10 @@ services:
 		class: PHPStan\DependencyInjection\Type\DynamicReturnTypeExtensionRegistryProvider
 		factory: PHPStan\DependencyInjection\Type\LazyDynamicReturnTypeExtensionRegistryProvider
 
+	-
+		class: PHPStan\DependencyInjection\Type\ExpressionTypeResolverExtensionRegistryProvider
+		factory: PHPStan\DependencyInjection\Type\LazyExpressionTypeResolverExtensionRegistryProvider
+
 	-
 		class: PHPStan\DependencyInjection\Type\OperatorTypeSpecifyingExtensionRegistryProvider
 		factory: PHPStan\DependencyInjection\Type\LazyOperatorTypeSpecifyingExtensionRegistryProvider
diff --git a/src/Analyser/DirectInternalScopeFactory.php b/src/Analyser/DirectInternalScopeFactory.php
@@ -3,6 +3,7 @@
 namespace PHPStan\Analyser;
 
 use PHPStan\DependencyInjection\Type\DynamicReturnTypeExtensionRegistryProvider;
+use PHPStan\DependencyInjection\Type\ExpressionTypeResolverExtensionRegistryProvider;
 use PHPStan\Node\Printer\ExprPrinter;
 use PHPStan\Parser\Parser;
 use PHPStan\Php\PhpVersion;
@@ -26,6 +27,7 @@ public function __construct(
 		private ReflectionProvider $reflectionProvider,
 		private InitializerExprTypeResolver $initializerExprTypeResolver,
 		private DynamicReturnTypeExtensionRegistryProvider $dynamicReturnTypeExtensionRegistryProvider,
+		private ExpressionTypeResolverExtensionRegistryProvider $expressionTypeResolverExtensionRegistryProvider,
 		private ExprPrinter $exprPrinter,
 		private TypeSpecifier $typeSpecifier,
 		private PropertyReflectionFinder $propertyReflectionFinder,
@@ -76,6 +78,7 @@ public function create(
 			$this->reflectionProvider,
 			$this->initializerExprTypeResolver,
 			$this->dynamicReturnTypeExtensionRegistryProvider->getRegistry(),
+			$this->expressionTypeResolverExtensionRegistryProvider->getRegistry(),
 			$this->exprPrinter,
 			$this->typeSpecifier,
 			$this->propertyReflectionFinder,
diff --git a/src/Analyser/LazyInternalScopeFactory.php b/src/Analyser/LazyInternalScopeFactory.php
@@ -4,6 +4,7 @@
 
 use PHPStan\DependencyInjection\Container;
 use PHPStan\DependencyInjection\Type\DynamicReturnTypeExtensionRegistryProvider;
+use PHPStan\DependencyInjection\Type\ExpressionTypeResolverExtensionRegistryProvider;
 use PHPStan\Node\Printer\ExprPrinter;
 use PHPStan\Php\PhpVersion;
 use PHPStan\Reflection\FunctionReflection;
@@ -72,6 +73,7 @@ public function create(
 			$this->container->getByType(ReflectionProvider::class),
 			$this->container->getByType(InitializerExprTypeResolver::class),
 			$this->container->getByType(DynamicReturnTypeExtensionRegistryProvider::class)->getRegistry(),
+			$this->container->getByType(ExpressionTypeResolverExtensionRegistryProvider::class)->getRegistry(),
 			$this->container->getByType(ExprPrinter::class),
 			$this->container->getByType(TypeSpecifier::class),
 			$this->container->getByType(PropertyReflectionFinder::class),
diff --git a/src/Analyser/MutatingScope.php b/src/Analyser/MutatingScope.php
@@ -86,6 +86,7 @@
 use PHPStan\Type\ConstantTypeHelper;
 use PHPStan\Type\DynamicReturnTypeExtensionRegistry;
 use PHPStan\Type\ErrorType;
+use PHPStan\Type\ExpressionTypeResolverExtensionRegistry;
 use PHPStan\Type\GeneralizePrecision;
 use PHPStan\Type\Generic\GenericClassStringType;
 use PHPStan\Type\Generic\GenericObjectType;
@@ -178,6 +179,7 @@ public function __construct(
 		private ReflectionProvider $reflectionProvider,
 		private InitializerExprTypeResolver $initializerExprTypeResolver,
 		private DynamicReturnTypeExtensionRegistry $dynamicReturnTypeExtensionRegistry,
+		private ExpressionTypeResolverExtensionRegistry $expressionTypeResolverExtensionRegistry,
 		private ExprPrinter $exprPrinter,
 		private TypeSpecifier $typeSpecifier,
 		private PropertyReflectionFinder $propertyReflectionFinder,
@@ -679,6 +681,13 @@ private function getNodeKey(Expr $node): string
 
 	private function resolveType(string $exprString, Expr $node): Type
 	{
+		foreach ($this->expressionTypeResolverExtensionRegistry->getExtensions() as $extension) {
+			$type = $extension->getType($node, $this);
+			if ($type !== null) {
+				return $type;
+			}
+		}
+
 		if ($node instanceof Expr\Exit_ || $node instanceof Expr\Throw_) {
 			return new NonAcceptingNeverType();
 		}
diff --git a/src/Broker/BrokerFactory.php b/src/Broker/BrokerFactory.php
@@ -15,6 +15,7 @@ class BrokerFactory
 	public const DYNAMIC_STATIC_METHOD_RETURN_TYPE_EXTENSION_TAG = 'phpstan.broker.dynamicStaticMethodReturnTypeExtension';
 	public const DYNAMIC_FUNCTION_RETURN_TYPE_EXTENSION_TAG = 'phpstan.broker.dynamicFunctionReturnTypeExtension';
 	public const OPERATOR_TYPE_SPECIFYING_EXTENSION_TAG = 'phpstan.broker.operatorTypeSpecifyingExtension';
+	public const EXPRESSION_TYPE_RESOLVER_EXTENSION_TAG = 'phpstan.broker.expressionTypeResolverExtension';
 
 	public function __construct(private Container $container)
 	{
diff --git a/src/DependencyInjection/ConditionalTagsExtension.php b/src/DependencyInjection/ConditionalTagsExtension.php
@@ -33,6 +33,7 @@ public function getConfigSchema(): Nette\Schema\Schema
 			BrokerFactory::DYNAMIC_METHOD_RETURN_TYPE_EXTENSION_TAG => $bool,
 			BrokerFactory::DYNAMIC_STATIC_METHOD_RETURN_TYPE_EXTENSION_TAG => $bool,
 			BrokerFactory::DYNAMIC_FUNCTION_RETURN_TYPE_EXTENSION_TAG => $bool,
+			BrokerFactory::EXPRESSION_TYPE_RESOLVER_EXTENSION_TAG => $bool,
 			BrokerFactory::OPERATOR_TYPE_SPECIFYING_EXTENSION_TAG => $bool,
 			BrokerFactory::ALLOWED_SUB_TYPES_CLASS_REFLECTION_EXTENSION_TAG => $bool,
 			LazyRegistry::RULE_TAG => $bool,
diff --git a/src/DependencyInjection/Type/ExpressionTypeResolverExtensionRegistryProvider.php b/src/DependencyInjection/Type/ExpressionTypeResolverExtensionRegistryProvider.php
@@ -0,0 +1,12 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\DependencyInjection\Type;
+
+use PHPStan\Type\ExpressionTypeResolverExtensionRegistry;
+
+interface ExpressionTypeResolverExtensionRegistryProvider
+{
+
+	public function getRegistry(): ExpressionTypeResolverExtensionRegistry;
+
+}
diff --git a/src/DependencyInjection/Type/LazyExpressionTypeResolverExtensionRegistryProvider.php b/src/DependencyInjection/Type/LazyExpressionTypeResolverExtensionRegistryProvider.php
@@ -0,0 +1,29 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\DependencyInjection\Type;
+
+use PHPStan\Broker\BrokerFactory;
+use PHPStan\DependencyInjection\Container;
+use PHPStan\Type\ExpressionTypeResolverExtensionRegistry;
+
+class LazyExpressionTypeResolverExtensionRegistryProvider implements ExpressionTypeResolverExtensionRegistryProvider
+{
+
+	private ?ExpressionTypeResolverExtensionRegistry $registry = null;
+
+	public function __construct(private Container $container)
+	{
+	}
+
+	public function getRegistry(): ExpressionTypeResolverExtensionRegistry
+	{
+		if ($this->registry === null) {
+			$this->registry = new ExpressionTypeResolverExtensionRegistry(
+				$this->container->getServicesByTag(BrokerFactory::EXPRESSION_TYPE_RESOLVER_EXTENSION_TAG),
+			);
+		}
+
+		return $this->registry;
+	}
+
+}
diff --git a/src/Testing/PHPStanTestCase.php b/src/Testing/PHPStanTestCase.php
@@ -18,6 +18,7 @@
 use PHPStan\DependencyInjection\ContainerFactory;
 use PHPStan\DependencyInjection\Reflection\ClassReflectionExtensionRegistryProvider;
 use PHPStan\DependencyInjection\Type\DynamicReturnTypeExtensionRegistryProvider;
+use PHPStan\DependencyInjection\Type\ExpressionTypeResolverExtensionRegistryProvider;
 use PHPStan\DependencyInjection\Type\OperatorTypeSpecifyingExtensionRegistryProvider;
 use PHPStan\File\FileHelper;
 use PHPStan\Internal\DirectoryCreator;
@@ -180,6 +181,7 @@ public static function createScopeFactory(ReflectionProvider $reflectionProvider
 					$container->getParameter('usePathConstantsAsConstantString'),
 				),
 				$container->getByType(DynamicReturnTypeExtensionRegistryProvider::class),
+				$container->getByType(ExpressionTypeResolverExtensionRegistryProvider::class),
 				$container->getByType(ExprPrinter::class),
 				$typeSpecifier,
 				new PropertyReflectionFinder(),
diff --git a/src/Type/ExpressionTypeResolverExtension.php b/src/Type/ExpressionTypeResolverExtension.php
@@ -0,0 +1,28 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Type;
+
+use PhpParser\Node\Expr;
+use PHPStan\Analyser\Scope;
+
+/**
+ * To register it in the configuration file use the `phpstan.broker.expressionTypeResolverExtension` service tag:
+ *
+ * ```
+ * services:
+ * 	-
+ *		class: App\PHPStan\MyExtension
+ *		tags:
+ *			- phpstan.broker.expressionTypeResolverExtension
+ * ```
+ *
+ * You should return null in your extension if you don't care about given Expr.
+ *
+ * @api
+ */
+interface ExpressionTypeResolverExtension
+{
+
+	public function getType(Expr $expr, Scope $scope): ?Type;
+
+}
diff --git a/src/Type/ExpressionTypeResolverExtensionRegistry.php b/src/Type/ExpressionTypeResolverExtensionRegistry.php
@@ -0,0 +1,25 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Type;
+
+class ExpressionTypeResolverExtensionRegistry
+{
+
+	/**
+	 * @param array<ExpressionTypeResolverExtension> $extensions
+	 */
+	public function __construct(
+		private array $extensions,
+	)
+	{
+	}
+
+	/**
+	 * @return array<ExpressionTypeResolverExtension>
+	 */
+	public function getExtensions(): array
+	{
+		return $this->extensions;
+	}
+
+}
diff --git a/tests/PHPStan/Analyser/ExpressionTypeResolverExtensionTest.php b/tests/PHPStan/Analyser/ExpressionTypeResolverExtensionTest.php
@@ -0,0 +1,35 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Analyser;
+
+use PHPStan\Testing\TypeInferenceTestCase;
+
+class ExpressionTypeResolverExtensionTest extends TypeInferenceTestCase
+{
+
+	public function dataFileAsserts(): iterable
+	{
+		yield from self::gatherAssertTypes(__DIR__ . '/data/expression-type-resolver-extension.php');
+	}
+
+	/**
+	 * @dataProvider dataFileAsserts
+	 * @param mixed ...$args
+	 */
+	public function testFileAsserts(
+		string $assertType,
+		string $file,
+		...$args,
+	): void
+	{
+		$this->assertFileAsserts($assertType, $file, ...$args);
+	}
+
+	public static function getAdditionalConfigFiles(): array
+	{
+		return [
+			__DIR__ . '/expression-type-resolver-extension.neon',
+		];
+	}
+
+}
diff --git a/tests/PHPStan/Analyser/data/MethodCallReturnsBoolExpressionTypeResolverExtension.php b/tests/PHPStan/Analyser/data/MethodCallReturnsBoolExpressionTypeResolverExtension.php
@@ -0,0 +1,46 @@
+<?php
+
+namespace ExpressionTypeResolverExtension;
+
+use PhpParser\Node\Expr;
+use PhpParser\Node\Expr\MethodCall;
+use PhpParser\Node\Identifier;
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\ParametersAcceptorSelector;
+use PHPStan\Type\BooleanType;
+use PHPStan\Type\ExpressionTypeResolverExtension;
+use PHPStan\Type\StringType;
+use PHPStan\Type\Type;
+
+class MethodCallReturnsBoolExpressionTypeResolverExtension implements ExpressionTypeResolverExtension {
+
+	public function getType(Expr $expr, Scope $scope): ?Type
+	{
+		if (!$expr instanceof MethodCall) {
+			return null;
+		}
+
+		if (!$expr->name instanceof Identifier) {
+			return null;
+		}
+
+		if ($expr->name->name !== 'methodReturningBoolNoMatterTheCallerUnlessReturnsString') {
+			return null;
+		}
+
+		$methodReflection = $scope->getMethodReflection($scope->getType($expr->var), $expr->name->name);
+
+		if ($methodReflection === null) {
+			return null;
+		}
+
+		$returnType = ParametersAcceptorSelector::selectSingle($methodReflection->getVariants())->getReturnType();
+
+		if ($returnType instanceof StringType) {
+			return null;
+		}
+
+		return new BooleanType();
+	}
+
+}
diff --git a/tests/PHPStan/Analyser/data/expression-type-resolver-extension.php b/tests/PHPStan/Analyser/data/expression-type-resolver-extension.php
@@ -0,0 +1,21 @@
+<?php
+
+// test file for ExpressionTypeResolverExtensionTest
+
+namespace ExpressionTypeResolverExtensionTest;
+
+use function PHPStan\Testing\assertType;
+
+class WhateverClass {
+	public function methodReturningBoolNoMatterTheCallerUnlessReturnsString() { return true; }
+}
+class WhateverClass2 {
+	public function methodReturningBoolNoMatterTheCallerUnlessReturnsString() { return true; }
+}
+class WhateverClass3 {
+	public function methodReturningBoolNoMatterTheCallerUnlessReturnsString(): string { return ''; }
+}
+
+assertType('bool', (new WhateverClass)->methodReturningBoolNoMatterTheCallerUnlessReturnsString());
+assertType('bool', (new WhateverClass2)->methodReturningBoolNoMatterTheCallerUnlessReturnsString());
+assertType('string', (new WhateverClass3)->methodReturningBoolNoMatterTheCallerUnlessReturnsString());
diff --git a/tests/PHPStan/Analyser/expression-type-resolver-extension.neon b/tests/PHPStan/Analyser/expression-type-resolver-extension.neon
@@ -0,0 +1,7 @@
+# config for ExpressionTypeResolverExtensionTest
+services:
+	-
+		class: ExpressionTypeResolverExtension\MethodCallReturnsBoolExpressionTypeResolverExtension
+		tags:
+			- phpstan.broker.expressionTypeResolverExtension
+

Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@ class BrokerFactory`
`15`	`15`	`public const DYNAMIC_STATIC_METHOD_RETURN_TYPE_EXTENSION_TAG = 'phpstan.broker.dynamicStaticMethodReturnTypeExtension';`
`16`	`16`	`public const DYNAMIC_FUNCTION_RETURN_TYPE_EXTENSION_TAG = 'phpstan.broker.dynamicFunctionReturnTypeExtension';`
`17`	`17`	`public const OPERATOR_TYPE_SPECIFYING_EXTENSION_TAG = 'phpstan.broker.operatorTypeSpecifyingExtension';`
	`18`	`+ public const EXPRESSION_TYPE_RESOLVER_EXTENSION_TAG = 'phpstan.broker.expressionTypeResolverExtension';`
`18`	`19`
`19`	`20`	`public function __construct(private Container $container)`
`20`	`21`	`{`