Skip to content

We can not assume the type of Query::getResult() if ResultType may be void #260

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.

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 1 commit into from
Jan 24, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -93,12 +93,20 @@ private function getMethodReturnTypeForHydrationMode(
Type $queryResultType
): Type
{
if ($queryResultType instanceof VoidType) {
$isVoidType = (new VoidType())->isSuperTypeOf($queryResultType);

if ($isVoidType->yes()) {
// A void query result type indicates an UPDATE or DELETE query.
// In this case all methods return the number of affected rows.
return new IntegerType();
}

if ($isVoidType->maybe()) {
// We can't be sure what the query type is, so we return the
// declared return type of the method.
return $this->originalReturnType($methodReflection);
}

if (!$this->isObjectHydrationMode($hydrationMode)) {
// We support only HYDRATE_OBJECT. For other hydration modes, we
// return the declared return type of the method.
Expand Down
22 changes: 22 additions & 0 deletions tests/Type/Doctrine/data/QueryResult/queryBuilderGetQuery.php
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,26 @@ public function testQueryResultTypeIsMixedWhenDQLIsInvalid(EntityManagerInterfac
assertType('Doctrine\ORM\Query<mixed>', $query);
}

public function testQueryResultTypeIsVoidWithDeleteOrUpdate(EntityManagerInterface $em): void
{
$query = $em->getRepository(Many::class)
->createQueryBuilder('m')
->where('m.id IN (:ids)')
->setParameter('ids', $ids)
->delete()
->getQuery();

assertType('Doctrine\ORM\Query<void>', $query);

$query = $em->getRepository(Many::class)
->createQueryBuilder('m')
->where('m.id IN (:ids)')
->setParameter('ids', $ids)
->update()
->set('m.intColumn', '42')
->getQuery();

assertType('Doctrine\ORM\Query<void>', $query);

}
}
107 changes: 107 additions & 0 deletions tests/Type/Doctrine/data/QueryResult/queryResult.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

use Doctrine\ORM\AbstractQuery;
use Doctrine\ORM\EntityManagerInterface;
use Doctrine\ORM\Query;
use function PHPStan\Testing\assertType;

class QueryResultTest
Expand Down Expand Up @@ -210,4 +211,110 @@ public function testReturnTypeOfQueryMethodsWithExplicitNonConstantHydrationMode
$query->getOneOrNullResult($hydrationMode)
);
}

/**
* Test that we return the original return type when ResultType may be
* VoidType
*
* @param Query<mixed> $query
*/
public function testReturnTypeOfQueryMethodsWithReturnTypeIsMixed(EntityManagerInterface $em, Query $query): void
{
assertType(
'mixed',
$query->getResult(AbstractQuery::HYDRATE_OBJECT)
);
assertType(
'mixed',
$query->execute(null, AbstractQuery::HYDRATE_OBJECT)
);
assertType(
'mixed',
$query->executeIgnoreQueryCache(null, AbstractQuery::HYDRATE_OBJECT)
);
assertType(
'mixed',
$query->executeUsingQueryCache(null, AbstractQuery::HYDRATE_OBJECT)
);
assertType(
'mixed',
$query->getSingleResult(AbstractQuery::HYDRATE_OBJECT)
);
assertType(
'mixed',
$query->getOneOrNullResult(AbstractQuery::HYDRATE_OBJECT)
);
}

/**
* Test that we return the original return type when ResultType may be
* VoidType (TemplateType variant)
*
* @template T
*
* @param Query<T> $query
*/
public function testReturnTypeOfQueryMethodsWithReturnTypeIsTemplateMixedType(EntityManagerInterface $em, Query $query): void
{
assertType(
'mixed',
$query->getResult(AbstractQuery::HYDRATE_OBJECT)
);
assertType(
'mixed',
$query->execute(null, AbstractQuery::HYDRATE_OBJECT)
);
assertType(
'mixed',
$query->executeIgnoreQueryCache(null, AbstractQuery::HYDRATE_OBJECT)
);
assertType(
'mixed',
$query->executeUsingQueryCache(null, AbstractQuery::HYDRATE_OBJECT)
);
assertType(
'mixed',
$query->getSingleResult(AbstractQuery::HYDRATE_OBJECT)
);
assertType(
'mixed',
$query->getOneOrNullResult(AbstractQuery::HYDRATE_OBJECT)
);
}


/**
* Test that we return ResultType return ResultType can not be VoidType
*
* @template T of array|object
*
* @param Query<T> $query
*/
public function testReturnTypeOfQueryMethodsWithReturnTypeIsNonVoidTemplate(EntityManagerInterface $em, Query $query): void
{
assertType(
'array<T of array|object (method QueryResult\queryResult\QueryResultTest::testReturnTypeOfQueryMethodsWithReturnTypeIsNonVoidTemplate(), argument)>',
$query->getResult(AbstractQuery::HYDRATE_OBJECT)
);
assertType(
'array<T of array|object (method QueryResult\queryResult\QueryResultTest::testReturnTypeOfQueryMethodsWithReturnTypeIsNonVoidTemplate(), argument)>',
$query->execute(null, AbstractQuery::HYDRATE_OBJECT)
);
assertType(
'array<T of array|object (method QueryResult\queryResult\QueryResultTest::testReturnTypeOfQueryMethodsWithReturnTypeIsNonVoidTemplate(), argument)>',
$query->executeIgnoreQueryCache(null, AbstractQuery::HYDRATE_OBJECT)
);
assertType(
'array<T of array|object (method QueryResult\queryResult\QueryResultTest::testReturnTypeOfQueryMethodsWithReturnTypeIsNonVoidTemplate(), argument)>',
$query->executeUsingQueryCache(null, AbstractQuery::HYDRATE_OBJECT)
);
assertType(
'T of array|object (method QueryResult\queryResult\QueryResultTest::testReturnTypeOfQueryMethodsWithReturnTypeIsNonVoidTemplate(), argument)',
$query->getSingleResult(AbstractQuery::HYDRATE_OBJECT)
);
assertType(
'(T of array|object (method QueryResult\queryResult\QueryResultTest::testReturnTypeOfQueryMethodsWithReturnTypeIsNonVoidTemplate(), argument))|null',
$query->getOneOrNullResult(AbstractQuery::HYDRATE_OBJECT)
);
}
}