Skip to content

fix(doctrine): fix partial fetch with same entity included multiple time with different fields #7647

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.

Sign up for GitHub

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
soyuka merged 1 commit into from
Jan 6, 2026
Merged

fix(doctrine): fix partial fetch with same entity included multiple time with different fields #7647

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 3 additions & 3 deletions features/doctrine/eager_loading.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Feature: Eager Loading
Then the response status code should be 200
And the DQL should be equal to:
"""
SELECT o, thirdLevel_a1, fourthLevel_a2, relatedToDummyFriend_a3, dummyFriend_a4
SELECT o, thirdLevel_a1, relatedToDummyFriend_a3, fourthLevel_a2, dummyFriend_a4
FROM ApiPlatform\Tests\Fixtures\TestBundle\Entity\RelatedDummy o
LEFT JOIN o.thirdLevel thirdLevel_a1
LEFT JOIN thirdLevel_a1.fourthLevel fourthLevel_a2
Expand Down Expand Up @@ -46,7 +46,7 @@ Feature: Eager Loading
Then the response status code should be 200
And the DQL should be equal to:
"""
SELECT o, thirdLevel_a4, fourthLevel_a5, relatedToDummyFriend_a1, dummyFriend_a6
SELECT o, thirdLevel_a4, relatedToDummyFriend_a1, fourthLevel_a5, dummyFriend_a6
FROM ApiPlatform\Tests\Fixtures\TestBundle\Entity\RelatedDummy o
INNER JOIN o.relatedToDummyFriend relatedToDummyFriend_a1
LEFT JOIN o.thirdLevel thirdLevel_a4
Expand Down Expand Up @@ -83,7 +83,7 @@ Feature: Eager Loading
Then the response status code should be 200
And the DQL should be equal to:
"""
SELECT o, thirdLevel_a3, fourthLevel_a4, relatedToDummyFriend_a5, dummyFriend_a6
SELECT o, thirdLevel_a3, relatedToDummyFriend_a5, fourthLevel_a4, dummyFriend_a6
FROM ApiPlatform\Tests\Fixtures\TestBundle\Entity\RelatedDummy o
LEFT JOIN o.thirdLevel thirdLevel_a3
LEFT JOIN thirdLevel_a3.fourthLevel fourthLevel_a4
Expand Down
82 changes: 64 additions & 18 deletions src/Doctrine/Orm/Extension/EagerLoadingExtension.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
use ApiPlatform\Metadata\Property\Factory\PropertyMetadataFactoryInterface;
use ApiPlatform\Metadata\Property\Factory\PropertyNameCollectionFactoryInterface;
use Doctrine\ORM\Mapping\ClassMetadata;
use Doctrine\ORM\Query\AST\PartialObjectExpression;
use Doctrine\ORM\Query\Expr\Join;
use Doctrine\ORM\Query\Expr\Select;
use Doctrine\ORM\QueryBuilder;
Expand Down Expand Up @@ -70,7 +71,7 @@ private function apply(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $
$options = [];

$forceEager = $operation?->getForceEager() ?? $this->forceEager;
$fetchPartial = $operation?->getFetchPartial() ?? $this->fetchPartial;
$fetchPartial = class_exists(PartialObjectExpression::class) && ($operation?->getFetchPartial() ?? $this->fetchPartial);

if (!isset($context['groups']) && !isset($context['attributes'])) {
$contextType = isset($context['api_denormalize']) ? 'denormalization_context' : 'normalization_context';
Expand All @@ -95,7 +96,61 @@ private function apply(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $
$options['denormalization_groups'] = $denormalizationGroups;
}

$this->joinRelations($queryBuilder, $queryNameGenerator, $resourceClass, $forceEager, $fetchPartial, $queryBuilder->getRootAliases()[0], $options, $context);
$selects = $this->joinRelations($queryBuilder, $queryNameGenerator, $resourceClass, $forceEager, $fetchPartial, $queryBuilder->getRootAliases()[0], $options, $context);
$selectsByClass = [];
foreach ($selects as [$entity, $alias, $fields]) {
if ($entity === $resourceClass) {
// We don't perform partial select the root entity
$fields = null;
}

if (!isset($selectsByClass[$entity])) {
$selectsByClass[$entity] = [
'aliases' => [$alias => true],
'fields' => null === $fields ? null : array_flip($fields),
];
} else {
$selectsByClass[$entity]['aliases'][$alias] = true;
if (null === $selectsByClass[$entity]['fields']) {
continue;
}

if (null === $fields) {
$selectsByClass[$entity]['fields'] = null;
continue;
}

// Merge fields
foreach ($fields as $field) {
$selectsByClass[$entity]['fields'][$field] = true;
}
}
}

$existingSelects = [];
foreach ($queryBuilder->getDQLPart('select') ?? [] as $dqlSelect) {
if (!$dqlSelect instanceof Select) {
continue;
}
foreach ($dqlSelect->getParts() as $part) {
$existingSelects[(string) $part] = true;
}
}

foreach ($selectsByClass as $data) {
$fields = null === $data['fields'] ? null : array_keys($data['fields']);
foreach (array_keys($data['aliases']) as $alias) {
if (isset($existingSelects[$alias])) {
continue;
}

if (null === $fields) {
$queryBuilder->addSelect($alias);
} else {
$queryBuilder->addSelect(\sprintf('partial %s.{%s}', $alias, implode(',', $fields)));
}
}
}
}

/**
Expand All @@ -107,7 +162,7 @@ private function apply(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $
*
* @throws RuntimeException when the max number of joins has been reached
*/
private function joinRelations(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, bool $forceEager, bool $fetchPartial, string $parentAlias, array $options = [], array $normalizationContext = [], bool $wasLeftJoin = false, int &$joinCount = 0, ?int $currentDepth = null, ?string $parentAssociation = null): void
private function joinRelations(QueryBuilder $queryBuilder, QueryNameGeneratorInterface $queryNameGenerator, string $resourceClass, bool $forceEager, bool $fetchPartial, string $parentAlias, array $options = [], array $normalizationContext = [], bool $wasLeftJoin = false, int &$joinCount = 0, ?int $currentDepth = null, ?string $parentAssociation = null): iterable
{
if ($joinCount > $this->maxJoins) {
throw new RuntimeException('The total number of joined relations has exceeded the specified maximum. Raise the limit if necessary with the "api_platform.eager_loading.max_joins" configuration key (https://api-platform.com/docs/core/performance/#eager-loading), or limit the maximum serialization depth using the "enable_max_depth" option of the Symfony serializer (https://symfony.com/doc/current/components/serializer.html#handling-serialization-depth).');
Expand Down Expand Up @@ -200,13 +255,13 @@ private function joinRelations(QueryBuilder $queryBuilder, QueryNameGeneratorInt
if (true === $fetchPartial) {
try {
$propertyOptions = $this->getPropertyContext($attributesMetadata[$association] ?? null, $options);
$this->addSelect($queryBuilder, $mapping['targetEntity'], $associationAlias, $propertyOptions);
yield from $this->addSelect($queryBuilder, $mapping['targetEntity'], $associationAlias, $propertyOptions);
} catch (ResourceClassNotFoundException) {
continue;
}
} else {
$propertyOptions = null;
$this->addSelectOnce($queryBuilder, $associationAlias);
yield [$resourceClass, $associationAlias, null];
}

// Avoid recursive joins for self-referencing relations
Expand All @@ -229,7 +284,7 @@ private function joinRelations(QueryBuilder $queryBuilder, QueryNameGeneratorInt
}

$propertyOptions ??= $this->getPropertyContext($attributesMetadata[$association] ?? null, $options);
$this->joinRelations($queryBuilder, $queryNameGenerator, $mapping['targetEntity'], $forceEager, $fetchPartial, $associationAlias, $propertyOptions, $childNormalizationContext, $isLeftJoin, $joinCount, $currentDepth, $association);
yield from $this->joinRelations($queryBuilder, $queryNameGenerator, $mapping['targetEntity'], $forceEager, $fetchPartial, $associationAlias, $propertyOptions, $childNormalizationContext, $isLeftJoin, $joinCount, $currentDepth, $association);
}
}

Expand Down Expand Up @@ -267,13 +322,13 @@ private function getPropertyContext(?AttributeMetadataInterface $attributeMetada
return $propertyOptions;
}

private function addSelect(QueryBuilder $queryBuilder, string $entity, string $associationAlias, array $propertyMetadataOptions): void
private function addSelect(QueryBuilder $queryBuilder, string $entity, string $associationAlias, array $propertyMetadataOptions): iterable
{
$select = [];
$entityManager = $queryBuilder->getEntityManager();
$targetClassMetadata = $entityManager->getClassMetadata($entity);
if (!empty($targetClassMetadata->subClasses)) {
$this->addSelectOnce($queryBuilder, $associationAlias);
yield [$entity, $associationAlias, null];

return;
}
Expand Down Expand Up @@ -308,15 +363,6 @@ private function addSelect(QueryBuilder $queryBuilder, string $entity, string $a
}
}

$queryBuilder->addSelect(\sprintf('partial %s.{%s}', $associationAlias, implode(',', $select)));
}

private function addSelectOnce(QueryBuilder $queryBuilder, string $alias): void
{
$existingSelects = array_reduce($queryBuilder->getDQLPart('select') ?? [], fn ($existing, $dqlSelect) => ($dqlSelect instanceof Select) ? array_merge($existing, $dqlSelect->getParts()) : $existing, []);

if (!\in_array($alias, $existingSelects, true)) {
$queryBuilder->addSelect($alias);
}
yield [$entity, $associationAlias, $select];
}
}
Loading
Loading