Skip to content

Fix behaviour of "order" attribute #3472

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

Closed
teohhanhui wants to merge 1 commit into from
Closed

Fix behaviour of "order" attribute #3472

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
62 changes: 41 additions & 21 deletions src/Bridge/Doctrine/MongoDbOdm/Extension/OrderExtension.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
use ApiPlatform\Core\Bridge\Doctrine\MongoDbOdm\PropertyHelperTrait as MongoDbOdmPropertyHelperTrait;
use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
use Doctrine\Common\Persistence\ManagerRegistry;
use Doctrine\ODM\MongoDB\Aggregation\Builder;
use Doctrine\ODM\MongoDB\Aggregation\Builder as AggregationBuilder;

/**
* Applies selected ordering while querying resource collection.
Expand All @@ -31,42 +31,54 @@
*/
final class OrderExtension implements AggregationCollectionExtensionInterface
{
use PropertyHelperTrait;
use MongoDbOdmPropertyHelperTrait;
use PropertyHelperTrait;

public const DIRECTION_ASC = 'ASC';
public const DIRECTION_DESC = 'DESC';

private $order;
private $resourceMetadataFactory;
private $managerRegistry;

public function __construct(string $order = null, ResourceMetadataFactoryInterface $resourceMetadataFactory = null, ManagerRegistry $managerRegistry = null)
{
$this->resourceMetadataFactory = $resourceMetadataFactory;
$this->order = $order;
$this->resourceMetadataFactory = $resourceMetadataFactory;
$this->managerRegistry = $managerRegistry;
}

/**
* {@inheritdoc}
*/
public function applyToCollection(Builder $aggregationBuilder, string $resourceClass, string $operationName = null, array &$context = [])
public function applyToCollection(AggregationBuilder $aggregationBuilder, string $resourceClass, string $operationName = null, array &$context = [])
{
$classMetaData = $this->getClassMetadata($resourceClass);
$identifiers = $classMetaData->getIdentifier();
if (null !== $this->resourceMetadataFactory) {
$defaultOrder = $this->resourceMetadataFactory->create($resourceClass)->getAttribute('order');
if (null !== $defaultOrder) {
foreach ($defaultOrder as $field => $order) {
if (\is_int($field)) {
// Default direction
$field = $order;
$order = 'ASC';
if (null !== $order = $this->resourceMetadataFactory->create($resourceClass)->getAttribute('order')) {
if (\is_string($order)) {
$direction = strtoupper($order);
if (\in_array($direction, [self::DIRECTION_ASC, self::DIRECTION_DESC], true)) {
$this->sortByAllIdentifiers($aggregationBuilder, $resourceClass, $direction, $context);

return;
}

if ($this->isPropertyNested($field, $resourceClass)) {
[$field] = $this->addLookupsForNestedProperty($field, $aggregationBuilder, $resourceClass);
$order = [$order];

@soyuka soyuka Mar 31, 2020

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

not sure how would this happen

@teohhanhui teohhanhui Mar 31, 2020

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

order="id"?

}

foreach ($order as $property => $direction) {
if (\is_int($property)) {
$property = $direction;
$direction = self::DIRECTION_ASC;
}

$field = $property;

if ($this->isPropertyNested($property, $resourceClass)) {
[$field] = $this->addLookupsForNestedProperty($property, $aggregationBuilder, $resourceClass);
}
$aggregationBuilder->sort(
$context['mongodb_odm_sort_fields'] = ($context['mongodb_odm_sort_fields'] ?? []) + [$field => $order]
$context['mongodb_odm_sort_fields'] = ($context['mongodb_odm_sort_fields'] ?? []) + [$field => $direction]
);
}

Expand All @@ -75,16 +87,24 @@ public function applyToCollection(Builder $aggregationBuilder, string $resourceC
}

if (null !== $this->order) {
foreach ($identifiers as $identifier) {
$aggregationBuilder->sort(
$context['mongodb_odm_sort_fields'] = ($context['mongodb_odm_sort_fields'] ?? []) + [$identifier => $this->order]
);
}
$this->sortByAllIdentifiers($aggregationBuilder, $resourceClass, $this->order, $context);
}
}

/**
* {@inheritdoc}
*/
protected function getManagerRegistry(): ManagerRegistry
{
return $this->managerRegistry;
}

private function sortByAllIdentifiers(AggregationBuilder $aggregationBuilder, string $resourceClass, string $direction, array &$context): void
{
foreach ($this->getClassMetadata($resourceClass)->getIdentifier() as $field) {
$aggregationBuilder->sort(
$context['mongodb_odm_sort_fields'] = ($context['mongodb_odm_sort_fields'] ?? []) + [$field => $direction]
);
}
}
}
105 changes: 82 additions & 23 deletions src/Bridge/Doctrine/Orm/Extension/OrderExtension.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,14 @@

namespace ApiPlatform\Core\Bridge\Doctrine\Orm\Extension;

use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryBuilderHelper;
use ApiPlatform\Core\Bridge\Doctrine\Common\PropertyHelperTrait;
use ApiPlatform\Core\Bridge\Doctrine\Orm\PropertyHelperTrait as OrmPropertyHelperTrait;
use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGeneratorInterface;
use ApiPlatform\Core\Exception\InvalidArgumentException;
use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
use Doctrine\Common\Persistence\ManagerRegistry;
use Doctrine\Common\Persistence\Mapping\ClassMetadata;
use Doctrine\ORM\EntityManager;
use Doctrine\ORM\QueryBuilder;

/**
Expand All @@ -28,13 +32,25 @@
*/
final class OrderExtension implements ContextAwareQueryCollectionExtensionInterface
{
use OrmPropertyHelperTrait;
use PropertyHelperTrait;

public const DIRECTION_ASC = 'ASC';
public const DIRECTION_DESC = 'DESC';

private $order;
private $resourceMetadataFactory;
private $managerRegistry;
/**
* @var EntityManager|null
*/
private $entityManager;

public function __construct(string $order = null, ResourceMetadataFactoryInterface $resourceMetadataFactory = null)
public function __construct(string $order = null, ResourceMetadataFactoryInterface $resourceMetadataFactory = null, ManagerRegistry $managerRegistry = null)
{
$this->resourceMetadataFactory = $resourceMetadataFactory;
$this->order = $order;
$this->resourceMetadataFactory = $resourceMetadataFactory;
$this->managerRegistry = $managerRegistry;
}

/**
Expand All @@ -46,39 +62,82 @@ public function applyToCollection(QueryBuilder $queryBuilder, QueryNameGenerator
throw new InvalidArgumentException('The "$resourceClass" parameter must not be null');
}

$rootAlias = $queryBuilder->getRootAliases()[0];
// BC
if (null === $this->managerRegistry) {
$this->entityManager = $queryBuilder->getEntityManager();
}

$classMetaData = $queryBuilder->getEntityManager()->getClassMetadata($resourceClass);
$identifiers = $classMetaData->getIdentifier();
if (null !== $this->resourceMetadataFactory) {
$defaultOrder = $this->resourceMetadataFactory->create($resourceClass)->getAttribute('order');
if (null !== $defaultOrder) {
foreach ($defaultOrder as $field => $order) {
if (\is_int($field)) {
// Default direction
$field = $order;
$order = 'ASC';
if (null !== $order = $this->resourceMetadataFactory->create($resourceClass)->getAttribute('order')) {
if (\is_string($order)) {
$direction = strtoupper($order);
if (\in_array($direction, [self::DIRECTION_ASC, self::DIRECTION_DESC], true)) {
$this->addOrderByForAllIdentifiers($queryBuilder, $resourceClass, $direction);

return;
}

$pos = strpos($field, '.');
if (false === $pos || isset($classMetaData->embeddedClasses[substr($field, 0, $pos)])) {
// Configure default filter with property
$field = "{$rootAlias}.{$field}";
} else {
$alias = QueryBuilderHelper::addJoinOnce($queryBuilder, $queryNameGenerator, $rootAlias, substr($field, 0, $pos));
$field = sprintf('%s.%s', $alias, substr($field, $pos + 1));
$order = [$order];
}

foreach ($order as $property => $direction) {
if (\is_int($property)) {
$property = $direction;
$direction = self::DIRECTION_ASC;
}

$alias = $queryBuilder->getRootAliases()[0];
$field = $property;

if ($this->isPropertyNested($property, $resourceClass)) {
[$alias, $field] = $this->addJoinsForNestedProperty($property, $alias, $queryBuilder, $queryNameGenerator, $resourceClass);
}
$queryBuilder->addOrderBy($field, $order);
$queryBuilder->addOrderBy(sprintf('%s.%s', $alias, $field), $direction);
}

return;
}
}

if (null !== $this->order) {
foreach ($identifiers as $identifier) {
$queryBuilder->addOrderBy("{$rootAlias}.{$identifier}", $this->order);
$this->addOrderByForAllIdentifiers($queryBuilder, $resourceClass, $this->order);
}
}

/**
* {@inheritdoc}
*/
protected function getClassMetadata(string $resourceClass): ClassMetadata
{
// BC
if (null === $this->managerRegistry) {
if (null === $this->entityManager) {
throw new \RuntimeException('The manager registry was not provided, and the entity manager was not set on the class.');
}

return $this->entityManager->getClassMetadata($resourceClass);
}

return $this
->getManagerRegistry()
->getManagerForClass($resourceClass)
->getClassMetadata($resourceClass);
}

/**
* {@inheritdoc}
*/
protected function getManagerRegistry(): ManagerRegistry
{
return $this->managerRegistry;
}

private function addOrderByForAllIdentifiers(QueryBuilder $queryBuilder, string $resourceClass, string $direction): void
{
$rootAlias = $queryBuilder->getRootAliases()[0];

foreach ($this->getClassMetadata($resourceClass)->getIdentifier() as $field) {
$queryBuilder->addOrderBy(sprintf('%s.%s', $rootAlias, $field), $direction);
}
}
}
1 change: 1 addition & 0 deletions src/Bridge/Symfony/Bundle/Resources/config/doctrine_orm.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,7 @@
<service id="api_platform.doctrine.orm.query_extension.order" class="ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\OrderExtension" public="false">
<argument>%api_platform.collection.order%</argument>
<argument type="service" id="api_platform.metadata.resource.metadata_factory" />
<argument type="service" id="doctrine" />

<tag name="api_platform.doctrine.orm.query_extension.collection" priority="-32" />
</service>
Expand Down
43 changes: 21 additions & 22 deletions tests/Bridge/Doctrine/MongoDbOdm/Extension/OrderExtensionTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,37 +118,36 @@ public function testApplyToCollectionWithOrderOverriddenWithNoDirection()
$orderExtensionTest->applyToCollection($aggregationBuilder, Dummy::class);
}

public function testApplyToCollectionWithOrderOverriddenWithAssociation()
public function testApplyToCollectionOrderByNestedAssociationField(): void
{
$resourceMetadataFactoryProphecy = $this->prophesize(ResourceMetadataFactoryInterface::class);
$aggregationBuilderProphecy = $this->prophesize(Builder::class);
$resourceMetadataFactoryProphecy->create(Dummy::class)->willReturn(new ResourceMetadata(null, null, null, null, null, ['order' => ['author.name']]));

$classMetadataProphecy = $this->prophesize(ClassMetadata::class);
$classMetadataProphecy->getIdentifier()->willReturn(['name']);
$classMetadataProphecy->hasAssociation('author')->willReturn(true);
$classMetadataProphecy->hasAssociation('name')->willReturn(false);
$classMetadataProphecy->getAssociationTargetClass('author')->willReturn(Dummy::class);
$classMetadataProphecy->hasReference('author')->willReturn(true);
$classMetadataProphecy->getFieldMapping('author')->willReturn(['isOwningSide' => true, 'storeAs' => ClassMetadata::REFERENCE_STORE_AS_ID]);

$objectManagerProphecy = $this->prophesize(DocumentManager::class);
$objectManagerProphecy->getClassMetadata(Dummy::class)->willReturn($classMetadataProphecy);

$managerRegistryProphecy = $this->prophesize(ManagerRegistry::class);
$managerRegistryProphecy->getManagerForClass(Dummy::class)->willReturn($objectManagerProphecy);

$lookupProphecy = $this->prophesize(Lookup::class);
$lookupProphecy->localField('author')->shouldBeCalled()->willReturn($lookupProphecy);
$lookupProphecy->foreignField('_id')->shouldBeCalled()->willReturn($lookupProphecy);
$lookupProphecy->alias('author_lkup')->shouldBeCalled();
$aggregationBuilderProphecy->lookup(Dummy::class)->shouldBeCalled()->willReturn($lookupProphecy->reveal());

$aggregationBuilderProphecy = $this->prophesize(Builder::class);
$aggregationBuilderProphecy->lookup(Dummy::class)->shouldBeCalled()->willReturn($lookupProphecy);
$aggregationBuilderProphecy->unwind('$author_lkup')->shouldBeCalled();
$aggregationBuilderProphecy->sort(['author_lkup.name' => 'ASC'])->shouldBeCalled();

$classMetadataProphecy = $this->prophesize(ClassMetadata::class);
$classMetadataProphecy->getIdentifier()->shouldBeCalled()->willReturn(['name']);
$classMetadataProphecy->hasAssociation('author')->shouldBeCalled()->willReturn(true);
$classMetadataProphecy->hasAssociation('name')->shouldBeCalled()->willReturn(false);
$classMetadataProphecy->getAssociationTargetClass('author')->shouldBeCalled()->willReturn(Dummy::class);
$classMetadataProphecy->hasReference('author')->shouldBeCalled()->willReturn(true);
$classMetadataProphecy->getFieldMapping('author')->shouldBeCalled()->willReturn(['isOwningSide' => true, 'storeAs' => ClassMetadata::REFERENCE_STORE_AS_ID]);

$resourceMetadataFactoryProphecy->create(Dummy::class)->shouldBeCalled()->willReturn(new ResourceMetadata(null, null, null, null, null, ['order' => ['author.name']]));

$objectManagerProphecy = $this->prophesize(DocumentManager::class);
$objectManagerProphecy->getClassMetadata(Dummy::class)->shouldBeCalled()->willReturn($classMetadataProphecy->reveal());

$managerRegistryProphecy = $this->prophesize(ManagerRegistry::class);
$managerRegistryProphecy->getManagerForClass(Dummy::class)->shouldBeCalled()->willReturn($objectManagerProphecy->reveal());

$aggregationBuilder = $aggregationBuilderProphecy->reveal();
$orderExtensionTest = new OrderExtension('asc', $resourceMetadataFactoryProphecy->reveal(), $managerRegistryProphecy->reveal());
$orderExtensionTest->applyToCollection($aggregationBuilder, Dummy::class);
$orderExtension = new OrderExtension('asc', $resourceMetadataFactoryProphecy->reveal(), $managerRegistryProphecy->reveal());
$orderExtension->applyToCollection($aggregationBuilderProphecy->reveal(), Dummy::class);
}
}
Loading