Skip to content

fix eager, left join if previous was a left join #789

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
dunglas merged 1 commit into from
Oct 8, 2016
Merged

fix eager, left join if previous was a left join #789

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
22 changes: 14 additions & 8 deletions src/Bridge/Doctrine/Orm/Extension/EagerLoadingExtension.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,10 +66,11 @@ public function getMetadataProperties(string $resourceClass) : array
*
* @param QueryBuilder $queryBuilder
* @param string $resourceClass
* @param string $originAlias
* @param string $relationAlias
* @param string $originAlias the current entity alias (first o, then a1, a2 etc.)
* @param string $relationAlias the previous relation alias to keep it unique
* @param bool $wasLeftJoin if the relation containing the new one had a left join, we have to force the new one to left join too
*/
private function joinRelations(QueryBuilder $queryBuilder, string $resourceClass, string $originAlias = 'o', string &$relationAlias = 'a')
private function joinRelations(QueryBuilder $queryBuilder, string $resourceClass, string $originAlias = 'o', string &$relationAlias = 'a', bool $wasLeftJoin = false)
{
$classMetadata = $queryBuilder->getEntityManager()->getClassMetadata($resourceClass);
$j = 0;
Expand All @@ -82,12 +83,16 @@ private function joinRelations(QueryBuilder $queryBuilder, string $resourceClass
continue;
}

$joinColumns = $mapping['joinColumns'] ?? $mapping['joinTable']['joinColumns'] ?? null;
if (false === $wasLeftJoin) {
$joinColumns = $mapping['joinColumns'] ?? $mapping['joinTable']['joinColumns'] ?? null;

if (null === $joinColumns) {
$method = 'leftJoin';
if (null === $joinColumns) {
$method = 'leftJoin';
} else {
$method = false === $joinColumns[0]['nullable'] ? 'innerJoin' : 'leftJoin';
}
} else {
$method = false === $joinColumns[0]['nullable'] ? 'innerJoin' : 'leftJoin';
$method = 'leftJoin';
}

$associationAlias = $relationAlias.$i;
Expand All @@ -110,7 +115,8 @@ private function joinRelations(QueryBuilder $queryBuilder, string $resourceClass
$queryBuilder->addSelect(sprintf('partial %s.{%s}', $associationAlias, implode(',', $select)));

$relationAlias = $relationAlias.++$j;
$this->joinRelations($queryBuilder, $mapping['targetEntity'], $associationAlias, $relationAlias);

$this->joinRelations($queryBuilder, $mapping['targetEntity'], $associationAlias, $relationAlias, $method === 'leftJoin');
}
}
}
40 changes: 27 additions & 13 deletions tests/Bridge/Doctrine/Orm/Extension/EagerLoadingExtensionTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
use ApiPlatform\Core\Metadata\Property\PropertyNameCollection;
use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\Dummy;
use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\RelatedDummy;
use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\UnknownDummy;
use Doctrine\ORM\EntityManager;
use Doctrine\ORM\Mapping\ClassMetadata;
use Doctrine\ORM\QueryBuilder;
Expand Down Expand Up @@ -96,9 +97,10 @@ public function testApplyToItem()
{
$propertyNameCollectionFactoryProphecy = $this->prophesize(PropertyNameCollectionFactoryInterface::class);

$relatedNameCollection = new PropertyNameCollection(['id', 'name', 'notindatabase', 'notreadable']);
$relatedNameCollection = new PropertyNameCollection(['id', 'name', 'notindatabase', 'notreadable', 'relation']);

$propertyNameCollectionFactoryProphecy->create(RelatedDummy::class)->willReturn($relatedNameCollection)->shouldBeCalled();
$propertyNameCollectionFactoryProphecy->create(UnknownDummy::class)->willReturn(new PropertyNameCollection(['id']))->shouldBeCalled();

$propertyMetadataFactoryProphecy = $this->prophesize(PropertyMetadataFactoryInterface::class);
$relationPropertyMetadata = new PropertyMetadata();
Expand All @@ -122,16 +124,19 @@ public function testApplyToItem()
$propertyMetadataFactoryProphecy->create(RelatedDummy::class, 'name')->willReturn($namePropertyMetadata)->shouldBeCalled();
$propertyMetadataFactoryProphecy->create(RelatedDummy::class, 'notindatabase')->willReturn($notInDatabasePropertyMetadata)->shouldBeCalled();
$propertyMetadataFactoryProphecy->create(RelatedDummy::class, 'notreadable')->willReturn($notReadablePropertyMetadata)->shouldBeCalled();
$propertyMetadataFactoryProphecy->create(RelatedDummy::class, 'relation')->willReturn($relationPropertyMetadata)->shouldBeCalled();
$propertyMetadataFactoryProphecy->create(UnknownDummy::class, 'id')->willReturn($idPropertyMetadata)->shouldBeCalled();

$queryBuilderProphecy = $this->prophesize(QueryBuilder::class);

$classMetadataProphecy = $this->prophesize(ClassMetadata::class);
$classMetadataProphecy->getAssociationNames()->shouldBeCalled()->willReturn([0 => 'relatedDummy', 'relatedDummy2', 'relatedDummy3', 'relatedDummy4']);
$classMetadataProphecy->getAssociationNames()->shouldBeCalled()->willReturn(['relatedDummy', 'relatedDummy2', 'relatedDummy3', 'relatedDummy4']);
$classMetadataProphecy->associationMappings = [
'relatedDummy' => ['fetch' => 3, 'joinColumns' => [['nullable' => true]], 'targetEntity' => RelatedDummy::class],
'relatedDummy2' => ['fetch' => 3, 'joinColumns' => [['nullable' => false]], 'targetEntity' => RelatedDummy::class],
'relatedDummy3' => ['fetch' => 3, 'joinTable' => ['joinColumns' => [['nullable' => false]]], 'targetEntity' => RelatedDummy::class],
'relatedDummy4' => ['fetch' => 3, 'targetEntity' => RelatedDummy::class],
'relatedDummy2' => ['fetch' => 3, 'joinColumns' => [['nullable' => false]], 'targetEntity' => UnknownDummy::class],
'relatedDummy3' => ['fetch' => 3, 'joinTable' => ['joinColumns' => [['nullable' => false]]], 'targetEntity' => UnknownDummy::class],
'relatedDummy4' => ['fetch' => 3, 'targetEntity' => UnknownDummy::class],
'relatedDummy5' => ['fetch' => 2, 'targetEntity' => UnknownDummy::class],
];

$relatedClassMetadataProphecy = $this->prophesize(ClassMetadata::class);
Expand All @@ -142,26 +147,35 @@ public function testApplyToItem()
}
}

$relatedClassMetadataProphecy->getAssociationNames()->shouldBeCalled()->willReturn([]);
$relatedClassMetadataProphecy->getAssociationNames()->shouldBeCalled()->willReturn(['relation']);

$relatedClassMetadataProphecy->associationMappings = [
'relation' => ['fetch' => 3, 'joinColumns' => [['nullable' => false]], 'targetEntity' => UnknownDummy::class],
];

$unknownClassMetadataProphecy = $this->prophesize(ClassMetadata::class);
$unknownClassMetadataProphecy->getAssociationNames()->shouldBeCalled()->willReturn([]);

$emProphecy = $this->prophesize(EntityManager::class);
$emProphecy->getClassMetadata(Dummy::class)->shouldBeCalled()->willReturn($classMetadataProphecy->reveal());
$emProphecy->getClassMetadata(RelatedDummy::class)->shouldBeCalled()->willReturn($relatedClassMetadataProphecy->reveal());
$emProphecy->getClassMetadata(UnknownDummy::class)->shouldBeCalled()->willReturn($unknownClassMetadataProphecy->reveal());

$queryBuilderProphecy->leftJoin('o.relatedDummy', 'a0')->shouldBeCalled(1);
$queryBuilderProphecy->innerJoin('o.relatedDummy2', 'a11')->shouldBeCalled(1);
$queryBuilderProphecy->innerJoin('o.relatedDummy3', 'a122')->shouldBeCalled(1);
$queryBuilderProphecy->leftJoin('o.relatedDummy4', 'a1233')->shouldBeCalled(1);
$queryBuilderProphecy->leftJoin('a0.relation', 'a10')->shouldBeCalled(1);
$queryBuilderProphecy->innerJoin('o.relatedDummy2', 'a111')->shouldBeCalled(1);
$queryBuilderProphecy->innerJoin('o.relatedDummy3', 'a1122')->shouldBeCalled(1);
$queryBuilderProphecy->leftJoin('o.relatedDummy4', 'a11233')->shouldBeCalled(1);
$queryBuilderProphecy->addSelect('partial a0.{id,name}')->shouldBeCalled(1);
$queryBuilderProphecy->addSelect('partial a11.{id,name}')->shouldBeCalled(1);
$queryBuilderProphecy->addSelect('partial a122.{id,name}')->shouldBeCalled(1);
$queryBuilderProphecy->addSelect('partial a1233.{id,name}')->shouldBeCalled(1);
$queryBuilderProphecy->addSelect('partial a10.{id}')->shouldBeCalled(1);
$queryBuilderProphecy->addSelect('partial a111.{id}')->shouldBeCalled(1);
$queryBuilderProphecy->addSelect('partial a1122.{id}')->shouldBeCalled(1);
$queryBuilderProphecy->addSelect('partial a11233.{id}')->shouldBeCalled(1);

$queryBuilderProphecy->getEntityManager()->shouldBeCalled(2)->willReturn($emProphecy->reveal());

$queryBuilder = $queryBuilderProphecy->reveal();
$orderExtensionTest = new EagerLoadingExtension($propertyNameCollectionFactoryProphecy->reveal(), $propertyMetadataFactoryProphecy->reveal());
$orderExtensionTest->applyToCollection($queryBuilder, new QueryNameGenerator(), Dummy::class);

$orderExtensionTest->applyToItem($queryBuilder, new QueryNameGenerator(), Dummy::class, []);
}
Expand Down