Merge pull request #138 from TomHAnderson/feature/sort-fields

Added sortFields config option

Author: TomHAnderson

src/Config.php

@@ -61,6 +61,12 @@ class Config
      */
     protected string|null $entityPrefix = null;
 
+    /**
+     * @var bool|null When set to true entity fields will be
+     *                sorted alphabetically
+     */
+    protected bool|null $sortFields = null;
+
     /** @param mixed[] $config */
     public function __construct(array $config = [])
     {
@@ -171,4 +177,16 @@ public function getEntityPrefix(): string|null
     {
         return $this->entityPrefix;
     }
+
+    public function setSortFields(bool|null $sortFields): self
+    {
+        $this->sortFields = $sortFields;
+
+        return $this;
+    }
+
+    public function getSortFields(): bool|null
+    {
+        return $this->sortFields;
+    }
 }

src/Type/Entity.php

@@ -6,12 +6,14 @@
 
 use ApiSkeletons\Doctrine\GraphQL\AbstractContainer;
 use ApiSkeletons\Doctrine\GraphQL\Buildable;
+use ApiSkeletons\Doctrine\GraphQL\Config;
 use ApiSkeletons\Doctrine\GraphQL\Criteria\CriteriaFactory;
 use ApiSkeletons\Doctrine\GraphQL\Event\EntityDefinition;
 use ApiSkeletons\Doctrine\GraphQL\Hydrator\HydratorFactory;
 use ApiSkeletons\Doctrine\GraphQL\Resolve\FieldResolver;
 use ApiSkeletons\Doctrine\GraphQL\Resolve\ResolveCollectionFactory;
 use ArrayObject;
+use Closure;
 use Doctrine\ORM\EntityManager;
 use Doctrine\ORM\Mapping\ClassMetadataInfo;
 use Doctrine\ORM\Mapping\MappingException;
@@ -23,12 +25,17 @@
 use function array_keys;
 use function assert;
 use function in_array;
+use function ksort;
+
+use const SORT_REGULAR;
 
 class Entity implements Buildable
 {
     /** @var mixed[]  */
     protected array $metadata;
 
+    protected Config $config;
+
     protected CriteriaFactory $criteriaFactory;
 
     protected EntityManager $entityManager;
@@ -50,6 +57,7 @@ public function __construct(AbstractContainer $container, string $typeName, arra
         $container = $container->getContainer();
 
         $this->collectionFactory = $container->get(ResolveCollectionFactory::class);
+        $this->config            = $container->get(Config::class);
         $this->criteriaFactory   = $container->get(CriteriaFactory::class);
         $this->entityManager     = $container->get(EntityManager::class);
         $this->eventDispatcher   = $container->get(EventDispatcher::class);
@@ -127,6 +135,17 @@ protected function getGraphQLType(): ObjectType
             new EntityDefinition($arrayObject, $this->getEntityClass() . '.definition'),
         );
 
+        /**
+         * If sortFields then resolve the fiels and sort them
+         */
+        if ($this->config->getSortFields()) {
+            if ($arrayObject['fields'] instanceof Closure) {
+                $arrayObject['fields'] = $arrayObject['fields']();
+            }
+
+            ksort($arrayObject['fields'], SORT_REGULAR);
+        }
+
         /** @psalm-suppress InvalidArgument */
         $objectType = new ObjectType($arrayObject->getArrayCopy());
         $this->typeManager->set($this->getTypeName(), $objectType);

test/Feature/Type/EntityTest.php

@@ -6,13 +6,21 @@
 
 use ApiSkeletons\Doctrine\GraphQL\Config;
 use ApiSkeletons\Doctrine\GraphQL\Driver;
+use ApiSkeletons\Doctrine\GraphQL\Event\EntityDefinition;
 use ApiSkeletons\Doctrine\GraphQL\Hydrator\Strategy\AssociationDefault;
 use ApiSkeletons\Doctrine\GraphQL\Hydrator\Strategy\FieldDefault;
 use ApiSkeletons\Doctrine\GraphQL\Hydrator\Strategy\ToInteger;
 use ApiSkeletons\Doctrine\GraphQL\Type\Entity;
 use ApiSkeletons\Doctrine\GraphQL\Type\TypeManager;
 use ApiSkeletonsTest\Doctrine\GraphQL\AbstractTest;
 use ApiSkeletonsTest\Doctrine\GraphQL\Entity\Recording;
+use ApiSkeletonsTest\Doctrine\GraphQL\Entity\User;
+use ArrayObject;
+use League\Event\EventDispatcher;
+
+use function array_keys;
+use function array_values;
+use function sort;
 
 class EntityTest extends AbstractTest
 {
@@ -58,4 +66,36 @@ public function testEntityMetadata(): void
 
         $this->assertEquals('entitytestrecording_entityTest', $metadata['typeName']);
     }
+
+    public function testSortFields(): void
+    {
+        $unsortedFields           = new ArrayObject();
+        $unsortedFields['fields'] = [];
+
+        $config = new Config(['sortFields' => true]);
+
+        $driver = new Driver($this->getEntityManager(), $config);
+
+        // Fields are only sorted after this event is fired
+        $driver->get(EventDispatcher::class)->subscribeTo(
+            User::class . '.definition',
+            static function (EntityDefinition $event) use ($unsortedFields): void {
+                $fields = $event->getDefinition()['fields']();
+
+                $unsortedFields['fields'] = array_keys($fields);
+            },
+        );
+
+        $graphQLType  = $driver->get(TypeManager::class)
+            ->build(Entity::class, User::class)();
+        $fields       = array_keys($graphQLType->getFields());
+        $fieldsSorted = $fields;
+        sort($fieldsSorted);
+        $unsortedFieldsSorted = $unsortedFields['fields'];
+        sort($unsortedFieldsSorted);
+
+        $this->assertNotEquals(array_values($unsortedFields['fields']), $fields);
+        $this->assertEquals($fields, $fieldsSorted);
+        $this->assertEquals($fields, $unsortedFieldsSorted);
+    }
 }