Fix 1246: configure default order on ApiResource annotation (#1321)

Author: vincentchalamon

features/bootstrap/FeatureContext.php

@@ -28,6 +28,7 @@
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\EmbeddableDummy;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\EmbeddedDummy;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\FileConfigDummy;
+use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\Foo;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\Node;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\Question;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\RelatedDummy;
@@ -132,6 +133,23 @@ public function thereIsDummyObjects($nb)
         $this->manager->flush();
     }
 
+    /**
+     * @Given there are :nb foo objects with fake names
+     */
+    public function thereAreFooObjectsWithFakeNames($nb)
+    {
+        $names = ['Hawsepipe', 'Sthenelus', 'Ephesian', 'Separativeness', 'Balbo'];
+
+        for ($i = 0; $i < $nb; ++$i) {
+            $foo = new Foo();
+            $foo->setName($names[$i]);
+
+            $this->manager->persist($foo);
+        }
+
+        $this->manager->flush();
+    }
+
     /**
      * @Given there is :nb dummy group objects
      */

features/main/default_order.feature

@@ -0,0 +1,57 @@
+Feature: Default order
+  In order to get a list in a specific order,
+  As a client software developer,
+  I need to be able to specify default order.
+
+  @createSchema @dropSchema
+  Scenario: Override custom order
+    Given there are 5 foo objects with fake names
+    When I send a "GET" request to "/foos?itemsPerPage=10"
+    Then the response status code should be 200
+    And the response should be in JSON
+    And the header "Content-Type" should be equal to "application/ld+json; charset=utf-8"
+    And the JSON should be equal to:
+    """
+    {
+      "@context": "/contexts/Foo",
+      "@id": "/foos",
+      "@type": "hydra:Collection",
+      "hydra:member": [
+        {
+          "@id": "/foos/2",
+          "@type": "Foo",
+          "id": 2,
+          "name": "Sthenelus"
+        },
+        {
+          "@id": "/foos/4",
+          "@type": "Foo",
+          "id": 4,
+          "name": "Separativeness"
+        },
+        {
+          "@id": "/foos/1",
+          "@type": "Foo",
+          "id": 1,
+          "name": "Hawsepipe"
+        },
+        {
+          "@id": "/foos/3",
+          "@type": "Foo",
+          "id": 3,
+          "name": "Ephesian"
+        },
+        {
+          "@id": "/foos/5",
+          "@type": "Foo",
+          "id": 5,
+          "name": "Balbo"
+        }
+      ],
+      "hydra:totalItems": 5,
+      "hydra:view": {
+        "@id": "/foos?itemsPerPage=10",
+        "@type": "hydra:PartialCollectionView"
+      }
+    }
+    """

src/Bridge/Doctrine/Orm/Extension/OrderExtension.php

@@ -14,20 +14,24 @@
 namespace ApiPlatform\Core\Bridge\Doctrine\Orm\Extension;
 
 use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGeneratorInterface;
+use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
 use Doctrine\ORM\QueryBuilder;
 
 /**
  * Applies selected ordering while querying resource collection.
  *
  * @author Kévin Dunglas <[email protected]>
  * @author Samuel ROZE <[email protected]>
+ * @author Vincent Chalamon <[email protected]>
  */
 final class OrderExtension implements QueryCollectionExtensionInterface
 {
     private $order;
+    private $resourceMetadataFactory;
 
-    public function __construct(string $order = null)
+    public function __construct(string $order = null, ResourceMetadataFactoryInterface $resourceMetadataFactory = null)
     {
+        $this->resourceMetadataFactory = $resourceMetadataFactory;
         $this->order = $order;
     }
 
@@ -38,6 +42,14 @@ public function applyToCollection(QueryBuilder $queryBuilder, QueryNameGenerator
     {
         $classMetaData = $queryBuilder->getEntityManager()->getClassMetadata($resourceClass);
         $identifiers = $classMetaData->getIdentifier();
+        if (null !== $this->resourceMetadataFactory) {
+            $defaultOrder = $this->resourceMetadataFactory->create($resourceClass)->getAttribute('order');
+            if (null !== $defaultOrder) {
+                $queryBuilder->addOrderBy('o.'.$defaultOrder[0], $defaultOrder[1] ?? 'ASC');
+
+                return;
+            }
+        }
 
         if (null !== $this->order) {
             foreach ($identifiers as $identifier) {

src/Bridge/Symfony/Bundle/Resources/config/doctrine_orm.xml

@@ -154,6 +154,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" />
 
             <tag name="api_platform.doctrine.orm.query_extension.collection" priority="16" />
         </service>

tests/Bridge/Doctrine/Orm/Extension/OrderExtensionTest.php

@@ -15,6 +15,8 @@
 
 use ApiPlatform\Core\Bridge\Doctrine\Orm\Extension\OrderExtension;
 use ApiPlatform\Core\Bridge\Doctrine\Orm\Util\QueryNameGenerator;
+use ApiPlatform\Core\Metadata\Resource\Factory\ResourceMetadataFactoryInterface;
+use ApiPlatform\Core\Metadata\Resource\ResourceMetadata;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\Dummy;
 use Doctrine\ORM\EntityManager;
 use Doctrine\ORM\Mapping\ClassMetadata;
@@ -62,4 +64,48 @@ public function testApplyToCollectionWithWrongOrder()
         $orderExtensionTest = new OrderExtension();
         $orderExtensionTest->applyToCollection($queryBuilder, new QueryNameGenerator(), Dummy::class);
     }
+
+    public function testApplyToCollectionWithOrderOverriden()
+    {
+        $resourceMetadataFactoryProphecy = $this->prophesize(ResourceMetadataFactoryInterface::class);
+        $queryBuilderProphecy = $this->prophesize(QueryBuilder::class);
+
+        $queryBuilderProphecy->addOrderBy('o.foo', 'DESC')->shouldBeCalled();
+
+        $classMetadataProphecy = $this->prophesize(ClassMetadata::class);
+        $classMetadataProphecy->getIdentifier()->shouldBeCalled()->willReturn(['name']);
+
+        $resourceMetadataFactoryProphecy->create(Dummy::class)->shouldBeCalled()->willReturn(new ResourceMetadata(null, null, null, null, null, ['order' => ['foo', 'DESC']]));
+
+        $emProphecy = $this->prophesize(EntityManager::class);
+        $emProphecy->getClassMetadata(Dummy::class)->shouldBeCalled()->willReturn($classMetadataProphecy->reveal());
+
+        $queryBuilderProphecy->getEntityManager()->shouldBeCalled()->willReturn($emProphecy->reveal());
+
+        $queryBuilder = $queryBuilderProphecy->reveal();
+        $orderExtensionTest = new OrderExtension('asc', $resourceMetadataFactoryProphecy->reveal());
+        $orderExtensionTest->applyToCollection($queryBuilder, new QueryNameGenerator(), Dummy::class);
+    }
+
+    public function testApplyToCollectionWithOrderOverridenWithNoDirection()
+    {
+        $resourceMetadataFactoryProphecy = $this->prophesize(ResourceMetadataFactoryInterface::class);
+        $queryBuilderProphecy = $this->prophesize(QueryBuilder::class);
+
+        $queryBuilderProphecy->addOrderBy('o.foo', 'ASC')->shouldBeCalled();
+
+        $classMetadataProphecy = $this->prophesize(ClassMetadata::class);
+        $classMetadataProphecy->getIdentifier()->shouldBeCalled()->willReturn(['name']);
+
+        $resourceMetadataFactoryProphecy->create(Dummy::class)->shouldBeCalled()->willReturn(new ResourceMetadata(null, null, null, null, null, ['order' => ['foo']]));
+
+        $emProphecy = $this->prophesize(EntityManager::class);
+        $emProphecy->getClassMetadata(Dummy::class)->shouldBeCalled()->willReturn($classMetadataProphecy->reveal());
+
+        $queryBuilderProphecy->getEntityManager()->shouldBeCalled()->willReturn($emProphecy->reveal());
+
+        $queryBuilder = $queryBuilderProphecy->reveal();
+        $orderExtensionTest = new OrderExtension('asc', $resourceMetadataFactoryProphecy->reveal());
+        $orderExtensionTest->applyToCollection($queryBuilder, new QueryNameGenerator(), Dummy::class);
+    }
 }

tests/Fixtures/TestBundle/Entity/Dummy.php

@@ -34,7 +34,7 @@
  *         "my_dummy.order",
  *         "my_dummy.range",
  *         "my_dummy.search",
- *     },
+ *     }
  * })
  * @ORM\Entity
  */

tests/Fixtures/TestBundle/Entity/Foo.php

@@ -0,0 +1,65 @@
+<?php
+
+/*
+ * This file is part of the API Platform project.
+ *
+ * (c) Kévin Dunglas <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types=1);
+
+namespace ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity;
+
+use ApiPlatform\Core\Annotation\ApiProperty;
+use ApiPlatform\Core\Annotation\ApiResource;
+use Doctrine\ORM\Mapping as ORM;
+use Symfony\Component\Validator\Constraints as Assert;
+
+/**
+ * Foo.
+ *
+ * @author Vincent Chalamon <[email protected]>
+ *
+ * @ApiResource(attributes={
+ *     "order"={"name", "DESC"}
+ * })
+ * @ORM\Entity
+ */
+class Foo
+{
+    /**
+     * @var int The id
+     *
+     * @ORM\Column(type="integer")
+     * @ORM\Id
+     * @ORM\GeneratedValue(strategy="AUTO")
+     */
+    private $id;
+
+    /**
+     * @var string The dummy name
+     *
+     * @ORM\Column
+     * @Assert\NotBlank
+     * @ApiProperty(iri="http://schema.org/name")
+     */
+    private $name;
+
+    public function getId()
+    {
+        return $this->id;
+    }
+
+    public function setName($name)
+    {
+        $this->name = $name;
+    }
+
+    public function getName()
+    {
+        return $this->name;
+    }
+}