QueryResultTypeWalker: precise type inferring

Author: janedbal

README.md

@@ -128,6 +128,14 @@ Queries are analyzed statically and do not require a running database server. Th
 
 Most DQL features are supported, including `GROUP BY`, `DISTINCT`, all flavors of `JOIN`, arithmetic expressions, functions, aggregations, `NEW`, etc. Sub queries and `INDEX BY` are not yet supported (infered type will be `mixed`).
 
+### Query type inference of expressions
+
+Whether e.g. `SUM(e.column)` is fetched as `float`, `numeric-string` or `int` highly [depends on drivers, their setup and PHP version](https://github.com/janedbal/php-database-drivers-fetch-test).
+This extension autodetects your setup and provides quite accurate results for `pdo_mysql`, `mysqli`, `pdo_sqlite`, `sqlite3`, `pdo_pgsql` and `pgsql`.
+Sadly, this autodetection often needs real database connection, so in order to utilize precise types, your `objectManagerLoader` need to be able to connect to real database.
+
+If you are using `bleedingEdge`, the connection failure is propagated. If not, it will be silently ignored and the type will be `mixed` or an union of possible types.
+
 ### Supported methods
 
 The `getResult` method is supported when called without argument, or with the hydrateMode argument set to `Query::HYDRATE_OBJECT`:

phpstan.neon

@@ -42,21 +42,25 @@ parameters:
 		-
 			message: '#^Call to function method_exists\(\) with ''Doctrine\\\\ORM\\\\EntityManager'' and ''create'' will always evaluate to true\.$#'
 			path: src/Doctrine/Mapping/ClassMetadataFactory.php
-			reportUnmatched: false
-		-
-			messages:
-				- '#^Call to function method_exists\(\) with Doctrine\\DBAL\\Connection and ''getNativeConnection'' will always evaluate to true\.$#'
-				- '#^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
 			paths:
+				- src/Type/Doctrine/Query/QueryResultTypeWalker.php
 				- src/Doctrine/Driver/DriverDetector.php
 
 		-
 			messages: # needed for older DBAL versions
 				- '#^Class PgSql\\Connection not found\.$#'
 				- '#^Class Doctrine\\DBAL\\Driver\\PgSQL\\Driver not found\.$#'
 				- '#^Class Doctrine\\DBAL\\Driver\\SQLite3\\Driver not found\.$#'
+
+		-
+			message: '#^Call to an undefined method Doctrine\\DBAL\\Connection\:\:getWrappedConnection\(\)\.$#' # dropped in DBAL 4
+			path: src/Type/Doctrine/Query/QueryResultTypeWalker.php
+
+		-
+			messages: # oldest dbal has only getSchemaManager, dbal4 has only createSchemaManager
+				- '#^Call to function method_exists\(\) with Doctrine\\DBAL\\Connection and ''createSchemaManager'' will always evaluate to true\.$#'
+				- '#^Call to an undefined method Doctrine\\DBAL\\Connection\:\:getSchemaManager\(\)\.$#'
+			path: tests/Platform/QueryResultTypeWalkerFetchTypeMatrixTest.php

src/Doctrine/Driver/DriverDetector.php

@@ -46,6 +46,11 @@ public function __construct(bool $failOnInvalidConnection)
 		$this->failOnInvalidConnection = $failOnInvalidConnection;
 	}
 
+	public function failsOnInvalidConnection(): bool
+	{
+		return $this->failOnInvalidConnection;
+	}
+
 	/**
 	 * @return self::*|null
 	 */

src/Type/Doctrine/CreateQueryDynamicReturnTypeExtension.php

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

src/Type/Doctrine/Descriptors/FloatType.php

@@ -40,7 +40,13 @@ public function getWritableToDatabaseType(): Type
 
 	public function getDatabaseInternalType(): Type
 	{
-		return TypeCombinator::union(new \PHPStan\Type\FloatType(), new IntegerType());
+		return TypeCombinator::union(
+			new \PHPStan\Type\FloatType(),
+			new IntersectionType([
+				new StringType(),
+				new AccessoryNumericStringType(),
+			])
+		);
 	}
 
 	public function getDatabaseInternalTypeForDriver(Connection $connection): Type

src/Type/Doctrine/Descriptors/ReflectionDescriptor.php

@@ -2,6 +2,7 @@
 
 namespace PHPStan\Type\Doctrine\Descriptors;
 
+use Doctrine\DBAL\Connection;
 use Doctrine\DBAL\Platforms\AbstractPlatform;
 use Doctrine\DBAL\Types\Type as DbalType;
 use PHPStan\DependencyInjection\Container;
@@ -14,7 +15,7 @@
 use PHPStan\Type\Type;
 use PHPStan\Type\TypeCombinator;
 
-class ReflectionDescriptor implements DoctrineTypeDescriptor
+class ReflectionDescriptor implements DoctrineTypeDescriptor, DoctrineTypeDriverAwareDescriptor
 {
 
 	/** @var class-string<DbalType> */
@@ -90,4 +91,27 @@ public function getDatabaseInternalType(): Type
 		return new MixedType();
 	}
 
+	public function getDatabaseInternalTypeForDriver(Connection $connection): Type
+	{
+		$registry = $this->container->getByType(DefaultDescriptorRegistry::class);
+		$parents = $this->reflectionProvider->getClass($this->type)->getParentClassesNames();
+
+		foreach ($parents as $dbalTypeParentClass) {
+			try {
+				// this assumes that if somebody inherits from DecimalType,
+				// the real database type remains decimal and we can reuse its descriptor
+				$descriptor = $registry->getByClassName($dbalTypeParentClass);
+
+				return $descriptor instanceof DoctrineTypeDriverAwareDescriptor
+					? $descriptor->getDatabaseInternalTypeForDriver($connection)
+					: $descriptor->getDatabaseInternalType();
+
+			} catch (DescriptorNotRegisteredException $e) {
+				continue;
+			}
+		}
+
+		return new MixedType();
+	}
+
 }

src/Type/Doctrine/Query/DqlConstantStringType.php

@@ -0,0 +1,31 @@
+<?php declare(strict_types = 1);
+
+namespace PHPStan\Type\Doctrine\Query;
+
+use Doctrine\ORM\Query\AST\Literal;
+use PHPStan\Type\Constant\ConstantStringType;
+
+class DqlConstantStringType extends ConstantStringType
+{
+
+	/** @var Literal::* */
+	private $originLiteralType;
+
+	/**
+	 * @param Literal::* $originLiteralType
+	 */
+	public function __construct(string $value, int $originLiteralType)
+	{
+		parent::__construct($value, false);
+		$this->originLiteralType = $originLiteralType;
+	}
+
+	/**
+	 * @return Literal::*
+	 */
+	public function getOriginLiteralType(): int
+	{
+		return $this->originLiteralType;
+	}
+
+}