fix(symfony): cache invalidation should handle multiple GetCollection operations

Author: mrossard

src/Symfony/Bundle/Resources/config/doctrine_orm_http_cache_purger.php

@@ -23,6 +23,7 @@
             service('api_platform.http_cache.purger'),
             service('api_platform.iri_converter'),
             service('api_platform.resource_class_resolver'),
+            service('api_platform.metadata.resource.metadata_collection_factory'),
             service('api_platform.property_accessor'),
             service('api_platform.object_mapper')->nullOnInvalid(),
             service('api_platform.object_mapper.metadata_factory')->nullOnInvalid(),

src/Symfony/Doctrine/EventListener/PurgeHttpCacheListener.php

@@ -18,6 +18,7 @@
 use ApiPlatform\Metadata\Exception\OperationNotFoundException;
 use ApiPlatform\Metadata\GetCollection;
 use ApiPlatform\Metadata\IriConverterInterface;
+use ApiPlatform\Metadata\Resource\Factory\ResourceMetadataCollectionFactoryInterface;
 use ApiPlatform\Metadata\ResourceClassResolverInterface;
 use ApiPlatform\Metadata\UrlGeneratorInterface;
 use ApiPlatform\Metadata\Util\ClassInfoTrait;
@@ -48,9 +49,10 @@ final class PurgeHttpCacheListener
     public function __construct(private readonly PurgerInterface $purger,
         private readonly IriConverterInterface $iriConverter,
         private readonly ResourceClassResolverInterface $resourceClassResolver,
+        private readonly ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory,
         ?PropertyAccessorInterface $propertyAccessor = null,
         private readonly ?ObjectMapperInterface $objectMapper = null,
-        private readonly ?ObjectMapperMetadataFactoryInterface $objectMapperMetadata = null)
+        private readonly ?ObjectMapperMetadataFactoryInterface $objectMapperMetadata = null, )
     {
         $this->propertyAccessor = $propertyAccessor ?? PropertyAccess::createPropertyAccessor();
     }
@@ -128,8 +130,17 @@ private function gatherResourceAndItemTags(object $entity, bool $purgeItem): voi
 
         foreach ($resources as $resource) {
             try {
-                $iri = $this->iriConverter->getIriFromResource($resource, UrlGeneratorInterface::ABS_PATH, new GetCollection());
-                $this->tags[$iri] = $iri;
+                // Here we need to loop on all GetCollection Operations, there can be multiple for a single resource class
+                $resourceClass = $this->resourceClassResolver->getResourceClass($resource);
+                $resourceMetadataCollection = $this->resourceMetadataCollectionFactory->create($resourceClass);
+                foreach ($resourceMetadataCollection as $resourceMetadata) {
+                    foreach ($resourceMetadata->getOperations() as $operation) {
+                        if ($operation instanceof GetCollection) {
+                            $iri = $this->iriConverter->getIriFromResource($resource, UrlGeneratorInterface::ABS_PATH, $operation);
+                            $this->tags[$iri] = $iri;
+                        }
+                    }
+                }
 
                 if ($purgeItem) {
                     $this->addTagForItem($entity);