QueryResultTypeWalker: precise type inferring

Author: janedbal

README.md

@@ -152,6 +152,12 @@ $query->getOneOrNullResult(Query::HYDRATE_OBJECT); // User
 
 This is due to the design of the `Query` class preventing from determining the hydration mode used by these functions unless it is specified explicitly during the call.
 
+### Expression types inferring
+
+Whether `MAX(e.id)` is fetched as `string` or `int` highly [depends on drivers, their setup and PHP version](https://github.com/janedbal/php-database-drivers-fetch-test).
+This extension copies the logic from linked analysis, autodetects your setup and provides accurate results for `pdo_mysql`, `mysqli`, `pdo_sqlite`, `sqlite3`, `pdo_pgsql` and `pgsql`.
+Any other driver will result in union with stringified version, e.g. `numeric-string|int`.
+
 ### Problematic approaches
 
 Not every QueryBuilder can be statically analysed, here are few advices to maximize type inferring:

phpstan.neon

@@ -49,3 +49,11 @@ parameters:
 				- '#^Cannot call method getWrappedResourceHandle\(\) on class\-string\|object\.$#'
 			path: tests/Platform/QueryResultTypeWalkerFetchTypeMatrixTest.php
 			reportUnmatched: false
+		-
+			message: '#^Call to function method_exists\(\) with Doctrine\\DBAL\\Connection and ''getNativeConnection'' will always evaluate to true\.$#' # needed for older DBAL versions
+			path: src/Type/Doctrine/Query/QueryResultTypeWalker.php
+		-
+			messages: # needed for older DBAL versions (fails only on PHP 7.3)
+				- '#^Class Doctrine\\DBAL\\Driver\\PgSQL\\Driver not found\.$#'
+				- '#^Class Doctrine\\DBAL\\Driver\\SQLite3\\Driver not found\.$#'
+			path: src/Type/Doctrine/Query/QueryResultTypeWalker.php

src/Type/Doctrine/CreateQueryDynamicReturnTypeExtension.php

@@ -12,6 +12,7 @@
 use Doctrine\Persistence\Mapping\MappingException;
 use PhpParser\Node\Expr\MethodCall;
 use PHPStan\Analyser\Scope;
+use PHPStan\Php\PhpVersion;
 use PHPStan\Reflection\MethodReflection;
 use PHPStan\Type\Constant\ConstantStringType;
 use PHPStan\Type\Doctrine\Query\QueryResultTypeBuilder;
@@ -37,10 +38,14 @@ final class CreateQueryDynamicReturnTypeExtension implements DynamicMethodReturn
 	/** @var DescriptorRegistry */
 	private $descriptorRegistry;
 
-	public function __construct(ObjectMetadataResolver $objectMetadataResolver, DescriptorRegistry $descriptorRegistry)
+	/** @var PhpVersion */
+	private $phpVersion;
+
+	public function __construct(ObjectMetadataResolver $objectMetadataResolver, DescriptorRegistry $descriptorRegistry, PhpVersion $phpVersion)
 	{
 		$this->objectMetadataResolver = $objectMetadataResolver;
 		$this->descriptorRegistry = $descriptorRegistry;
+		$this->phpVersion = $phpVersion;
 	}
 
 	public function getClass(): string
@@ -87,7 +92,7 @@ public function getTypeFromMethodCall(
 
 				try {
 					$query = $em->createQuery($queryString);
-					QueryResultTypeWalker::walk($query, $typeBuilder, $this->descriptorRegistry);
+					QueryResultTypeWalker::walk($query, $typeBuilder, $this->descriptorRegistry, $this->phpVersion);
 				} catch (ORMException | DBALException | NewDBALException | CommonException | MappingException | \Doctrine\ORM\Exception\ORMException $e) {
 					return new QueryType($queryString, null, null);
 				} catch (AssertionError $e) {

src/Type/Doctrine/DefaultDescriptorRegistry.php

@@ -36,4 +36,15 @@ public function get(string $type): DoctrineTypeDescriptor
 		return $this->descriptors[$typeClass];
 	}
 
+	/**
+	 * @throws DescriptorNotRegisteredException
+	 */
+	public function getByClassName(string $className): DoctrineTypeDescriptor
+	{
+		if (!isset($this->descriptors[$className])) {
+			throw new DescriptorNotRegisteredException();
+		}
+		return $this->descriptors[$className];
+	}
+
 }

src/Type/Doctrine/Descriptors/ArrayType.php

@@ -2,6 +2,7 @@
 
 namespace PHPStan\Type\Doctrine\Descriptors;
 
+use Doctrine\DBAL\Driver;
 use PHPStan\Type\MixedType;
 use PHPStan\Type\StringType;
 use PHPStan\Type\Type;
@@ -24,7 +25,7 @@ public function getWritableToDatabaseType(): Type
 		return new \PHPStan\Type\ArrayType(new MixedType(), new MixedType());
 	}
 
-	public function getDatabaseInternalType(): Type
+	public function getDatabaseInternalType(Driver $driver): Type
 	{
 		return new StringType();
 	}

src/Type/Doctrine/Descriptors/AsciiStringType.php

@@ -2,6 +2,7 @@
 
 namespace PHPStan\Type\Doctrine\Descriptors;
 
+use Doctrine\DBAL\Driver;
 use PHPStan\Type\StringType;
 use PHPStan\Type\Type;
 
@@ -23,7 +24,7 @@ public function getWritableToDatabaseType(): Type
 		return new StringType();
 	}
 
-	public function getDatabaseInternalType(): Type
+	public function getDatabaseInternalType(Driver $driver): Type
 	{
 		return new StringType();
 	}

src/Type/Doctrine/Descriptors/BigIntType.php

@@ -3,6 +3,7 @@
 namespace PHPStan\Type\Doctrine\Descriptors;
 
 use Composer\InstalledVersions;
+use Doctrine\DBAL\Driver;
 use PHPStan\Type\Accessory\AccessoryNumericStringType;
 use PHPStan\Type\IntegerType;
 use PHPStan\Type\StringType;
@@ -30,10 +31,10 @@ public function getWritableToPropertyType(): Type
 
 	public function getWritableToDatabaseType(): Type
 	{
-		return TypeCombinator::union(new StringType(), new IntegerType());
+		return TypeCombinator::union(new StringType());
 	}
 
-	public function getDatabaseInternalType(): Type
+	public function getDatabaseInternalType(Driver $driver): Type
 	{
 		return new IntegerType();
 	}

src/Type/Doctrine/Descriptors/BinaryType.php

@@ -2,6 +2,7 @@
 
 namespace PHPStan\Type\Doctrine\Descriptors;
 
+use Doctrine\DBAL\Driver;
 use PHPStan\Type\MixedType;
 use PHPStan\Type\ResourceType;
 use PHPStan\Type\StringType;
@@ -25,7 +26,7 @@ public function getWritableToDatabaseType(): Type
 		return new MixedType();
 	}
 
-	public function getDatabaseInternalType(): Type
+	public function getDatabaseInternalType(Driver $driver): Type
 	{
 		return new StringType();
 	}

src/Type/Doctrine/Descriptors/BlobType.php

@@ -2,6 +2,7 @@
 
 namespace PHPStan\Type\Doctrine\Descriptors;
 
+use Doctrine\DBAL\Driver;
 use PHPStan\Type\MixedType;
 use PHPStan\Type\ResourceType;
 use PHPStan\Type\Type;
@@ -24,7 +25,7 @@ public function getWritableToDatabaseType(): Type
 		return new MixedType();
 	}
 
-	public function getDatabaseInternalType(): Type
+	public function getDatabaseInternalType(Driver $driver): Type
 	{
 		return new MixedType();
 	}

src/Type/Doctrine/Descriptors/BooleanType.php

@@ -2,6 +2,9 @@
 
 namespace PHPStan\Type\Doctrine\Descriptors;
 
+use Doctrine\DBAL\Driver;
+use Doctrine\DBAL\Driver\PDO\PgSQL\Driver as PdoPgSQLDriver;
+use Doctrine\DBAL\Driver\PgSQL\Driver as PgSQLDriver;
 use PHPStan\Type\Constant\ConstantIntegerType;
 use PHPStan\Type\Type;
 use PHPStan\Type\TypeCombinator;
@@ -24,12 +27,15 @@ public function getWritableToDatabaseType(): Type
 		return new \PHPStan\Type\BooleanType();
 	}
 
-	public function getDatabaseInternalType(): Type
+	public function getDatabaseInternalType(Driver $driver): Type
 	{
+		if ($driver instanceof PgSQLDriver || $driver instanceof PdoPgSQLDriver) {
+			return new \PHPStan\Type\BooleanType();
+		}
+
 		return TypeCombinator::union(
 			new ConstantIntegerType(0),
-			new ConstantIntegerType(1),
-			new \PHPStan\Type\BooleanType()
+			new ConstantIntegerType(1)
 		);
 	}