Merge pull request #8130 from BacLuc/responsetagger-use-injection

refactor/api: inject EntityManager into PurgeHttpCacheListener

Author: simfeld

api/src/HttpCache/PurgeHttpCacheListener.php

@@ -28,7 +28,6 @@
 use App\Entity\HasId;
 use Doctrine\Common\Util\ClassUtils;
 use Doctrine\ORM\EntityManagerInterface;
-use Doctrine\ORM\Event\OnFlushEventArgs;
 use Doctrine\ORM\Event\PreUpdateEventArgs;
 use Doctrine\ORM\Mapping\AssociationMapping;
 use Doctrine\ORM\Mapping\ClassMetadata;
@@ -39,12 +38,19 @@
 /**
  * Purges responses containing modified entities from the proxy cache.
  */
-final class PurgeHttpCacheListener {
+final readonly class PurgeHttpCacheListener {
     use ClassInfoTrait;
 
     public const IRI_RELATION_DELIMITER = '#';
 
-    public function __construct(private readonly IriConverterInterface $iriConverter, private readonly ResourceClassResolverInterface $resourceClassResolver, private readonly PropertyAccessorInterface $propertyAccessor, private readonly ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory, private readonly CacheManager $cacheManager) {}
+    public function __construct(
+        private IriConverterInterface $iriConverter,
+        private ResourceClassResolverInterface $resourceClassResolver,
+        private PropertyAccessorInterface $propertyAccessor,
+        private ResourceMetadataCollectionFactoryInterface $resourceMetadataCollectionFactory,
+        private CacheManager $cacheManager,
+        private EntityManagerInterface $em,
+    ) {}
 
     /**
      * Collects tags from the previous and the current version of the updated entities to purge related documents.
@@ -72,32 +78,25 @@ public function preUpdate(PreUpdateEventArgs $eventArgs): void {
     /**
      * Collects tags from inserted, updated and deleted entities, including relations.
      */
-    public function onFlush(OnFlushEventArgs $eventArgs): void {
-        /** @var EntityManagerInterface */
-        $em = $eventArgs->getObjectManager();
-
-        if (!$em instanceof EntityManagerInterface) {
-            return;
-        }
-
-        $uow = $em->getUnitOfWork();
+    public function onFlush(): void {
+        $uow = $this->em->getUnitOfWork();
 
         foreach ($uow->getScheduledEntityInsertions() as $entity) {
-            $this->gatherResourceTags($em, $entity);
-            $this->gatherRelationTags($em, $entity);
+            $this->gatherResourceTags($entity);
+            $this->gatherRelationTags($entity);
         }
 
         foreach ($uow->getScheduledEntityUpdates() as $entity) {
-            $originalEntity = $this->getOriginalEntity($entity, $em);
+            $originalEntity = $this->getOriginalEntity($entity);
             $this->addTagForItem($entity);
-            $this->gatherResourceTags($em, $entity, $originalEntity);
+            $this->gatherResourceTags($entity, $originalEntity);
         }
 
         foreach ($uow->getScheduledEntityDeletions() as $entity) {
-            $originalEntity = $this->getOriginalEntity($entity, $em);
+            $originalEntity = $this->getOriginalEntity($entity);
             $this->addTagForItem($originalEntity);
-            $this->gatherResourceTags($em, $originalEntity);
-            $this->gatherRelationTags($em, $originalEntity);
+            $this->gatherResourceTags($originalEntity);
+            $this->gatherRelationTags($originalEntity);
         }
 
         // trigger cache purges for changes on many-to-many relations
@@ -138,13 +137,13 @@ private function addTagsForManyToManyRelations($collection, $entities) {
     /**
      * Computes the original state of the entity based on the current entity and on the changeset.
      */
-    private function getOriginalEntity($entity, $em) {
-        $uow = $em->getUnitOfWork();
+    private function getOriginalEntity($entity) {
+        $uow = $this->em->getUnitOfWork();
         $changeSet = $uow->getEntityChangeSet($entity);
-        $classMetadata = $em->getClassMetadata(ClassUtils::getClass($entity));
+        $classMetadata = $this->em->getClassMetadata(ClassUtils::getClass($entity));
 
         $originalEntity = clone $entity;
-        $em->detach($originalEntity);
+        $this->em->detach($originalEntity);
         foreach ($changeSet as $key => $value) {
             $classMetadata->setFieldValue($originalEntity, $key, $value[0]);
         }
@@ -158,7 +157,7 @@ private function getOriginalEntity($entity, $em) {
      * If oldEntity is provided, purge is only done if the IRI of the collection has changed
      * (e.g. for updating period on a ScheduleEntry and the IRI changes from /periods/1/schedule_entries to /periods/2/schedule_entries)
      */
-    private function gatherResourceTags(EntityManagerInterface $em, object $entity, ?object $oldEntity = null): void {
+    private function gatherResourceTags(object $entity, ?object $oldEntity = null): void {
         $entityClass = $this->getObjectClass($entity);
         if (!$this->resourceClassResolver->isResourceClass($entityClass)) {
             return;
@@ -168,7 +167,7 @@ private function gatherResourceTags(EntityManagerInterface $em, object $entity,
         $this->gatherResourceTagsForClass($resourceClass, $entity, $oldEntity);
 
         // also purge parent classes (e.g. /content_nodes)
-        $classMetadata = $em->getClassMetadata(ClassUtils::getClass($entity));
+        $classMetadata = $this->em->getClassMetadata(ClassUtils::getClass($entity));
         foreach ($classMetadata->parentClasses as $parentClass) {
             $this->gatherResourceTagsForClass($parentClass, $entity, $oldEntity);
         }
@@ -221,8 +220,8 @@ private function invalidateCollection(GetCollection $operation, object $entity,
      *
      * @psalm-suppress UndefinedClass
      */
-    private function gatherRelationTags(EntityManagerInterface $em, object $entity): void {
-        $associationMappings = $em->getClassMetadata(ClassUtils::getClass($entity))->getAssociationMappings();
+    private function gatherRelationTags(object $entity): void {
+        $associationMappings = $this->em->getClassMetadata(ClassUtils::getClass($entity))->getAssociationMappings();
 
         foreach ($associationMappings as $property => $associationMapping) {
             if ($associationMapping instanceof AssociationMapping && ($associationMapping->targetEntity ?? null) && !$this->resourceClassResolver->isResourceClass($associationMapping->targetEntity)) {