Exclude property from GraphQL sorting

This should have been excluded already since 4e52511

Author: PowerKiKi

src/Factory/AbstractFactory.php

@@ -6,8 +6,10 @@
 
 use Doctrine\Common\Annotations\Reader;
 use Doctrine\ORM\EntityManager;
+use Doctrine\ORM\Mapping\ClassMetadata;
 use Doctrine\Persistence\Mapping\Driver\AnnotationDriver;
 use Doctrine\Persistence\Mapping\Driver\MappingDriverChain;
+use GraphQL\Doctrine\Annotation\Exclude;
 use GraphQL\Doctrine\Exception;
 use GraphQL\Doctrine\Factory\MetadataReader\MappingDriverChainAdapter;
 use GraphQL\Doctrine\Types;
@@ -51,4 +53,20 @@ final protected function getAnnotationReader(): Reader
 
         throw new Exception('graphql-doctrine requires Doctrine to be configured with a `' . AnnotationDriver::class . '`.');
     }
+
+    /**
+     * Returns whether the property is excluded
+     *
+     * @param ClassMetadata $metadata
+     * @param string $propertyName
+     *
+     * @return bool
+     */
+    final protected function isPropertyExcluded(ClassMetadata $metadata, string $propertyName): bool
+    {
+        $property = $metadata->getReflectionProperty($propertyName);
+        $exclude = $this->getAnnotationReader()->getPropertyAnnotation($property, Exclude::class);
+
+        return $exclude !== null;
+    }
 }

src/Factory/Type/FilterGroupConditionTypeFactory.php

@@ -4,10 +4,8 @@
 
 namespace GraphQL\Doctrine\Factory\Type;
 
-use GraphQL\Doctrine\Annotation\Exclude;
 use GraphQL\Doctrine\Annotation\Filter;
 use GraphQL\Doctrine\Annotation\Filters;
-
 use GraphQL\Doctrine\Definition\Operator\AbstractOperator;
 use GraphQL\Doctrine\Definition\Operator\BetweenOperatorType;
 use GraphQL\Doctrine\Definition\Operator\EmptyOperatorType;
@@ -26,7 +24,6 @@
 use GraphQL\Type\Definition\LeafType;
 use GraphQL\Type\Definition\Type;
 use ReflectionClass;
-use ReflectionProperty;
 
 /**
  * A factory to create an InputObjectType from a Doctrine entity to
@@ -64,8 +61,7 @@ public function create(string $className, string $typeName): Type
                 foreach ($metadata->fieldMappings as $mapping) {
 
                     // Skip exclusion specified by user
-                    $property = $metadata->getReflectionProperty($mapping['fieldName']);
-                    if ($this->isExcluded($property)) {
+                    if ($this->isPropertyExcluded($metadata, $mapping['fieldName'])) {
                         continue;
                     }
 
@@ -284,18 +280,4 @@ private function getOperatorFieldName(string $className): string
 
         return lcfirst($name);
     }
-
-    /**
-     * Returns whether the property is excluded
-     *
-     * @param ReflectionProperty $property
-     *
-     * @return bool
-     */
-    private function isExcluded(ReflectionProperty $property): bool
-    {
-        $exclude = $this->getAnnotationReader()->getPropertyAnnotation($property, Exclude::class);
-
-        return $exclude !== null;
-    }
 }

src/Factory/Type/SortingTypeFactory.php

@@ -79,7 +79,9 @@ public function create(string $className, string $typeName): Type
     private function getPossibleValues(string $className): array
     {
         $metadata = $this->entityManager->getClassMetadata($className);
-        $standard = array_values($metadata->fieldNames);
+        $standard = array_values(array_filter($metadata->fieldNames, function ($fieldName) use ($metadata) {
+            return !$this->isPropertyExcluded($metadata, $fieldName);
+        }));
         $custom = $this->getCustomSortingNames($className);
 
         return array_merge($standard, $custom);

tests/SortingTypesTest.php

@@ -6,6 +6,7 @@
 
 use GraphQLTests\Doctrine\Blog\Model\Post;
 use GraphQLTests\Doctrine\Blog\Model\Special\ModelWithTraits;
+use GraphQLTests\Doctrine\Blog\Model\User;
 
 final class SortingTypesTest extends \PHPUnit\Framework\TestCase
 {
@@ -17,6 +18,12 @@ public function testCanGetPostSorting(): void
         $this->assertAllTypes('tests/data/PostSorting.graphqls', $actual);
     }
 
+    public function testCanGetUserSorting(): void
+    {
+        $actual = $this->types->getSorting(User::class);
+        $this->assertAllTypes('tests/data/UserSorting.graphqls', $actual);
+    }
+
     public function testCanInheritSortingFromTraits(): void
     {
         $actual = $this->types->getSorting(ModelWithTraits::class);

tests/data/UserSorting.graphqls

@@ -0,0 +1,34 @@
+schema {
+  query: query
+}
+
+"""Order to be used in DQL"""
+enum SortingOrder {
+  ASC
+  DESC
+}
+
+input UserSorting {
+  field: UserSortingField!
+
+  """
+  If true `NULL` values will be considered as the highest value, so appearing
+  last in a `ASC` order, and first in a `DESC` order.
+  """
+  nullAsHighest: Boolean = false
+  order: SortingOrder = ASC
+}
+
+"""Fields available for `UserSorting`"""
+enum UserSortingField {
+  creationDate
+  name
+  email
+  isAdministrator
+  id
+  pseudoRandom
+}
+
+type query {
+  defaultField(defaultArg: [UserSorting!]): Boolean
+}