Handle all hydration mode in QueryResultDynamicReturnTypeExtension

[VincentLanglet]

Closes #403

[VincentLanglet]

Hi @arnaud-lb, I'm trying to improve #232 to supports all hydration modes.

Do you mind taking a look ?
I dunno if we can support everything but maybe some of my ideas are going in the right direction :)

[VincentLanglet]

Hi @greg0ire, maybe you can help me on this.

I'm not familiar with all the hydratation mode.
Do you agree with the expected types I wrote in the tests ?

[greg0ire]

Not super familiar either, but nothing strikes me as incorrect in what you wrote.

[VincentLanglet]

Not super familiar either, but nothing strikes me as incorrect in what you wrote.

Thanks, if you have a suggestion about who I should/could ping ; I'm open to it.

@ondrejmirtes I would say, this is ready to be reviewed.

[ondrejmirtes]

We should be more specific here - based on the entity, we should know the array shape.

[VincentLanglet]

I agree. But I thought this could have been a good first step.
Wouldn't be ok to merge this and improve the array shape in a second PR ?

list<array> is better than mixed,
then list<array{id: int, ...}> will be better than list<array>.

Also I had no idea how to improve the

if ($isObject->yes()) {
    return new ArrayType(new MixedType(), new MixedType());
}

part with the PHPStan kit.

[ondrejmirtes]

Yes, that's fine. I'm gonna merge this and test on real-world projects before releasing it. Thanks.

[ondrejmirtes]

I think it's mostly fine, but it can lead to new errors. Previously where there was mixed now there's a more specific type. Which means that if you're on level 8, you can get a new error like:

should return array<array{x: string, y: string|null, z: string|null, aa: int|null}> but returns list<array>.

This is happening for HYDRATE_SCALAR when selecting a few specific columns in SELECT.

[ondrejmirtes]

But on a different project it leads to 108 new errors.

So there are situations where it's wrong.

Some examples:

		$query = $this->entityManager->createQueryBuilder()
			->select('IDENTITY(n.related)')
			->from(DistrictNeighbour::class, 'n')
			->andWhere('n.center = ?', $districtId)
			->getQuery();

		return array_map(static fn (array $row): UuidInterface => $row['related'], $query->getArrayResult());

leading to: Offset 'related' does not exist on array{1: string}.

Or:

$result = $this->entityManager->createQueryBuilder()
			->select('d.name, d.id')
			->from(Destination::class, 'd')
			->addOrderBy('d.name')
			->getQuery()
			->getArrayResult();

		$destinations = [];
		foreach ($result as $item) {
			$destinations[(string) $item['id']->toString()] = (string) $item['name'];
		}

leading to: Cannot call method toString() on array.

Or:

$eventsCount = $this->entityManager->createQueryBuilder()
			->select('COUNT(cle.id)')
			->from(CountryLocalityEvent::class, 'cle')
			->andWhere('cle.user = ?', $user)
			->andWhere('cle.expirationTime > ?', DateTimeProvider::now())
			->getQuery()
			->getSingleScalarResult();

		return $eventsCount > 0;

leading to: Comparison operation ">" between list<array{1: int<0, max>|numeric-string}> and 0 results in an error.

Because of these problems, I'm gonna revert it now. Please send a new PR with improvements. Thank you.

[VincentLanglet]

But on a different project it leads to 108 new errors.

So there are situations where it's wrong.

Thanks for the report.
It should be better with #412