Option to use the more expensive computation (off by default)

Author: ondrejmirtes

extension.neon

@@ -5,12 +5,17 @@ parameters:
 		allCollectionsSelectable: true
 		objectManagerLoader: null
 
+		# setting this to false might lead to performance problems
+		# it changes the braching logic - with false, queryBuilders from all branches are analysed separately
+		queryBuilderFastAlgorithm: true
+
 parametersSchema:
 	doctrine: structure([
 		repositoryClass: schema(string(), nullable())
 		queryBuilderClass: schema(string(), nullable())
 		allCollectionsSelectable: bool()
 		objectManagerLoader: schema(string(), nullable())
+		queryBuilderFastAlgorithm: bool()
 	])
 
 conditionalTags:
@@ -28,6 +33,7 @@ services:
 		class: PHPStan\Type\Doctrine\QueryBuilder\CreateQueryBuilderDynamicReturnTypeExtension
 		arguments:
 			queryBuilderClass: %doctrine.queryBuilderClass%
+			fasterVersion: %doctrine.queryBuilderFastAlgorithm%
 		tags:
 			- phpstan.broker.dynamicMethodReturnTypeExtension
 	-

rules.neon

@@ -8,6 +8,7 @@ parametersSchema:
 		queryBuilderClass: schema(string(), nullable())
 		allCollectionsSelectable: bool()
 		objectManagerLoader: schema(string(), nullable())
+		queryBuilderFastAlgorithm: bool()
 		reportDynamicQueryBuilders: bool()
 	])
 

src/Type/Doctrine/QueryBuilder/BranchingQueryBuilderType.php

@@ -0,0 +1,45 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Type\Doctrine\QueryBuilder;
+
+use PHPStan\TrinaryLogic;
+use PHPStan\Type\Type;
+
+class BranchingQueryBuilderType extends QueryBuilderType
+{
+
+	public function equals(Type $type): bool
+	{
+		if ($type instanceof parent) {
+			if (count($this->getMethodCalls()) !== count($type->getMethodCalls())) {
+				return false;
+			}
+
+			foreach ($this->getMethodCalls() as $id => $methodCall) {
+				if (!isset($type->getMethodCalls()[$id])) {
+					return false;
+				}
+			}
+
+			foreach ($type->getMethodCalls() as $id => $methodCall) {
+				if (!isset($this->getMethodCalls()[$id])) {
+					return false;
+				}
+			}
+
+			return true;
+		}
+
+		return parent::equals($type);
+	}
+
+	public function isSuperTypeOf(Type $type): TrinaryLogic
+	{
+		if ($type instanceof parent) {
+			return TrinaryLogic::createFromBoolean($this->equals($type));
+		}
+
+		return parent::isSuperTypeOf($type);
+	}
+
+}

src/Type/Doctrine/QueryBuilder/CreateQueryBuilderDynamicReturnTypeExtension.php

@@ -13,9 +13,16 @@ class CreateQueryBuilderDynamicReturnTypeExtension implements \PHPStan\Type\Dyna
 	/** @var string|null */
 	private $queryBuilderClass;
 
-	public function __construct(?string $queryBuilderClass)
+	/** @var bool */
+	private $fasterVersion;
+
+	public function __construct(
+		?string $queryBuilderClass,
+		bool $fasterVersion
+	)
 	{
 		$this->queryBuilderClass = $queryBuilderClass;
+		$this->fasterVersion = $fasterVersion;
 	}
 
 	public function getClass(): string
@@ -34,7 +41,12 @@ public function getTypeFromMethodCall(
 		Scope $scope
 	): Type
 	{
-		return new QueryBuilderType(
+		$class = SimpleQueryBuilderType::class;
+		if (!$this->fasterVersion) {
+			$class = BranchingQueryBuilderType::class;
+		}
+
+		return new $class(
 			$this->queryBuilderClass ?? 'Doctrine\ORM\QueryBuilder'
 		);
 	}

src/Type/Doctrine/QueryBuilder/QueryBuilderType.php

@@ -3,11 +3,9 @@
 namespace PHPStan\Type\Doctrine\QueryBuilder;
 
 use PhpParser\Node\Expr\MethodCall;
-use PHPStan\TrinaryLogic;
 use PHPStan\Type\ObjectType;
-use PHPStan\Type\Type;
 
-class QueryBuilderType extends ObjectType
+abstract class QueryBuilderType extends ObjectType
 {
 
 	/** @var array<string, MethodCall> */
@@ -21,37 +19,9 @@ public function getMethodCalls(): array
 		return $this->methodCalls;
 	}
 
-	public function equals(Type $type): bool
-	{
-		if ($type instanceof self) {
-			if (count($this->methodCalls) !== count($type->methodCalls)) {
-				return false;
-			}
-
-			foreach ($this->getMethodCalls() as $id => $methodCall) {
-				if (!isset($type->methodCalls[$id])) {
-					return false;
-				}
-			}
-
-			return true;
-		}
-
-		return parent::equals($type);
-	}
-
-	public function isSuperTypeOf(Type $type): TrinaryLogic
-	{
-		if ($type instanceof self) {
-			return TrinaryLogic::createFromBoolean($this->equals($type));
-		}
-
-		return parent::isSuperTypeOf($type);
-	}
-
 	public function append(MethodCall $methodCall): self
 	{
-		$object = new self($this->getClassName());
+		$object = new static($this->getClassName());
 		$object->methodCalls = $this->methodCalls;
 		$object->methodCalls[substr(md5(uniqid()), 0, 10)] = $methodCall;
 

src/Type/Doctrine/QueryBuilder/SimpleQueryBuilderType.php

@@ -0,0 +1,32 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Type\Doctrine\QueryBuilder;
+
+use PHPStan\TrinaryLogic;
+use PHPStan\Type\Type;
+
+class SimpleQueryBuilderType extends QueryBuilderType
+{
+
+	public function equals(Type $type): bool
+	{
+		if ($type instanceof parent) {
+			return count($this->getMethodCalls()) === count($type->getMethodCalls());
+		}
+
+		return parent::equals($type);
+	}
+
+	public function isSuperTypeOf(Type $type): TrinaryLogic
+	{
+		if ($type instanceof parent) {
+			$thisCount = count($this->getMethodCalls());
+			$thatCount = count($type->getMethodCalls());
+
+			return TrinaryLogic::createFromBoolean($thisCount >= $thatCount);
+		}
+
+		return parent::isSuperTypeOf($type);
+	}
+
+}

tests/Rules/Doctrine/ORM/QueryBuilderDqlRuleTest.php

@@ -19,13 +19,17 @@
 class QueryBuilderDqlRuleTest extends RuleTestCase
 {
 
+	/** @var bool */
+	private $fasterVersion;
+
 	protected function getRule(): Rule
 	{
 		return new QueryBuilderDqlRule(new ObjectMetadataResolver(__DIR__ . '/entity-manager.php', null), true);
 	}
 
 	public function testRule(): void
 	{
+		$this->fasterVersion = false;
 		$this->analyse([__DIR__ . '/data/query-builder-dql.php'], [
 			[
 				"QueryBuilder: [Syntax Error] line 0, col 66: Error: Expected end of string, got ')'\nDQL: SELECT e FROM PHPStan\Rules\Doctrine\ORM\MyEntity e WHERE e.id = 1)",
@@ -94,9 +98,22 @@ public function testRule(): void
 		]);
 	}
 
-	public function testRuleBranches(): void
+	/**
+	 * @return bool[][]
+	 */
+	public function dataRuleBranches(): array
 	{
-		$this->analyse([__DIR__ . '/data/query-builder-branches-dql.php'], [
+		return [[true], [false]];
+	}
+
+	/**
+	 * @dataProvider dataRuleBranches
+	 * @param bool $fasterVersion
+	 */
+	public function testRuleBranches(bool $fasterVersion): void
+	{
+		$this->fasterVersion = $fasterVersion;
+		$errors = [
 			[
 				'QueryBuilder: [Semantical Error] line 0, col 58 near \'p.id = 1\': Error: \'p\' is not defined.',
 				31,
@@ -105,10 +122,6 @@ public function testRuleBranches(): void
 				'QueryBuilder: [Semantical Error] line 0, col 58 near \'p.id = 1\': Error: \'p\' is not defined.',
 				45,
 			],
-			[
-				'QueryBuilder: [Semantical Error] line 0, col 58 near \'p.id = 1\': Error: \'p\' is not defined.',
-				59,
-			],
 			[
 				'QueryBuilder: [Semantical Error] line 0, col 93 near \'t.id = 1\': Error: \'t\' is not defined.',
 				90,
@@ -117,9 +130,29 @@ public function testRuleBranches(): void
 				'QueryBuilder: [Semantical Error] line 0, col 95 near \'foo = 1\': Error: Class PHPStan\Rules\Doctrine\ORM\MyEntity has no field or association named foo',
 				107,
 			],
-			[
+		];
+		if (!$fasterVersion) {
+			array_splice($errors, 2, 0, [
+				[
+					'QueryBuilder: [Semantical Error] line 0, col 58 near \'p.id = 1\': Error: \'p\' is not defined.',
+					59,
+				],
+			]);
+			$errors[] = [
 				'QueryBuilder: [Semantical Error] line 0, col 93 near \'t.id = 1\': Error: \'t\' is not defined.',
 				107,
+			];
+		}
+		$this->analyse([__DIR__ . '/data/query-builder-branches-dql.php'], $errors);
+	}
+
+	public function testBranchingPerformance(): void
+	{
+		$this->fasterVersion = true;
+		$this->analyse([__DIR__ . '/data/query-builder-branches-performance.php'], [
+			[
+				'QueryBuilder: [Semantical Error] line 0, col 58 near \'p.id = 1 AND\': Error: \'p\' is not defined.',
+				121,
 			],
 		]);
 	}
@@ -132,7 +165,7 @@ public function getDynamicMethodReturnTypeExtensions(): array
 		$objectMetadataResolver = new ObjectMetadataResolver(__DIR__ . '/entity-manager.php', null);
 		$argumentsProcessor = new ArgumentsProcessor();
 		return [
-			new CreateQueryBuilderDynamicReturnTypeExtension(null),
+			new CreateQueryBuilderDynamicReturnTypeExtension(null, $this->fasterVersion),
 			new QueryBuilderMethodDynamicReturnTypeExtension(null),
 			new QueryBuilderGetQueryDynamicReturnTypeExtension($objectMetadataResolver, $argumentsProcessor, null),
 			new QueryGetDqlDynamicReturnTypeExtension(),