Merge pull request #102 from TomHAnderson/feature/field-specific-crit…

…eria Added excludeCriteria to Field Attributes
API-Skeletons · Jan 23, 2023 · ef25882 · ef25882
2 parents e341cfc + 5b5729d
commit ef25882
Show file tree

Hide file tree

Showing 5 changed files with 48 additions and 5 deletions.
diff --git a/src/Attribute/Field.php b/src/Attribute/Field.php
@@ -9,11 +9,13 @@
 #[Attribute(Attribute::TARGET_PROPERTY | Attribute::IS_REPEATABLE)]
 class Field
 {
+    /** @param string[] $excludeCriteria */
     public function __construct(
         protected string $group = 'default',
         protected string|null $strategy = null,
         protected string|null $description = null,
         protected string|null $type = null,
+        private array $excludeCriteria = [],
     ) {
     }
 
@@ -36,4 +38,10 @@ public function getType(): string|null
     {
         return $this->type;
     }
+
+    /** @return string[] */
+    public function getExcludeCriteria(): array
+    {
+        return $this->excludeCriteria;
+    }
 }
diff --git a/src/Criteria/CriteriaFactory.php b/src/Criteria/CriteriaFactory.php
@@ -17,6 +17,7 @@
 use function array_filter;
 use function array_keys;
 use function assert;
+use function count;
 use function in_array;
 
 class CriteriaFactory
@@ -87,6 +88,21 @@ public function get(
 
             assert($graphQLType, 'GraphQL type not found for ' . $fieldMetadata['type']);
 
+            // Limit field filters
+            if (
+                isset($entityMetadata['fields'][$fieldName]['excludeCriteria'])
+                && count($entityMetadata['fields'][$fieldName]['excludeCriteria'])
+            ) {
+                // Compute the difference of arrays
+                $fieldExcludeCriteria = $entityMetadata['fields'][$fieldName]['excludeCriteria'];
+                $allowedFilters       = array_filter(
+                    $allowedFilters,
+                    static function ($value) use ($fieldExcludeCriteria) {
+                        return ! in_array($value, $fieldExcludeCriteria);
+                    },
+                );
+            }
+
             $fields[$fieldName] = [
                 'name' => $fieldName,
                 'type' => new FiltersInputType($typeName, $fieldName, $graphQLType, $allowedFilters),

diff --git a/src/Metadata/MetadataFactory.php b/src/Metadata/MetadataFactory.php
@@ -87,6 +87,8 @@ private function globalEnable(array $entityClasses): Metadata
                 // Set default strategy based on field type
                 $this->metadataConfig[$entityClass]['fields'][$fieldName]['strategy'] =
                     $this->getDefaultStrategy($entityClassMetadata->getTypeOfField($fieldName));
+
+                $this->metadataConfig[$entityClass]['fields'][$fieldName]['excludeCriteria'] = [];
             }
 
             // Fetch attributes for associations
@@ -217,6 +219,9 @@ private function buildMetadataConfigForFields(
                     continue;
                 }
 
+                $this->metadataConfig[$reflectionClass->getName()]['fields'][$fieldName]['excludeCriteria'] =
+                    $instance->getExcludeCriteria();
+
                 // Set default strategy based on field type
                 $this->metadataConfig[$reflectionClass->getName()]['fields'][$fieldName]['strategy'] =
                     $this->getDefaultStrategy($entityClassMetadata->getTypeOfField($fieldName));

diff --git a/test/Entity/Artist.php b/test/Entity/Artist.php
@@ -13,7 +13,7 @@
  * Artist
  */
 #[GraphQL\Entity(typeName: 'artist', description: 'Artists')]
-#[GraphQL\Entity(group: 'ExcludeCriteriaTest')]
+#[GraphQL\Entity(group: 'ExcludeCriteriaTest', excludeCriteria: ['neq'])]
 #[GraphQL\Entity(group: 'TypeNameTest')]
 #[GraphQL\Entity(group: 'DuplicateGroup')]
 #[GraphQL\Entity(group: 'DuplicateGroup')]
@@ -23,7 +23,7 @@
 class Artist
 {
     #[GraphQL\Field(description: 'Artist name')]
-    #[GraphQL\Field(group: 'ExcludeCriteriaTest')]
+    #[GraphQL\Field(group: 'ExcludeCriteriaTest', excludeCriteria: ['eq'])]
     #[GraphQL\Field(group: 'TypeNameTest')]
     #[GraphQL\Field(group: 'DuplicateGroup')]
     #[GraphQL\Field(group: 'DuplicateGroup')]

diff --git a/test/Feature/Criteria/ExcludeCriteriaTest.php b/test/Feature/Criteria/ExcludeCriteriaTest.php
@@ -24,7 +24,7 @@ public function testExcludeCriteria(): void
             'query' => new ObjectType([
                 'name' => 'query',
                 'fields' => [
-                    'artist' => [
+                    'artists' => [
                         'type' => $driver->connection($driver->type(Artist::class)),
                         'args' => [
                             'filter' => $driver->filter(Artist::class),
@@ -36,14 +36,28 @@ public function testExcludeCriteria(): void
             ]),
         ]);
 
-        $query  = '{ artist { edges { node { performances ( filter: {venue: { neq: "test"} } ) { edges { node { venue } } } } } } }';
+        $query  = '{ artists (filter: { name: { eq: "Grateful Dead" } } ) { edges { node { name } } } }';
+        $result = GraphQL::executeQuery($schema, $query);
+
+        foreach ($result->errors as $error) {
+            $this->assertEquals('Field "eq" is not defined by type "ApiSkeletonsTest_Doctrine_GraphQL_Entity_Artist_ExcludeCriteriaTest_filter_name_filters".', $error->getMessage());
+        }
+
+        $query  = '{ artists (filter: { name: { neq: "Grateful Dead" } } ) { edges { node { name } } } }';
+        $result = GraphQL::executeQuery($schema, $query);
+
+        foreach ($result->errors as $error) {
+            $this->assertEquals('Field "neq" is not defined by type "ApiSkeletonsTest_Doctrine_GraphQL_Entity_Artist_ExcludeCriteriaTest_filter_name_filters".', $error->getMessage());
+        }
+
+        $query  = '{ artists { edges { node { performances ( filter: {venue: { neq: "test"} } ) { edges { node { venue } } } } } } }';
         $result = GraphQL::executeQuery($schema, $query);
 
         foreach ($result->errors as $error) {
             $this->assertEquals('Field "neq" is not defined by type "ApiSkeletonsTest_Doctrine_GraphQL_Entity_Artist_ExcludeCriteriaTest_performances_filter_venue_filters". Did you mean "eq"?', $error->getMessage());
         }
 
-        $query  = '{ artist { edges { node { performances ( filter: {venue: { contains: "test" } } ) { edges { node { venue } } } } } } }';
+        $query  = '{ artists { edges { node { performances ( filter: {venue: { contains: "test" } } ) { edges { node { venue } } } } } } }';
         $result = GraphQL::executeQuery($schema, $query);
 
         foreach ($result->errors as $error) {