Merge pull request #119 from TomHAnderson/feature/criteria-event

TomHAnderson · web-flow · commit d0cb76b18c5b · 2023-01-31T19:57:24.000-07:00
Feature/criteria event
diff --git a/README.md b/README.md
@@ -298,6 +298,42 @@ $driver->get(EventDispatcher::class)->subscribeTo(Artist::class . '.filterQueryB
 );
 ```
 
+### Filter Criteria (embedded collections)
+
+You may modify the criteria object used to filter associations.  For instance, if you use soft 
+deletes then you would want to filter out deleted rows from an association.
+
+```php
+use ApiSkeletons\Doctrine\GraphQL\Attribute as GraphQL;
+use ApiSkeletons\Doctrine\GraphQL\Event\FilterCriteria;
+use App\ORM\Entity\Artist;
+use League\Event\EventDispatcher;
+
+#[GraphQL\Entity]
+class Artist 
+{
+    #[GraphQL\Field]
+    public $id;
+    
+    #[GraphQL\Field]
+    public $name;
+    
+    #[GraphQL\Association(filterCriteriaEventName: self::class . '.performances.filterCriteria')]
+    public $performances;
+}
+
+// Add a listener to your driver
+$driver->get(EventDispatcher::class)->subscribeTo(
+    Artist::class . '.performances.filterCriteria',
+    function (FilterCriteria $event): void {
+        $event->getCriteria()->andWhere(
+            $event->getCriteria()->expr()->eq('isDeleted', false)
+        );
+    },
+);
+```
+
+
 ### Entity ObjectType Definition
 
 You may modify the array used to define an entity type before it is created. This can be used for generated data and the like. 
diff --git a/src/Attribute/Association.php b/src/Attribute/Association.php
@@ -15,6 +15,7 @@ public function __construct(
         protected string|null $strategy = null,
         protected string|null $description = null,
         protected array $excludeCriteria = [],
+        protected string|null $filterCriteriaEventName = null,
     ) {
     }
 
@@ -38,4 +39,9 @@ public function getExcludeCriteria(): array
     {
         return $this->excludeCriteria;
     }
+
+    public function getFilterCriteriaEventName(): string|null
+    {
+        return $this->filterCriteriaEventName;
+    }
 }
diff --git a/src/Event/FilterCriteria.php b/src/Event/FilterCriteria.php
@@ -0,0 +1,55 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ApiSkeletons\Doctrine\GraphQL\Event;
+
+use Doctrine\Common\Collections\Criteria;
+use GraphQL\Type\Definition\ResolveInfo;
+use League\Event\HasEventName;
+
+class FilterCriteria implements
+    HasEventName
+{
+    /** @param mixed[] $args */
+    public function __construct(
+        protected Criteria $criteria,
+        protected string $eventName,
+        protected mixed $objectValue,
+        protected array $args,
+        protected mixed $context,
+        protected ResolveInfo $info,
+    ) {
+    }
+
+    public function eventName(): string
+    {
+        return $this->eventName;
+    }
+
+    public function getCriteria(): Criteria
+    {
+        return $this->criteria;
+    }
+
+    public function getObjectValue(): mixed
+    {
+        return $this->objectValue;
+    }
+
+    /** @return mixed[] */
+    public function getArgs(): array
+    {
+        return $this->args;
+    }
+
+    public function getContext(): mixed
+    {
+        return $this->context;
+    }
+
+    public function getInfo(): ResolveInfo
+    {
+        return $this->info;
+    }
+}
diff --git a/src/Metadata/MetadataFactory.php b/src/Metadata/MetadataFactory.php
@@ -100,8 +100,10 @@ private function globalEnable(array $entityClasses): Metadata
                     continue;
                 }
 
-                $this->metadataConfig[$entityClass]['fields'][$associationName]['excludeCriteria'] = [];
-                $this->metadataConfig[$entityClass]['fields'][$associationName]['description']     = $associationName;
+                $this->metadataConfig[$entityClass]['fields'][$associationName]['excludeCriteria']         = [];
+                $this->metadataConfig[$entityClass]['fields'][$associationName]['description']             = $associationName;
+                $this->metadataConfig[$entityClass]['fields'][$associationName]['filterCriteriaEventName']
+                    = null;
 
                 // NullifyOwningAssociation is not used for globalEnable
                 $this->metadataConfig[$entityClass]['fields'][$associationName]['strategy'] =
@@ -257,10 +259,12 @@ private function buildMetadataConfigForAssociations(
                 );
                 $associationInstance = $instance;
 
-                $this->metadataConfig[$reflectionClass->getName()]['fields'][$associationName]['description']     =
+                $this->metadataConfig[$reflectionClass->getName()]['fields'][$associationName]['description']             =
                     $instance->getDescription();
-                $this->metadataConfig[$reflectionClass->getName()]['fields'][$associationName]['excludeCriteria'] =
+                $this->metadataConfig[$reflectionClass->getName()]['fields'][$associationName]['excludeCriteria']         =
                     $instance->getExcludeCriteria();
+                $this->metadataConfig[$reflectionClass->getName()]['fields'][$associationName]['filterCriteriaEventName'] =
+                    $instance->getFilterCriteriaEventName();
 
                 if ($instance->getStrategy()) {
                     $this->metadataConfig[$reflectionClass->getName()]['fields'][$associationName]['strategy']
diff --git a/src/Resolve/ResolveCollectionFactory.php b/src/Resolve/ResolveCollectionFactory.php
@@ -6,6 +6,8 @@
 
 use ApiSkeletons\Doctrine\GraphQL\Config;
 use ApiSkeletons\Doctrine\GraphQL\Criteria\Filters as FiltersDef;
+use ApiSkeletons\Doctrine\GraphQL\Event\FilterCriteria;
+use ApiSkeletons\Doctrine\GraphQL\Metadata\Metadata;
 use ApiSkeletons\Doctrine\GraphQL\Type\Entity;
 use ApiSkeletons\Doctrine\GraphQL\Type\TypeManager;
 use Closure;
@@ -15,6 +17,7 @@
 use Doctrine\ORM\Mapping\ClassMetadata;
 use Doctrine\ORM\PersistentCollection;
 use GraphQL\Type\Definition\ResolveInfo;
+use League\Event\EventDispatcher;
 
 use function base64_decode;
 use function base64_encode;
@@ -27,6 +30,8 @@ public function __construct(
         protected Config $config,
         protected FieldResolver $fieldResolver,
         protected TypeManager $typeManager,
+        protected EventDispatcher $eventDispatcher,
+        protected Metadata $metadata,
     ) {
     }
 
@@ -51,21 +56,29 @@ public function parseArrayValue(ClassMetadata $metadata, string $field, array $v
 
     public function get(Entity $entity): Closure
     {
-        return function ($source, $args, $context, ResolveInfo $resolveInfo) {
+        return function ($source, array $args, $context, ResolveInfo $info) {
             $fieldResolver = $this->fieldResolver;
-            $collection    = $fieldResolver($source, $args, $context, $resolveInfo);
+            $collection    = $fieldResolver($source, $args, $context, $info);
 
             $collectionMetadata = $this->entityManager->getMetadataFactory()
                 ->getMetadataFor(
                     (string) $this->entityManager->getMetadataFactory()
                         ->getMetadataFor(ClassUtils::getRealClass($source::class))
-                        ->getAssociationTargetClass($resolveInfo->fieldName),
+                        ->getAssociationTargetClass($info->fieldName),
                 );
 
+            $metadataConfig = $this->metadata->getMetadataConfig();
+            $entityClass    = ClassUtils::getRealClass($source::class);
+
             return $this->buildPagination(
                 $args['pagination'] ?? [],
                 $collection,
                 $this->buildCriteria($args['filter'] ?? [], $collectionMetadata),
+                $metadataConfig[$entityClass]['fields'][$info->fieldName]['filterCriteriaEventName'],
+                $source,
+                $args,
+                $context,
+                $info,
             );
         };
     }
@@ -116,8 +129,13 @@ private function buildCriteria(array $filter, ClassMetadata $collectionMetadata)
      *
      * @return mixed[]
      */
-    private function buildPagination(array $pagination, PersistentCollection $collection, Criteria $criteria): array
-    {
+    private function buildPagination(
+        array $pagination,
+        PersistentCollection $collection,
+        Criteria $criteria,
+        string|null $filterCriteriaEventName,
+        mixed ...$resolve,
+    ): array {
         $first  = 0;
         $after  = 0;
         $last   = 0;
@@ -174,6 +192,19 @@ private function buildPagination(array $pagination, PersistentCollection $collec
             $criteria->setMaxResults($limit);
         }
 
+        /**
+         * Fire the event dispatcher using the passed event name.
+         */
+        if ($filterCriteriaEventName) {
+            $this->eventDispatcher->dispatch(
+                new FilterCriteria(
+                    $criteria,
+                    $filterCriteriaEventName,
+                    ...$resolve,
+                ),
+            );
+        }
+
         // Fetch slice of collection
         $items = $collection->matching($criteria);
 
diff --git a/src/Services.php b/src/Services.php
@@ -69,6 +69,8 @@ static function (ContainerInterface $container) {
                         $container->get(Config::class),
                         $container->get(Resolve\FieldResolver::class),
                         $container->get(Type\TypeManager::class),
+                        $container->get(EventDispatcher::class),
+                        $container->get(Metadata\Metadata::class),
                     );
                 },
             )
diff --git a/test/Entity/Artist.php b/test/Entity/Artist.php
@@ -19,6 +19,7 @@
 #[GraphQL\Entity(group: 'DuplicateGroup')]
 #[GraphQL\Entity(group: 'DuplicateGroupField')]
 #[GraphQL\Entity(group: 'DuplicateGroupAssociation')]
+#[GraphQL\Entity(group: 'FilterCriteriaEvent')]
 #[ORM\Entity]
 class Artist
 {
@@ -29,12 +30,14 @@ class Artist
     #[GraphQL\Field(group: 'DuplicateGroup')]
     #[GraphQL\Field(group: 'DuplicateGroupField')]
     #[GraphQL\Field(group: 'DuplicateGroupField')]
+    #[GraphQL\Field(group: 'FilterCriteriaEvent')]
     #[ORM\Column(type: 'string', nullable: false)]
     private string $name;
 
     #[GraphQL\Field(description: 'Primary key')]
     #[GraphQL\Field(group: 'ExcludeCriteriaTest')]
     #[GraphQL\Field(group: 'TypeNameTest')]
+    #[GraphQL\Field(group: 'FilterCriteriaEvent')]
     #[ORM\Id]
     #[ORM\Column(type: 'bigint')]
     #[ORM\GeneratedValue(strategy: 'AUTO')]
@@ -47,6 +50,7 @@ class Artist
     #[GraphQL\Association(group: 'DuplicateGroup')]
     #[GraphQL\Association(group: 'DuplicateGroupAssociation')]
     #[GraphQL\Association(group: 'DuplicateGroupAssociation')]
+    #[GraphQL\Association(group: 'FilterCriteriaEvent', filterCriteriaEventName: self::class . '.performances.filterCriteria')]
     #[ORM\OneToMany(targetEntity: 'ApiSkeletonsTest\Doctrine\GraphQL\Entity\Performance', mappedBy: 'artist')]
     private Collection $performances;
 
diff --git a/test/Entity/Performance.php b/test/Entity/Performance.php
@@ -15,19 +15,23 @@
  */
 #[GraphQL\Entity(typeName: 'performance', description: 'Performances')]
 #[GraphQL\Entity(group: 'ExcludeCriteriaTest', excludeCriteria: ['contains'])]
+#[GraphQL\Entity(group: 'FilterCriteriaEvent')]
 #[ORM\Entity]
 class Performance
 {
     #[GraphQL\Field(description: 'Venue name')]
     #[GraphQL\Field(description: 'Venue name', group: 'ExcludeCriteriaTest')]
+    #[GraphQL\Field(group: 'FilterCriteriaEvent')]
     #[ORM\Column(type: 'string', nullable: true)]
     private string|null $venue = null;
 
     #[GraphQL\Field(description: 'City name')]
+    #[GraphQL\Field(group: 'FilterCriteriaEvent')]
     #[ORM\Column(type: 'string', nullable: true)]
     private string|null $city = null;
 
     #[GraphQL\Field(description: 'State name')]
+    #[GraphQL\Field(group: 'FilterCriteriaEvent')]
     #[ORM\Column(type: 'string', nullable: true)]
     private string|null $state = null;
 
diff --git a/test/Feature/Event/FilterCriteriaTest.php b/test/Feature/Event/FilterCriteriaTest.php
@@ -0,0 +1,86 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ApiSkeletonsTest\Doctrine\GraphQL\Feature\Event;
+
+use ApiSkeletons\Doctrine\GraphQL\Config;
+use ApiSkeletons\Doctrine\GraphQL\Driver;
+use ApiSkeletons\Doctrine\GraphQL\Event\FilterCriteria;
+use ApiSkeletonsTest\Doctrine\GraphQL\AbstractTest;
+use ApiSkeletonsTest\Doctrine\GraphQL\Entity\Artist;
+use Doctrine\Common\Collections\Criteria;
+use GraphQL\GraphQL;
+use GraphQL\Type\Definition\ObjectType;
+use GraphQL\Type\Definition\ResolveInfo;
+use GraphQL\Type\Schema;
+use League\Event\EventDispatcher;
+
+use function count;
+
+class FilterCriteriaTest extends AbstractTest
+{
+    public function testEvent(): void
+    {
+        $driver = new Driver($this->getEntityManager(), new Config(['group' => 'FilterCriteriaEvent']));
+
+        $driver->get(EventDispatcher::class)->subscribeTo(
+            Artist::class . '.performances.filterCriteria',
+            function (FilterCriteria $event): void {
+                $this->assertInstanceOf(Criteria::class, $event->getCriteria());
+
+                $event->getCriteria()->andWhere(
+                    $event->getCriteria()->expr()->eq('venue', 'Delta Center'),
+                );
+
+                $this->assertInstanceOf(Artist::class, $event->getObjectValue());
+                $this->assertEquals('contextTest', $event->getContext());
+                $this->assertIsArray($event->getArgs());
+                $this->assertInstanceOf(ResolveInfo::class, $event->getInfo());
+            },
+        );
+
+        $schema = new Schema([
+            'query' => new ObjectType([
+                'name' => 'query',
+                'fields' => [
+                    'artist' => [
+                        'type' => $driver->connection($driver->type(Artist::class)),
+                        'args' => [
+                            'filter' => $driver->filter(Artist::class),
+                        ],
+                        'resolve' => $driver->resolve(Artist::class),
+                    ],
+                ],
+            ]),
+        ]);
+
+        $query = '{
+            artist (filter: { id: { eq: 1 } } ) {
+              edges {
+                node {
+                  id
+                  name
+                  performances {
+                    edges {
+                      node {
+                        venue
+                      }
+                    }
+                  }
+                }
+              }
+            }
+        }';
+
+        $result = GraphQL::executeQuery($schema, $query, null, 'contextTest');
+        $data   = $result->toArray()['data'];
+
+        $this->assertEquals(1, count($data['artist']['edges']));
+        $this->assertEquals(1, count($data['artist']['edges'][0]['node']['performances']));
+        $this->assertEquals(
+            'Delta Center',
+            $data['artist']['edges'][0]['node']['performances']['edges'][0]['node']['venue'],
+        );
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@ public function __construct(`
`15`	`15`	`protected string\|null $strategy = null,`
`16`	`16`	`protected string\|null $description = null,`
`17`	`17`	`protected array $excludeCriteria = [],`
	`18`	`+ protected string\|null $filterCriteriaEventName = null,`
`18`	`19`	`) {`
`19`	`20`	`}`
`20`	`21`
`@@ -38,4 +39,9 @@ public function getExcludeCriteria(): array`
`38`	`39`	`{`
`39`	`40`	`return $this->excludeCriteria;`
`40`	`41`	`}`
	`42`	`+`
	`43`	`+ public function getFilterCriteriaEventName(): string\|null`
	`44`	`+ {`
	`45`	`+ return $this->filterCriteriaEventName;`
	`46`	`+ }`
`41`	`47`	`}`
Original file line number	Diff line number	Diff line change
`@@ -69,6 +69,8 @@ static function (ContainerInterface $container) {`
`69`	`69`	`$container->get(Config::class),`
`70`	`70`	`$container->get(Resolve\FieldResolver::class),`
`71`	`71`	`$container->get(Type\TypeManager::class),`
	`72`	`+ $container->get(EventDispatcher::class),`
	`73`	`+ $container->get(Metadata\Metadata::class),`
`72`	`74`	`);`
`73`	`75`	`},`
`74`	`76`	`)`